Guide to User Macro Templates

The 'template' is one of the fields that you will define when creating a user macro. (See the rest of the guide to writing user macros.) This page gives you guidelines about the code you can enter in a user macro template.

このページの残りの部分では、上記の手順を詳しく説明します。

On this page:

Coding in HTML or Wiki Markup

If you chose an output format of 'HTML', you must write the content of the template using HTML. In addition, you can use the Velocity templating language. For more information about the Velocity template language, see the Velocity user's guide.

If you chose an output format of 'Wiki Markup', you must write the content of the template using Confluence wiki markup.

Note: When coding in wiki markup, you can use $body, $paramFoo and Velocity too, as described in detail below. For example:

Foo $!paramFoo Honk
$body
Bar
$action.getText('done.name')
Eek

Accessing your Macro's Body

Use the $body object within your user macro template to access the content passed to your macro in the macro body.

The $body object is available if you have specified that your macro has a body (in other words, if you have not selected 'No macro body').

Example: Let's assume your macro is called helloworld.
Enter the following code in your template:

Hello World: $body

A user enters the following on a Confluence page:

{helloworld}From Matthew{helloworld}

Wiki ページには次のように表示されます。

Hello World: From Matthew

Using Parameters in your User Macro

You can specify parameters for your macro, so that users can pass it information to determine its behaviour on a Confluence page.

How your Macro's Parameters are Used on a Confluence Page

When adding a macro to a Confluence page, users can pass parameters to your user macro in the same way as any other macro:

• When adding the macro via wiki markup, users can pass parameters separated by the pipe (|) sign.
• The Macro Browser will display an input field for each of your macro's parameters. The field type is determined by the parameter type you specify for each parameter.

Defining the Parameters

In summary, a parameter definition contains:

• @param
• パラメーター名
• A number of attributes (optional)

形式:

## @param MYNAME:title=MY TITLE|type=MY TYPE|desc=MY DESCRIPTION|required=true|multiple=true|default=MY DEFAULT VALUE

追加情報：

• The order of the parameters in the template determines the order in which the Macro Browser displays the parameters.
• テンプレートの冒頭部分でパラメーターを定義することをお勧めします。
• 指定したパラメーターの種類に応じて、追加の属性がある場合があります。

以下のセクションでは、それぞれの属性の詳細を示します。

Parameter Name

パラメーター名はリストの最初の属性です。name 属性自体には名前がありません。

例： 次のコードは、「foo」と「bar」という名前の 2 つのパラメーターを定義します。

## @param foo
## @param bar

Parameter Type

パラメーターのフィールド タイプ。タイプを指定しない場合、既定値は string になります。

## @param colour:title=Colour|type=enum|enumValues=Grey,Red,Yellow,Green

## @param status:title=Status|type=string|required=true|desc=Status to display

## @param page:title=Page|type=confluence-content|required=true|desc=Select a page do use

## @param user:title=Username|type=username|desc=Select username to display

## @param space:title=Space|type=spacekey

## @param fromDate:title=From Date|type=date|desc=Date to start from. Format: dd/mm/YYYY 

## @param numPosts:title=Number of Posts|type=int|default=15|desc=Number of posts to display

## @param pcent:title=Percentage|type=percentage|desc=Number of posts to display 

Using the Parameters in your Macro Code

パラメーターは、テンプレートでは $paramfoo、$parambar ("foo" および "bar" という名前のパラメーターの場合) などの形式で使用できます。

This example shows how the parameters would be used on a wiki page: {macro:foo=value|bar=value}.

通常、不足している $paramfoo などのパラメーターは、出力で '$paramfoo' などと表示されます。パラメーターが設定されていない場合に何も表示しないようにするには、ドル記号 ($) の後に感嘆符 (!) を付けて「$!paramfoo」のようにします。

Using No Parameters

If your macro does not accept parameters, you should use @noparams in your template. That will let Confluence know that it need not display a parameter input field in the Macro Browser.

If the user macro contains no parameters and does not specify @noparams, then the Macro Browser will display a free-format text box allowing users to enter undefined parameters. This can be confusing, especially if the macro does not accept parameters.

例： テンプレートの冒頭部分に次の行を追加します。

## @noparams

Other Objects Available to your Macro

As well as the macro body and parameters, there are a variety of Confluence objects available in the Velocity context. In addition to the default context, user macros also include the following:

For a list of objects available in the default Velocity context, see the developer documentation.

関連トピック

Writing User Macros
Examples of User Macros