projectdoc Toolbox

Render the property value of an ancestor of this document, for the first ancestor that matches the specified document type.

Audience
Categories
Tags
Type
Since
1.16

The Ancestor Property Macro allows template authors to reference a document property of an ancestor 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 an ancestor's document to the properties table to be printed.

Properties

The macro provides the following properties.

Property Name

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

Ancestor Doctype

The name of the type of the ancestor document to be actually considered a ancestor. The property of the first matching ancestor is rendered.

An ancestor is a parent or one of the parents of that parent.

If the ancestor doctype is not specified, the ancestor is required to have the same type as the referencing document.

Default Value

A default value to render, if the document has no ancestor of the specified doctype. Usually this property is left blank.

Related macros

NameShort DescriptionTags
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.
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.
Name List Macro
Lists references to projectdoc documents. The rendering will add a link to a document, if there is a document with the given name.
Parent Property Macro
Renders the property of the parent document, if it has the same doctype.