Contents
Checklist Items
There are basically 2 types of items: Ones with square boxes (checkboxes)
and ones with circles. Lines starting with
# become checkbox items.
Lines starting with
o become items with circles instead of
checkboxes.
If
x or
* (instead of
# and
o) is
used, the checklist items will be already checked.
Headings
Lines which should appear as headlines have to start with
===
(largest headline),
== (medium), or
= (smallest).
The 3 sizes correspond with the HTML tags h1, h2, and h3. Respective
trailing equal signs are removed.
Examples
Large headline (h1)
Medium headline (h2)
Smallest headline (h3)
Text Input Fields
Checklist items and other text may use
[] which gets
substituted with a text input field (its size may be defined on the
Checklist Generator's entry form). You may also size them individually
by adding underscore characters as in
[____] or
[_______].
Indented Lines
Lines which start with exactly 2 space characters will appear indented,
i.e. with some added left margin.
Example
This checklist item is not indented.
Items Continued On Same Line
Line breaks can be avoided by adding a space character at the end. For
instance, a checklist item following an item ending with a space
character will appear on the same line.
The same works for paragraph text.
Example
Some text with no space at the end of the line becomes a single paragraph.
Some text with a space at the end of the line (line ends here) /
will be continued with text from the next line (line ends here) /
even if it is a checklist item.
URLs, Links and Anchors
To include a link to a website or mail address use [url=link]text[/url].
Example
To link e.g. to the Checklist Generator use
[url=http://wox.at/clg]Checklist generator homepage[/url]:
Checklist generator homepage
To link to a mail address use e.g.
[url=mailto:user@example.net]user@example.net[/url]:
user@example.net
Miscellaneous Notes
The first headline of a checklist becomes the HTML title of the created list.
Single empty lines and comments are ignored. They do not show up in the created checklist. Comment lines have to start with //.
Two or more consecutive empty lines will show up as vertical space.
3 space characters are replaced by a spacer (in HTML speak 3 ). Example: S p a c e r s. The only exception is in tables: Here space characters are ignored to allow better alignment. To create a spacer use 3 _ (underline characters) instead.
Lines starting with 4 dashes (----) become horizontal lines.
Super tricky stuff
In order to write [ ] one has to write a space between the brackets so that they are not converted to a text input field.
There's no safe way to write exactly [url=...]...[/url]. Instead one could include a space, e.g. after ..., such as in [url=... ]...[/url].