Section |
---|
| The comma-separated list of document names to reference. Each name will be rendered as a link to the document, if a document with such a name (and doctype, see next section) exists. |
Section |
---|
| The type of the documents to select. Note Box |
---|
The name of a document must be unique within its doctype for this macro to work property. It is not possible to reference several documents with the same name and document type. It is allowed to specify more than one doctype. But keep in mind that the names must be unique for the set of selected doctypes. |
|
Section |
---|
| If checked the name of the parent document is added in case its doctype matches with the doctypes specified by the doctype parameter. If no doctype parameter is specified, the doctype of the parent must match the doctype of the document containing the macro. This parameter allows Static Document Link |
---|
document | PDAC:Template Author |
---|
label | template authors |
---|
| to configure their doctype to automatically configure a property value. In case the document is added to the doctype homepage, the property value is configured by adding names manually. In case the document is added to another document, then the name of that document is automatically derived.A typical use case is a doctype lifecycle that allows to group lifecycle phases. If the lifecycle phase is add to the doctype homepage to be selectable by multiple lifecycles, the Name List Macro behaves as usual. If the lifecycle phase is added as a child to a lifecycle document, the new phase automatically references the parent lifecycle as the lifecycle it belongs to. Version Box |
---|
| The parameter is available since version 4.6. |
|
Section |
---|
title | Empty Where Clause Handling |
---|
| If unchecked treat an empty where clause as match any (i.e. no constraint) or treat it as no valid match exists (in which case the displayed result is always empty). Tip Box |
---|
You may temporarily uncheck the box to display all possible values. |
Deprecated Box |
---|
title | Deprecated since 4.2 |
---|
| In case all properties should be shown, use the Default Strategy named all . |
|
Section |
---|
| Select a strategy to calculate a default value in case no name is specified. The following strategies are supported: Strategy | Description |
---|
none | Simply keep the value empty. | all | Render all matching names. | ancestor | Render the first matching ancestor document's name. | ancestor-property | Render the first ancestor's unique property value. |
Version Box |
---|
| This parameter is available since version 4.2 of the projectdoc Toolbox. The strategy ancestor-property is provided since version 4.8. |
|
Content Marker |
---|
|
Content Marker |
---|
|
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 text field below in addition to this field. Only if no space is specified, the current and its delegate spaces are taken into account. |
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. Only if no spaces are specified, the current and its delegate spaces are taken into account. |
Section |
---|
title | Render List as comma-separated Values |
---|
| If checked, the list is comma-separated, otherwise the rendering produces an unordered list. If rendered with commas, the names are always shown as text. Otherwise they may be rendered as boxes. Please refer to Box Style for details. |
Section |
---|
title | Restrict to one Value |
---|
| If checked only one value is allowed to be selected. The whole content is regarded as one single value and will not be split up. |
Section |
---|
| If checked only values defined by the referenced doctype and constraints are allowed. The range of valid values is defined by the doctype and the where parameter. If authors specify values not within the defined range, they are dropped. Note Box |
---|
If in addition to the range restriction the one-value restriction is also enforced, only the first value will be taken into account. That is: if two values are specified, where the first is not in the range, but the second is, then no value will be rendered. |
| Section |
---|
title | Render List as comma-separated Values |
---|
| If checked, the list is comma-separated, otherwise the rendering produces an unordered list. If rendered with commas, the names are always shown as text. Otherwise they may be rendered as boxes. Please refer to Box Style for details
|
Section |
---|
| The name of the property the values in this list are values for. This property is useful for template designers to associate the value with the name of a property. This allows queries to reference the ancestors of a document referenced here. See Search Tips for details. |
Section |
---|
| When selected, overrides to disallow the rendering of names with links to create new documents. Only relevant in case Static Document Link |
---|
document | Document Creation for Name List |
---|
| is active. Version Box |
---|
| Available since version 4.6. |
|
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 text field below in addition to this field. Only if no space is specified, the current and its delegate spaces are taken into account. |
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. Only if no spaces are specified, the current and its delegate spaces are taken into account
|
Section |
---|
| A Lucene search expression to filter on the results. For more information on queries, please refer to Search Tips. Transclusion |
---|
document | Search Tips |
---|
ids | curly-braces |
---|
|
|
|
Section |
---|
|
Version Box |
---|
until | 3.0 |
---|
title | Removed since 3.1 |
---|
since | 1.16 |
---|
| If the Display Template Parameter is specified, name the properties here to render a link to the document the name value refers to. If none is specified, the whole template value is considered to be the label for the link. |
|
|
Section |
---|
| The name of the property to select the document. The property has to be unique and defaults to the Name property. |
Section |
---|
| Template to render instead of the plain property value. Define property placeholders which will be replaced by the referenced property values. A property placeholder starts with ${ , contains the name of the property it is a placeholder for, and ends with a curly brace. Example Box |
---|
Use templates like this to refer to properties. Code Block |
---|
| The $[Name] is not ${Subject}. |
The placeholders will be replaced by the values of the property Name and Subject. The use of $[...] renders a link. |
The use of Deep Links is supported. Code Block |
---|
| The $[Name] is not ${Ref->Type}. |
Version Box |
---|
| Since version 4.6 there is a text version of the property that provides the list of names. This allows queries to match the document by its name although the property value is rendered by the template. A typical use case is to render the name of persons and their organizations with a template, for instance on a minutes document. The property would be called "Attendees ". For matching this document by a person (to see which minutes mention a particular person), it is inconvenient and error prone if the query would need know the pattern with the person's name and organization for the match. Therefore queries will always match by the name of the referenced property. The text form "Attendees$ " can be used to match with the text rendered by the template. When accessing the value, for instance with the Display Document Property Macro, the property "Attendees " will return the rendered HTML code snippet controlled by the template. In case the text form with the plain names needs to be accessed, use "Attendees$ ". |
|
Section |
---|
| In case there is only one name in this list, this label overrides the name. If this macro is used in a section body to reference a document, e.g. a glossary item, then the label being rendered may be different from the name or any other property of the document. In these use cases, where there is only one name, the label will be rendered instead of the property. This is similar to Confluence links, where per default the title of the referenced document is renders, but the label of the link may be an arbitrary sting. |
Section |
---|
| Set the Cascading Style Sheet (CSS) classes for the rendered reference. |
Section |
---|
|
Transclusion |
---|
document | Display Document Property Macro |
---|
ids | Identifier |
---|
|
|
|
Section |
---|
|
Transclusion |
---|
document | Display Document Property Macro |
---|
ids | Identifier Classes |
---|
|
|
|
Section |
---|
| Control the sort order for the autocomplete feature of this macro. This parameter has only effect on the autocomplete feature of this macro. If empty, the default sort order is defined by the Sort Key property of the documents. Version Box |
---|
| This parameter is available since version 4.0 of the projectdoc Toolbox. |
|
|
|