目次マクロ

このページの内容

お困りですか?

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

コミュニティに質問

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

Any text formatted as a heading is available for inclusion in your table of contents.


tip/resting Created with Sketch.

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

目次マクロを使用する

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

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

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

オートコンプリートでマクロを素早く入力する方法

  • 新しいエディタ - 「/」と要素 (ツールや挿入メニューのアイテム) の先頭の文字を入力すると、提案の一覧が表示されます。
  • 従来のエディタ - 「{」とマクロ名の先頭を入力すると、マクロ候補の一覧が表示されます。

詳細については、「キーボード ショートカット、マークダウン、およびオートコンプリート」をご参照ください。


既存のマクロを編集する方法

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

マクロ パラメーター

パラメーターは、マクロ出力の内容や形式を制御するために設定できるオプションです。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 と入力すると、一連の見出しが 10 px でインデントされます。たとえば、レベル 1 の見出しのインデントは 10 px となり、レベル 2 の見出しはさらに 10 px でインデントされます。

区切り記号
(separator

brackets

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

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

見出しの最小レベル
(minLevel 

1

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

最大見出しレベル
(maxLevel

7

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

見出しを含める
(include


Filter headings to include according to specific criteria. You can use wildcard characters.

If you only want the Overview and Summary headings to appear, enter Overview|Summary in this field.

除外する見出し
(exclude


Filter headings to exclude according to specific criteria. You can use wildcard characters.

If the headings you want to exclude are Overview and Summary, enter Overview|Summary in this field.

印刷可能
(printable

オン

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

CSS クラス名
(class


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

絶対 URL
(absoluteURL )

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

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

フィルターされた目次

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

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

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

フラット リスト

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

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

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

Wiki マークアップの例

Wiki markup is only supported in the legacy editor.


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

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

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