| 1 | <html> |
|---|
| 2 | <head> |
|---|
| 3 | <title>Wiki syntax reference</title> |
|---|
| 4 | </head> |
|---|
| 5 | |
|---|
| 6 | <body> |
|---|
| 7 | |
|---|
| 8 | <h4>Wiki syntax reference</h4> |
|---|
| 9 | |
|---|
| 10 | <p>The Wiki syntax is a way to enhance your text with a minimal set |
|---|
| 11 | of tags studied to cover the basic needs (titles, paragraphs, quotes, |
|---|
| 12 | lists...).</p> |
|---|
| 13 | |
|---|
| 14 | <dl> |
|---|
| 15 | <dt>Block elements</dt> |
|---|
| 16 | <dd> |
|---|
| 17 | <ul> |
|---|
| 18 | <li>Leave an empty line between two similar blocks.</li> |
|---|
| 19 | <li><strong>Paragraph:</strong> Free text, ended by an empty line if |
|---|
| 20 | another paragraph is to follow.</li> |
|---|
| 21 | <li><strong>Title:</strong> <code>!!! title</code>, <code>!! title</code> |
|---|
| 22 | or <code>! title</code>, allowing you to use three different levels of |
|---|
| 23 | heading.</li> |
|---|
| 24 | <li><strong>Horizontal line:</strong> <code>----</code></li> |
|---|
| 25 | <li><strong>Lists:</strong> Start each line with |
|---|
| 26 | <code>*</code> or <code>#</code> for unnumbered or numbered lists respectively. |
|---|
| 27 | List imbrication is done by mixing list markers this way: |
|---|
| 28 | <pre> |
|---|
| 29 | * item 1 |
|---|
| 30 | ** item 1.1 |
|---|
| 31 | * item 2 |
|---|
| 32 | *# item 2.1 |
|---|
| 33 | ... |
|---|
| 34 | </pre> |
|---|
| 35 | </li> |
|---|
| 36 | <li><strong>Preformatted text:</strong> Each line must start with a space.</li> |
|---|
| 37 | <li><strong>Block quote:</strong> Each line must start with a <code>></code>.</li> |
|---|
| 38 | </ul> |
|---|
| 39 | </dd> |
|---|
| 40 | |
|---|
| 41 | <dt>Formatting tags</dt> |
|---|
| 42 | <dd> |
|---|
| 43 | <ul> |
|---|
| 44 | <li><strong>Emphasis:</strong> Two quotes <code>''text''</code></li> |
|---|
| 45 | <li><strong>Strong emphasis:</strong> Two underscores <code>__text__</code></li> |
|---|
| 46 | <li><strong>New line:</strong> <code>%%%</code></li> |
|---|
| 47 | <li><strong>Insertion:</strong> Two plusses <code>++text++</code></li> |
|---|
| 48 | <li><strong>Deletion:</strong> Two minuses <code>--text--</code></li> |
|---|
| 49 | <li><strong>Link:</strong> <code>[url]</code>, <code>[name|url]</code>, |
|---|
| 50 | <code>[name|url|language]</code> or <code>[name|url|language|title]</code></li> |
|---|
| 51 | <li><strong>Image:</strong> |
|---|
| 52 | <code>((url|alternative text))</code>, |
|---|
| 53 | <code>((url|alternative text|position))</code> or |
|---|
| 54 | <code>((url|alternative text|position|long description))</code>. |
|---|
| 55 | <br />The position can be either L (left), R (right) or C (centered).</li> |
|---|
| 56 | <li><strong>Anchor:</strong> <code>~anchor~</code></li> |
|---|
| 57 | <li><strong>Acronym:</strong> <code>??acronym|title??</code></li> |
|---|
| 58 | <li><strong>Inline HTML:</strong> Two backquotes <code>``html code``</code></li> |
|---|
| 59 | <li><strong>Inline quote:</strong> <code>{{quote}}</code>, |
|---|
| 60 | <code>{{quote|language}}</code> or <code>{{quote|language|url}}</code></li> |
|---|
| 61 | <li><strong>Code:</strong> <code>@@code@@</code></li> |
|---|
| 62 | <li><strong>Footnotes:</strong> <code>$$footnote$$</code></li> |
|---|
| 63 | </ul> |
|---|
| 64 | </dd> |
|---|
| 65 | |
|---|
| 66 | <dt>Unformatted text</dt> |
|---|
| 67 | <dd>If you don't want one formatting character to be interpreted as such, add a |
|---|
| 68 | <code>\</code> just before it. For instance: |
|---|
| 69 | <code>\[Text in brackets without being a link\]</code> |
|---|
| 70 | </dd> |
|---|
| 71 | |
|---|
| 72 | <dt>HTML code</dt> |
|---|
| 73 | <dd>Even if you chose the Wiki syntax, you may sometimes need a more |
|---|
| 74 | powerful formatting, i.e. HTML syntax. Do it the following way: |
|---|
| 75 | <pre> |
|---|
| 76 | ///html |
|---|
| 77 | <p style="color:red">my text in red</p> |
|---|
| 78 | /// |
|---|
| 79 | </pre> |
|---|
| 80 | </dd> |
|---|
| 81 | </dl> |
|---|
| 82 | |
|---|
| 83 | </body> |
|---|
| 84 | </html> |
|---|
