Notation Guide

Print Help Tips
Lists

Lists allow you to present information as a series of ordered items.

Notation Comment
* some
* bullet
** indented
** bullets
* points
A bulleted list (must be in first column). Use more (**) for deeper indentations.

Example:

  • some
  • bullet
    • indented
    • bullets
  • points

- different
- bullet
- types
A list item (with -), several lines create a single list.

Example:

  • different
  • bullet
  • types

# a
# numbered
# list
A numbered list (must be in first column). Use more (##, ###) for deeper indentations.

Example:

  1. a
  2. numbered
  3. list

# a
# numbered
#* with
#* nested
#* bullet
# list

* a
* bulletted
*# with
*# nested
*# numbered
* list

You can even go with any kind of mixed nested lists:

Example:

  1. a
  2. numbered
    • with
    • nested
    • bullet
  3. list

  • a
  • bulletted
    1. with
    2. nested
    3. numbered
  • list

{checklist:name=The animals| parent=Animals|checklabels=mammal, oviparous, pets}

{checklist:name=Oviparious|parent=Animals|excerpt-heading=Classification|label=oviparous|checklabels=fish, amphibians, reptiles, birds|mutuallyexclusive=true}

{checklist:name=The pets| parent=demo:Animals| label=pets| excerpt-heading=Classification| comment-heading=Comments}

Generates a checklist for a subset of pages. The rows are children pages of a given page (parent) and can be filtered by a label. The columns can be labels that are set/un-set for the pages, the excerpt or a text.

The columns of the checklist can also be defined using the {checklist-label}, {checklist-input}, {checklist-wikiinput}, {checklist-select}, {checklist-excerpt}, {checklist-include}, {checklist-wiki}, {checklist-metadata} macros.

Generates a checklist for a subset of pages. The rows are children pages of a given page (parent) and can be filtered by a label.

The columns can be labels that are set/un-set for the pages, the excerpt or a text. You can set/unset the tag in the row pages and edit the text.

Parameters value can have any of the following keywords that will be replace when rendering the page:

Keyword Value
@user@ current user's name
@userfullname@ current user's full name
@self@ or title the title of the page owning the checklist
@creator@ the page creator's user name
@modifier@ the last modifier's user name
@any other value name@ the given metadata value in the page owning the checklist

parameter Mandatory? Default description
name or unnamed
first parameter
no current page's name the name of the checklist
parent no   the parent page, if not set, and there is no label set either, then the page containing the checklist will be used as such
label no   the label the selected must have
space no   the space to reduce the query to, when using label only and no parent
depth no 0 depth of the search for children ('0' for no limit)
childrenonly no false whether or not parent-children are to be included
sort no name How the table should be sorted: name to sort by name, created to sort by page creation date, or modified to sort by last modification date
checklabels no   a comma separated list of labels to be used to 'check' the pages
mutuallyexclusive no false whether or not the checklabels are mutually exclusive
excerpt-heading no   the heading for the excerpt column
comment no   the heading for a column to be used for comments
class no grid the style sheet (CSS) class to use for the table
pagelink no true whether or not to include a link to the pages as the first column of the table

Examples

Lets say we have a page Animals as parent of the pages Dog, Cat, Shark, Elephant, Turtle, Salmon, Snake, Whale, Frog, Toad, Lizard, Platypus and Eagle.

In the first example, all the children of Animals are shown. The checks are for the labels mammal, oviparous and pets. Whenever any the check is selected, the appropriate label is added/removed to/from the page on the row.

In the second example, the excerpt of each page is shown, and it will show only the children of Animals that have the label oviparous and the check labels bird, fish, amphibian and reptile are mutually exclusive.


In the third example, only the children of Animals that have the label pets are shown. The excerpt of each page is shown and a comment can be added to each page in the checklist


Note how the comment text can be actual wiki content.

{checklist-label:Mammal?|label=mammal}

When used within a {checklist} macro, it defines a column as a label check. Every time a cell of this column is selected, the label will be added/removed to/from the referred page

parameter Mandatory? Default description
heading or unnamed
first parameter
yes   The heading of the column
label no the heading The label to be used to 'check' the pages
width no   width of the column
class no   the style sheet (CSS) class to use for the cells
readonly no false whether or not the column is read-only

Example

{checklist:name=Pets|parent=Animals|label=pets}
   {checklist-label:Mammal?|label=mammal}
{checklist}
Will render as:
{checklist-input:Common pet names|cols=20}

When used within a {checklist} macro, it defines a column as a text input.

parameter Mandatory? Default description
heading or unnamed
first parameter
yes   The heading of the column
cols yes   The maximum number of characters read
width no   width of the column
class no   the style sheet (CSS) class to use for the cells
readonly no false whether or not the column is read-only
sorttype no S Type of value to be used to sort the table by this column. Values could be any of A, C, D, F, I, S, as defined in the Table Plugin
store no rows Determines where to store the value. Use rows to store the values for this column into the pages representing each row (metadata value name is <Column Heading>), or checklist to store the values into the page containing the checklist (metadata value name is <Column Heading>.<Row page title>)

Example

{checklist:name=Pets names|parent=Animals|label=pets}
   {checklist-input:Common pet names|cols=20}
{checklist}
Will render as:
{checklist-wikiinput:Comments| rows=5| cols=20| width=90%}

When used within a {checklist} macro, it defines a column as a wiki-text input.

parameter Mandatory? Default description
heading or unnamed
first parameter
yes   The heading of the column
cols yes   The number of columns in the text area when editing the value
rows no 1 The number of rows in the text area when editing the value
width no   width of the column
class no   the style sheet (CSS) class to use for the cells
readonly no false whether or not the column is read-only
sorttype no S Type of value to be used to sort the table by this column. Values could be any of A, C, D, F, I, S, as defined in the Table Plugin
store no rows Determines where to store the value. Use rows to store the values for this column into the pages representing each row (metadata value name is <Column Heading>), or checklist to store the values into the page containing the checklist (metadata value name is <Column Heading>.<Row page title>)

Example

{checklist:name=The pets| parent=Animals| label=pets}
    {checklist-wikiinput:Comments|rows=5|cols=20|width=90%}
{checklist}
Will render as:
{checklist-select:Can swim?}
yes
no
{checklist-select}

{checklist-select:Type|uselabels=true}
fish|It's a fish
amphibians|It's an amphibian
reptiles|It's a reptile
birds|It's a bird
{checklist-select}

{checklist-select:Who owns one?|usersgroup=all}

When used within a {checklist} macro, it defines a column as a selection (drop-down menu). The selection can be from a list of options, a list of labels or a list of users.

parameter Mandatory? Default description
heading or unnamed
first parameter
yes   The heading of the column
uselabels no false instead of setting a metadata value, add the selected label
usersgroup no   instead of listing the value, use the given users group to select from a list of users. Use all for listing all the users
width no   width of the column
class no   the style sheet (CSS) class to use for the cells
readonly no false whether or not the column is read-only
sorttype no S Type of value to be used to sort the table by this column. Values could be any of A, C, D, F, I, S, as defined in the Table Plugin
store no rows Determines where to store the value. Use rows to store the values for this column into the pages representing each row (metadata value name is <Column Heading>), or checklist to store the values into the page containing the checklist (metadata value name is <Column Heading>.<Row page title>)
macro body     If no usersgroup is given, the options to select from have to be defined as part of the body. Each line of the body define an option. Each option could have a different value from the actual caption by defining it as <value>|<caption>

If store is set to checklist and there is only one option to select from, then the column is handled as a checkbox.

Examples

{checklist:name=Swimmers|parent=Animals|label=oviparous}
   {checklist-select:Can swim?}
      yes
      no
   {checklist-select}
{checklist}
Will render as:
{checklist:name=The oviparious|parent=Animals|label=oviparous}
   {checklist-select:Type|uselabels=true}
       fish|It's a fish
       amphibians|It's an amphibian
       reptiles|It's a reptile
       birds|It's a bird
   {checklist-select}
{checklist}
Will render as:
{checklist:name=Pets on the team|parent=Animals|label=pets}
   {checklist-select:Who owns one?|usersgroup=all}
{checklist}

Will render as:
{checklist-wiki:Photo}
!photo.jpg!
{checklist-wiki}

When used within a {checklist} macro, it defines a column as a wiki segment to be rendered for each of the pages on the checklist.

parameter Mandatory? Default description
heading or unnamed
first parameter
yes   The heading of the column and the metadata value name
width no   width of the column
class no   the style sheet (CSS) class to use for the cells
sorttype no S Type of value to be used to sort the table by this column. Values could be any of A, C, D, F, I, S, as defined in the Table Plugin
macro body     the wiki segment to be rendered for each page on the checklist

Example

Assuming each of the pages contains an attachment photo.jpg

{checklist:name=Da pets|parent=Animals|label= pets}
   {checklist-wiki:Photo}
       !photo.jpg!
   {checklist-wiki}
{checklist}
Will render as:
{checklist-excerpt:Classification|width=10%}

When used within a {checklist} macro, it defines a column as the excerpt of each of the pages.

parameter Mandatory? Default description
heading or unnamed
first parameter
yes   The heading of the column
width no   width of the column
class no   the style sheet (CSS) class to use for the cells
sorttype no S Type of value to be used to sort the table by this column. Values could be any of A, C, D, F, I, S, as defined in the Table Plugin

Example

{checklist:name=pets| parent=Animals| label=pets}
    {checklist-excerpt:Classification|width=10%}
{checklist}
Will render as:
{checklist-pagelink:Edit|destination=view|width=10%}

When used within a {checklist} macro, it defines a column as a link to each of the pages.

parameter Mandatory? Default description
heading or unnamed
first parameter
yes   The heading of the column
destination no view the link should go to (view or edit)
width no   width of the column
class no   the style sheet (CSS) class to use for the cells
sorttype no S Type of value to be used to sort the table by this column. Values could be any of A, C, D, F, I, S, as defined in the Table Plugin
{checklist-include:Full page}

When used within a {checklist} macro, it defines a column as the entire content of each of the pages.Use with caution, it can get really messy.

parameter Mandatory? Default description
heading or unnamed
first parameter
yes   The heading of the column
width no   width of the column
class no   the style sheet (CSS) class to use for the cells
sorttype no S Type of value to be used to sort the table by this column. Values could be any of A, C, D, F, I, S, as defined in the Table Plugin

Example

{checklist:name=All the pet's pages|parent=Animals|label= pets}
   {checklist-include:Full page}
{checklist}
Will render as:
{checklist-metadata:Comments}

When used within a {checklist} macro, it defines a column as a lookup of existing metadata for each page.

parameter Mandatory? Default description
heading or unnamed
first parameter
yes   The heading of the column and the metadata value name
width no   width of the column
class no   the style sheet (CSS) class to use for the cells
sorttype no S Type of value to be used to sort the table by this column. Values could be any of A, C, D, F, I, S, as defined in the Table Plugin

Example

{checklist:name=The pets names|parent=Animals|label=pets}
   {checklist-metadata:Comments}
{checklist}
Will render as:
{checklist-attribute:attribute=Common pet names}

{checklist-attribute:page=confluence:Cat| attribute=Comments}

Displays the value of an attribute set on a page through a {checklist}

parameter description
page (optional) title of the page to lookup. If none set, then the current page will be used
attribute Name of the attribute (column) set in the checklist


The first example on the side will display fido, dino... if the segment is in the Dog page

The second example on the side will display If you are a cat person... from any page

{checklist-log:format=useranddate| maxentries=1|Comments}

Generates a checklist change report for a given page.

parameter Mandatory? Default description
page no current page The title of the page to generate the report from
maxentries no 0 (no limit) The maximum number of entries to report (0 for no limit)
maxentriespername no 0 (no limit) The maximum number of entries per value name (0 for no limit)
mostrecentfirst no false whether or not display the most recent entry first
format no detailed Defines the way each of log entries is to be reported:
date : display only the date
dateanduser: display the date and use
detailed: display all the available information
newvalue: display only the new value
oldvalue: display only the last value
simple: display date, user and new value in a single line
user: display only the user
useranddate: display the user and date
remaining
unnamed parameters
no   each remaining unnamed parameters in the macro indicate what name values are to be included in the report. If none set, the report will include all the value names

Example

{checklist-log:format=useranddate|maxentries=1|Comments}
Will render as:
{checklist-column:heading=Classification| type=excerpt| width=5%}
{checklist-column:heading=Mammal| type=label| label=mammal}
{checklist-column:heading=Comments| type=text| cols=30| readonly=true}
{checklist-column:heading=Common pet names| type=text| rows=5| cols=20}

This macro is being deprecated. Use {checklist-label}, {checklist-excerpt} or {checklist-wikiinput} instead.

Defines more detailed column information for a {checklist}.

parameter Mandatory? Default description
heading yes   Heading of the column
type yes   type of column. It can be any of label, text or excerpt
label yes, if
type=label
  the label to be used to 'check' the pages
rows yes, if
type=text
  rows when editing text area
cols yes, if
type=text
  cols when editing text area
width no   width of the of column
readonly no false whether or not the column is read-only

Note that the {checklist-column} macro must be contained within a {checklist} macro.

{dynamictasklist:thingsToDo}
{dynamictasklist:thingsToDo|showAssignee=false}
{dynamictasklist:thingsToDo|promptOnDelete=false}

The Dynamic Tasklist Macro displays a task list which can be modified in the page as it is viewed. Despite the fact that this plugin has an ajax UI, it is still fully versioned like a normal Confluence page.

  • showAssignee - (optional) If set to true the assignee will be shown in the tasks.
  • width - (optional) The width of the tasklist (default is 640px). To set the width to 400 pixels, set the parameter value to 400px.
  • enableLocking - (optional) If set to true, tasks can be locked so other users can not modify.
  • autoLockOnComplete (optional) Used in conjunction with enableLocking. Tasks will auto lock when it is completed.
  • promptOnDelete - (optional) If set to false there will not be any confirmation prompt when deleting a task.

Example:
What you need to type What you will get
{dynamictasklist:Arthurs To-Do's}
{dynamic-table}
|header1|header2|header3|
{dynamictable}

{dynamic-table:id=myId}
|header1|header2|header3|
{dynamictable}

{dynamic-table:myId|title=Table Title}
|header1|header2|header3|
{dynamictable}

Dynamic Table Macro

Displays a dynamic table. Rows are added to the table, removed from the table and re-ordered while viewing the page. dynamictable is equivalent to dynamic-table for compatibility with older versions of this plugin. The body of the macro is used to determine the column headings. The first row with text is used - the text is a pipe (|) separated list of column headings. Use "| |" for a blank column heading.

  • id - Optional. Can be specified as the default parameter. A way to specify a unique id to identify this instance of the macro. By default, a numeric id is automatically assigned based on the order of the macro on the page.
  • title - Optional. Title to display as first line of table. If the default parameter is specified, it will be used as the table title as well as the id.