Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section
titleProperties

The macro provides the following properties.

Section
titleDoctype

Specify the type of the documents to select. If documents from more than one document type are to be selected, enumerate them in a comma-separated list. Leave blank to select documents from any doctypes.

Section
titleName Template

Define a template to render list item values or definition list terms.

To reference a property, use this syntax: ${Property Name}

Link references are supported: Replace the curly braces with brackets: $[Property Name]. If no link reference is provided, the whole name is rendered as link.

Version Box
since4.13

Since version 4.13 the parameter supports to reference a

Static Document Link
documentSpace Properties
labelspace property
. The name of the space property has to be prefixed with the paragraph sign ('§').

For instance, if the value for the name template parameter is specified by the space property my-name-template, then the value of the name template parameter is §my-name-template.

Transclusion
documentDisplay Document Properties Macro
idssupported-html-elements


Section
titleData Template

Define a template to render definition list descriptions. This parameter is only considered if a list of type definition is used.

To reference a property, use this syntax: ${Property Name}

Link references are supported: Replace the curly braces with brackets: $[Property Name].

Version Box
since4.13

Since version 4.13 the parameter supports to reference a

Static Document Link
documentSpace Properties
labelspace property
. The name of the space property has to be prefixed with the paragraph sign ('§').

For instance, if the value for the data template parameter is specified by the space property my-data-template, then the value of the data template parameter is §my-data-template.

Transclusion
documentDisplay Document Properties Macro
idssupported-html-elements


Transclusion
taget-heading-level*
documentDisplay Table Macro
idsWhere


Transclusion
taget-heading-level2
documentSort By Property
idsSort By


Section
titleMax Hit Count

Limit the maximum number of hits in the result set.

Section
titleRestrict to immediate Children

If checked, only immediate children of the current document are valid as hits.

Section
titleRestrict to Favored
Transclusion
documentDisplay Table Macro
idsRestrict to Favored


Section
titleExclude Self

If checked excludes this document from the query result.

Section
titleRender Children

For each hit also render the direct and transitive children.

Does not apply to definition lists.

It is not necessary for the children to match the query constraints. If a child is also a hit, it will be rendered twice. Limit the chance of redundant hit by selecting the restriction to immediate children or by adjusting the query accordingly.

Tip Box

If you just want to select on the root documents of a type, use the following in your where clause:

Code Block
*:* -Parent:[* TO *]

This feature is available since version 1.10.

Section
titleSpace Key

To limit the search on documents to the space with the given key.

The editor allows to scan for space names. If you want to select more than one space, use the space keys text field (in addition to this field).

Section
titleSpace Keys

To limit the search on documents to the spaces with the given keys. Use this if you want to search in several spaces.

Leave blank, if you want to search in the current space only. Use "@all" to search in all spaces.

Section
titleList Type

Controls the type of the list. May be an ordered, unordered or definition list.

Section
titleIdentifier

Unique identifier for the rendered content.

This identifier is used for Remote Control and Context Controlled Macros.

Transclusion
taget-heading-level*
documentDisplay Table Macro
idsIdentifier Classes


Transclusion
taget-heading-level*
documentDisplay List Macro
idsContext controlled


Transclusion
taget-heading-level*
documentDisplay List Macro
idsRemote Controls


Section
titleCSS Classes

The name of the CSS classes to apply to the list elements.

Transclusion
taget-heading-level*
documentDisplay Table Macro
idsRender no hits as blank


Transclusion
taget-heading-level*
documentDisplay Table Macro
idsNo Hits Text


...