toc.xbl : 目次の自動生成

toc.xbl の束縛

目次を生成するための toc.xbl を文書に束縛するためには、 -moz-binding 特性を使用します。この特性の値は束縛する XBL の文書と、その中に含まれる束縛 (binding) 要素を識別する URI 参照です。

h1 {
  -moz-binding: url(https://suika.suikawiki.org/www/style/ui/toc#after);
}

この例では、 XBL 文書として <https://suika.suikawiki.org/www/style/ui/toc> を、その中の束縛として after を指定しています。 前者は XBL 文書を別の場所に保存する場合は適当に書き換えて下さい。 後者は現時点では after 以外指定できません。

-moz-binding 特性を使用したスタイル・シートの例を2種類用意しました。 是非お使い下さい。

• h1 要素の後に目次を挿入: <https://suika.suikawiki.org/www/style/ui/toc-after-h1> [使用例]
• ID が ABSTRACT である要素の後に目次を挿入: <https://suika.suikawiki.org/www/style/ui/toc-after-abstract>

もちろん、これらを使わずに先の例のような特性の指定を直接お使いのスタイル・シートに追加していただいても構いません。

生成した目次へのスタイル指定

目次は、次の図のような構造で生成されます。

色々な本質的ではない理由により、最上位の要素は xhtml1:div にしています。ただし、元々文書に存在していた xhtml1:div 要素と区別できるように、 toc:toc 属性を加えています。この要素は束縛した要素の弟として追加されます。

最初の要素である xhtml2:h は目次部分の見出しで、目次という文字列が含まれます。 その弟として xhtml2:nl 要素を使って文章中の見出しに対応するリストが作られています。 このリストは文章中の見出しの深さに対応しています。 ただし、文章中に章節に対応する要素があるかどうかで構造がやや異なります。

章節に対応する要素がある場合

章節構造にあわせて入れ子になったリストが作られます。 リストの深さが章節の深さです。

章節に対応する要素がない場合

要素型名の数字に関わらず、同じ深さの平らなリストが作られます。 リストの深さと章節の深さが一致しません。ただし、 リスト項目 (xhtml2:li 要素) の属性 toc:element-type に要素型の局所名 (XHTML でない HTML の場合、小文字化済み) を、属性 toc:element-type-ns-uri に要素型の名前空間 URI を与えています。これを使ってスタイル・シートの側で見かけの深さを変えることができます。

<!-- 目次 -->
<!ELEMENT xhtml1:div (xhtml2:h, xhtml2:nl)>
<!ATTLIST xhtml1:div
  toc:toc  CDATA  #REQUIRED>

<!-- 目次の見出し -->
<!ELEMENT xhtml2:h ANY>

<!-- 章名リスト -->
<!ELEMENT xhtml2:nl (xhtml2:label, xhtml2:li+)>

<!-- 章名 (節あり) -->
<!ELEMENT xhtml2:label ANY>

<!ATTLIST xhtml2:li
  href  CDATA  #REQUIRED>

<!-- 章名 (節なし) -->
<!ELEMENT xhtml2:li ANY>

<!ATTLIST xhtml2:li
  href  CDATA  #REQUIRED
  toc:element-type  NMTOKEN  #IMPLIED
  toc:element-type-uri  CDATA  #IMPLIED>

XHTML 2 に対応した利用者エージェントやスタイル・シートを使っていれば、 何もしなくてもこの構造を適切にレンダリングできるはずです。 そうでない場合や、対応していても目次の部分だけ違ったレンダリングをさせたい場合には、 著者が適当なスタイル・シートで指定する必要があります。

@import 'https://suika.suikawiki.org/www/style/ui/toc-style-float-compact.css';

対応している要素型

次の要素型は、見出しを表す要素型として扱います。

• xhtml1:h1
• xhtml1:h2
• xhtml1:h3
• xhtml1:h4
• xhtml1:h5
• xhtml1:h6
• xhtml2-2002:h
• xhtml2-2005:h

次の要素型は、頭を表す要素型とみなします。

• html5:header
• xhtml1:div (ただし、 class に header が含まれている要素に限ります。)

次の要素型は、章節を表す要素型とみなします。

• xhtml1:body
• xhtml1:div (ただし、 class に section, article, wiki-section のいずれかが含まれている要素に限ります。)
• xhtml2-2002:body
• xhtml2-2002:section
• xhtml2-2005:body
• xhtml2-2005:section
• html5:section