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 |
---|
title | Empty Where Clause Handling | Parent Name |
---|
| 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 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. projectdoc-box-deprecatedversion |
---|
titlesince | Deprecated since 4.2 |
---|
| In case all properties should be shown, use the Default Strategy named all . |
| Section |
---|
| | The parameter is available since version 4.6. |
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 derivedSelect 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. projectdoc-box-versionexample |
---|
| This parameter is available since version 4.2 of the projectdoc Toolbox. | | A typical use case is a doctype lifecycle that allows to group lifecycle phases. The Phase doctype would provide a property named Lifecycle with a Name List Macro specifying the doctype lifecycle via the Doctype Parameter. If the lifecycle phase is added to the doctype homepage to be selectable by multiple lifecycles, the Name List Macro specifies no lifecycle. 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. |
This function is similar to the Static Document Link |
---|
document | Parent Property Macro |
---|
| .
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 |
---|
default | Use the value defined by the space property Display Property |
---|
add-link | true |
---|
document | Name List Macro Defaults-to Configuration |
---|
property-name | ID |
---|
| . | none | Simply keep the value empty. This is the default if not overridden by the space property. | all | Render all matching names. This parameter is deprecated and should not be used: Property values derived by searches do not create reproducible results. | ancestor | Render the first doctype-matching ancestor document's name. | ancestor-property | Render the first ancestor's unique property value. Use the 'Property' parameter to define the name of the ancestor property whose value is to be displayed. All other parameters have no effect on the rendering for this special use case. Version Box |
---|
| The strategy ancestor-property is provided since version 4.8. |
|
Note that the Parent Name parameter is also providing a strategy to render name values. |
Version Box |
---|
| This parameter is available since version 4.2 of the projectdoc Toolbox | Content Marker |
---|
| Content Marker |
---|
| | Section |
---|
title | Restrict to one Value |
---|
| If checked only one value is allowed to be selected. If more than one value is provided before projectdoc 1.16.0 only the first value is rendered. Since projectdoc 1.16.0 the whole content is regarded as one single value and will not be split up. Available since version 1.11, changed since 1.16.0. |
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. Available since version 1.11. 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 124649483 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 |
---|
| 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 |
---|
| The sort strategy to apply to specified names. This allows to render the names provided by users to be sorted before they are rendered. The following strategies are supported: Strategy | Description |
---|
none | Keep the names in the order entered. This is the default. | asc | Sort the names in ascending lexical order. | desc | Sort the names in descending lexical order |
| Where | 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 |
---|
| 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 Version Box |
---|
| .16 | This parameter is supported available since version 6.1. 16.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. |
|
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 |
---|
| Use the matcher to filter on the name documents. Applies only if the Unique Property parameter is either the name, short name, or identifier. In case you want to allow users to select only those values that are valid according to the matcher, check . If the restriction to the range is applied, no other value can be selected. Content Marker |
---|
id | DonotusedynamicValuesasPropertyValues |
---|
| Caution Box |
---|
title | Do not use dynamic Values as Property Values |
---|
| Do not use any other attribute than (Name ), Static Document Link |
---|
document | Short Name |
---|
label | short name |
---|
| (Short Name ), or identifier (Identifier ) to select documents to render with this macro.If other properties are used, the macro runs a Lucene query. If a property value is dependent on a query result, the value will not automatically be rerun if new documents are added or existing documents are altered. So the result stored with Lucene (at the time the document is saved) may not match the values rendered when the macro is shown on the page (at render time). Lucene queries also require that all documents are present to create valid results. In case of a database rebuild this constraint is not met. |
|
Transclusion |
---|
document | Child Documents Macro |
---|
ids | Matcher |
---|
|
|
|
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. The use of this parameter requires that a valid doctype is set via the parameter. Otherwise the macros does not know which document to create and renders a plain link.Only relevant in case Static Document Link |
---|
document | Document Creation for Name List |
---|
| is active. Version Box |
---|
| Available since version 4.6. |
|
Section |
---|
| A Lucene search expression to filter on the results. This parameter only applies in case a name is provided, if the identifying property is neither the name, the short name, or the identifier of a document (in which cases the Matcher parameter is used for filtering). If no name is provided, but the search scope is everything, the constraint specified with the Where Parameter is applied. This use case is deprecated because it requires a search to find propert values. Deprecated Box |
---|
This parameter is deprecated to select on values. See In-Document Link |
---|
anchor | Do not use dynamic Values as Property Values |
---|
| for details. |
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 Version Box |
---|
| | Since version 3.1 the use of Deep Links is supported. Code Block |
---|
| The $[Name] is not ${Ref ->Type}.->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. So template authors would create queries with the text version of the property, called "Attendees$ ". | Section |
---|
| 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$ " 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 |
---|
| In case there is only one name in this list, this label overrides the name. Version Box |
---|
| | The parameter is available since version 2.3 of the projectdoc Toolboxlabel 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 rendersrendered, but the label of the link may be an arbitrary stingstring. Deprecated Box |
---|
title | Deprecated since 5.1 |
---|
| The use of the Label Parameter is deprecated since version 5.1 of the projectdoc Toolbox. Use the parameter Display Template (without placeholders) as a replacement. |
Section |
---|
| Set the Cascading Style Sheet (CSS) classes for the rendered reference. The classes are only rendered if a list is rendered. Not for single elements and not for the comma-separated representation. |
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. |
|
|
|