...

Provides a user form with input fields before rendering the body of the macro. Form fields will be used to replace variables in the body prior to rendering. Field values can be provided by user interaction, pre-defined variables, or request parameters. Any text in the macro body that begins with $ immediately followed by a key found in the replace parameter list (see Field types for details) will be replaced by the value. Normally, values will be provided by a user submitting a form from the page based on the replace parameter. Default values can be specified.

...

Parameters

Field Types

See Field types.

Advanced capabilities

...

1. Horizontal radio button - gender:M:Gender:radio::M:Male:F:Female
2. Single select with 12 lines - month:12:Month:select:12:1:Jan:2:Feb:3:Mar:4:Apr:5:May:6:Jun:7:July:8:Aug:9:Sept:10:Oct:11:Nov:12:Dec
3. Checkbox (value same as text) - day::Day of$nbsp;week:checkbox-required:7:Sunday::Monday::Tuesday::Wednesday::Thursday::Friday::Saturday

Export

The htmlHTML, representing the rendered body of the macro, can be exported to a page attachment or to the file system. This enables the dynamic content to be captured at a point in time for later viewing. An attachment or file created by this type of export , can be used on a page by including it in the body of an html HTML macro. For example: {html:script=^bobs.html} {html}. If exportVersion=keep is used, the referenced attachment is already there, and the HTML macro is authorized for use on the page, then the macro body will not be rendered and the attachment will be included instead. This enables caching and automation capabilities.

...

Request parameters are case sensitive. Look at the url URL after pressing the run button or after an autorun. This url URL can be used as a link. Usually, the url URL contains the page title. If the page title contains special characters or you wish to have a more persistent link (that survives page renames or moves), then Confluence's alternate page view url URL can be used: .../pages/viewpage.action?pageId=......... The view url can be constructed by looking at the url URL after going to Tools->Info. Tiny links cannot be used (CONF-11594   ). Each parameter is represented by a request parameter composed of _ separated elements:

• run - constant
• id - id associated with this run instance - see the id parameter
• parameter key - the first component of the key:value:description triple

...

• If the initial value needs to be specified with more than one selection, the value must be a single quoted, comma-separated list of choice values.
• The replacement value for such a field is a single quoted, comma-separated list of single-quoted selected values.
• Checkbox and multi-select entries appear multiple times as a request parameter with a value matching values that have been selected.
• Embedded single quotes are doubled.

...

{run:replace=greeting:Hello,who:Bob}
{beanshell}
 System.out.println("$greeting $who");
{beanshell}
{run}

...