projectdoc Toolbox

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.

Audience

Template Author

Categories

Display / Property

Tags

Type

Content Reuse, Properties Management

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.

If the local property is empty, nothing is rendered.

The use case for this macro is to use the property of a referenced document and concatenate it with the value of the property of this document. This is usually only relevant for Template Authors.

Concatenate URIs

One example for using this property is to construct URIs by components.

Suppose you document a component named "Server" that has an URI property with value "https://mycorp".

Another component is a a service on this component which is called "myservice".

The URI property of the service that is deployed to the server should use the URI of "Server" as a base and append its service identificator.

Use the Display Document Property Ref Concat Macro like this:

Properties

Document

The document where a property refers to another document.

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 (local)

The property within the local document to display.

If the value of this property is empty, nothing will be rendered.

For instance you want to append the phone extension (property "Phone Extension") of this document with the "Phone Stem" property of a referenced company (property "Company") document. In this case the Property Name local is set to "Phone Extension".

Property Name (Document)

The property within the given document that refers to another document. That is the value of the property is another document. If the property is not given, nothing is rendered.

Continuing the example of "Property Name", set Property Name (Document) to "Company".

Property Name (remote)

The localized name of the property of the referenced document to display.

Continuing the example of "Property Name", set Property Name (remote) to "Fax Stem".

Doctype

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.

Default Value

The default value, if the property is not set.

Delimiter

The character sequence that is inserted between the first and the second value of the concatenation.

Append Local

Controls if the local value is appended to the remote value ('true') or if the remote value is appended to the local value ('false').

Add Link

Signals to render a link for the complete template to the referenced document (or the content of the content is an URL).

Prepend Newline

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

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

Space shortcuts

Page tree

Docs

Support

Free Blueprints

Tooling for Blueprints

Free Extensions

Spaces

Plugins for Maven

Incubator

Libraries for Java

Incubator

Add-ons for Confluence

Tools