data/TWiki/TWikiEditingShorthand.txt,v
author Colas Nahaboo <colas@nahaboo.net>
Sat, 26 Jan 2008 15:50:53 +0100
changeset 0 414e01d06fd5
permissions -rw-r--r--
RELEASE 4.2.0 freetown
     1 head	1.3;
     2 access;
     3 symbols;
     4 locks; strict;
     5 comment	@# @;
     6 
     7 
     8 1.3
     9 date	2008.01.22.03.21.30;	author TWikiContributor;	state Exp;
    10 branches;
    11 next	1.2;
    12 
    13 1.2
    14 date	2007.01.16.04.11.58;	author TWikiContributor;	state Exp;
    15 branches;
    16 next	1.1;
    17 
    18 1.1
    19 date	2006.06.25.16.26.26;	author TWikiContributor;	state Exp;
    20 branches;
    21 next	;
    22 
    23 
    24 desc
    25 @buildrelease
    26 @
    27 
    28 
    29 1.3
    30 log
    31 @buildrelease
    32 @
    33 text
    34 @%META:TOPICINFO{author="TWikiContributor" date="1176595977" format="1.1" version="3"}%
    35 ---++ TWiki Editing Shorthand
    36 
    37 %STARTINCLUDE%
    38 
    39 %TABLE{}%
    40 <table class="twikiTable" border="1" cellpadding="3" bgcolor="#ffffff">
    41 <tr bgcolor="#ffffff">
    42 <th width="50%" class="twikiFirstCol">
    43  Formatting Command:
    44 </th>
    45 <th width="25%">
    46  You write:
    47 </th>
    48 <th width="25%">
    49  You get:
    50 </th>
    51 </tr>
    52 <tr valign="top">
    53 <td>
    54  *Paragraphs:* %BR%
    55  Blank lines will create new paragraphs.
    56 </td><td>
    57 <verbatim>
    58 1st paragraph
    59 
    60 2nd paragraph
    61 </verbatim>
    62 </td><td>
    63 
    64 1st paragraph
    65 
    66 2nd paragraph
    67 </td>
    68 </tr>
    69 <tr valign="top">
    70 <td>
    71  *Headings:* %BR%
    72 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.
    73 
    74 You can create a table of contents with the [[VarTOC][%<nop>TOC%]] variable. If you want to *exclude* a heading from the TOC, put =!!= after the =---+=.
    75 
    76 %X% Empty headings are allowed, but won't appear in the table of contents.
    77 </td><td>
    78 <verbatim>
    79 ---++ Sushi
    80 ---+++ Maguro
    81 ---+++!! Not in TOC
    82 </verbatim>
    83 </td><td>
    84 
    85 <nop><h2>Sushi</h2>
    86 <nop><h3>Maguro</h3>
    87 <nop><h3>Not in TOC</h3>
    88 </td>
    89 </tr>
    90 <tr valign="top">
    91 <td>
    92  *Bold Text:* %BR%
    93  Words get shown in *bold* by enclosing them in =*= asterisks.
    94 </td><td>
    95 <verbatim>
    96 *Bold*
    97 </verbatim>
    98 </td><td>
    99 
   100 *Bold*
   101 </td>
   102 </tr>
   103 <tr valign="top">
   104 <td>
   105  *Italic Text:* %BR%
   106  Words get shown in _italic_ by enclosing them in =_= underscores.
   107 </td><td>
   108 <verbatim>
   109 _Italic_
   110 </verbatim>
   111 </td><td>
   112 
   113 _Italic_
   114 </td>
   115 </tr>
   116 <tr valign="top">
   117 <td>
   118  *Bold Italic:* %BR%
   119  Words get shown in __bold italic__ by enclosing them in =__= double-underscores.
   120 </td><td>
   121 <verbatim>
   122 __Bold italic__
   123 </verbatim>
   124 </td><td>
   125 
   126 __Bold italic__
   127 </td>
   128 </tr>
   129 <tr valign="top">
   130 <td>
   131  *Fixed Font:* %BR%
   132  Words get shown in =fixed font= by enclosing them in =<nop>=<nop>= equal signs.
   133 </td><td>
   134 <verbatim>
   135 =Fixed font=
   136 </verbatim>
   137 </td><td>
   138 
   139 =Fixed font=
   140 
   141 </td>
   142 </tr>
   143 <tr valign="top">
   144 <td>
   145  *Bold Fixed Font:* %BR%
   146  Words get shown in ==bold fixed font== by enclosing them in ==<nop>== double equal signs.
   147 </td><td>
   148 <verbatim>
   149 ==Bold fixed==
   150 </verbatim>
   151 </td><td>
   152 
   153 ==Bold fixed==
   154 </td>
   155 </tr>
   156 <tr valign="top">
   157 <td>
   158 %T% You can follow the closing bold, italic, or other (=* _ __ = ===) indicator
   159 with normal punctuation, such as commas and full stops.
   160 
   161 %X% Make sure there is no space between the text and the indicators.
   162 </td><td>
   163 <verbatim>
   164 _This works_,
   165 _this does not _
   166 </verbatim>
   167 </td><td>
   168 
   169 _This works_,%BR%
   170 _this does not _
   171 </td>
   172 </tr>
   173 <tr valign="top">
   174 <td>
   175  *Verbatim Text:* %BR%
   176  Surround code excerpts and other formatted text with =&lt;verbatim&gt;= and =&lt;/verbatim&gt;= tags.%BR%
   177 %T% =verbatim= tags disable HTML code. Use =&lt;pre&gt;= and =&lt;/pre&gt;= tags instead if you want the HTML code within the tags to be interpreted.%BR%
   178 __%X% NOTE:__ Preferences variables (* Set NAME = value) are set within verbatim tags.
   179 </td><td>
   180 <verbatim>
   181 <verbatim>
   182 class CatAnimal {
   183   void purr() {
   184     <code here>
   185   }
   186 }
   187 </verbatim>
   188 </verbatim>
   189 </td><td>
   190 <verbatim>
   191 class CatAnimal {
   192   void purr() {
   193     <code here>
   194   }
   195 }
   196 </verbatim>
   197 </td>
   198 </tr>
   199 <tr valign="top">
   200 <td>
   201  *Separator (Horizontal Rule):* %BR%
   202 Three or more three dashes at the beginning of a line..
   203 </td><td>
   204 <verbatim>
   205 -------
   206 </verbatim>
   207 </td><td>
   208 
   209 -------
   210 </td>
   211 </tr>
   212 <tr valign="top">
   213 <td>
   214  *Bulleted List:* %BR%
   215 Multiple of three spaces, an asterisk, and another space.%BR%
   216 %H% For all the list types, you can break a list item over several lines by indenting lines after the first one by *at least 3 spaces*.
   217 </td><td>
   218 <verbatim>
   219    * level 1
   220       * level 2
   221    * back on 1
   222    * A bullet
   223      broken over
   224      three lines
   225    * last bullet
   226 </verbatim>
   227 </td><td>
   228 
   229    * level 1
   230       * level 2
   231    * back on 1
   232    * A bullet
   233      broken over
   234      three lines
   235    * last bullet
   236 </td>
   237 </tr>
   238 <tr valign="top">
   239 <td>
   240 *Numbered List:* %BR%
   241 Multiple of three spaces, a type character, a dot, and another space. Several types are available besides a number:
   242 | *Type* | *Generated Style* | *Sample Sequence* |
   243 | 1. | Arabic numerals | 1, 2, 3, 4... |
   244 | A. | Uppercase letters | A, B, C, D... |
   245 | a. | Lowercase letters | a, b, c, d... |
   246 | I. | Uppercase Roman Numerals | I, II, III, IV... |
   247 | i. | Lowercase Roman Numerals | i, ii, iii, iv... |
   248 </td><td>
   249 <verbatim>
   250    1. Sushi
   251    1. Dim Sum
   252    1. Fondue
   253 
   254    A. Sushi
   255    A. Dim Sum
   256    A. Fondue
   257 
   258    i. Sushi
   259    i. Dim Sum
   260    i. Fondue
   261 </verbatim>
   262 </td><td>
   263 
   264    1. Sushi
   265    1. Dim Sum
   266    1. Fondue
   267 
   268    A. Sushi
   269    A. Dim Sum
   270    A. Fondue
   271 
   272    i. Sushi
   273    i. Dim Sum
   274    i. Fondue
   275 </td>
   276 </tr>
   277 <tr valign="top">
   278 <td>
   279  *Definition List:* %BR%
   280  Three spaces, a dollar sign, the term, a colon, a space, followed by the definition.
   281 
   282  Deprecated syntax: Three spaces, the term with no spaces, a colon, a space, followed by the definition.
   283 </td><td>
   284 <verbatim>
   285    $ Sushi: Japan
   286    $ Dim Sum: S.F.
   287 </verbatim>
   288 </td><td>
   289 
   290    $ Sushi: Japan
   291    $ Dim Sum: S.F.
   292 </td>
   293 </tr>
   294 <tr valign="top">
   295 <td>
   296  *Table:* %BR%
   297 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.
   298    * =| <nop>*bold*<nop> |= header cell with text in asterisks
   299    * =|   center-aligned   |= cell with at least two, and equal number of spaces on either side
   300    * =|      right-aligned |= cell with more spaces on the left
   301    * =| 2 colspan ||= and multi-span columns with multiple <tt>|</tt>'s right next to each other
   302    * =|^|= cell with caret indicating follow-up row of multi-span rows
   303    * You can split rows over multiple lines by putting a backslash ='\'= at the end of each line
   304    * Contents of table cells wrap automatically as determined by the browser
   305    * Use =%<nop>VBAR%= or =&amp;#124;= to add =&#124;= characters in tables.
   306    * Use =%<nop>CARET%= or =&amp;#94;= to add =&#94;= characters in tables.
   307 %T% The %SYSTEMWEB%.TablePlugin provides the =|^|= multiple-span row functionality and additional rendering features
   308 </td><td>
   309 <verbatim>
   310 | *L* | *C* | *R* |
   311 | A2 |  B2  |  C2 |
   312 | A3 |  B3  |  C3 |
   313 | multi span |||
   314 | A5-7 |  5  |  5 |
   315 |^| six | six |
   316 |^| seven | seven |
   317 | split\
   318   | over\
   319   | 3 lines |
   320 | A9 |  B9  |  C9 |
   321 </verbatim>
   322 </td><td>
   323 
   324 | *L* | *C* | *R* |
   325 | A2 |  B2  |  C2 |
   326 | A3 |  B3  |  C3 |
   327 | multi span |||
   328 | A5-7 |  5  |  5 |
   329 |^| six | six |
   330 |^| seven | seven |
   331 | split\
   332   | over\
   333   | 3 lines |
   334 | A9 |  B9  |  C9 |
   335 </td>
   336 </tr>
   337 <tr valign="top">
   338 <td>
   339  *<nop>WikiWord Links:* %BR%
   340  <nop>CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically if preceded by whitespace or parenthesis. %BR%
   341 %T% If you want to link to a topic in a different web write =Otherweb.TopicName=. %BR%
   342 To link to a topic in a subweb write =Otherweb.Subweb.TopicName=.%BR%
   343 %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 <nop>%HOMETOPIC% topic. %BR%
   344 %X% Dots ='.'= are used to separate webs and subwebs from topic names and therefore cannot be used in topic names.
   345 
   346 It's generally a good idea to use the TWikiVariables %<nop>SYSTEMWEB% and %<nop>USERSWEB% instead of TWiki and Main.
   347 </td><td>
   348 <verbatim>
   349 WebStatistics
   350 
   351 Sandbox.WebNotify
   352 
   353 Sandbox.WebHome
   354 
   355 Sandbox.Subweb.TopicName
   356 </verbatim>
   357 </td><td>
   358 
   359 WebStatistics
   360 
   361 Sandbox.WebNotify
   362 
   363 Sandbox.%HOMETOPIC%
   364 
   365 <a href="#MyAnchor" title="simulated link">TopicName</a>
   366 </td>
   367 </tr>
   368 <tr valign="top">
   369 <td>
   370  *Anchors:* %BR%
   371  You can define a reference inside a TWiki topic (called an anchor name) and link to that. To __define__ an anchor write =#AnchorName= at the beginning of a line. The anchor name must be a WikiWord of no more than 32 characters. To __link to__ an anchor name use the =[<nop>[MyTopic#MyAnchor]]= syntax. You can omit the topic name if you want to link within the same topic.
   372 </td><td>
   373 <verbatim>
   374 [[WikiWord#NotThere]]
   375 
   376 [[#MyAnchor][Jump]]
   377 
   378 #MyAnchor To here
   379 </verbatim>
   380 </td><td>
   381 
   382 [[WikiWord#NotThere]]
   383 
   384 [[#MyAnchor][Jump]]
   385 
   386 #MyAnchor To here
   387 </td>
   388 </tr>
   389 <tr valign="top">
   390 <td>
   391 #HeRe
   392  *Forced Links:* %BR%
   393  You can create a forced internal link by enclosing words in double square brackets.
   394 %BR% 
   395 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, =[<nop>[text formatting FAQ]]= links to topic TextFormattingFAQ.  You can also refer to a different web and use anchors.
   396 %BR%
   397 %T% To "escape" double square brackets that would otherwise make a link, prefix the leading left square bracket with an exclamation point.
   398 </td><td>
   399 <verbatim>
   400 [[wiki syntax]]
   401 
   402 [[Main.TWiki groups]]
   403 
   404 escaped:
   405 ![[wiki syntax]]
   406 </verbatim>
   407 </td><td>
   408 
   409 [[wiki syntax]]
   410 
   411 [[%USERSWEB%.TWiki groups]]
   412 
   413 escaped:
   414 ![[wiki syntax]]
   415 </td>
   416 </tr>
   417 <tr valign="top">
   418 <td>
   419  *Specific Links:* %BR%
   420  You can create a link where you specify the link text and the URL separately using nested square brackets =[<nop>[reference][text]]=. Internal link references (e.g. WikiSyntax) and URLs (e.g. http://TWiki.org/) are both supported.
   421 The rules described under __Forced Links__ apply for internal link references.
   422  %BR% %T% Anchor names can be added as well, to create a link to a specific place in a topic.
   423 </td><td>
   424 <verbatim>
   425 [[WikiSyntax][wiki syntax]]
   426 
   427 [[http://gnu.org][GNU]]
   428 </verbatim>
   429 </td><td>
   430 
   431 [[WikiSyntax][wiki syntax]]
   432 
   433 [[http://gnu.org][GNU]]
   434 </td>
   435 </tr>
   436 <tr valign="top">
   437 <td>
   438  *Prevent a Link:* %BR%
   439  Prevent a WikiWord from being linked by prepending it with an exclamation point.
   440 </td><td>
   441 <verbatim>
   442 !SunOS
   443 </verbatim>
   444 </td><td>
   445 !SunOS
   446 </td>
   447 </tr>
   448 <tr valign="top">
   449 <td>
   450  *Disable Links:* %BR%
   451  You can disable automatic linking of WikiWords by surrounding text with =&lt;noautolink&gt;= and =&lt;/noautolink&gt;= tags.%BR%
   452 %H% It is possible to turn off all auto-linking with a NOAUTOLINK preferences setting.
   453 </td><td>
   454 <verbatim>
   455  <noautolink>
   456  RedHat & SuSE
   457  </noautolink>
   458 </verbatim>
   459 </td><td>
   460 
   461  <noautolink>
   462  RedHat & SuSE
   463  </noautolink>
   464 </td>
   465 </tr>
   466 <tr valign="top">
   467 <td>
   468 *Mailto Links:* %BR%
   469 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 =[<nop>[mailto:user@@domain][descriptive text]]=.
   470 </td><td>
   471 <verbatim>
   472 a@@b.com
   473 
   474 [[mailto:a@@b.com]\
   475 [Mail]]
   476 
   477 [[mailto:?subject=\
   478 Hi][Hi]]
   479 </verbatim>
   480 </td><td>
   481 
   482 a@@b.com
   483 
   484 [[mailto:a@@b.com]\
   485 [Mail]]
   486 
   487 [[mailto:?subject=Hi][Hi]]
   488 </td>
   489 </tr>
   490 <tr>
   491 <td>
   492  *Literal content:* %BR%
   493  TWiki generates HTML code from TWiki shorthand.
   494  *Experts* surround anything that must be output literally in the HTML code, without the application of
   495  TWiki shorthand rules, with =&lt;literal&gt;..&lt;/literal&gt;= tags. %X% any HTML
   496  within literal tags *must* be well formed i.e. all tags must be properly closed before
   497  the end of the literal block. %I% TWiki Variables are expanded within literal blocks.
   498 </td><td>
   499 <pre>
   500 &lt;literal&gt;
   501 | Not | A | Table |
   502 &lt;literal&gt;
   503 </pre>
   504 </td>
   505 <td>
   506 <literal>
   507 | Not | A | Table |
   508 </literal>
   509 </td>
   510 </tr>
   511 <tr>
   512 <td>
   513  *Protected content:* %BR%
   514  *Experts* protect text from mangling by WYSIWYG editors using
   515  =&lt;sticky&gt;..&lt;/sticky&gt;= tags. Sticky tags don't have any effect on normal
   516  topic display; they are only relevant when content has to be
   517  protected from a WYSIWYG editor (usually because it isn't well-formed HTML, or because it
   518  is HTML that WYSIWYG would normally filter out or modify). Protected
   519  content appears as plain text in the WYSIWYG editor.
   520 </td><td>
   521 =&lt;sticky&gt;=
   522 <verbatim>
   523 <div>
   524 This div is required
   525 </div>
   526 </verbatim>
   527 =&lt;sticky&gt;=
   528 </td>
   529 <td>
   530 <sticky>
   531 <div>
   532 This div is required
   533 </div>
   534 </sticky>
   535 </td>
   536 </tr>
   537 </table>
   538 
   539 %STOPINCLUDE%
   540 @
   541 
   542 
   543 1.2
   544 log
   545 @buildrelease
   546 @
   547 text
   548 @d1 1
   549 a1 1
   550 %META:TOPICINFO{author="TWikiContributor" date="1153796460" format="1.1" version="2"}%
   551 d9 1
   552 a9 1
   553 <th width="50%">
   554 d30 1
   555 d51 1
   556 d66 1
   557 d79 1
   558 d92 1
   559 d105 1
   560 d119 1
   561 d135 1
   562 d142 1
   563 a142 1
   564  *Verbatim (Literal) Text:* %BR%
   565 d175 1
   566 d195 1
   567 d230 1
   568 d248 2
   569 d256 1
   570 d272 3
   571 a274 2
   572    * Use =&amp;#124;= or =%<nop>VBAR%= to add =&#124;= characters in tables.
   573 %T% The %TWIKIWEB%.TablePlugin provides the =|^|= multiple-span row functionality and additional rendering features
   574 d290 1
   575 d309 3
   576 a311 1
   577 %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 <nop>%HOMETOPIC% topic.
   578 d313 1
   579 a313 1
   580 It's generally a good idea to use the TWikiVariables %<nop>TWIKIWEB% and %<nop>MAINWEB% instead of TWiki and Main.
   581 d321 2
   582 d325 1
   583 d331 2
   584 d338 1
   585 a338 1
   586  You can define a reference inside a TWiki topic (called an anchor name) and link to that. To __define__ an anchor write =#AnchorName= at the beginning of a line. The anchor name must be a WikiWord. To __link to__ an anchor name use the =[<nop>[MyTopic#MyAnchor]]= syntax. You can omit the topic name if you want to link within the same topic.
   587 d348 1
   588 d369 1
   589 a369 1
   590 [[Main.TWiki users]]
   591 d375 1
   592 d378 1
   593 a378 1
   594 [[%MAINWEB%.TWiki users]]
   595 d397 1
   596 d423 1
   597 a423 2
   598  RedHat &
   599  SuSE
   600 d427 1
   601 d429 1
   602 a429 2
   603  RedHat &
   604  SuSE
   605 d448 1
   606 d457 47
   607 @
   608 
   609 
   610 1.1
   611 log
   612 @buildrelease
   613 @
   614 text
   615 @d1 2
   616 a2 2
   617 %META:TOPICINFO{author="TWikiContributor" date="1141755719" format="1.1" version="1"}%
   618 ---++ TWiki Editing Shorthand'
   619 d258 1
   620 @