projectdoc Toolbox

Renders the property of the parent document, if it has the same doctype.

Audience
Categories
Tags
Type

The Parent Property Macro allows template authors to reference a document property of the parent document. If such a document is moved to another document tree, the referenced parent property is automatically updated.

This macro is especially useful to add the name of the parent document to the properties table to be printed.

Properties

The macro provides the following properties.

Property Name

The name of the property in the parent document to references.

Parent Doctype

The name of the type of the parent document to be actually considered a parent. If the document type differs, the document is considered to have no parent.

If the macro parameter is empty, the parent is required to have the same type as the referencing document.

Since version 2.0 the value may be set to #ANY. In this case any projectdoc document is considered to be a valid parent.

Multiple values must be separated by comma.

Append

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

Append Text

The text to be appended to the referenced property value.

Default Value

A default value to render, if the document has no parent. Usually this property is left blank.

Prepend Newline

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

Related macros

Name Short Description Tags
Render the property value of an ancestor of this document, for the first ancestor that matches the specified document type.
Renders the list of child documents, matching the given filter criteria.
Renders a template with property references.
Renders the value of a document property as an image. The property value is required to an URL that points to an image.
Renders the value of a document property as a link with an alternative label.
Renders the value of a property of a document.
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.
Displays a document property from a referenced document.
Renders a space attribute value.
Renders a space property value.
Lists references to projectdoc documents. The rendering will add a link to a document, if there is a document with the given name.

Resources

Parent
The property references the higher ranked document, typically of the same type as the child document. Usually the parent is a more general form of the child or is in some other ways a structuring instance.
Parent Property of projectdoc Documents
projectdoc documents typically provide a property named 'Parent Property'. This property refers to a logical parent. This tip shows what this is all about.
adjust-title-on-any-parent
Controls the generation of the document title by adding the parent document's title in any case.
Materialize Properties
Using existing properties from other documents.