Reporting List Item macro allows one to specify details about single list level of reporting list:

  • Parameters are specified for a single list level and these parameters are repeated for each list report line of this level. There is a special variable CurrentItem, which corresponds to appropriate JSON object on each report line. So, this is a most tricky part of this plug-in: here you specify what will be the main contents of the reporting list by referencing current line JSON object fields and applying any calculations to it. Note, that for the formulas to be processed the Body content type parameter value should be set to anything other than Text only. Examples:
    • "UPPER(CurrentItem.title)" - shows the page title in the uppercase.
    • "CurrentItem" - shows whole JSON object JSON, which is convenient when configuring reports.

Reporting List Item macro has the following parameters:

Parameter Description
[Enum] List item type (default='Unordered list item')

Specifies the list level type - whether it is an ordered list or unordered list. This parameter may have one of the following values:

  • Unordered list item
    • Means, that the list on this level will be unordered.
  • Ordered list item
    • Means, that the list on this level will be ordered.
[Enum] Body content type (default='Single expression')

Specifies, how the Body content parameter text should be processed - whether it is a plain text or a single formula or a mix of formulas and text. This parameter may have one of the following values:

  • Text only
    • Means, that the specified text will be shown as is. In this case no formulas are searched for in it.
    • Example: "Text".
  • Single expression
    • Means, that the specified text is a formula, which should be calculated and its result will be shown.
    • Example body content: "'Child pages: ' & JSONARRAYLENGTH(CurrentItem.children.page.results)".
  • Text and expressions in square braces
    • Means, that there are the formulas in the text, enclosed in square brackets. All these formulas will be calculated and replaced with the calculation results.
    • Example body content: "Child pages: [JSONARRAYLENGTH(CurrentItem.children.page.results)]".
  • Text and expressions in curly braces
    • Means, that there are the formulas in the text, enclosed in curly brackets. All these formulas will be calculated and replaced with the calculation results.
    • Example body content: "Child pages: {JSONARRAYLENGTH(CurrentItem.children.page.results)}".
[String] Body content (default=''(Empty value))

Specifies the list item body content text. This value is processed according to Body content type parameter value (see examples above).
[Enum] Body output type (default='Plain text')

Specifies the way how the body content will be pre-processed before writing to the page. It may have one of the following values:

  • Plain text
    • Means, that the text will be shown as is.
    • (Technical) In this case the text is escaped before being shown, so '<' becomes '&lt;' and so on.
  • HTML
    • Means, that the text will not be escaped so you may specify or even calculate a correct HTML code to add any formatting or an image to your text.
    • In this case some additional checks are performed.
[Boolean] Skip items with no children (default='False')

Specifies whether the list items with no child elements should be skipped or not. If this parameter is True, the paremt list items with no children will be skipped.