Location: PHPKode > projects > DotClear > locales/en/help/wiki.html
<html>
<head>
  <title>Wiki syntax reference</title>
</head>

<body>

<h3>Wiki syntax reference</h3>

<p>The wiki syntax is a way to enhance your text with a minimal set
of tags, studied to cover the basic needs (titles, paragraphs, quotes,
lists...)</p>

<dl>
<dt>Block elements</dt>
<dd>
<ul>
  <li>Leave an empty line between two similar blocks.</li>
  <li><strong>Paragraph</strong>: free text, ended by an empty line if
  another paragraph is to follow.</li>
  <li><strong>Title</strong>: <code>!!! title</code>, <code>!! title</code>
  or <code>! title</code>, allowing you to use three  different levels of
  heading.</li>
  <li><strong>Horizontal line</strong>: <code>----</code></li>
  <li><strong>Lists</strong>: Start each line with
  <code>*</code> or <code>#</code> for unnumbered or numbered lists respectively.
  List imbrication is done by mixing list markers this way:
<pre>
* item 1
** item 1.1
* item 2
*# item 2.1
...
</pre>
  </li>
  <li><strong>Preformatted text</strong>: each line must start with a space.</li>
  <li><strong>Block quote</strong>: each line must start with a semicolon (<code>&gt;</code>).</li>
</ul>
</dd>

<dt>Formatting tags</dt>
<dd>
<ul>
  <li><strong>Emphasis</strong>: two quotes <code>''text''</code></li>
  <li><strong>Strong emphasis</strong>: two underscore <code>__text__</code></li>
  <li><strong>New line</strong>: <code>%%%</code></li>
  <li><strong>Insertion</strong>: two plusses <code>++text++</code></li>
  <li><strong>Deletion</strong>: two minuses <code>--text--</code></li>
  <li><strong>Link</strong>: <code>[url]</code>, <code>[name|url]</code>,
    <code>[name|url|language]</code> or <code>[name|url|languagee|title]</code></li>
  <li><strong>Image</strong>:
    <code>((url|alternative text))</code>,
    <code>((url|alternative text|position))</code> or
    <code>((url|alternative text|position|long description))</code>.
    <br />The position can be either L or G (left), R or D (right) or C (centered).</li>
  <li><strong>Anchor</strong>: <code>~anchor~</code></li>
  <li><strong>Acronym</strong>: <code>??acronym|title??</code></li>
  <li><strong>Inline HTML</strong>: two backquotes <code>``html code``</code></li>
  <li><strong>Inline quote</strong>: <code>{{quote}}</code>,
    <code>{{quote|language}}</code> or <code>{{quote|language|url}}</code></li>
  <li><strong>Code</strong>: <code>@@code@@</code></li>
  <li><strong>Footnotes</strong>: <code>$$footnote$$</code></li>
</ul>
</dd>

<dt>Unformatted text</dt>
<dd>If you don't want one formatting character to be interpreted as such, add a
<code>\</code> just before it. This way:
<code>\[text in brackets without being a link\]</code>
</dd>

<dt>HTML Code</dt>
<dd>Even if you chose the wiki syntax, you may sometimes need a more
powerful formatting, i.e. HTML syntax. Do it the following way:
<pre>
///html
&lt;p style="color:red"&gt;my text in red&lt;/p&gt;
///
</pre>
</dd>
</dl>


</body>
</html>
Return current item: DotClear