I'm overwhelmed by the number of macros provided by projectdoc! Which of the macros are most useful to me?
Question
I'm overwhelmed by the number of macros provided by projectdoc! Which of the macros are most useful to me?
Answer
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:
Create a Document
| Title |
Short Description |
Notes |
| A table containing document properties. Three columns: name, value and meta data (aka controls) to a property. | Added automatically by the projectdoc templates. Use the properties to query and select information. |
| 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. | 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. |
List Documents
| Title |
Short Description |
Notes |
| Lists references to projectdoc documents in a table. Allows to select document properties for columns. Also non-list representations are provided. | 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. |
| Renders a predefined list of documents in a table. | 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. |
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.
