www.bonsaiframework.com
Page tree
Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 25 Next »

This section is still being written.

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.

# Here is an example of the output of the top command.
top
Processes: 67 total, 2 running, 1 stuck, 64 sleeping, 322 threads                       23:32:55
Load Avg: 0.35, 0.31, 0.21  CPU usage: 2.87% user, 2.39% sys, 94.72% idle
SharedLibs: 4076K resident, 4728K data, 0B linkedit.
MemRegions: 17168 total, 475M resident, 22M private, 307M shared.
PhysMem: 303M wired, 1090M active, 2086M inactive, 3479M used, 614M free.
VM: 154G vsize, 1038M framework vsize, 452896(540) pageins, 384(0) pageouts.
Networks: packets: 7870815/3728M in, 7170915/856M out.
Disks: 450412/11G read, 193367/7816M written.

PID   COMMAND      %CPU TIME     #TH  #WQ  #POR #MREG RPRVT  RSHRD  RSIZE  VPRVT  VSIZE  PGRP
5688  top          3.9  00:01.84 1/1  0    24   33    1348K  244K   1924K  17M    2378M  5688
5685  bash         0.0  00:00.00 1    0    17   24    396K   244K   1060K  17M    2378M  5685
5684  login        0.0  00:00.03 1    0    22   53    488K   244K   1592K  19M    2379M  5684
5682  Terminal     3.0  00:02.13 6    2    110+ 120+  11M+   19M+   17M+   61M+   2736M+ 5682
5672  mdworker     0.0  00:00.09 3    1    50   71    2804K  7008K  8376K  50M    2428M  5672
5648  cupsd        0.0  00:00.02 3    1    36   58    1100K  248K   2412K  48M    2409M  5648
2212  Preview      0.0  00:02.36 2    1    105  153   6716K  24M    22M    46M    2733M  2212
2121  AppleSpell   0.0  00:00.07 2    1    33   50    1036K  5612K  2528K  39M    2427M  2121

Yes, the code macro is missing is the ability to,

  • Colour code
  • Bold or Italicize
  • Use Hyperlinks

However, the code macro handles the most important requirements,

  • Defaulting to a mono-spaced font (which is critical in text based work for rendering tabular data)
  • Auto horizontal scrolling
  • The right macro where Confluence will continue to add features for code

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.

The Bonsai Wiki Standards use the following classifications,

  • Incomplete - The article or section is incomplete and not yet ready for use.
  • Improvement - The article or section can be improved.
  • Review - The document is ready for review.
  • Comment - Inline comment for authors of articles.

Here is an example of an action item that talks about improving content with examples,

Action Item - Improvement

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.

Make sure you are logged in as serveradmin before proceeding.

References and Hyper-links in Notations

We use the Info macro to provide informational comments that may be of interest to the reader but not required reading. This is different than direct references which should just be normal html links.

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

  • No labels