- Created by Robert Reiner, last modified on 05. Nov 2021
projectdoc Toolbox
Displays a document property from a referenced document.
- Audience
- Categories
- Tags
- Type
- Supports Control
Allows to reference a property of a reference in this document. The document may be the name or the title of a document.
This macro is usually only useful for template authors who want to reference a value of a document given by an author (and therefore not known in advance).
Properties
Document
The document the property containing the reference to a remote document, is part of.
If not specified, the current document is used.
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 (Document)
The localized name of the property that contains the name of a referenced document.
Suppose you want to reference the phone number (property: "Phone Number") of a person stored as a team member (property "Team Member") in a Name List Macro of this document.
Leave the Document property of the macro empty, therefore referring this document. Use "Team Member" as the property name (of this document).
The localized name of the property that contains the name of a referenced document.
Since version 1.13 the property may reference multiple documents. In this case, the generated value is a list based on the property values from these documents. Duplicates are dropped. If the document is not accessible, it is silently dropped. If you need to handle the property as a single value despite the fact it contains a comma, use
Property Name (Value)
The localized name of the property of the referenced document to display.
To continue the previous example, set the property name here to "Phone Number" to display the value of the Team Member of this document.
Doctype
Do not use as Property Value!
If a doctype value is set, the macro effectively runs a search for a document of a given type and name. Dynamic values are not supported as property values. Therefore this property should not be used.
Either use the Name List Macro (to specify a value that is optionally linked) or use this macro, but make a hard reference (by leaving this parameter value blank).
Since the display document property macros should reference the information (and not query them), the property is likely to be removed in near future.
If specified, the value given as document is used as a document instance name. If not specified, the value given as document is used as a page title.
Space Key (for Doctype)
The name of the space the document is part of. If the document references a page title, not a document name, add the space key in front of the title, separated by a colon.
Add Link
Signals to render a link for the complete template to the referenced document (or the content of the content is an URL).
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
If checked the append text is appended, otherwise it is prepended.
Append Text
The text to be appended to the referenced property value.
Default Value
The default value, if the property is not set.Since version 1.13 this value is rendered in the context of multiple documents, if none of the documents provides a value.
Prepend Newline
If checked, signals that a newline is to be rendered before the property.
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 Space Closure
Define the scope to search for documents in the Autocomplete context.
Only documents within this scope will be accepted by the Autocomplete for the Documents parameter.
Further constraints on the space can be declared by the use of the Autocomplete Constraints parameter.
Default space is the delegate space of the current space.
Since 4.3
This parameter is available since version 4.3 of the projectdoc Toolbox.
Before this the space closure could not be changed from its default delegate space.
This property is only used in the context of the Autocomplete function. It is only enforced on Autocomplete in the browser.
Changes to the parameter value will only take effect on the next Autocomplete selections. But there is also no guarantee that the list of selected documents will not be filtered later. The not enforced constraint is that the selected documents should match the constraints.content
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.
This property is only used in the context of the Autocomplete function. It is only enforced on Autocomplete in the browser.
Changes to the parameter value will only take effect on the next Autocomplete selections. But there is also no guarantee that the list of selected documents will not be filtered later. The not enforced constraint is that the selected documents should match the constraints.content
Related macros
List of related macros to render document properties.
- 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 As Link Macro
- Renders the value of a document property as a link with an alternative label.
- Display Document Property As List Macro
- Renders the list value of a document property.
- Display Document Property Macro
- Renders the value of a property of a document.
- 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 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.
Resources
- Referencing Property Values
- Shows how to render the value of a document property with a display macro. There are actually three variants of this macro that we are discussion in this short article.
- Materialize Properties
- Using existing properties from other documents.
- Linking to Glossary Terms
- Show how to use the Name List Macro to render links to glossary terms.
