Formatting Command: | You write: | You get: | |||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Paragraphs: %BR% Blank lines will create new paragraphs. | 1st paragraph 2nd paragraph |
1st paragraph 2nd paragraph |
|||||||||||||||||||||||||
Headings: %BR% 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 [[Main/VarTOC]] variable. If you want to exclude a heading from the TOC, put %X% Empty headings are allowed, but won't appear in the table of contents. |
---++ Sushi ---+++ Maguro ---+++!! Not in TOC |
SushiMaguroNot in TOC |
|||||||||||||||||||||||||
Bold Text: %BR% Words get shown in bold by enclosing them in * asterisks. |
*Bold* |
Bold |
|||||||||||||||||||||||||
Italic Text: %BR% Words get shown in italic by enclosing them in _ underscores. |
_Italic_ |
Italic |
|||||||||||||||||||||||||
Bold Italic: %BR% Words get shown in bold italic by enclosing them in __ double-underscores. |
__Bold italic__ |
Bold italic |
|||||||||||||||||||||||||
Fixed Font: %BR% Words get shown in fixed font by enclosing them in = equal signs. |
=Fixed font= |
|
|||||||||||||||||||||||||
Bold Fixed Font: %BR% Words get shown in bold fixed font by enclosing them in double equal signs. |
==Bold fixed== |
|
|||||||||||||||||||||||||
%T% You can follow the closing bold, italic, or other (* _ __ = == ) indicator with normal punctuation, such as commas and full stops. %X% Make sure there is no space between the text and the indicators. |
_This works_, _this does not _ |
This works,%BR% _this does not _ |
|||||||||||||||||||||||||
Verbatim Text: %BR% Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags.%BR% %T% verbatim tags disable HTML code. Use <pre> and </pre> tags instead if you want the HTML code within the tags to be interpreted.%BR% %X% 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): %BR% Three or more three dashes at the beginning of a line.. | ------- |
|
|||||||||||||||||||||||||
Bulleted List: %BR% Multiple of three spaces, an asterisk, and another space.%BR% %H% 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 |
|
|||||||||||||||||||||||||
Numbered List: %BR% Multiple of three spaces, a type character, a dot, and another space. Several types are available besides a number:
|
1. Sushi 1. Dim Sum 1. Fondue A. Sushi A. Dim Sum A. Fondue i. Sushi i. Dim Sum i. Fondue |
|
|||||||||||||||||||||||||
Definition List: %BR% 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. |
|
|||||||||||||||||||||||||
Table: %BR% 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.
|^| 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 | |
|
|||||||||||||||||||||||||
WikiWord Links: %BR% CapitalizedWordsStuckTogether (or [[Main/WikiWords]]) will produce a link automatically if preceded by whitespace or parenthesis. %BR% %T% If you want to link to a topic in a different web write Otherweb.TopicName . %BR% To link to a topic in a subweb write Otherweb.Subweb.TopicName .%BR% %H% 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. %BR% %X% 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 [[Main/TWikiVariables]] %SYSTEMWEB% and %USERSWEB% instead of TWiki and Main. |
WebStatistics Sandbox.WebNotify Sandbox.WebHome Sandbox.Subweb.TopicName |
[[Main/WebStatistics]] [[Sandbox/WebNotify]] [[Sandbox/WebHome]] |
|||||||||||||||||||||||||
Anchors: %BR% 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 [[Main/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 |
[[Main/WikiWord#NotThere]] [[Main/WebHome#MyAnchor]] |
|||||||||||||||||||||||||
Forced Links: %BR% You can create a forced internal link by enclosing words in double square brackets. %BR% 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 [[Main/TextFormattingFAQ]]. You can also refer to a different web and use anchors. %BR% %T% 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]] |
[[Main/WikiSyntax]] [[USERSWEB/TWikiGroups]] escaped: [[wiki syntax]] |
|||||||||||||||||||||||||
Specific Links: %BR% 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. [[Main/WikiSyntax]]) and URLs (e.g. http://TWiki.org/) are both supported. The rules described under Forced Links apply for internal link references. %BR% %T% 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]] |
[[Main/WikiSyntax]] |
|||||||||||||||||||||||||
Prevent a Link: %BR% Prevent a [[Main/WikiWord]] from being linked by prepending it with an exclamation point. | !SunOS |
SunOS | |||||||||||||||||||||||||
Disable Links: %BR% You can disable automatic linking of [[Main/WikiWords]] by surrounding text with <noautolink> and </noautolink> tags.%BR% %H% It is possible to turn off all auto-linking with a NOAUTOLINK preferences setting. |
<noautolink> RedHat & SuSE </noautolink> |
RedHat & SuSE |
|||||||||||||||||||||||||
Mailto Links: %BR% 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]] |
||||||||||||||||||||||||||
Literal content: %BR% 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. %X% any HTML within literal tags must be well formed i.e. all tags must be properly closed before the end of the literal block. %I% TWiki Variables are expanded within literal blocks. |
<literal> | Not | A | Table | <literal> |
| Not | A | Table | | |||||||||||||||||||||||||
Protected content: %BR% 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 |