目次の領域マクロ
コンテンツ ゾーン テーブル マクロを使用して、コンテンツ テーブルを作成するページ内のセクション (ゾーン) を区切ります。見出しをフラット リストとしてスタイリングし、セクションやページの一番上と下にリンクのリストを配置して、Web ナビゲーションに似たナビゲーション バーを提供します。
コテンツ ゾーン テーブルを使用する
コンテンツ ゾーン ページ マクロをページに追加するには：
- From the editor toolbar, choose
(Insert) > Other Macros - 対象のマクロを見つけて、選択します。
Speed it up with autocomplete: Type { and the beginning of the macro name, to see a list of suggested macros. In this example we're inserting the cheese macro. 
既存のマクロを編集する方法: マクロのプレースホルダをクリックして、[編集] を選択します。これによりマクロの詳細を開き、マクロのパラメーターを編集できます。
パラメーター
Parameters are options that you can set to control the content or format of the macro output. Where the parameter name used in Confluence storage format or wikimarkup is different to the label used in the macro browser, it will be listed below in brackets (example).
パラメーター | 既定 | 説明 |
|---|---|---|
ロケーション | 両方 | 出力リストを表示するゾーンを指定します。top、bottom またはboth でページ ゾーン コンテンツを囲みます。 |
出力タイプ | list | コンテンツ テーブルのレイアウトを指定します。
|
セクション番号を表示 | false | 見出しにアウトライン ナンバリングを適用します。例: 1.1, 1.2, 1.3. |
リスト スタイル | なし | 各リスト項目のブレット ポイントのスタイルを指定します。 有効な CSS スタイルを使用できます。 例:
|
見出しのインデント |
| CSS の数に従って、リストのインデントを作成します。「10px」と入力すると、見出しグループが連続して 10px でインデントされます。たとえば、h 1 の見出しの場合、インデントは 10px となり、h 2 の見出しはさらに 10px でインデントされます。 |
区切り記号 | brackets | flat 出力タイプにのみ適用されます。リンクの表示スタイルを指定します。 次のいずれかの値を入力できます。
|
見出しの最小レベル | 1 | TOC リストを開始する最大見出しレベルを選択します。 たとえば、2 の場合、h2、h3、および h4 見出しをリストしますが、1 見出しは含まれません。 |
最大見出しレベル | 7 | TOC に含める最小の見出しレベルを指定します。例えば、2 は h1 と h2 をリストしますが、h3 以下は含みません。 |
見出しを含める |
| 特定の条件に従って含める見出しをフィルターします。ワイルドカード文字を使用できます。正規表現文字列の作成例に対しては「Sun's Regex documentation」を参照してください。 |
除外する見出し |
| 特定の条件に従って含める見出しをフィルターします。ワイルドカード文字を使用できます。正規表現文字列の作成例に対しては Sun's Regex documentation を参照してください。 |
印刷可能 | true | 既定では、TOC は印刷用に設定されています。このパラメーターをクリアすると、ページを印刷した際に TOC は表示されなくなります。 |
CSS クラス名 |
| お使いの CSS スタイル シートにカスタムの TOC がある場合、このパラメーターを使用して、指定した "class" 属性で TOC を出力できます。 |
例
この例は、次のヘッダーが付いたページに基づいています。
フィルターされた目次
この例では。"Favorite", を含むすべての見出しをフィルターし、"Things" という単語で終わる見出しを除外しています。リスト スタイルは大文字ローマ数字です。
| パラメーター | 値 |
|---|---|
| 出力タイプ | list |
| リスト スタイル | upper-roman |
| 見出しを含める |
|
| 見出しを除外する | .*Things |
スクリーンショット: フィルターされた TOC 'zone' 見出し
フラット リスト
この例では、すべての見出しをフィルターして角括弧で囲まれた "Unknowns" のフラット リストをレンダリングします。
| パラメーター | 値 |
|---|---|
| 出力タイプ | フラット |
| Separator | brackets |
| Max Heading Level | 2 |
| 見出しを含める | Unknown* |
スクリーンショット: フィルターされた TOC 'zone' 見出し (フラット リストとして表示)
Wiki マークアップの例
以下の例は、エディタ外部 (スペースのサイドバー、ヘッダー、フッターのカスタム コンテンツなど) でマクロを追加する場合に便利です。
マクロ名: toc-zone
マクロ本文: リッチ テキストの利用可
{toc-zone:printable=false|maxLevel=2|minLevel=2|location=top|type=flat|outline=true|separator=pipe}
Only headings within this block are included in the table of contents.
{toc-zone}注意
- コンテンツ ゾーン テーブル マクロ (CONF-10619) の未解決の問題により、マクロ ブラウザーの更新関数はパラメーター変数をレンダリングしません。現在、コンテンツ ゾーン テーブル マクロに対するパラメーター値変更のレンダリングは、ページの保存後にのみ発生します。
HTML 見出しマークアップと目次ゾーン マクロの併用について — 目次ゾーン マクロは単独で HTML 見出しマークアップを処理することはできません。そのため、HTML と HTML インクルード マクロを使用して Confluence ページで HTML 見出しマークアップをレンダリングしている場合、目次ゾーン マクロではそれらの見出しからコンテンツ リストを作成することはできません (この問題の詳細は、TOC-93 を参照してください)。
ただし、ページの各 HTML 見出しに、次の構文に基づいた HTML アンカーを挿入した場合、目次ゾーン マクロはこれらの見出しをコンテンツ リストに組み込みます。<h2><a name="pagename-headingname"></a>Heading Name</h2>アンカー名の構文は、ハイフンで区切られたページ名と見出し名です。すべてのスペースを削除し、すべてのテキストを小文字に変換してください。すべての句読点を、対応する URL エンコードに変換してください。