Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Document Properties Marker
overridefalse
Short DescriptionIt is easy to list all pages that transclude a section from the current page. This allows you, as an author, to check quickly if changes to a document that is transcluded, needs changes to the transcluding documents.
 

Doctypetopichide
NameUse Display Table for Transclusion References
 

Parent
Parent Property
propertyParent
property-nameName
hide
Audience
Name List
doctyperole
render-no-hits-as-blanktrue
propertyAudience
 

Level of Experience
Name List
doctypeexperience-level
render-no-hits-as-blanktrue
propertyLevel of Experience
 

Expected Duration
 
10 min
Subject
Name List
doctypesubject
propertySubject
 

Categories
Name List
doctypecategory
propertyCategories
 

Tags
Tag List
namesTransclusion
propertyTags
 

Iteration
Iteration
valuefinished
hide
Type
Name List
doctypetopic-type
render-no-hits-as-blanktrue
namesTip
propertyType
 

Sort Keyhide
Section
show-titlefalse
titleDescription

If you apply changes to a document you may like to know which documents transclude content from this document. This way you are able to check quickly, if your changes call for changes in some of the transcluding documents.

Note Box
titleExplicit Transclusions are supported

Only explicit transclusions are tracked with this approach. Explicit transclusions are set with the Transclusion Macro. These transclusions are evaluated at the time the page is saved.

If you employ searches for your transclusion, the references are not tracked. Searches are evaluated at the time the search is executed. Therefore transclusions rendered with the Transclude Documents Macro will not show up in this list.

This is similar to the fact that links rendered within the Display Table Macro are also not counting as references to the page.

Using the projectdoc Toolbox makes this very easy. Actually some doctypes, such as the Module, automatically add this information.

Use a constraint on the search result like this:

Code Block
languagetext
$<TranscludedDocumentTitles>=[${Space Key}.${Name}]

Here is the code in storage format to add in order to list the transcluding pages:

Code Block
<ac:structured-macro ac:name="projectdoc-display-table">
  <ac:parameter ac:name="render-no-hits-as-blank">true</ac:parameter>
  <ac:parameter ac:name="select">Name, Short Description, Doctype</ac:parameter>
  <ac:parameter ac:name="sort-by">Sort Key, Name</ac:parameter>
  <ac:parameter ac:name="where">$&lt;TranscludedDocumentTitles&gt;=[${Space Key}.${Name}]</ac:parameter>
</ac:structured-macro>
Tip Box

If you want to show the transclusion information only to authors, you may hide the section dependent on user privileges. See Information for Audiences for details.

...

Section
titleResources

These macros transclude content from a projectdoc document:

  • Display Properties
    documentTransclusion Macro
  • Display Properties
    documentTransclude Documents Macro

These macros define content to be transcluded:

  • Display Properties
    documentSection Macro
  • Display Properties
    documentContent Marker Macro

More information on transclusion topics are found by the tag Transclusion.

Piwik Set Multiple Custom Variables
NameValue
Departmentprojectdoc
Categoryprojectdoc-tip
Typehowto