目次マクロは現在の Confluence ページの見出しをスキャンし、これらの見出しに基づいて目次を作成します。これにより、コンテンツ構造を要約し、見出しへのリンクを提供することで、読者が長いページを回避できるようナビゲートします。 

絵文字、メンション、ステータス、日付を使用して見出しとしてフォーマットされた任意のテキストを目次に含めることができます。

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

目次マクロを挿入するには: 

  1. Confluence エディタで、 > [詳細を表示] の順に選択します。
  2. 挿入するアイテムを探して選択します
  3. [挿入] を選択します。

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

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

  1. マクロのプレースホルダーを選択します。フローティング ツールバーが表示されます。
  2. [編集] を選択します。右側のパネルが開きます。
  3. パラメータを修正します。変更内容は、移動するごとに保存されます。
  4. ページの編集を再開すると、パネルが閉じます。

パラメーター

パラメーターは、マクロ出力の内容や形式を制御するために設定できるオプションです。Confluence の保存形式または wiki マークアップで使用されるパラメータ名がブラウザで使用されるラベルと異なる場合、以下の一覧に括弧付きで表示されます (example)。

パラメーター

既定

説明

出力タイプ
(type)

list

  • list – 一般的なリスト タイプの目次を生成します。
  • flat — 横型メニュー タイプの一連のリンクを精製します。

セクション番号を表示
(outline

clear

チェック ボックスをオンにして、見出しにアウトライン番号を適用します。例: 1.1、1.2、1.3。

リスト スタイル
(style

disc

各リスト項目のブレット ポイントのスタイルを選択します。有効な 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)

見出しのインデント
(indent


CSS の数に従って、リストのインデントを作成します。「10px」と入力すると、一連の見出しが 10px ずつインデントされます。たとえば、レベル 1 の見出しは 10px インデントされ、レベル 2 の見出しはさらに 10px インデントされます。

区切り記号
(separator

brackets

このパラメーターはフラットリストにのみ適用されます。 次の値のいずれかを入力できます。

  • brackets – 各項目を角かっこ [ ] で囲む。
  • braces – 各項目を波かっこ { } で囲む。
  • parens – 各項目をかっこ ( ) で囲む。
  • pipe – 各項目をパイプで区切る。
  • anything — 入力する値によってそれぞれが区切られます。テキストをセパレーターとして入力できます (例: 「***」)。カスタム セパレーターを使用している場合、テキストは入力されたとおりに表示されることに注意してください。文字を区切る追加スペースなどは入りません。

見出しの最小レベル
(minLevel 

1

TOC リストを開始する最大見出しレベルを選択します。たとえば、「2」と入力すると、レベル 2 以下の見出しが含まれますが、レベル 1 の見出しは含まれません。

最大見出しレベル
(maxLevel

7

含める最小の見出しレベルを指定します。たとえば、「2」と入力すると、レベル 1 および 2 の見出しが含まれますが、レベル 3 以下の見出しは含まれません。

見出しを含める
(include


特定の条件に従って含める見出しをフィルターします。ワイルドカード文字を使用できます。

概要および要約の見出しのみを表示したい場合は、このフィールドに Overview|Summary と入力します。

tip/resting Created with Sketch.

大文字と小文字は区別されます。両方のインスタンスを含める場合は、両方の形式の単語を入力してください。

除外する見出し
(exclude


特定の条件に実行する見出しをフィルターします。ワイルドカード文字を使用できます。

除外したい見出しが概要または要約の場合は、このフィールドに「Overview|Summary」と入力します。

tip/resting Created with Sketch.

大文字と小文字は区別されます。両方のインスタンスを除外する場合は、両方の形式の単語を入力してください。

印刷可能
(printable

オン

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

CSS クラス名
(class


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

絶対 URL
(absoluteURL )

既定では、TOC のリンクは現在のページを示す相対的な URL です。これを選択した場合、TOC のリンクは完全な URL になります。 

以下の例は、この目次に基づいています。

tip/resting Created with Sketch.

目次マクロの実際の動きをご覧になりたい場合は、洞察力に富んだ顧客インタビュー ページの作成でどのように使用されているかをご覧ください。


フィルターされた目次

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

パラメーター
リスト スタイルupper-roman
見出しを含める
Favourite*
見出しを除外する
.*Things

コンテンツの結果の表は次のようになります。

フラット リスト

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

パラメーター
出力タイプ
フラット
最大見出しレベル
2
見出しを含める
Unknown*

コンテンツの結果の表は次のようになります。

Wiki マークアップの例

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


robotsnoindex
robotsnoindex

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

マクロ名:  toc

マクロ本文: なし。

この例は、リスト タイプの目次を示しています。

{toc:printable=true|style=square|maxLevel=2|indent=5px|minLevel=2|class=bigpink|exclude=[1//2]|type=list|outline=true|include=.*}

この例では、目次のフラット テーブルを示しています。

{toc:printable=true|maxLevel=2|minLevel=2|class=bigpink|exclude=[1//2]|type=flat|outline=true|separator=pipe|include=.*}

注意

  • テンプレートで目次マクロを使用すると、テンプレート自体をプレビューしたときにエラーが表示されます。しかし、目次マクロがユーザーがテンプレートから作成するしたページで機能し、目次はページを保存した後に表示されます。(これはおそらく、テンプレートがページとして定義されておらず、目次マクロがページに対してのみ機能するためです。)
  • 目次マクロは、ページまたはブログ投稿の内容のみを表示します。例えば、コメントの見出しの目次を追加することはできません。 
  • 目次マクロ (CONF-10619) の課題が未解決なため、マクロ ブラウザーの更新関数はパラメーター変数をレンダリングしません。現在、目次マクロへのパラメーター値変更のレンダリングは、ページの保存後にのみ行われます。