...
Document Properties Marker |
---|
doctype | macro |
---|
override | false |
---|
|
Doctype | macro | hide |
---|
Name | Display List Macro | Short Description | Lists references to projectdoc documents in a list. List contain names and optional short descriptions. |
|
---|
Doctype | macro | hide |
---|
Name | Display List Macro |
|
---|
Parent | |
|
---|
Audience | Name List |
---|
doctype | role |
---|
render-no-hits-as-blank | true |
---|
render-list-as-comma-separated-values | true |
---|
names | Author, Template Author |
---|
property | Audience |
---|
|
|
|
---|
Categories | Name List |
---|
doctype | category |
---|
names | Display / Query |
---|
|
|
|
---|
Tags | Tag List |
---|
css | projectdoc-compact |
---|
names | Dynamic List, Query, Deep Link, Remote Control, Context Control, Autocomplete, Remote Controller |
---|
|
|
|
---|
Type | Name List |
---|
doctype | macro-type |
---|
names | Dynamic Navigation |
---|
|
|
|
---|
Iteration | | hide |
---|
Supports Wiki Markup | |
|
---|
Page Size Support | | |
|
---|
Sort Key | | hide |
---|
|
Section |
---|
index | true |
---|
show-title | false |
---|
title | Description |
---|
|
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 |
---|
|
|
Wiki syntax is supported since version 2.5.Wiki Markup is supported by this macro.
Section |
---|
|
The macro provides the following properties. Section |
---|
| 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 |
---|
| 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 | * |
---|
document | Display Table Macro |
---|
ids | Where |
---|
|
|
Transclusion |
---|
taget-heading-level | 2 |
---|
document | Sort By Property |
---|
ids | Sort By |
---|
|
|
Section |
---|
| Limit the maximum number of hits in the result set. |
Section |
---|
title | Restrict to immediate Children |
---|
| If checked, only immediate children of the current document are valid as hits. |
Section |
---|
| projectdoc-transclusion-macro |
---|
document | Display Table Macro |
---|
ids | Restrict to Favored |
---|
|
|
|
projectdoc-section |
---|
| If checked excludes this document from the query result. |
Section |
---|
| 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 |
---|
| 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 |
---|
| 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 |
---|
| Controls the type of the list. May be an ordered, unordered, definition list or definition listplain. |
Transclusion |
---|
taget-heading-level | * |
---|
document | Display Table Macro |
---|
ids | Identifier Classes |
---|
|
|
Section |
---|
| When checked configures parameters via document and space properties. Version Box |
---|
| Available since version 3.2 of the projectdoc Toolbox. |
The tip Static Document Link |
---|
document | Use Context Controlled Macros |
---|
| provides a short introduction in how to use this feature. |
Section |
---|
| List of controls to pass to transcluded contexts. Controls are separated by ampersand ('&'). Version Box |
---|
| 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 Static Document Link |
---|
document | Remote Controls for Transclusion |
---|
| provides a short introduction in how to use this feature. |
|
Section |
---|
| The name of the CSS classes to apply to the list elements. |
Section |
---|
| The delimiter between the name and the short description. Only relevant for numbered and unnumbered lists. |
Section |
---|
title | Render Short Description |
---|
| Controls whether or not the short description should be rendered. Only relevant for numbered and unnumbered lists. |
Section |
---|
title | Uncapitalize Short Description |
---|
| Controls whether or not the first letter of the short description should be rendered with a lower case letter. |
projectdoc-section-transclusion-macro |
---|
taget-heading-level | * |
---|
document | Display Table Macro |
---|
idstitle | Render no hits as blank |
---|
| If the query found no hits, the result is rendered as a short text message. If a result with no hits should not be rendered at all, check this box. |
|
Transclusion |
---|
taget-heading-level | * |
---|
document | Display Table Macro |
---|
ids | No Hits Text |
---|
|
|
|
Section |
---|
|
Section |
---|
title | Remote Controlled Documents |
---|
| Version Box |
---|
Remote Controlled Documents for this marco are available since version 3.2 of the projectdoc Toolbox. |
Remote Controlled Documents allow to control the content at request time. A HTTP request may override parameters of the macro. A request parameter addresses a macro by its identifier. After the identifier the name of the parameter is appended, separated by a colon. Example Box |
---|
| Assume that the identifier of the macro is set to 'my', the following call will override the doctype parameter on the page 'MyPage' in space 'MYS'. Code Block |
---|
confluence/display/MYS/MyPage?my:doctype=code |
|
The list of parameters allowed to override: doctype select-for-name where sort-by max-hit-count restrict-to-immediate-children exclude-self render-children space-key space-keys list-type css-classes delimiter render-short-description uncapitalize-short-description render-no-hits-as-blank render-no-hits-as-blank-text
|
|
Section |
---|
title | Details |
---|
Section |
---|
index | true |
---|
title | Related macros |
---|
|
Display Table |
---|
doctype | macro |
---|
render-no-hits-as-blank | true |
---|
render-mode | definition |
---|
select | Name, Short Description |
---|
sort-by | Sort Key, Name |
---|
where | Categories = "Display / Query" |
---|
exclude-self | true |
---|
|
|
...
Section |
---|
|
Tour |
---|
render-as-definition-list | true |
---|
replace-title-with-name | true |
---|
| |
|
Piwik Set Multiple Custom Variables |
---|
Name | Value |
---|
Department | projectdoc | Category | projectdoc-macro | Type | modular | |