ページ ツリー マクロ
ページツリー マクロには、指定した親 (ルート) ページから開始するページの動的な階層リストが表示されます。コンテンツ テーブルや関連トピックのリストとして動作することができます。ページ ツリーを表示すると、読者はリンクをクリックして関連ページを表示することができます。ページの現在の位置はページツリーでハイライトされます。
Note: The Page Tree macro is used in the Confluence Documentation theme, to create a navigation panel showing a table of contents for your space. Read the instructions on Configure the Documentation Theme.
ページツリー マクロの使用
ページ ツリー マクロをページに追加するには:
- Confluence のエディタで、[挿入] > [その他のマクロ] を選択します。
- 対象のマクロを見つけて、選択します。
オートコンプリートでマクロエントリを高速化： タイプ{とマクロ名の先頭には、提案したマクロの一覧を表示します。詳細は、こちらを参照ください。リンク、ファイル、マクロ、メンションのオートコンプリート
既存のマクロを編集する方法: マクロのプレースホルダをクリックして、[編集] を選択します。マクロのパラメータが編集可能な場合、マクロのダイアログ ウィンドウが開きます。
マクロ パラメーターへの変更の影響を見るには、マクロ ブラウザーで更新をクリックします。
マクロ パラメーター
パラメーターは、マクロ出力の内容や形式を制御するために設定できるオプションです。Confluence の保存形式または wiki マークアップで使用されるパラメータ名がマクロ ブラウザで使用されるラベルと異なる場合、以下の一覧に括弧付きで表示されます (example)。
パラメーター | 既定 | 説明 |
|---|---|---|
ルート ページ | スペースのホームページ | ページ ツリーの親ページを指定します。ツリーには指定されたページのすべての子と、それらの子と孫などが含まれます。ツリーには、ページ自体は含まれません。
|
ページの並べ替え | 職位 | ツリー内でのページの表示順を指定します。この並べ替えは表示目的のみです。ページの順序を永続的に再配置するものではありません。次のいずれかの値を使用できます。
|
ページ ツリーの抜粋を含む | false | ページツリーで各ページの抜粋を表示する場合に選択します。抜粋は、各ページで抜粋マクロを使用して定義する必要があります。 |
逆順ソート | false | ページを自然な順序の逆 (降順) で表示する場合に選択します。並べ替えパラメーターと併用する必要があります。 |
ページ ツリーの上部の検索ボックスを含める | false | ページツリーの上の検索ボックスに含める場合に選択します。この検索ボックスでは、読者に指定した値のページ内での検索を許可することができます。 |
展開 / 折りたたみリンクの表示 | false | ページツリーの一番上に「すべて展開」および「すべて折りたたみ」リンクを表示する場合に選択します。読者はこれらのリンクをクリックし、一度にツリーのすべてのブランチを開く/閉じることができます。 wikimarkup とストレージ形式で利用可能な値:
|
開始時の深さ | 1 | 最初に開いたときに、ツリーに表示する子の数を設定するには、0 より大きい数を入力します。 |
コードの例
次の例は、Confluence ページの基本的なマークアップを調べたり、編集したりする上級ユーザー向けに提供されています。
マクロ名: pagetree
マクロ本文: なし。
保存形式の例
<ac:structured-macro ac:name="pagetree">
<ac:parameter ac:name="reverse">false</ac:parameter>
<ac:parameter ac:name="sort">natural</ac:parameter>
<ac:parameter ac:name="root">
<ac:link>
<ri:page ri:content-title="Page Name"/>
</ac:link>
</ac:parameter>
<ac:parameter ac:name="startDepth">3</ac:parameter>
<ac:parameter ac:name="excerpt">true</ac:parameter>
<ac:parameter ac:name="searchBox">true</ac:parameter>
<ac:parameter ac:name="expandCollapseAll">true</ac:parameter>
</ac:structured-macro>Wiki マークアップの例
{pagetree:root=Page Name|sort=natural|excerpt=true|reverse=false|startDepth=3|expandCollapseAll=true|searchBox=true}