Versions Compared

Key

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

...

Section
titleProperties
Section
titleNames

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
titleDoctype

The doctype 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.

Content Marker
idCommons
Section
titleEmpty 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.

Section
titleRestrict to one Value

If checked only one value is allowed to be selected.

If authors specify more than one value , is provided before projectdoc 1.16.0 only the first one is taken into account and renderedvalue 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
titleRestrict to Range

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.

Tip Box

Refer to Define Status Tags for an example on how to define property value ranges.

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
titleRender 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
titleProperty

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
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 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
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. Only if no spaces are specified, the current and its delegate spaces are taken into account.

Section
titleWhere

A Lucene search expression to filter on the results.

For more information on queries, please refer to Search Tips.

Transclusion
documentSearch Tips
idscurly-braces

Section
titleUnique Property

The name of the property to select the document. The property has to be unique and defaults to the Name property.

Section
titleDisplay Template

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
languagetext
The ${Name} is not ${Subject}.

The placeholders will be replaced by the values of the property Name and Subject.

Since version 1.16.

Section
titleLink Properties

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.

Since version 1.16.

...