projectdoc Toolbox

Renders the value of a property of a document.

This macro transcludes the value of a property of its own or another document.

Properties

Document

The document the property is part of.

If not specified, the current document is used. This allows to render the value of a property of the same document at several places of this document, without duplicating the value.

 

Within the Document Properties Marker Macro

  • you must not reference a property of the same document before it is defined. If you use this macro as the value of a document property, the macro must only reference properties that haven been specified prior.
  • do not reference properties of pages with different page access restrictions!

Property Name

 The name of the property to fetch the property value.

CSS Classes

Provide a list of classes to be set for the rendered value.

The value will be rendered in a HTML-span element with this CSS class names added.

This parameter is available since version 2.0.

Append

Check if the Append Text is actually to be appended. If unchecked, the Append Text is prepended.

Additional Text

The text to be appended to the referenced property value.

Default Value

A default value to render, if the document has no value for the referenced property.

Prepend Newline

If checked, signals that a newline is to be rendered before the property value.

Identifier

Unique identifier of the macro for the rendered context.

Features may supply default configurations dependent on the value of this property.

Since 4.0

 

This parameter is available since version 4.0 of the projectdoc Toolbox.

Identifier Classes

Identifiers to address this macro as part a group for the rendered context.

Features may supply default configurations dependent on the value of this property.

Since 4.0

 

This parameter is available since version 4.0 of the projectdoc Toolbox.

Autocomplete Constraints

Provide a Where clause to select on documents for the autocomplete feature of this macro.

This parameter is only to control the autocomplete feature of this macro. If empty, no constraints are put on the list documents presented.

Since 4.0

 

This parameter is available since version 4.0 of the projectdoc Toolbox.

Autocomplete Sort

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.

Since 4.0

 

This parameter is available since version 4.0 of the projectdoc Toolbox.

Related macros

Display Document Properties Macro
Renders a template with property references.
Display Document Property As Image Macro
Renders the value of a document property as an image. The property value is required to an URL that points to an image.
Display Document Property Ref Concat Macro
Displays a single property of a document that is referred by a property of another document and concatenates it with the value of a local property.
Display Document Property Ref Macro
Displays a document property from a referenced document.
Display Space Attribute Macro
Renders a space attribute value.
Display Space Property Macro
Renders a space property value.
Tour Macro
Renders a predefined list of documents in a table.

Name Short Description Doctype
Lists references to projectdoc documents in a list. List contain names and optional short descriptions.
Lists references to projectdoc documents in a list. List items are defined by templates referencing properties.
Lists references to projectdoc documents in a table. Allows to select document properties for columns. Also non-list representations are provided.
Renders transcluded content fetched from documents of a result set.
Renders a table of index entries.
Renders transcluded content fetched from documents of a result set.

Resources

Linking to Glossary Terms
Show how to use the Name List Macro to render links to glossary terms.