Versions Compared

Key

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

...

Section
titlePrerequisites


Section
titleTask
Image Added

Suppose you have pages with references you want to collect and render in a table.

For this example we use the Online Manual for the projectdoc Toolbox and want to render the name, short description, and referenced documents with the Display Table Macro.

These are the documents we want to transclude from:

  1. Tours
  2. Topics
  3. FAQs
Image Removed



Section
titleRequirements

To grab information from these three documents, two requirements must be met:

  1. The table of references is required to be selectable
  2. The display table macros require an identifier of tag

Let's see how we meet this requirements!

Section
titleSelectable Table of References

In our task we want to select the name and short description as properties and the table of references, which is part of the document body. The table of references is part of a Section Macro and therefore selectable. But we do want to have the table alone without the introduction text.

Therefore the table needs to be wrapped inside a Content Marker Macro with identifier documents (the identifier may be any character sequence).

Content Marker Macro with Identifier Parameter set to 'documents'.

Since the Display Table Macro renders each property and section in a column identified by the name or title – in our case identifier – we need to make sure that the identifier provided to the Identifier Parameter of the Content Marker Macro has the same value in all three documents.


Section
titleSelectable Display Table Macro

In order to remote control the Display Table Macro the macro requires to be identifiable. This can be done by either providing a value to the Identifier Parameter or the Identifier Classes Parameter.

We decide to provide the identifier references.

The Identifier Parameter of the Display Table Macro is set to 'references'.


...