TWiki Web>TWikiEditingShorthand (2010-06-12, TWikiContributor)

TWiki Editing Shorthand

Formatting Command: You write: You get:

Paragraphs: Blank lines will create new paragraphs.

1st paragraph

2nd paragraph

1st paragraph

2nd paragraph

Headings: 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.

You can create a table of contents with the %TOC% variable. If you want to exclude a heading from the TOC, put !! after the ---+.

Empty headings are allowed, but won't appear in the table of contents.

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

Sushi

Maguro

Not in TOC

Bold Text: Words get shown in bold by enclosing them in * asterisks.

*Bold*

Bold

Italic Text: Words get shown in italic by enclosing them in _ underscores.

_Italic_

Italic

Bold Italic: Words get shown in bold italic by enclosing them in __ double-underscores.

__Bold italic__

Bold italic

Fixed Font: Words get shown in fixed font by enclosing them in = equal signs.

=Fixed font=

Fixed font

Bold Fixed Font: Words get shown in bold fixed font by enclosing them in double equal signs.

==Bold fixed==

Bold fixed

You can follow the closing bold, italic, or other (* _ __ = ==) indicator with normal punctuation, such as commas and full stops.

Make sure there is no space between the text and the indicators.

_This works_,
_this does not _

This works, _this does not _

Verbatim (Literal) Text: Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags.

verbatim tags disable HTML code. Use <pre> and </pre> tags instead if you want the HTML code within the tags to be interpreted. NOTE: Preferences variables (* Set NAME = value) are set within verbatim tags.

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

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

Separator (Horizontal Rule): Three or more three dashes at the beginning of a line..

-------

Bulleted List: Multiple of three spaces, an asterisk, and another space.

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

Numbered List: Multiple of three spaces, a type character, a dot, and another space. Several types are available besides a number:

Type	Generated Style	Sample Sequence
1.	Arabic numerals	1, 2, 3, 4...
A.	Uppercase letters	A, B, C, D...
a.	Lowercase letters	a, b, c, d...
I.	Uppercase Roman Numerals	I, II, III, IV...
i.	Lowercase Roman Numerals	i, ii, iii, iv...

   1. Sushi
   1. Dim Sum
   1. Fondue

   A. Sushi
   A. Dim Sum
   A. Fondue

   i. Sushi
   i. Dim Sum
   i. Fondue

Sushi
Dim Sum
Fondue

Sushi
Dim Sum
Fondue

Sushi
Dim Sum
Fondue

Definition List: Three spaces, a dollar sign, the term, a colon, a space, followed by the definition.

Deprecated syntax: Three spaces, the term with no spaces, a colon, a space, followed by the definition.

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

Sushi: Japan
Dim Sum: S.F.

Table: 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.

| *bold* | header cell with text in asterisks
| center-aligned | cell with at least two, and equal number of spaces on either side
| right-aligned | cell with more spaces on the left
| 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
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.

The TablePlugin provides the |^| multiple-span row functionality 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 |  B9  |  C9 |

L	C	R
A2	B2	C2
A3	B3	C3
multi span
A5-7	5	5
	six	six
	seven	seven
split	over	3 lines
A9	B9	C9

WikiWord Links: CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically if preceded by whitespace or parenthesis.

If you want to link to a topic in a different web write Otherweb.TopicName. To link to a topic in a subweb write Otherweb.Subweb.TopicName.

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.

Dots '.' are used to separate webs and subwebs from topic names and therefore cannot be used in topic names.

It's generally a good idea to use the TWikiVariables %SYSTEMWEB% and %USERSWEB% instead of TWiki and Main.

WebStatistics

Sandbox.WebNotify

Sandbox.WebHome

Sandbox.Subweb.TopicName

Anchors: 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 [[MyTopic#MyAnchor]] syntax. You can omit the topic name if you want to link within the same topic.

[[WikiWord#NotThere]]

[[#MyAnchor][Jump]]

#MyAnchor To here

WikiWord#NotThere

Jump

To here

Forced Links: You can create a forced internal link by enclosing words in double square brackets.

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, [[text formatting FAQ]] links to topic TextFormattingFAQ. You can also refer to a different web and use anchors.

To "escape" double square brackets that would otherwise make a link, prefix the leading left square bracket with an exclamation point.

[[wiki syntax]]

[[Main.TWiki groups]]

escaped:
![[wiki syntax]]

wiki syntax

Main.TWiki groups

escaped: [[wiki syntax]]

Specific Links: You can create a link where you specify the link text and the URL separately using nested square brackets [[reference][text]]. Internal link references (e.g. WikiSyntax) and URLs (e.g. http://TWiki.org/) are both supported. The rules described under Forced Links apply for internal link references.

Anchor names can be added as well, to create a link to a specific place in a topic.

[[WikiSyntax][wiki syntax]]

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

wiki syntax

GNU

Prevent a Link: Prevent a WikiWord from being linked by prepending it with an exclamation point.

!SunOS

SunOS

Disable Links: You can disable automatic linking of WikiWords by surrounding text with <noautolink> and </noautolink> tags.

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

 <noautolink>
 RedHat & SuSE
 </noautolink>

RedHat & SuSE

Mailto Links: 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 [[mailto:user@domain][descriptive text]].

a@b.com

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

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

a@b.com

Mail

Literal content: TWiki generates HTML code from TWiki shorthand. Experts surround anything that must be output literally in the HTML code, without the application of TWiki shorthand rules, with <literal>..</literal> tags.

any HTML within literal tags must be well formed i.e. all tags must be properly closed before the end of the literal block.

TWiki Variables are expanded within literal blocks.

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

| Not | A | Table |

Protected content: Experts protect text from mangling by WYSIWYG editors using <sticky>..</sticky> tags. Sticky tags don't have any effect on normal topic display; they are only relevant when content has to be protected from a WYSIWYG editor (usually because it isn't well-formed HTML, or because it is HTML that WYSIWYG would normally filter out or modify). Protected content appears as plain text in the WYSIWYG editor.

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

This div is required

Topic revision: r1 - 2010-06-12 - TWikiContributor

TWiki

Copyright &© 1999-2024 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.TWikiEditingShorthand.