用語集

テキストや仕様書の巻末にあるような用語集です。

入力例

.. glossary::

   ほげほげ
      行頭の前に半角スペースが3つ入っています

      ほげほげの説明と同じブロックです

   ぴよぴよ
      なぜほげほげとぴよぴよなのか

   ふー
   ばー
      ふーとばーは何の略でしょうか

   すいへーりーべー : 元素
   ひとよひとよにひとみごろ : 2の平方根
      語呂合わせでの覚え方

書き方は基本的に定義リストと同じですが、少しだけ便利にな使い方ができるようになっています。

同じ意味の用語が複数ある場合は、用語を複数並べて書くことができます。(入力例の「ふー」と「ばー」)

出力例

../_images/rst_syntax_glossary_01.png

HTMLはこうなります。

<dl class="glossary docutils">
    <dt id="term">ほげほげ</dt>
    <dd>
        <p class="first">行頭の前に半角スペースが3つ入っています</p>
        <p class="last">ほげほげの説明と同じブロックです</p>
    </dd>
    <dt id="term-1">ぴよぴよ</dt>
    <dd>なぜほげほげとぴよぴよなのか</dd>
    <dt id="term-2">ふー<dt id="term-3">ばー</dt>
    <dd>ふーとばーは何の略でしょうか</dd>
    <dt id="term-4">すいへーりーべー<dt id="term-5">ひとよひとよにひとみごろ</dt>
    <dd>語呂合わせでの覚え方</dd>
</dl>

「すいへーりーべー : 元素」となっているところがありますが、こうすると、索引が後ろ側の文字列でまとめられます。下図ですと、「元素」というくくりができていますね。

../_images/rst_syntax_glossary_02.png