Difference: TWikiEditingShorthand (1 vs. 10)

Revision 102015-09-16 - TWikiContributor

Line: 1 to 1

TWiki Editing Shorthand

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

Line: 34 to 34

2nd paragraph

Changed:

<
<

>
>

<-- TWikibugs:Item7687 -->

1st paragraph

2nd paragraph

Line: 56 to 57

Not in TOC

Changed:

<
<

>
>

Sushi

Maguro

Not in TOC

Line: 72 to 73

Bold

Changed:

<
<

>
>

Bold

Line: 86 to 87

Italic

Changed:

<
<

>
>

Italic

Line: 100 to 101

Bold italic

Changed:

<
<

>
>

Bold italic

Line: 114 to 115

Fixed font

Changed:

<
<

>
>

Fixed font

Line: 129 to 130

Bold fixed

Changed:

<
<

>
>

Bold fixed

Line: 147 to 148

too_

Changed:

<
<

>
>

This works,
_this does not _
_this fails

Line: 164 to 165

Changed:

<
<

>
>

Line: 185 to 186

last bullet

Changed:

<
<

>
>

level 1
- level 2
back on 1

Line: 211 to 212

No bullet

Changed:

<
<

>
>

Icon list
- Full
- OK

Line: 246 to 247

Fondue

Changed:

<
<

>
>

Sushi
Dim Sum
Fondue

Line: 273 to 274

Dim Sum: S.F.

Changed:

<
<

>
>

Sushi: Japan
Dim Sum: S.F.

Line: 288 to 289

| 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

Added:

>
>

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

Changed:

<
< The TablePlugin provides the |^| multiple-span row functionality and additional rendering features

>
> The TablePlugin provides the |^| multiple-span row functionality, |>> ... <<| multi-line syntax, and additional rendering features

| *L* | *C* | *R* |

Line: 305 to 307

split

over

3 lines

Changed:

<
<

>
>

Nested

table

Changed:

<
<

>
>

L	C	R
A2	B2	C2
A3	B3	C3

Line: 319 to 324

split

over

3 lines

Changed:

<
<

>
>

Nested

table

Line: 344 to 352

TopicName

Changed:

<
<

>
>

WebStatistics

WebNotify

Line: 369 to 377

To here

Changed:

<
<

>
>

WikiWord#NotThere

Jump

Line: 392 to 400

http://escaped-link

Changed:

<
<

>
>

http://twiki.org

https://google.com

Line: 414 to 422

[[WikiWord]]

Changed:

<
< WikiWord?name1=value1;name2=value2

>
> WikiWord?n1=v1;n2=v2

Changed:

<
< WikiWord#TheSyntax

>
> WikiWord#TheAnchor

Changed:

<
< WikiWord?foo=bar#TheSyntax

>
> WikiWord?n=5#TheAnchor

wiki syntax

Line: 430 to 438

[[WikiSyntax]]

Changed:

<
<

>
>

WikiWord

Changed:

<
< WikiWord#TheSyntax

>
>

WikiWord?n1=v1;n2=v2

WikiWord#TheAnchor

WikiWord?n=5#TheAnchor

wiki syntax

Line: 460 to 472

BugN1234

Changed:

<
<

>
>

The sky is falling

Line: 494 to 506

Changed:

<
<

>
>

RedHat & SuSE

Line: 516 to 528

Hi][Hi]]

Changed:

<
<

>
>

a@b.com

[[mailto:[email protected]]

Line: 535 to 547

@twiki

Changed:

<
<

>
>

@twiki

Revision 92014-06-05 - TWikiContributor

Line: 1 to 1

TWiki Editing Shorthand

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

Added:

>
>

Line: 400 to 406

Forced Links:
Use double square brackets to create forced links: Write [[link]] or [[link][label]] to force a link. Use the former for singleton words and if automatic linking is disabled. Use the latter one to specify a link label other than the link. For the link, you can use internal link references (e.g. WikiWords) and URLs (e.g. http://TWiki.org/).

Added:

>
> URL parameters can follow a WikiWord

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

Line: 407 to 414

[[WikiWord]]

Added:

>
> WikiWord?name1=value1;name2=value2

WikiWord#TheSyntax

Added:

>
> WikiWord?foo=bar#TheSyntax

wiki syntax

GNU

Revision 82013-03-19 - TWikiContributor

Line: 1 to 1

TWiki Editing Shorthand

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

Line: 166 to 166

Bulleted List:

Changed:

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

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

Line: 191 to 191

Added:

>
>

Icon List:
Multiple of three spaces, an asterisk, text icon:name and another space.

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 list
- Full
- OK
Item 1
Item 2
No bullet

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

Line: 295 to 320

WikiWord Links:

Changed:

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

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

Line: 349 to 374

Added:

>
>

External Links:
URLs starting with file, ftp, gopher, http, https, irc, mailto, news, nntp and telnet are linked automatically if preceded by whitespace or parenthesis. External links are indicated with a trailing

icon, and open up in a new browser tab or window; the behavior of both can be set in configure or preferences variables (see TWikiExternalLinks for details). Links can be prevented with an ! exclamation point prefix.

http://twiki.org

https://google.com

!http://escaped-link

http://twiki.org

https://google.com

http://escaped-link

Forced Links:

Changed:

<
< Use double square brackets to create forced links: Write [[link]] or [[link][label]] to force a link. Use the former for singleton words and if automatic linking is disabled. Use the latter one to specify a link label other than the link. For the link, you can use internal link references (e.g. WikiWords) and URLs (e.g. http://TWiki.org/).

Added:

>
> The topic title instead of the topic name is shown for [[WikiWord]] links if the SHOWTOPICTITLELINK preferences setting is enabled.

[[WikiWord]]

Line: 388 to 436

Added:

>
>

Topic Title Links:
Use double square brackets and a plus sign to create links with topic title: Write [[+TopicName]] or [[+Web.TopicName]] to show the topic title instead of the topic name. The topic title is defined by the form field named "Title", the topic preferences setting named TITLE, or the topic name if neither exists.

An alternative syntax is [[TopicName][$topictitle]] or [[Web.TopicName][$topictitle]].

[[+BugN1234]]

[[+Bugs.BugN1234]]

[[BugN1234][$topictitle]]

The sky is falling

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

Line: 403 to 474

Disable Links:

Changed:

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

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

Line: 445 to 516

Added:

>
>

Twitter Links:
@twitter IDs are linked automatically. The link rule is defined by the {Links}{TwitterUrlPattern} configure setting.

@twiki	@twiki

Verbatim Text:

Changed:

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

>
> Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags.
The verbatim tag disables HTML code. Use <pre> and </pre> tags instead if you want the HTML code within the tags to be interpreted.
Preferences variables (* Set NAME = value) are set within verbatim tags.

<verbatim></verbatim>
<nop>

Line: 476 to 561

Literal Text:
TWiki generates HTML code from TWiki shorthand. Experts surround anything that must be output literally in the HTML code, without the application of

Changed:

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

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

Revision 72011-06-05 - TWikiContributor

Line: 1 to 1

TWiki Editing Shorthand

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

Line: 18 to 18

Added:

>
>

Paragraphs:
Blank lines will create new paragraphs.

Line: 35 to 36

Added:

>
>

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.

Changed:

<
<

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.

>
> 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 and won't appear in the table of contents.

---++ Sushi

Line: 56 to 58

Added:

>
>

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

Line: 69 to 72

Added:

>
>

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

Line: 82 to 86

Added:

>
>

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

Line: 95 to 100

Added:

>
>

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

Line: 109 to 115

Added:

>
>

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

Line: 124 to 131

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

Changed:

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

>
> Make sure there is no space between the text and the indicators.
All words enclosed by the indicators need to be on the same line.

_This works_,
_this does not _

Added:

>
> _this fails too_

This works,

Changed:

<
<

_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>
  }
}

>
> _this does not _
_this fails too_

Added:

>
>

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

Line: 178 to 164

Added:

>
>

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.

Line: 204 to 191

Added:

>
>

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

Line: 243 to 231

Added:

>
>

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

Line: 260 to 249

Added:

>
>

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

Line: 303 to 293

Added:

>
>

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.

Line: 334 to 325

Added:

>
>

Anchors:

Changed:

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

>
> 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]]

Changed:

<
< To here

>
> To here

Line: 350 to 343

Jump

Changed:

<
< To here

>
> To here

Added:

>
>

Forced Links:

Changed:

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

>
> Use double square brackets to create forced links: Write [[link]] or [[link][label]] to force a link. Use the former for singleton words and if automatic linking is disabled. Use the latter one to specify a link label other than the link. For the link, you can use internal link references (e.g. WikiWords) and URLs (e.g. http://TWiki.org/).
Anchor names can be added to create a link to a specific place in a document.
To "escape" double square brackets that would otherwise make a link, prefix the leading left square bracket with an exclamation point.

Changed:

<
< wiki syntax

>
>

WikiWord

WikiWord#TheSyntax

wiki syntax

Changed:

<
< Main.TWiki groups

>
>

GNU

Singleton

escaped:

Changed:

<
< [[wiki syntax]]

>
> [[WikiSyntax]]

Changed:

<
< wiki syntax

>
> WikiWord

Changed:

<
< Main.TWiki groups

>
> WikiWord#TheSyntax

Deleted:

<
<

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.

wiki syntax

Changed:

<
<

GNU

>
> GNU

Changed:

<
< wiki syntax

>
> Singleton

Changed:

<
< GNU

>
> escaped: [[WikiSyntax]]

Added:

>
>

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

Line: 414 to 401

Added:

>
>

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.

Line: 432 to 420

Added:

>
>

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]].

Line: 454 to 443

Changed:

<
<

>
>

Changed:

<
< Literal content:

>
>

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

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

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

Line: 475 to 492

Changed:

<
<

>
>

Changed:

<
< Protected content:

>
> Protected Text:

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

Revision 62010-11-11 - TWikiContributor

Line: 1 to 1

TWiki Editing Shorthand

Added:

>
>

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

Revision 52010-06-12 - TWikiContributor

-<
<
+ TWiki Editing Shorthand
->
>
+ TWiki Editing Shorthand
-<
<
-<
<
->
>
+Related topics: WikiSyntax, WikiWord, WikiNotation, TextFormattingRules, TWikiRenderingShortcut, TWikiShorthand

Revision 42009-11-25 - TWikiContributor

Line: 1 to 1

TWiki Editing Shorthand

Line: 139 to 139

Changed:

<
< Verbatim Text:

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

Line: 485 to 485

is HTML that WYSIWYG would normally filter out or modify). Protected content appears as plain text in the WYSIWYG editor.

Changed:

<
<

<sticky>

<div>

>
>

<sticky>
<div>

This div is required

Changed:

<
< <sticky>

>
> </div> </sticky>

Revision 32007-04-15 - TWikiContributor

Line: 1 to 1

TWiki Editing Shorthand

Line: 6 to 6

Changed:

<
<

>
>

Formatting Command:

Line: 131 to 139

Changed:

<
< Verbatim (Literal) Text:

>
> Verbatim Text:

Line: 234 to 245

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

Added:

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

   $ Sushi: Japan

Line: 255 to 269

|^| 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

Changed:

<
<

Use | or %VBAR% to add | characters in tables.

The TablePlugin provides the |^| multiple-span row functionality and additional rendering features

>
>

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* |

Line: 290 to 306

Changed:

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

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

Changed:

<
< It's generally a good idea to use the TWikiVariables %TWIKIWEB% and %MAINWEB% instead of TWiki and Main.

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

WebStatistics

Line: 300 to 318

WebNotify

Sandbox

Added:

>
> TopicName

Added:

>
>

Line: 307 to 328

Added:

>
> TopicName

Anchors:

Changed:

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

>
> 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]]

Line: 342 to 366

[[wiki syntax]]

Changed:

<
< Main.TWiki users

>
> Main.TWiki groups

escaped: [[wiki syntax]]

Line: 348 to 372

[[wiki syntax]]

Added:

>
>

wiki syntax

Changed:

<
< Main.TWiki users

>
> Main.TWiki groups

escaped: [[wiki syntax]]

Line: 394 to 420

 <noautolink>

Changed:

<
< RedHat & SuSE

>
> RedHat & SuSE

Line: 399 to 424

Added:

>
>

Changed:

<
< RedHat & SuSE

>
> RedHat & SuSE

Line: 428 to 454

Added:

>
>

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

Revision 22006-07-25 - TWikiContributor

Line: 1 to 1

Changed:

<
<

TWiki Editing Shorthand'

>
>

TWiki Editing Shorthand

Line: 255 to 255

|^| 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

Added:

>
>

Use | or %VBAR% to add | characters in tables.

The TablePlugin provides the |^| multiple-span row functionality and additional rendering features

Revision 12006-03-07 - TWikiContributor

Line: 1 to 1

Added:

>
>

TWiki Editing Shorthand'

Formatting Command: You write: You get:

Paragraphs:
Blank lines will create new paragraphs.

1st paragraph

2nd paragraph

1st paragraph

2nd paragraph

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

   $ 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

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
A5-7	5	5
A2	B2	C2
A3	B3	C3
A9	B9	C9
multi span
split	over	3 lines
A5-7	seven	seven
A5-7	six	six

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.

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.

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

WebStatistics

Sandbox.WebNotify

Sandbox.WebHome

WebStatistics

WebNotify

Sandbox

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. 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 users]]

escaped:
![[wiki syntax]]

wiki syntax

Main.TWiki users

escaped: [[wiki syntax]]

) 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

a@b.com

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

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

a@b.com

Mail

View topic | History: r10 < r9 < r8 < r7 | More topic actions...

Copyright © 1999-2025 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.