TextFormattingRules 49 - 07 Mar 2006 - Main.TWikiContributor
|
|
TWiki Text Formatting | |
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
- 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 |
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 .
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]]
|
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
Hi
|
| > > |
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
- 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
- Use
| or %VBAR% 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 .
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]]
|
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
Hi
|
| | Using HTML | |
< < | You can use just about any HTML tag without a problem. You can add HTML if there is no TWiki equivalent, for example, write <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.
- If you use HTML use XHTML 1.0 Transitional syntax.
-
Script tags may be filtered out, at the discretion of your TWiki administrator.
Recommendations when pasting HTML from other sources:
- Copy only text between
<body> and </body> tags.
- Remove all empty lines. TWiki inserts
<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 -
<...> - of an 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.
TWiki converts shorthand notation to HTML for display. To copy a fully marked-up page, simply view the source in your browser and save the contents. If you need to save HTML frequently, you may want to check out TWiki:Plugins/PublishAddOn. | > > | You can use just about any HTML tag without a problem. You can add HTML if there is no TWiki equivalent, for example, write <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.
- If you use HTML use XHTML 1.0 Transitional syntax.
-
Script tags may be filtered out, at the discretion of your TWiki administrator.
Recommendations when pasting HTML from other sources:
- Copy only text between
<body> and </body> tags.
- Remove all empty lines. TWiki inserts
<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 -
<...> - of an 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.
TWiki converts shorthand notation to HTML for display. To copy a fully marked-up page, simply view the source in your browser and save the contents. If you need to save HTML frequently, you may want to check out TWiki:Plugins/PublishAddOn. | | Script tags | | TWiki Variables | |
< < | TWiki Variables are names that are enclosed in percent signs % that are expanded on the fly.
-
%TOC% : Automatically generates a table of contents based on headings in a topic - see the top of this page for an example.
-
%WEB% : The current web, is TWiki.
-
%TOPIC% : The current topic name, is TextFormattingRules.
-
%ATTACHURL% : The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as %ATTACHURL%/image.gif to show the URL of the file or the image in your text.
-
%INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current web is the default web. Example: %INCLUDE{"TWiki.SiteMap"}%
-
%SEARCH{"sushi"}% : Inline search showing the search result embedded in a topic. FormattedSearch gives you control over formatting, useful for creating web-based applications.
- TWikiPreferences defines some site-wide variables. Among others:
- Line break: Write
%BR% to start a new line.
- Colored text: Write:
%RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors to get: Red and blue colors.
- Documentation Graphics: Write:
%H% Help, %T% Tip, %X% Alert to get: Help, Tip, Alert. For more info see TWikiDocGraphics.
- To "escape" a variable, prefix it with an exclamation mark. Write:
!%SOMEVARIABLE% to get: %SOMEVARIABLE%.
| > > | TWiki Variables are names that are enclosed in percent signs % that are expanded on the fly. Some variables take arguments, such as %INCLUDE% . For those variables, the arguments are included in curly braces ({ and }).
Variable | In brief | Full documentation |
%TOC% | Automatically generates a table of contents based on headings in a topic - see the top of this page for an example. | VarTOC |
%WEB% | The current web, is TWiki. | VarWEB |
%TOPIC% | The current topic name, is TextFormattingRules. <-- using BASETOPIC instead of TOPIC for the example because this document is normally included in TextFormattingRules --> | VarTOPIC |
%ATTACHURL% | The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as %ATTACHURL%/image.gif to show the URL of the file or the image in your text. | VarATTACHURL |
%INCLUDE{"SomeTopic"}% | Server side include, includes another topic. The current web is the default web. Example: %INCLUDE{"TWiki.SiteMap"}% | VarINCLUDE |
%SEARCH{"sushi"}% | Inline search showing the search result embedded in a topic. FormattedSearch gives you control over formatting, useful for creating web-based applications. | VarSEARCH |
TWikiPreferences defines some site-wide variables. Among them are:
- Line break: Write
%BR% to start a new line.
- Colored text: Write:
%RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors to get: Red and blue colors.
There are many more variables. To see them all, go to TWikiVariables.
Documentation Graphics: There are many graphics available to use in your topics. Use %ICON{"help"}% , %ICON{"tip"}% , and %ICON{"warning"}% to get: , , and , respectively. TWikiDocGraphics lists them all.
To "escape" a variable, prefix it with an exclamation mark. Write: !%SOMEVARIABLE% to get: %SOMEVARIABLE%. | | TWikiPlugin Formatting Extensions |
|
TextFormattingRules 48 - 27 Mar 2005 - Main.TWikiContributor
|
|
TWiki Text Formatting | |
< < | Working in TWiki is as easy as typing in text - exactly like email. 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 - refer back to this page in a pop-up window from the Edit screen. | > > | 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:
|
Example: You write:
|
You get:
|
| > > |
Formatting Command:
|
You write:
|
You get:
|
| | | |
< < | | > > | | | Paragraphs:
Blank lines will create new paragraphs. | |
< < | | > > | | | 1st paragraph
2nd paragraph | |
< < | | > > | | | 1st paragraph
2nd paragraph
| |
< < | | > > | | | Headings:
| |
< < | At least three dashes at the beginning of a line, followed by plus signs and the heading text. One plus creates a level 1 heading (most important), two pluses a level 2 heading; the maximum is level 6. Note: A Table of Content can be created automatically with the %TOC% variable, see TWikiVariables. Any heading text after !! is excluded from the TOC; for example, write ---+!! text if you do not want to list a header in the TOC.
---++ Sushi
---+++ Maguro
|
Sushi | | > > | 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. | | | |
< < | Maguro | > > | 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 bold by enclosing them in * asterisks.
| | > > | Words get shown in bold by enclosing them in * asterisks.
| | | Bold | |
< < | | > > | | | | |
< < | | > > | | | Italic Text:
| |
< < | Words get italic by enclosing them in _ underscores.
| | > > | Words get shown in italic by enclosing them in _ underscores.
| | | Italic | |
< < | | > > | | | | |
< < | | > > | | | Bold Italic:
| |
< < | Words get _bold italic by enclosing them in _ double-underscores.
| | > > | Words get shown in bold italic by enclosing them in __ double-underscores.
| | | Bold italic | |
< < | | > > | | | | |
< < | | > > | | | Fixed Font:
Words get shown in fixed font by enclosing them in = equal signs. | |
< < | | > > | | | Fixed font | |
< < | | > > | | | | |
< < | | > > | | | Bold Fixed Font:
Words get shown in bold fixed font by enclosing them in double equal signs. | |
< < | | > > | | | Bold fixed | |
< < | | > > | | | | |
< < |
Note: Make sure there is no space between the text and the bold, italic, or other indicators (* _ __ = == ).
|
|
| > > |
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 works,
| |
< < | _this not _ | > > | _this does not _ | | | |
< < |
Verbatim Mode:
Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags. Note: Use <pre> and </pre> tags instead if you want that HTML code is interpreted. Note: Each tag must be on a line by itself.
|
<verbatim>
|
| > > |
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></verbatim>
<nop>
|
| | class CatAnimal? {
void purr() { | |
< < | <code here> | > > |
| | }
} | |
< < | | > > | | |
class CatAnimal {
void purr() { | | | |
< < |
Separator:
At least three dashes at the beginning of a line.
|
|
| > > |
Separator (Horizontal Rule):
Three or more three dashes at the beginning of a line..
| |
| |
| |
< < | | > > | | | | |
< < |
List Item:
Three spaces, an asterisk, and another space.
|
* bullet item
|
|
Nested List Item:
Six, nine, ... spaces, an asterisk, and another space.
|
|
| > > |
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.
| |
| | | |
< < | | > > |
- back on 1
- A bullet broken over three lines
- last bullet
| | | | |
> > |
- back on 1
- A bullet broken over three lines
- last bullet
| | | |
< < |
Ordered List:
Three spaces, a number, a dot, and another space. Several types are available besides a number: |
| > > |
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... |
| |
< < | | > > | | |
- Sushi
- Dim Sum
| |
> > |
- Fondue
| |
- Sushi
- Dim Sum
| |
> > |
- Fondue
| |
- Sushi
- Dim Sum
| |
< < | | > > | | |
- 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.
| |
< < | | > > | | | | |
< < | | > > | | | Table:
| |
< < | Any number of lines of text. Each line is one row of the table consisting of one or more cells. Each cell starts and ends with a vertical bar '|'. Any spaces at the beginning of a line are ignored.
Notes: •
| *bold* | cells are displayed as table headers. •
| center-spaced | cells are displayed center aligned. •
| right-spaced | cells are displayed right aligned. •
| 2 colspan || cells are displayed as multi-span columns (i.e., a cell with no text spans a column). •
|^| cells with a caret indicate follow-up rows of multi-span rows (this functionality is provided by TablePlugin). •
If a row contains a large amount of text, and you want it to be more readable while editing the table, split the row into multiple text lines by ending each line with a backslash character '\' . •
Table cells wrap automatically as determined by the browser.
| | > > | 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
| | |
| |
< < |
| > > |
| |
| |
< < |
| > > |
| |
| |
< < | | > > |
seven | seven |
split | over | 3 lines |
A9 | B9 | C9 |
| | |
| |
< < |
| > > |
| |
| |
< < |
| > > |
| |
| |
> > |
seven | seven |
split | over | 3 lines |
A9 | B9 | C9 |
| | | |
< < | | > > | | | WikiWord Links:
| |
< < | CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically. Note: In case you want to link to a topic in a different TWiki web write Otherweb.TopicName . (The link label is the the name of the web in case the is WebHome, else it is the topic name)
WebNotify
Main.TWikiUsers
|
WebNotify | | > > | 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 | | | | |
< < | TWikiUsers | > > | | | | |
< < | | > > |
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. | |
< < | Note: 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.
Note: To "escape" double square brackets that would otherwise be a correct link, prefix the leading left square brackets with an exclamation point, that is, begin with ![[....
| | > > |
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 | > > | Main.TWiki users | | escaped:
[[wiki syntax]] | |
< < | | > > | | | wiki syntax
Main.TWiki users | | | |
< < | | > > | | | Specific Links:
| |
< < | Create a link where you can specify the link text and the link reference separately, using nested square brackets like [[reference][text]] . Internal link references (e.g. WikiSyntax) and external link references (e.g. http://TWiki.org/) are supported.
Note: The same Forced Links rules apply for internal link references.
Note: For external link references, you can simply use a space instead of ][ to separate the link URL from the descriptive text.
Note: Anchor names can be added as well, like [[WebHome#MyAnchor][go home]] and [[http://gnu.org/#Action][GNU Action]] .
[[WikiSyntax][syntax]]
| | > > | 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]] | | | GNU | |
< < | | > > | | | GNU | |
< < | XML | | | |
< < |
Anchors:
You can define a link 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
|
|
| > > | | | Prevent a Link:
Prevent a WikiWord from being linked by prepending it with an exclamation point. | |
< < | | > > | | | SunOS | |
< < | | > > | | | | |
< < | | > > | | | Disable Links:
| |
< < | You can disable automatic linking of WikiWords by surrounding text with <noautolink> and </noautolink> tags.
Note: Each tag must be on a line by itself.
Note: This also works for TWiki tables, but only if you add a blank line between the end of the table and the closing </noautolink> tag (known issue of the TablePlugin).
| | > > | 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>
| |
< < | | > > | | | | |
< < |
Mailto: Links:
To create 'mailto:' links that have more descriptive link text, specify subject lines or message bodies, or omit the email address, you can write [[mailto:user@domain descriptive text]] .
|
[[mailto:a@z.com Mail]]
[[mailto:?subject=Hi Hi]]
|
Mail |
| > > |
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 |
| | | |
< < | Hi | > > | | |
Using HTML | |
< < | You can use just about any HTML tag without a problem - however, there are a few usability and technical considerations to keep in mind.
HTML and TWiki Usability | > > | You can use just about any HTML tag without a problem. You can add HTML if there is no TWiki equivalent, for example, write <strike>deleted text</strike> to get deleted text. | | | |
< < |
-
TIP: On collaboration pages, it's preferable NOT to use HTML, and to use TWiki shorthand instead - this keeps the text uncluttered and easy to edit.
-
NOTE: TWiki is designed to work with a wide range of browsers and computer platforms, holding to HTML 4.0 and XHTML 1.0 compatibility in the standard installation - adding raw HTML, particularly browser-specific tags (or any other mark-up that doesn't degrade well) will reduce compatibility.
- Recommondations when using HTML:
- Use XHTML 1.0 Transitional syntax
- Do not span a tag over more then one line
- Remove all empty lines. TWiki inserts
<p /> paragraph tags on empty lines, which causes problems if done between tags that do not allow paragraph tags, like for example between table tags.
| > > | 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.
- If you use HTML use XHTML 1.0 Transitional syntax.
-
Script tags may be filtered out, at the discretion of your TWiki administrator.
| | | |
> > | Recommendations when pasting HTML from other sources:
- Copy only text between
<body> and </body> tags.
- Remove all empty lines. TWiki inserts
<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 -
<...> - of an 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.
| | | |
< < | TWiki HTML Rendering | > > | TWiki converts shorthand notation to HTML for display. To copy a fully marked-up page, simply view the source in your browser and save the contents. If you need to save HTML frequently, you may want to check out TWiki:Plugins/PublishAddOn. | | | |
< < |
- TWiki converts shorthand notation to XHTML 1.0 for display. To copy a fully marked-up page, simply view source in your browser and save the contents.
-
If you need to save HTML frequently, you may want to check out TWiki:Plugins/GenHTMLAddon - it will "generate a directory containing rendered versions of a set of TWiki pages together with any attached files."
-
NOTE: The opening and closing angle brackets - <...> - of an HTML tag must be on the same line, or the tag will be broken.
- This feature allows you to enter an unclosed angle bracket - as a greater than or less than symbol - and have it automatically rendered as if you had entered its HTML character,
< , ex: a < b
-
If you're pasting in preformatted HTML text and notice problems, check the file in a text processor with no text wrap. Also, save without hard line breaks on text wrap, in your HTML editing program.
| > > | Script tags | | | |
< < | TWiki and JavaScript
You can use JavaScript for your TWiki applications. Since TWiki rendering might interfere with JavaScript code you need to escape it with HTML comments and <pre> tags:
<script type="text/javascript">
<!-- Hide JavaScript and <pre> escape TWiki rendering
... put your JavaScript code here...
// Stop hiding and stop </pre> escaping TWiki rendering -->
</script>
| > > | You can use HTML <script> tags for your TWiki applications. However note that your TWiki administrator can disable <script> in topics, and may have chosen to do so for security considerations. TWiki markup and TWikiVariables are not expanded inside script tags. | | Hyperlinks | |
< < | Being able to create links without any formatting required is a core TWiki feature, made possible with WikiWords. New TWiki linking rules are a simple extension of the syntax that provide a new set of flexible options. | > > | 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 TWiki web.
| > > |
- 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!)
| |
-
http://... , https://... , ftp://... , gopher://... , news://... , file://... , telnet://... and mailto:...@... are linked automatically.
| |
< < |
- Email addresses like
name@domain.com are linked automatically.
| > > |
- E-mail addresses like
name@domain.com are linked automatically.
| |
-
[[Square bracket rules]] let you easily create non-WikiWord links.
- You can also write
[[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.
| |
-
[[Square bracket rules]] let you easily create non-WikiWord links.
- You can also write
[[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 | |
< < | Variables are names that are enclosed in percent signs % that are expanded on the fly. | > > | TWiki Variables are names that are enclosed in percent signs % that are expanded on the fly. | |
-
%TOC% : Automatically generates a table of contents based on headings in a topic - see the top of this page for an example.
| |
< < |
-
%WEB% : The current web, is TWiki.
| > > |
-
%WEB% : The current web, is TWiki.
| |
-
%TOPIC% : The current topic name, is TextFormattingRules.
-
%ATTACHURL% : The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as %ATTACHURL%/image.gif to show the URL of the file or the image in your text.
| |
< < |
-
%INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current TWiki web is the default web. Example: %INCLUDE{"TWiki.SiteMap"}%
| > > |
-
%INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current web is the default web. Example: %INCLUDE{"TWiki.SiteMap"}%
| | | |
< < |
-
%SEARCH{"sushi"}% : Inline search showing the search result embedded in a topic. FormattedSearch gives you control over formatting, used to create web-based applications.
| > > |
-
%SEARCH{"sushi"}% : Inline search showing the search result embedded in a topic. FormattedSearch gives you control over formatting, useful for creating web-based applications.
| | | |
< < |
- TWikiPreferences defines site-wide variables. Among others:
- Line break: Write
%BR% to start a new line.
- Colored text: Write:
%RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors to get: Red and blue colors.
- Documentation Graphics: Write:
%H% Help, %T% Tip, %X% Alert to get: Help, Tip, Alert. For more info see TWikiDocGraphics.
| > > |
- TWikiPreferences defines some site-wide variables. Among others:
- Line break: Write
%BR% to start a new line.
- Colored text: Write:
%RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors to get: Red and blue colors.
- Documentation Graphics: Write:
%H% Help, %T% Tip, %X% Alert to get: Help, Tip, Alert. For more info see TWikiDocGraphics.
| | | |
< < |
- To "escape" a variable, prefix it with an exclamation point. Write:
!%SOMEVARIABLE% to get: %SOMEVARIABLE%.
| > > |
- To "escape" a variable, prefix it with an exclamation mark. Write:
!%SOMEVARIABLE% to get: %SOMEVARIABLE%.
| | TWikiPlugin Formatting Extensions | |
< < | Plugins provide additional text formatting capabilities and can extend the functionality of TWiki into many other areas. For example, the optional SpreadSheetPlugin lets you create a spreadsheet with the same basic notation used in TWiki tables.
Available Plugins are located in the Plugins web on TWiki.org. Currently enabled plugins on this TWiki installation, as listed by %PLUGINDESCRIPTIONS% : | > > | 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 %PLUGINDESCRIPTIONS% : | | - SpreadSheetPlugin (any TWiki, 10197): Add spreadsheet calculation like
"$SUM( $ABOVE() )" to TWiki tables and other topic text - ActionTrackerPlugin (21 May 2007, $Rev: 14969 (20 Sep 2007) $): Adds support for action tags in topics, and automatic notification of action statuses
- AttachmentListPlugin (1.0.1, $Rev: 15921 (07 Dec 2007) $): Displays a formattable list of topic attachments, anywhere in a topic.
- BreadCrumbsPlugin (v1.00, $Rev: 13657 (08 May 2007) $): A flexible way to display breadcrumbs navigation
- CalendarPlugin (Dakar, 9113): Show a monthly calendar with highlighted events
- CommentPlugin (Dakar, 11359): Allows users to quickly post comments to a page without an edit/preview/save cycle
- CompareRevisionsAddonPlugin (Dakar, $Rev: 9808$):
- EditTablePlugin (any TWiki, 11646): Edit TWiki tables using edit fields, date pickers and drop down boxes
- FilterPlugin (1.40, $Rev: 15932 (07 Dec 2007) $): Substitute and extract information from content by using regular expressions
- FlexWebListPlugin (v1.21, $Rev: 16132 (03 Jan 2008) $): Flexible way to display hierarchical weblists
- FootNotePlugin (2.006): Footnotes are notes placed at the end of a topic.
- GluePlugin (2.00, $Rev: 15708 (23 Nov 2007) $): Enable markup to span multiple lines
- IfDefinedPlugin (v1.01, $Rev: 15157 (05 Oct 2007) $): Render content conditionally
- InterwikiPlugin (Dakar, $Rev: 11935$): Link
ExternalSite:Page text to external sites based on aliases defined in a rules topic - JQueryPlugin (v0.4, $Rev: 15608 (15 Nov 2007) $): jQuery JavaScript library for TWiki
- NatSkinPlugin (3.00-pre17, $Rev: 15581 (13 Nov 2007) $): Supplements the bare bones NatSkin theme for TWiki
- PreferencesPlugin (Dakar, 9839): Allows editing of preferences using fields predefined in a form
- RedDotPlugin (1.40, $Rev: 16137 (03 Jan 2008) $): Renders edit-links as little red dots
- RenderListPlugin (any TWiki, 1.034): Render bullet lists in a variety of formats
- SlideShowPlugin (Any TWiki, $Rev: 12847$): Create web based presentations based on topics with headings.
- SmiliesPlugin (Dakar, 8154): Render smilies as icons, like
for :-) or for = :eek:= - TablePlugin (1.020, 12339): Control attributes of tables and sorting of table columns
- TreeBrowserPlugin (v1.8): Renders a list as a collapsable/expandable tree.
- TreePlugin (1.7): Dynamic generation of TWiki topic trees
- TwistyPlugin (1.2.0, $Rev: 12154$): Twisty section JavaScript library to open/close content dynamically
- VotePlugin (1.33, $Rev: 14312 (01 Jul 2007) $): Simple way to count votes
- WysiwygPlugin (Dakar, 12422): Translator framework for Wysiwyg editors
Check on current Plugin status and settings for this site in TWikiPreferences. | |
- Q: Why is the
'&' character sometimes not displayed?
- A: The
'&' character has a special meaning in HTML, it starts a so called character entity, i.e. '©' is the © copyright character. You need to escape '&' to see it as it is, so write '&' instead of '&' . Example: Type 'This & that' to get 'This & that' .
| |
< < | -- TWiki:Main.MikeMannix - 02 Dec 2001
-- TWiki:Main.PeterThoeny - 01 Aug 2004 | > > | | | |
|
TextFormattingRules 47 - 01 Aug 2004 - Main.PeterThoeny
|
|
TWiki Text Formatting | | | |
< < | CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically. Note: In case you want to link to a topic in a different TWiki web write Webname.TopicName . | > > | CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically. Note: In case you want to link to a topic in a different TWiki web write Otherweb.TopicName . (The link label is the the name of the web in case the is WebHome, else it is the topic name) | | | | You can use JavaScript for your TWiki applications. Since TWiki rendering might interfere with JavaScript code you need to escape it with HTML comments and <pre> tags: | |
< < | | > > | | | <-- Hide JavaScript? and escape TWiki rendering
... put your JavaScript code here...
// Stop hiding and stop escaping TWiki rendering --> | |
-
- A: The
'&' character has a special meaning in HTML, it starts a so called character entity, i.e. '©' is the © copyright character. You need to escape '&' to see it as it is, so write '&' instead of '&' . Example: Type 'This & that' to get 'This & that' .
-- TWiki:Main.MikeMannix - 02 Dec 2001
| |
< < | -- TWiki:Main.PeterThoeny - 25 Apr 2004 | > > | -- TWiki:Main.PeterThoeny - 01 Aug 2004 | | |
|
TextFormattingRules 45 - 11 Jul 2004 - Main.PeterThoeny
|
|
TWiki Text Formatting | | HTML and TWiki Usability | |
< < |
- On collaboration pages, it's preferable NOT to use HTML, and to use TWiki shorthand instead - this keeps the text uncluttered and easy to edit.
-
NOTE: TWiki is designed to work with a wide range of browsers and computer platforms, holding to HTML 3.2 compatibility in the standard installation - adding raw HTML, particularly browser-specific tags (or any other mark-up that doesn't degrade well) will reduce compatibility.
| > > |
-
TIP: On collaboration pages, it's preferable NOT to use HTML, and to use TWiki shorthand instead - this keeps the text uncluttered and easy to edit.
-
NOTE: TWiki is designed to work with a wide range of browsers and computer platforms, holding to HTML 4.0 and XHTML 1.0 compatibility in the standard installation - adding raw HTML, particularly browser-specific tags (or any other mark-up that doesn't degrade well) will reduce compatibility.
- Recommondations when using HTML:
- Use XHTML 1.0 Transitional syntax
- Do not span a tag over more then one line
- Remove all empty lines. TWiki inserts
<p /> paragraph tags on empty lines, which causes problems if done between tags that do not allow paragraph tags, like for example between table tags.
| | TWiki HTML Rendering |
|
TextFormattingRules 44 - 25 Apr 2004 - Main.PeterThoeny
|
|
TWiki Text Formatting | | | |
< < | Three spaces, a number, and another space. | > > | Three spaces, a number, 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... |
| | | |
< < |
- Sushi
- Dim Sum
| > > |
- Sushi
- Dim Sum
- Sushi
- Dim Sum
- Sushi
- Dim Sum
| | | |
< < |
- Sushi
- Dim Sum
| > > |
- Sushi
- Dim Sum
- Sushi
- Dim Sum
- Sushi
- Dim Sum
| | | | wiki syntax
Main.TWiki users | |
> > | escaped:
[[wiki syntax]] | | | |
> > | escaped:
[[wiki syntax]] | | | | TWiki and JavaScript | |
< < | You can use JavaScript for your TWiki applications. Sice TWiki rendering might interfere with JavaScript code you need to escape it with HTML comments and <pre> tags: | > > | You can use JavaScript for your TWiki applications. Since TWiki rendering might interfere with JavaScript code you need to escape it with HTML comments and <pre> tags: | |
<script language="JavaScript">
<!-- Hide JavaScript and <pre> escape TWiki rendering | |
-
- A: The
'&' character has a special meaning in HTML, it starts a so called character entity, i.e. '©' is the © copyright character. You need to escape '&' to see it as it is, so write '&' instead of '&' . Example: Type 'This & that' to get 'This & that' .
-- TWiki:Main.MikeMannix - 02 Dec 2001
| |
< < | -- TWiki:Main.PeterThoeny - 29 Mar 2004 | > > | -- TWiki:Main.PeterThoeny - 25 Apr 2004 | | |
|
TextFormattingRules 43 - 30 Mar 2004 - Main.PeterThoeny
|
|
TWiki Text Formatting | | | |
< < | Three spaces and an asterisk. | > > | Three spaces, an asterisk, and another space. | | | | | |
< < | Six, nine, ... spaces and an asterisk. | > > | Six, nine, ... spaces, an asterisk, and another space. | | | | | |
< < | Three spaces and a number. | > > | Three spaces, a number, and another space. | | | | | center-spaced | cells are displayed center aligned. •
| right-spaced | cells are displayed right aligned. •
| 2 colspan || cells are displayed as multi-span columns (i.e., a cell with no text spans a column). • | |
< < | |^| cells with a caret indicate follow-up rows of multi-span rows. • | > > | |^| cells with a caret indicate follow-up rows of multi-span rows (this functionality is provided by TablePlugin). • | | If a row contains a large amount of text, and you want it to be more readable while editing the table, split the row into multiple text lines by ending each line with a backslash character '\' . •
Table cells wrap automatically as determined by the browser.
| | | Forced Links:
You can create a forced internal link by enclosing words in double square brackets.
Note: 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. | |
< < | Note: To "escape" double square brackets that would otherwise be a correct link, use <nop> between the leading left square brackets, that is, begin with [<nop>[.... | > > | Note: To "escape" double square brackets that would otherwise be a correct link, prefix the leading left square brackets with an exclamation point, that is, begin with ![[.... | | | | | |
< < | Prevent a WikiWord from being linked by prepending it with the <nop> tag. | > > | Prevent a WikiWord from being linked by prepending it with an exclamation point. | | | |
< < | <nop>SunOS | > > | SunOS | | | |
< < | SunOS | > > | SunOS | | | |
-
- This feature allows you to enter an unclosed angle bracket - as a greater than or less than symbol - and have it automatically rendered as if you had entered its HTML character,
< , ex: a < b
-
If you're pasting in preformatted HTML text and notice problems, check the file in a text processor with no text wrap. Also, save without hard line breaks on text wrap, in your HTML editing program.
| |
> > | TWiki and JavaScript
You can use JavaScript for your TWiki applications. Sice TWiki rendering might interfere with JavaScript code you need to escape it with HTML comments and <pre> tags:
<script language="JavaScript">
<!-- Hide JavaScript and <pre> escape TWiki rendering
... put your JavaScript code here...
// Stop hiding and stop </pre> escaping TWiki rendering -->
</script>
| | Hyperlinks
Being able to create links without any formatting required is a core TWiki feature, made possible with WikiWords. New TWiki linking rules are a simple extension of the syntax that provide a new set of flexible options. | | | |
< < |
- To "escape" a percent sign that would otherwise be interpreted as a variable, add
<nop> after the first percent sign. Write: %<nop>SOMEVARIABLE% to get: %SOMEVARIABLE%.
| > > |
- To "escape" a variable, prefix it with an exclamation point. Write:
!%SOMEVARIABLE% to get: %SOMEVARIABLE%.
| | TWikiPlugin Formatting Extensions | |
-
- A: The
'&' character has a special meaning in HTML, it starts a so called character entity, i.e. '©' is the © copyright character. You need to escape '&' to see it as it is, so write '&' instead of '&' . Example: Type 'This & that' to get 'This & that' .
-- TWiki:Main.MikeMannix - 02 Dec 2001
| |
< < | -- TWiki:Main.PeterThoeny - 16 Mar 2004 | > > | -- TWiki:Main.PeterThoeny - 29 Mar 2004 |
|
TextFormattingRules 42 - 17 Mar 2004 - Main.PeterThoeny
|
|
TWiki Text Formatting | | | |
< < | Three spaces, the term, a colon, a space, followed by the definition.
Note: Terms with spaces are not supported. In case you do have a term with more then one word, separate the words with dashes or with the non-breaking-space entity. | > > | 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.
| | | |
< < |
- Sushi
- Japan
- Dim Sum
- S.F.
| > > |
- Sushi
- Japan
- Dim Sum
- S.F.
| | | |
- Q: Why is the
'&' character sometimes not displayed?
- A: The
'&' character has a special meaning in HTML, it starts a so called character entity, i.e. '©' is the © copyright character. You need to escape '&' to see it as it is, so write '&' instead of '&' . Example: Type 'This & that' to get 'This & that' .
| |
< < | -- MikeMannix? - 02 Dec 2001
-- PeterThoeny? - 15 Jul 2003 | > > | -- TWiki:Main.MikeMannix - 02 Dec 2001
-- TWiki:Main.PeterThoeny - 16 Mar 2004 |
|
TextFormattingRules 41 - 16 Dec 2003 - Main.PeterThoeny
|
|
TWiki Text Formatting | |
< < | Working in TWiki is as easy as typing in text - exactly like email. 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 layed out below - refer back to this page in a pop-up window from the Edit screen. | > > | Working in TWiki is as easy as typing in text - exactly like email. 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 - refer back to this page in a pop-up window from the Edit screen. | |
TWiki Editing Shorthand |
|
TextFormattingRules 40 - 01 Aug 2003 - Main.PeterThoeny
|
|
TWiki Text Formatting | | Forced Links:
You can create a forced internal link by enclosing words in double square brackets.
Note: 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. | |
> > | Note: To "escape" double square brackets that would otherwise be a correct link, use <nop> between the leading left square brackets, that is, begin with [<nop>[.... | | | | | |
> > |
- To "escape" a percent sign that would otherwise be interpreted as a variable, add
<nop> after the first percent sign. Write: %<nop>SOMEVARIABLE% to get: %SOMEVARIABLE%.
| | TWikiPlugin Formatting Extensions |
|
TextFormattingRules 39 - 26 Jul 2003 - Main.PeterThoeny
|
|
TWiki Text Formatting | | Create a link where you can specify the link text and the link reference separately, using nested square brackets like [[reference][text]] . Internal link references (e.g. WikiSyntax) and external link references (e.g. http://TWiki.org/) are supported.
Note: The same Forced Links rules apply for internal link references.
Note: For external link references, you can simply use a space instead of ][ to separate the link URL from the descriptive text. | |
< < | Note: Anchor names can be added as well, like [[WebHome#MyAnchor][go home]] and [[http://gnu.org/#Action][GNU Action]] . | > > | Note: Anchor names can be added as well, like [[WebHome#MyAnchor][go home]] and [[http://gnu.org/#Action][GNU Action]] . | | | | | |
< < | WebHome#NotThere | > > | WikiWord#NotThere | | Jump | | | |
< < | WebHome#NotThere | > > | WikiWord#NotThere | | Jump |
|
TextFormattingRules 38 - 16 Jul 2003 - Main.PeterThoeny
|
|
TWiki Text Formatting | | | |
< < | Note: Make sure to "stick" the * _ = == signs to the words, that is, take away spaces. | > > | Note: Make sure there is no space between the text and the bold, italic, or other indicators (* _ __ = == ). | | | | | |
< < | This works, | > > | This works,
| | | | | |
< < | | > > | | | | |
< < | | > > | | | | | | |
< < | Optional spaces followed by the cells enclosed in vertical bars.
Note: | *bold* | cells are rendered as table headers.
Note: | spaced | cells are rendered center aligned.
Note: | spaced | cells are rendered right aligned.
Note: | 2 colspan || cells are rendered as multi-span columns.
Note: In case you have a long row and you want it to be more readable when you edit the table you can split the row into lines that end with a '\' backslash character.
| > > | Any number of lines of text. Each line is one row of the table consisting of one or more cells. Each cell starts and ends with a vertical bar '|'. Any spaces at the beginning of a line are ignored.
Notes: •
| *bold* | cells are displayed as table headers. •
| center-spaced | cells are displayed center aligned. •
| right-spaced | cells are displayed right aligned. •
| 2 colspan || cells are displayed as multi-span columns (i.e., a cell with no text spans a column). •
|^| cells with a caret indicate follow-up rows of multi-span rows. •
If a row contains a large amount of text, and you want it to be more readable while editing the table, split the row into multiple text lines by ending each line with a backslash character '\' . •
Table cells wrap automatically as determined by the browser. | | | |
| |
< < |
| > > |
A4-6 | four | four |
five | five |
six | six |
| | | |
| |
< < |
| > > |
A4-6 | four | four |
five | five |
six | six |
| | | |
- TWiki converts shorthand notation to XHTML 1.0 for display. To copy a fully marked-up page, simply view source in your browser and save the contents.
-
If you need to save HTML frequently, you may want to check out TWiki:Plugins/GenHTMLAddon - it will "generate a directory containing rendered versions of a set of TWiki pages together with any attached files."
-
NOTE: The opening and closing angle brackets - <...> - of an HTML tag must be on the same line, or the tag will be broken.
| |
< < |
-
- This feature allows you to enter an unclosed angle bracket - as a greater than or less than symbol - and have it automatically rendered as if you had entered its HTML character,
< , ex: a > b
| > > |
-
- This feature allows you to enter an unclosed angle bracket - as a greater than or less than symbol - and have it automatically rendered as if you had entered its HTML character,
< , ex: a < b
| |
-
-
If you're pasting in preformatted HTML text and notice problems, check the file in a text processor with no text wrap. Also, save without hard line breaks on text wrap, in your HTML editing program.
Hyperlinks | |
-
- A: The
'&' character has a special meaning in HTML, it starts a so called character entity, i.e. '©' is the © copyright character. You need to escape '&' to see it as it is, so write '&' instead of '&' . Example: Type 'This & that' to get 'This & that' .
-- MikeMannix? - 02 Dec 2001
| |
< < | -- PeterThoeny? - 01 Feb 2003 | > > | -- PeterThoeny? - 15 Jul 2003 |
|
TextFormattingRules 37 - 01 Feb 2003 - Main.PeterThoeny
|
|
TWiki Text Formatting | | External Links | |
< < |
-
http://... , https://... , ftp://... and mailto:...@... are linked automatically.
| > > |
-
http://... , https://... , ftp://... , gopher://... , news://... , file://... , telnet://... and mailto:...@... are linked automatically.
| |
- Email addresses like
name@domain.com are linked automatically.
|
|
TextFormattingRules 36 - 01 Feb 2003 - Main.PeterThoeny
|
| | |
< < | TWiki Text Formatting
Working in TWiki is as easy as typing in text - exactly like email. 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 layed out below - refer back to this page in a pop-up window from the Edit screen. | > > | TWiki Text Formatting
Working in TWiki is as easy as typing in text - exactly like email. 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 layed out below - refer back to this page in a pop-up window from the Edit screen. | |
TWiki Editing Shorthand | |
< < | | > > | | | | | | |
< < | Paragraphs:
| > > | Paragraphs:
| | Blank lines will create new paragraphs.
| | | | |
< < | Headings:
| > > | Headings:
| | At least three dashes at the beginning of a line, followed by plus signs and the heading text. One plus creates a level 1 heading (most important), two pluses a level 2 heading; the maximum is level 6. Note: A Table of Content can be created automatically with the %TOC% variable, see TWikiVariables. Any heading text after !! is excluded from the TOC; for example, write ---+!! text if you do not want to list a header in the TOC.
| | | | |
< < | Bold Text:
| > > | Bold Text:
| | Words get bold by enclosing them in * asterisks.
| | | | |
< < | Italic Text:
| > > | Italic Text:
| | Words get italic by enclosing them in _ underscores.
| | | | |
< < | Bold Italic:
| > > | Bold Italic:
| | Words get _bold italic by enclosing them in _ double-underscores.
| | | | |
< < | Fixed Font:
| > > | Fixed Font:
| | Words get shown in fixed font by enclosing them in = equal signs.
| | | | |
< < | Bold Fixed Font:
| > > | Bold Fixed Font:
| | Words get shown in bold fixed font by enclosing them in double equal signs.
| | | | |
< < | Note: Make sure to "stick" the * _ = == signs to the words, e.g. take away spaces. | > > | Note: Make sure to "stick" the * _ = == signs to the words, that is, take away spaces. | | | | | |
< < | Verbatim Mode:
Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags. Note: Use <pre> and </pre> tags instead if you want that HTML code is interpreted. Note: Each tag must be on a line by itself. | > > | Verbatim Mode:
Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags. Note: Use <pre> and </pre> tags instead if you want that HTML code is interpreted. Note: Each tag must be on a line by itself. | | | | | |
< < | Separator:
| > > | Separator:
| | At least three dashes at the beginning of a line.
| | | | |
< < | List Item:
| > > | List Item:
| | Three spaces and an asterisk.
| | | | |
< < | Nested List Item:
| > > | Nested List Item:
| | Six, nine, ... spaces and an asterisk.
| | | | |
< < | Ordered List:
| > > | Ordered List:
| | Three spaces and a number.
| | | | |
< < | Definition List:
Three spaces, the term, a colon, a space, followed by the definition.
| > > | Definition List:
Three spaces, the term, a colon, a space, followed by the definition.
| | Note: Terms with spaces are not supported. In case you do have a term with more then one word, separate the words with dashes or with the non-breaking-space entity.
| | | | |
< < | Table:
Optional spaces followed by the cells enclosed in vertical bars.
Note: | *bold* | cells are rendered as table headers.
Note: | spaced | cells are rendered center aligned.
Note: | spaced | cells are rendered right aligned.
Note: | 2 colspan || cells are rendered as multi-span columns.
Note: In case you have a long row and you want it to be more readable when you edit the table you can split the row into lines that end with a '\' backslash character.
| > > | Table:
Optional spaces followed by the cells enclosed in vertical bars.
Note: | *bold* | cells are rendered as table headers.
Note: | spaced | cells are rendered center aligned.
Note: | spaced | cells are rendered right aligned.
Note: | 2 colspan || cells are rendered as multi-span columns.
Note: In case you have a long row and you want it to be more readable when you edit the table you can split the row into lines that end with a '\' backslash character.
| | | |
| |
< < | | A4 \
| next \
| > > |
| | | |
| |
< < |
| > > |
| | | |
< < | WikiWord Links:
CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically. Note: In case you want to link to a topic in a different TWiki web write Webname.TopicName . | > > | WikiWord Links:
CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically. Note: In case you want to link to a topic in a different TWiki web write Webname.TopicName . | | | | | |
< < | Forced Links:
You can create a forced internal link by enclosing words in double square brackets. Note: Text within the brackets may contain optional spaces; the topic name is formed by capitalizing the initial letter and by removing the spaces; i.e. [[text formatting FAQ]] links to topic TextFormattingFAQ. You can also refer to a different web and use anchors. | > > | Forced Links:
You can create a forced internal link by enclosing words in double square brackets.
Note: 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. | | | | | |
< < | Specific Links:
Create a link where you can specify the link text and the link reference separately, using nested square brackets like [[reference][text]] . Internal link references (i.e. WikiSyntax) and external link references (i.e. http://TWiki.org/) are supported. The same Forced Links rules apply for internal link references. Anchor names can be added as well, like [[WebHome#MyAnchor][go home]] and [[http://www.yahoo.com/#somewhere][Yahoo!]] . | > > | Specific Links:
Create a link where you can specify the link text and the link reference separately, using nested square brackets like [[reference][text]] . Internal link references (e.g. WikiSyntax) and external link references (e.g. http://TWiki.org/) are supported.
Note: The same Forced Links rules apply for internal link references.
Note: For external link references, you can simply use a space instead of ][ to separate the link URL from the descriptive text.
Note: Anchor names can be added as well, like [[WebHome#MyAnchor][go home]] and [[http://gnu.org/#Action][GNU Action]] . | |
[[WikiSyntax][syntax]]
[[http://gnu.org][GNU]]
|
| |
> > | XML | | | |
> > | XML | | | |
< < | Easier External Links:
An easier syntax for external links is now available: [[externalURL text]] - just hit the spacebar to separate the link URL from the descriptive text, e.g. [[http://gnu.org/ GNU]] . This also supports anchors, e.g. [[http://www.yahoo.com/#somewhere Yahoo!]] .
[[http://gnu.org GNU]]
|
GNU
|
Anchors:
| | > > | Anchors:
| | You can define a link 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 disable automatic linking of WikiWords by surrounding text with <noautolink> and </noautolink> tags. Note: Each tag must be on a line by itself. Note: This also works for TWiki tables, but only if you add a blank line between the end of the table and the closing </noautolink> tag (known issue of the TablePlugin). | > > | You can disable automatic linking of WikiWords by surrounding text with <noautolink> and </noautolink> tags.
Note: Each tag must be on a line by itself.
Note: This also works for TWiki tables, but only if you add a blank line between the end of the table and the closing </noautolink> tag (known issue of the TablePlugin). | | | | | |
> > |
Mailto: Links:
To create 'mailto:' links that have more descriptive link text, specify subject lines or message bodies, or omit the email address, you can write [[mailto:user@domain descriptive text]] .
|
[[mailto:a@z.com Mail]]
[[mailto:?subject=Hi Hi]]
|
Mail
Hi
|
| |
Using HTML | |
- Email addresses like
name@domain.com are linked automatically.
| |
< < |
-
- You can also write
[[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.
| > > |
-
- You can also write
[[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 | |
-
%INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current TWiki web is the default web. Example: %INCLUDE{"TWiki.SiteMap"}%
| |
< < | | > > |
-
%SEARCH{"sushi"}% : Inline search showing the search result embedded in a topic. FormattedSearch gives you control over formatting, used to create web-based applications.
- TWikiPreferences defines site-wide variables. Among others:
- Line break: Write
%BR% to start a new line.
- Colored text: Write:
%RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors to get: Red and blue colors.
- Documentation Graphics: Write:
%H% Help, %T% Tip, %X% Alert to get: Help, Tip, Alert. For more info see TWikiDocGraphics.
| | | |
< < |
- TWikiPreferences defines site-wide variables like colors. For example, write:
%RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors to get: Red and blue colors.
| > > | | |
TWikiPlugin Formatting Extensions | |
-
- A: The
'&' character has a special meaning in HTML, it starts a so called character entity, i.e. '©' is the © copyright character. You need to escape '&' to see it as it is, so write '&' instead of '&' . Example: Type 'This & that' to get 'This & that' .
-- MikeMannix? - 02 Dec 2001
| |
< < | -- PeterThoeny? - 02 May 2002 | > > | -- PeterThoeny? - 01 Feb 2003 |
|
TextFormattingRules 35 - 03 Oct 2002 - Main.PeterThoeny
|
|
TWiki Text Formatting | | | |
< < | Prevent a Link:
| > > | Prevent a Link:
| | Prevent a WikiWord from being linked by prepending it with the <nop> tag.
| | | | |
> > |
Disable Links:
You can disable automatic linking of WikiWords by surrounding text with <noautolink> and </noautolink> tags. Note: Each tag must be on a line by itself. Note: This also works for TWiki tables, but only if you add a blank line between the end of the table and the closing </noautolink> tag (known issue of the TablePlugin).
|
<noautolink>
RedHat &
SuSE
</noautolink>
|
RedHat &
SuSE
|
| |
Using HTML |
|
TextFormattingRules 34 - 05 Jun 2002 - Main.PeterThoeny
|
|
TWiki Text Formatting | | | |
< < | At least three dashes at the beginning of a line, followed by plus signs and the heading text. One plus creates a level 1 heading (most important), two pluses a level 2 heading; the maximum is level 6. Note: A Table of Content can be created automatically with the %TOC% variable, see TWikiVariables. | > > | At least three dashes at the beginning of a line, followed by plus signs and the heading text. One plus creates a level 1 heading (most important), two pluses a level 2 heading; the maximum is level 6. Note: A Table of Content can be created automatically with the %TOC% variable, see TWikiVariables. Any heading text after !! is excluded from the TOC; for example, write ---+!! text if you do not want to list a header in the TOC. | | | | | |
< < | | > > | | | Forced Links:
You can create a forced internal link by enclosing words in double square brackets. Note: Text within the brackets may contain optional spaces; the topic name is formed by capitalizing the initial letter and by removing the spaces; i.e. [[text formatting FAQ]] links to topic TextFormattingFAQ. You can also refer to a different web and use anchors.
| | | | |
< < | | | Using HTML |
|
TextFormattingRules 33 - 02 May 2002 - Main.PeterThoeny
|
|
TWiki Text Formatting | |
-
- You can also write
[[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
Variables are names that are enclosed in percent signs % that are expanded on the fly.
-
%TOC% : Automatically generates a table of contents based on headings in a topic - see the top of this page for an example.
-
%WEB% : The current web, is TWiki.
-
%TOPIC% : The current topic name, is TextFormattingRules.
-
%ATTACHURL% : The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as %ATTACHURL%/image.gif to show the URL of the file or the image in your text.
-
%INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current TWiki web is the default web. Example: %INCLUDE{"TWiki.SiteMap"}%
- TWikiPreferences defines site-wide variables like colors. For example, write:
%RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors to get: Red and blue colors.
| | TWikiPlugin Formatting Extensions | | Check on current Plugin status and settings for this site in TWikiPreferences. | |
< < | -- MikeMannix? - 02 Dec 2001 | | | |
< < | Updated to cover TWiki:Codev/EasierExternalLinking (in the alpha release). | > > | 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: | | | |
< < | -- RichardDonkin? - 26 Mar 2002 | > > |
- Q: Text enclosed in angle brackets like
<filename> is not displayed. How can I show it as it is?
- A: The
'<' and '>' characters have a special meaning in HTML, they define HTML tags. You need to escape them, so write '<' instead of '<' , and '>' instead of '>' . Example: Type 'prog <filename>' to get 'prog <filename>' .
| | | |
< < | Latest updates to this topic are in the main TWiki, since that's got the TWikiAlphaRelease code. | > > |
- Q: Why is the
'&' character sometimes not displayed?
- A: The
'&' character has a special meaning in HTML, it starts a so called character entity, i.e. '©' is the © copyright character. You need to escape '&' to see it as it is, so write '&' instead of '&' . Example: Type 'This & that' to get 'This & that' .
| | | |
< < | -- RichardDonkin? - 05 Apr 2002 | > > | -- MikeMannix? - 02 Dec 2001
-- PeterThoeny? - 02 May 2002 |
|
TextFormattingRules 31 - 26 Mar 2002 - Main.RichardDonkin
|
|
TWiki Text Formatting | | | |
> > | Easier External Links:
An easier syntax for external links is now available: [[externalURL text]] - just hit the spacebar to separate the link URL from the descriptive text, e.g. [[http://gnu.org/ GNU]] . This also supports anchors, e.g. [[http://www.yahoo.com/#somewhere Yahoo!]] .
[[http://gnu.org GNU]]
|
GNU
|
| | | Anchors:
You can define a link 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.
| | |
- Email addresses like
name@domain.com are linked automatically.
| |
> > |
-
- You can also write
[[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.
| | TWikiPlugin Formatting Extensions | | Check on current Plugin status and settings for this site in TWikiPreferences.
-- MikeMannix? - 02 Dec 2001 | |
> > | Updated to cover TWiki:Codev/EasierExternalLinking (in the alpha release).
-- RichardDonkin? - 26 Mar 2002 |
|
TextFormattingRules 30 - 03 Dec 2001 - Main.MikeMannix
|
|
TWiki Text Formatting | | Using HTML | |
< < | You can use just about any HTML tag without a problem - however, to keep in mind: | > > | You can use just about any HTML tag without a problem - however, there are a few usability and technical considerations to keep in mind.
HTML and TWiki Usability | |
- On collaboration pages, it's preferable NOT to use HTML, and to use TWiki shorthand instead - this keeps the text uncluttered and easy to edit.
| |
< < |
-
- NOTE: TWiki converts shorthand notation to XHTML 1.0 for display. To copy a fully marked-up page, simply view source in your browser and save the contents.
- NOTE: The standard installation TWiki is compatible across a wide range of browsers and computer platforms. If this is important to you, remember that using browser-specific tags or any other mark-up that doesn't degrade well will reduce compatibility.
| > > |
-
NOTE: TWiki is designed to work with a wide range of browsers and computer platforms, holding to HTML 3.2 compatibility in the standard installation - adding raw HTML, particularly browser-specific tags (or any other mark-up that doesn't degrade well) will reduce compatibility.
TWiki HTML Rendering
- TWiki converts shorthand notation to XHTML 1.0 for display. To copy a fully marked-up page, simply view source in your browser and save the contents.
-
If you need to save HTML frequently, you may want to check out TWiki:Plugins/GenHTMLAddon - it will "generate a directory containing rendered versions of a set of TWiki pages together with any attached files."
-
NOTE: The opening and closing angle brackets - <...> - of an HTML tag must be on the same line, or the tag will be broken.
- This feature allows you to enter an unclosed angle bracket - as a greater than or less than symbol - and have it automatically rendered as if you had entered its HTML character,
< , ex: a > b
-
If you're pasting in preformatted HTML text and notice problems, check the file in a text processor with no text wrap. Also, save without hard line breaks on text wrap, in your HTML editing program.
| | Hyperlinks |
|
TextFormattingRules 29 - 02 Dec 2001 - Main.MikeMannix
|
| | |
< < | Appendix C: Text Formatting Rules | > > | TWiki Text Formatting | | Working in TWiki is as easy as typing in text - exactly like email. 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 layed out below - refer back to this page in a pop-up window from the Edit screen.
| | | |
< < | | > > | | | Forced Links:
You can create a forced internal link by enclosing words in double square brackets. Note: Text within the brackets may contain optional spaces; the topic name is formed by capitalizing the initial letter and by removing the spaces; i.e. [[text formatting FAQ]] links to topic TextFormattingFAQ. You can also refer to a different web and use anchors.
| | | | |
< < | TWiki Variables
Variables are names that are enclosed in percent signs % that are expanded on the fly.
-
%TOC% : Automatically generates a table of contents based on headings in a topic - see the top of this page for an example.
-
%WEB% : The current web, is TWiki.
-
%TOPIC% : The current topic name, is TextFormattingRules.
-
%ATTACHURL% : The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as %ATTACHURL%/image.gif to show the URL of the file or the image in your text.
-
%INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current TWiki web is the default web. Example: %INCLUDE{"TWiki.TWikiWebsTable"}%
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
<filename> is not displayed. How can I show it as it is?
- A: The
'<' and '>' characters have a special meaning in HTML, they define HTML tags. You need to escape them, so write '<' instead of '<' , and '>' instead of '>' . Example: Type 'prog <filename>' to get 'prog <filename>' .
- Q: Why is the
'&' character sometimes not displayed?
- A: The
'&' character has a special meaning in HTML, it starts a so called character entity, ex: '©' is the © copyright character. You need to escape '&' to see it as it is, so write '&' instead of '&' . Example: Type 'This & that' to get 'This & that' .
| > > | TWikiPlugin Formatting Extensions | | | |
< < | TWiki Plugins | > > | Plugins provide additional text formatting capabilities and can extend the functionality of TWiki into many other areas. For example, the optional SpreadSheetPlugin lets you create a spreadsheet with the same basic notation used in TWiki tables. | | | |
< < | Plugins provide additional text formatting capabilities and can extend the functionality of TWiki into many other areas. For example, one optional Plugin lets you create a basic spreadsheet in a similar way to tables. Available Plugins are located in the Plugins web on TWiki.org. Currently enabled plugins on here: | > > | Available Plugins are located in the Plugins web on TWiki.org. Currently enabled plugins on this TWiki installation, as listed by %PLUGINDESCRIPTIONS% : | | - SpreadSheetPlugin (any TWiki, 10197): Add spreadsheet calculation like
"$SUM( $ABOVE() )" to TWiki tables and other topic text - ActionTrackerPlugin (21 May 2007, $Rev: 14969 (20 Sep 2007) $): Adds support for action tags in topics, and automatic notification of action statuses
- AttachmentListPlugin (1.0.1, $Rev: 15921 (07 Dec 2007) $): Displays a formattable list of topic attachments, anywhere in a topic.
- BreadCrumbsPlugin (v1.00, $Rev: 13657 (08 May 2007) $): A flexible way to display breadcrumbs navigation
- CalendarPlugin (Dakar, 9113): Show a monthly calendar with highlighted events
- CommentPlugin (Dakar, 11359): Allows users to quickly post comments to a page without an edit/preview/save cycle
- CompareRevisionsAddonPlugin (Dakar, $Rev: 9808$):
- EditTablePlugin (any TWiki, 11646): Edit TWiki tables using edit fields, date pickers and drop down boxes
- FilterPlugin (1.40, $Rev: 15932 (07 Dec 2007) $): Substitute and extract information from content by using regular expressions
- FlexWebListPlugin (v1.21, $Rev: 16132 (03 Jan 2008) $): Flexible way to display hierarchical weblists
- FootNotePlugin (2.006): Footnotes are notes placed at the end of a topic.
- GluePlugin (2.00, $Rev: 15708 (23 Nov 2007) $): Enable markup to span multiple lines
- IfDefinedPlugin (v1.01, $Rev: 15157 (05 Oct 2007) $): Render content conditionally
- InterwikiPlugin (Dakar, $Rev: 11935$): Link
ExternalSite:Page text to external sites based on aliases defined in a rules topic - JQueryPlugin (v0.4, $Rev: 15608 (15 Nov 2007) $): jQuery JavaScript library for TWiki
- NatSkinPlugin (3.00-pre17, $Rev: 15581 (13 Nov 2007) $): Supplements the bare bones NatSkin theme for TWiki
- PreferencesPlugin (Dakar, 9839): Allows editing of preferences using fields predefined in a form
- RedDotPlugin (1.40, $Rev: 16137 (03 Jan 2008) $): Renders edit-links as little red dots
- RenderListPlugin (any TWiki, 1.034): Render bullet lists in a variety of formats
- SlideShowPlugin (Any TWiki, $Rev: 12847$): Create web based presentations based on topics with headings.
- SmiliesPlugin (Dakar, 8154): Render smilies as icons, like
for :-) or for = :eek:= - TablePlugin (1.020, 12339): Control attributes of tables and sorting of table columns
- TreeBrowserPlugin (v1.8): Renders a list as a collapsable/expandable tree.
- TreePlugin (1.7): Dynamic generation of TWiki topic trees
- TwistyPlugin (1.2.0, $Rev: 12154$): Twisty section JavaScript library to open/close content dynamically
- VotePlugin (1.33, $Rev: 14312 (01 Jul 2007) $): Simple way to count votes
- WysiwygPlugin (Dakar, 12422): Translator framework for Wysiwyg editors
Check on current Plugin status and settings for this site in TWikiPreferences. | |
< < | -- MikeMannix? - 02 Oct 2001
| > > | -- MikeMannix? - 02 Dec 2001 |
|
TextFormattingRules 28 - 02 Oct 2001 - Main.MikeMannix
|
| | |
< < | TWiki Text Formatting | > > | Appendix C: Text Formatting Rules | | Working in TWiki is as easy as typing in text - exactly like email. 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 layed out below - refer back to this page in a pop-up window from the Edit screen.
| |
-
- A: The
'<' and '>' characters have a special meaning in HTML, they define HTML tags. You need to escape them, so write '<' instead of '<' , and '>' instead of '>' . Example: Type 'prog <filename>' to get 'prog <filename>' .
- Q: Why is the
'&' character sometimes not displayed?
| |
< < |
-
- A: The
'&' character has a special meaning in HTML, it starts a so called character entity, i.e. '©' is the © copyright character. You need to escape '&' to see it as it is, so write '&' instead of '&' . Example: Type 'This & that' to get 'This & that' .
| > > |
-
- A: The
'&' character has a special meaning in HTML, it starts a so called character entity, ex: '©' is the © copyright character. You need to escape '&' to see it as it is, so write '&' instead of '&' . Example: Type 'This & that' to get 'This & that' .
| | TWiki Plugins | | Check on current Plugin status and settings for this site in TWikiPreferences. | |
< < | -- MikeMannix? - 30 Aug 2001 | > > | -- MikeMannix? - 02 Oct 2001
|
|
TextFormattingRules 27 - 18 Sep 2001 - Main.MikeMannix
|
|
TWiki Text Formatting | | | |
< < | | > > | | | Forced Links:
You can create a forced internal link by enclosing words in double square brackets. Note: Text within the brackets may contain optional spaces; the topic name is formed by capitalizing the initial letter and by removing the spaces; i.e. [[text formatting FAQ]] links to topic TextFormattingFAQ. You can also refer to a different web and use anchors.
| |
|
TextFormattingRules 26 - 07 Sep 2001 - Main.MikeMannix
|
|
TWiki Text Formatting
Working in TWiki is as easy as typing in text - exactly like email. 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 layed out below - refer back to this page in a pop-up window from the Edit screen. | |
> > | | | TWiki Editing Shorthand
| | | |
< < | | > > | | | Forced Links:
You can create a forced internal link by enclosing words in double square brackets. Note: Text within the brackets may contain optional spaces; the topic name is formed by capitalizing the initial letter and by removing the spaces; i.e. [[text formatting FAQ]] links to topic TextFormattingFAQ. You can also refer to a different web and use anchors.
| | | Using HTML | |
< < | Most HTML tags will work, but it's almost always preferable not to use HTML, so that the markup remains easy for everyone to edit. | > > | You can use just about any HTML tag without a problem - however, to keep in mind:
- On collaboration pages, it's preferable NOT to use HTML, and to use TWiki shorthand instead - this keeps the text uncluttered and easy to edit.
- NOTE: TWiki converts shorthand notation to XHTML 1.0 for display. To copy a fully marked-up page, simply view source in your browser and save the contents.
- NOTE: The standard installation TWiki is compatible across a wide range of browsers and computer platforms. If this is important to you, remember that using browser-specific tags or any other mark-up that doesn't degrade well will reduce compatibility.
| | Hyperlinks | |
< < | Being able to create links without any formatting required is a core TWiki feature, made possible using WikiNames. With the latest version of TWiki linking rules, a simple extension of the syntax provides an new set of flexible linking options. | > > | Being able to create links without any formatting required is a core TWiki feature, made possible with WikiWords. New TWiki linking rules are a simple extension of the syntax that provide a new set of flexible options. | | Internal Links
- GoodStyle is a WikiWord that links to the GoodStyle topic located in the current TWiki web.
| |
< < |
- NotExistingYet? is a topic waiting to be written. You could create that topic by clicking on the question mark. (Do not create that topic; you would wreck this example!)
| > > |
- 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 | | External Links
-
http://... , https://... , ftp://... and mailto:...@... are linked automatically.
| |
> > | | |
- Email addresses like
name@domain.com are linked automatically.
| |
> > | | | TWiki Variables | |
< < | Variables are names that are enclosed in percent signs; they get expanded on the fly. | > > | Variables are names that are enclosed in percent signs % that are expanded on the fly.
-
%TOC% : Automatically generates a table of contents based on headings in a topic - see the top of this page for an example.
| | | |
< < |
-
%TOC% : The table of content, is based on headings in a topic.
| |
-
%WEB% : The current web, is TWiki .
| |
> > | | |
-
%TOPIC% : The current topic name, is TextFormattingRules .
| |
> > | | |
-
%ATTACHURL% : The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as %ATTACHURL%/image.gif to show the URL of the file or the image in your text.
| |
< < |
-
%INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current TWiki web is the default web. Example: %INCLUDE{"TWiki.TWikiWebsTable"}%
- There are many more variables, see TWikiVariables.
| | | |
< < | "Gotchas" when Editing Text | > > |
-
%INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current TWiki web is the default web. Example: %INCLUDE{"TWiki.TWikiWebsTable"}%
| | | |
< < | The formatting rules are fairly simple to use and fast to type. However, there are some things to watch out for: | > > | 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
<filename> is not displayed. How can I show it as it is?
- A: The
'<' and '>' characters have a special meaning in HTML, they define HTML tags. You need to escape them, so write '<' instead of '<' , and '>' instead of '>' . Example: Type 'prog <filename>' to get 'prog <filename>' .
| |
- Q: Why is the
'&' character sometimes not displayed?
- A: The
'&' character has a special meaning in HTML, it starts a so called character entity, i.e. '©' is the © copyright character. You need to escape '&' to see it as it is, so write '&' instead of '&' . Example: Type 'This & that' to get 'This & that' .
| |
< < | | | TWiki Plugins | |
< < | Plugins provide additional text formatting rules and can extend the functionality of TWiki into many other areas. Available Plugins are located in the Plugins web. Currently enabled plugins on this site are: | > > | Plugins provide additional text formatting capabilities and can extend the functionality of TWiki into many other areas. For example, one optional Plugin lets you create a basic spreadsheet in a similar way to tables. Available Plugins are located in the Plugins web on TWiki.org. Currently enabled plugins on here: | | - SpreadSheetPlugin (any TWiki, 10197): Add spreadsheet calculation like
"$SUM( $ABOVE() )" to TWiki tables and other topic text - ActionTrackerPlugin (21 May 2007, $Rev: 14969 (20 Sep 2007) $): Adds support for action tags in topics, and automatic notification of action statuses
- AttachmentListPlugin (1.0.1, $Rev: 15921 (07 Dec 2007) $): Displays a formattable list of topic attachments, anywhere in a topic.
- BreadCrumbsPlugin (v1.00, $Rev: 13657 (08 May 2007) $): A flexible way to display breadcrumbs navigation
- CalendarPlugin (Dakar, 9113): Show a monthly calendar with highlighted events
- CommentPlugin (Dakar, 11359): Allows users to quickly post comments to a page without an edit/preview/save cycle
- CompareRevisionsAddonPlugin (Dakar, $Rev: 9808$):
- EditTablePlugin (any TWiki, 11646): Edit TWiki tables using edit fields, date pickers and drop down boxes
- FilterPlugin (1.40, $Rev: 15932 (07 Dec 2007) $): Substitute and extract information from content by using regular expressions
- FlexWebListPlugin (v1.21, $Rev: 16132 (03 Jan 2008) $): Flexible way to display hierarchical weblists
- FootNotePlugin (2.006): Footnotes are notes placed at the end of a topic.
- GluePlugin (2.00, $Rev: 15708 (23 Nov 2007) $): Enable markup to span multiple lines
- IfDefinedPlugin (v1.01, $Rev: 15157 (05 Oct 2007) $): Render content conditionally
- InterwikiPlugin (Dakar, $Rev: 11935$): Link
ExternalSite:Page text to external sites based on aliases defined in a rules topic - JQueryPlugin (v0.4, $Rev: 15608 (15 Nov 2007) $): jQuery JavaScript library for TWiki
- NatSkinPlugin (3.00-pre17, $Rev: 15581 (13 Nov 2007) $): Supplements the bare bones NatSkin theme for TWiki
- PreferencesPlugin (Dakar, 9839): Allows editing of preferences using fields predefined in a form
- RedDotPlugin (1.40, $Rev: 16137 (03 Jan 2008) $): Renders edit-links as little red dots
- RenderListPlugin (any TWiki, 1.034): Render bullet lists in a variety of formats
- SlideShowPlugin (Any TWiki, $Rev: 12847$): Create web based presentations based on topics with headings.
- SmiliesPlugin (Dakar, 8154): Render smilies as icons, like
for :-) or for = :eek:= - TablePlugin (1.020, 12339): Control attributes of tables and sorting of table columns
- TreeBrowserPlugin (v1.8): Renders a list as a collapsable/expandable tree.
- TreePlugin (1.7): Dynamic generation of TWiki topic trees
- TwistyPlugin (1.2.0, $Rev: 12154$): Twisty section JavaScript library to open/close content dynamically
- VotePlugin (1.33, $Rev: 14312 (01 Jul 2007) $): Simple way to count votes
- WysiwygPlugin (Dakar, 12422): Translator framework for Wysiwyg editors
|
|
TextFormattingRules 25 - 06 Sep 2001 - Main.MikeMannix
|
| | |
< < | It is easy to collaborate: just type in your text. You don't need to know HTML at all, though you can use it if you prefer. Links to topics will be created automatically, as long as you follow these simple Text Formatting Rules. TextFormattingFAQ has answers to frequently asked questions about text formatting. This page is also available as quick reference pop-up window from a link in the Edit screen. | > > | TWiki Text Formatting
Working in TWiki is as easy as typing in text - exactly like email. 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 layed out below - refer back to this page in a pop-up window from the Edit screen. | | | |
< < | Editing | > > | TWiki Editing Shorthand | | | |
< < | | > > | | | | | | |
< < | | |
> > | | |
|
Paragraphs:
Blank lines will create new paragraphs. |
| | | |
< < | | |
> > | | |
|
Headings:
At least three dashes at the beginning of a line, followed by plus signs and the heading text. One plus creates a level 1 heading (most important), two pluses a level 2 heading; the maximum is level 6. Note: A Table of Content can be created automatically with the %TOC% variable, see TWikiVariables. |
| | | |
< < | | |
> > | | |
|
Bold Text:
Words get bold by enclosing them in * asterisks. |
| | | |
< < | | |
> > | | |
|
Italic Text:
Words get italic by enclosing them in _ underscores. |
| | | |
< < | | |
> > | | |
|
Bold Italic:
Words get _bold italic by enclosing them in _ double-underscores. |
| | | |
< < | | |
> > | | |
|
Fixed Font:
Words get shown in fixed font by enclosing them in = equal signs. |
| | | |
< < | | |
> > | | |
|
Bold Fixed Font:
Words get shown in bold fixed font by enclosing them in double equal signs. |
| | | |
< < | | |
> > | | |
|
Note: Make sure to "stick" the * _ = == signs to the words, e.g. take away spaces.
| |
| | | |
< < | | |
> > | | |
|
Verbatim Mode:
Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags. Note: Use <pre> and </pre> tags instead if you want that HTML code is interpreted. Note: Each tag must be on a line by itself. |
| | | |
< < | | |
> > | | |
|
Separator:
At least three dashes at the beginning of a line. |
| | | |
< < | | |
> > | | |
|
List Item:
Three spaces and an asterisk. |
| | | |
< < | | |
> > | | |
|
Nested List Item:
Six, nine, ... spaces and an asterisk. |
| | | |
< < | | |
> > | | |
|
Ordered List:
Three spaces and a number. |
| | | |
< < | | |
> > | | |
|
Definition List:
Three spaces, the term, a colon, a space, followed by the definition.
|
| | | |
< < | | |
> > | | |
|
Table:
Optional spaces followed by the cells enclosed in vertical bars.
|
| |
|
|
< < | | |
> > | | |
|
WikiWord Links:
CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically. Note: In case you want to link to a topic in a different TWiki web write Webname.TopicName . |
| | | |
< < | | |
> > | | |
|
Forced Links:
You can create a forced internal link by enclosing words in double square brackets. Note: Text within the brackets may contain optional spaces; the topic name is formed by capitalizing the initial letter and by removing the spaces; i.e. [[text formatting FAQ]] links to topic TextFormattingFAQ. You can also refer to a different web and use anchors. |
| | | |
< < | | |
> > | | |
|
Specific Links:
Create a link where you can specify the link text and the link reference separately, using nested square brackets like [[reference][text]] . Internal link references (i.e. WikiSyntax) and external link references (i.e. http://TWiki.org/) are supported. The same Forced Links rules apply for internal link references. Anchor names can be added as well, like [[WebHome#MyAnchor][go home]] and [[http://www.yahoo.com/#somewhere][Yahoo!]] . |
| | | |
< < | | |
> > | | |
|
Anchors:
You can define a link 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. |
| | | |
< < | | |
> > | | |
|
Prevent a Link:
Prevent a WikiWord from being linked by prepending it with the <nop> tag. |
|
|
TextFormattingRules 24 - 06 Sep 2001 - Main.MikeMannix
|
|
It is easy to collaborate: just type in your text. You don't need to know HTML at all, though you can use it if you prefer. Links to topics will be created automatically, as long as you follow these simple Text Formatting Rules. TextFormattingFAQ has answers to frequently asked questions about text formatting. This page is also available as quick reference pop-up window from a link in the Edit screen.
Editing | |
< < | | > > | | | | | | |
> > | | | Using HTML |
|
TextFormattingRules 23 - 06 Sep 2001 - Main.MikeMannix
|
|
It is easy to collaborate: just type in your text. You don't need to know HTML at all, though you can use it if you prefer. Links to topics will be created automatically, as long as you follow these simple Text Formatting Rules. TextFormattingFAQ has answers to frequently asked questions about text formatting. This page is also available as quick reference pop-up window from a link in the Edit screen. | |
< < | Links
Being able to create links without any formatting required is a core TWiki feature, made possible using WikiNames. With the latest version of TWiki linking rules, a simple extension of the syntax provides an new set of flexible linking options.
Internal Links
- GoodStyle is a WikiWord that links to the GoodStyle topic located in the current TWiki web.
- NotExistingYet? is a topic waiting to be written. You could create that topic by clicking on the question mark. (Do not create that topic; you would wreck this example!)
External Links
-
http://... , https://... , ftp://... and mailto:...@... are linked automatically.
- Email addresses like
name@domain.com are linked automatically.
| | Editing | |
< < | | > > | | | | | Most HTML tags will work, but it's almost always preferable not to use HTML, so that the markup remains easy for everyone to edit. | |
< < | | > > | Hyperlinks
Being able to create links without any formatting required is a core TWiki feature, made possible using WikiNames. With the latest version of TWiki linking rules, a simple extension of the syntax provides an new set of flexible linking options.
Internal Links
- GoodStyle is a WikiWord that links to the GoodStyle topic located in the current TWiki web.
- NotExistingYet? is a topic waiting to be written. You could create that topic by clicking on the question mark. (Do not create that topic; you would wreck this example!)
External Links
-
http://... , https://... , ftp://... and mailto:...@... are linked automatically.
- Email addresses like
name@domain.com are linked automatically.
| |
TWiki Variables |
|
TextFormattingRules 22 - 30 Aug 2001 - Main.MikeMannix
|
| | |
< < | It is easy to collaborate; just type your text. You don't need to know HTML at all, though you can use it if you prefer. Links to topics will be created automatically, as long as you follow these simple Text Formatting Rules. TextFormattingFAQ has answers to frequently asked questions about text formatting. This page is available in a pop-up window when in Edit mode. | > > | It is easy to collaborate: just type in your text. You don't need to know HTML at all, though you can use it if you prefer. Links to topics will be created automatically, as long as you follow these simple Text Formatting Rules. TextFormattingFAQ has answers to frequently asked questions about text formatting. This page is also available as quick reference pop-up window from a link in the Edit screen. | | Links | |
< < | Being able to create links without any formating required is a core TWiki feature, made possible using WikiNames. With the latest version of TWiki linking rules, by adding a few extra symbols, you can have even more powerful linking control. | > > | Being able to create links without any formatting required is a core TWiki feature, made possible using WikiNames. With the latest version of TWiki linking rules, a simple extension of the syntax provides an new set of flexible linking options. | | | |
< < | TWiki Internal Links | > > | Internal Links | |
- GoodStyle is a WikiWord that links to the GoodStyle topic located in the current TWiki web.
- NotExistingYet? is a topic waiting to be written. You could create that topic by clicking on the question mark. (Do not create that topic; you would wreck this example!)
| |
< < | Remote Site Links | > > | External Links | |
-
http://... , https://... , ftp://... and mailto:...@... are linked automatically.
- Email addresses like
name@domain.com are linked automatically.
| | | |
< < | TWiki Plugins | > > | TWiki Plugins | | | |
< < | Plugins offer additional text formatting rules and extend the functionality of TWiki. Currently enabled plugins are: | > > | Plugins provide additional text formatting rules and can extend the functionality of TWiki into many other areas. Available Plugins are located in the Plugins web. Currently enabled plugins on this site are: | | - SpreadSheetPlugin (any TWiki, 10197): Add spreadsheet calculation like
"$SUM( $ABOVE() )" to TWiki tables and other topic text - ActionTrackerPlugin (21 May 2007, $Rev: 14969 (20 Sep 2007) $): Adds support for action tags in topics, and automatic notification of action statuses
- AttachmentListPlugin (1.0.1, $Rev: 15921 (07 Dec 2007) $): Displays a formattable list of topic attachments, anywhere in a topic.
- BreadCrumbsPlugin (v1.00, $Rev: 13657 (08 May 2007) $): A flexible way to display breadcrumbs navigation
- CalendarPlugin (Dakar, 9113): Show a monthly calendar with highlighted events
- CommentPlugin (Dakar, 11359): Allows users to quickly post comments to a page without an edit/preview/save cycle
- CompareRevisionsAddonPlugin (Dakar, $Rev: 9808$):
- EditTablePlugin (any TWiki, 11646): Edit TWiki tables using edit fields, date pickers and drop down boxes
- FilterPlugin (1.40, $Rev: 15932 (07 Dec 2007) $): Substitute and extract information from content by using regular expressions
- FlexWebListPlugin (v1.21, $Rev: 16132 (03 Jan 2008) $): Flexible way to display hierarchical weblists
- FootNotePlugin (2.006): Footnotes are notes placed at the end of a topic.
- GluePlugin (2.00, $Rev: 15708 (23 Nov 2007) $): Enable markup to span multiple lines
- IfDefinedPlugin (v1.01, $Rev: 15157 (05 Oct 2007) $): Render content conditionally
- InterwikiPlugin (Dakar, $Rev: 11935$): Link
ExternalSite:Page text to external sites based on aliases defined in a rules topic - JQueryPlugin (v0.4, $Rev: 15608 (15 Nov 2007) $): jQuery JavaScript library for TWiki
- NatSkinPlugin (3.00-pre17, $Rev: 15581 (13 Nov 2007) $): Supplements the bare bones NatSkin theme for TWiki
- PreferencesPlugin (Dakar, 9839): Allows editing of preferences using fields predefined in a form
- RedDotPlugin (1.40, $Rev: 16137 (03 Jan 2008) $): Renders edit-links as little red dots
- RenderListPlugin (any TWiki, 1.034): Render bullet lists in a variety of formats
- SlideShowPlugin (Any TWiki, $Rev: 12847$): Create web based presentations based on topics with headings.
- SmiliesPlugin (Dakar, 8154): Render smilies as icons, like
for :-) or for = :eek:= - TablePlugin (1.020, 12339): Control attributes of tables and sorting of table columns
- TreeBrowserPlugin (v1.8): Renders a list as a collapsable/expandable tree.
- TreePlugin (1.7): Dynamic generation of TWiki topic trees
- TwistyPlugin (1.2.0, $Rev: 12154$): Twisty section JavaScript library to open/close content dynamically
- VotePlugin (1.33, $Rev: 14312 (01 Jul 2007) $): Simple way to count votes
- WysiwygPlugin (Dakar, 12422): Translator framework for Wysiwyg editors
| |
< < | Learn more about plugins in TWikiPlugins and TWikiPreferences. | > > | Check on current Plugin status and settings for this site in TWikiPreferences.
-- MikeMannix? - 30 Aug 2001 |
|
TextFormattingRules 21 - 30 Aug 2001 - Main.MikeMannix
|
|
< < | It is easy to collaborate; just type your text. You don't need to know HTML at all, though you can use it if you prefer. Links to topics will be created automatically, as long as you follow these simple Text Formatting Rules. TextFormattingFAQ has answers to frequently asked questions about text formatting. | > > |
It is easy to collaborate; just type your text. You don't need to know HTML at all, though you can use it if you prefer. Links to topics will be created automatically, as long as you follow these simple Text Formatting Rules. TextFormattingFAQ has answers to frequently asked questions about text formatting. This page is available in a pop-up window when in Edit mode. | | Links | |
< < | The Collaborative Work Area is a bunch of related links that are editable through your web browser. | > > | Being able to create links without any formating required is a core TWiki feature, made possible using WikiNames. With the latest version of TWiki linking rules, by adding a few extra symbols, you can have even more powerful linking control. | | TWiki Internal Links
- GoodStyle is a WikiWord that links to the GoodStyle topic located in the current TWiki web.
- NotExistingYet? is a topic waiting to be written. You could create that topic by clicking on the question mark. (Do not create that topic; you would wreck this example!)
| |
< < | External Links | > > | Remote Site Links | |
-
http://... , https://... , ftp://... and mailto:...@... are linked automatically.
- Email addresses like
name@domain.com are linked automatically.
|
|
TextFormattingRules 20 - 11 Aug 2001 - Main.PeterThoeny
|
| It is easy to collaborate; just type your text. You don't need to know HTML at all, though you can use it if you prefer. Links to topics will be created automatically, as long as you follow these simple Text Formatting Rules. TextFormattingFAQ has answers to frequently asked questions about text formatting. | | | |
< < | Three spaces, the term, a colon, followed by the definition.
| > > | Three spaces, the term, a colon, a space, followed by the definition.
| | Note: Terms with spaces are not supported. In case you do have a term with more then one word, separate the words with dashes or with the non-breaking-space entity.
| |
|
TextFormattingRules 19 - 14 Jul 2001 - Main.PeterThoeny
|
| It is easy to collaborate; just type your text. You don't need to know HTML at all, though you can use it if you prefer. Links to topics will be created automatically, as long as you follow these simple Text Formatting Rules. TextFormattingFAQ has answers to frequently asked questions about text formatting. | | TWiki Plugins | |
< < | TWiki Plugins offer additional text formatting rules. Plugins currently installed are: | > > | Plugins offer additional text formatting rules and extend the functionality of TWiki. Currently enabled plugins are: | | | |
< < |
- DefaultPlugin? : The default plugin is used for some depreciated rendering of older TWiki versions.
-
| > > | - SpreadSheetPlugin (any TWiki, 10197): Add spreadsheet calculation like
"$SUM( $ABOVE() )" to TWiki tables and other topic text - ActionTrackerPlugin (21 May 2007, $Rev: 14969 (20 Sep 2007) $): Adds support for action tags in topics, and automatic notification of action statuses
- AttachmentListPlugin (1.0.1, $Rev: 15921 (07 Dec 2007) $): Displays a formattable list of topic attachments, anywhere in a topic.
- BreadCrumbsPlugin (v1.00, $Rev: 13657 (08 May 2007) $): A flexible way to display breadcrumbs navigation
- CalendarPlugin (Dakar, 9113): Show a monthly calendar with highlighted events
- CommentPlugin (Dakar, 11359): Allows users to quickly post comments to a page without an edit/preview/save cycle
- CompareRevisionsAddonPlugin (Dakar, $Rev: 9808$):
- EditTablePlugin (any TWiki, 11646): Edit TWiki tables using edit fields, date pickers and drop down boxes
- FilterPlugin (1.40, $Rev: 15932 (07 Dec 2007) $): Substitute and extract information from content by using regular expressions
- FlexWebListPlugin (v1.21, $Rev: 16132 (03 Jan 2008) $): Flexible way to display hierarchical weblists
- FootNotePlugin (2.006): Footnotes are notes placed at the end of a topic.
- GluePlugin (2.00, $Rev: 15708 (23 Nov 2007) $): Enable markup to span multiple lines
- IfDefinedPlugin (v1.01, $Rev: 15157 (05 Oct 2007) $): Render content conditionally
- InterwikiPlugin (Dakar, $Rev: 11935$): Link
ExternalSite:Page text to external sites based on aliases defined in a rules topic - JQueryPlugin (v0.4, $Rev: 15608 (15 Nov 2007) $): jQuery JavaScript library for TWiki
- NatSkinPlugin (3.00-pre17, $Rev: 15581 (13 Nov 2007) $): Supplements the bare bones NatSkin theme for TWiki
- PreferencesPlugin (Dakar, 9839): Allows editing of preferences using fields predefined in a form
- RedDotPlugin (1.40, $Rev: 16137 (03 Jan 2008) $): Renders edit-links as little red dots
- RenderListPlugin (any TWiki, 1.034): Render bullet lists in a variety of formats
- SlideShowPlugin (Any TWiki, $Rev: 12847$): Create web based presentations based on topics with headings.
- SmiliesPlugin (Dakar, 8154): Render smilies as icons, like
for :-) or for = :eek:= - TablePlugin (1.020, 12339): Control attributes of tables and sorting of table columns
- TreeBrowserPlugin (v1.8): Renders a list as a collapsable/expandable tree.
- TreePlugin (1.7): Dynamic generation of TWiki topic trees
- TwistyPlugin (1.2.0, $Rev: 12154$): Twisty section JavaScript library to open/close content dynamically
- VotePlugin (1.33, $Rev: 14312 (01 Jul 2007) $): Simple way to count votes
- WysiwygPlugin (Dakar, 12422): Translator framework for Wysiwyg editors
| | Learn more about plugins in TWikiPlugins and TWikiPreferences. |
|
TextFormattingRules 18 - 28 Jun 2001 - Main.PeterThoeny
|
| It is easy to collaborate; just type your text. You don't need to know HTML at all, though you can use it if you prefer. Links to topics will be created automatically, as long as you follow these simple Text Formatting Rules. TextFormattingFAQ has answers to frequently asked questions about text formatting. | |
< < | LINKS | > > |
Links | | The Collaborative Work Area is a bunch of related links that are editable through your web browser. | |
< < | The TWiki web has the following types of internal links: | > > | TWiki Internal Links | |
- GoodStyle is a WikiWord that links to the GoodStyle topic located in the current TWiki web.
- NotExistingYet? is a topic waiting to be written. You could create that topic by clicking on the question mark. (Do not create that topic; you would wreck this example!)
| |
< < | External links: | > > | External Links | |
-
http://... , https://... , ftp://... and mailto:...@... are linked automatically.
- Email addresses like
name@domain.com are linked automatically.
| |
< < | EDITING | > > | Editing | | | | | |
< < | Sushi | > > | ---++ Sushi | | | |
< < | Maguro | > > | ---+++ Maguro | | | |
< < | Sushi | > > | Sushi | | | |
< < | Maguro | > > | Maguro | | | | | |
< < | HTML | > > | Using HTML | | Most HTML tags will work, but it's almost always preferable not to use HTML, so that the markup remains easy for everyone to edit. | |
< < | | > > | | | | |
< < | WIKI VARIABLES | > > | TWiki Variables | | Variables are names that are enclosed in percent signs; they get expanded on the fly. | |
> > |
-
%TOC% : The table of content, is based on headings in a topic.
| |
-
%WEB% : The current web, is TWiki .
-
%TOPIC% : The current topic name, is TextFormattingRules .
-
%ATTACHURL% : The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as %ATTACHURL%/image.gif to show the URL of the file or the image in your text.
-
%INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current TWiki web is the default web. Example: %INCLUDE{"TWiki.TWikiWebsTable"}%
- There are many more variables, see TWikiVariables.
| |
> > | "Gotchas" when Editing Text
The formatting rules are fairly simple to use and fast to type. However, there are some things to watch out for:
- Q: Text enclosed in angle brackets like
<filename> is not displayed. How can I show it as it is?
- A: The
'<' and '>' characters have a special meaning in HTML, they define HTML tags. You need to escape them, so write '<' instead of '<' , and '>' instead of '>' . Example: Type 'prog <filename>' to get 'prog <filename>' .
- Q: Why is the
'&' character sometimes not displayed?
- A: The
'&' character has a special meaning in HTML, it starts a so called character entity, i.e. '©' is the © copyright character. You need to escape '&' to see it as it is, so write '&' instead of '&' . Example: Type 'This & that' to get 'This & that' .
| | | |
< < | TWiki PLUGINS | > > | TWiki Plugins | | TWiki Plugins offer additional text formatting rules. Plugins currently installed are: |
|
TextFormattingRules 17 - 05 Apr 2001 - Main.PeterThoeny
|
|
Table:
Optional spaces followed by the cells enclosed in vertical bars.
|
| |
< < | Note: In case you have a long row and you want it to be more readable when you edit the table you can split the row into lines that end with a '\' backslash character. | > > | Note: | *bold* | cells are rendered as table headers.
Note: | spaced | cells are rendered center aligned.
Note: | spaced | cells are rendered right aligned.
Note: | 2 colspan || cells are rendered as multi-span columns.
Note: In case you have a long row and you want it to be more readable when you edit the table you can split the row into lines that end with a '\' backslash character.
| | | |
< < |
| A3 \ | > > |
L | C | R |
A2 | 2 | 2 |
A3 | 3 | 3 |
multi span |
| A4 \ | | | next \
| | |
< < |
| A3 | > > |
L | C | R |
A2 | 2 | 2 |
A3 | 3 | 3 |
multi span |
| A4 | |
|
|
TextFormattingRules 16 - 16 Mar 2001 - Main.PeterThoeny
|
| It is easy to collaborate; just type your text. You don't need to know HTML at all, though you can use it if you prefer. Links to topics will be created automatically, as long as you follow these simple Text Formatting Rules. TextFormattingFAQ has answers to frequently asked questions about text formatting. | |
< < | LINKS | > > | LINKS | | The Collaborative Work Area is a bunch of related links that are editable through your web browser. | |
- GoodStyle is a WikiWord that links to the GoodStyle topic located in the current TWiki web.
- NotExistingYet? is a topic waiting to be written. You could create that topic by clicking on the question mark. (Do not create that topic; you would wreck this example!)
| |
< < | External links: | > > | External links: | |
-
http://... , https://... , ftp://... and mailto:...@... are linked automatically.
- Email addresses like
name@domain.com are linked automatically.
| |
< < | EDITING | > > | EDITING | | | | | |
< < | HTML | > > | HTML | | Most HTML tags will work, but it's almost always preferable not to use HTML, so that the markup remains easy for everyone to edit.
| |
< < | WIKI VARIABLES | > > | WIKI VARIABLES | | Variables are names that are enclosed in percent signs; they get expanded on the fly. | |
-
%ATTACHURL% : The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as %ATTACHURL%/image.gif to show the URL of the file or the image in your text.
-
%INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current TWiki web is the default web. Example: %INCLUDE{"TWiki.TWikiWebsTable"}%
- There are many more variables, see TWikiVariables.
| |
> > |
TWiki PLUGINS
TWiki Plugins offer additional text formatting rules. Plugins currently installed are:
- DefaultPlugin? : The default plugin is used for some depreciated rendering of older TWiki versions.
-
Learn more about plugins in TWikiPlugins and TWikiPreferences. |
|
TextFormattingRules 15 - 02 Mar 2001 - Main.PeterThoeny
|
| | |
> > | Headings:
At least three dashes at the beginning of a line, followed by plus signs and the heading text. One plus creates a level 1 heading (most important), two pluses a level 2 heading; the maximum is level 6. Note: A Table of Content can be created automatically with the %TOC% variable, see TWikiVariables.
---++ Sushi
---+++ Maguro
|
Sushi
Maguro
|
| | | Bold Text:
Words get bold by enclosing them in * asterisks.
| | | | |
< < | At least four dashes at the beginning of a line. | > > | At least three dashes at the beginning of a line. | | | | | |
< < | Create a link where you can specify the link text and the link reference separately, using nested square brackets like [[text][reference]] . Internal link references (i.e. WikiSyntax) and external link references (i.e. http://TWiki.org/) are supported. The same Forced Links rules apply for internal link references. Anchor names can be added as well, like [[go home][WebHome@MyAnchor]] and [[Yahoo!][http://www.yahoo.com/#somewhere]] . | > > | Create a link where you can specify the link text and the link reference separately, using nested square brackets like [[reference][text]] . Internal link references (i.e. WikiSyntax) and external link references (i.e. http://TWiki.org/) are supported. The same Forced Links rules apply for internal link references. Anchor names can be added as well, like [[WebHome#MyAnchor][go home]] and [[http://www.yahoo.com/#somewhere][Yahoo!]] . | | | |
< < | WikiSyntax? | > > | syntax | | | |
< < | http://gnu.org? | > > | GNU | | | |
< < | WikiSyntax? | > > | syntax | | | |
< < | http://gnu.org? | > > | GNU | | | |
< < | You can define a link 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 link 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. | | | |
< < | WebHome@NotThere? | > > | WebHome#NotThere | | | |
< < | @MyAnchor? | > > | Jump | | | |
< < | @MyAnchor To here | > > | To here | | | |
< < | WebHome@NotThere? | > > | WebHome#NotThere | | | |
< < | @MyAnchor? | > > | Jump | | | |
< < | @MyAnchor To here | > > | To here | | |
|
TextFormattingRules 14 - 25 Feb 2001 - Main.PeterThoeny
|
| | |
< < | WebNotify, | > > | WebNotify | | | |
< < | WebNotify, | > > | WebNotify | | ReadmeFirst?
Forced Links:
| | |
< < | You can create a forced internal link by enclosing words in double square brackets. Note: Text within the brackets may contain optional spaces; the topic name is formed by capitalizing the initial letter and by removing the spaces; i.e. [[text formatting FAQ]] links to topic TextFormattingFAQ. You can also refer to a different web. | > > | You can create a forced internal link by enclosing words in double square brackets. Note: Text within the brackets may contain optional spaces; the topic name is formed by capitalizing the initial letter and by removing the spaces; i.e. [[text formatting FAQ]] links to topic TextFormattingFAQ. You can also refer to a different web and use anchors. | | | |
< < | wiki syntax, | > > | wiki syntax | | | |
< < | wiki syntax, | > > | wiki syntax | | | |
> > | Specific Links:
Create a link where you can specify the link text and the link reference separately, using nested square brackets like [[text][reference]] . Internal link references (i.e. WikiSyntax) and external link references (i.e. http://TWiki.org/) are supported. The same Forced Links rules apply for internal link references. Anchor names can be added as well, like [[go home][WebHome@MyAnchor]] and [[Yahoo!][http://www.yahoo.com/#somewhere]] .
[[syntax][WikiSyntax]]
[[GNU][http://gnu.org]]
|
WikiSyntax?
http://gnu.org?
|
Anchors:
You can define a link 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.
|
[[WebHome@NotThere]]
[[Jump][@MyAnchor]]
@MyAnchor To here
|
WebHome@NotThere?
@MyAnchor?
@MyAnchor To here
|
| | | Prevent a Link:
Prevent a WikiWord from being linked by prepending it with the <nop> tag.
| |
|
TextFormattingRules 13 - 10 Feb 2001 - Main.PeterThoeny
|
| | |
< < | Optional spaces followed by the cells enclosed in vertical bars. | > > | Optional spaces followed by the cells enclosed in vertical bars.
Note: In case you have a long row and you want it to be more readable when you edit the table you can split the row into lines that end with a '\' backslash character. | |
| A1 | B1 | C1 |
| A2 | B2 | C2 |
|
| |
> > | | A3 \
| next \
| |
|
| |
> > |
| | | | | |
< < |
Disable Links:
You can disable automatic linking of WikiWords by surround text with <noautolink> and </noautolink> tags. Note: Each tag must be on a line by itself.
|
<noautolink>
RedHat &
SuSE
</noautolink>
|
RedHat &
SuSE
|
| | |
|
TextFormattingRules 12 - 01 Feb 2001 - Main.PeterThoeny
|
| EDITING | |
< < |
- CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically. In case you want to link to a topic in a different TWiki web write
Web.TopicName , i.e. write Know.ReadmeFirst to link to ReadmeFirst? located in the Know web.
- You can create a forced internal link by enclosing words in double square brackets, i.e. write
[[text formatting FAQ]] to get text formatting FAQ that links to topic TextFormattingFAQ. Text within the brackets may contain optional spaces; the topic name is formed by capitalizing the initial letter and by removing the spaces. You can also refer to a different web, i.e. [[Main.TWiki users]] points to TWikiUsers in the Main web.
- Blank lines will create new paragraphs.
- Words get bold by enclosing them in * asterisks
- Words get italic by enclosing them in _ underscores
- Words get bold italic by enclosing them in __ double-underscores
- Words get shown in
fixed font by enclosing them in = equal signs
- Words get shown in
bold fixed font by enclosing them in == double equal signs
- Note for bold , italic , bold italic and
fixed font text:
- Make sure to "stick" the
* _ = signs to the characters, e.g.
- This works
- _This does not get italic because there is a space between the last word and the underline character _
- Example text to enter:
- Writing *bold text* , _italic text_ and =fixed== monospaced text
- Example text gets rendered as:
- Writing bold text , italic text and
fixed= monospaced text
- Separator: at least four dashes at the beginning of a line: <-------->
- List Item: 3 spaces and an asterisk: < *>
- Nested Item: 6 spaces and an asterisk: < *>
- Ordered List: 3 spaces and a number: < 1>
- Definition: 3 spaces, the term, a colon, followed by the definition: < term: definition>
Note that terms with spaces are not supported. In case you do have a term with more then one word, separate the words with dashes or with the non-breaking-space entity, i.e. write Character Set: to get Character Set: .
- Table: Optional spaces followed by the cells enclosed in vertical bars: < | cell 1 | cell 2 | cell 3 | ... |>
| > > |
Formatting Command:
|
Example: You write:
|
You get:
|
Paragraphs:
Blank lines will create new paragraphs.
|
1st paragraph
2nd paragraph
|
1st paragraph
2nd paragraph
|
Bold Text:
Words get bold by enclosing them in * asterisks.
|
*Bold*
|
Bold
|
Italic Text:
Words get italic by enclosing them in _ underscores.
|
_Italic_
|
Italic
|
Bold Italic:
Words get _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
|
Note: Make sure to "stick" the * _ = == signs to the words, e.g. take away spaces.
|
_This works_,
_this not _
|
This works,
_this not _
|
Verbatim Mode:
Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags. Note: Use <pre> and </pre> tags instead if you want that HTML code is interpreted. Note: Each tag must be on a line by itself.
|
<verbatim>
class CatAnimal {
void purr() {
<code here>
}
}
</verbatim>
|
class CatAnimal {
void purr() {
<code here>
}
}
|
Separator:
At least four dashes at the beginning of a line.
|
-------
|
|
List Item:
Three spaces and an asterisk.
|
* bullet item
|
|
Nested List Item:
Six, nine, ... spaces and an asterisk.
|
* nested stuff
|
|
Ordered List:
Three spaces and a number.
|
1 Sushi
1 Dim Sum
|
- Sushi
- Dim Sum
|
Definition List:
Three spaces, the term, a colon, followed by the definition.
Note: Terms with spaces are not supported. In case you do have a term with more then one word, separate the words with dashes or with the non-breaking-space entity.
|
Sushi: Japan
Dim Sum: S.F.
|
- Sushi
- Japan
- Dim Sum
- S.F.
|
Table:
Optional spaces followed by the cells enclosed in vertical bars.
|
| A1 | B1 | C1 |
| A2 | B2 | C2 |
|
|
WikiWord Links:
CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically. Note: In case you want to link to a topic in a different TWiki web write Webname.TopicName .
|
WebNotify,
Know.ReadmeFirst
|
WebNotify,
ReadmeFirst?
|
Forced Links:
You can create a forced internal link by enclosing words in double square brackets. Note: Text within the brackets may contain optional spaces; the topic name is formed by capitalizing the initial letter and by removing the spaces; i.e. [[text formatting FAQ]] links to topic TextFormattingFAQ. You can also refer to a different web.
|
[[wiki syntax]],
[[Main.TWiki users]]
|
wiki syntax,
Main.TWiki users
|
Prevent a Link:
Prevent a WikiWord from being linked by prepending it with the <nop> tag.
|
<nop>SunOS
|
SunOS
|
Disable Links:
You can disable automatic linking of WikiWords by surround text with <noautolink> and </noautolink> tags. Note: Each tag must be on a line by itself.
|
<noautolink>
RedHat &
SuSE
</noautolink>
|
RedHat &
SuSE
|
| |
HTML |
|
TextFormattingRules 11 - 21 Jan 2001 - Main.PeterThoeny
|
|
- Words get bold by enclosing them in * asterisks
- Words get italic by enclosing them in _ underscores
- Words get bold italic by enclosing them in __ double-underscores
| |
< < |
- Words get shown in
fixed font by enclosing them in = equal signs
| > > |
- Words get shown in
fixed font by enclosing them in = equal signs
- Words get shown in
bold fixed font by enclosing them in == double equal signs
| |
- Note for bold , italic , bold italic and
fixed font text:
- Make sure to "stick" the
* _ = signs to the characters, e.g.
|
|
TextFormattingRules 10 - 12 Dec 2000 - Main.PeterThoeny
|
|
- List Item: 3 spaces and an asterisk: < *>
- Nested Item: 6 spaces and an asterisk: < *>
- Ordered List: 3 spaces and a number: < 1>
| |
< < |
- Definition: 3 spaces, the term, a colon, followed by the definition.
| > > |
- Definition: 3 spaces, the term, a colon, followed by the definition: < term: definition>
Note that terms with spaces are not supported. In case you do have a term with more then one word, separate the words with dashes or with the non-breaking-space entity, i.e. write Character Set: to get Character Set: .
| |
- Table: Optional spaces followed by the cells enclosed in vertical bars: < | cell 1 | cell 2 | cell 3 | ... |>
|
|
TextFormattingRules 9 - 10 Dec 2000 - Main.PeterThoeny
|
|
< < | It is easy to collaborate, just type your text. You don't need to know HTML at all, though you can use it if you prefer. Links to topics will be created automatically as long as you follow these simple Text Formatting Rules. TextFormattingFAQ has answers to frequently asked questions about text formatting. | > > | It is easy to collaborate; just type your text. You don't need to know HTML at all, though you can use it if you prefer. Links to topics will be created automatically, as long as you follow these simple Text Formatting Rules. TextFormattingFAQ has answers to frequently asked questions about text formatting. | | LINKS | | The TWiki web has the following types of internal links:
- GoodStyle is a WikiWord that links to the GoodStyle topic located in the current TWiki web.
| |
< < |
- NotExistingYet? is a topic waiting to be written. You could create that topic by clicking on the question mark. (Do not create that topic, you would wreck this example!)
| > > |
- NotExistingYet? is a topic waiting to be written. You could create that topic by clicking on the question mark. (Do not create that topic; you would wreck this example!)
| | External links: |
|
TextFormattingRules 8 - 11 Nov 2000 - Main.PeterThoeny
|
| The Collaborative Work Area is a bunch of related links that are editable through your web browser. | |
< < | The TWiki web has the following types of internal links: | > > | The TWiki web has the following types of internal links: | |
- GoodStyle is a WikiWord that links to the GoodStyle topic located in the current TWiki web.
- NotExistingYet? is a topic waiting to be written. You could create that topic by clicking on the question mark. (Do not create that topic, you would wreck this example!)
External links: | |
< < |
-
http://... , https://... , ftp://... and mailto:...@... are linked automatically.
- Email addresses like
name@domain.com are linked automatically.
| > > |
-
http://... , https://... , ftp://... and mailto:...@... are linked automatically.
- Email addresses like
name@domain.com are linked automatically.
| | EDITING
- CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically. In case you want to link to a topic in a different TWiki web write
Web.TopicName , i.e. write Know.ReadmeFirst to link to ReadmeFirst? located in the Know web.
| |
< < |
- You can create a forced internal link by enclosing words in double square brackets, i.e. write
[[text formatting FAQ]] to get text formatting FAQ that links to topic TextFormattingFAQ. Text within the brackets may contain optional spaces; the topic name is formed by capitalizing the initial letter and by removing the spaces. You can also refer to a different web, i.e. [[Main.TWiki users]] points to TWikiUsers in the Main web.
| > > |
- You can create a forced internal link by enclosing words in double square brackets, i.e. write
[[text formatting FAQ]] to get text formatting FAQ that links to topic TextFormattingFAQ. Text within the brackets may contain optional spaces; the topic name is formed by capitalizing the initial letter and by removing the spaces. You can also refer to a different web, i.e. [[Main.TWiki users]] points to TWikiUsers in the Main web.
| |
- Blank lines will create new paragraphs.
- Words get bold by enclosing them in * asterisks
- Words get italic by enclosing them in _ underscores
| |
-
%WEB% : The current web, is TWiki .
-
%TOPIC% : The current topic name, is TextFormattingRules .
-
%ATTACHURL% : The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as %ATTACHURL%/image.gif to show the URL of the file or the image in your text.
| |
< < |
-
%INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current TWiki web is the default web. Example: %INCLUDE{"TWiki.TWikiWebsTable"}%
| > > |
-
%INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current TWiki web is the default web. Example: %INCLUDE{"TWiki.TWikiWebsTable"}%
| | |
|
TextFormattingRules 7 - 01 Nov 2000 - Main.PeterThoeny
|
| The TWiki web has the following types of internal links: | |
< < |
- GoodStyle is a topic that is part of the current TWiki web.
| > > |
- GoodStyle is a WikiWord that links to the GoodStyle topic located in the current TWiki web.
| |
- NotExistingYet? is a topic waiting to be written. You could create that topic by clicking on the question mark. (Do not create that topic, you would wreck this example!)
| |
< < |
- ReadmeFirst? is a topic in a different TWiki web. (You write it as Web.TopicName , but it will show up as TopicName )
- You can create a forced internal link by enclosing words in double square brackets, i.e. write
[[text formatting FAQ]] to get text formatting FAQ that links to topic TextFormattingFAQ. Text within the brackets may contain optional spaces. You can also refer to a different web, i.e. [[Main.TWiki users]] points to TWikiUsers in the Main web.
| | External links: | | EDITING | |
< < |
- CapitalizedWordsStuckTogether will produce a link automatically.
| > > |
- CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically. In case you want to link to a topic in a different TWiki web write
Web.TopicName , i.e. write Know.ReadmeFirst to link to ReadmeFirst? located in the Know web.
- You can create a forced internal link by enclosing words in double square brackets, i.e. write
[[text formatting FAQ]] to get text formatting FAQ that links to topic TextFormattingFAQ. Text within the brackets may contain optional spaces; the topic name is formed by capitalizing the initial letter and by removing the spaces. You can also refer to a different web, i.e. [[Main.TWiki users]] points to TWikiUsers in the Main web.
| |
- Blank lines will create new paragraphs.
- Words get bold by enclosing them in * asterisks
- Words get italic by enclosing them in _ underscores
|
|
TextFormattingRules 6 - 19 Sep 2000 - Main.PeterThoeny
|
| The Collaborative Work Area is a bunch of related links that are editable through your web browser. | |
< < | The TWiki web has the following types of internal links: | > > | The TWiki web has the following types of internal links: | |
- GoodStyle is a topic that is part of the current TWiki web.
- NotExistingYet? is a topic waiting to be written. You could create that topic by clicking on the question mark. (Do not create that topic, you would wreck this example!)
- ReadmeFirst? is a topic in a different TWiki web. (You write it as Web.TopicName , but it will show up as TopicName )
| |
> > |
- You can create a forced internal link by enclosing words in double square brackets, i.e. write
[[text formatting FAQ]] to get text formatting FAQ that links to topic TextFormattingFAQ. Text within the brackets may contain optional spaces. You can also refer to a different web, i.e. [[Main.TWiki users]] points to TWikiUsers in the Main web.
| | | |
< < | External links: | > > | External links: | |
-
http://... , https://... , ftp://... and mailto:...@... are linked automatically.
- Email addresses like
name@domain.com are linked automatically.
|
|
TextFormattingRules 5 - 18 Aug 2000 - Main.PeterThoeny
|
| EDITING | |
< < |
- CapitalizedWordsStickedTogether? will produce a link automatically.
| > > |
- CapitalizedWordsStuckTogether will produce a link automatically.
| |
- Blank lines will create new paragraphs.
- Words get bold by enclosing them in * asterisks
- Words get italic by enclosing them in _ underscores
| |
-
-
- Writing *bold text* , _italic text_ and =fixed== monospaced text
- Example text gets rendered as:
- Writing bold text , italic text and
fixed= monospaced text
| |
< < |
- Separator: -------- (at the beginning of a line)
- List Item: <3spaces>*
- Nested Item: <6spaces>*
- Ordered List: <3spaces><number>.
- Definition: <3spaces><term>:<definition>.
- Table: <optional spaces>| cell 1 | cell 2 | cell 3 | ... |
| > > |
- Separator: at least four dashes at the beginning of a line: <-------->
- List Item: 3 spaces and an asterisk: < *>
- Nested Item: 6 spaces and an asterisk: < *>
- Ordered List: 3 spaces and a number: < 1>
- Definition: 3 spaces, the term, a colon, followed by the definition.
- Table: Optional spaces followed by the cells enclosed in vertical bars: < | cell 1 | cell 2 | cell 3 | ... |>
| | | |
< < | EXTRAS | > > | HTML
Most HTML tags will work, but it's almost always preferable not to use HTML, so that the markup remains easy for everyone to edit. | | | |
< < |
- Most HTML tags will work.
| |
WIKI VARIABLES | |
< < | Variables are names enclosed in percent signs that gets expanded on the fly. | > > | Variables are names that are enclosed in percent signs; they get expanded on the fly. | |
-
%WEB% : The current web, is TWiki .
-
%TOPIC% : The current topic name, is TextFormattingRules .
-
%ATTACHURL% : The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as %ATTACHURL%/image.gif to show the URL of the file or the image in your text.
| |
< < |
-
%INCLUDE{"file.ext"}% : Server side include, includes the text of a file. The default directory is the current Wiki web. Example: %INCLUDE{"Know/TopicName.txt"}%
| > > |
-
%INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current TWiki web is the default web. Example: %INCLUDE{"TWiki.TWikiWebsTable"}%
| | |
|
TextFormattingRules 4 - 28 Feb 2000 - Main.PeterThoeny
|
| WIKI VARIABLES | |
< < | TWiki Variables
Special text strings expand on the fly to display user data or system info
TWikiVariables are text strings - %VARIABLE% or %VARIABLE{ parameter="value" }% - that expand into content whenever a topic is rendered for viewing. There are two types of variables:
- Preferences variables: Can be defined and changed by the user
- Predefined variables: Defined by the TWiki system or by Plugins (for example, the SpreadSheetPlugin introduces a
%CALC{}% variable)
Using Variables
To use a variable type its name. For example,
- type
%T% to get (a preferences variable)
- type
%TOPIC% to get TWikiVariables (a predefined variable)
- type
%CALC{ "$UPPER(Text)" }% to get TEXT (a variable defined by Plugin)
Note:
- To leave a variable unexpanded, precede it with an exclamation point, e.g. type
!%TOPIC% to get %TOPIC%
- Variables are expanded relative to the topic they are used in, not the topic they are defined in
- Type
%ALLVARIABLES% to get a full listing of all variables defined for a particular topic
Variable Names
Variable names must start with a letter. The following characters can be letters, numbers and the underscore '_'. You can use both upper-case and lower-case letters and you can mix the characteres. E.g. %MYVAR% , %MyVar% , %My2ndVar% , and %My_Var% are all valid variable names. Variables are case sensitive. %MyVAR% and %MYVAR% are not the same variable.
By convention all settings, predefined variables and variables used by plugins are always UPPER-CASE.
Preferences Variables
Unlike predefined variables, preferences variables can be defined by the user in various places.
Setting Preferences Variables
You can set variables in all the following places:
- local site level in TWiki.TWikiPreferences
- plugin topics (see TWikiPlugins)
- local site level in Main.TWikiPreferences
- user level in individual user topics in Main web
- web level in WebPreferences of each web
- topic level in topics in webs
- session variables (if sessions are enabled)
Settings at higher-numbered levels override settings of the same variable at lower numbered levels, unless the variable was included in the setting of FINALPREFERENCES at a lower-numbered level, in which case it is locked at the value it has at that level.
The syntax for setting Variables is the same anywhere in TWiki (on its own TWiki bullet line, including nested bullets): [multiple of 3 spaces] * [space] Set [space] VARIABLENAME [space] = [space] value
Examples:
Spaces between the = sign and the value will be ignored. You can split a value over several lines by indenting following lines with spaces - as long as you don't try to use * as the first character on the following line.
Example:
* Set VARIABLENAME = value starts here
and continues here
Whatever you include in your Variable will be expanded on display, exactly as if it had been entered directly.
Example: Create a custom logo variable
- To place a logo anywhere in a web by typing
%MYLOGO% , define the Variable on the web's WebPreferences topic, and upload a logo file, ex: mylogo.gif . You can upload by attaching the file to WebPreferences, or, to avoid clutter, to any other topic in the same web, e.g. LogoTopic . Sample variable setting in WebPreferences:
-
Set MYLOGO = %PUBURL%/%WEB%/LogoTopic/mylogo.gif
You can also set preferences variables on a topic by clicking the link Edit topic preference settings under More topic actions . Preferences set in this manner are not visible in the topic text, but take effect nevertheless.
Access Control Variables
These are special types of preferences variables to control access to content. TWikiAccessControl explains these security settings in detail.
Local values for variables
Certain topics (a users home topic, web site and default preferences topics) have a problem; variables defined in those topics can have two meanings. For example, consider a user topic. A user may want to use a double-height edit box when they are editing their home topic - but only when editing their home topic. The rest of the time, they want to have a normal edit box. This separation is achieved using Local in place of Set in the variable definition. For example, if the user sets the following in their home topic:
* Set EDITBOXHEIGHT = 10
* Local EDITBOXHEIGHT = 20
Then when they are editing any other topic, they will get a 10 high edit box. However when they are editing their home topic, they will get a 20 high edit box.
Local can be used wherever a preference needs to take a different value depending on where the current operation is being performed.
Use this powerful feature with great care! %ALLVARIABLES% can be used to get a listing of the values of all variables in their evaluation order, so you can see variable scope if you get confused.
Frequently Used Preferences Variables
The following preferences variables are frequently used. They are defined in TWikiPreferences#Miscellaneous_Settings:
-
%BR% - line break
-
%BULLET% - bullet sign
-
%BB% - line break and bullet combined
-
%BB2% - indented line break and bullet
-
%RED% text %ENDCOLOR% - colored text (also %YELLOW% , %ORANGE% , %PINK% , %PURPLE% , %TEAL% , %NAVY% , %BLUE% , %AQUA% , %LIME% , %GREEN% , %OLIVE% , %MAROON% , %BROWN% , %BLACK% , %GRAY% , %SILVER% , %WHITE% )
-
%H% - Help icon
-
%I% - Idea icon
-
%M% - Moved to icon
-
%N% - New icon
-
%P% - Refactor icon
-
%Q% - Question icon
-
%S% - Pick icon
-
%T% - Tip icon
-
%U% - Updated icon
-
%X% - Alert icon
-
%Y% - Done icon
There are additional useful preferences variables defined in TWikiPreferences, in Main.TWikiPreferences, and in WebPreferences of every web.
Predefined Variables
Most predefined variables return values that were either set in the configuration when TWiki was installed, or taken from server info (such as current username, or date and time). Some, like %SEARCH% , are powerful and general tools.
-
Predefined variables can be overridden by preferences variables
-
Plugins may extend the set of predefined variables (see individual Plugins topics for details)
-
Take the time to thoroughly read through ALL preference variables. If you actively configure your site, review variables periodically. They cover a wide range of functions, and it can be easy to miss the one perfect variable for something you have in mind. For example, see %INCLUDINGTOPIC% , %INCLUDE% , and the mighty %SEARCH% .
This version of TWiki - TWiki-4.1.2, Sat, 03 Mar 2007, build 13046 - predefines the following variables:
ACTIVATEDPLUGINS -- list of currently activated plugins
- Syntax:
%ACTIVATEDPLUGINS%
- Expands to: SpreadSheetPlugin, ActionTrackerPlugin, AttachmentListPlugin, BreadCrumbsPlugin, CalendarPlugin, CommentPlugin, CompareRevisionsAddonPlugin, EditTablePlugin, FilterPlugin, FlexWebListPlugin, FootNotePlugin, GluePlugin, IfDefinedPlugin, InterwikiPlugin, JQueryPlugin, NatSkinPlugin, PreferencesPlugin, RedDotPlugin, RenderListPlugin, SlideShowPlugin, SmiliesPlugin, TablePlugin, TreeBrowserPlugin, TreePlugin, TwistyPlugin, VotePlugin, WysiwygPlugin
- Related: PLUGINDESCRIPTIONS, FAILEDPLUGINS, PLUGINVERSION
ALLVARIABLES -- list of currently defined TWikiVariables
- Syntax:
%ALLVARIABLES%
- Expands to: a table showing all defined TWikiVariables in the current context
AQUA -- start aqua colored text
-
AQUA is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
- Syntax:
%AQUA% aqua text %ENDCOLOR%
- Expands to: aqua text
- Note:
%<color>% text must end with %ENDCOLOR% . If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR% , e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR% .
- Related: ENDCOLOR, TWikiPreferences, StandardColors
ATTACHURL -- full URL for attachments in the current topic
ATTACHURLPATH -- path of the attachment URL of the current topic
AUTHREALM -- authentication realm
BASETOPIC -- base topic where an INCLUDE started
- The name of the topic where a single or nested INCLUDE started - same as
%TOPIC% if there is no INCLUDE
- Syntax:
%BASETOPIC%
- Related: BASEWEB, INCLUDINGTOPIC, INCLUDE, TOPIC
BASEWEB -- base web where an INCLUDE started
- The web name where the includes started, e.g. the web of the first topic of nested includes. Same as
%WEB% in case there is no include.
- Syntax:
%BASEWEB%
- Related: BASETOPIC, INCLUDINGWEB, INCLUDE, WEB
BB -- bullet with line break
BB2 -- level 2 bullet with line break
BB3 -- level 3 bullet with line break
BB4 -- level 4 bullet with line break
BLACK -- start black colored text
-
BLACK is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
- Syntax:
%BLACK% black text %ENDCOLOR%
- Expands to: black text
- Note:
%<color>% text must end with %ENDCOLOR% . If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR% , e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR% .
- Related: ENDCOLOR, TWikiPreferences, StandardColors
BLUE -- start blue colored text
-
BLUE is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
- Syntax:
%BLUE% blue text %ENDCOLOR%
- Expands to: blue text
- Note:
%<color>% text must end with %ENDCOLOR% . If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR% , e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR% .
- Related: ENDCOLOR, TWikiPreferences, StandardColors
BR -- line break
BROWN -- start brown colored text
-
BROWN is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
- Syntax:
%BROWN% brown text %ENDCOLOR%
- Expands to: brown text
- Note:
%<color>% text must end with %ENDCOLOR% . If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR% , e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR% .
- Related: ENDCOLOR, TWikiPreferences, StandardColors
BULLET -- bullet character
DATE -- signature format date
DISPLAYTIME -- display time
DISPLAYTIME{"format"} -- formatted display time
- Formatted time - either GMT or Local server time, depending on setting in configure. Same format qualifiers as
%GMTIME%
- Syntax:
%DISPLAYTIME{"format"}%
- Example:
%DISPLAYTIME{"$hou:$min"}% expands to 01:40
- Related: DISPLAYTIME, GMTIME, SERVERTIME
ENCODE{"string"} -- encodes a string to HTML entities
- Encode "special" characters to HTML numeric entities. Encoded characters are:
- all non-printable ASCII characters below space, except newline (
"\n" ) and linefeed ("\r" )
- HTML special characters
"<" , ">" , "&" , single quote (' ) and double quote (" )
- TWiki special characters
"%" , "[" , "]" , "@" , "_" , "*" , "=" and "|"
- Syntax:
%ENCODE{"string"}%
- Supported parameters:
Parameter: | Description: | Default: | "string" | String to encode | required (can be empty) | type="entity" | Encode special characters into HTML entities, like a double quote into " . Does not encode \n or \r . | type="url" | type="html" | As type="entity" except it also encodes \n and \r | type="url" | type="quote" | Escape double quotes with backslashes (\" ), does not change other characters | type="url" | type="url" | Encode special characters for URL parameter use, like a double quote into %22 | (this is the default) |
- Example:
%ENCODE{"spaced name"}% expands to spaced%20name
-
Note: Values of HTML input fields must be entity encoded. Example: <input type="text" name="address" value="%ENCODE{ "any text" type="entity" }%" />
-
Note: Double quotes in strings must be escaped when passed into other TWiki variables. Example: %SEARCH{ "%ENCODE{ "string with "quotes"" type="quotes" }%" noheader="on" }%
ENDCOLOR -- end colored text
-
ENDCOLOR is a rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
- Syntax:
%RED% red text %ENDCOLOR%
- Expands to: red text
- Note:
%<color>% text must end with %ENDCOLOR% . If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR% , e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR% .
- Related: VarAQUA, VarBLACK, VarBLUE, VarBROWN, VarGRAY, VarGREEN, VarLIME, VarMAROON, VarNAVY, VarOLIVE, VarORANGE, VarPINK, VarPURPLE, VarRED, VarSILVER, VarTEAL, VarWHITE, VarYELLOW, TWikiPreferences, StandardColors
ENDSECTION{"name"} -- marks the end of a named section within a topic
- Syntax:
%ENDSECTION{"name"}%
- Syntax:
%ENDSECTION{type="include"}%
- Supported parameter:
Parameter: | Description: | "name" | Name of the section. | type="..." | Type of the section being terminated; supported types "section" , "include" , "templateonly" . |
- If the
STARTSECTION is named, the corresponding ENDSECTION must also be named with the same name. If the STARTSECTION specifies a type, then the corresponding ENDSECTION must also specify the same type. If the section is unnamed, ENDSECTION will match with the nearest unnamed %STARTSECTION% of the same type above it.
- Related: STARTSECTION
FAILEDPLUGINS -- debugging for plugins that failed to load, and handler list
FORMFIELD{"fieldname"} -- renders a field in the form attached to some topic
- Syntax:
%FORMFIELD{"fieldname"}%
- Supported parameters:
Parameter: | Description: | Default: | "fieldname" | The name of a TWiki form field | required | topic="..." | Topic where form data is located. May be of the form Web.TopicName | Current topic | format="..." | Format string. $value expands to the field value, and $title expands to the field title | "$value" | default="..." | Text shown when no value is defined for the field | "" | alttext="..." | Text shown when field is not found in the form | "" |
- Example:
%FORMFIELD{"ProjectName" topic="Projects.SushiProject" default="(not set)" alttext="ProjectName field found"}%
- Related: SEARCH
GMTIME -- GM time
GMTIME{"format"} -- formatted GM time
- Syntax:
%GMTIME{"format"}%
- Supported variables:
Variable: | Unit: | Example | $seconds | seconds | 59 | $minutes | minutes | 59 | $hours | hours | 23 | $day | day of month | 31 | $wday | day of the Week (Sun, Mon, Tue, Wed, Thu, Fri, Sat) | Thu | $dow | day of the week (Sun = 0) | 2 | $week | number of week in year (ISO 8601) | 34 | $month | month in ISO format | Dec | $mo | 2 digit month | 12 | $year | 4 digit year | 1999 | $ye | 2 digit year | 99 | $tz | either "GMT" (if set to gmtime), or "Local" (if set to servertime) | GMT | $iso | ISO format timestamp | 2024-09-01T01:40:52Z | $rcs | RCS format timestamp | 2024/09/01 01:40:52 | $http | E-mail & http format timestamp | Sun, 01 Sep 2024 01:40:52 GMT | $epoch | Number of seconds since 00:00 on 1st January, 1970 | 1725154852 |
- Variables can be shortened to 3 characters
- Example:
%GMTIME{"$day $month, $year - $hour:$min:$sec"}% expands to 01 Sep, 2024 - 01:40:52
-
Note: When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TWikiTemplates#TemplateTopicsVars for details.
- Related: DISPLAYTIME, GMTIME, REVINFO, SERVERTIME
GRAY -- start gray colored text
-
GRAY is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
- Syntax:
%GRAY% gray text %ENDCOLOR%
- Expands to: gray text
- Note:
%<color>% text must end with %ENDCOLOR% . If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR% , e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR% .
- Related: ENDCOLOR, TWikiPreferences, StandardColors
GREEN -- start green colored text
-
GREEN is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
- Syntax:
%GREEN% green text %ENDCOLOR%
- Expands to: green text
- Note:
%<color>% text must end with %ENDCOLOR% . If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR% , e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR% .
- Related: ENDCOLOR, TWikiPreferences, StandardColors
GROUPS -- a formatted list of groups
H -- help icon
- Type: Preference variable - TWikiRenderingShortcut.
- Current value: H =
- Related: I, ICON, M, N, P, Q, S, T, U, X, Y
HOMETOPIC -- home topic in each web
HTTP -- get HTTP headers
HTTP_HOST -- environment variable
HTTPS -- get HTTPS headers
- The same as
%HTTP% but operates on the HTTPS environment variables present when the SSL protocol is in effect. Can be used to determine whether SSL is turned on.
- Syntax:
%HTTPS%
- Syntax:
%HTTPS{"Header-name"}%
- Related: HTTP, REMOTE_ADDR, REMOTE_PORT, REMOTE_USER
I -- idea icon
- Type: Preference variable - TWikiRenderingShortcut.
- Current value: I =
- Related: H, ICON, M, N, P, Q, S, T, U, X, Y
ICON{"name"} -- small documentation graphic or icon of common attachment types
- Generates the HTML img tag of a small graphic image attached to TWikiDocGraphics. Images typically have a 16x16 pixel size. You can select a specific image by name, or you can give a full filename, in which case the type of the file will be used to select one of a collection of common file type icons.
- Syntax:
%ICON{"name"}%
- Examples:
-
%ICON{"flag-gray"}% returns
-
%ICON{"pdf"}% returns
-
%ICON{"smile.pdf"}% returns
-
%ICON{"/dont/you/dare/smile.pdf"}% returns
-
%ICON{"http://twiki.org/doc/xhtml.xsl"}% returns
- Graphic samples:
arrowbright , bubble , choice-yes , hand
- File type samples:
bmp , doc , gif , hlp , html , mp3 , pdf , ppt , txt , xls , xml , zip
- Related: ICONURL, ICONURLPATH, TWikiPreferences, FileAttachments, TWikiDocGraphics
ICONURL{"name"} -- URL of small documentation graphic or icon
- Generates the full URL of a TWikiDocGraphics image, which TWiki renders as an image. The related
%ICON{"name"}% generates the full HTML img tag. Specify image name or full filename (see ICON for details on filenames.)
- Syntax:
%ICONURL{"name"}%
- Examples:
-
%ICONURL{"arrowbright"}% returns https://moglen.law.columbia.edu/twiki/pub/TWiki/TWikiDocGraphics/arrowbright.gif
-
%ICONURL{"novel.pdf"}% returns https://moglen.law.columbia.edu/twiki/pub/TWiki/TWikiDocGraphics/pdf.gif
-
%ICONURL{"/queen/boheme.mp3"}% returns https://moglen.law.columbia.edu/twiki/pub/TWiki/TWikiDocGraphics/mp3.gif
- Related: ICONURLPATH, ICON, TWikiPreferences, FileAttachments, TWikiDocGraphics
ICONURLPATH{"name"} -- URL path of small documentation graphic or icon
- Generates the URL path of a TWikiDocGraphics image, typically used in an HTML img tag. Specify image name or full filename (see ICON for details on filenames.)
- Syntax:
%ICONURLPATH{"name"}%
- Examples:
-
%ICONURLPATH{"locktopic"}% returns /twiki/pub/TWiki/TWikiDocGraphics/locktopic.gif
-
%ICONURLPATH{"eggysmell.xml"}% returns /twiki/pub/TWiki/TWikiDocGraphics/xml.gif
-
%ICONURLPATH{"/doc/xhtml.xsl"}% returns /twiki/pub/TWiki/TWikiDocGraphics/xsl.gif
- Related: ICONURL, ICON, TWikiPreferences, FileAttachments, TWikiDocGraphics
IF{"condition" ...} -- simple conditionals
- Evaluate a condition and show one text or another based on the result. See details in IfStatements
- Syntax:
%IF{"CONDITION" then="THEN" else="ELSE"}% shows "THEN" if "CONDITION" evaluates to TRUE , otherwise "ELSE" will be shown
- Example:
%IF{"defined FUNFACTOR" then="FUNFACTOR is defined" else=" is not defined"}% renders as ==
- Related: $IF() of SpreadSheetPlugin
INCLUDE{"page"} -- include other topic or web page
- Syntax:
%INCLUDE{"page" ...}%
- Supported parameters:
Parameter: | Description: | Default: | "SomeTopic" | The name of a topic located in the current web, i.e. %INCLUDE{"WebNotify"}% | | "Web.Topic" | A topic in another web, i.e. %INCLUDE{"TWiki.SiteMap"}% | | "http://..." | A full qualified URL, i.e. %INCLUDE{"http://twiki.org:80/index.html"}% . Supported content types are text/html and text/plain . if the URL resolves to an attachment file on the server this will automatically translate to a server-side include. | | pattern="..." | Include a subset of a topic or a web page. Specify a RegularExpression that scans from start ('^' ) to end and contains the text you want to keep in parenthesis, e.g., pattern="^.*?(from here.*?to here).*" . IncludeTopicsAndWebPages has more. | none | rev="2" | Include a previous topic revision; N/A for URLs | top revision | raw="on" | When a page is included, normally TWiki will process it, doing the following: 1) Alter relative links to point back to originating host, 2) Remove some basic HTML tags (html, head, body, script) and finally 3) Remove newlines from HTML tags spanning multiple lines. If you prefer to include exactly what is in the source of the originating page set this to on . raw="on" is short for disableremoveheaders="on" , disableremovescript="on" , disableremovebody="on" , disablecompresstags="on" and disablerewriteurls="on" . | disabled | literal="on" | While using the raw option will indeed include the raw content, the included content will still be processed and rendered like regular topic content. To disable parsing of the included content, set the literal option to "on" . | disabled | disableremoveheaders="on" | Bypass stripping headers from included HTML (everything until first </head> tag) | disabled | disableremovescript="on" | Bypass stripping all <script> tags from included HTML | disabled | disableremovebody="on" | Bypass stripping the </body> tag and everything around over and below it | disabled | disablecompresstags="on" | Bypass replacing newlines in HTML tags with spaces. This compression step rewrites unmatched <'s into < entities unless bypassed | disabled | disablerewriteurls="on" | Bypass rewriting relative URLs into absolute ones | disabled | warn="off" | Warn if topic include fails: Fail silently (if off ); output default warning (if set to on ); else, output specific text (use $topic for topic name) | %INCLUDEWARNING% preferences setting | section="name" | Includes only the specified named section, as defined in the included topic by the STARTSECTION and ENDSECTION variables. Nothing is shown if the named section does not exists. | | PARONE="val 1" PARTWO="val 2" | Any other parameter will be defined as a variable within the scope of the included topic. The example parameters on the left will result in %PARONE% and %PARTWO% being defined within the included topic. | |
- Note: JavaScript in included webpages is filtered out as a security precaution per default (disable filter with
disableremovescript parameter)
- Examples: See IncludeTopicsAndWebPages
- Related: BASETOPIC, BASEWEB, INCLUDINGTOPIC, INCLUDINGWEB, STARTINCLUDE, STOPINCLUDE, STARTSECTION, ENDSECTION
INCLUDINGTOPIC -- name of topic that includes current topic
- The name of the topic that includes the current topic - same as
%TOPIC% in case there is no include
- Syntax:
%INCLUDINGTOPIC%
- Related: BASETOPIC, INCLUDINGWEB, INCLUDE, TOPIC
INCLUDINGWEB -- web that includes current topic
- The web name of the topic that includes the current topic - same as
%WEB% if there is no INCLUDE.
- Syntax:
%INCLUDINGWEB%
- Related: BASEWEB, INCLUDINGTOPIC, INCLUDE, WEB
LANGUAGE -- current user's language
- Returns the language code for the language used as the current user. This is the language actually used by TWiki Internationalization (e.g. in user interface).
- The language is detected from the user's browser, unless some site/web/user/session-defined setting overrides it:
- If the
LANGUAGE preference is set, it's used as user's language instead of any language detected from the browser.
- Avoid defining
LANGUAGE at a non per-user way, so each user can choose his/her preferred language.
- Related: LANGUAGES
LANGUAGES -- list available TWiki languages
- List the languages available (as
PO files) to TWiki. Those are the languages in which TWiki's user interface is available.
- Syntax:
%LANGUAGES{...}%
- Supported parameters:
Parameter: | Description: | Default: | format | format for each item. See below for variables available in the format string. | " * $langname" | separator | separator between items. | "\n" (newline) | marker="selected" | Text for $marker if the item matches selection | "selected" | selection="%LANGUAGE%" | Current language to be selected in list | (none) |
-
format variables: Variable | Meaning | $langname | language's name, as informed by the translators | $langtag | language's tag. Ex: en , pt-br , etc. |
- Example:
<select>%LANGUAGES{format="<option $marker value='$langtag'>$langname</option>" selection="%LANGUAGE%"}%</select> creates an option list of the available languages with the current language selected
LIME -- start lime colored text
-
LIME is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
- Syntax:
%LIME% lime text %ENDCOLOR%
- Expands to: lime text
- Note:
%<color>% text must end with %ENDCOLOR% . If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR% , e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR% .
- Related: ENDCOLOR, TWikiPreferences, StandardColors
LOCALSITEPREFS -- web.topicname of site preferences topic
- The full name of the local site preferences topic. This topic is read for preferences before TWiki.%TWIKIPREFSTOPIC% is read.
- Syntax:
%LOCALSITEPREFS%
- Expands to:
Main.TWikiPreferences , renders as TWikiPreferences
LOGIN -- present a full login link
LOGOUT -- present a full logout link
M -- moved to... icon
- Type: Preference variable - TWikiRenderingShortcut.
- Current value: M =
- Related: H, I, ICON, N, P, Q, S, T, U, X, Y
MAINWEB -- name of Main web
MAKETEXT -- creates text using TWiki's I18N infrastructure
- Syntax:
%MAKETEXT{"string" args="..."}
- Supported parameters:
Parameter | Description | Default | "text" or string="text" | The text to be displayed. | none | args="param1, param2" | a comma-separated list of arguments to be interpolated in the string, replacing the [_N] placeholders in it. | none |
- Examples:
-
%MAKETEXT{string="Notes:"}% expands to Notes:
-
%MAKETEXT{"If you have any questions, please contact [_1]." args="%WIKIWEBMASTER%"}% expands to If you have any questions, please contact webmaster@new.law.columbia.edu.
-
%MAKETEXT{"Did you want to [[[_1]][reset [_2]'s password]]?" args="%TWIKIWEB%.ResetPassword,%WIKIUSERNAME%"}% expands to Did you want to reset Main.TWikiGuest's password?
- Notes:
- TWiki will translate the
string to the current user's language only if it has such string in its translation table for that language.
- Amperstands (
& ) followed by one letter (one of a...z, A...Z) (say, X ) in the translatable string will be translated to <span class='twikiAccessKey'>X</span> . This is used to implement access keys. If you want to write an actual amperstand that stays just before a letter, write two consecutive amperstands (&& ): they will be transformed in just one.
- translatable string starting with underscores (
_ ) are reserved. You cannot use translatable phrases starting with an underscore.
- Make sure that the translatable string is constant. Specially, do not include
%VARIABLES% inside the translatable strings (since they will get expanded before the %MAKETEXT{...}% itself is handled).
MAROON -- start maroon colored text
-
MAROON is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
- Syntax:
%MAROON% maroon text %ENDCOLOR%
- Expands to: maroon text
- Note:
%<color>% text must end with %ENDCOLOR% . If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR% , e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR% .
- Related: ENDCOLOR, TWikiPreferences, StandardColors
META -- displays meta-data
- Provided mainly for use in templates, this variable generates the parts of the topic view that relate to meta-data (attachments, forms etc.) The
formfield item is the most likely to be useful to casual users.
- Syntax:
%META{ "item" ...}%
- Parameters:
Item | Options | Description | "formfield" | name="..." : name of the field. The field value can be shortened as described in FormattedSearch for $formfield newline="..." : by default, each newline character will be rewritten to <br /> to allow metadata that contains newlines to be used in tables, etc. $n indicates a newline character. bar="..." : by default, each vertical bar is rewritten to an HTML entity so as to not be mistaken for a table separator. | Show a single form field | "form" | none | Generates the table showing the form fields. See Form Templates | "attachments" | all="on" to show hidden attachments. title="..." to show a title - only if attachments are displayed. template="..." to use a custom template for the rendering of attachments; default attachtables is used. | Generates the list of attachments | "moved" | none | Details of any topic moves | "parent" | dontrecurse="on" : By default recurses up tree, this has some cost. nowebhome="on" : Suppress WebHome. prefix="..." : Prefix that goes before parents, but only if there are parents, default "" . format="..." : Format string used to display each parent topic where $web expands to the web name, and $topic expands to the topic name; default: "[[$web.$topic][$topic]]" suffix="..." : Suffix, only appears if there are parents; default "" . separator="..." : Separator between parents; default " > " . | Generates the parent link |
- Related: METASEARCH
METASEARCH -- special search of meta data
- Syntax:
%METASEARCH{...}%
- Supported parameters:
Parameter: | Description: | Default: | type="topicmoved" | What sort of search is required? "topicmoved" if search for a topic that may have been moved "parent" if searching for topics that have a specific parent i.e. its children "field" if searching for topics that have a particular form field value (use the name and value parameters to specify which field to search) | required | web="%WEB%" | Wiki web to search: A web, a list of webs separated by whitespace, or all webs. | current web | topic="%TOPIC%" | The topic the search relates to, for topicmoved and parent searches | current topic | name | form field to search, for field type searches. May be a regular expression (see SEARCH). | | value | form field value, for field type searches. May be a regular expression (see SEARCH). | | title="Title" | Text that is prefixed to any search results | empty | default="none" | Default text shown if no search hit | empty |
- Example:
%METASEARCH{type="topicmoved" web="%WEB%" topic="%TOPIC%" title="This topic used to exist and was moved to: "}%
- Example: You may want to use this in WebTopicViewTemplate and WebTopicNonWikiTemplate:
%METASEARCH{type="parent" web="%WEB%" topic="%TOPIC%" title="Children: "}%
- Example:
%METASEARCH{type="field" name="Country" value="China"}%
- Related: SEARCH, META
N -- "new" icon
- Type: Preference variable - TWikiRenderingShortcut.
- Current value: N =
- Related: H, I, ICON, M, P, Q, S, T, U, X, Y
NAVY -- start navy blue colored text
-
NAVY is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
- Syntax:
%NAVY% navy text %ENDCOLOR%
- Expands to: navy text
- Note:
%<color>% text must end with %ENDCOLOR% . If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR% , e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR% .
- Related: ENDCOLOR, TWikiPreferences, StandardColors
NOP -- template text not to be expanded in instantiated topics
- Syntax:
%NOP%
- In normal topic text, expands to <nop>, which prevents expansion of adjacent variables and wikiwords
- When the topic containing this is used as a template for another topic, it is removed.
- Syntax:
%NOP{...}% deprecated
- In normal topic text, expands to whatever is in the curly braces (if anything).
-
Note: This is deprecated. Do not use it. Use %STARTSECTION{type="templateonly"}% .. %ENDSECTION{type="templateonly"}% instead (see TWikiTemplates for more details).
- Related: STARTSECTION, TWikiTemplates
NOTIFYTOPIC -- name of the notify topic
OLIVE -- start olive green colored text
-
OLIVE is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
- Syntax:
%OLIVE% olive text %ENDCOLOR%
- Expands to: olive text
- Note:
%<color>% text must end with %ENDCOLOR% . If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR% , e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR% .
- Related: ENDCOLOR, TWikiPreferences, StandardColors
ORANGE -- start orange colored text
-
ORANGE is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
- Syntax:
%ORANGE% orange text %ENDCOLOR%
- Expands to: orange text
- Note:
%<color>% text must end with %ENDCOLOR% . If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR% , e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR% .
- Related: ENDCOLOR, TWikiPreferences, StandardColors
P -- pencil icon
- Type: Preference variable - TWikiRenderingShortcut.
- Current value: P =
- Related: H, I, ICON, M, N, Q, S, T, U, X, Y
PINK -- start pink colored text
-
PINK is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
- Syntax:
%PINK% pink text %ENDCOLOR%
- Expands to: pink text
- Note:
%<color>% text must end with %ENDCOLOR% . If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR% , e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR% .
- Related: ENDCOLOR, TWikiPreferences, StandardColors
PLUGINDESCRIPTIONS -- list of plugin descriptions
- Syntax:
%PLUGINDESCRIPTIONS%
- Expands to:
- SpreadSheetPlugin (any TWiki, 10197): Add spreadsheet calculation like
"$SUM( $ABOVE() )" to TWiki tables and other topic text - ActionTrackerPlugin (21 May 2007, $Rev: 14969 (20 Sep 2007) $): Adds support for action tags in topics, and automatic notification of action statuses
- AttachmentListPlugin (1.0.1, $Rev: 15921 (07 Dec 2007) $): Displays a formattable list of topic attachments, anywhere in a topic.
- BreadCrumbsPlugin (v1.00, $Rev: 13657 (08 May 2007) $): A flexible way to display breadcrumbs navigation
- CalendarPlugin (Dakar, 9113): Show a monthly calendar with highlighted events
- CommentPlugin (Dakar, 11359): Allows users to quickly post comments to a page without an edit/preview/save cycle
- CompareRevisionsAddonPlugin (Dakar, $Rev: 9808$):
- EditTablePlugin (any TWiki, 11646): Edit TWiki tables using edit fields, date pickers and drop down boxes
- FilterPlugin (1.40, $Rev: 15932 (07 Dec 2007) $): Substitute and extract information from content by using regular expressions
- FlexWebListPlugin (v1.21, $Rev: 16132 (03 Jan 2008) $): Flexible way to display hierarchical weblists
- FootNotePlugin (2.006): Footnotes are notes placed at the end of a topic.
- GluePlugin (2.00, $Rev: 15708 (23 Nov 2007) $): Enable markup to span multiple lines
- IfDefinedPlugin (v1.01, $Rev: 15157 (05 Oct 2007) $): Render content conditionally
- InterwikiPlugin (Dakar, $Rev: 11935$): Link
ExternalSite:Page text to external sites based on aliases defined in a rules topic - JQueryPlugin (v0.4, $Rev: 15608 (15 Nov 2007) $): jQuery JavaScript library for TWiki
- NatSkinPlugin (3.00-pre17, $Rev: 15581 (13 Nov 2007) $): Supplements the bare bones NatSkin theme for TWiki
- PreferencesPlugin (Dakar, 9839): Allows editing of preferences using fields predefined in a form
- RedDotPlugin (1.40, $Rev: 16137 (03 Jan 2008) $): Renders edit-links as little red dots
- RenderListPlugin (any TWiki, 1.034): Render bullet lists in a variety of formats
- SlideShowPlugin (Any TWiki, $Rev: 12847$): Create web based presentations based on topics with headings.
- SmiliesPlugin (Dakar, 8154): Render smilies as icons, like
for :-) or for = :eek:= - TablePlugin (1.020, 12339): Control attributes of tables and sorting of table columns
- TreeBrowserPlugin (v1.8): Renders a list as a collapsable/expandable tree.
- TreePlugin (1.7): Dynamic generation of TWiki topic trees
- TwistyPlugin (1.2.0, $Rev: 12154$): Twisty section JavaScript library to open/close content dynamically
- VotePlugin (1.33, $Rev: 14312 (01 Jul 2007) $): Simple way to count votes
- WysiwygPlugin (Dakar, 12422): Translator framework for Wysiwyg editors
- Related: ACTIVATEDPLUGINS, FAILEDPLUGINS, PLUGINVERSION
PLUGINVERSION -- the version of a TWiki Plugin, or the TWiki Plugins API
PUBURL -- the base URL of attachments
PUBURLPATH -- the base URL path of attachments
PURPLE -- start purple colored text
-
PURPLE is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
- Syntax:
%PURPLE% purple text %ENDCOLOR%
- Expands to: purple text
- Note:
%<color>% text must end with %ENDCOLOR% . If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR% , e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR% .
- Related: ENDCOLOR, TWikiPreferences, StandardColors
Q -- question icon
- Type: Preference variable - TWikiRenderingShortcut.
- Current value: Q =
- Related: H, I, ICON, M, N, P, S, T, U, X, Y
QUERYPARAMS -- show paramaters to the query
- Expands the parameters to the query that was used to display the page.
- Syntax:
%QUERYPARAMS{...}%
- Parameters:
-
format="..." format string for each entry, default $name=$value
-
separator="..." separator string, default separator="$n" (newline)
- The following escape sequences are expanded in the format string:
Sequence: | Expands To: | $name | Name of the parameter | $value | String value of the parameter. Multi-valued parameters will have a "row" for each value. | $n or $n() | New line. Use $n() if followed by alphanumeric character, e.g. write Foo$n()Bar instead of Foo$nBar | $nop or $nop() | Is a "no operation". | $quot | Double quote (" ) | $percnt | Percent sign (% ) | $dollar | Dollar sign ($ ) |
- Example:
-
%QUERYPARAMS{format="<input type='hidden' name='$name' value='$percntENCODE{$quot()$value$quot type=$quot()html$quot}$percnt' />"}%
- See also QUERYSTRING, URLPARAM
QUERYSTRING -- full, unprocessed string of parameters to this URL
- String of all the URL parameters that were on the URL used to get to the current page. For example, if you add ?name=Samantha;age=24;eyes=blue to this URL you can see this in action. This string can be appended to a URL to pass parameter values on to another page.
-
Note: URLs built this way are typically restricted in length, typically to 2048 characters. If you need more space than this, you will need to use an HTML form and %QUERYPARAMS% .
- Syntax:
%QUERYSTRING%
- Expands to:
- Related: QUERYPARAMS, URLPARAM
RED -- start red colored text
-
RED is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
- Syntax:
%RED% red text %ENDCOLOR%
- Expands to: red text
- Note:
%<color>% text must end with %ENDCOLOR% . If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR% , e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR% .
- Related: ENDCOLOR, TWikiPreferences, StandardColors
REMOTE_ADDR -- environment variable
REMOTE_PORT -- environment variable
REMOTE_USER -- environment variable
REVINFO -- revision information of current topic
REVINFO{"format"} -- formatted revision information of topic
- Syntax:
%REVINFO{"format"}%
- Supported parameters:
Parameter: | Description: | Default: | "format" | Format of revision information, see supported variables below | "r1.$rev - $date - $wikiusername" | web="..." | Name of web | Current web | topic="..." | Topic name | Current topic | rev="1.5" | Specific revison number | Latest revision |
- Supported variables in format:
Variable: | Unit: | Example | $web | Name of web | Current web | $topic | Topic name | Current topic | $rev | Revison number. Prefix r1. to get the usual r1.5 format | 5 | $username | Login username of revision | jsmith | $wikiname | WikiName of revision | JohnSmith | $wikiusername | WikiName with Main web prefix | Main.JohnSmith | $date | Revision date | 21 Sep 2006 | $time | Revision time | 23:24:25 | $iso | Revision date in ISO date format | 2006-09-22T06:24:25Z | $min , $sec , etc. | Same date format qualifiers as GMTIME{"format"} | |
- Example:
%REVINFO{"$date - $wikiusername" rev="1.1"}% returns revision info of first revision
- Related: GMTIME{"format"}, REVINFO
S -- red star icon
- Type: Preference variable - TWikiRenderingShortcut.
- Current value: S =
- Related: H, I, ICON, M, N, P, Q, T, U, X, Y
SCRIPTNAME -- name of current script
- The name of the current script is shown, including script suffix, if any (for example
viewauth.cgi )
- Syntax:
%SCRIPTNAME%
- Expands to:
rdiff
- Related: SCRIPTSUFFIX, SCRIPTURL, SCRIPTURLPATH
SCRIPTSUFFIX -- script suffix
- Some TWiki installations require a file extension for CGI scripts, such as
.pl or .cgi
- Syntax:
%SCRIPTSUFFIX%
- Expands to:
- Related: SCRIPTNAME, SCRIPTURL, SCRIPTURLPATH
SCRIPTURL -- base URL of TWiki scripts
SCRIPTURL{"script"} -- URL of TWiki script
- Syntax:
%SCRIPTURL{"script"}%
- Expands to:
https://moglen.law.columbia.edu/twiki/bin/script
- Example: To get the authenticated version of the current topic you can write
%SCRIPTURL{"viewauth"}%/%WEB%/%TOPIC% which expands to https://moglen.law.columbia.edu/twiki/bin/viewauth/TWiki/TWikiVariables
-
Note: In most cases you should use %SCRIPTURLPATH{"script"}% instead, as it works with URL rewriting much better
- Related: PUBURL, SCRIPTNAME, SCRIPTSUFFIX, SCRIPTURL, SCRIPTURLPATH, SCRIPTURLPATH{"script"}
SCRIPTURLPATH -- base URL path of TWiki scripts
SCRIPTURLPATH{"script"} -- URL path of TWiki script
SEARCH{"text"} -- search content
- Inline search, shows a search result embedded in a topic
- Syntax:
%SEARCH{"text" ...}%
- Supported parameters:
Parameter: | Description: | Default: | "text" | Search term. Is a keyword search, literal search or regular expression search, depending on the type parameter. SearchHelp has more | required | search="text" | (Alternative to above) | N/A | web="Name" web="Main, Know" web="all" | Comma-separated list of webs to search. You can specifically exclude webs from an all search using a minus sign - for example, web="all,-Secretweb" . The special word all means all webs that do not have the NOSEARCHALL variable set to on in their WebPreferences. Note that TWikiAccessControls are respected when searching webs; it is much better to use them than NOSEARCHALL . | Current web | topic="WebPreferences" topic="*Bug" | Limit search to topics: A topic, a topic with asterisk wildcards, or a list of topics separated by comma. Note this is a list of topic names and must not include web names. | All topics in a web | excludetopic="Web*" excludetopic="WebHome, WebChanges" | Exclude topics from search: A topic, a topic with asterisk wildcards, or a list of topics separated by comma. Note this is a list of topic names and must not include web names. | None | type="keyword" type="literal" type="regex" | Do a keyword search like soap "web service" -shampoo ; a literal search like web service ; or RegularExpression search like soap;web service;!shampoo | %SEARCHVAR- DEFAULTTYPE% preferences setting (literal) | scope="topic" scope="text" scope="all" | Search topic name (title); the text (body) of topic; or all (both) | "text" | order="topic" order="created" order="modified" order="editby" order= "formfield(name)" | Sort the results of search by the topic names, topic creation time, last modified time, last editor, or named field of TWikiForms. The sorting is done web by web; if you want to sort across webs, create a formatted table and sort it with TablePlugin's initsort. Note that dates are sorted most recent date last (i.e at the bottom of the table). | Sort by topic name | limit="all" limit="16" | Limit the number of results returned. This is done after sorting if order is specified | All results | date="..." | limits the results to those pages with latest edit time in the given TimeInterval. | All results | reverse="on" | Reverse the direction of the search | Ascending search | casesensitive="on" | Case sensitive search | Ignore case | bookview="on" | BookView search, e.g. show complete topic text | Show topic summary | nonoise="on" | Shorthand for nosummary="on" nosearch="on" nototal="on" zeroresults="off" noheader="on" noempty="on" | Off | nosummary="on" | Show topic title only | Show topic summary | nosearch="on" | Suppress search string | Show search string | noheader="on" | Suppress default search header Topics: Changed: By: , unless a header is explicitly specified | Show default search header, unless search is inline and a format is specified (Cairo compatibility) | nototal="on" | Do not show number of topics found | Show number | zeroresults="off" | Suppress all output if there are no hits | zeroresults="on" , displays: "Number of topics: 0" | noempty="on" | Suppress results for webs that have no hits. | Show webs with no hits | header="..." format="..." | Custom format results: see FormattedSearch for usage, variables & examples | Results in table | expandvariables="on" | Expand variables before applying a FormattedSearch on a search hit. Useful to show the expanded text, e.g. to show the result of a SpreadSheetPlugin %CALC{}% instead of the formula | Raw text | multiple="on" | Multiple hits per topic. Each hit can be formatted. The last token is used in case of a regular expression ";" and search | Only one hit per topic | nofinalnewline="on" | If on , the search variable does not end in a line by itself. Any text continuing immediately after the search variable on the same line will be rendered as part of the table generated by the search, if appropriate. | off | recurse="on" | Recurse into subwebs, if subwebs are enabled. | off | separator=", " | Line separator between search hits | "$n" (Newline) | newline="%BR%" | Line separator within a search hit. Useful if the format="" parameter contains a $pattern() that captures more than one line, i.e. contents of a textfield in a form. | "$n" (Newline) |
- Example:
%SEARCH{"wiki" web="Main" scope="topic"}%
- Example with format:
%SEARCH{"FAQ" scope="topic" nosearch="on" nototal="on" header="| *Topic: * | *Summary: * |" format="| $topic | $summary |"% (displays results in a table with header - details)
-
Hint: If the TWiki:Plugins.TablePlugin is installed, you may set a %TABLE{}% variable just before the %SEARCH{}% to alter the output of a search. Example: %TABLE{ tablewidth="90%" }%
- Related: METASEARCH, TOPICLIST, WEBLIST, FormattedSearch, SearchHelp, SearchPatternCookbook, RegularExpression
SERVERTIME -- server time
SERVERTIME{"format"} -- formatted server time
- Same format qualifiers as
%GMTIME%
- Syntax:
%SERVERTIME{"format"}%
- Example:
%SERVERTIME{"$hou:$min"}% expands to 21:40
-
Note: When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TWikiTemplates#TemplateTopicsVars for details.
- Related: DISPLAYTIME, GMTIME, SERVERTIME
SESSIONID -- unique ID for this session
SESSIONVAR -- name of CGI and session variable that stores the session ID
SESSION_VARIABLE -- get, set or clear a session variable
SILVER -- start silver colored text
-
SILVER is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
- Syntax:
%SILVER% silver text %ENDCOLOR%
- Expands to: silver text
- Note:
%<color>% text must end with %ENDCOLOR% . If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR% , e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR% .
- Related: ENDCOLOR, TWikiPreferences, StandardColors
SPACEDTOPIC -- topic name, spaced and URL-encoded deprecated
- The current topic name with added URL-encoded spaces, for use in regular expressions that search for backlinks to the current topic
- Syntax:
%SPACEDTOPIC%
- Expands to:
Var%20*SPACEDTOPIC
-
Note: This is a deprecated variable. It can be duplicated with %ENCODE{%SPACEOUT{"%TOPIC%" separator=" *"}%}%
- Related: SPACEOUT, TOPIC, ENCODE
SPACEOUT{"string"} -- renders string with spaces inserted in sensible places
- Inserts spaces after lower case letters that are followed by a digit or a capital letter, and after digits that are followed by a capital letter.
- Useful for spacing out WikiWords
- Syntax:
%SPACEOUT{ "%TOPIC%" }%
- Expands to:
TWiki Variables
- Supported parameters:
Parameter: | Description: | Default: | separator | The separator to put between words e.g. %SPACEOUT{"DogsCatsBudgies" separator=", "}% -> Dogs, Cats, Budgies | ' ' |
-
Hint: Spaced out WikiWords are not automatically linked. To SPACEOUT a WikiWord but preserve the link use "double bracket" format. For example, [[WebHome][%SPACEOUT{"WebHome"}%]] expands to Web Home
- Related: SPACEDTOPIC, $PROPERSPACE() of SpreadSheetPlugin
STARTINCLUDE -- start position of topic text if included
- If present in included topic, start to include text from this location up to the end, or up to the location of the
%STOPINCLUDE% variable. A normal view of the topic shows everything exept the %STARTINCLUDE% variable itself.
- Note: If you want more than one part of the topic included, use
%STARTSECTION{type="include"}% instead
- Syntax:
%STARTINCLUDE%
- Related: INCLUDE, STARTSECTION, STOPINCLUDE
STARTSECTION -- marks the start of a section within a topic
- Section boundaries are defined with
%STARTSECTION{}% and %ENDSECTION{}% .
- Sections may be given a name to help identify them, and/or a type, which changes how they are used.
-
type="section" - the default, used for a generic section, such as a named section used by INCLUDE.
-
type="include" - like %STARTINCLUDE% ... %STOPINCLUDE% except that you can have as many include blocks as you want (%STARTINCLUDE% is restricted to only one).
-
type="templateonly" - start position of text to be removed when a template topic is used. This is used to embed text that you do not want expanded when a new topic based on the template topic is created. See TWikiTemplates for more information.
- Syntax:
%STARTSECTION{"name"}% ................ %ENDSECTION{"name"}%
- Syntax:
%STARTSECTION{type="include"}% ........ %ENDSECTION{type="include"}%
- Syntax:
%STARTSECTION{type="templateonly"}% ... %ENDSECTION{type="templateonly"}%
- Supported parameters:
Parameter: | Description: | Default | "name" | Name of the section. Must be unique inside a topic. | Generated name | type="..." | Type of the section; type "section" , "include" or "templateonly" | "section" |
-
Note: If a section is not given a name, it will be assigned one. Unnamed sections are assigned names starting with _SECTION0 for the first unnamed section in the topic, _SECTION1 for the second, etc..
-
Note: You can define nested sections. It is not recommended to overlap sections, although it is valid in TWiki. Use named sections to make sure that the correct START and ENDs are matched. Section markers are not displayed when a topic is viewed.
- Related: ENDSECTION, INCLUDE, NOP, STARTINCLUDE, STOPINCLUDE
STATISTICSTOPIC -- name of statistics topic
STOPINCLUDE -- end position of topic text if included
- If present in included topic, stop to include text at this location and ignore the remaining text. A normal view of the topic shows everyting exept the
%STOPINCLUDE% variable itself.
- Syntax:
%STOPINCLUDE%
- Related: INCLUDE, STARTINCLUDE
T -- tip icon
- Type: Preference variable - TWikiRenderingShortcut.
- Current value: T =
- Related: H, I, ICON, M, N, P, Q, S, U, X, Y
TEAL -- start teal colored text
-
TEAL is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
- Syntax:
%TEAL% teal text %ENDCOLOR%
- Expands to: teal text
- Note:
%<color>% text must end with %ENDCOLOR% . If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR% , e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR% .
- Related: ENDCOLOR, TWikiPreferences, StandardColors
TOC -- table of contents of current topic
TOC{"Topic"} -- table of contents
- Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax (
"---++ text" ) and HTML ("<h2>text</h2>" ) are taken into account. Any heading text after "!!" is excluded from the TOC; for example, write "---+!! text" if you do not want to list a header in the TOC
- Syntax:
%TOC{"SomeTopic" ...}%
- Supported parameters:
Parameter: | Description: | Default: | "TopicName" | topic name | Current topic | web="Name" | Name of web | Current web | depth="2" | Limit depth of headings shown in TOC | 6 | title="Some text" | Title to appear at top of TOC | none |
- Example:
%TOC{depth="2"}%
- Example:
%TOC{"TWikiDocumentation" web="TWiki" title="Contents:"}%
- Example: see TWiki:Sandbox.TestTopicInclude
-
Hint: TOC will generate links to the headings, so when a reader clicks on a heading it will jump straight where that heading is anchored in the text. If you have two headings with exactly the same text, then their anchors will also be identical and they won't be able to jump to them. To make the anchors unique, you can add an invisible HTML comment to the text of the heading. This will be hidden in normal view, but will force the anchors to be different. For example, ---+ Heading <!--5-->.
- Related: TOC
TOPIC -- name of current topic
-
%TOPIC% expands to the name of the topic. If you are looking at the text of an included topic, it is the name of the included topic.
- Syntax:
%TOPIC%
- Expands to:
TWikiVariables , renders as TWikiVariables
- Related: BASETOPIC, INCLUDINGTOPIC, TOPICLIST, WEB
TOPICLIST{"format"} -- topic index of a web
- List of all topics in a web. The "format" defines the format of one topic item. It may include variables: The
$name variable gets expanded to the topic name, $qname to double quoted name, $marker to marker parameter where topic matches selection , and $web to the name of the web.
- Syntax:
%TOPICLIST{"format" ...}%
- Supported parameters:
Parameter: | Description: | Default: | "format" | Format of one line, may include $web (name of web), $name (name of the topic), $qname (name of topic in double quotes), $marker (which expands to marker for the item matching selection only) | "$name" | format="format" | (Alternative to above) | "$name" | separator=", " | line separator | "$n" (new line) | marker="selected" | Text for $marker if the item matches selection | "selected" | selection="TopicA, TopicB" | Current value to be selected in list | (none) | web="Name" | Name of web | Current web |
- Example:
%TOPICLIST{" * $web.$name"}% creates a bullet list of all topics
- Example:
%TOPICLIST{separator=", "}% creates a comma separated list of all topics
- Example:
%TOPICLIST{" <option>$name</option>"}% creates an option list (for drop down menus)
- Example:
<select>%TOPICLIST{" <option $marker value='$name'>$name</option>" separator=" " selection="%TOPIC%"}%</select> creates an option list of web topics with the current topic selected
- Related: SEARCH, WEBLIST
TOPICURL -- shortcut to viewing the current topic
TWIKIWEB -- name of TWiki documentation web
- The web containing all documentation and site-wide preference settings for TWiki
- Syntax:
%TWIKIWEB%
- Expands to:
TWiki
- Related: MAINWEB
U -- "updated" icon
- Type: Preference variable - TWikiRenderingShortcut.
- Current value: U =
- Related: H, I, ICON, M, N, P, Q, S, T, X, Y
URLPARAM{"name"} -- get value of a URL parameter
- Returns the value of a URL parameter.
- Syntax:
%URLPARAM{"name"}%
- Supported parameters:
Parameter: | Description: | Default: | "name" | The name of a URL parameter | required | default="..." | Default value in case parameter is empty or missing | empty string | newline="<br />" | Convert newlines in textarea to other delimiters | no conversion | encode="entity" | Encode special characters into HTML entities. See ENCODE for more details. | no encoding | encode="url" | Encode special characters for URL parameter use, like a double quote into %22 | no encoding | encode="quote" | Escape double quotes with backslashes (\" ), does not change other characters; required when feeding URL parameters into other TWiki variables | no encoding | multiple="on" multiple="[[$item]]" | If set, gets all selected elements of a <select multiple="multiple"> tag. A format can be specified, with $item indicating the element, e.g. multiple="Option: $item" | first element | separator=", " | Separator between multiple selections. Only relevant if multiple is specified | "\n" (new line) |
- Example:
%URLPARAM{"skin"}% returns print for a .../view/TWiki/TWikiVariables?skin=print URL
-
Note: URL parameters passed into HTML form fields must be entity ENCODEd.
-
Note: Double quotes in URL parameters must be escaped when passed into other TWiki variables. Example: %SEARCH{ "%URLPARAM{ "search" encode="quotes" }%" noheader="on" }%
-
Note: When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TWikiTemplates#TemplateTopicsVars for details.
-
Note: There is a risk that this variable could be misused for cross-site scripting.
- Related: ENCODE, SEARCH, FormattedSearch, QUERYSTRING
USERINFO{"WikiName"} -- retrieve details about a user
- Syntax:
%USERINFO%
- Expands to:
guest, TWikiGuest, (comma-separated list of the username, wikiusername, and emails)
- With formatted output, using tokens
$emails , $username , $wikiname , $wikiusername , and $groups :
- Example:
%USERINFO{ format="$username is really $wikiname" }%
- Expands to:
guest is really TWikiGuest
- Retrieve information about another user:
- Example:
%USERINFO{ "TWikiGuest" format="$username is really $wikiname" }%
- Expands to:
guest is really TWikiGuest
- Note: The parameter should be the wikiname of a user. You can only get information about another user if the
{AntiSpam}{HideUserDetails} configuration option is not enabled, or if you are an admin. (User details are hidden in this TWiki)
- Related: USERNAME, WIKINAME, WIKIUSERNAME, TWikiUserAuthentication, ChangeEmailAddress
USERNAME -- your login username
VAR{"NAME" web="Web"} -- get a preference value from another web
- Syntax:
%VAR{"NAME" web="Web"}%
- Example: To get
%WEBBGCOLOR% of the Main web write %VAR{"WEBBGCOLOR" web="Main"}% , which expands to #FFEFA6
- Related: WEBPREFSTOPIC
VBAR -- vertical bar
VOTE{ attributes } -- define a poll in a TWiki topic.
- The following standard attributes are recognized
Name | Description | Example | id | The identifier of the poll. You can have multiple independent votes in the same topic. | id="Dining" | selectN | Defines the name of a select vote, where you select one from a ranges of options. N is a number that identifies this item within the poll e.g. select1 , select2 etc. You must number all select and stars parameters uniquely and sequentially (e.g. select1 stars2 select3 | select1="Drink" | optionsN | Each selectN must have a corresponding optionsN that defines a comma-separated list of the options that can be selected between. | options1="Beer,Wine,Milk" | starsN | Defines the name of a rate vote, where you rate something by giving it a number of stars. N is a number that identifies this item within the poll e.g. select1 , stars2 etc. You must number all select and stars parameters uniquely and sequentially (e.g. select1 stars2 select3 | stars2="Usability" | widthN | Each starsN must have a corresponding widthN . This gives the number of stars to show e.g. width1="5" will show 5 stars. | width2="10" | formatN | Defines the format of the results display. See formatting results, below. | format="$large" | chartN | Defines the format of a single bar in the results bar chart generated for the corresponding select (for select type only). See formatting results, below. | chart="<p>$option $score</p>" | separator | Defines the string to be used to separate each row in the result. | separator="<br/>" | global | If set to "off" , this makes the id local to this topic (the default). If set to "on" it will be a global poll that can be accessed from many topics. | global="on" | open | If set to "off" this is a closed vote. If set to "on" it is open (the default) | open="on" | secret | If set to "off" , then the database will record who voted. If set to "on" , votes are secret (the default) | secret="on" | saveto | If set to the name of a topic, the poll results will be appended to the end of that topic. The results are formatted as a TWiki table for easy post-processing. | saveto="Main.VoteResults" | bayesian | If set to "on" , rating averages will be computed using the Bayesian average of this item against all the other items that have the same item in their stars field. This requires all the participating %VOTEs to be global , or to save their results to the same place using saveto . See http://www.thebroth.com/blog/118/bayesian-rating for more information about Bayesian rating. | bayesian="off" | submit | If set to "off" , this makes the %VOTE display the results of the vote without prompting for any input. This is useful when - for example - you want to show the results of a global vote, without permitting more voting. |
WEB -- name of current web
-
%WEB% expands to the name of the web where the topic is located. If you are looking at the text of an included topic, it is the web where the included topic is located.
- Syntax:
%WEB%
- Expands to:
TWiki
- Related: BASEWEB, INCLUDINGWEB, TOPIC
WEBLIST{"format"} -- index of all webs
- List of all webs. Obfusticated webs are excluded, e.g. webs with a
NOSEARCHALL = on preference variable. The "format" defines the format of one web item. The $name variable gets expanded to the name of the web, $qname gets expanded to double quoted name, $marker to marker where web matches selection .
- Syntax:
%WEBLIST{"format" ...}%
- Supported parameters:
Parameter: | Description: | Default: | "format" | Format of one line, may include $name (the name of the web), $qname (the name of the web in double quotes), $indentedname (the name of the web with parent web names replaced by indents, for use in indented lists), and $marker (which expands to marker for the item matching selection only) | "$name" | format="format" | (Alternative to above) | "$name" | separator=", " | Line separator | "$n" (new line) | webs="public" | Comma separated list of webs, public expands to all non-hidden. NOTE: Administrators will see all webs, not just the public ones | "public" | marker="selected" | Text for $marker if the item matches selection | "selected" | selection="%WEB%" | Current value to be selected in list | section="%WEB%" |
- Example:
%WEBLIST{" * [[$name.WebHome]]"}% - creates a bullet list of all webs.
- Example:
<form><select name="web"> %WEBLIST{"<option $marker value=$qname>$name</option>" webs="Trash, public" selection="%WEB%" separator=" "}% </select></form> - creates a dropdown of all public webs + Trash web, with the current web highlighted.
- Related: TOPICLIST, SEARCH
WEBPREFSTOPIC -- name of web preferences topic
WHITE -- start white colored text
-
WHITE is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
- Syntax:
%WHITE% white text %ENDCOLOR%
- Expands to: white text (shown with a gray background here)
- Note:
%<color>% text must end with %ENDCOLOR% . If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR% , e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR% .
- Related: ENDCOLOR, TWikiPreferences, StandardColors
WIKIHOMEURL -- site home URL
- Syntax
%WIKIHOMEURL%
- Expands to
/twiki/bin/view
- Defined in TWikiPreferences and normally per default set to
%SCRIPTURLPATH{"view"}%
-
Note: For the top bar logo URL use %WIKILOGOURL% defined in WebPreferences instead.
- Related: WIKITOOLNAME
WIKINAME -- your Wiki username
WIKIPREFSTOPIC -- name of site-wide preferences topic
WIKITOOLNAME -- name of your TWiki site
WIKIUSERNAME -- your Wiki username with web prefix
WIKIUSERSTOPIC -- name of topic listing all registers users
WIKIVERSION -- the version of the installed TWiki engine
X -- warning icon
- Type: Preference variable - TWikiRenderingShortcut.
- Current value: X =
- Related: H, I, ICON, M, N, P, Q, S, T, U, Y
Y -- "yes" icon
- Type: Preference variable - TWikiRenderingShortcut.
- Current value: Y =
- Related: H, I, ICON, M, N, P, Q, S, T, U, X
YELLOW -- start yellow colored text
-
YELLOW is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
- Syntax:
%YELLOW% yellow text %ENDCOLOR%
- Expands to: yellow text
- Note:
%<color>% text must end with %ENDCOLOR% . If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR% , e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR% .
- Related: ENDCOLOR, TWikiPreferences, StandardColors
| > > | Variables are names enclosed in percent signs that gets expanded on the fly.
-
%WEB% : The current web, is TWiki .
-
%TOPIC% : The current topic name, is TextFormattingRules .
-
%ATTACHURL% : The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as %ATTACHURL%/image.gif to show the URL of the file or the image in your text.
-
%INCLUDE{"file.ext"}% : Server side include, includes the text of a file. The default directory is the current Wiki web. Example: %INCLUDE{"Know/TopicName.txt"}%
- There are many more variables, see TWikiVariables.
|
|
TextFormattingRules 3 - 09 Aug 1999 - Main.PeterThoeny
|
| EDITING | |
< < |
- CapitalizedWordsWillProduce? a link automatically.
| > > |
- CapitalizedWordsStickedTogether? will produce a link automatically.
| |
- Blank lines will create new paragraphs.
| |
< < |
- Words get bold by enclosing them with * asterisks
- Words get italic by enclosing them with _ underscores
- Words get bold italic by enclosing them with __ two underscores
- Words get showns in
fixed font by enclosing it with = equal signs
- Notes for bold , italic , bold italic and
fixed font text:
| > > |
- Words get bold by enclosing them in * asterisks
- Words get italic by enclosing them in _ underscores
- Words get bold italic by enclosing them in __ double-underscores
- Words get shown in
fixed font by enclosing them in = equal signs
- Note for bold , italic , bold italic and
fixed font text:
| |
-
- Make sure to "stick" the
* _ = signs to the characters, e.g.
- This works
- _This does not get italic because there is a space between the last word and the underline character _
| |
- Nested Item: <6spaces>*
- Ordered List: <3spaces><number>.
- Definition: <3spaces><term>:<definition>.
| |
> > |
- Table: <optional spaces>| cell 1 | cell 2 | cell 3 | ... |
| | EXTRAS | | WIKI VARIABLES | |
< < | %INCLUDE:"TWikiVariables.txt"% | > > | TWiki Variables
Special text strings expand on the fly to display user data or system info
TWikiVariables are text strings - %VARIABLE% or %VARIABLE{ parameter="value" }% - that expand into content whenever a topic is rendered for viewing. There are two types of variables:
- Preferences variables: Can be defined and changed by the user
- Predefined variables: Defined by the TWiki system or by Plugins (for example, the SpreadSheetPlugin introduces a
%CALC{}% variable)
Using Variables
To use a variable type its name. For example,
- type
%T% to get (a preferences variable)
- type
%TOPIC% to get TWikiVariables (a predefined variable)
- type
%CALC{ "$UPPER(Text)" }% to get TEXT (a variable defined by Plugin)
Note:
- To leave a variable unexpanded, precede it with an exclamation point, e.g. type
!%TOPIC% to get %TOPIC%
- Variables are expanded relative to the topic they are used in, not the topic they are defined in
- Type
%ALLVARIABLES% to get a full listing of all variables defined for a particular topic
Variable Names
Variable names must start with a letter. The following characters can be letters, numbers and the underscore '_'. You can use both upper-case and lower-case letters and you can mix the characteres. E.g. %MYVAR% , %MyVar% , %My2ndVar% , and %My_Var% are all valid variable names. Variables are case sensitive. %MyVAR% and %MYVAR% are not the same variable.
By convention all settings, predefined variables and variables used by plugins are always UPPER-CASE.
Preferences Variables
Unlike predefined variables, preferences variables can be defined by the user in various places.
Setting Preferences Variables
You can set variables in all the following places:
- local site level in TWiki.TWikiPreferences
- plugin topics (see TWikiPlugins)
- local site level in Main.TWikiPreferences
- user level in individual user topics in Main web
- web level in WebPreferences of each web
- topic level in topics in webs
- session variables (if sessions are enabled)
Settings at higher-numbered levels override settings of the same variable at lower numbered levels, unless the variable was included in the setting of FINALPREFERENCES at a lower-numbered level, in which case it is locked at the value it has at that level.
The syntax for setting Variables is the same anywhere in TWiki (on its own TWiki bullet line, including nested bullets): [multiple of 3 spaces] * [space] Set [space] VARIABLENAME [space] = [space] value
Examples:
Spaces between the = sign and the value will be ignored. You can split a value over several lines by indenting following lines with spaces - as long as you don't try to use * as the first character on the following line.
Example:
* Set VARIABLENAME = value starts here
and continues here
Whatever you include in your Variable will be expanded on display, exactly as if it had been entered directly.
Example: Create a custom logo variable
- To place a logo anywhere in a web by typing
%MYLOGO% , define the Variable on the web's WebPreferences topic, and upload a logo file, ex: mylogo.gif . You can upload by attaching the file to WebPreferences, or, to avoid clutter, to any other topic in the same web, e.g. LogoTopic . Sample variable setting in WebPreferences:
-
Set MYLOGO = %PUBURL%/%WEB%/LogoTopic/mylogo.gif
You can also set preferences variables on a topic by clicking the link Edit topic preference settings under More topic actions . Preferences set in this manner are not visible in the topic text, but take effect nevertheless.
Access Control Variables
These are special types of preferences variables to control access to content. TWikiAccessControl explains these security settings in detail.
Local values for variables
Certain topics (a users home topic, web site and default preferences topics) have a problem; variables defined in those topics can have two meanings. For example, consider a user topic. A user may want to use a double-height edit box when they are editing their home topic - but only when editing their home topic. The rest of the time, they want to have a normal edit box. This separation is achieved using Local in place of Set in the variable definition. For example, if the user sets the following in their home topic:
* Set EDITBOXHEIGHT = 10
* Local EDITBOXHEIGHT = 20
Then when they are editing any other topic, they will get a 10 high edit box. However when they are editing their home topic, they will get a 20 high edit box.
Local can be used wherever a preference needs to take a different value depending on where the current operation is being performed.
Use this powerful feature with great care! %ALLVARIABLES% can be used to get a listing of the values of all variables in their evaluation order, so you can see variable scope if you get confused.
Frequently Used Preferences Variables
The following preferences variables are frequently used. They are defined in TWikiPreferences#Miscellaneous_Settings:
-
%BR% - line break
-
%BULLET% - bullet sign
-
%BB% - line break and bullet combined
-
%BB2% - indented line break and bullet
-
%RED% text %ENDCOLOR% - colored text (also %YELLOW% , %ORANGE% , %PINK% , %PURPLE% , %TEAL% , %NAVY% , %BLUE% , %AQUA% , %LIME% , %GREEN% , %OLIVE% , %MAROON% , %BROWN% , %BLACK% , %GRAY% , %SILVER% , %WHITE% )
-
%H% - Help icon
-
%I% - Idea icon
-
%M% - Moved to icon
-
%N% - New icon
-
%P% - Refactor icon
-
%Q% - Question icon
-
%S% - Pick icon
-
%T% - Tip icon
-
%U% - Updated icon
-
%X% - Alert icon
-
%Y% - Done icon
There are additional useful preferences variables defined in TWikiPreferences, in Main.TWikiPreferences, and in WebPreferences of every web.
Predefined Variables
Most predefined variables return values that were either set in the configuration when TWiki was installed, or taken from server info (such as current username, or date and time). Some, like %SEARCH% , are powerful and general tools.
-
Predefined variables can be overridden by preferences variables
-
Plugins may extend the set of predefined variables (see individual Plugins topics for details)
-
Take the time to thoroughly read through ALL preference variables. If you actively configure your site, review variables periodically. They cover a wide range of functions, and it can be easy to miss the one perfect variable for something you have in mind. For example, see %INCLUDINGTOPIC% , %INCLUDE% , and the mighty %SEARCH% .
This version of TWiki - TWiki-4.1.2, Sat, 03 Mar 2007, build 13046 - predefines the following variables:
ACTIVATEDPLUGINS -- list of currently activated plugins
- Syntax:
%ACTIVATEDPLUGINS%
- Expands to: SpreadSheetPlugin, ActionTrackerPlugin, AttachmentListPlugin, BreadCrumbsPlugin, CalendarPlugin, CommentPlugin, CompareRevisionsAddonPlugin, EditTablePlugin, FilterPlugin, FlexWebListPlugin, FootNotePlugin, GluePlugin, IfDefinedPlugin, InterwikiPlugin, JQueryPlugin, NatSkinPlugin, PreferencesPlugin, RedDotPlugin, RenderListPlugin, SlideShowPlugin, SmiliesPlugin, TablePlugin, TreeBrowserPlugin, TreePlugin, TwistyPlugin, VotePlugin, WysiwygPlugin
- Related: PLUGINDESCRIPTIONS, FAILEDPLUGINS, PLUGINVERSION
ALLVARIABLES -- list of currently defined TWikiVariables
- Syntax:
%ALLVARIABLES%
- Expands to: a table showing all defined TWikiVariables in the current context
AQUA -- start aqua colored text
-
AQUA is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
- Syntax:
%AQUA% aqua text %ENDCOLOR%
- Expands to: aqua text
- Note:
%<color>% text must end with %ENDCOLOR% . If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR% , e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR% .
- Related: ENDCOLOR, TWikiPreferences, StandardColors
ATTACHURL -- full URL for attachments in the current topic
ATTACHURLPATH -- path of the attachment URL of the current topic
AUTHREALM -- authentication realm
BASETOPIC -- base topic where an INCLUDE started
- The name of the topic where a single or nested INCLUDE started - same as
%TOPIC% if there is no INCLUDE
- Syntax:
%BASETOPIC%
- Related: BASEWEB, INCLUDINGTOPIC, INCLUDE, TOPIC
BASEWEB -- base web where an INCLUDE started
- The web name where the includes started, e.g. the web of the first topic of nested includes. Same as
%WEB% in case there is no include.
- Syntax:
%BASEWEB%
- Related: BASETOPIC, INCLUDINGWEB, INCLUDE, WEB
BB -- bullet with line break
BB2 -- level 2 bullet with line break
BB3 -- level 3 bullet with line break
BB4 -- level 4 bullet with line break
BLACK -- start black colored text
-
BLACK is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
- Syntax:
%BLACK% black text %ENDCOLOR%
- Expands to: black text
- Note:
%<color>% text must end with %ENDCOLOR% . If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR% , e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR% .
- Related: ENDCOLOR, TWikiPreferences, StandardColors
BLUE -- start blue colored text
-
BLUE is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
- Syntax:
%BLUE% blue text %ENDCOLOR%
- Expands to: blue text
- Note:
%<color>% text must end with %ENDCOLOR% . If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR% , e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR% .
- Related: ENDCOLOR, TWikiPreferences, StandardColors
BR -- line break
BROWN -- start brown colored text
-
BROWN is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
- Syntax:
%BROWN% brown text %ENDCOLOR%
- Expands to: brown text
- Note:
%<color>% text must end with %ENDCOLOR% . If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR% , e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR% .
- Related: ENDCOLOR, TWikiPreferences, StandardColors
BULLET -- bullet character
DATE -- signature format date
DISPLAYTIME -- display time
DISPLAYTIME{"format"} -- formatted display time
- Formatted time - either GMT or Local server time, depending on setting in configure. Same format qualifiers as
%GMTIME%
- Syntax:
%DISPLAYTIME{"format"}%
- Example:
%DISPLAYTIME{"$hou:$min"}% expands to 01:40
- Related: DISPLAYTIME, GMTIME, SERVERTIME
ENCODE{"string"} -- encodes a string to HTML entities
- Encode "special" characters to HTML numeric entities. Encoded characters are:
- all non-printable ASCII characters below space, except newline (
"\n" ) and linefeed ("\r" )
- HTML special characters
"<" , ">" , "&" , single quote (' ) and double quote (" )
- TWiki special characters
"%" , "[" , "]" , "@" , "_" , "*" , "=" and "|"
- Syntax:
%ENCODE{"string"}%
- Supported parameters:
Parameter: | Description: | Default: | "string" | String to encode | required (can be empty) | type="entity" | Encode special characters into HTML entities, like a double quote into " . Does not encode \n or \r . | type="url" | type="html" | As type="entity" except it also encodes \n and \r | type="url" | type="quote" | Escape double quotes with backslashes (\" ), does not change other characters | type="url" | type="url" | Encode special characters for URL parameter use, like a double quote into %22 | (this is the default) |
- Example:
%ENCODE{"spaced name"}% expands to spaced%20name
-
Note: Values of HTML input fields must be entity encoded. Example: <input type="text" name="address" value="%ENCODE{ "any text" type="entity" }%" />
-
Note: Double quotes in strings must be escaped when passed into other TWiki variables. Example: %SEARCH{ "%ENCODE{ "string with "quotes"" type="quotes" }%" noheader="on" }%
ENDCOLOR -- end colored text
-
ENDCOLOR is a rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
- Syntax:
%RED% red text %ENDCOLOR%
- Expands to: red text
- Note:
%<color>% text must end with %ENDCOLOR% . If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR% , e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR% .
- Related: VarAQUA, VarBLACK, VarBLUE, VarBROWN, VarGRAY, VarGREEN, VarLIME, VarMAROON, VarNAVY, VarOLIVE, VarORANGE, VarPINK, VarPURPLE, VarRED, VarSILVER, VarTEAL, VarWHITE, VarYELLOW, TWikiPreferences, StandardColors
ENDSECTION{"name"} -- marks the end of a named section within a topic
- Syntax:
%ENDSECTION{"name"}%
- Syntax:
%ENDSECTION{type="include"}%
- Supported parameter:
Parameter: | Description: | "name" | Name of the section. | type="..." | Type of the section being terminated; supported types "section" , "include" , "templateonly" . |
- If the
STARTSECTION is named, the corresponding ENDSECTION must also be named with the same name. If the STARTSECTION specifies a type, then the corresponding ENDSECTION must also specify the same type. If the section is unnamed, ENDSECTION will match with the nearest unnamed %STARTSECTION% of the same type above it.
- Related: STARTSECTION
FAILEDPLUGINS -- debugging for plugins that failed to load, and handler list
FORMFIELD{"fieldname"} -- renders a field in the form attached to some topic
- Syntax:
%FORMFIELD{"fieldname"}%
- Supported parameters:
Parameter: | Description: | Default: | "fieldname" | The name of a TWiki form field | required | topic="..." | Topic where form data is located. May be of the form Web.TopicName | Current topic | format="..." | Format string. $value expands to the field value, and $title expands to the field title | "$value" | default="..." | Text shown when no value is defined for the field | "" | alttext="..." | Text shown when field is not found in the form | "" |
- Example:
%FORMFIELD{"ProjectName" topic="Projects.SushiProject" default="(not set)" alttext="ProjectName field found"}%
- Related: SEARCH
GMTIME -- GM time
GMTIME{"format"} -- formatted GM time
- Syntax:
%GMTIME{"format"}%
- Supported variables:
Variable: | Unit: | Example | $seconds | seconds | 59 | $minutes | minutes | 59 | $hours | hours | 23 | $day | day of month | 31 | $wday | day of the Week (Sun, Mon, Tue, Wed, Thu, Fri, Sat) | Thu | $dow | day of the week (Sun = 0) | 2 | $week | number of week in year (ISO 8601) | 34 | $month | month in ISO format | Dec | $mo | 2 digit month | 12 | $year | 4 digit year | 1999 | $ye | 2 digit year | 99 | $tz | either "GMT" (if set to gmtime), or "Local" (if set to servertime) | GMT | $iso | ISO format timestamp | 2024-09-01T01:40:52Z | $rcs | RCS format timestamp | 2024/09/01 01:40:52 | $http | E-mail & http format timestamp | Sun, 01 Sep 2024 01:40:52 GMT | $epoch | Number of seconds since 00:00 on 1st January, 1970 | 1725154852 |
- Variables can be shortened to 3 characters
- Example:
%GMTIME{"$day $month, $year - $hour:$min:$sec"}% expands to 01 Sep, 2024 - 01:40:52
-
Note: When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TWikiTemplates#TemplateTopicsVars for details.
- Related: DISPLAYTIME, GMTIME, REVINFO, SERVERTIME
GRAY -- start gray colored text
-
GRAY is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
- Syntax:
%GRAY% gray text %ENDCOLOR%
- Expands to: gray text
- Note:
%<color>% text must end with %ENDCOLOR% . If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR% , e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR% .
- Related: ENDCOLOR, TWikiPreferences, StandardColors
GREEN -- start green colored text
-
GREEN is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
- Syntax:
%GREEN% green text %ENDCOLOR%
- Expands to: green text
- Note:
%<color>% text must end with %ENDCOLOR% . If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR% , e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR% .
- Related: ENDCOLOR, TWikiPreferences, StandardColors
GROUPS -- a formatted list of groups
H -- help icon
- Type: Preference variable - TWikiRenderingShortcut.
- Current value: H =
- Related: I, ICON, M, N, P, Q, S, T, U, X, Y
HOMETOPIC -- home topic in each web
HTTP -- get HTTP headers
HTTP_HOST -- environment variable
HTTPS -- get HTTPS headers
- The same as
%HTTP% but operates on the HTTPS environment variables present when the SSL protocol is in effect. Can be used to determine whether SSL is turned on.
- Syntax:
%HTTPS%
- Syntax:
%HTTPS{"Header-name"}%
- Related: HTTP, REMOTE_ADDR, REMOTE_PORT, REMOTE_USER
I -- idea icon
- Type: Preference variable - TWikiRenderingShortcut.
- Current value: I =
- Related: H, ICON, M, N, P, Q, S, T, U, X, Y
ICON{"name"} -- small documentation graphic or icon of common attachment types
- Generates the HTML img tag of a small graphic image attached to TWikiDocGraphics. Images typically have a 16x16 pixel size. You can select a specific image by name, or you can give a full filename, in which case the type of the file will be used to select one of a collection of common file type icons.
- Syntax:
%ICON{"name"}%
- Examples:
-
%ICON{"flag-gray"}% returns
-
%ICON{"pdf"}% returns
-
%ICON{"smile.pdf"}% returns
-
%ICON{"/dont/you/dare/smile.pdf"}% returns
-
%ICON{"http://twiki.org/doc/xhtml.xsl"}% returns
- Graphic samples:
arrowbright , bubble , choice-yes , hand
- File type samples:
bmp , doc , gif , hlp , html , mp3 , pdf , ppt , txt , xls , xml , zip
- Related: ICONURL, ICONURLPATH, TWikiPreferences, FileAttachments, TWikiDocGraphics
ICONURL{"name"} -- URL of small documentation graphic or icon
- Generates the full URL of a TWikiDocGraphics image, which TWiki renders as an image. The related
%ICON{"name"}% generates the full HTML img tag. Specify image name or full filename (see ICON for details on filenames.)
- Syntax:
%ICONURL{"name"}%
- Examples:
-
%ICONURL{"arrowbright"}% returns https://moglen.law.columbia.edu/twiki/pub/TWiki/TWikiDocGraphics/arrowbright.gif
-
%ICONURL{"novel.pdf"}% returns https://moglen.law.columbia.edu/twiki/pub/TWiki/TWikiDocGraphics/pdf.gif
-
%ICONURL{"/queen/boheme.mp3"}% returns https://moglen.law.columbia.edu/twiki/pub/TWiki/TWikiDocGraphics/mp3.gif
- Related: ICONURLPATH, ICON, TWikiPreferences, FileAttachments, TWikiDocGraphics
ICONURLPATH{"name"} -- URL path of small documentation graphic or icon
- Generates the URL path of a TWikiDocGraphics image, typically used in an HTML img tag. Specify image name or full filename (see ICON for details on filenames.)
- Syntax:
%ICONURLPATH{"name"}%
- Examples:
-
%ICONURLPATH{"locktopic"}% returns /twiki/pub/TWiki/TWikiDocGraphics/locktopic.gif
-
%ICONURLPATH{"eggysmell.xml"}% returns /twiki/pub/TWiki/TWikiDocGraphics/xml.gif
-
%ICONURLPATH{"/doc/xhtml.xsl"}% returns /twiki/pub/TWiki/TWikiDocGraphics/xsl.gif
- Related: ICONURL, ICON, TWikiPreferences, FileAttachments, TWikiDocGraphics
IF{"condition" ...} -- simple conditionals
- Evaluate a condition and show one text or another based on the result. See details in IfStatements
- Syntax:
%IF{"CONDITION" then="THEN" else="ELSE"}% shows "THEN" if "CONDITION" evaluates to TRUE , otherwise "ELSE" will be shown
- Example:
%IF{"defined FUNFACTOR" then="FUNFACTOR is defined" else=" is not defined"}% renders as ==
- Related: $IF() of SpreadSheetPlugin
INCLUDE{"page"} -- include other topic or web page
- Syntax:
%INCLUDE{"page" ...}%
- Supported parameters:
Parameter: | Description: | Default: | "SomeTopic" | The name of a topic located in the current web, i.e. %INCLUDE{"WebNotify"}% | | "Web.Topic" | A topic in another web, i.e. %INCLUDE{"TWiki.SiteMap"}% | | "http://..." | A full qualified URL, i.e. %INCLUDE{"http://twiki.org:80/index.html"}% . Supported content types are text/html and text/plain . if the URL resolves to an attachment file on the server this will automatically translate to a server-side include. | | pattern="..." | Include a subset of a topic or a web page. Specify a RegularExpression that scans from start ('^' ) to end and contains the text you want to keep in parenthesis, e.g., pattern="^.*?(from here.*?to here).*" . IncludeTopicsAndWebPages has more. | none | rev="2" | Include a previous topic revision; N/A for URLs | top revision | raw="on" | When a page is included, normally TWiki will process it, doing the following: 1) Alter relative links to point back to originating host, 2) Remove some basic HTML tags (html, head, body, script) and finally 3) Remove newlines from HTML tags spanning multiple lines. If you prefer to include exactly what is in the source of the originating page set this to on . raw="on" is short for disableremoveheaders="on" , disableremovescript="on" , disableremovebody="on" , disablecompresstags="on" and disablerewriteurls="on" . | disabled | literal="on" | While using the raw option will indeed include the raw content, the included content will still be processed and rendered like regular topic content. To disable parsing of the included content, set the literal option to "on" . | disabled | disableremoveheaders="on" | Bypass stripping headers from included HTML (everything until first </head> tag) | disabled | disableremovescript="on" | Bypass stripping all <script> tags from included HTML | disabled | disableremovebody="on" | Bypass stripping the </body> tag and everything around over and below it | disabled | disablecompresstags="on" | Bypass replacing newlines in HTML tags with spaces. This compression step rewrites unmatched <'s into < entities unless bypassed | disabled | disablerewriteurls="on" | Bypass rewriting relative URLs into absolute ones | disabled | warn="off" | Warn if topic include fails: Fail silently (if off ); output default warning (if set to on ); else, output specific text (use $topic for topic name) | %INCLUDEWARNING% preferences setting | section="name" | Includes only the specified named section, as defined in the included topic by the STARTSECTION and ENDSECTION variables. Nothing is shown if the named section does not exists. | | PARONE="val 1" PARTWO="val 2" | Any other parameter will be defined as a variable within the scope of the included topic. The example parameters on the left will result in %PARONE% and %PARTWO% being defined within the included topic. | |
- Note: JavaScript in included webpages is filtered out as a security precaution per default (disable filter with
disableremovescript parameter)
- Examples: See IncludeTopicsAndWebPages
- Related: BASETOPIC, BASEWEB, INCLUDINGTOPIC, INCLUDINGWEB, STARTINCLUDE, STOPINCLUDE, STARTSECTION, ENDSECTION
INCLUDINGTOPIC -- name of topic that includes current topic
- The name of the topic that includes the current topic - same as
%TOPIC% in case there is no include
- Syntax:
%INCLUDINGTOPIC%
- Related: BASETOPIC, INCLUDINGWEB, INCLUDE, TOPIC
INCLUDINGWEB -- web that includes current topic
- The web name of the topic that includes the current topic - same as
%WEB% if there is no INCLUDE.
- Syntax:
%INCLUDINGWEB%
- Related: BASEWEB, INCLUDINGTOPIC, INCLUDE, WEB
LANGUAGE -- current user's language
- Returns the language code for the language used as the current user. This is the language actually used by TWiki Internationalization (e.g. in user interface).
- The language is detected from the user's browser, unless some site/web/user/session-defined setting overrides it:
- If the
LANGUAGE preference is set, it's used as user's language instead of any language detected from the browser.
- Avoid defining
LANGUAGE at a non per-user way, so each user can choose his/her preferred language.
- Related: LANGUAGES
LANGUAGES -- list available TWiki languages
- List the languages available (as
PO files) to TWiki. Those are the languages in which TWiki's user interface is available.
- Syntax:
%LANGUAGES{...}%
- Supported parameters:
Parameter: | Description: | Default: | format | format for each item. See below for variables available in the format string. | " * $langname" | separator | separator between items. | "\n" (newline) | marker="selected" | Text for $marker if the item matches selection | "selected" | selection="%LANGUAGE%" | Current language to be selected in list | (none) |
-
format variables: Variable | Meaning | $langname | language's name, as informed by the translators | $langtag | language's tag. Ex: en , pt-br , etc. |
- Example:
<select>%LANGUAGES{format="<option $marker value='$langtag'>$langname</option>" selection="%LANGUAGE%"}%</select> creates an option list of the available languages with the current language selected
LIME -- start lime colored text
-
LIME is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
- Syntax:
%LIME% lime text %ENDCOLOR%
- Expands to: lime text
- Note:
%<color>% text must end with %ENDCOLOR% . If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR% , e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR% .
- Related: ENDCOLOR, TWikiPreferences, StandardColors
LOCALSITEPREFS -- web.topicname of site preferences topic
- The full name of the local site preferences topic. This topic is read for preferences before TWiki.%TWIKIPREFSTOPIC% is read.
- Syntax:
%LOCALSITEPREFS%
- Expands to:
Main.TWikiPreferences , renders as TWikiPreferences
LOGIN -- present a full login link
LOGOUT -- present a full logout link
M -- moved to... icon
- Type: Preference variable - TWikiRenderingShortcut.
- Current value: M =
- Related: H, I, ICON, N, P, Q, S, T, U, X, Y
MAINWEB -- name of Main web
MAKETEXT -- creates text using TWiki's I18N infrastructure
- Syntax:
%MAKETEXT{"string" args="..."}
- Supported parameters:
Parameter | Description | Default | "text" or string="text" | The text to be displayed. | none | args="param1, param2" | a comma-separated list of arguments to be interpolated in the string, replacing the [_N] placeholders in it. | none |
- Examples:
-
%MAKETEXT{string="Notes:"}% expands to Notes:
-
%MAKETEXT{"If you have any questions, please contact [_1]." args="%WIKIWEBMASTER%"}% expands to If you have any questions, please contact webmaster@new.law.columbia.edu.
-
%MAKETEXT{"Did you want to [[[_1]][reset [_2]'s password]]?" args="%TWIKIWEB%.ResetPassword,%WIKIUSERNAME%"}% expands to Did you want to reset Main.TWikiGuest's password?
- Notes:
- TWiki will translate the
string to the current user's language only if it has such string in its translation table for that language.
- Amperstands (
& ) followed by one letter (one of a...z, A...Z) (say, X ) in the translatable string will be translated to <span class='twikiAccessKey'>X</span> . This is used to implement access keys. If you want to write an actual amperstand that stays just before a letter, write two consecutive amperstands (&& ): they will be transformed in just one.
- translatable string starting with underscores (
_ ) are reserved. You cannot use translatable phrases starting with an underscore.
- Make sure that the translatable string is constant. Specially, do not include
%VARIABLES% inside the translatable strings (since they will get expanded before the %MAKETEXT{...}% itself is handled).
MAROON -- start maroon colored text
-
MAROON is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
- Syntax:
%MAROON% maroon text %ENDCOLOR%
- Expands to: maroon text
- Note:
%<color>% text must end with %ENDCOLOR% . If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR% , e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR% .
- Related: ENDCOLOR, TWikiPreferences, StandardColors
META -- displays meta-data
- Provided mainly for use in templates, this variable generates the parts of the topic view that relate to meta-data (attachments, forms etc.) The
formfield item is the most likely to be useful to casual users.
- Syntax:
%META{ "item" ...}%
- Parameters:
Item | Options | Description | "formfield" | name="..." : name of the field. The field value can be shortened as described in FormattedSearch for $formfield newline="..." : by default, each newline character will be rewritten to <br /> to allow metadata that contains newlines to be used in tables, etc. $n indicates a newline character. bar="..." : by default, each vertical bar is rewritten to an HTML entity so as to not be mistaken for a table separator. | Show a single form field | "form" | none | Generates the table showing the form fields. See Form Templates | "attachments" | all="on" to show hidden attachments. title="..." to show a title - only if attachments are displayed. template="..." to use a custom template for the rendering of attachments; default attachtables is used. | Generates the list of attachments | "moved" | none | Details of any topic moves | "parent" | dontrecurse="on" : By default recurses up tree, this has some cost. nowebhome="on" : Suppress WebHome. prefix="..." : Prefix that goes before parents, but only if there are parents, default "" . format="..." : Format string used to display each parent topic where $web expands to the web name, and $topic expands to the topic name; default: "[[$web.$topic][$topic]]" suffix="..." : Suffix, only appears if there are parents; default "" . separator="..." : Separator between parents; default " > " . | Generates the parent link |
- Related: METASEARCH
METASEARCH -- special search of meta data
- Syntax:
%METASEARCH{...}%
- Supported parameters:
Parameter: | Description: | Default: | type="topicmoved" | What sort of search is required? "topicmoved" if search for a topic that may have been moved "parent" if searching for topics that have a specific parent i.e. its children "field" if searching for topics that have a particular form field value (use the name and value parameters to specify which field to search) | required | web="%WEB%" | Wiki web to search: A web, a list of webs separated by whitespace, or all webs. | current web | topic="%TOPIC%" | The topic the search relates to, for topicmoved and parent searches | current topic | name | form field to search, for field type searches. May be a regular expression (see SEARCH). | | value | form field value, for field type searches. May be a regular expression (see SEARCH). | | title="Title" | Text that is prefixed to any search results | empty | default="none" | Default text shown if no search hit | empty |
- Example:
%METASEARCH{type="topicmoved" web="%WEB%" topic="%TOPIC%" title="This topic used to exist and was moved to: "}%
- Example: You may want to use this in WebTopicViewTemplate and WebTopicNonWikiTemplate:
%METASEARCH{type="parent" web="%WEB%" topic="%TOPIC%" title="Children: "}%
- Example:
%METASEARCH{type="field" name="Country" value="China"}%
- Related: SEARCH, META
N -- "new" icon
- Type: Preference variable - TWikiRenderingShortcut.
- Current value: N =
- Related: H, I, ICON, M, P, Q, S, T, U, X, Y
NAVY -- start navy blue colored text
-
NAVY is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
- Syntax:
%NAVY% navy text %ENDCOLOR%
- Expands to: navy text
- Note:
%<color>% text must end with %ENDCOLOR% . If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR% , e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR% .
- Related: ENDCOLOR, TWikiPreferences, StandardColors
NOP -- template text not to be expanded in instantiated topics
- Syntax:
%NOP%
- In normal topic text, expands to <nop>, which prevents expansion of adjacent variables and wikiwords
- When the topic containing this is used as a template for another topic, it is removed.
- Syntax:
%NOP{...}% deprecated
- In normal topic text, expands to whatever is in the curly braces (if anything).
-
Note: This is deprecated. Do not use it. Use %STARTSECTION{type="templateonly"}% .. %ENDSECTION{type="templateonly"}% instead (see TWikiTemplates for more details).
- Related: STARTSECTION, TWikiTemplates
NOTIFYTOPIC -- name of the notify topic
OLIVE -- start olive green colored text
-
OLIVE is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
- Syntax:
%OLIVE% olive text %ENDCOLOR%
- Expands to: olive text
- Note:
%<color>% text must end with %ENDCOLOR% . If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR% , e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR% .
- Related: ENDCOLOR, TWikiPreferences, StandardColors
ORANGE -- start orange colored text
-
ORANGE is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
- Syntax:
%ORANGE% orange text %ENDCOLOR%
- Expands to: orange text
- Note:
%<color>% text must end with %ENDCOLOR% . If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR% , e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR% .
- Related: ENDCOLOR, TWikiPreferences, StandardColors
P -- pencil icon
- Type: Preference variable - TWikiRenderingShortcut.
- Current value: P =
- Related: H, I, ICON, M, N, Q, S, T, U, X, Y
PINK -- start pink colored text
-
PINK is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
- Syntax:
%PINK% pink text %ENDCOLOR%
- Expands to: pink text
- Note:
%<color>% text must end with %ENDCOLOR% . If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR% , e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR% .
- Related: ENDCOLOR, TWikiPreferences, StandardColors
PLUGINDESCRIPTIONS -- list of plugin descriptions
- Syntax:
%PLUGINDESCRIPTIONS%
- Expands to:
- SpreadSheetPlugin (any TWiki, 10197): Add spreadsheet calculation like
"$SUM( $ABOVE() )" to TWiki tables and other topic text - ActionTrackerPlugin (21 May 2007, $Rev: 14969 (20 Sep 2007) $): Adds support for action tags in topics, and automatic notification of action statuses
- AttachmentListPlugin (1.0.1, $Rev: 15921 (07 Dec 2007) $): Displays a formattable list of topic attachments, anywhere in a topic.
- BreadCrumbsPlugin (v1.00, $Rev: 13657 (08 May 2007) $): A flexible way to display breadcrumbs navigation
- CalendarPlugin (Dakar, 9113): Show a monthly calendar with highlighted events
- CommentPlugin (Dakar, 11359): Allows users to quickly post comments to a page without an edit/preview/save cycle
- CompareRevisionsAddonPlugin (Dakar, $Rev: 9808$):
- EditTablePlugin (any TWiki, 11646): Edit TWiki tables using edit fields, date pickers and drop down boxes
- FilterPlugin (1.40, $Rev: 15932 (07 Dec 2007) $): Substitute and extract information from content by using regular expressions
- FlexWebListPlugin (v1.21, $Rev: 16132 (03 Jan 2008) $): Flexible way to display hierarchical weblists
- FootNotePlugin (2.006): Footnotes are notes placed at the end of a topic.
- GluePlugin (2.00, $Rev: 15708 (23 Nov 2007) $): Enable markup to span multiple lines
- IfDefinedPlugin (v1.01, $Rev: 15157 (05 Oct 2007) $): Render content conditionally
- InterwikiPlugin (Dakar, $Rev: 11935$): Link
ExternalSite:Page text to external sites based on aliases defined in a rules topic - JQueryPlugin (v0.4, $Rev: 15608 (15 Nov 2007) $): jQuery JavaScript library for TWiki
- NatSkinPlugin (3.00-pre17, $Rev: 15581 (13 Nov 2007) $): Supplements the bare bones NatSkin theme for TWiki
- PreferencesPlugin (Dakar, 9839): Allows editing of preferences using fields predefined in a form
- RedDotPlugin (1.40, $Rev: 16137 (03 Jan 2008) $): Renders edit-links as little red dots
- RenderListPlugin (any TWiki, 1.034): Render bullet lists in a variety of formats
- SlideShowPlugin (Any TWiki, $Rev: 12847$): Create web based presentations based on topics with headings.
- SmiliesPlugin (Dakar, 8154): Render smilies as icons, like
for :-) or for = :eek:= - TablePlugin (1.020, 12339): Control attributes of tables and sorting of table columns
- TreeBrowserPlugin (v1.8): Renders a list as a collapsable/expandable tree.
- TreePlugin (1.7): Dynamic generation of TWiki topic trees
- TwistyPlugin (1.2.0, $Rev: 12154$): Twisty section JavaScript library to open/close content dynamically
- VotePlugin (1.33, $Rev: 14312 (01 Jul 2007) $): Simple way to count votes
- WysiwygPlugin (Dakar, 12422): Translator framework for Wysiwyg editors
- Related: ACTIVATEDPLUGINS, FAILEDPLUGINS, PLUGINVERSION
PLUGINVERSION -- the version of a TWiki Plugin, or the TWiki Plugins API
PUBURL -- the base URL of attachments
PUBURLPATH -- the base URL path of attachments
PURPLE -- start purple colored text
-
PURPLE is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
- Syntax:
%PURPLE% purple text %ENDCOLOR%
- Expands to: purple text
- Note:
%<color>% text must end with %ENDCOLOR% . If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR% , e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR% .
- Related: ENDCOLOR, TWikiPreferences, StandardColors
Q -- question icon
- Type: Preference variable - TWikiRenderingShortcut.
- Current value: Q =
- Related: H, I, ICON, M, N, P, S, T, U, X, Y
QUERYPARAMS -- show paramaters to the query
- Expands the parameters to the query that was used to display the page.
- Syntax:
%QUERYPARAMS{...}%
- Parameters:
-
format="..." format string for each entry, default $name=$value
-
separator="..." separator string, default separator="$n" (newline)
- The following escape sequences are expanded in the format string:
Sequence: | Expands To: | $name | Name of the parameter | $value | String value of the parameter. Multi-valued parameters will have a "row" for each value. | $n or $n() | New line. Use $n() if followed by alphanumeric character, e.g. write Foo$n()Bar instead of Foo$nBar | $nop or $nop() | Is a "no operation". | $quot | Double quote (" ) | $percnt | Percent sign (% ) | $dollar | Dollar sign ($ ) |
- Example:
-
%QUERYPARAMS{format="<input type='hidden' name='$name' value='$percntENCODE{$quot()$value$quot type=$quot()html$quot}$percnt' />"}%
- See also QUERYSTRING, URLPARAM
QUERYSTRING -- full, unprocessed string of parameters to this URL
- String of all the URL parameters that were on the URL used to get to the current page. For example, if you add ?name=Samantha;age=24;eyes=blue to this URL you can see this in action. This string can be appended to a URL to pass parameter values on to another page.
-
Note: URLs built this way are typically restricted in length, typically to 2048 characters. If you need more space than this, you will need to use an HTML form and %QUERYPARAMS% .
- Syntax:
%QUERYSTRING%
- Expands to:
- Related: QUERYPARAMS, URLPARAM
RED -- start red colored text
-
RED is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
- Syntax:
%RED% red text %ENDCOLOR%
- Expands to: red text
- Note:
%<color>% text must end with %ENDCOLOR% . If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR% , e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR% .
- Related: ENDCOLOR, TWikiPreferences, StandardColors
REMOTE_ADDR -- environment variable
REMOTE_PORT -- environment variable
REMOTE_USER -- environment variable
REVINFO -- revision information of current topic
REVINFO{"format"} -- formatted revision information of topic
- Syntax:
%REVINFO{"format"}%
- Supported parameters:
Parameter: | Description: | Default: | "format" | Format of revision information, see supported variables below | "r1.$rev - $date - $wikiusername" | web="..." | Name of web | Current web | topic="..." | Topic name | Current topic | rev="1.5" | Specific revison number | Latest revision |
- Supported variables in format:
Variable: | Unit: | Example | $web | Name of web | Current web | $topic | Topic name | Current topic | $rev | Revison number. Prefix r1. to get the usual r1.5 format | 5 | $username | Login username of revision | jsmith | $wikiname | WikiName of revision | JohnSmith | $wikiusername | WikiName with Main web prefix | Main.JohnSmith | $date | Revision date | 21 Sep 2006 | $time | Revision time | 23:24:25 | $iso | Revision date in ISO date format | 2006-09-22T06:24:25Z | $min , $sec , etc. | Same date format qualifiers as GMTIME{"format"} | |
- Example:
%REVINFO{"$date - $wikiusername" rev="1.1"}% returns revision info of first revision
- Related: GMTIME{"format"}, REVINFO
S -- red star icon
- Type: Preference variable - TWikiRenderingShortcut.
- Current value: S =
- Related: H, I, ICON, M, N, P, Q, T, U, X, Y
SCRIPTNAME -- name of current script
- The name of the current script is shown, including script suffix, if any (for example
viewauth.cgi )
- Syntax:
%SCRIPTNAME%
- Expands to:
rdiff
- Related: SCRIPTSUFFIX, SCRIPTURL, SCRIPTURLPATH
SCRIPTSUFFIX -- script suffix
- Some TWiki installations require a file extension for CGI scripts, such as
.pl or .cgi
- Syntax:
%SCRIPTSUFFIX%
- Expands to:
- Related: SCRIPTNAME, SCRIPTURL, SCRIPTURLPATH
SCRIPTURL -- base URL of TWiki scripts
SCRIPTURL{"script"} -- URL of TWiki script
- Syntax:
%SCRIPTURL{"script"}%
- Expands to:
https://moglen.law.columbia.edu/twiki/bin/script
- Example: To get the authenticated version of the current topic you can write
%SCRIPTURL{"viewauth"}%/%WEB%/%TOPIC% which expands to https://moglen.law.columbia.edu/twiki/bin/viewauth/TWiki/TWikiVariables
-
Note: In most cases you should use %SCRIPTURLPATH{"script"}% instead, as it works with URL rewriting much better
- Related: PUBURL, SCRIPTNAME, SCRIPTSUFFIX, SCRIPTURL, SCRIPTURLPATH, SCRIPTURLPATH{"script"}
SCRIPTURLPATH -- base URL path of TWiki scripts
SCRIPTURLPATH{"script"} -- URL path of TWiki script
SEARCH{"text"} -- search content
- Inline search, shows a search result embedded in a topic
- Syntax:
%SEARCH{"text" ...}%
- Supported parameters:
Parameter: | Description: | Default: | "text" | Search term. Is a keyword search, literal search or regular expression search, depending on the type parameter. SearchHelp has more | required | search="text" | (Alternative to above) | N/A | web="Name" web="Main, Know" web="all" | Comma-separated list of webs to search. You can specifically exclude webs from an all search using a minus sign - for example, web="all,-Secretweb" . The special word all means all webs that do not have the NOSEARCHALL variable set to on in their WebPreferences. Note that TWikiAccessControls are respected when searching webs; it is much better to use them than NOSEARCHALL . | Current web | topic="WebPreferences" topic="*Bug" | Limit search to topics: A topic, a topic with asterisk wildcards, or a list of topics separated by comma. Note this is a list of topic names and must not include web names. | All topics in a web | excludetopic="Web*" excludetopic="WebHome, WebChanges" | Exclude topics from search: A topic, a topic with asterisk wildcards, or a list of topics separated by comma. Note this is a list of topic names and must not include web names. | None | type="keyword" type="literal" type="regex" | Do a keyword search like soap "web service" -shampoo ; a literal search like web service ; or RegularExpression search like soap;web service;!shampoo | %SEARCHVAR- DEFAULTTYPE% preferences setting (literal) | scope="topic" scope="text" scope="all" | Search topic name (title); the text (body) of topic; or all (both) | "text" | order="topic" order="created" order="modified" order="editby" order= "formfield(name)" | Sort the results of search by the topic names, topic creation time, last modified time, last editor, or named field of TWikiForms. The sorting is done web by web; if you want to sort across webs, create a formatted table and sort it with TablePlugin's initsort. Note that dates are sorted most recent date last (i.e at the bottom of the table). | Sort by topic name | limit="all" limit="16" | Limit the number of results returned. This is done after sorting if order is specified | All results | date="..." | limits the results to those pages with latest edit time in the given TimeInterval. | All results | reverse="on" | Reverse the direction of the search | Ascending search | casesensitive="on" | Case sensitive search | Ignore case | bookview="on" | BookView search, e.g. show complete topic text | Show topic summary | nonoise="on" | Shorthand for nosummary="on" nosearch="on" nototal="on" zeroresults="off" noheader="on" noempty="on" | Off | nosummary="on" | Show topic title only | Show topic summary | nosearch="on" | Suppress search string | Show search string | noheader="on" | Suppress default search header Topics: Changed: By: , unless a header is explicitly specified | Show default search header, unless search is inline and a format is specified (Cairo compatibility) | nototal="on" | Do not show number of topics found | Show number | zeroresults="off" | Suppress all output if there are no hits | zeroresults="on" , displays: "Number of topics: 0" | noempty="on" | Suppress results for webs that have no hits. | Show webs with no hits | header="..." format="..." | Custom format results: see FormattedSearch for usage, variables & examples | Results in table | expandvariables="on" | Expand variables before applying a FormattedSearch on a search hit. Useful to show the expanded text, e.g. to show the result of a SpreadSheetPlugin %CALC{}% instead of the formula | Raw text | multiple="on" | Multiple hits per topic. Each hit can be formatted. The last token is used in case of a regular expression ";" and search | Only one hit per topic | nofinalnewline="on" | If on , the search variable does not end in a line by itself. Any text continuing immediately after the search variable on the same line will be rendered as part of the table generated by the search, if appropriate. | off | recurse="on" | Recurse into subwebs, if subwebs are enabled. | off | separator=", " | Line separator between search hits | "$n" (Newline) | newline="%BR%" | Line separator within a search hit. Useful if the format="" parameter contains a $pattern() that captures more than one line, i.e. contents of a textfield in a form. | "$n" (Newline) |
- Example:
%SEARCH{"wiki" web="Main" scope="topic"}%
- Example with format:
%SEARCH{"FAQ" scope="topic" nosearch="on" nototal="on" header="| *Topic: * | *Summary: * |" format="| $topic | $summary |"% (displays results in a table with header - details)
-
Hint: If the TWiki:Plugins.TablePlugin is installed, you may set a %TABLE{}% variable just before the %SEARCH{}% to alter the output of a search. Example: %TABLE{ tablewidth="90%" }%
- Related: METASEARCH, TOPICLIST, WEBLIST, FormattedSearch, SearchHelp, SearchPatternCookbook, RegularExpression
SERVERTIME -- server time
SERVERTIME{"format"} -- formatted server time
- Same format qualifiers as
%GMTIME%
- Syntax:
%SERVERTIME{"format"}%
- Example:
%SERVERTIME{"$hou:$min"}% expands to 21:40
-
Note: When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TWikiTemplates#TemplateTopicsVars for details.
- Related: DISPLAYTIME, GMTIME, SERVERTIME
SESSIONID -- unique ID for this session
SESSIONVAR -- name of CGI and session variable that stores the session ID
SESSION_VARIABLE -- get, set or clear a session variable
SILVER -- start silver colored text
-
SILVER is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
- Syntax:
%SILVER% silver text %ENDCOLOR%
- Expands to: silver text
- Note:
%<color>% text must end with %ENDCOLOR% . If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR% , e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR% .
- Related: ENDCOLOR, TWikiPreferences, StandardColors
SPACEDTOPIC -- topic name, spaced and URL-encoded deprecated
- The current topic name with added URL-encoded spaces, for use in regular expressions that search for backlinks to the current topic
- Syntax:
%SPACEDTOPIC%
- Expands to:
Var%20*SPACEDTOPIC
-
Note: This is a deprecated variable. It can be duplicated with %ENCODE{%SPACEOUT{"%TOPIC%" separator=" *"}%}%
- Related: SPACEOUT, TOPIC, ENCODE
SPACEOUT{"string"} -- renders string with spaces inserted in sensible places
- Inserts spaces after lower case letters that are followed by a digit or a capital letter, and after digits that are followed by a capital letter.
- Useful for spacing out WikiWords
- Syntax:
%SPACEOUT{ "%TOPIC%" }%
- Expands to:
TWiki Variables
- Supported parameters:
Parameter: | Description: | Default: | separator | The separator to put between words e.g. %SPACEOUT{"DogsCatsBudgies" separator=", "}% -> Dogs, Cats, Budgies | ' ' |
-
Hint: Spaced out WikiWords are not automatically linked. To SPACEOUT a WikiWord but preserve the link use "double bracket" format. For example, [[WebHome][%SPACEOUT{"WebHome"}%]] expands to Web Home
- Related: SPACEDTOPIC, $PROPERSPACE() of SpreadSheetPlugin
STARTINCLUDE -- start position of topic text if included
- If present in included topic, start to include text from this location up to the end, or up to the location of the
%STOPINCLUDE% variable. A normal view of the topic shows everything exept the %STARTINCLUDE% variable itself.
- Note: If you want more than one part of the topic included, use
%STARTSECTION{type="include"}% instead
- Syntax:
%STARTINCLUDE%
- Related: INCLUDE, STARTSECTION, STOPINCLUDE
STARTSECTION -- marks the start of a section within a topic
- Section boundaries are defined with
%STARTSECTION{}% and %ENDSECTION{}% .
- Sections may be given a name to help identify them, and/or a type, which changes how they are used.
-
type="section" - the default, used for a generic section, such as a named section used by INCLUDE.
-
type="include" - like %STARTINCLUDE% ... %STOPINCLUDE% except that you can have as many include blocks as you want (%STARTINCLUDE% is restricted to only one).
-
type="templateonly" - start position of text to be removed when a template topic is used. This is used to embed text that you do not want expanded when a new topic based on the template topic is created. See TWikiTemplates for more information.
- Syntax:
%STARTSECTION{"name"}% ................ %ENDSECTION{"name"}%
- Syntax:
%STARTSECTION{type="include"}% ........ %ENDSECTION{type="include"}%
- Syntax:
%STARTSECTION{type="templateonly"}% ... %ENDSECTION{type="templateonly"}%
- Supported parameters:
Parameter: | Description: | Default | "name" | Name of the section. Must be unique inside a topic. | Generated name | type="..." | Type of the section; type "section" , "include" or "templateonly" | "section" |
-
Note: If a section is not given a name, it will be assigned one. Unnamed sections are assigned names starting with _SECTION0 for the first unnamed section in the topic, _SECTION1 for the second, etc..
-
Note: You can define nested sections. It is not recommended to overlap sections, although it is valid in TWiki. Use named sections to make sure that the correct START and ENDs are matched. Section markers are not displayed when a topic is viewed.
- Related: ENDSECTION, INCLUDE, NOP, STARTINCLUDE, STOPINCLUDE
STATISTICSTOPIC -- name of statistics topic
STOPINCLUDE -- end position of topic text if included
- If present in included topic, stop to include text at this location and ignore the remaining text. A normal view of the topic shows everyting exept the
%STOPINCLUDE% variable itself.
- Syntax:
%STOPINCLUDE%
- Related: INCLUDE, STARTINCLUDE
T -- tip icon
- Type: Preference variable - TWikiRenderingShortcut.
- Current value: T =
- Related: H, I, ICON, M, N, P, Q, S, U, X, Y
TEAL -- start teal colored text
-
TEAL is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
- Syntax:
%TEAL% teal text %ENDCOLOR%
- Expands to: teal text
- Note:
%<color>% text must end with %ENDCOLOR% . If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR% , e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR% .
- Related: ENDCOLOR, TWikiPreferences, StandardColors
TOC -- table of contents of current topic
TOC{"Topic"} -- table of contents
- Table of Contents. Shows a TOC that is generated automatically based on headings of a topic. Headings in WikiSyntax (
"---++ text" ) and HTML ("<h2>text</h2>" ) are taken into account. Any heading text after "!!" is excluded from the TOC; for example, write "---+!! text" if you do not want to list a header in the TOC
- Syntax:
%TOC{"SomeTopic" ...}%
- Supported parameters:
Parameter: | Description: | Default: | "TopicName" | topic name | Current topic | web="Name" | Name of web | Current web | depth="2" | Limit depth of headings shown in TOC | 6 | title="Some text" | Title to appear at top of TOC | none |
- Example:
%TOC{depth="2"}%
- Example:
%TOC{"TWikiDocumentation" web="TWiki" title="Contents:"}%
- Example: see TWiki:Sandbox.TestTopicInclude
-
Hint: TOC will generate links to the headings, so when a reader clicks on a heading it will jump straight where that heading is anchored in the text. If you have two headings with exactly the same text, then their anchors will also be identical and they won't be able to jump to them. To make the anchors unique, you can add an invisible HTML comment to the text of the heading. This will be hidden in normal view, but will force the anchors to be different. For example, ---+ Heading <!--5-->.
- Related: TOC
TOPIC -- name of current topic
-
%TOPIC% expands to the name of the topic. If you are looking at the text of an included topic, it is the name of the included topic.
- Syntax:
%TOPIC%
- Expands to:
TWikiVariables , renders as TWikiVariables
- Related: BASETOPIC, INCLUDINGTOPIC, TOPICLIST, WEB
TOPICLIST{"format"} -- topic index of a web
- List of all topics in a web. The "format" defines the format of one topic item. It may include variables: The
$name variable gets expanded to the topic name, $qname to double quoted name, $marker to marker parameter where topic matches selection , and $web to the name of the web.
- Syntax:
%TOPICLIST{"format" ...}%
- Supported parameters:
Parameter: | Description: | Default: | "format" | Format of one line, may include $web (name of web), $name (name of the topic), $qname (name of topic in double quotes), $marker (which expands to marker for the item matching selection only) | "$name" | format="format" | (Alternative to above) | "$name" | separator=", " | line separator | "$n" (new line) | marker="selected" | Text for $marker if the item matches selection | "selected" | selection="TopicA, TopicB" | Current value to be selected in list | (none) | web="Name" | Name of web | Current web |
- Example:
%TOPICLIST{" * $web.$name"}% creates a bullet list of all topics
- Example:
%TOPICLIST{separator=", "}% creates a comma separated list of all topics
- Example:
%TOPICLIST{" <option>$name</option>"}% creates an option list (for drop down menus)
- Example:
<select>%TOPICLIST{" <option $marker value='$name'>$name</option>" separator=" " selection="%TOPIC%"}%</select> creates an option list of web topics with the current topic selected
- Related: SEARCH, WEBLIST
TOPICURL -- shortcut to viewing the current topic
TWIKIWEB -- name of TWiki documentation web
- The web containing all documentation and site-wide preference settings for TWiki
- Syntax:
%TWIKIWEB%
- Expands to:
TWiki
- Related: MAINWEB
U -- "updated" icon
- Type: Preference variable - TWikiRenderingShortcut.
- Current value: U =
- Related: H, I, ICON, M, N, P, Q, S, T, X, Y
URLPARAM{"name"} -- get value of a URL parameter
- Returns the value of a URL parameter.
- Syntax:
%URLPARAM{"name"}%
- Supported parameters:
Parameter: | Description: | Default: | "name" | The name of a URL parameter | required | default="..." | Default value in case parameter is empty or missing | empty string | newline="<br />" | Convert newlines in textarea to other delimiters | no conversion | encode="entity" | Encode special characters into HTML entities. See ENCODE for more details. | no encoding | encode="url" | Encode special characters for URL parameter use, like a double quote into %22 | no encoding | encode="quote" | Escape double quotes with backslashes (\" ), does not change other characters; required when feeding URL parameters into other TWiki variables | no encoding | multiple="on" multiple="[[$item]]" | If set, gets all selected elements of a <select multiple="multiple"> tag. A format can be specified, with $item indicating the element, e.g. multiple="Option: $item" | first element | separator=", " | Separator between multiple selections. Only relevant if multiple is specified | "\n" (new line) |
- Example:
%URLPARAM{"skin"}% returns print for a .../view/TWiki/TWikiVariables?skin=print URL
-
Note: URL parameters passed into HTML form fields must be entity ENCODEd.
-
Note: Double quotes in URL parameters must be escaped when passed into other TWiki variables. Example: %SEARCH{ "%URLPARAM{ "search" encode="quotes" }%" noheader="on" }%
-
Note: When used in a template topic, this variable will be expanded when the template is used to create a new topic. See TWikiTemplates#TemplateTopicsVars for details.
-
Note: There is a risk that this variable could be misused for cross-site scripting.
- Related: ENCODE, SEARCH, FormattedSearch, QUERYSTRING
USERINFO{"WikiName"} -- retrieve details about a user
- Syntax:
%USERINFO%
- Expands to:
guest, TWikiGuest, (comma-separated list of the username, wikiusername, and emails)
- With formatted output, using tokens
$emails , $username , $wikiname , $wikiusername , and $groups :
- Example:
%USERINFO{ format="$username is really $wikiname" }%
- Expands to:
guest is really TWikiGuest
- Retrieve information about another user:
- Example:
%USERINFO{ "TWikiGuest" format="$username is really $wikiname" }%
- Expands to:
guest is really TWikiGuest
- Note: The parameter should be the wikiname of a user. You can only get information about another user if the
{AntiSpam}{HideUserDetails} configuration option is not enabled, or if you are an admin. (User details are hidden in this TWiki)
- Related: USERNAME, WIKINAME, WIKIUSERNAME, TWikiUserAuthentication, ChangeEmailAddress
USERNAME -- your login username
VAR{"NAME" web="Web"} -- get a preference value from another web
- Syntax:
%VAR{"NAME" web="Web"}%
- Example: To get
%WEBBGCOLOR% of the Main web write %VAR{"WEBBGCOLOR" web="Main"}% , which expands to #FFEFA6
- Related: WEBPREFSTOPIC
VBAR -- vertical bar
VOTE{ attributes } -- define a poll in a TWiki topic.
- The following standard attributes are recognized
Name | Description | Example | id | The identifier of the poll. You can have multiple independent votes in the same topic. | id="Dining" | selectN | Defines the name of a select vote, where you select one from a ranges of options. N is a number that identifies this item within the poll e.g. select1 , select2 etc. You must number all select and stars parameters uniquely and sequentially (e.g. select1 stars2 select3 | select1="Drink" | optionsN | Each selectN must have a corresponding optionsN that defines a comma-separated list of the options that can be selected between. | options1="Beer,Wine,Milk" | starsN | Defines the name of a rate vote, where you rate something by giving it a number of stars. N is a number that identifies this item within the poll e.g. select1 , stars2 etc. You must number all select and stars parameters uniquely and sequentially (e.g. select1 stars2 select3 | stars2="Usability" | widthN | Each starsN must have a corresponding widthN . This gives the number of stars to show e.g. width1="5" will show 5 stars. | width2="10" | formatN | Defines the format of the results display. See formatting results, below. | format="$large" | chartN | Defines the format of a single bar in the results bar chart generated for the corresponding select (for select type only). See formatting results, below. | chart="<p>$option $score</p>" | separator | Defines the string to be used to separate each row in the result. | separator="<br/>" | global | If set to "off" , this makes the id local to this topic (the default). If set to "on" it will be a global poll that can be accessed from many topics. | global="on" | open | If set to "off" this is a closed vote. If set to "on" it is open (the default) | open="on" | secret | If set to "off" , then the database will record who voted. If set to "on" , votes are secret (the default) | secret="on" | saveto | If set to the name of a topic, the poll results will be appended to the end of that topic. The results are formatted as a TWiki table for easy post-processing. | saveto="Main.VoteResults" | bayesian | If set to "on" , rating averages will be computed using the Bayesian average of this item against all the other items that have the same item in their stars field. This requires all the participating %VOTEs to be global , or to save their results to the same place using saveto . See http://www.thebroth.com/blog/118/bayesian-rating for more information about Bayesian rating. | bayesian="off" | submit | If set to "off" , this makes the %VOTE display the results of the vote without prompting for any input. This is useful when - for example - you want to show the results of a global vote, without permitting more voting. |
WEB -- name of current web
-
%WEB% expands to the name of the web where the topic is located. If you are looking at the text of an included topic, it is the web where the included topic is located.
- Syntax:
%WEB%
- Expands to:
TWiki
- Related: BASEWEB, INCLUDINGWEB, TOPIC
WEBLIST{"format"} -- index of all webs
- List of all webs. Obfusticated webs are excluded, e.g. webs with a
NOSEARCHALL = on preference variable. The "format" defines the format of one web item. The $name variable gets expanded to the name of the web, $qname gets expanded to double quoted name, $marker to marker where web matches selection .
- Syntax:
%WEBLIST{"format" ...}%
- Supported parameters:
Parameter: | Description: | Default: | "format" | Format of one line, may include $name (the name of the web), $qname (the name of the web in double quotes), $indentedname (the name of the web with parent web names replaced by indents, for use in indented lists), and $marker (which expands to marker for the item matching selection only) | "$name" | format="format" | (Alternative to above) | "$name" | separator=", " | Line separator | "$n" (new line) | webs="public" | Comma separated list of webs, public expands to all non-hidden. NOTE: Administrators will see all webs, not just the public ones | "public" | marker="selected" | Text for $marker if the item matches selection | "selected" | selection="%WEB%" | Current value to be selected in list | section="%WEB%" |
- Example:
%WEBLIST{" * [[$name.WebHome]]"}% - creates a bullet list of all webs.
- Example:
<form><select name="web"> %WEBLIST{"<option $marker value=$qname>$name</option>" webs="Trash, public" selection="%WEB%" separator=" "}% </select></form> - creates a dropdown of all public webs + Trash web, with the current web highlighted.
- Related: TOPICLIST, SEARCH
WEBPREFSTOPIC -- name of web preferences topic
WHITE -- start white colored text
-
WHITE is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
- Syntax:
%WHITE% white text %ENDCOLOR%
- Expands to: white text (shown with a gray background here)
- Note:
%<color>% text must end with %ENDCOLOR% . If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR% , e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR% .
- Related: ENDCOLOR, TWikiPreferences, StandardColors
WIKIHOMEURL -- site home URL
- Syntax
%WIKIHOMEURL%
- Expands to
/twiki/bin/view
- Defined in TWikiPreferences and normally per default set to
%SCRIPTURLPATH{"view"}%
-
Note: For the top bar logo URL use %WIKILOGOURL% defined in WebPreferences instead.
- Related: WIKITOOLNAME
WIKINAME -- your Wiki username
WIKIPREFSTOPIC -- name of site-wide preferences topic
WIKITOOLNAME -- name of your TWiki site
WIKIUSERNAME -- your Wiki username with web prefix
WIKIUSERSTOPIC -- name of topic listing all registers users
WIKIVERSION -- the version of the installed TWiki engine
X -- warning icon
- Type: Preference variable - TWikiRenderingShortcut.
- Current value: X =
- Related: H, I, ICON, M, N, P, Q, S, T, U, Y
Y -- "yes" icon
- Type: Preference variable - TWikiRenderingShortcut.
- Current value: Y =
- Related: H, I, ICON, M, N, P, Q, S, T, U, X
YELLOW -- start yellow colored text
-
YELLOW is one of the rendering shortcut settings predefined in TWikiPreferences. See the section rendering shortcut settings in that topic for a complete list of colors.
- Syntax:
%YELLOW% yellow text %ENDCOLOR%
- Expands to: yellow text
- Note:
%<color>% text must end with %ENDCOLOR% . If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR% , e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR% .
- Related: ENDCOLOR, TWikiPreferences, StandardColors
|
|
TextFormattingRules 2 - 23 Jun 1999 - Main.thoeny
|
|
- CapitalizedWordsWillProduce? a link automatically.
- Blank lines will create new paragraphs.
| |
< < |
- words get bold by enclosing it with * asterisks
- words get italic by enclosing it with _ underscores
- words get showns in
fixed font by enclosing it with = equal signs
| > > |
- Words get bold by enclosing them with * asterisks
- Words get italic by enclosing them with _ underscores
- Words get bold italic by enclosing them with __ two underscores
- Words get showns in
fixed font by enclosing it with = equal signs
- Notes for bold , italic , bold italic and
fixed font text:
- Make sure to "stick" the
* _ = signs to the characters, e.g.
- This works
- _This does not get italic because there is a space between the last word and the underline character _
- Example text to enter:
- Writing *bold text* , _italic text_ and =fixed== monospaced text
- Example text gets rendered as:
- Writing bold text , italic text and
fixed= monospaced text
| |
- Separator: -------- (at the beginning of a line)
- List Item: <3spaces>*
- Nested Item: <6spaces>*
|
|
TextFormattingRules 1 - 13 Jun 1999 - Main.thoeny
|
|
> > | It is easy to collaborate, just type your text. You don't need to know HTML at all, though you can use it if you prefer. Links to topics will be created automatically as long as you follow these simple Text Formatting Rules. TextFormattingFAQ has answers to frequently asked questions about text formatting.
LINKS
The Collaborative Work Area is a bunch of related links that are editable through your web browser.
The TWiki web has the following types of internal links:
- GoodStyle is a topic that is part of the current TWiki web.
- NotExistingYet? is a topic waiting to be written. You could create that topic by clicking on the question mark. (Do not create that topic, you would wreck this example!)
- ReadmeFirst? is a topic in a different TWiki web. (You write it as Web.TopicName , but it will show up as TopicName )
External links:
-
http://... , https://... , ftp://... and mailto:...@... are linked automatically.
- Email addresses like
name@domain.com are linked automatically.
EDITING
- CapitalizedWordsWillProduce? a link automatically.
- Blank lines will create new paragraphs.
- words get bold by enclosing it with * asterisks
- words get italic by enclosing it with _ underscores
- words get showns in
fixed font by enclosing it with = equal signs
- Separator: -------- (at the beginning of a line)
- List Item: <3spaces>*
- Nested Item: <6spaces>*
- Ordered List: <3spaces><number>.
- Definition: <3spaces><term>:<definition>.
EXTRAS
- Most HTML tags will work.
WIKI VARIABLES
%INCLUDE:"TWikiVariables.txt"% |
|
Revision 49 | r49 - 07 Mar 2006 - 18:38:28 - TWikiContributor |
Revision 48 | r48 - 27 Mar 2005 - 13:14:15 - TWikiContributor |
Revision 47 | r47 - 01 Aug 2004 - 10:51:40 - PeterThoeny? |
Revision 46 | r46 - 24 Jul 2004 - 08:21:33 - PeterThoeny? |
Revision 45 | r45 - 11 Jul 2004 - 07:46:26 - PeterThoeny? |
Revision 44 | r44 - 25 Apr 2004 - 06:29:37 - PeterThoeny? |
Revision 43 | r43 - 30 Mar 2004 - 05:39:47 - PeterThoeny? |
Revision 42 | r42 - 17 Mar 2004 - 07:03:50 - PeterThoeny? |
Revision 41 | r41 - 16 Dec 2003 - 08:41:03 - PeterThoeny? |
Revision 40 | r40 - 01 Aug 2003 - 05:12:16 - PeterThoeny? |
Revision 39 | r39 - 26 Jul 2003 - 21:37:04 - PeterThoeny? |
Revision 38 | r38 - 16 Jul 2003 - 23:57:00 - PeterThoeny? |
Revision 37 | r37 - 01 Feb 2003 - 20:47:48 - PeterThoeny? |
Revision 36 | r36 - 01 Feb 2003 - 11:12:00 - PeterThoeny? |
Revision 35 | r35 - 03 Oct 2002 - 01:40:05 - PeterThoeny? |
Revision 34 | r34 - 05 Jun 2002 - 01:27:00 - PeterThoeny? |
Revision 33 | r33 - 02 May 2002 - 21:41:50 - PeterThoeny? |
Revision 32 | r32 - 05 Apr 2002 - 13:36:49 - RichardDonkin? |
Revision 31 | r31 - 26 Mar 2002 - 08:26:34 - RichardDonkin? |
Revision 30 | r30 - 03 Dec 2001 - 04:11:51 - MikeMannix? |
Revision 29 | r29 - 02 Dec 2001 - 08:07:19 - MikeMannix? |
Revision 28 | r28 - 02 Oct 2001 - 07:37:03 - MikeMannix? |
Revision 27 | r27 - 18 Sep 2001 - 00:12:46 - MikeMannix? |
Revision 26 | r26 - 07 Sep 2001 - 05:05:03 - MikeMannix? |
Revision 25 | r25 - 06 Sep 2001 - 08:50:20 - MikeMannix? |
Revision 24 | r24 - 06 Sep 2001 - 07:49:13 - MikeMannix? |
Revision 23 | r23 - 06 Sep 2001 - 06:32:14 - MikeMannix? |
Revision 22 | r22 - 30 Aug 2001 - 17:26:24 - MikeMannix? |
Revision 21 | r21 - 30 Aug 2001 - 10:10:31 - MikeMannix? |
Revision 20 | r20 - 11 Aug 2001 - 07:41:20 - PeterThoeny? |
Revision 19 | r19 - 14 Jul 2001 - 08:48:15 - PeterThoeny? |
Revision 18 | r18 - 28 Jun 2001 - 22:15:10 - PeterThoeny? |
Revision 17 | r17 - 05 Apr 2001 - 07:31:04 - PeterThoeny? |
Revision 16 | r16 - 16 Mar 2001 - 00:07:53 - PeterThoeny? |
Revision 15 | r15 - 02 Mar 2001 - 01:23:27 - PeterThoeny? |
Revision 14 | r14 - 25 Feb 2001 - 03:14:21 - PeterThoeny? |
Revision 13 | r13 - 10 Feb 2001 - 10:09:44 - PeterThoeny? |
Revision 12 | r12 - 01 Feb 2001 - 01:34:06 - PeterThoeny? |
Revision 11 | r11 - 21 Jan 2001 - 08:59:42 - PeterThoeny? |
Revision 10 | r10 - 12 Dec 2000 - 19:01:00 - PeterThoeny? |
Revision 9 | r9 - 10 Dec 2000 - 22:26:47 - PeterThoeny? |
Revision 8 | r8 - 11 Nov 2000 - 06:51:06 - PeterThoeny? |
Revision 7 | r7 - 01 Nov 2000 - 23:58:30 - PeterThoeny? |
Revision 6 | r6 - 19 Sep 2000 - 07:37:29 - PeterThoeny? |
Revision 5 | r5 - 18 Aug 2000 - 06:50:00 - PeterThoeny? |
Revision 4 | r4 - 28 Feb 2000 - 08:45:06 - PeterThoeny? |
Revision 3 | r3 - 09 Aug 1999 - 06:25:08 - PeterThoeny? |
Revision 2 | r2 - 23 Jun 1999 - 16:09:34 - Main.thoeny |
Revision 1 | r1 - 13 Jun 1999 - 07:38:53 - Main.thoeny |
|
|
This site is powered by the TWiki collaboration platform. All material on this collaboration platform is the property of the contributing authors. All material marked as authored by Eben Moglen is available under the license terms CC-BY-SA version 4.
|
|