TWiki Text Formatting

Working in TWiki is as easy as typing in text. You don't need to know HTML, though you can use it if you prefer. Links to topics are created automatically when you enter WikiWords. And TWiki shorthand gives you all the power of HTML with a simple coding system that takes no time to learn. It's all laid out below.

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 CGI !! after the CGI ---+. 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 CGI * asterisks.	*Bold*	Bold
Italic Text: Words get shown in italic by enclosing them in CGI _ underscores.	_Italic_	Italic
Bold Italic: Words get shown in bold italic by enclosing them in CGI __ double-underscores.	__Bold italic__	Bold italic
Fixed Font: Words get shown in CGI fixed font by enclosing them in CGI = equal signs.	=Fixed font=	CGI Fixed font
Bold Fixed Font: Words get shown in CGI CGI bold fixed font by enclosing them in CGI CGI double equal signs.	==Bold fixed==	CGI CGI Bold fixed
You can follow the closing bold, italic, or other (CGI * _ __ = ==) 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 Text: Surround code excerpts and other formatted text with CGI <verbatim> and CGI </verbatim> tags. CGI verbatim tags disable HTML code. Use CGI <pre> and CGI </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. CGI | *bold* | header cell with text in asterisks CGI |   center-aligned   | cell with at least two, and equal number of spaces on either side CGI |      right-aligned | cell with more spaces on the left CGI | 2 colspan || and multi-span columns with multiple |'s right next to each other CGI |^| cell with caret indicating follow-up row of multi-span rows You can split rows over multiple lines by putting a backslash CGI '\' at the end of each line Contents of table cells wrap automatically as determined by the browser Use CGI %VBAR% or CGI &#124; to add CGI | characters in tables. Use CGI %CARET% or CGI &#94; to add CGI ^ characters in tables. The TablePlugin provides the CGI |^| 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 CGI TopicName? . To link to a topic in a subweb write CGI 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 CGI '.' 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	WebStatistics WebNotify Sandbox TopicName
Anchors: You can define a reference inside a TWiki topic (called an anchor name) and link to that. To define an anchor write CGI #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 CGI [[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, CGI [[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 CGI [[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 CGI <noautolink> and CGI </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 CGI [[mailto:user@domain][descriptive text]].	a@b.com [[mailto:a@b.com]\ [Mail]] [[mailto:?subject=\ Hi][Hi]]	a@b.com Mail Hi
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 CGI <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 CGI <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.	CGI <sticky> <div> This div is required </div> CGI <sticky>	This div is required

Using HTML

You can use most HTML tags in TWiki topics without a problem. This is useful where you want to add some content that is formatted in a way that is not supported using TWiki shorthand, for example, you can write CGI <strike>deleted text</strike> to get deleted text.

There are a few usability and technical considerations to keep in mind:

• On collaboration pages, it's better not to use HTML, but to use TWiki shorthand instead - this keeps the text uncluttered and easy to edit using the plaintext editor.
• If you must use HTML, use XHTML 1.0 Transitional syntax.
• Use CGI <literal>..</literal> tags around blocks of HTML to avoid accidental interpretation of TWiki shorthand within the HTML.
• Script tags may be filtered out, at the discretion of your TWiki administrator.

Recommendations when pasting HTML from other sources (using the plain-text editor):

• Copy only text between CGI <body> and CGI </body> tags.
• Remove all empty lines. TWiki inserts CGI <p /> paragraph tags on empty lines, which causes problems if done between HTML tags that do not allow paragraph tags, like for example between table tags.
• Remove leading spaces. TWiki might interpret some text as lists.
• Do not span a tag over more than one line. TWiki requires that the opening and closing angle brackets - CGI CGI <...> - of a HTML tag are on the same line, or the tag will be broken.
• In your HTML editing program, save without hard line breaks on text wrap.

When using a WYSIWYG editor, you can just copy-paste directly into the editor, and the content will be converted to TWiki shorthand automatically when you save.

Hyperlinks

Being able to create links without any special formatting is a core TWiki feature, made possible with WikiWords and inline URLs.

Internal Links

• GoodStyle is a WikiWord that links to the GoodStyle topic located in the current web.

• NotExistingYet? is a topic waiting to be written. Create the topic by clicking on the ?. (Try clicking, but then, Cancel - creating the topic would wreck this example!)

External Links

• CGI http://..., CGI https://..., CGI ftp://..., CGI gopher://..., CGI news://..., CGI file://..., CGI telnet://... and CGI mailto:...@... are linked automatically.

• E-mail addresses like CGI name@domain.com are linked automatically.

• CGI [[Square bracket rules]] let you easily create non-WikiWord links.
  • You can also write CGI [[http://yahoo.com Yahoo home page]] as an easier way of doing external links with descriptive text for the link, such as Yahoo home page.

TWiki Variables

TWiki Variables are names enclosed in percent signs that are that are expanded to some other text when the topic is displayed. For example, CGI %TOPIC% is expanded to TWikiVariablesQuickStart. Some variables can take arguments in curly braces - for example, CGI %INCLUDE{"OtherTopic" ARG="arg"}%.

Many TWiki variables are built-in, and others are predefined for your convenience. You can also define your own TWiki Variables at the entire site, individual web, or individual topic level. For more information, go to TWikiVariables

TWiki Variables are fully expanded before any of the TWiki text formatting rules are applied.

Documentation Graphics: There are many graphics available to use in your topics. Use CGI %ICON{"help"}%, CGI %ICON{"tip"}%, and CGI %ICON{"warning"}% to get: , , and , respectively. TWikiDocGraphics lists them all.

To "escape" a variable, prefix it with an exclamation mark. Write: CGI !%SOMEVARIABLE% to get: %SOMEVARIABLE%.

TWikiPlugin Formatting Extensions

Plugins can extend the functionality of TWiki into many other areas. There are a huge number of TWiki plugins available from the Plugins web on TWiki.org.

Currently enabled plugins on this TWiki installation, as listed by CGI %PLUGINDESCRIPTIONS%:

• SpreadSheetPlugin (any TWiki, $Rev: 17387 (11 Aug 2008) $): Add spreadsheet calculation like CGI "$SUM( $ABOVE() )" to TWiki tables and other topic text
• CommentPlugin (03 Aug 2008, $Rev: 17302 (11 Aug 2008) $): Allows users to quickly post comments to a page without an edit/preview/save cycle
• EditTablePlugin (4.8.4, $Rev: 17302 (11 Aug 2008) $): Edit TWiki tables using edit fields, date pickers and drop down boxes
• InterwikiPlugin (03 Aug 2008, $Rev: 14913 (17 Sep 2007) $): Link CGI CGI ExternalSite? :Page text to external sites based on aliases defined in a rules topic
• PreferencesPlugin (TWiki-4.2, $Rev: 15487 (11 Aug 2008) $): Allows editing of preferences using fields predefined in a form
• SlideShowPlugin (02 Aug 2008, $Rev: 17260 (11 Aug 2008) $): Create web based presentations based on topics with headings.
• SmiliesPlugin (Dakar, $Rev: 16049 (11 Aug 2008) $): Render smilies as icons, like for CGI  :-) or for CGI  :eek:
• TablePlugin (1.034, $Rev: 17367 (11 Aug 2008) $): Control attributes of tables and sorting of table columns
• TinyMCEPlugin (03 Aug 2008, $Rev: 17302 (11 Aug 2008) $): Integration of TinyMCE? with WysiwygPlugin
• TwistyPlugin (1.4.10, $Rev: 15653 (19 Nov 2007) $): Twisty section JavaScript library to open/close content dynamically
• WysiwygPlugin (03 Aug 2008, $Rev: 17359 (11 Aug 2008) $): Translator framework for Wysiwyg editors

Check on current Plugin status and settings for this site in TWikiPreferences.

Common Editing Errors

TWiki formatting rules are fairly simple to use and quick to type. However, there are some things to watch out for, taken from the TextFormattingFAQ:

• Q: Text enclosed in angle brackets like CGI <filename> is not displayed. How can I show it as it is?
  • A: The CGI '<' and CGI '>' characters have a special meaning in HTML, they define HTML tags. You need to escape them, so write CGI '<' instead of CGI '<', and CGI '>' instead of CGI '>'.
    Example: Type CGI 'prog <filename>' to get CGI 'prog <filename>'.

• Q: Why is the CGI '&' character sometimes not displayed?
  • A: The CGI '&' character has a special meaning in HTML, it starts a so called character entity, i.e. CGI '©' is the CGI © copyright character. You need to escape CGI '&' to see it as it is, so write CGI '&' instead of CGI '&'.
    Example: Type CGI 'This & that' to get CGI 'This & that'.