This is a gentle introduction to the core macros. The macros are grouped semantically to make it easier for users to build a conceptual mind map for them.
Working Horses
Authors add properties and sections to projectdoc documents. This information is transcluded from other documents, either by pointing to a particular property or section or by defining a query to select information from a number of documents.
To enhance navigation authors may render links to related documents by queries. If the list of references is fixed, the documents to link to can be easily defined and any property or section may be rendered.
The following macros are used to accomplish these tasks quite easily.
| Name |
Short Description |
Notes |
| A table containing document properties. Three columns: name, value and meta data (aka controls) to a property. | Typically this macro is already on every projectdoc document created with a blueprint. Authors supply values for the defined properties and optionally add new ones. |
| 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. | Defines a section within a projectdoc document. This is text content with a title to be easily transcluded for reuse in other pages. |
| Lists references to projectdoc documents in a table. Allows to select document properties for columns. Also non-list representations are provided. | Since every document has properties, it is very easy to select them. Mind the Search Tips! |
| Renders a predefined list of documents in a table. | While the Display Table Macro lists a result set of documents that match your queries, the Tour Macro allows to select the documents to display manually. Then select the properties and sections you want to show. |
| Transcludes content from a document marked with the content marker macro. | If you need to transclude from a single document. Also consider to have a look at the Section Macro if you want to transclude information from a non-standard part of a document. |
| Renders transcluded content fetched from documents of a result set. | If you need to transclude from documents in a result set. |
| Renders the value of a property of a document. | |
| Renders a quote from a resource with author and source. | To quote relevant information, also consider the External Quote Macro for quoting from resources outside your wiki. |
For teams to work collaboratively on their documentation there are more use cases than these basic ones. You may need to transclude information from remote servers, add visuals to put emphasis on important information, or control which information to show for different audiences.
Have a look at the next section to learn of these and all the other macros inside of the projectdoc Toolbox!
Introduction to Core Macros
The list groups the core macros semantically. This may help new users to learn about the core macros and to know when to use which.
An alternative View on projectdoc Macros
