目次マクロ

マクロ

このページの内容

お困りですか?

アトラシアン コミュニティをご利用ください。

コミュニティに質問

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

tip/resting Created with Sketch.

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

目次マクロを使用する

ヒント: エディター ツールバーにすばやくアクセスするには、挿入 > 目次を選択します。

目次マクロをページに追加するには:

  1. Confluence のエディタで、[挿入] > [その他のマクロ] を選択します。
  2. 対象のマクロを見つけて、選択します。

オートコンプリートでマクロの入力を高速化: 「{」とマクロ名の先頭を入力すると、マクロ候補の一覧を表示できます。詳細については、「キーボード ショートカット、マークダウン、およびオートコンプリート」をご参照ください。

既存のマクロを編集する方法: マクロのプレースホルダをクリックして、[編集] を選択します。マクロのパラメータが編集可能な場合、マクロのダイアログ ウィンドウが開きます。

マクロ パラメーター

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

パラメータ

既定

説明

Output Type
(type)

一覧

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

Display Section Numbering
(outline

clear

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

List Style
(style

disc

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

  • none — no list style is displayed
  • circle —  the list style is a circle
  • disc — the list style is a filled circle. This is the typical bullet list, and is used for this example list.
  • square — the list style is a square
  • decimal — the list is numbered (1, 2, 3, 4, 5)
  • lower-alpha — the list is lower-case, alphabetized (a, b, c, d, e)
  • lower-roman — the list style is lower roman numerals (i, ii, iii, iv, v, vi)
  • upper-roman — the list style is upper roman numerals (I, II, III, IV, V, VI)

Heading Indent
(indent

 

Sets the indent for a list according to CSS quantities. Entering 10px will successively indent heading groups by 10px. For example, level 1 headings will be indented 10px and level 2 headings will be indented an additional 10px.

Separator
(separator

brackets

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

  • brackets — Each item is enclosed by square brackets: [ ].
  • braces — Each item is enclosed by braces: { }.
  • parens — Each item is enclosed by parentheses: ( ).
  • pipe — Each item is separated by a pipe:
  • anything — 入力する値によってそれぞれが区切られます。テキストをセパレーターとして入力できます (例: 「***」)。カスタム セパレーターを使用している場合、テキストは入力されたとおりに表示されることに注意してください。文字を区切る追加スペースなどは入りません。

Minimum Heading Level
(minLevel

1

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

Maximum Heading Level
(maxLevel

7

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

Include Headings
(include

 

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

 

Exclude Headings
(exclude

 

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

 

Printable
(printable

オン

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

CSS Class Name
(class

 

If you have custom TOC styles in your CSS style sheet, use this parameter to output the TOC inside <div> tags with the specified class attribute.

Absolute URL
(absoluteURL )
  既定では、TOC のリンクは現在のページを示す相対的な URL です。これを選択した場合、TOC のリンクは完全な URL になります。この設定は、目次が入ったページを別ノページに含め、リンクをクリックしたユーザーの移動先を制御したい場合に便利です。

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

フィルターされた目次

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

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

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

フラット リスト

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

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

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

Wiki マークアップの例

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) の未解決の問題により、マクロ ブラウザーの更新関数はパラメーター変数をレンダリングしません。現在、コンテンツ ゾーン テーブル マクロに対するパラメーター値変更のレンダリングは、ページの保存後にのみ発生します。
最終更新日 2017 年 8 月 8 日

この内容はお役に立ちましたか?

はい
いいえ
この記事についてのフィードバックを送信する
Powered by Confluence and Scroll Viewport.