| Table of Contents |
|---|
| Warning |
|---|
TBC - This section is still being written. |
There are so many ways of using wikis that we need to agree on standards.
...
Formatting Conventions
These are the most used conventions in the wiki for formatting.
Command Line Examples
Confluence has a built in macro specifically for command line examples. For command line examples, use the code macro set to the language bash. Also for in-line comments, use the # symbol which is ignored on the command line.
...
We use the same macro but select the particular language to used in the example.
Collapsible Content
Collapsible content using the expand macro should only be used in cases where the reader wants to quickly view optional data. A good example is an FAQ. Beyond that, consider simply making a link to another page.
| Expand |
|---|
This content is collapsed. Be careful not to abuse this macro. |
Author Notations Calling for Action
...
The Bonsai Wiki Standards use basic classification with allowance for a one liner summary. For example,
...
uses the heading of the warning marco with the following code,
- TBC (To Be Completed) - Follow with a name if appropriate.
- TBI (To Be Improved) - Help Improve the Article
- Review TBR (To Be Reviewed) - The Author Would like Review by Peers
- Comment - From Tin to Roderick
- . Follow with a name if appropriate.
Here is an example of an action item that talks about improving content with examples,
| Warning | ||
|---|---|---|
| ||
The contents of this section needs to be augmented with examples. |
...