Versions Compared

Key

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

...

Section
titleListing what is transcluded

In case a document takes advantage of transcluding contents from existing documents, the authors may decide to add a list of references to these documents explicitly at the end of the document. This could be done in the References section. Together with the name of the documents and a link the list can also render the Short Description, making it even easier for the reader to understand what the referenced information is about before clicking on the link.

With version 3.0.3 1 of the projectdoc Toolbox a new artificial property named Page Key will be provided. This page key has the form SpaceKey.PageTitle. It allows to uniquely reference a page within a Confluence server as does the numerical page ID. While page IDs may change, for instance due to export and import of a space, the tupel space key and page title does not. The page key is controlled by the user, while the page ID is not.

With this new artificial property the following query can be specified.

Code Block
languagetext
$<Page Key>~(${TranscludedDocumentTitles})

It searches all pages whose page key is part of the current document's transclusion list.

Example Box

Using the configuration from the last example.

The query being part of the document A (in space ONE) would read like this:

Code Block
languagetext
$<Page Key>~(ONE.B, TWO.C)

So all pages that page A transcludes from are part of the result set.


...