抜粋マクロ
抜粋マクロは、ページの一部を再利用できるようしるしをつけるために使用します。抜粋を定義すると、しるしをつけたコンテンツを抜粋マクロやブログ投稿マクロなど、他のマクロで表示することが可能になります。
抜粋は 1 ページにつき 1 つのみ定義できます。つまり、抜粋マクロはページに 1 回のみ追加できます。
抜粋マクロを使用する
ページに抜粋マクロを追加するには:
- Confluence のエディタで、[挿入] > [その他のマクロ] を選択します。
- 対象のマクロを見つけて、選択します。
オートコンプリートでマクロエントリを高速化: タイプ{とマクロ名の先頭には、提案したマクロの一覧を表示します。詳細は、こちらを参照ください。リンク、ファイル、マクロ、メンションのオートコンプリート
既存のマクロを編集する方法: マクロのプレースホルダをクリックして、[編集] を選択します。マクロのパラメータが編集可能な場合、マクロのダイアログ ウィンドウが開きます。
マクロに再利用可能なコンテンツを追加するには:
- 抜粋マクロ プレースホルダー内にコンテンツを追加します。
- マクロプレースホルダーを選択し、オプションパネルを開きます。次に、オプション;新たに行を追加して表示またはインラインで表示を選択します。既定値では、行を追加してマクロのコンテンツを表示します。インラインを選択すると、マクロのコンテンツは前後のテキストと同一パラグラフの一部として表示されます。このオプションは抜粋マクロを含むページにのみ影響します。コンテンツを再利用したページには影響しません。
スクリーンショット:抜粋マクロプ レースホルダーとオプション パネル
パラメーター
パラメーターは、マクロ出力の内容や形式を制御するために設定できるオプションです。Confluence の保存形式または wiki マークアップで使用されるパラメータ名がマクロ ブラウザで使用されるラベルと異なる場合、以下の一覧に括弧付きで表示されます (example
)。
パラメーター | 既定 | 説明 |
---|---|---|
抜粋したコンテンツを非表示にする | false | 抜粋マクロプレースホルダーに含まれるページコンテンツをページに表示するか否か管理します。 このオプションは抜粋マクロを含むページにのみ影響します。コンテンツを再利用したページには影響しません。 |
コードの例
次の例は、Confluence ページの基本的なマークアップを調べたり、編集したりする上級ユーザー向けに提供されています。
マクロ名: excerpt
マクロ本文: リッチ テキストの利用可
以下の付加パラメータは保存形式および Wiki マークアップで使用可能です。エディターのオプションパネルと同様に機能します。
パラメーター名 | 必須 | 既定 | パラメーターの説明と指定可能な値 |
---|---|---|---|
atlassian-macro-output-type | いいえ | BLOCK | 抜粋マクロ本体に含まれるコンテンツを新たに行を追加して表示するか、インラインで表示するか決定します。 利用可能な値:
このオプションは抜粋マクロを含むページにのみ影響します。コンテンツを再利用したページには影響しません。 |
保存形式の例
<ac:structured-macro ac:name="excerpt">
<ac:parameter ac:name="hidden">true</ac:parameter>
<ac:parameter ac:name="atlassian-macro-output-type">BLOCK</ac:parameter>
<ac:rich-text-body>
<p>This is the <strong>text</strong> I want to reuse in other pages. This text is inside an Excerpt macro.</p>
</ac:rich-text-body>
</ac:structured-macro>
Wiki マークアップ例
{excerpt:hidden=true|atlassian-macro-output-type=BLOCK}
This is the *text* I want to reuse in other pages. This text is inside an Excerpt macro.
{excerpt}