...
There are so many ways of using wikis that we need to agree on standards.
Often Used
These are the most used conventions in the wiki.
Command Line Examples
Unfortunately Confluence does not yet have a built in macro specifically for command line examples. For command line examples, use the code macro set to the language HTML. Also for in-line comments, use the # symbol which is ignored on the command line.
...
| Warning |
|---|
Put a link here to vote for the feature to improve the code macro. |
Code Examples
We use the same macro but select the particular language to used in the example.
Collapsible Content
...
Author Notations Calling for Action
These are notations used by authors to note parts of the wiki that are not yet ready or need improvement.
Action Items
All action items use the warning macro and are aimed at other authors or letting the reader know the contents are not quite complete or need improvement. Action items should all use a title of "Action Item" followed by a classification. This allows us to easily search for action items.
...
| Warning | ||
|---|---|---|
| ||
The contents of this section needs to be augmented with examples. |
Notes
The purpose of notes is to highlight information. We use the notes macro for this.
| Note |
|---|
Make sure you are logged in as serveradmin before proceeding. |
References and Hyper-links in Notations
We use the Info macro to provide informational notes that may be of interest to the reader. Direct references should just be normal html links.
| Info |
|---|
As described in Ubuntu Help Pages - Time Synchronisation with NTP there are many ways of doing this. The method shown here was taught to me by Dickson as the more universal Unix approach. |
Panels
The Panel Macro allows you to display anything from a block of text, to an image or embedded video inside a customizable panel. Generally, the purpose is to accentuate content or define sections within a page.
Directory Structure Highlights for Authors
Authors of content should know about the areas of the wiki and how we place the content as it is being written and organize completed content.
Re-Using Content
Confluence's Include and Excerpt Include macros help you re-use content.
Writing Content
Dictionary - Canada English