目次の領域マクロを挿入する

コンテンツ ゾーン テーブル マクロを使用して、コンテンツ テーブルを作成するページ内のセクション (ゾーン) を区切ります。見出しをフラット リストとしてスタイリングし、セクションやページの一番上と下にリンクのリストを配置して、Web ナビゲーションに似たナビゲーション バーを提供します。

コンテンツ ゾーン テーブル マクロを使用する

コンテンツ ゾーン テーブル マクロを追加するには:

  1. 編集時には、ツールバーから を選択します。

  2. 挿入するアイテムを探して選択します

  3. [挿入] を選択します。

このページに「/」と入力して、ツールバーからを選択し、同じリストを表示することも可能です。

コンテンツ ゾーン テーブル マクロを編集するには:

  1. マクロのプレースホルダーを選択します。フローティング ツールバーが表示されます。

  2. 編集を選択します。右側のパネルが開きます。

  3. パラメータを修正します。変更内容は、移動するごとに保存されます。

  4. ページの編集を再開すると、パネルが閉じます。

パラメーター

パラメータは、マクロ出力の内容や形式を制御するために設定するオプションです。 

Confluence Cloud ストレージ形式または wikimarkup で使用されるパラメーター名が、ブラウザやスラッシュ コマンドを使用してマクロを挿入する際に使用されるラベルと異なる場合は、下記の角括弧内に記載します ()。

パラメーター

既定

説明

location
(location

両方

出力リストを表示するゾーンを指定します。topbottom またはboth でページ ゾーン コンテンツを囲みます。

Output Type
(type

list

コンテンツ テーブルのレイアウトを指定します。

  • list – 縦型のリスト (一般的には TOC) を生成します。

  • flat – 横型のメニュー タイプの一連のリンクを生成します。例: [Heading 1] [Heading 2] [Heading 3]。

Display Section Numbering
(outline

false

選択して、見出しにアウトライン番号を適用します。例: 1.1、1.2、1.3。

List Style
(style

なし

各リスト項目のブレット ポイントのスタイルを指定します。  有効な CSS スタイルを使用できます。 例:

  • none — リスト スタイルの表示なし

  • circle --- 丸のリスト スタイル

  • disc — 黒丸のリスト スタイル。一般的な箇条書きリスト。このリスト例で使用しています。

  • square — 正方形のリスト スタイル

  • decimal — 番号付きリスト (1、2、3、4、5)

  • lower-alpha — 小文字のアルファベットが付いたリスト (a、b、c、d、e)

  • lower-roman — 小文字のローマ数字が付いたリスト (i、ii、iii、iv、v、vi)

  • upper-roman — 大文字のローマ数字が付いたリスト (I、II、III、IV、V、VI)

Heading Indent
(indent

 

CSS の数に従って、リスト出力タイプのインデントを作成します。「10px」と入力すると、見出しグループが連続して 10px でインデントされます。たとえば、h1 の見出しの場合、インデントは 10px となり、h2 の見出しはさらに 10px でインデントされます。

Separator
(separator

brackets

flat 出力タイプにのみ適用されます。リンクの表示スタイルを指定します。 次のいずれかの値を入力できます。

  • brackets — 各アイテムは、角かっこ [ ] で囲まれます。

  • brackets — 各アイテムは、角括弧 [ ] で囲まれます。

  • parens — 各アイテムをかっこ ( ) で囲む。

  • pipe — 各アイテムをパイプで区切る:

  • anything — 入力する値によってそれぞれが区切られます。テキストをセパレーターとして入力できます (例: '***')。カスタム セパレーターを使用している場合、テキストは入力されたとおりに表示されることに注意してください。文字を区切る追加スペースなどは入りません。

Minimum Heading Level
(minLevel

1

TOC リストを開始する最大見出しレベルを選択します。たとえば、2 の場合、h2、h3、h4 見出しをリストしますが、h1 見出しは含みません。

Max Heading Level
(maxLevel

7

TOC に含める最小見出しレベルを選択します。たとえば、2 の場合、h1 と h2 をリストしますが、h3 以下は含みません。

Include Headings
(include

 

特定の条件に従って含める見出しをフィルタリングします。ワイルドカード文字を使用できます。正規表現文字列の作成例については「Sun's Regex documentation」をご参照ください。

Exclude Headings
(exclude

 

特定の条件に従って含める見出しをフィルタリングします。ワイルドカード文字を使用できます。正規表現文字列の作成例については「Sun's Regex documentation」をご参照ください。

Printable
(printable

true

既定では、TOC は印刷用に設定されています。このパラメーターをクリアすると、ページを印刷した際に TOC は表示されなくなります。

CSS Class Name
(class

 

お使いの CSS スタイル シートにカスタムの TOC がある場合、このパラメーターを使用して、指定した "class" 属性で TOC を出力できます。

 

この例は、次のヘッダーが付いたページに基づいています。

フィルターを使用しない目次の例をご確認ください

フィルターされた目次

この例では。"Favorite", を含むすべての見出しをフィルターし、"Things" という単語で終わる見出しを除外しています。リスト スタイルは大文字ローマ数字です。

パラメーター

出力タイプ

list

リスト スタイル

upper-roman

見出しを含める

Favourite*

見出しを除外する

.*Things

目次をフィルタリングすると表示される内容をご確認ください

フラット リスト

この例では、すべての見出しをフィルターして角括弧で囲まれた "Unknowns" のフラット リストをレンダリングします。

パラメーター

出力タイプ

フラット

Separator

brackets

Max Heading Level

2

見出しを含める

1 Unknown.*
目次をフラット リストで表示したときに表示される内容をご確認ください

Wiki マークアップの例

Wiki マークアップは従来のエディタでのみサポートされます。

Wiki マークアップはエディタ外部でマクロを追加する必要がある場合 (スペースのサイドバー、ヘッダー、またはフッターのカスタム コンテンツなど) に便利です。

Macro name: toc-zone

マクロ本文: リッチ テキストの利用可

1 2 3 4 5 6 {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) の課題が未解決なため、マクロ ブラウザーの更新機能はパラメーターの変更をレンダリングしません。現在、目次の領域マクロに対するパラメーター値変更のレンダリングは、ページの保存後にのみ行われます。

 

その他のヘルプ