Difference: TWikiEditingShorthand (r7 vs. r6)

TWiki Editing Shorthand

These instructions are for contributors who prefer to use the Raw Edit over the default WYSIWYG editor.

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.

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

ALERT! 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

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

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


ALERT! Make sure there is no space between the text and the indicators.
ALERT! All words enclosed by the indicators need to be on the same line.
_This works_, _this does not _ _this fails too_ 

This works ,
_this does not _
_this fails too_

Verbatim (Literal) Text:
Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags.
TIP verbatim Separator (Horizontal Rule): tags disable HTML code. Use <pre> and </pre> tags instead if you want the HTML code within the tags to be interpreted.
ALERT! NOTE: Three or more three dashes at the beginning of a line.. Preferences variables (* Set NAME = value) are set within verbatim tags.
 ------- class CatAnimal { void purr() {  } }  
class CatAnimal {
  void purr() {
    <code here>
  }
}

Separator (Horizontal Rule): Bulleted List:
Three Multiple or more three dashes at the beginning of a line.. three spaces, an asterisk, and another space.
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
Bulleted List: Numbered List:
Multiple of three spaces, an asterisk, a type character, a dot, and another space. Several types are available besides a number:
TypeGenerated StyleSample 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...
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 1. Sushi 1. Dim Sum 1. Fondue A. Sushi A. Dim Sum A. Fondue i. Sushi i. Dim Sum i. Fondue 
  • level 1
    • level 2
  • back on 1
  • A bullet broken over three lines
  • last bullet
  1. Sushi
  2. Dim Sum
  3. Fondue
  1. Sushi
  2. Dim Sum
  3. Fondue
  1. Sushi
  2. Dim Sum
  3. Fondue
Numbered List: Definition List:
Multiple Three of three spaces, a type character, dollar sign, the term, a dot, colon, and another space. Several types are available besides a number: space, followed by the definition.
TypeGenerated StyleSample 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...

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

1. Sushi 1. $ Sushi: Japan $ Dim Sum 1. Sum: S.F. Fondue A. Sushi A. Dim Sum A. Fondue i. Sushi i. Dim Sum i. Fondue 
  1. Sushi
  2. Dim Sum
  3. Fondue
Sushi
Japan
Dim Sum
S.F.
  1. Sushi
  2. Dim Sum
  3. Fondue
  1. Sushi
  2. Dim Sum
  3. Fondue
Definition List: Table:
Three spaces, a Each row of dollar sign, the term, table is a colon, line containing of one or more cells. Each cell starts and ends with a space, followed by vertical bar '|'. Any spaces at the definition. beginning of a line are ignored.

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

  • | *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 &#124; to add | characters in tables.
  • Use %CARET% or &#94; to add ^ characters in tables.
TIP The TablePlugin provides the |^| multiple-span row functionality and additional rendering features
$ Sushi: Japan $ Dim Sum: S.F. | *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 | 
Sushi
Japan
Dim Sum
S.F.
LCR
A2 B2 C2
A3 B3 C3
multi span
A5-7 5 5
six six
seven seven
split over 3 lines
A9 B9 C9
Table: WikiWord Links:
Each row CapitalizedWordsStuckTogether (or 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 &#124; to add | characters in tables.
  • Use %CARET% or &#94; to add ^ characters in tables.
WikiWords ) will produce a link automatically if preceded by whitespace or parenthesis.
TIP The If you want to link to a topic in a different web write TablePlugin Otherweb.TopicName provides . the |^|
multiple-span row functionality and additional rendering features To link to a topic in a subweb write Otherweb.Subweb.TopicName .
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.
ALERT! 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.

| *L* | *C* WebStatistics Sandbox.WebNotify Sandbox.WebHome Sandbox.Subweb.TopicName | *R* | | A2 | B2 | C2 | | A3 | B3 | C3 | | multi span ||| | A5-7 | 5 | 5 | |^| six | six | |^| seven | seven | | split\ | over\ | 3 lines | | A9 | B9 | C9 | 
LCR
A2 B2 C2
A3 B3 C3
multi span
A5-7 5 5
six six
seven seven
split over 3 lines
A9 B9 C9

WebStatistics

WebNotify

Sandbox

TopicName

WikiWord Links: Anchors:
CapitalizedWordsStuckTogether (or You can define a reference inside a TWiki topic (called an anchor name) and link to that. To WikiWords define ) will produce an anchor write a link automatically if preceded by whitespace or parenthesis.
#AnchorName TIP at the beginning of a line. The anchor name must be a If you want to link to a topic in a different web write WikiWord Otherweb.TopicName of no more than 32 characters. To . link
to an anchor name use the To link to a topic in a subweb write [[MyTopic#MyAnchor]] Otherweb.Subweb.TopicName syntax. You can omit the topic name if you want to link within the same topic. .
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.
ALERT! 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 [[WikiWord#NotThere]] [[#MyAnchor][Jump]] #MyAnchor To here 

WebStatistics WikiWord#NotThere

WebNotify Jump

Sandbox To here

TopicName

Anchors: Forced Links:
You can define a Use double square brackets reference inside a TWiki topic (called an anchor name) and link to that. To create forced links: Write define [[link]] an or anchor write #AnchorName [[link][label]] at the to force beginning of a line. The anchor name must be a link. Use the former for singleton words and if WikiWord automatic linking is disabled of no more . Use the latter one to specify a link label other than 32 characters. To the link. For the link, you can use internal link references (e.g. link to WikiWords an anchor name use ) and URLs (e.g. the [[MyTopic#MyAnchor]] http://TWiki.org/ syntax. ). You can omit the topic name if you want to link within the same topic.
TIP Anchor names can be added to create a link to a specific place in a document.
TIP To "escape" double square brackets that would otherwise make a link, prefix the leading left square bracket with an exclamation point.
[[WikiWord#NotThere]] [[#MyAnchor][Jump]] #MyAnchor To here [[WikiWord]] [[WikiWord#TheSyntax]] [[WikiSyntax][wiki syntax]] [[http://gnu.org/][GNU]] [[Singleton]] escaped: ![[WikiSyntax]] 

WikiWord#NotThere WikiWord

Jump WikiWord#TheSyntax

wiki syntax To here

GNU

Singleton

escaped: [[WikiSyntax]]

Forced Links: Prevent a Link:
You Prevent can create a forced internal link by enclosing words in double square brackets.
WikiWord Text within the from being linked brackets may contain optional spaces; the topic name is formed by capitalizing the initial letter and by prepending it with an exclamation point. removing the spaces; for example, [[text formatting FAQ]] links to topic TextFormattingFAQ . You can also refer to a different web and use anchors.
TIP To "escape" double square brackets that would otherwise make a link, prefix the leading left square bracket with an exclamation point.
[[wiki !SunOS syntax]] [[Main.TWiki groups]] escaped: ![[wiki syntax]] 

wiki syntax

SunOS

Main.TWiki groups

escaped: [[wiki syntax]]

Specific Links: Disable Links:
You can create a link where disable automatic linking of you specify the link text and the URL separately using nested square brackets [[reference][text]] WikiWords . Internal link references by surrounding text with (e.g. WikiSyntax <noautolink> ) and URLs (e.g. http://TWiki.org/ </noautolink> ) tags. are both supported. The rules described under Forced Links apply for internal link references.
TIP HELP Anchor names can It is possible be added as well, to create turn off all auto-linking with a link to a NOAUTOLINK preferences setting. specific place in a topic.
[[WikiSyntax][wiki syntax]] [[http://gnu.org][GNU]]  RedHat & SuSE  

wiki syntax RedHat & SuSE

GNU

Prevent a Link: Mailto Links:
Prevent a 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 WikiWord [[mailto:user@domain][descriptive text]] from . being linked by prepending it with an exclamation point.
!SunOS a@b.com [[mailto:a@b.com]\ [Mail]] [[mailto:?subject=\ Hi][Hi]] 
SunOS

a@b.com

Mail

Hi

Disable Links: Verbatim Text:
You can disable automatic linking of Surround code excerpts and other formatted text with WikiWords <verbatim> by surrounding text with <noautolink> and tags.
HELP TIP It is possible to turn off all auto-linking with a NOAUTOLINK preferences setting. verbatim tags disable HTML code. Use <pre> and </pre> tags instead if you want the HTML code within the tags to be interpreted.
ALERT! NOTE: Preferences variables (* Set NAME = value) are set within verbatim tags.
 RedHat & SuSE   class CatAnimal { void purr() {  } }  

RedHat & SuSE

class CatAnimal {
  void purr() {
    <code here>
  }
}
Mailto Links: Literal Text:
E-mail addresses are linked automatically. To create TWiki generates HTML code from TWiki shorthand. 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]] Experts . surround anything that must be output literally in the HTML code, without the application of TWiki shorthand rules, with <literal>..</literal> tags. ALERT! any HTML within literal tags must be well formed i.e. all tags must be properly closed before the end of the literal block. IDEA! TWiki Variables are expanded within literal blocks.
a@b.com [[mailto:a@b.com]\ [Mail]] [[mailto:?subject=\ Hi][Hi]]  | Not | A | Table |  

a@b.com

| Not | A | Table |

Mail

Hi

Literal content: Protected Text:
TWiki generates HTML code from TWiki shorthand. Experts surround anything that must be output literally in protect text from mangling by WYSIWYG editors using the HTML code, without the application of TWiki shorthand rules, with .. .. 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. ALERT! any HTML within literal tags must be well formed i.e. all tags must be properly closed before the end of the literal block. IDEA! TWiki Variables are expanded within literal blocks.
 | Not | A | Table |  
This div is required
| Not | A | Table |
This div is required
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

Related topics: WikiSyntax, WikiWord, WikiNotation, TextFormattingRules, TWikiRenderingShortcut, TWikiShorthand

View topic | View difference side by side | History: r8 < r7 < r6 < r5 | More topic actions
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 1999-2020 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.