1 ## <a name="TWiki Editing Shorthand"></a> TWiki Editing Shorthand
3 <table bgcolor="#ffffff" border="1" cellpadding="3">
5 <th width="50%"> Formatting Command: </th>
6 <th width="25%"> You write: </th>
7 <th width="25%"> You get: </th>
10 <td><strong>Paragraphs:</strong> %BR% Blank lines will create new paragraphs. </td>
16 <td> 1st paragraph <p> 2nd paragraph </p>
20 <td><strong>Headings:</strong> %BR% Three or more dashes at the beginning of a line, followed by plus signs and the heading text. One plus creates a top level heading, two pluses a second level heading, etc. The maximum heading depth is 6. <p> You can create a table of contents with the [[Main/VarTOC]] variable. If you want to <strong>exclude</strong> a heading from the TOC, put <code>!!</code> after the <code>---+</code>. </p>
21 <p> %X% Empty headings are allowed, but won't appear in the table of contents. </p>
35 <td><strong>Bold Text:</strong> %BR% Words get shown in <strong>bold</strong> by enclosing them in <code>*</code> asterisks. </td>
39 <td><strong>Bold</strong></td>
42 <td><strong>Italic Text:</strong> %BR% Words get shown in <em>italic</em> by enclosing them in <code>_</code> underscores. </td>
46 <td><em>Italic</em></td>
49 <td><strong>Bold Italic:</strong> %BR% Words get shown in <strong><em>bold italic</em></strong> by enclosing them in <code>__</code> double-underscores. </td>
53 <td><strong><em>Bold italic</em></strong></td>
56 <td><strong>Fixed Font:</strong> %BR% Words get shown in <code>fixed font</code> by enclosing them in <code>=</code> equal signs. </td>
60 <td><code>Fixed font</code><p>
65 <td><strong>Bold Fixed Font:</strong> %BR% Words get shown in <code><b>bold fixed font</b></code> by enclosing them in <code><b></b></code> double equal signs. </td>
69 <td><code><b>Bold fixed</b></code></td>
72 <td> %T% You can follow the closing bold, italic, or other (<code>* _ __ = ==</code>) indicator with normal punctuation, such as commas and full stops. <p> %X% Make sure there is no space between the text and the indicators. </p>
78 <td><em>This works</em>,%BR% _this does not _ </td>
81 <td><strong>Verbatim (Literal) Text:</strong> %BR% Surround code excerpts and other formatted text with <code><verbatim></code> and <code></verbatim></code> tags.%BR% %T% <code>verbatim</code> tags disable HTML code. Use <code><pre></code> and <code></pre></code> tags instead if you want the HTML code within the tags to be interpreted.%BR% <strong><em>%X% NOTE:</em></strong> Preferences variables (* Set NAME = value) are set within verbatim tags. </td>
100 <td><strong>Separator (Horizontal Rule):</strong> %BR% Three or more three dashes at the beginning of a line.. </td>
109 <td><strong>Bulleted List:</strong> %BR% Multiple of three spaces, an asterisk, and another space.%BR% %H% For all the list types, you can break a list item over several lines by indenting lines after the first one by <strong>at least 3 spaces</strong>. </td>
126 <li> A bullet broken over three lines </li>
127 <li> last bullet </li>
132 <td><strong>Numbered List:</strong> %BR% Multiple of three spaces, a type character, a dot, and another space. Several types are available besides a number: <table border="1" cellpadding="0" cellspacing="0" style="border-width: 1px">
134 <th bgcolor="#6b7f93" maxcols="0" style=""><a href="http://localhost?sortcol=0;table=1;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#ffffff">Type</font></a></th>
135 <th bgcolor="#6b7f93" maxcols="0" style=""><a href="http://localhost?sortcol=1;table=1;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#ffffff">Generated Style</font></a></th>
136 <th bgcolor="#6b7f93" maxcols="0" style=""><a href="http://localhost?sortcol=2;table=1;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#ffffff">Sample Sequence</font></a></th>
139 <td bgcolor="#ecf2f8" style=""> 1. </td>
140 <td bgcolor="#ecf2f8" style=""> Arabic numerals </td>
141 <td bgcolor="#ecf2f8" style=""> 1, 2, 3, 4... </td>
144 <td bgcolor="#ffffff" style=""> A. </td>
145 <td bgcolor="#ffffff" style=""> Uppercase letters </td>
146 <td bgcolor="#ffffff" style=""> A, B, C, D... </td>
149 <td bgcolor="#ecf2f8" style=""> a. </td>
150 <td bgcolor="#ecf2f8" style=""> Lowercase letters </td>
151 <td bgcolor="#ecf2f8" style=""> a, b, c, d... </td>
154 <td bgcolor="#ffffff" style=""> I. </td>
155 <td bgcolor="#ffffff" style=""> Uppercase Roman Numerals </td>
156 <td bgcolor="#ffffff" style=""> I, II, III, IV... </td>
159 <td bgcolor="#ecf2f8" style=""> i. </td>
160 <td bgcolor="#ecf2f8" style=""> Lowercase Roman Numerals </td>
161 <td bgcolor="#ecf2f8" style=""> i, ii, iii, iv... </td>
187 <li type="A"> Sushi </li>
188 <li type="A"> Dim Sum </li>
189 <li type="A"> Fondue </li>
194 <li type="i"> Sushi </li>
195 <li type="i"> Dim Sum </li>
196 <li type="i"> Fondue </li>
201 <td><strong>Definition List:</strong> %BR% Three spaces, a dollar sign, the term, a colon, a space, followed by the definition. </td>
216 <td><strong>Table:</strong> %BR% Each row of the table is a line containing of one or more cells. Each cell starts and ends with a vertical bar '|'. Any spaces at the beginning of a line are ignored. <ul>
217 <li><code>| *bold* |</code> header cell with text in asterisks </li>
218 <li><code>| center-aligned |</code> cell with at least two, and equal number of spaces on either side </li>
219 <li><code>| right-aligned |</code> cell with more spaces on the left </li>
220 <li><code>| 2 colspan ||</code> and multi-span columns with multiple <tt>|</tt>'s right next to each other </li>
221 <li><code>|^|</code> cell with caret indicating follow-up row of multi-span rows </li>
222 <li> You can split rows over multiple lines by putting a backslash <code>'\'</code> at the end of each line </li>
223 <li> Contents of table cells wrap automatically as determined by the browser </li>
224 <li> Use <code>&#124;</code> or <code>%VBAR%</code> to add <code>|</code> characters in tables. </li>
225 </ul> %T% The [[TWiki/TablePlugin]] provides the <code>|^|</code> multiple-span row functionality and additional rendering features </td>
240 <table border="1" cellpadding="0" cellspacing="0" style="border-width: 1px">
242 <th bgcolor="#6b7f93" maxcols="0" style=""><a href="http://localhost?sortcol=0;table=2;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#ffffff">L</font></a></th>
243 <th bgcolor="#6b7f93" maxcols="0" style=""><a href="http://localhost?sortcol=1;table=2;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#ffffff">C</font></a></th>
244 <th bgcolor="#6b7f93" maxcols="0" style=""><a href="http://localhost?sortcol=2;table=2;up=0#sorted_table" rel="nofollow" title="Sort by this column"><font color="#ffffff">R</font></a></th>
247 <td bgcolor="#ecf2f8" style=""> A2 </td>
248 <td align="center" bgcolor="#ecf2f8" style=""> B2 </td>
249 <td align="right" bgcolor="#ecf2f8" style=""> C2 </td>
252 <td bgcolor="#ffffff" style=""> A3 </td>
253 <td align="center" bgcolor="#ffffff" style=""> B3 </td>
254 <td align="right" bgcolor="#ffffff" style=""> C3 </td>
257 <td bgcolor="#ecf2f8" colspan="3" style=""> multi span </td>
260 <td bgcolor="#ffffff" rowspan="3" style=""> A5-7 </td>
261 <td align="center" bgcolor="#ffffff" style=""> 5 </td>
262 <td align="right" bgcolor="#ffffff" style=""> 5 </td>
265 <td bgcolor="#ecf2f8" style=""> six </td>
266 <td bgcolor="#ecf2f8" style=""> six </td>
269 <td bgcolor="#ffffff" style=""> seven </td>
270 <td bgcolor="#ffffff" style=""> seven </td>
273 <td bgcolor="#ecf2f8" style=""> split </td>
274 <td bgcolor="#ecf2f8" style=""> over </td>
275 <td bgcolor="#ecf2f8" style=""> 3 lines </td>
278 <td bgcolor="#ffffff" style=""> A9 </td>
279 <td align="center" bgcolor="#ffffff" style=""> B9 </td>
280 <td align="right" bgcolor="#ffffff" style=""> C9 </td>
286 <td><strong>WikiWord Links:</strong> %BR% CapitalizedWordsStuckTogether (or [[Main/WikiWords]]) will produce a link automatically if preceded by whitespace or parenthesis. %BR% %T% If you want to link to a topic in a different web write <code>Otherweb.TopicName</code>. %BR% %H% The link label excludes the name of the web, e.g. only the topic name is shown. As an exception, the name of the web is shown for the WebHome topic. <p> It's generally a good idea to use the [[Main/TWikiVariables]] %TWIKIWEB% and %MAINWEB% instead of TWiki and Main. </p>
295 <td>[[Main/WebStatistics]]<p>[[Sandbox/WebNotify]]</p>
296 <p>[[Sandbox/WebHome]]</p>
300 <td><strong>Anchors:</strong> %BR% You can define a reference inside a TWiki topic (called an anchor name) and link to that. To <strong><em>define</em></strong> an anchor write <code>#AnchorName</code> at the beginning of a line. The anchor name must be a [[Main/WikiWord]]. To <strong><em>link to</em></strong> an anchor name use the <code>[[MyTopic#MyAnchor]]</code> syntax. You can omit the topic name if you want to link within the same topic. </td>
302 [[WikiWord#NotThere]]
308 <td>[[Main/WikiWord#NotThere]]<p>[[Main/WebHome#MyAnchor]]</p>
309 <p><a name="MyAnchor"></a> To here </p>
313 <td><a name="HeRe"></a> <strong>Forced Links:</strong> %BR% You can create a forced internal link by enclosing words in double square brackets. %BR% Text within the brackets may contain optional spaces; the topic name is formed by capitalizing the initial letter and by removing the spaces; for example, <code>[[text formatting FAQ]]</code> links to topic [[Main/TextFormattingFAQ]]. You can also refer to a different web and use anchors. %BR% %T% To "escape" double square brackets that would otherwise make a link, prefix the leading left square bracket with an exclamation point. </td>
322 <td>[[Main/WikiSyntax]]<p>[[Main/TWikiUsers]]</p>
323 <p> escaped: [[wiki syntax]] </p>
327 <td><strong>Specific Links:</strong> %BR% You can create a link where you specify the link text and the URL separately using nested square brackets <code>[[reference][text]]</code>. Internal link references (e.g. [[Main/WikiSyntax]]) and URLs (e.g. <a href="http://TWiki.org/" target="_top">http://TWiki.org/</a>) are both supported. The rules described under <strong><em>Forced Links</em></strong> apply for internal link references. %BR% %T% Anchor names can be added as well, to create a link to a specific place in a topic. </td>
329 [[WikiSyntax][wiki syntax]]
331 [[http://gnu.org][GNU]]
333 <td>[[Main/WikiSyntax]]<p><a href="http://gnu.org" target="_top">GNU</a></p>
337 <td><strong>Prevent a Link:</strong> %BR% Prevent a [[Main/WikiWord]] from being linked by prepending it with an exclamation point. </td>
344 <td><strong>Disable Links:</strong> %BR% You can disable automatic linking of [[Main/WikiWords]] by surrounding text with <code><noautolink></code> and <code></noautolink></code> tags.%BR% %H% It is possible to turn off all auto-linking with a NOAUTOLINK preferences setting. </td>
351 <td> RedHat & SuSE </td>
354 <td><strong>Mailto Links:</strong> %BR% E-mail addresses are linked automatically. To create e-mail links that have more descriptive link text, specify subject lines or message bodies, or omit the e-mail address, you can write <code>[[mailto:user@domain][descriptive text]]</code>. </td>
364 <td><a href="mailto:a@b.com">a@b.com</a><p><a href="mailto:a@b.com">Mail</a></p>
365 <p><a href="mailto:?subject=Hi">Hi</a></p>