Databases Reference
In-Depth Information
If you don't specify the type of the parameter, it will default to a string. But there are
many more types available from which you can choose. Confluence will render the
input field of your parameter based on the type you specify.
Type
Description
boolean
Displays a checkbox to the user and passes the value
true
or
false
to the
macro as a string.
## @param hide:title=Should hide?|type=boolean
enum
Offers a list of values for selection. You can specify the values to appear
in the dropdown yourself. The variable will be passed on the to macro as
it is, including capitalization.
## @param color:title=Color|type=enum|enumValues=Grey,
Red,Green
string
Shows a text field; this is the default if no other type is specified.
## @param title:title=Title|type=string
confluence-
content
Shows a quick search where the user can search for a page or blog post
in Confluence.
## @param page:title=Page|type=confluence-
content|required=true
username
Shows a quick search for users.
## @param user:title=Username|type=username
spacekey
Shows a list of spaces for selection; the space key is passed on to
the macro.
## @param space:title=Space|type=spacekey
date
Currently threated as a normal string. Users can type a date in any
format; be sure to check the date in your template.
## @paramfromDate:title=From Date|type=date
int
Type is accepted, but currently treated as a normal string.
## @param numItems:title=Number of items|type=int
percentage
Type is accepted, but currently treated as a normal string.
## @param pcent:title=Percentage|type=percentage
The parameters are available in your template as, for example,
$paramtitle
and
$paramcolor
for parameters called title and color respectively.
Normally, if a parameter like
$paramtitle
is missing, it will appear as
$paramtitle
in the output. To output nothing when a parameter is not set, use an exclamation
mark after the dollar sign:
$!paramtitle
.
