User Guide

This guide will show you all the existing macros that Comala Lists provides to create your checklist.

If you haven't started yet, we recommend you to read Getting Started with Comala Lists. For illustration purposes, we also include examples for all of them.

User Guide - Comala Lists macros

All Comala List app macros (except the list log macro) are added to the body of the list macro.

Examples - list macro — Managing lists of pages and their labels - Examples 1, 2, 3
Example - list wiki macro — Adding wiki content including images as list items - Example 8
Example - Create a checklist for a requirements review — A more sophisticated checklist used for a requirements list review - Example 11
Example - list log macro — Create a report log of changes - Example 10
Example - list include macro — Adding entire page content as list items - Example 9
Examples - list select macro — Adding a column as a dropdown selection for each item using labels, metadata or users - Example 5, 6, 7
Example - list label macro — Creating a label check heading and allowing plain text notes for a list column - Example 4

A number of examples include the use of more than one macro within the body of the list macro to define columns in the displayed list.

Within each list macro, you can use parameters to use as variables in your lists.

The parameter values can have any of the following keywords that will be replaced 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