Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
doctypemacro
overridefalse
Doctypemacrohide
NameDisplay Document Property Ref Macro 
Short DescriptionDisplays a document property from a referenced document. 
Parent
Parent Property
property-nameName
 
Audience
Name List
doctyperole
render-no-hits-as-blanktrue
namesTemplate Author
propertyAudience
 
Categories
Name List
doctypecategory
namesDisplay / Property
propertyCategories
 
Tags

Tag List
namesDisplay, Property Value Transclusion

 
Type

Name List
doctypemacro-type
render-list-as-comma-separated-valuestrue
namesContent Reuse, Properties Management

 
Iteration
Iteration
valueproduction
hide
Supports Controlis-single-value 
Sort Keyhide
Section
indextrue
show-titlefalse
titleDescription

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

Section
titleProperties
Section
level2
titleDocument

The document the property containing the reference to a remote document, is part of.

If not specified, the current document is used.

Transclusion
documentDisplay Property Usage Warning
idsContent

Section
level2
titleProperty Name (Document)

The localized name of the property that contains the name of a referenced document.

Example Box

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

Section
level2
titleProperty Name (Value)

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

Example Box

To continue the previous example, set the property name here to "Phone Number" to display the value of the Team Member of this document.

Section
level2
titleDoctype

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.

Section
level2
titleSpace 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
level2
titleAdd Link

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

Transclusion
taget-heading-level*
documentDisplay Document Property Macro
idsCSS Classes

Section
level2
titleAppend

If checked the append text is appended, otherwise it is prepended.

Section
level2
titleAppend Text

The text to be appended to the referenced property value.

Section
level2
titleDefault 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.

Section
level2
titlePrepend Newline

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

...

Section
titleReferences

Section
titleResources

Piwik Set Multiple Custom Variables
NameValue
Departmentprojectdoc
Categoryprojectdoc-macro
Typemodular