Deep links reference properties in referenced documents.

Relation: projectdoc

Properties in documents can be referenced. In a select clause specifying "Name, Short Description" selects the Name and Short Description property. If a property value is a link, a special syntax allows to fetch a property from the referenced document. The syntax for a deep link is '->'.

Deep Link

Person->Address->Phone

The above assumes that a document has a reference to a person document, which has a property pointing to a address document. From the address document the value of the property 'Phone' is selected.

Deep links may also be specified in templates (for instance using the Display Document Properties Macro) and in where clauses (for instance using the Display Table Macro).

Deep Links for Select Clauses

Use Deep Link to select a property from a referenced document in the Select Clause.

Name, Audience->Group, Audience

The table header can be replaced using the Header Translations parameter by most macros

Audience->Group=Group Name

Deep Links for Where Clauses

Since version 2.0 of the projectdoc Toolbox Deep Links are supported for property references (on the right side) as an experimental features.

$<Story Points> = [${Master->Ref Story Points}]

Note that you cannot use deep links on the left side of the where clause without Materialization. Since version 4.5 this is supported by property control mat, by space property Materialize by Doctype, or by Doctype Descriptor. Materialization is also possible in prior versions of the projectdoc Toolbox with a little more verbose approach. Read Materialize Properties for more information on this.

Supporting Macros

A number of macros from the projectdoc Toolbox support deep links:

Display Document Properties Macro: Renders a template with property references.
Display List Macro: Lists references to projectdoc documents in a list. List contain names and optional short descriptions.
Display List Template Macro: Lists references to projectdoc documents in a list. List items are defined by templates referencing properties.
Display Table Macro: Lists references to projectdoc documents in a table. Allows to select document properties for columns. Also non-list representations are provided.
Index Card Macro: Renders transcluded content fetched from documents of a result set.
Index Entries Table Macro: Renders a table of index entries.
Tour-by-Property Macro: Renders a predefined list of documents in a table . Documents are selected by a document property. Allows to select document properties for columns. Also non-list representations are provided.
Tour Macro: Renders a predefined list of documents in a table.
Transclude Documents Macro: Renders transcluded content fetched from documents of a result set.
Transclusion Macro: Transcludes content from a document marked with the content marker macro.
Transclusion Reference Macro: Transcludes content via a reference from a document marked with the content marker macro.

Resources

Deep Links: With deep links properties from referenced properties can be accessed for rendering.