Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section
titleListing who Transcludes

The use case for listing who transcludes is to keep track of which document uses content of a given document. If text is changed it is easy for the author to find the transcluding documents. With the list of transcluding documents the author can quickly check if the change on the transcluded contents also requires changes on the transcluding documents. If readers find a module by search they can quickly check in which documents this topic is used and find additional information in related documents.


The Module doctype provides a section named Transcluded by to show which documents use contents of this module.

This section lists all documents that transclude contents from this module.

Here is an example from the module REST API Browser we use in our online manual for the projectdoc Toolbox:

Image Added

The Display Table Macro is configured in the Module doctype like this:

The Where clause reads:

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

The query selects all documents that contain the space key and title (in a special format SpaceKey.PageTitle) in their list of pages they transclude from.

Example Box

If a document A in space ONE transcludes content from a page B in space ONE and C in space TWO, then its artificial property TranscludedDocumentTitles has a value of ONE.B, TWO.C.

The query above, being part of the document C (in space TWO) would read like this:

Code Block
languagetext
$<TranscludedDocumentTitles>=[TWO.C]

So all pages that transclude from C are part of the result set.


...