Versions Compared

Key

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

...

Document Properties Marker
doctypemacro
overridefalse
Short DescriptionLists references to projectdoc documents in a list. List contain names and optional short descriptions.
Doctypemacrohide
NameDisplay List Macro
Parent
Parent Property
property-nameName

Audience
Name List
doctyperole
render-no-hits-as-blanktrue
render-list-as-comma-separated-valuestrue
namesAuthor, Template Author
propertyAudience

Categories
Name List
doctypecategory
namesDisplay / Query

Tags

Tag List
cssprojectdoc-compact
namesDynamic List, Query, Deep Link, Remote Control, Context Control, Autocomplete, Remote Controller


Type

Name List
doctypemacro-type
namesDynamic Navigation


Iteration

Iteration
valueproduction

hide
Supports Wiki Markup(tick)
Page Size Support(tick)
Sort Keyhide

Wiki Markup is supported

since version 2.5.

by this macro.

Section
indextrue
show-titlefalse
titleDescription

Renders the query result set as a unordered, ordered or definition list.

While the Display Table Macro allows to select the properties to be displayed in columns of a table, the Display List Macro renders the name of the document and optionally its short description. There are parameters to tweak the visual representation easily.

Adding constraints is done via the where parameter and it is possible to sort the result.

Version Box
since2.5
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
titleSelect for Name

Specify the property of the documents in the result set to be displayed as the list item label. The value defaults to Name if not specified.

Available since version 1.10.

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 in the original result set, 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 or plain.

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


Section
titleContext controlled

When checked configures parameters via document and space properties.

Version Box
title3.2

Available since version 3.2 of the projectdoc Toolbox.

The tip

Static Document Link
documentUse Context Controlled Macros
provides a short introduction in how to use this feature.

Section
titleRemote Controls

List of controls to pass to transcluded contexts. Controls are separated by slashes ampersand ('/&').

Version Box
since4.5

Available since version 4.5 of the projectdoc Toolbox.

This allows to control the rendering of remote controllable macros by sending controls. For more information please refer to Remote Control.

Example Box

To alter the rendering of a remote control macro identified by id 'docs', use the following controls:

Code Block
docs:select=Name,Type/&docs:render-mode=definition

The tip tip

Static Document Link
documentRemote Controls for Transclusion
 provides a short introduction in how to use this feature.

Section
titleCSS Classes

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

Section
titleDelimiter

The delimiter between the name and the short description. Only relevant for numbered and unnumbered lists.

Section
titleRender Short Description

Controls whether or not the short description should be rendered. Only relevant for numbered and unnumbered lists.

Section
titleUncapitalize Short Description

Controls whether or not the first letter of the short description should be rendered with a lower case letter.

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


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


...

Section
titleNotes

Section
titleReferences
Tour
render-as-definition-listtrue
replace-title-with-nametrue
TitleShort Description
Limitations on Query Results
Section
titleResources

Piwik Set Multiple Custom Variables
NameValue
Departmentprojectdoc
Categoryprojectdoc-macro
Typemodular