Help Text as a PDF file, single html file, or split into multiple html files
The Vehicle Maintenance Log

next up previous contents
Next: D. Documentation Change Log Up: Vehicle Maintenance Log Help Previous: B. Example Email Report

Subsections



C. Formatting Log Entries with NanoWiki

The NanoWiki Engine is a very minimal set of markup tags for formatting text.

C..1 NanoWiki Example

The following text:

This is an example of my nanowiki formatting engine.
You can specifiy links by typing the URL like this http://rogercortesi.com/
or like this... [http://rogercortesi.com/ my web page]

Newlines are honored.
[[[
a code block is entered using a pair
of triple brackets \[\[\[ code... \]\]\].
]]]
[[[[
Here is some code that is indented by using a
quadruple bracket pair \[\[\[\[ text... \]\]\]\].
]]]]
More text

gets displayed as:

Figure 12: An example of NanoWiki formatting.
Image nanowiki_example

C..2 NanoWiki Formatting Rules

Newlines:
Newlings are printed.

Hyperlinks:
http://rogercortesi.com/ or [http://rogercortesi.com/ my site] where the text 'my site' will be used as the link text.

Code block / Preformatted Text:
Text between [[[ and ]]] will preformatted (3 pairs of brackets).

Indentation:
Text between [[[[ and ]]]] will be indented (4 pairs of brackets). Indentations can be nested.

Files:
[[media:filename.pdf]] or [[media:filename.pdf hello roger]] where 'hello roger' will be the link text.

Images:
[[image:filename.jpg]] or [[image:filename.jpg hello roger]] where 'hello roger' will be the caption.

Thumbnail Images:
[[thumb:filename.jpg]] or [[thumb:filename.jpg hello roger]] where 'hello roger' will be the caption. The thumbnail file MUST exists (see file upload page), and it will link to the full size image.

Files and images must be in the entry's primary topic's directory. File name may not have spaces in them. Bracket characters may be escaped with a backslash in front of them to prevent them from created indentations, codeblocks or URLs.


next up previous contents
Next: D. Documentation Change Log Up: Vehicle Maintenance Log Help Previous: B. Example Email Report   Contents
Roger Cortesi 2005-11-19