クイックリンク

MDN はページへのクイックリンクの追加に対応しています。これらのボックスは、 MDN 上の他のページやサイト外のページへの階層的なリストを含むことができます。この記事では、クイックリンクボックスの生成方法を解説します。

ページには、左側のサイドバーに表示されるクイックリンクボックスが1つしかない場合があります。このサイドバーは、任意で、ユーザーがサイドバーの上部にある「このサイドバーを隠す」リンクをクリックすることで非表示にすることができます。

クイックリンクの構文

ページのクイックリンクは、 "Quick_Links" という ID を持つ <section> ブロックを作成することによって提供されます。次に、セクション内のクイックリンクボックスに入るコンテンツを配置します。これらは <ol> 順序付きリスト (ネストも可) として整形する必要があります。これは、エディターツールバーの番号付きリストボタンを使用して行うことができます。たとえば、このページにはいくつかの便利なページにつながるクイックリンクボックスがあります。その HTML は次のようになります。

<section id="Quick_Links">
  <ol>
    <li><a href="http://docs.ckeditor.com/">CKEditor documentation site</a></li>
    <li><a href="http://mxr.mozilla.org/">MXR: Mozilla source cross-reference</a></li>
    <li class="toggle">
      <details><summary>Style guides</summary>
      <ol>
        <li><a href="http://www.economist.com/research/StyleGuide/">The Economist style guide</a></li>
        <li><a href="http://www.amazon.com/gp/product/0226104036/">The Chicago manual of style</a></li>
        <li><a href="http://www.answers.com/library/Dictionary">Answers.com dictionary</a></li>
        <li><a href="http://www.wsu.edu/~brians/errors/">Common Errors in English</a></li>
      </ol>
      </details>
    </li>
  </ol>
</section>

注意すべき重要事項:

リストは順序付きリストであるべきです。
別な順序付きリストを含んだ <details> を同じ <li> ブロックの中で使用すると、階層構造のリストを持つことができます。

クイックリンクを生成するマクロの使用

メイン記事: ナビゲーションサイドバーを使うには

言うまでもなく、マクロを使用してクイックリンクを生成することができます (また、しばしばするべきです)。複数のページで同じクイックリンクを使用する必要がある場合は、マクロにするべきです。たとえば、このページでは MDNSidebar マクロを使用してクイックリンクボックスを生成しています。 MDN エディターガイドの他の各ページも同様です。

マクロは、必要に応じて単純なものでも複雑なものでもかまいません。上記のクイックリンクの構文と同様の HTML を出力するだけです。

標準のクイックリンクマクロ

私たちのクイックリンクを生成する標準マクロの一覧です。

CSSRef: CSS リファレンスページの標準クイックリンクを作成します。
HTMLRef: HTML リファレンスページの標準クイックリンクを作成します。
MakeSimpleQuicklinks: MDN 上のページのリストが与えられた場合、このマクロは、ページのタイトルをリンクテキストとして使用し、その概要をツールチップとして使用するクイックリンクボックスを作成します。これは階層リストを作成しません。
QuickLinksWithSubpages: 現在のページ (または指定したページ) の子を宛先として使用して、クイックリンクのセットを作成します。これにより、最大2レベルの階層リストが作成されます。ページのタイトルをリンクテキストとして使用し、その概要をツールチップとして表示します。