ガジェット マクロ
ガジェットは、小さいながらも大きな機能を備えたアプリケーションです。通常、Web アプリケーション サーバーから提供され、他の多くの Web アプリケーションで再利用が可能です。Confluence では、ガジェット マクロを使用してページやブログ投稿にガジェットを追加します。
Confluence にはページやブログ投稿に追加できる独自のガジェットがいくつかバンドルされています。Confluence 管理者が次のことを完了している場合、このリストにある他のガジェットにもアクセスできます。
- Confluence に付加ガジェットをインストール済み（通常 Confluence プラグインとして）、または
- 外部の Web アプリケーションまたは Web サイト (JIRA アプリケーションなど) から提供されるガジェットを登録済み
他のマクロとは異なり、ガジェットマクロの名前は独特で、以下のような形式をとります。"<gadget-name> macro"、ここで<gadget-name> はガジェット自体から与えられる名前が付けられます。
Confluence ページやブログ投稿にガジェットを挿入する
ページにガジェットを追加するには：
- ページまたはブログ投稿を編集します。
- 挿入 > その他のマクロを選択します。
- 外部コンテンツをクリックし、Confluence インストール版で利用可能なガジェットのリストを参照します。
（外部コンテンツにアクセス可能な、JIRA 課題、RSS フィード、ウィジェット コネクタなどの Confluence マクロも同じカテゴリに表示されます。） - ガジェットのパラメーターとプロパティにアクセスします。
多くのガジェットではマクロダイアログに表示される、基本的なパラメーターの設定が可能になっています（下記参照）。独自のセットになったパラメーターを持つガジェットもあり、この場合、パラメーターはセットでのみ有効で状態になっています。ガジェットには、マクロブラウザのプレビューからアクセスできます。 - 要件に合わせてパラメーターを設定します。
- 再読み込みをクリックして変更をプレビューします。
- 挿入をクリックしてページにガジェットを追加します。
Confluence ページやブログ投稿でガジェットを編集する
ページやブログ投稿で既存のガジェットを編集するには：
- ページまたはブログ投稿を編集します。
- ガジェットマクロ プレースホルダーをクリックし、編集を選択します（またはプレースホルダーをダブルクリックします）。
- 要件に合わせてガジェットのパラメーターを設定します。
- 再読み込みをクリックして変更をプレビューします。
- ガジェットを保存します。
標準ガジェット パラメーター
多くのガジェットではマクロ ダイアログの右側に表示される、基本的なパラメーターの設定が可能になっています（下記参照）。各ガジェットはマクロ ダイアログの左側に表示される、独自のパラメーターセットを持っています。
パラメーター | 既定 | 説明 |
|---|---|---|
幅 | 450 pixels | 以下のいずれかの方法でガジェット幅を設定します：
|
Border | true | ガジェットを細いグレーのボーダーで囲む。 |
ガジェット マクロのコンテンツ
標準パラメーターの追加では、ガジェットマクロには「パラメーター的」のコンテンツが含まれます。これは、各ガジェット固有の特殊なプロパティ設定を表示します。そのため、ここでは説明を控えます。通常、マクロブラウザを使用してガジェットの既定プロパティをカスタマイズした場合のみ、コンテンツが変更されます。
コードの例
次の例は、Confluence ページの基本的なマークアップを調べたり、編集したりする上級ユーザー向けに提供されています。
マクロ名: gadget
マクロ本文: なし。
以下の付加パラメータは保存形式および Wiki マークアップで使用可能です。
| パラメーター名 | 必須 | 既定 | パラメーターの説明と指定可能な値 |
|---|---|---|---|
url | はい | (なし) | ガジェット仕様が設定されている場所（XML ファイル）。 |
preferences | いいえ | (Gadget 依存) | 各ガジェット固有の、特定のプロパティ設定。 |
マークアップでのガジェットプロパティ（設定）を編集する際の注意：プロパティの値は Wiki マークアップや保存形式で直接編集することが可能ですが、無効な値しか入力できません。ガジェットプロパティが値をサポートしている場合、マクロブラウザはユーザーにプロパティに有効な値を選択させるよう制限します。そのため、ガジェットプロパティの編集には、マクロブラウザを使用することをおすすめします。
保存形式の例
これは Confluence ページ ガジェットの例です。
<ac:structured-macro ac:name="gadget">
<ac:parameter ac:name="width">500</ac:parameter>
<ac:parameter ac:name="border">false</ac:parameter>
<ac:parameter ac:name="url">rest/gadgets/1.0/g/com.atlassian.confluence.plugins.gadgets:confluence-page-gadget/gadgets/confluence-page-gadget.xml</ac:parameter>
<ac:parameter ac:name="preferences">spaceName=Documentation&spaceKey=DOC&quickfind-space=Documentation&pageId=753666&pageName=Documentation%20Home&quickfind-page=Documentation%20Home&isEditable=true&isConfigured=true&refresh=15&showLink=false</ac:parameter>
</ac:structured-macro>
これは Confluence ニュース ガジェットの例です。
<ac:structured-macro ac:name="gadget">
<ac:parameter ac:name="url">rest/gadgets/1.0/g/com.atlassian.confluence.plugins.gadgets:confluence-news-gadget/gadgets/confluence-news-gadget.xml</ac:parameter>
<ac:parameter ac:name="preferences"/>
</ac:structured-macro>
Wiki マークアップの例
これは Confluence ページ ガジェットの例です。
{gadget:width=500|border=false|url=rest/gadgets/1.0/g/com.atlassian.confluence.plugins.gadgets:confluence-page-gadget/gadgets/confluence-page-gadget.xml} spaceName=Documentation&spaceKey=DOC&quickfind-space=Documentation&pageId=753666&pageName=Documentation%20Home&quickfind-page=Documentation%20Home&isEditable=true&isConfigured=true&refresh=15&showLink=false {gadget}
これは Confluence ニュース ガジェットの例です。
{gadget:url=rest/gadgets/1.0/g/com.atlassian.confluence.plugins.gadgets:confluence-news-gadget/gadgets/confluence-news-gadget.xml} {gadget}