Unfortunately there is no quick answer on which macros are most useful in any context. If you are a beginner, we recommend to get familiar with the following macros first: Section |
---|
level | 2 |
---|
title | Create a Document |
---|
| Tour |
---|
Title | Short Description | Notes |
---|
Document Properties Marker Macro | | Added automatically by the projectdoc templates. Use the properties to query and select information. | Section Macro | | Use sections to make content on a page referenceable. You may associate help for document authors to support document creation. The macro makes it also easy to drag sections around. |
|
|
Section |
---|
level | 2 |
---|
title | List Documents |
---|
| Tour |
---|
Title | Short Description | Notes |
---|
Display Table Macro | | Use Select, Where, Sort By to define queries on documents in your wiki. New documents that meet the criteria are automatically added on next visit of the page. | Tour Macro | | If you want to explicitly specify the documents your want to list, and select information from it, use the Tour Macro. This makes sure that the number of elements is fixed. |
|
|
Section |
---|
level | 2 |
---|
title | Transclude Information |
---|
| Tour |
---|
Title | Short Description | Notes |
---|
Transclusion Macro | | To remove redundancy strive for modular documentation. This does not only make team collaboration on documents easier, it also removes redundancy and inconsistencies. The Transclusion Macro allows to include a text snippet from another document. The text has to be marked either with the Section Macro or the Content Marker Macro . | Transclude Documents Macro | | To transclude content from a list of documents, use the Transclude Documents Macro. This combines the query ability of the Display Table Macro with the Transclusion Macro . | Display Document Property Macro | | If you want to reference a single property from a document (probably with a link to that document), use the Display Document Property Macro. If you want to arrange a couple of properties by a template, have a look at the Display Document Properties Macro . |
|
|
The overview lists all projectdoc macros in alphabetical order. You may experience the Macros Introduction as a more gentle approach, since the macros are introduced in a semantic context. |