2 == LOona markup notation ==
4 LOona's text markup is based on indentations and the systematic use
5 of text elements that you would expect in good-looking plain text
6 documents anyway. Albeit loosely based on the markup notation of
7 other, more popular WIKIs, LOona's markup notation has some features
8 to offer which recommend it especially for technical documentation.
10 '''NOTE''': To understand these instructions, click on 'Edit' to see
11 the plain text representation; use 'Preview' to try out some markup
17 Text of a consistent indentation level running uninterrupted by empty
18 lines is combined into ''blocks''. Lines in blocks can break at any
19 position; the line breaks are not included to the result:
21 ---------------------------------------------------------------------
28 ---------------------------------------------------------------------
31 === 2. Indentation ===
33 ''Indentation'' is measured in the consecutive number of spaces at
34 the beginning of a line; different indentation levels are taken into
37 ---------------------------------------------------------------------
47 ---------------------------------------------------------------------
50 === 3. Preformatted text ===
52 For blocks of code and other kinds of ''preformatted text'' use an
53 indentation that is ''two levels deeper'' than the current level,
56 ---------------------------------------------------------------------
64 ---------------------------------------------------------------------
69 Inlined ''code'' is marked up between double braces. It may occur at
70 any position in a line, but it must be the same line in which the
71 opening and the closing of the markup occurs:
73 ---------------------------------------------------------------------
75 This is {{code_markup}} in running text.
77 ---------------------------------------------------------------------
82 There are two types of items in ''lists''; ''soft'' and ''bulleted''
83 items. They are recognized by their initiatory character (dash or
84 asterisk), followed by a whitespace at the beginning of a line:
86 ---------------------------------------------------------------------
91 ---------------------------------------------------------------------
93 Soft items are, by the way, a natural means to enforce line breaks:
95 ---------------------------------------------------------------------
98 - this is another line,
99 - this is a third line.
101 ---------------------------------------------------------------------
103 Lists follow the same indentation rules as normal text:
105 ---------------------------------------------------------------------
117 ---------------------------------------------------------------------
119 '''NOTE''': Although not striclty required, it is recommended to
120 indent lists by one level. This will help the parser to avoid
121 ambiguities; otherwise, when a regular block follows an unindented
122 list, it would be concatenated with the last item, as empty lines are
123 not sufficient to break out from a list.
128 Image references are enclosed by at signs:
130 ---------------------------------------------------------------------
132 @@/images/loona.png@@
134 ---------------------------------------------------------------------
139 Links are enclosed in double squared brackets:
142 Internal link: Link target is description at the same time.
144 * [[Home page][home]] -
145 Internal link with description differing from the link target
147 * [[http://loona.neoscientists.org/]] -
150 * [[You know what cool is][http://loona.neoscientists.org/]] -
151 External link with different description
153 * [[@@/images/loona.png@@][http://loona.neoscientists.org/]] -
156 As for external links, LOona's configuration file offers a global
157 option to decide whether external links should open in a new browser
158 window or not. (Many people disregard this feature, while businesses
159 seem to swear by it.)
164 Lines running uninterrupted with at least one cell separator in each
165 of them automatically form a table. The cell separator is a double
168 ---------------------------------------------------------------------
170 First cell || Second cell
171 Third cell || Fourth cell
173 ---------------------------------------------------------------------
175 It is also possible to create empty cells as long as the separators
176 are present. Note, by the way, that cell separators do not
177 necessarily need to be aligned exactly below each other:
179 ---------------------------------------------------------------------
181 First cell || || third cell
184 ---------------------------------------------------------------------
189 Headings occupy an entire line. They are enclosed by at least one
190 equal sign and a whitspace on each side; the more equal signs, the
191 less significant the section:
193 ---------------------------------------------------------------------
201 ---------------------------------------------------------------------
206 A minimum of four dashes is interpreted as a horizontal rule. Rules
207 may occur at arbitrary indentation levels, but otherwise, they must
208 occupy the whole line:
210 ---------------------------------------------------------------------
213 ----------------------------------------------
216 ---------------------------------------------------------------------
221 An emphasized portion of text may occur at any position in a line,
222 but the opening and the closing of the markup must occur in the same
223 line to be recognized.
225 The emphasized text is surrounded by at least two ticks on each side;
226 the more ticks, the stronger the emphasis.
228 ---------------------------------------------------------------------
232 - '''strong emphasis'''
233 - ''''very strong emphasis''''
235 ---------------------------------------------------------------------
240 If in doubt, use fewer markup. Sparse application of compositional
241 elements usually leads to better readability and stylistic clarity.
242 If you can't produce the looks you project, first and foremost think
243 of improving your stylesheet.
245 Ok, for the desperate: There's a single lone hack in LOona's markup
246 format which allows you to produce additional padding between
247 elements, list items which may appear to be empty, etc. It can come
248 to the rescue in some darned situations. It's the non-breaking space;
249 produce it either by inserting the character code 160 (see your
250 browser or operating system manuals on how to achieve this), or by
251 writing the HTML equivalent (' '). (See the plain text
252 representation of this document, as it cannot be escaped.)