User Macro Module

https://developer.atlassian.com/display/CONFDEV/User+Macro+Module

Confluence Administration Consoleの中のuser macroを定義することで、プラグインを書くことなくuser macrosを作成することができる。

user macro pluginを加える

user macroはConfluence plugin moduleの一種である。

一般的なプラグインの情報についてより知りたい場合は、Confluence Plugin Guideを読んで下さい。
プラグイン（マクロ含む）をどのようにインストールし形成するかを学ぶために、DOC:Installing a Plugin and Macrosを読んで下さい。
貴方自身のプラグインを書く導入として、Writing Confluence Pluginsを読んで下さい。

※User macro plugin modulesはConfluence2.3以降で可能である。

※via the Universal Plugin Manager(Confluence3.4以降でデフォルトのplugin maneger)にプラグインをuploadするために、atlassian-plugin attribute pluginsVersion='2' as shown in the example bellowをセットする必要がある。

User Macro Plugin Modules

User macro plugin modules はプラグイン開発者にJavaのコードを追加で記述することなく、シンプルなマクロを直接atlassian-plugin.xml内に定義することを許す。
user macro plugin modulesは管理上のコンソールにとって形成されたDOC:Writer User Macroと機能的に同一である。それ以外は、それらは正常なプラグインと同じ方法でパッケージし分配することができる。

※plugin modulesによってインストールされたuser macroはadministrative consoleのuser macro section内には出現せず、user interface内からは編集することができない。

Macro Plugin Moduleの形成

Macro plugin moduleは次の例のように完全のatlassian-plugin.xml file内に形成されている。

<templete>のセクションは必要で、マクロを与えるために使用されるvelocity templeteを定義する。
DOC:Writing User Macros内で利用可能な全てのVelocity variables はuser macro plugin modules内で利用可能である。
マクロのnameとkeyはMacro Moduleと同様に指定されるだろう。
No class attributeは必要である。（class attributeは必要ない？）
<user-macro>elementのattributesは、user macroのための対応する位置と一致する。

利用可能なattribute

属性値	必須	初期値	設定可能値
hasBody	No	false	・true-{hello}world{hello}のようにブレースで囲まれていて間に$bodyという変数を持つ・false-単独のマクロ{name}のようになる
bodyType	No	raw	・raw-$bodyはマクロテンプレートにそのまま渡されて組み込まれる・escapehtml-$bodyはHTML タグをエスケープされて組み込まれる・redered-$bodyはWikiテキストとしてレンダリングされたあとにマクロテンプレートに組み込まれる
outputType	No	html	・html-出力するページにHTMLとして挿入される。・wiki-HTMLにレンダリングされる前のWikiテキストとして挿入される。