The Table of Contents macro scans the headings of the current Confluence page to dynamically create a table of contents from your page headings. This helps readers navigate lengthy pages by summarising the content structure and providing links to headings. Headings are indented progressively.

On this page:

Using the Table of Contents Macro

目次マクロをページに追加する方法

  1. In the Confluence editor, choose Insert > Other Macros.
  2. Find and select the required macro.

You can also add the macro to a page by choosing Insert > Table of Contents from the editor toolbar.

マクロ パラメーター

When editing, you can click on the macro placeholder and choose Edit to display the parameters for this macro in the Macro Browser.

Parameters are options that you can set for Confluence macros to control the content or format of the macro output. The table below lists parameters for this macro that can be set in the Macro Browser.

パラメーター

既定

説明

出力タイプ

list

  • list — produces a typical list type TOC.
  • flat — 横型メニュー タイプの一連のリンクを精製します。

Display Section Numbering

clear

見出しにアウトライン ナンバリングを適用します。例: 1.1、1.2、1.3.

リスト スタイル

なし

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

  • none — リスト スタイルの表示なし
  • circle —  丸のリスト スタイル
  • disc — 黒丸のリスト スタイル。一般的な箇条書きリスト。このリスト例で使用しています。
  • square — 正方形のリスト スタイル
  • decimal — 番号付きリスト (1、2、3、4、5)
  • lower-alpha — the list is lower-case, alphabetised (a, b, c, d, e)
  • lower-roman — 小文字のローマ数字のリスト スタイル (i、ii、iii、iv、v、vi)
  • upper-roman — 大文字のローマ数字 (I、II、III、IV、V、VI) のリスト スタイル。

Heading Indent

 

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

Separator

brackets

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

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

Minimum Heading Level

1

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

最大見出しレベル

7

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

見出しを含める

 

Filter headings to include according to specific criteria. You can use wildcard characters. See Sun's Regex documentation for examples of constructing regular expression strings.

 

見出しを除外する

 

Filter headings to enclude according to specific criteria. You can use wildcard characters. See Sun's Regex documentation for examples of constructing regular expression strings.

 

印刷用

オン

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

CSS Class Name

 

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

例

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

 

フィルターされた目次

This example filters the headings to include those that contain 'Favourite', but excludes headings which end with 'Things'. The list is styled with Roman numerals.

パラメーター値
​List Styleupper-roman​
見出しを含める
Favourite*
見出しを除外する
.*Things

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

 

フラット リスト

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

パラメーター値
​Output Type
flat​
最大見出しレベル
2
見出しを含める
Unknown*

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

注意

  • Due to an outstanding issue in the Table of Contents macro (CONF-10619), the Macro Browser's Refresh function does not render any parameter modifications. Currently, the rendering of parameter value modifications to the Table of Contents macro occurs only after the page is saved.

  • Using HTML Heading Markup with the Table of Contents Macro 
    The Table of Contents macro cannot handle HTML heading markup on its own. Hence, if you use the HTML and HTML Include macros to render HTML heading markup in a Confluence page, the Table of Contents macro will not create a contents list out of these headings. (For more information about this issue, please refer to TOC-93.)
    However, if you insert an HTML anchor into each HTML heading on your page (based on the following syntax), the Table of Contents macro will incorporate these headings into your contents list.

    <h2><a name="pagename-headingname"></a>見出し名</h2>

    The syntax for the anchor name is the page name and heading name separated by a hyphen, in which the page and heading names have all spaces removed and are converted to lowercase. If punctuation marks occur within a page or heading name, each mark should usually be converted to its URL escape code in the anchor name.

関連トピック

Table of Content Zone Macro
Page Tree Macro
Adding a Navigation Sidebar
Working with Macros

Take me back to the Confluence User's Guide.

Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 2.5 Australia License.