目次の領域マクロ

マクロ

このページの内容

お困りですか?

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

コミュニティに質問

目次の領域マクロをページに追加すると、ページの指定されたセクションの目次を表示できます。

このマクロは以下の場合に適しています。 

  • ページのセクションの目次を作成する
  • 非常に長いページを通じて複数の目次を作成する

見出しの目次はマクロの本文内で作成する必要があります。

このページの内容

スクリーンショット: 出力タイプ "flat" で設定された目次の領域マクロ。

このマクロをページに追加する

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

  1. エディタのツールバーで、[挿入] > [その他のマクロ] を選択します。
  2. [Confluence コンテンツ] カテゴリから [目次の領域] を選択します。
  3. 任意のパラメーターを入力します。
  4. [挿入] をクリックします。
  5. コンテンツをマクロ本文に追加するか貼り付けます。マクロ内の見出しが目次に含まれます。

その後、ページを公開するとマクロの動作を確認できます。 

スクリーンショット: 目次の領域マクロの本文内での見出しの入力。

マクロ パラメーターを変更する

マクロ パラメーターは、マクロの動作を変えるために使用します。

マクロ パラメーターを変更するには、次の手順を実行します。

  1. エディタでマクロのプレースホルダーをクリックし、[編集] を選択します。
  2. 必要に応じてパラメーターを更新し、[挿入] を選択します。

このマクロで使用できるパラメーターの一覧は、次のとおりです。 

パラメーター

既定

説明

ロケーション
(location

両方

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

出力タイプ
(type

list

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

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

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

false

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

リスト スタイル
(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) のリスト スタイル。

見出しのインデント
(indent


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

区切り記号
(separator

brackets

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

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

見出しの最小レベル
(minLevel 

1

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

最大見出しレベル
(maxLevel

7

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

見出しを含める
(include


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

除外する見出し
(exclude


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

印刷可能
(printable

true

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

CSS クラス名
(class


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

Confluence の保存形式または wiki マークアップで使用されるパラメーター名がマクロ ブラウザで使用されるラベルと異なる場合、以下の一覧に括弧付きで表示されます (example)。

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

フィルターされた目次

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

パラメーター
出力タイプlist
リスト スタイルupper-roman
見出しを含める

Favourite.*

見出しを除外する.*Things

スクリーンショット: フィルターされた TOC 'zone' 見出し

フラット リスト

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

パラメーター
出力タイプフラット
Separatorbrackets
Max Heading Level2
見出しを含める
Unknown*

スクリーンショット: フィルターされた TOC 'zone' 見出し (フラット リストとして表示)

このマクロを追加するその他の方法

手入力でこのマクロを追加する

{」と入力してからマクロ名の入力を開始すると、マクロの一覧が表示されます。

Wiki マークアップを使用してこのマクロを追加する

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

マクロ名: toc-zone

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

{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}

トラブルシューティング

HTML 見出しマークアップと目次の領域マクロの併用について — 目次の領域マクロは単独で HTML 見出しマークアップを処理することはできません。そのため、HTMLHTML インクルード マクロを使用して Confluence ページで HTML 見出しのマークアップをレンダリングしている場合、目次の領域マクロではそれらの見出しからコンテンツ リストを作成することはできません。

ただし、ページの各 HTML 見出しに、次の構文に基づいた HTML アンカーを挿入した場合、目次ゾーン マクロはこれらの見出しをコンテンツ リストに組み込みます。

<h2><a name="pagename-headingname"></a>Heading Name</h2>

アンカー名の構文は、ハイフンで区切られたページ名と見出し名です。すべてのスペースを削除し、すべてのテキストを小文字に変換してください。すべての句読点を、対応する URL エンコードに変換してください。

最終更新日 2020 年 5 月 20 日

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

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