projectdoc Toolbox

The Content Marker Macro identifies content that can be displayed using the Display Table Macro. This is a short tip on how to transclude content from a projectdoc document.

Parent
Audience
Level of Experience
Expected Duration
15 min
Tags
Type

Assume you have a number of documents that contain information you want to display side-by-side in an overview document. You can use the Display Table Macro to grab properties and sections from a projectdoc document. But what if the content you need to display is not in a section or you want to display only parts of a section?

Sections without Name

Authors may always suppress the rendering of a section. So if the content to be transcluded is indeed a section, but you do not want to render the title of the section, this is the way to go. Use the Section Macro to define sections.

Transclude the content by the unique title by the use of the Display Table Macro.

Arbitrary Content

If you do not have a section, but a chunk of data that needs to be identified, use the Content Marker Macro. You can use this macro to identify a snippet inside a section or document.

 

You cannot define overlapping areas with the Section Macros and Content Marker Macros. The need to be strictly in a containment hierarchy.

Set the identifier for a piece of information you need to mark in a number of documents.

Again, use the Display Table Macro to select the content from the matching documents.

 

You can control the column headers of the Display Table Macro by translating them like this:

Now the second column header will read "Q 1" instead of "figures-q1".

Resources

Name Short Description
Lists references to projectdoc documents in a table. Allows to select document properties for columns. Also non-list representations are provided.
Renders a section, if the body is not empty. Supports authors to create content, clutter-free rendering without empty sections. Allows to transclude the content.
Marks a piece of content within a document. This content can be referenced for transclusion.
Use the Section Macro to define sections. This tip introduces the macro by listing its features.
It 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.
It is often obvious that the introduction text is a description of the information of the document. Therefore the title 'Description' or 'Summary' may be irrelevant. You may suppress the rendering of the title easily.