編集ガイド/目次と見出しについて

Last-modified: 2022-10-29 (土) 00:15:56

最終更新:2022-10-29 (土) 00:15:56

概要

目次は、ページ内に作成した見出しを列挙する機能です。
また、目次内の各見出し名をクリックすることでページ内の該当部分に移動することができます。
このページでは目次・見出しの作成方法や注意点などについて解説します。

目次

目次の作り方

目次を作成したい場所に以下のように記述します。

#contents

目次には、そのページ内の見出しが列挙されます。

見出しの作り方

見出しには3つの段階があります。
見出しにしたい行の先頭に[*]を1~3つ付けることで見出し化できます。
例:

*見出し1
**見出し2
***見出し3

結果:

見出し1

 

見出し2

 

見出し3

目次に表示されない見出し

目次に表示されない見出し - WIKIWIKI.jp Sample Wikiをチェック(疲れたので後回し)。

アンカーについて

既存のページを編集しようとすると見出しの後ろに

[#c7d780d5]

みたいな英数字とか

[#comment]

みたいな英単語とかが並んでいると思います。
これはアンカーと言います。

アンカーには"アンカーの存在する場所へジャンプするURLの生成"という機能があります。
そのためアンカーは編集で削除しても自動で付与されます。
ちなみに上記の[目次に表示されない見出し]ではアンカーは作成されません。

例えば、このWikiの[ガルーラ]というページ内の

*もちもの [#item]

といった見出しがあった場合、

https://wikiwiki.jp/triple/ガルーラ#item

と記述すれば[もちもの]の見出しへのリンクが作成できます。
実際に上のリンクをクリックすれば飛べるはずです(これを書いた時からページ構造が変わっていなければ)。

また、各見出し名の横にある鉛筆マークをクリックした際、その見出し下を編集するページを開けますが、これもアンカーにより編集用のURL作成が可能となっています。

つまり何が言いたいかというと1つのページ内で同じ名前のアンカーを作成してしまうと上記の機能が正常に動作しなくなります。
見出しをコピーする際には、このアンカーもコピーしてしまわないように気をつけてください(別ページのアンカー名とは被っても大丈夫です)。

見出しを作成した際、アンカー名は自分でつけるべきか?

結論から言うとつけた方が良いです。
アンカー名は何もしなくてもWiki側が自動でランダムな英数字を付与してくれます。
機能的にはこれで問題はありません。
ではなぜつけた方が良いかですが、これは

  1. 問題が起きていても発見しづらい
  2. 他のサイト・ページから参照されていた場合問題が起きやすい

などが理由です。
順に説明します。

まずは1つ目の[問題が起きていても発見しづらい]です。
これは上述した"1つのページ内で同じ名前のアンカーを作成してはいけない"という話と関係があります。
アンカー名がランダムな英数字な場合、それがコピーされて同一ページ内で使われていてもまず気付きません。
これは、それぞれの見出しに関連したアンカー名を付けていれば防ぐことができます。

次に2つ目の[他のサイト・ページから参照されていた場合問題が起きやすい]です。
ページの構造が変わったりアンカー名が変更された場合に、ランダムな英数字のアンカー名だとどこを参照していたか分からなくなります。
これは特に見出しが多い用語集などで起こりやすい問題です。
(あと、シェアした際に見栄えが悪いです。)

参考リンク

目次 - WIKIWIKI.jp Sample Wiki
見出し - WIKIWIKI.jp Sample Wiki
アンカーの設定 - WIKIWIKI.jp Sample Wiki
目次に表示されない見出し - WIKIWIKI.jp Sample Wiki

コメント