projectdoc for Confluence is scheduled to be released by the end of this month. Our documentation effort currently concentrates on the addon’s macros.
Today we finished the documentation for 19 macros or the more of 40 macros provided by projectdoc.
The macros with updated documentation are:
- Tip Box Macro
- Renders a box with a tip for the reader.
- Warning Box Macro
- Renders a hint to warn the reader about something.
- Fault Box Macro
- Renders a box containing a fault message reported by a team member for the author.
- Section Macro
- Renders a section, if the body is not empty. Allows to transclude the content.
- References Box Macro
- Renders a box with references to further information.
- Question Box Macro
- Renders a box containing an open question.
- Pending Box Macro
- Renders a box containing a pending message to be handled later by the author.
- Note Box Macro
- Renders something to note by the reader.
- Iteration Macro
- Selects an iteration phase from a fixed set of stages.
- Info Box Macro
- Renders a box containing an info message.
- Hide From Anonymous User
- Hides a text fragment from an anonymous user.
- Hide From Viewer Macro
- Hides a text fragment from a user that has no edit permissions.
- Feedback Box Macro
- Renders a box containing a feedback message from a reader with write privilege.
- Example Box Macro
- Renders an example within a box.
- Caution Box Macro
- Renders a box containing a caution message.
- Deprecated Box Macro
- Renders a box containing a deprecation warning for the reader.
- Document Properties Marker Macro
- A table containing document properties. Three columns: name, value and meta data to a property.
- Content Marker Macro
- Marks a piece of content within a document. This content can be referenced for transclusion.
- Definition List Macro
- Renders term and definition information as a definition list. Currently Conflucene does not easily support authors to write definition lists. But definition lists allow to render this form of information efficiently.
For detailed information about these macros, please refer to the list of macros.
Or have a look at the updated Prezi presentation: projectdoc Macros. This presentation provides a brief visual overview over the projectdoc macros.
If you want to learn more about projectdoc and how it helps to create good project documentation, please refer to the introduction video!
