Help

Avoiding macro syntax errors

Macro markup is space sensitive and has to be valid YAML syntax. This means that if you include macros with incorrect spacing or invalid characters in wiki pages or cards you may see macro syntax errors.

Spacing errors

We advise that you either copy the macro examples that are used in macro reference or use the wiki toolbar to help you create your macros. These will give you charts that should not have any spacing issues.

Markup errors

If a property, project variable or type name or value has a colon (:) included in its name then the macro may have problems with YAML parsing. For example, if a property value was called "Release 1: The Beginning" using this in macros may cause a YAML parsing error to be seen.

In these scenarios, if you want to include a colon (:) in a name then you will need to wrap the whole value of the macro parameter in single and double quotes.

    {{
    table query: "SELECT name, number WHERE Release = 'Release 1: The Beginning'"
    }}

When quoting project variables ensure the quotes are used around the project variable name.

     {{
     table query: "SELECT name, number WHERE Release = ('Release 2: Enhancements')"
     }}

For more help around YAML and what constitutes valid YAML markup you can refer to http://yaml.org/spec/current.html.