抜粋インクルード マクロ
抜粋のインクルードマクロは、とあるページから他のページへコンテンツを「抜粋」(一部分)して表示する際に使用します。
このマクロを使用する前に、抜粋が抜粋マクロで定義されている必要があります。マクロは次のように利用できる点にご注意ください。
- ページで任意の数の抜粋インクルード マクロを使用可能
- ページで 1 つの抜粋マクロのみを使用可能
例
以下の例では、エディタに表示される抜粋インクルード マクロと、ページを表示した際にそれがどう見えるかを示しています。ページ タイトルとコンテンツ周囲のパネルの両方を表示するオプションを設定しています。
- エディタに表示される抜粋インクルード マクロ。
- ページを表示した際の抜粋インクルード マクロ。
コンテンツは、"reusable note" と呼ばれるページの抜粋マクロから取り込まれます。
抜粋インクルードマクロを使用する
ページに抜粋インクルードマクロを追加するには:
- エディタのツールバーで、[挿入] > [その他のマクロ] を選択します。
- 対象のマクロを見つけて、選択します。
オートコンプリートを活用して素早く入力: 「{」とマクロ名の先頭を入力すると、マクロ候補の一覧が表示されます。この例では、cheese マクロを挿入します。
既存のマクロを編集する方法: マクロのプレースホルダをクリックして、[編集] を選択します。これによりマクロの詳細を開き、マクロのパラメーターを編集できます。
パラメーター
パラメーターは、マクロ出力の内容や形式を制御するために設定できるオプションです。Confluence の保存形式または wiki マークアップで使用されるパラメータ名がマクロ ブラウザで使用されるラベルと異なる場合、以下の一覧に括弧付きで表示されます (example
)。
パラメーター | 既定 | 説明 |
---|---|---|
抜粋を含むページ | なし | 表示する抜粋を含むページ名を入力します。抜粋は、同じスペースまたは同じ Wiki の別のスペースにあるページから行います。 抜粋インクルードマクロ ダイアログにページ名を入力すると、他のスペースのページも含め、Confluence がマッチするページをリスト表示します。 あるいは、以下のようにスペースキーとページ名をコロン (:) でつなげて入力することも可能です。
このパラメーターは Wiki マークアップで名前が付けられていません。 |
周囲のパネルを削除 | false | Confluence で抜粋コンテンツの周囲にパネルを表示するか否か決定します。パネルは抜粋を含むページタイトルとパネルのボーダーを表示します。既定値では、パネルとタイトルが表示されます。 |
Wiki マークアップの例
以下の例は、エディタ外部 (スペースのサイドバー、ヘッダー、フッターのカスタム コンテンツなど) でマクロを追加する場合に便利です。
マクロ名: excerpt-include
マクロ本文: なし。
{excerpt-include:My page name|nopanel=true}