Display Document Property Ref Concat Macro

...

Document Properties Marker

doctype	macro
override	false

Doctype

macro

hide

Name

Display Document Property Ref Concat Macro

Short Description

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.

Parent

Parent Property

property-name	Name

Audience

Name List

doctype	role
render-no-hits-as-blank	true
names	Template Author

Tags

Tag List


names	Display, Property Value Transclusion

, Autocomplete

Type

Name List

doctype	macro-type
render-list-as-comma-separated-values	true
names	Content Reuse, Properties Management

Iteration


value	production

hide

Sort Key

hide

Section

index	true
show-title	false
title	Description

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.

Example Box

title	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:

...

Section

title	Properties

Section

level	2
title	Document

The document where a property refers to another document.

Transclusion

document	Display Property Usage Warning
ids	Content

Section

level	2
title	Property Name (local)

The property within the local document to display.

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

Example Box
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".

Section

level	2
title	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.

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

Section

level	2
title	Property Name (remote)

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

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

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.

projectdoc-section

level	2
title	Doctype

transclusion-macro

taget-heading-level	*
document	Display Document Property Ref Macro
ids	Doctype

Section

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

Section

level	2
title	Default Value

The default value, if the property is not set.

Section

level	2
title	Delimiter

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

Section

level	2
title	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').

Section

level	2
title	Add Link

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

Section

level	2
title	Prepend Newline

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

Section

title	Identifier

Transclusion

document	Display Document Property Macro
ids	Identifier

Section

title	Identifier Classes

projectdoc-transclusion-macro

document	Display Document Property Macro
ids	Identifier Classes

projectdoc-section

title	Autocomplete Space Closure

Transclusion

document	Display Document Property Macro
ids	Autocomplete Space Closure

Section

title	Autocomplete Constraints

Transclusion

document	Display Document Property Macro
ids	Autocomplete Constraints

Section

hide	true
title	Autocomplete Sort

Transclusion

document	Display Document Property Macro
ids	Autocomplete Sort

Section

title	Details

Section

index	true
title	Related macros

Display Table

doctype	macro
render-no-hits-as-blank	true
render-mode	definition
select	Name, Short Description
sort-by	Sort Key, Name
where	Categories = "Display / Property"
exclude-self	true

...

Section

title	References

Section

title	Resources

Tour

render-as-definition-list	true
replace-title-with-name	true

Title	Short Description
Referencing Property Values
Linking to Glossary Terms

Piwik Set Multiple Custom Variables

Name	Value
Department	projectdoc
Category	projectdoc-macro
Type	modular

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

Support

Team

Legal

Versions Compared

Old Version 2

New Version Current

Key

About

Keep up-to-date!

Powered by