Dotclear

source: locales/en/help/core_wiki.html @ 3997:6eb2c35bdb0e

Revision 3997:6eb2c35bdb0e, 3.4 KB checked in by franck <carnet.franck.paul@…>, 6 years ago (diff)

Update some help (en and fr) for new wiki subscript form: _<subscript>_
Line 
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
11of tags studied to cover the basic needs (titles, paragraphs, quotes,
12lists...).</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    <code>*</code> item 1
30    <code>**</code> item 1.1
31    <code>*</code> item 2
32    <code>*#</code> item 2.1
33  ...
34  </pre>
35  </li>
36  <li><strong>Definition lists:</strong> Start each line with <code>=</code> for the term to define and with <code>:</code> for the definition of the term.
37  <pre>
38  <code>=</code> term
39  <code>:</code> description of the term
40  </pre>
41  </li>
42  <li><strong>Preformatted text:</strong> Each line must start with a space.</li>
43  <li><strong>Block quote:</strong> Each line must start with a <code>&gt;</code>.</li>
44  <li><strong>Side block:</strong> Each line must start with a <code>)</code>.</li>
45</ul>
46</dd>
47
48<dt>Formatting tags</dt>
49<dd>
50<ul>
51  <li><strong>Emphasis:</strong> Two quotes <code>''text''</code></li>
52  <li><strong>Strong emphasis:</strong> Two underscores <code>__text__</code></li>
53  <li><strong>New line:</strong> <code>%%%</code></li>
54  <li><strong>Insertion:</strong> Two plusses <code>++text++</code></li>
55  <li><strong>Deletion:</strong> Two minuses <code>--text--</code></li>
56  <li><strong>Link:</strong> <code>[url]</code>, <code>[name|url]</code>,
57    <code>[name|url|language]</code> or <code>[name|url|language|title]</code></li>
58  <li><strong>Image:</strong>
59    <code>((url|alternative text))</code>,
60    <code>((url|alternative text|position))</code> or
61    <code>((url|alternative text|position|long description))</code>.
62    <br />The position can be either L (left), R (right) or C (centered).</li>
63  <li><strong>Anchor:</strong> <code>~anchor~</code></li>
64  <li><strong>Acronym:</strong> <code>??acronym|title??</code></li>
65  <li><strong>Inline HTML:</strong> Two backquotes <code>``html code``</code></li>
66  <li><strong>Inline quote:</strong> <code>{{quote}}</code>,
67    <code>{{quote|language}}</code> or <code>{{quote|language|url}}</code></li>
68  <li><strong>Code:</strong> <code>@@code@@</code></li>
69  <li><strong>Footnotes:</strong> <code>$$footnote$$</code></li>
70  <li><strong>Superscript</strong>&nbsp;: <code>^superscript^</code></li>
71  <li><strong>Subscript</strong>&nbsp;: <code>_subscript_</code></li>
72</ul>
73</dd>
74
75<dt>Unformatted text</dt>
76<dd>If you don't want one formatting character to be interpreted as such, add a
77<code>\</code> just before it. For instance:
78<code>\[Text in brackets without being a link\]</code>
79</dd>
80
81<dt>HTML code</dt>
82<dd>Even if you chose the Wiki syntax, you may sometimes need a more
83powerful formatting, i.e. HTML syntax. Do it the following way:
84<pre>
85///html
86&lt;p style="color:red"&gt;my text in red&lt;/p&gt;
87///
88</pre>
89</dd>
90</dl>
91
92</body>
93</html>
Note: See TracBrowser for help on using the repository browser.

Sites map