TWiki Editing Shorthand

1st paragraph

2nd paragraph

• icon:tip You can create a table of contents with the %TOC% variable.
• icon:tip If you want to exclude a heading from the TOC, put !! after the ---+.
• icon:warning Empty headings are allowed and won't appear in the table of contents.

---++ Sushi
---+++ Maguro
---+++!! Not in TOC

Sushi

Maguro

Not in TOC

*Bold*

_Italic_

__Bold italic__

=Fixed font=

==Bold fixed==

• icon:tip You can follow the closing bold, italic, or other (* _ __ = ==) indicator with normal punctuation, such as commas and full stops.
• icon:warning Make sure there is no space between the text and the indicators.
• icon:warning All words enclosed by the indicators need to be on the same line.

_This works_,
_this does not _
_this fails
too_

-------

• icon:help 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.

   * level 1
      * level 2
   * back on 1
   * A bullet
     broken over
     three lines
   * last bullet

• level 1
  • level 2
• back on 1
• A bullet broken over three lines
• last bullet

• icon:help Use the name of any TWikiDocGraphics icon.

   * icon:tip Icon list
      * icon:led-red Full
      * icon:led-green OK
   * icon:unchecked Item 1
   * icon:checked Item 2
   * icon:empty No bullet

• icon:tip Icon list
  • icon:led-red Full
  • icon:led-green OK
• icon:unchecked Item 1
• icon:checked Item 2
• icon:empty No bullet

   1. Sushi
   1. Dim Sum
   1. Fondue

   A. Sushi
   A. Dim Sum
   A. Fondue

   i. Sushi
   i. Dim Sum
   i. Fondue

1. Sushi
2. Dim Sum
3. Fondue

1. Sushi
2. Dim Sum
3. Fondue

1. Sushi
2. Dim Sum
3. Fondue

   $ Sushi: Japan
   $ Dim Sum: S.F.

Sushi

Japan

Dim Sum

S.F.

• | *bold* | header cell with text in asterisks
• |   center-aligned   | cell with two or more spaces on both sides. The number of spaces may be different between sides
• |      right-aligned | cell with two or more spaces on the left and one or zero space on the right
• | 2 colspan || and multi-span columns with multiple |'s right next to each other
• |^| cell with caret indicating follow-up row of multi-span rows
• |>> … <<| cell enclosed in double-square brackets can span multiple lines - useful for bullets and nested tables
• You can split rows over multiple lines by putting a backslash '\' at the end of each line
• Contents of table cells wrap automatically as determined by the browser
• Use %VBAR% or | to add | characters in tables.
• Use %CARET% or ^ to add ^ characters in tables.
• icon:tip The TablePlugin provides the |^| multiple-span row functionality, |>> … <<| multi-line syntax, and additional rendering features

| *L* | *C* | *R* |
| A2 |  B2  |  C2 |
| A3 |  B3  |  C3 |
| multi span |||
| A5-7 |  5  |  5 |
|^| six | six |
|^| seven | seven |
| split\
  | over\
  | 3 lines |
| A9 |>>
 | Nested |
 | table |
<<|  C9 |

• icon:tip If you want to link to a topic in a different web write Otherweb.TopicName.
• icon:tip To link to a topic in a subweb write Otherweb.Subweb.TopicName.
• icon:help 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.
• icon:warning Dots '.' are used to separate webs and subwebs from topic names and therefore cannot be used in topic names.
• icon:tip Links can be prevented with an ! exclamation point prefix.

WebStatistics

Sandbox.WebNotify

Sandbox.WebHome

Sandbox.Subweb.TopicName

!EscapedWikiWord

[[WikiWord#NotThere]]

[[#MyAnchor][Jump]]

#MyAnchor
To here

http://twiki.org

https://google.com

!http://escaped-link

• icon:tip URL parameters can follow a WikiWord
• icon:tip Anchor names can be added to create a link to a specific place in a document.
• icon:tip To "escape" double square brackets that would otherwise make a link, prefix the leading left square bracket with an exclamation point.
• icon:tip The topic title instead of the topic name is shown for [[WikiWord]] links if the SHOWTOPICTITLELINK preferences setting is enabled.

[[WikiWord]]

[[WikiWord?n1=v1;n2=v2]]

[[WikiWord#TheAnchor]]

[[WikiWord?n=5#TheAnchor]]

[[WikiSyntax][wiki syntax]]

[[http://gnu.org/][GNU]]

[[Singleton]]

escaped:
![[WikiSyntax]]

• icon:tip An alternative syntax is [[TopicName][$topictitle]] or [[Web.TopicName][$topictitle]].

[[+BugN1234]]

[[+Bugs.BugN1234]]

[[BugN1234][$topictitle]]

[[%SYSTEMWEB%.WikiWord\
#TheSyntax][$name]]

[[%PUBURL%/%WEB%/WabiSabi\
/wabisabi.gif][$name]]

!RedHat

• icon:help It is possible to turn off all auto-linking with a NOAUTOLINK preferences setting.

 <noautolink>
 RedHat & SuSE
 </noautolink>

a@b.com

[[mailto:a@b.com]\
[Mail]]

[[mailto:?subject=\
Hi][Hi]]

@twiki

!@escaped

• icon:tip The verbatim tag disables HTML code. Use <pre> and </pre> tags instead if you want the HTML code within the tags to be interpreted.
• icon:warning Preferences variables (* Set NAME = value) are set within verbatim tags.

<verbatim>
class CatAnimal {
  void purr() {
    <code here>
  }
}
</verbatim>

class CatAnimal {
  void purr() {
    <code here>
  }
}

• icon:warning Any HTML within literal tags must be well formed i.e. all tags must be properly closed before the end of the literal block.
• icon:tip TWiki Variables are expanded within literal blocks.

<literal>
| Not | A | Table |
<literal>

<sticky>
<div>
This div is required
</div>
</sticky>