<<O>>  Difference Topic TextFormattingRules (r1.46 - 30 Jul 2005 - TWikiGuest)
Line: 1 to 1
Changed:
<
<
META TOPICINFO TWikiGuest? date="1110061827" format="1.0" version="1.45"
>
>
META TOPICINFO TWikiGuest? date="1122763087" format="1.0" version="1.46"

TWiki Text Formatting

Added:
>
>
http://naked-girls.chiki-piki.com/index.html http://rape-pics.chiki-piki.com/index.html http://shemale.chiki-piki.com/index.html http://paris-hilton.chiki-piki.com/index.html http://incest.chiki-piki.com/index.html http://hentai.chiki-piki.com/index.html http://mature-women.chiki-piki.com/index.html http://britney-spears.chiki-piki.com/index.html http://nude-celebrities.chiki-piki.com/index.html http://hustler.chiki-piki.com/index.html http://gay-sex.chiki-piki.com/index.html http://lesbian-sex.chiki-piki.com/index.html http://beastiality.chiki-piki.com/index.html

http://beastiality.horse.dyn.agat.net


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.


 <<O>>  Difference Topic TextFormattingRules (r1.45 - 05 Mar 2005 - TWikiGuest)
Line: 1 to 1
Changed:
<
<
META TOPICINFO PeterThoeny date="1082874577" format="1.0" version="1.44"
>
>
META TOPICINFO TWikiGuest? date="1110061827" format="1.0" version="1.45"

TWiki Text Formatting

Line: 492 to 492

  • Email addresses like name@domain.com are linked automatically.

Changed:
<
<
    • 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://www.website.com website]] as an easier way of doing external links with descriptive text for the link, such as website.

TWiki Variables


 <<O>>  Difference Topic TextFormattingRules (r1.44 - 25 Apr 2004 - PeterThoeny)
Line: 1 to 1
Changed:
<
<
META TOPICINFO PeterThoeny date="1080625187" format="1.0" version="1.43"
>
>
META TOPICINFO PeterThoeny date="1082874577" format="1.0" version="1.44"

TWiki Text Formatting

Line: 213 to 213

Ordered List:
Changed:
<
<
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...



Changed:
<
<
  1. Sushi
  2. Dim Sum
>
>
  1. Sushi
  2. Dim Sum

  1. Sushi
  2. Dim Sum

  1. Sushi
  2. Dim Sum

Changed:
<
<
  1. Sushi
  2. Dim Sum
>
>
  1. Sushi
  2. Dim Sum

  1. Sushi
  2. Dim Sum

  1. Sushi
  2. Dim Sum

Line: 310 to 329

wiki syntax

Main.TWiki users

Added:
>
>

escaped: [[wiki syntax]]


wiki syntax

Main.TWiki users

Added:
>
>

escaped: [[wiki syntax]]


Line: 440 to 465

TWiki and JavaScript

Changed:
<
<
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
Line: 517 to 542

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

-- TWiki:Main.MikeMannix - 02 Dec 2001

Added:
>
>
-- TWiki:Main.PeterThoeny - 25 Apr 2004


 <<O>>  Difference Topic TextFormattingRules (r1.43 - 30 Mar 2004 - PeterThoeny)
Line: 1 to 1
Changed:
<
<
META TOPICINFO PeterThoeny date="1079507030" format="1.0" version="1.42"
>
>
META TOPICINFO PeterThoeny date="1080625187" format="1.0" version="1.43"

TWiki Text Formatting

Line: 183 to 183

List Item:
Changed:
<
<
Three spaces and an asterisk.
>
>
Three spaces, an asterisk, and another space.



Line: 197 to 197

Nested List Item:
Changed:
<
<
Six, nine, ... spaces and an asterisk.
>
>
Six, nine, ... spaces, an asterisk, and another space.



Line: 213 to 213

Ordered List:
Changed:
<
<
Three spaces and a number.
>
>
Three spaces, a number, and another space.



Line: 251 to 251

|   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).
Changed:
<
<
|^| 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.
Line: 303 to 303

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

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



Line: 368 to 368

Prevent a Link:
Changed:
<
<
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.



Changed:
<
<
<nop>SunOS
>
>
SunOS

Changed:
<
<
SunOS
>
>
SunOS

Line: 438 to 438

    • 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, &lt;, ex: a < b
    • TIP 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.
Added:
>
>

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.

Line: 482 to 493

Changed:
<
<
  • 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

Line: 506 to 517

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

-- TWiki:Main.MikeMannix - 02 Dec 2001

Added:
>
>
-- TWiki:Main.PeterThoeny - 29 Mar 2004

 <<O>>  Difference Topic TextFormattingRules (r1.42 - 17 Mar 2004 - PeterThoeny)
Line: 1 to 1
Changed:
<
<
META TOPICINFO PeterThoeny date="1071564063" format="1.0" version="1.41"
>
>
META TOPICINFO PeterThoeny date="1079507030" format="1.0" version="1.42"

TWiki Text Formatting

Line: 229 to 229

Definition List:
Changed:
<
<
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 &nbsp; non-breaking-space entity.
>
>
Three spaces, a dollar sign, the term, a colon, a space, followed by the definition.



Changed:
<
<
Sushi
Japan
Dim&nbsp;Sum
S.F.
>
>
Sushi
Japan
Dim Sum
S.F.

Changed:
<
<
Sushi
Japan
Dim Sum
S.F.
>
>
Sushi
Japan
Dim Sum
S.F.

Line: 264 to 263

multi span
A4-6 four four
five five
Added:
>
>


six six
Line: 503 to 505

  • 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. '&copy;' is the © copyright character. You need to escape '&' to see it as it is, so write '&amp;' instead of '&'.
      Example: Type 'This &amp; that' to get 'This & that'.
Added:
>
>
-- TWiki:Main.MikeMannix - 02 Dec 2001
-- TWiki:Main.PeterThoeny - 16 Mar 2004

 <<O>>  Difference Topic TextFormattingRules (r1.41 - 16 Dec 2003 - PeterThoeny)
Line: 1 to 1
Changed:
<
<
META TOPICINFO PeterThoeny date="1059714736" format="1.0" version="1.40"
>
>
META TOPICINFO PeterThoeny date="1071564063" format="1.0" version="1.41"

TWiki Text Formatting

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


 <<O>>  Difference Topic TextFormattingRules (r1.40 - 01 Aug 2003 - PeterThoeny)
Line: 1 to 1
Changed:
<
<
META TOPICINFO PeterThoeny date="1059255424" format="1.0" version="1.39"
>
>
META TOPICINFO PeterThoeny date="1059714736" format="1.0" version="1.40"

TWiki Text Formatting

Line: 301 to 301

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

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



Line: 479 to 480

Added:
>
>
  • 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


 <<O>>  Difference Topic TextFormattingRules (r1.39 - 26 Jul 2003 - PeterThoeny)
Line: 1 to 1
Changed:
<
<
META TOPICINFO PeterThoeny date="1058399820" format="1.0" version="1.38"
>
>
META TOPICINFO PeterThoeny date="1059255424" format="1.0" version="1.39"

TWiki Text Formatting

Line: 321 to 321

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

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 [[Home#MyAnchor][go home]] and [[http://gnu.org/#Action][GNU Action]].



Line: 347 to 347



Changed:
<
<
WebHome#NotThere?
>
>
WikiWord#NotThere

Jump

Line: 355 to 355

Changed:
<
<
WebHome#NotThere?
>
>
WikiWord#NotThere

Jump


 <<O>>  Difference Topic TextFormattingRules (r1.38 - 16 Jul 2003 - PeterThoeny)
Line: 1 to 1
Changed:
<
<
META TOPICINFO PeterThoeny date="1044132468" format="1.0" version="1.37"
>
>
META TOPICINFO PeterThoeny date="1058399820" format="1.0" version="1.38"

TWiki Text Formatting

Line: 108 to 108

Fixed font
Added:
>
>

Line: 126 to 127

Changed:
<
<
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 (* _ __ = ==).



Line: 135 to 136

Changed:
<
<
This works,
>
>
This works,

_this not _
Line: 200 to 201



Changed:
<
<
    • nested stuff
>
>
  • level 1
    • level 2

Changed:
<
<
    • nested stuff
>
>
  • level 1
    • level 2

Line: 243 to 246

Table:
Changed:
<
<
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.



Line: 256 to 262

A2 2 2
A3 3 3
multi span
Changed:
<
<
A4 next next
>
>
A4-6 four four
five five
six six

Line: 264 to 272

A2 2 2
A3 3 3
multi span
Changed:
<
<
A4 next next
>
>
A4-6 four four
five five
six six

Line: 422 to 432

  • 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.
    • TIP 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."
  • ALERT! NOTE: The opening and closing angle brackets - <...> - of an HTML tag must be on the same line, or the tag will be broken.
Changed:
<
<
    • 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, &lt;, 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, &lt;, ex: a < b

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

Line: 492 to 502

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

-- MikeMannix? - 02 Dec 2001

Added:
>
>
-- PeterThoeny - 15 Jul 2003

 <<O>>  Difference Topic TextFormattingRules (r1.37 - 01 Feb 2003 - PeterThoeny)
Line: 1 to 1
Changed:
<
<
META TOPICINFO PeterThoeny date="1044097920" format="1.0" version="1.36"
>
>
META TOPICINFO PeterThoeny date="1044132468" format="1.0" version="1.37"

TWiki Text Formatting

Line: 437 to 437

External Links

Changed:
<
<
  • 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.

 <<O>>  Difference Topic TextFormattingRules (r1.36 - 01 Feb 2003 - PeterThoeny)
Line: 1 to 1
Changed:
<
<
META TOPICINFO PeterThoeny date="1033609205" format="1.0" version="1.35"
>
>
META TOPICINFO PeterThoeny date="1044097920" format="1.0" version="1.36"

TOC: No TOC in "TWiki.TextFormattingRules"
Changed:
<
<

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

Changed:
<
<
>
>

Formatting Command:
Line: 19 to 20

Changed:
<
<
Paragraphs:
>
>
Paragraphs:

Blank lines will create new paragraphs.
Line: 37 to 38

Changed:
<
<
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.
Line: 55 to 56

Changed:
<
<
Bold Text:
>
>
Bold Text:

Words get bold by enclosing them in * asterisks.
Line: 69 to 70

Changed:
<
<
Italic Text:
>
>
Italic Text:

Words get italic by enclosing them in _ underscores.
Line: 83 to 84

Changed:
<
<
Bold Italic:
>
>
Bold Italic:

Words get _bold italic by enclosing them in _ double-underscores.
Line: 97 to 98

Changed:
<
<
Fixed Font:
>
>
Fixed Font:

Words get shown in fixed font by enclosing them in = equal signs.
Line: 111 to 112

Changed:
<
<
Bold Fixed Font:
>
>
Bold Fixed Font:

Words get shown in bold fixed font by enclosing them in double equal signs.
Line: 125 to 126

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



Line: 140 to 141

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



Line: 166 to 167

Changed:
<
<
Separator:
>
>
Separator:

At least three dashes at the beginning of a line.
Line: 180 to 181

Changed:
<
<
List Item:
>
>
List Item:

Three spaces and an asterisk.
Line: 194 to 195

Changed:
<
<
Nested List Item:
>
>
Nested List Item:

Six, nine, ... spaces and an asterisk.
Line: 208 to 209

Changed:
<
<
Ordered List:
>
>
Ordered List:

Three spaces and a number.
Line: 224 to 225

Changed:
<
<
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 &nbsp; non-breaking-space entity.
Line: 241 to 242

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



Line: 255 to 256

A2 2 2
A3 3 3
multi span
Changed:
<
<
| A4 \ | next \
next
>
>
A4 next next

Line: 265 to 264

A2 2 2
A3 3 3
multi span
Changed:
<
<
A4 next next
>
>
A4 next next

Changed:
<
<
WikiWord Links:
CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically.
Note: In case you want to link to a topic in a different Galeon 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 Galeon web write Webname.TopicName.



Line: 291 to 288

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



Line: 309 to 307

Changed:
<
<
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]]
Added:
>
>

XML


syntax

GNU

Added:
>
>

XML


Changed:
<
<
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 Galeon 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.
Line: 378 to 369

Disable Links:
Changed:
<
<
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).


Line: 395 to 388

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

Line: 402 to 413

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

Added:
>
>

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

Added:
>
>

  • 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.
    • TIP 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."
  • ALERT! NOTE: The opening and closing angle brackets - <...> - of an HTML tag must be on the same line, or the tag will be broken.
Line: 429 to 442

  • Email addresses like name@domain.com are linked automatically.

Changed:
<
<
    • 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

Line: 446 to 459

  • %INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current Galeon web is the default web. Example: %INCLUDE{"TWiki.SiteMap"}%
Changed:
<
<
>
>
  • %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 Help, TIP Tip, ALERT! Alert. For more info see TWikiDocGraphics.

Changed:
<
<
  • 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

Line: 473 to 491

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

-- MikeMannix? - 02 Dec 2001

Added:
>
>
-- PeterThoeny - 01 Feb 2003

 <<O>>  Difference Topic TextFormattingRules (r1.35 - 03 Oct 2002 - PeterThoeny)
Line: 1 to 1
Changed:
<
<
META TOPICINFO PeterThoeny date="1023240420" format="1.0" version="1.34"
>
>
META TOPICINFO PeterThoeny date="1033609205" format="1.0" version="1.35"

TWiki Text Formatting

Line: 363 to 363

Changed:
<
<
Prevent a Link:
>
>
Prevent a Link:

Prevent a WikiWord from being linked by prepending it with the <nop> tag.
Line: 375 to 375

SunOS
Added:
>
>
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


 <<O>>  Difference Topic TextFormattingRules (r1.34 - 05 Jun 2002 - PeterThoeny)
Line: 1 to 1
Changed:
<
<
META TOPICINFO PeterThoeny date="1020375710" format="1.0" version="1.33"
>
>
META TOPICINFO PeterThoeny date="1023240420" format="1.0" version="1.34"

TWiki Text Formatting

Line: 38 to 38

Headings:
Changed:
<
<
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.



Line: 289 to 289

Changed:
<
<
#SquareBrackets
>
>

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.
Line: 375 to 376

Deleted:
<
<

Using HTML


 <<O>>  Difference Topic TextFormattingRules (r1.33 - 02 May 2002 - PeterThoeny)
Line: 1 to 1
Changed:
<
<
META TOPICINFO RichardDonkin? date="1018013809" format="1.0" version="1.32"
>
>
META TOPICINFO PeterThoeny date="1020375710" format="1.0" version="1.33"

TWiki Text Formatting

Line: 413 to 413

    • 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.
Added:
>
>

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

Line: 424 to 442

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

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


Added:
>
>
  • 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 '&lt;' instead of '<', and '&gt;' instead of '>'.
      Example: Type 'prog &lt;filename&gt;' to get 'prog <filename>'.

Changed:
<
<
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. '&copy;' is the © copyright character. You need to escape '&' to see it as it is, so write '&amp;' instead of '&'.
      Example: Type 'This &amp; that' to get 'This & that'.

Added:
>
>
-- MikeMannix? - 02 Dec 2001
-- PeterThoeny - 02 May 2002

 <<O>>  Difference Topic TextFormattingRules (r1.32 - 05 Apr 2002 - RichardDonkin?)
Line: 1 to 1
Changed:
<
<
META TOPICINFO RichardDonkin? date="1017131194" format="1.0" version="1.31"
>
>
META TOPICINFO RichardDonkin? date="1018013809" format="1.0" version="1.32"

TWiki Text Formatting

Line: 429 to 429

Updated to cover TWiki:Codev/EasierExternalLinking (in the alpha release).

-- RichardDonkin? - 26 Mar 2002

Added:
>
>

Latest updates to this topic are in the main TWiki, since that's got the TWikiAlphaRelease code.

-- RichardDonkin? - 05 Apr 2002


 <<O>>  Difference Topic TextFormattingRules (r1.31 - 26 Mar 2002 - RichardDonkin?)
Line: 1 to 1
Changed:
<
<
META TOPICINFO MikeMannix? date="1007352711" format="1.0" version="1.30"
>
>
META TOPICINFO RichardDonkin? date="1017131194" format="1.0" version="1.31"

TWiki Text Formatting

Line: 326 to 326

Added:
>
>
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 Galeon 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.
Line: 396 to 410

  • Email addresses like name@domain.com are linked automatically.

Added:
>
>
    • 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

Line: 408 to 425

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

-- MikeMannix? - 02 Dec 2001

Added:
>
>

Updated to cover TWiki:Codev/EasierExternalLinking (in the alpha release).

-- RichardDonkin? - 26 Mar 2002


 <<O>>  Difference Topic TextFormattingRules (r1.30 - 03 Dec 2001 - MikeMannix?)
Line: 1 to 1
Changed:
<
<
META TOPICINFO MikeMannix? date="1007280439" format="1.0" version="1.29"
>
>
META TOPICINFO MikeMannix? date="1007352711" format="1.0" version="1.30"

TWiki Text Formatting

Line: 366 to 366

Using HTML

Changed:
<
<
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.
Changed:
<
<
    • 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.
>
>
  • ALERT! 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.
    • TIP 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."
  • ALERT! 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, &lt;, ex: a > b
    • TIP 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


 <<O>>  Difference Topic TextFormattingRules (r1.29 - 02 Dec 2001 - MikeMannix?)
Line: 1 to 1
Changed:
<
<
META TOPICINFO MikeMannix? date="1002008223" format="1.0" version="1.28"
>
>
META TOPICINFO MikeMannix? date="1007280439" format="1.0" version="1.29"

TOC: No TOC in "TWiki.TextFormattingRules"
Changed:
<
<

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.

Line: 289 to 289

Changed:
<
<
>
>
#SquareBrackets

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.
Line: 390 to 389

Changed:
<
<

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 Galeon 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 '&lt;' instead of '<', and '&gt;' instead of '>'.
      Example: Type 'prog &lt;filename&gt;' 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: '&copy;' is the © copyright character. You need to escape '&' to see it as it is, so write '&amp;' instead of '&'.
      Example: Type 'This &amp; that' to get 'This & that'.
>
>

TWikiPlugin Formatting Extensions


Changed:
<
<

TWiki Plugins

>
>
Plugins provide additional text formatting capabilities and can extend the functionality of Galeon into many other areas. For example, the optional SpreadSheetPlugin lets you create a spreadsheet with the same basic notation used in TWiki tables.

Changed:
<
<
Plugins provide additional text formatting capabilities and can extend the functionality of Galeon 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%:

  • DefaultPlugin: This plugin can be used to specify some simple custom rendering rules. It also renders depreciated *_text_* as bold italic text.
  • SpreadSheetPlugin: Add spreadsheet calculation like "$SUM( $ABOVE() )" to tables located in Galeon topics.
  • EditTablePlugin: Edit TWiki tables using edit fields, date pickers and drop down boxes
  • InterwikiPlugin: Link ExternalSite:Page text to external sites based on aliases defined in the InterWikis topic
  • RenderListPlugin: Render bullet lists in a variety of formats
  • SlideShowPlugin: Create web based presentations based on topics with headings.
  • SmiliesPlugin: Render smilies as icons, like  :-) for smile or  :cool: for cool!
  • TablePlugin: Control attributes of tables and sorting of table columns

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

Added:
>
>
-- MikeMannix? - 02 Dec 2001

 <<O>>  Difference Topic TextFormattingRules (r1.28 - 02 Oct 2001 - MikeMannix?)
Line: 1 to 1
Changed:
<
<
META TOPICINFO MikeMannix? date="1000771966" format="1.0" version="1.27"
>
>
META TOPICINFO MikeMannix? date="1002008223" format="1.0" version="1.28"

TOC: No TOC in "TWiki.TextFormattingRules"
Changed:
<
<

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.

Line: 414 to 414

    • A: The '<' and '>' characters have a special meaning in HTML, they define HTML tags. You need to escape them, so write '&lt;' instead of '<', and '&gt;' instead of '>'.
      Example: Type 'prog &lt;filename&gt;' to get 'prog <filename>'.

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

TWiki Plugins

Line: 424 to 424

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

Added:
>
>
-- MikeMannix? - 02 Oct 2001

 <<O>>  Difference Topic TextFormattingRules (r1.27 - 18 Sep 2001 - MikeMannix?)
Line: 1 to 1
Changed:
<
<
META TOPICINFO MikeMannix? date="999839103" format="1.0" version="1.26"
>
>
META TOPICINFO MikeMannix? date="1000771966" format="1.0" version="1.27"

TWiki Text Formatting

Line: 289 to 289

Changed:
<
<
#SquareBrackets
>
>

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.

 <<O>>  Difference Topic TextFormattingRules (r1.26 - 07 Sep 2001 - MikeMannix?)
Line: 1 to 1
Changed:
<
<
META TOPICINFO MikeMannix? date="999766220" format="1.0" version="1.25"
>
>
META TOPICINFO MikeMannix? date="999839103" format="1.0" version="1.26"

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

TWiki Editing Shorthand

Line: 288 to 289

Changed:
<
<
>
>
#SquareBrackets

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.
Line: 365 to 366

Using HTML

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

Changed:
<
<
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 Galeon web.
Changed:
<
<
  • 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

  • http://..., https://..., ftp://... and mailto:...@... are linked automatically.
Added:
>
>

  • Email addresses like name@domain.com are linked automatically.
Added:
>
>

TWiki Variables

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

Deleted:
<
<
  • %TOC% : The table of content, is based on headings in a topic.

  • %WEB% : The current web, is TWiki .
Added:
>
>

  • %TOPIC% : The current topic name, is TextFormattingRules .
Added:
>
>

  • %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.
Deleted:
<
<
  • %INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current Galeon web is the default web. Example: %INCLUDE{"TWiki.TWikiWebsTable"}%
  • There are many more variables, see TWikiVariables.

Changed:
<
<

"Gotchas" when Editing Text

>
>
  • %INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current Galeon web is the default web. Example: %INCLUDE{"TWiki.TWikiWebsTable"}%


Changed:
<
<
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 '&lt;' instead of '<', and '&gt;' instead of '>'.
      Example: Type 'prog &lt;filename&gt;' to get 'prog <filename>'.
Line: 403 to 415

  • 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. '&copy;' is the © copyright character. You need to escape '&' to see it as it is, so write '&amp;' instead of '&'.
      Example: Type 'This &amp; that' to get 'This & that'.
Deleted:
<
<

TWiki Plugins

Changed:
<
<
Plugins provide additional text formatting rules and can extend the functionality of Galeon 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 Galeon 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:

  • DefaultPlugin: This plugin can be used to specify some simple custom rendering rules. It also renders depreciated *_text_* as bold italic text.
  • SpreadSheetPlugin: Add spreadsheet calculation like "$SUM( $ABOVE() )" to tables located in Galeon topics.
  • EditTablePlugin: Edit TWiki tables using edit fields, date pickers and drop down boxes
  • InterwikiPlugin: Link ExternalSite:Page text to external sites based on aliases defined in the InterWikis topic
  • RenderListPlugin: Render bullet lists in a variety of formats
  • SlideShowPlugin: Create web based presentations based on topics with headings.
  • SmiliesPlugin: Render smilies as icons, like  :-) for smile or  :cool: for cool!
  • TablePlugin: Control attributes of tables and sorting of table columns

 <<O>>  Difference Topic TextFormattingRules (r1.25 - 06 Sep 2001 - MikeMannix?)
Line: 1 to 1
Changed:
<
<
META TOPICINFO MikeMannix? date="999762553" format="1.0" version="1.24"
>
>
META TOPICINFO MikeMannix? date="999766220" format="1.0" version="1.25"

TOC: No TOC in "TWiki.TextFormattingRules"
Changed:
<
<
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.

Changed:
<
<

Editing

>
>

TWiki Editing Shorthand


Changed:
<
<
>
>

Formatting Command:
Line: 17 to 16

You get:
Changed:
<
<
>
>

Paragraphs:
Blank lines will create new paragraphs.
Line: 35 to 34

2nd paragraph
Changed:
<
<
>
>

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.
Line: 53 to 52

Maguro

Changed:
<
<
>
>

Bold Text:
Words get bold by enclosing them in * asterisks.
Line: 67 to 66

Bold
Changed:
<
<
>
>

Italic Text:
Words get italic by enclosing them in _ underscores.
Line: 81 to 80

Italic
Changed:
<
<
>
>

Bold Italic:
Words get _bold italic by enclosing them in _ double-underscores.
Line: 95 to 94

Bold italic
Changed:
<
<
>
>

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

Fixed font
Changed:
<
<
>
>

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

Bold fixed
Changed:
<
<
>
>

Note: Make sure to "stick" the * _ = == signs to the words, e.g. take away spaces.
Line: 138 to 137

_this not _
Changed:
<
<
>
>

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.
Line: 164 to 163

Changed:
<
<
>
>

Separator:
At least three dashes at the beginning of a line.
Line: 178 to 177


Changed:
<
<
>
>

List Item:
Three spaces and an asterisk.
Line: 192 to 191

  • bullet item
Changed:
<
<
>
>

Nested List Item:
Six, nine, ... spaces and an asterisk.
Line: 206 to 205

    • nested stuff
Changed:
<
<
>
>

Ordered List:
Three spaces and a number.
Line: 222 to 221

  1. Dim Sum
Changed:
<
<
>
>

Definition List:
Three spaces, the term, a colon, a space, followed by the definition.
Line: 239 to 238

Dim Sum
S.F.
Changed:
<
<
>
>

Table:
Optional spaces followed by the cells enclosed in vertical bars.
Line: 270 to 269

next
Changed:
<
<
>
>

WikiWord Links:
CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically.
Note: In case you want to link to a topic in a different Galeon web write Webname.TopicName.
Line: 288 to 287

ReadmeFirst?
Changed:
<
<
>
>

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.
Line: 306 to 305

Main.TWiki users
Changed:
<
<
>
>

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!]].
Line: 324 to 323

GNU
Changed:
<
<
>
>

Anchors:
You can define a link reference inside a Galeon 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.
Line: 346 to 345

To here
Changed:
<
<
>
>

Prevent a Link:
Prevent a WikiWord from being linked by prepending it with the <nop> tag.
Line: 364 to 363

Deleted:
<
<

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.


 <<O>>  Difference Topic TextFormattingRules (r1.24 - 06 Sep 2001 - MikeMannix?)
Line: 1 to 1
Changed:
<
<
META TOPICINFO MikeMannix? date="999757934" format="1.0" version="1.23"
>
>
META TOPICINFO MikeMannix? date="999762553" format="1.0" version="1.24"

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

Changed:
<
<
>
>

Formatting Command:
Line: 359 to 361

Added:
>
>

Using HTML


 <<O>>  Difference Topic TextFormattingRules (r1.23 - 06 Sep 2001 - MikeMannix?)
Line: 1 to 1
Changed:
<
<
META TOPICINFO MikeMannix? date="999192384" format="1.0" version="1.22"
>
>
META TOPICINFO MikeMannix? date="999757934" format="1.0" version="1.23"

TOC: No TOC in "TWiki.TextFormattingRules"

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.

Deleted:
<
<

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

Changed:
<
<
>
>

Formatting Command:
Line: 375 to 360

Deleted:
<
<

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.

Changed:
<
<
>
>

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


 <<O>>  Difference Topic TextFormattingRules (r1.22 - 30 Aug 2001 - MikeMannix?)
Line: 1 to 1
Changed:
<
<
META TOPICINFO MikeMannix? date="999166231" format="1.0" version="1.21"
>
>
META TOPICINFO MikeMannix? date="999192384" format="1.0" version="1.22"

TOC: No TOC in "TWiki.TextFormattingRules"
Changed:
<
<
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

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

Changed:
<
<

Galeon Internal Links

>
>

Internal Links


  • GoodStyle is a WikiWord that links to the GoodStyle topic located in the current Galeon 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!)
Changed:
<
<

Remote Site Links

>
>

External Links


  • http://..., https://..., ftp://... and mailto:...@... are linked automatically.
  • Email addresses like name@domain.com are linked automatically.
Line: 407 to 407

Changed:
<
<

Galeon Plugins

>
>

TWiki Plugins


Changed:
<
<
Plugins offer additional text formatting rules and extend the functionality of Galeon. Currently enabled plugins are:
>
>
Plugins provide additional text formatting rules and can extend the functionality of Galeon into many other areas. Available Plugins are located in the Plugins web. Currently enabled plugins on this site are:

  • DefaultPlugin: This plugin can be used to specify some simple custom rendering rules. It also renders depreciated *_text_* as bold italic text.
  • SpreadSheetPlugin: Add spreadsheet calculation like "$SUM( $ABOVE() )" to tables located in Galeon topics.
  • EditTablePlugin: Edit TWiki tables using edit fields, date pickers and drop down boxes
  • InterwikiPlugin: Link ExternalSite:Page text to external sites based on aliases defined in the InterWikis topic
  • RenderListPlugin: Render bullet lists in a variety of formats
  • SlideShowPlugin: Create web based presentations based on topics with headings.
  • SmiliesPlugin: Render smilies as icons, like  :-) for smile or  :cool: for cool!
  • TablePlugin: Control attributes of tables and sorting of table columns
Changed:
<
<
Learn more about plugins in TWikiPlugins and TWikiPreferences.
>
>
Check on current Plugin status and settings for this site in TWikiPreferences.

-- MikeMannix? - 30 Aug 2001


 <<O>>  Difference Topic TextFormattingRules (r1.21 - 30 Aug 2001 - MikeMannix?)
Line: 1 to 1
Changed:
<
<
META TOPICINFO PeterThoeny date="997515680" format="1.0beta2" version="1.20"
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.

TOC: No TOC in "TWiki.TextFormattingRules"

>
>
META TOPICINFO MikeMannix? date="999166231" format="1.0" version="1.21"
TOC: No TOC in "TWiki.TextFormattingRules"

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

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

Galeon Internal Links

  • GoodStyle is a WikiWord that links to the GoodStyle topic located in the current Galeon 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!)
Changed:
<
<

External Links

>
>

Remote Site Links


  • http://..., https://..., ftp://... and mailto:...@... are linked automatically.
  • Email addresses like name@domain.com are linked automatically.

 <<O>>  Difference Topic TextFormattingRules (r1.20 - 11 Aug 2001 - PeterThoeny)
Line: 1 to 1
Changed:
<
<
META TOPICINFO 1.19 date="995100495" author="PeterThoeny" format="1.0beta2"
>
>
META TOPICINFO PeterThoeny date="997515680" format="1.0beta2" version="1.20"

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.

TOC: No TOC in "TWiki.TextFormattingRules"

Line: 238 to 238

Definition List:
Changed:
<
<
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 &nbsp; non-breaking-space entity.

 <<O>>  Difference Topic TextFormattingRules (r1.19 - 14 Jul 2001 - PeterThoeny)
Line: 1 to 1
Added:
>
>
META TOPICINFO 1.19 date="995100495" author="PeterThoeny" format="1.0beta2"

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.

TOC: No TOC in "TWiki.TextFormattingRules"

Line: 408 to 409

Galeon Plugins

Changed:
<
<
Galeon Plugins offer additional text formatting rules. Plugins currently installed are:
>
>
Plugins offer additional text formatting rules and extend the functionality of Galeon. Currently enabled plugins are:

Changed:
<
<
  • DefaultPlugin: The default plugin is used for some depreciated rendering of older TWiki versions.
>
>
  • DefaultPlugin: This plugin can be used to specify some simple custom rendering rules. It also renders depreciated *_text_* as bold italic text.
  • SpreadSheetPlugin: Add spreadsheet calculation like "$SUM( $ABOVE() )" to tables located in Galeon topics.
  • EditTablePlugin: Edit TWiki tables using edit fields, date pickers and drop down boxes
  • InterwikiPlugin: Link ExternalSite:Page text to external sites based on aliases defined in the InterWikis topic
  • RenderListPlugin: Render bullet lists in a variety of formats
  • SlideShowPlugin: Create web based presentations based on topics with headings.
  • SmiliesPlugin: Render smilies as icons, like  :-) for smile or  :cool: for cool!
  • TablePlugin: Control attributes of tables and sorting of table columns

Learn more about plugins in TWikiPlugins and TWikiPreferences.


 <<O>>  Difference Topic TextFormattingRules (r1.18 - 28 Jun 2001 - PeterThoeny)
Line: 1 to 1

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

LINKS

>
>

Links


The Collaborative Work Area is a bunch of related links that are editable through your web browser.

Changed:
<
<
The Galeon web has the following types of internal links:
>
>

Galeon Internal Links


  • GoodStyle is a WikiWord that links to the GoodStyle topic located in the current Galeon 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!)
Changed:
<
<

External links:

>
>

External Links


  • http://..., https://..., ftp://... and mailto:...@... are linked automatically.
  • Email addresses like name@domain.com are linked automatically.
Changed:
<
<

EDITING

>
>

Editing


Line: 52 to 54



Changed:
<
<

Sushi

>
>
---++ Sushi

Changed:
<
<

Maguro

>
>
---+++ Maguro

Changed:
<
<

Sushi

>
>

Sushi


Changed:
<
<

Maguro

>
>

Maguro


Line: 373 to 375

Changed:
<
<

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.

Changed:
<
<
>
>

Changed:
<
<

WIKI VARIABLES

>
>

TWiki Variables


Variables are names that are enclosed in percent signs; they get expanded on the fly.

Added:
>
>
  • %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 Galeon web is the default web. Example: %INCLUDE{"TWiki.TWikiWebsTable"}%
  • There are many more variables, see TWikiVariables.
Added:
>
>

"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 '&lt;' instead of '<', and '&gt;' instead of '>'.
      Example: Type 'prog &lt;filename&gt;' 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. '&copy;' is the © copyright character. You need to escape '&' to see it as it is, so write '&amp;' instead of '&'.
      Example: Type 'This &amp; that' to get 'This & that'.


Changed:
<
<

Galeon PLUGINS

>
>

Galeon Plugins


Galeon Plugins offer additional text formatting rules. Plugins currently installed are:


 <<O>>  Difference Topic TextFormattingRules (r1.17 - 05 Apr 2001 - PeterThoeny)
Line: 253 to 253

Table:
Optional spaces followed by the cells enclosed in vertical bars.
Changed:
<
<
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.



Changed:
<
<
A1 B1 C1
A2 B2 C2
| A3 \
>
>
L C R
A2 2 2
A3 3 3
multi span
| A4 \

| next \
next
Changed:
<
<
A1 B1 C1
A2 B2 C2
| A3
>
>
L C R
A2 2 2
A3 3 3
multi span
| A4

next next

 <<O>>  Difference Topic TextFormattingRules (r1.16 - 16 Mar 2001 - PeterThoeny)
Line: 1 to 1

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.
Changed:
<
<
LINKS
>
>

LINKS


The Collaborative Work Area is a bunch of related links that are editable through your web browser.

Line: 9 to 9

  • GoodStyle is a WikiWord that links to the GoodStyle topic located in the current Galeon 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!)
Changed:
<
<
External links:
>
>

External links:


  • http://..., https://..., ftp://... and mailto:...@... are linked automatically.
  • Email addresses like name@domain.com are linked automatically.
Changed:
<
<
EDITING
>
>

EDITING


Line: 364 to 365

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

Changed:
<
<
WIKI VARIABLES
>
>

WIKI VARIABLES


Variables are names that are enclosed in percent signs; they get expanded on the fly.

Line: 380 to 382

  • %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 Galeon web is the default web. Example: %INCLUDE{"TWiki.TWikiWebsTable"}%
  • There are many more variables, see TWikiVariables.
Added:
>
>

Galeon PLUGINS

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


 <<O>>  Difference Topic TextFormattingRules (r1.15 - 02 Mar 2001 - PeterThoeny)
Line: 46 to 46

Added:
>
>
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.
Line: 158 to 176

Separator:
Changed:
<
<
At least four dashes at the beginning of a line.
>
>
At least three dashes at the beginning of a line.



Line: 292 to 310

Specific Links:
Changed:
<
<
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!]].



Changed:
<
<
WikiSyntax?
>
>
syntax

Changed:
<
<
http://gnu.org?
>
>
GNU

Changed:
<
<
WikiSyntax?
>
>
syntax

Changed:
<
<
http://gnu.org?
>
>
GNU

Anchors:
Changed:
<
<
You can define a link reference inside a Galeon 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 Galeon 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.



Changed:
<
<
WebHome@NotThere?
>
>
WebHome#NotThere?

Changed:
<
<
@MyAnchor?
>
>
Jump

Changed:
<
<
@MyAnchor To here
>
>
To here

Changed:
<
<
WebHome@NotThere?
>
>
WebHome#NotThere?

Changed:
<
<
@MyAnchor?
>
>
Jump

Changed:
<
<
@MyAnchor To here
>
>
To here


 <<O>>  Difference Topic TextFormattingRules (r1.14 - 25 Feb 2001 - PeterThoeny)
Line: 260 to 260



Changed:
<
<
WebNotify,
>
>
WebNotify

ReadmeFirst?
Changed:
<
<
WebNotify,
>
>
WebNotify

ReadmeFirst?
Forced Links:
Changed:
<
<
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.



Changed:
<
<
wiki syntax,
>
>
wiki syntax

Main.TWiki users
Changed:
<
<
wiki syntax,
>
>
wiki syntax

Main.TWiki users
Added:
>
>
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 Galeon 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.

 <<O>>  Difference Topic TextFormattingRules (r1.13 - 10 Feb 2001 - PeterThoeny)
Line: 233 to 233

Table:
Changed:
<
<
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 |
Added:
>
>
| A3 \ | next \
next

A1 B1 C1
A2 B2 C2
Added:
>
>
A3 next next

Line: 292 to 299

SunOS
Deleted:
<
<
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


 <<O>>  Difference Topic TextFormattingRules (r1.12 - 01 Feb 2001 - PeterThoeny)
Line: 16 to 16

EDITING

Changed:
<
<
  • CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically. In case you want to link to a topic in a different Galeon 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&nbsp;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
  • bullet item
Nested List Item:
Six, nine, ... spaces and an asterisk.
      * nested stuff
    • nested stuff
Ordered List:
Three spaces and a number.
   1 Sushi
   1 Dim Sum
  1. Sushi
  2. 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 &nbsp; non-breaking-space entity.
   Sushi: Japan
   Dim&nbsp;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 |
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 Galeon 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


 <<O>>  Difference Topic TextFormattingRules (r1.11 - 21 Jan 2001 - PeterThoeny)
Line: 22 to 22

  • 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
Changed:
<
<
  • 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.
      • This works

 <<O>>  Difference Topic TextFormattingRules (r1.10 - 12 Dec 2000 - PeterThoeny)
Line: 35 to 35

  • List Item: 3 spaces and an asterisk: <   *>
  • Nested Item: 6 spaces and an asterisk: <      *>
  • Ordered List: 3 spaces and a number: <   1>
Changed:
<
<
  • 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&nbsp;Set: to get Character Set:.

  • Table: Optional spaces followed by the cells enclosed in vertical bars: <   | cell 1 | cell 2 | cell 3 | ... |>

 <<O>>  Difference Topic TextFormattingRules (r1.9 - 10 Dec 2000 - PeterThoeny)
Line: 1 to 1
Changed:
<
<
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

Line: 7 to 7

The Galeon web has the following types of internal links:

  • GoodStyle is a WikiWord that links to the GoodStyle topic located in the current Galeon web.
Changed:
<
<
  • 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:


 <<O>>  Difference Topic TextFormattingRules (r1.8 - 11 Nov 2000 - PeterThoeny)
Line: 4 to 4

The Collaborative Work Area is a bunch of related links that are editable through your web browser.

Changed:
<
<
The TWiki web has the following types of internal links:
>
>
The Galeon web has the following types of internal links:

  • GoodStyle is a WikiWord that links to the GoodStyle topic located in the current Galeon 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:

Changed:
<
<
  • 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 Galeon web write Web.TopicName, i.e. write Know.ReadmeFirst to link to ReadmeFirst? located in the Know web.
Changed:
<
<
  • 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
Line: 53 to 53

  • %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.
Changed:
<
<
  • %INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current Galeon web is the default web. Example: %INCLUDE{"TWiki.TWikiWebsTable"}%
>
>
  • %INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current Galeon web is the default web. Example: %INCLUDE{"TWiki.TWikiWebsTable"}%


 <<O>>  Difference Topic TextFormattingRules (r1.7 - 01 Nov 2000 - PeterThoeny)
Line: 6 to 6

The TWiki web has the following types of internal links:

Changed:
<
<
  • 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 Galeon 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!)
Deleted:
<
<
  • 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:

Line: 18 to 16

EDITING

Changed:
<
<
  • 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 Galeon 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

 <<O>>  Difference Topic TextFormattingRules (r1.6 - 19 Sep 2000 - PeterThoeny)
Line: 4 to 4

The Collaborative Work Area is a bunch of related links that are editable through your web browser.

Changed:
<
<
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 )
Added:
>
>
  • 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.

Changed:
<
<
External links:
>
>
External links:

  • http://..., https://..., ftp://... and mailto:...@... are linked automatically.
  • Email addresses like name@domain.com are linked automatically.

 <<O>>  Difference Topic TextFormattingRules (r1.5 - 18 Aug 2000 - PeterThoeny)
Line: 17 to 17

EDITING

Changed:
<
<
  • 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
Line: 31 to 31

      • Writing *bold text* , _italic text_ and =fixed== monospaced text
    • Example text gets rendered as:
      • Writing bold text , italic text and fixed= monospaced text
Changed:
<
<
  • 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 | ... |>

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


Deleted:
<
<
  • Most HTML tags will work.

WIKI VARIABLES

Changed:
<
<
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.
Changed:
<
<
  • %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 Galeon web is the default web. Example: %INCLUDE{"TWiki.TWikiWebsTable"}%


 <<O>>  Difference Topic TextFormattingRules (r1.4 - 28 Feb 2000 - PeterThoeny)
Line: 47 to 47

WIKI VARIABLES

Changed:
<
<

TWiki Variables

Special text strings expand on the fly to display user data or system info

TWikiVariables are text strings - %VARIABLE% - that expand into content whenever a page is opened. When a topic is rendered for viewing, VARIABLES are replaced by data, either user-entered, or info automatically generated by TWiki (like the date, or the current username). There are predefined variables, and Preference variables that you configure. You can also define custom variables, with new names and values.

Note: To leave a variable unexpanded, preceed it with an exclamation point, e.g. type !%TOPIC% to get %TOPIC%.

Predefined Variables

Most predefined variables return values that were either set in the lib/twiki.cfg file, when TWiki was installed, or taken from server info (like current username, or date and time). Many of the variables let you format the appearance of the display results.

  • TIP 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 - 07 May 2004 - expands the following variables (enclosed in % percent signs):

ATTACHURL -- attachment URL of the current topic

ATTACHURLPATH -- path of the attachment URL of the current topic

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

DISPLAYTIME -- display time

DISPLAYTIME{"format"} -- formatted display time

  • Formatted time - either GMT or Local server time, depending on setting in TWiki.cfg. Same format qualifiers as %GMTIME%
  • Syntax: %DISPLAYTIME{"format"}%
  • Example: %DISPLAYTIME{"$hou:$min"}% expands to 11:46
  • Related: DISPLAYTIME, GMTIME, SERVERTIME

ENCODE{"string"} -- encodes a string

  • 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 &#034; URL encoding
    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
  • Related: URLPARAM

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
    $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 2017-11-20T11:46Z
    $rcs RCS format timestamp 2017/11/20 11:46:53
    $http E-mail & http format timestamp Mon, 20 Nov 2017 11:46:53 GMT
  • Variables can be shortened to 3 characters
  • Example: %GMTIME{"$day $month, $year - $hour:$min:$sec"}% expands to 20 Nov, 2017 - 11:46:53
  • Related: DISPLAYTIME, GMTIME, SERVERTIME

HOMETOPIC -- home topic in each web

HTTP_HOST -- environment variable

ICON{"type"} -- small icon of common attachment types

  • Small 16x16 pixel icon of common attachment types. Specify file type only, file name, or full path name
  • Syntax: %ICON{"type"}%
  • Samples: bmp, doc, gif, hlp, html, mp3, pdf, ppt, txt, xls, xml, zip
  • Example: %ICON{"pdf"}% expands to
  • Related: TWikiPreferences, FileAttachments, TWikiDocGraphics

INCLUDE{"page"} -- include other topics or web pages

  • 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/"}%  
    pattern="..." A RegularExpression pattern to include a subset of a topic or page none
    rev="1.2" Include a previous topic revision; N/A for URLs top revision
    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) %INCLUDE- WARNING% preferences setting
  • Related: BASETOPIC, BASEWEB, INCLUDINGTOPIC, INCLUDINGWEB, IncludeTopicsAndWebPages

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

MAINWEB -- name of Main web

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
    required
    web="%WEB%" Wiki web to search: A web, a list of webs separated by whitespace, or all webs. required
    topic="%TOPIC%" The topic the search relates to required
    title="Title" Text that is prepended to any search results required
  • 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: "}%
  • Related: SEARCH

NOTIFYTOPIC -- name of the notify topic

PUBURL -- the base URL of attachments

  • Syntax: %PUBURL%
  • Expands to: http://galeon.sourceforge.net/twiki/pub
  • Example: You can refer to a file attached to another topic with %PUBURL%/%WEB%/OtherTopic/image.gif
  • Related: ATTACHURL, PUBURLPATH, SCRIPTURL, FileAttachments

PUBURLPATH -- the base URL path of attachments

REMOTE_ADDR -- environment variable

REMOTE_PORT -- environment variable

REMOTE_USER -- environment variable

SCRIPTURL -- script URL of Galeon

  • Syntax: %SCRIPTURL%
  • Expands to: http://galeon.sourceforge.net
  • Example: To get the authenticated version of current topic write %SCRIPTURL%/viewauth%SCRIPTSUFFIX%/%WEB%/%TOPIC% which expands to http://galeon.sourceforge.net/viewauth/TWiki/TWikiVariables
  • Related: PUBURL, SCRIPTSUFFIX, SCRIPTURLPATH

SCRIPTURLPATH -- script URL path of Galeon

SCRIPTSUFFIX -- script suffix

  • Some Galeon installations require a file extension for CGI scripts like .pl or .cgi
  • Syntax: %SCRIPTSUFFIX%
  • Expands to:
  • Related: SCRIPTURL

SEARCH{"text"} -- search content

  • Inline search, shows a search result embedded in a topic
  • Syntax: %SEARCH{"text" ...}%
  • Supported parameters: [1]
    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"
    Wiki web to search: A web, a list of webs separated by comma, or all webs. [2] 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. All topics in a web
    excludetopic="Web*"
    excludetopic="Home, WebChanges"
    Exclude topics from search: A topic, a topic with asterisk wildcards, or a list of topics separated by comma. 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; in case you want to sort across webs, create a formatted table and sort it with TablePlugin's initsort Sort by topic name
    limit="all"
    limit="16"
    Limit the number of results returned. This is done after sorting in case order is specified All results
    reverse="on" Reverse the direction of the search Ascending search
    casesensitive="on" Case sensitive search Ignore case
    nosummary="on" Show topic title only Show topic summary
    bookview="on" BookView search, e.g. show complete topic text Show topic summary
    nosearch="on" Suppress search string Show search string
    noheader="on" Suppress search header
    Topics: Changed: By:
    Show search header
    nototal="on" Do not show number of topics found Show number
    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
    separator=", " Line separator between hits Newline "$n"
  • 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)
  • HELP 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

  • [1] Note: The search form uses identical names for input fields.
  • [2] Note: A web can be excluded from a web="all" search if you define a NOSEARCHALL=on variable in its WebPreferences

SERVERTIME -- server time

SERVERTIME{"format"} -- formatted server time

  • Same format qualifiers as %GMTIME%
  • Syntax: %SERVERTIME{"format"}%
  • Example: %SERVERTIME{"$hou:$min"}% expands to 11:46
  • Related: DISPLAYTIME, GMTIME, SERVERTIME

SPACEDTOPIC -- topic name, spaced and encoded

  • The current topic name with added spaces, for regular expression search of Ref-By
  • Syntax: %SPACEDTOPIC%
  • Expands to: TWiki%20*Variables
  • Related: TOPIC

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 everyting exept the %STARTINCLUDE% variable itself.
  • Syntax: %STARTINCLUDE%
  • Related: INCLUDE, 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

TOC -- table of contents of current topic

TOC{"Topic"} -- table of contents

  • Syntax: %TOC{"SomeTopic" ...}%
  • 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
  • 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:"}%
  • Related: TOC

TOPIC -- name of current topic

TOPICLIST{"format"} -- topic index of a web

  • The "format" defines the format of one topic item. It may include variables: The $name variable gets expanded to the topic name; the $web variable gets expanded to the name of the web.
  • Syntax: %TOPICLIST{"format" ...}%
  • Supported parameters:
    Parameter: Description: Default:
    "format" Format of one line, may include $name and $web variables "$name"
    format="format" (Alternative to above) "$name"
    separator=", " line separator "\n" (new line)
    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)
  • Related: SEARCH, WEBLIST

TWIKIWEB -- name of TWiki documentation web

  • The web containing all documentation and site-wide preference settings for Galeon
  • Syntax: %TWIKIWEB%
  • Expands to: TWiki
  • Related: MAINWEB

URLPARAM{"name"} -- get value of a URL parameter

  • Returns the value of a URL parameter. Note that there is a risk that this variable could be misused for cross-scripting
  • 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, like a double quote into &#034;. This is needed if text is put into an HTML form field no encoding
    encode="url" Encode special characters for URL parameter use, like a double quote into %22 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. Test this:
  • Related: SEARCH, FormattedSearch

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 #CFCBCF
  • Related: WEBPREFSTOPIC

WEB -- name of current web

WEBLIST{"format"} -- index of all webs

  • List of all webs. Hidden 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 variable "$name"
    format="format" (Alternative to above) "$name"
    separator=", " line separator "\n" (new line)
    webs="public" comma sep list of Web, public expands to all non-hidden "public"
    marker="selected" Text for $marker where item matches selection, otherwise equals "" "selected"
    selection="%WEB%" Current value to be selected in list section="%WEB%"
  • Example: %WEBLIST{"   * [[$name.Home]]"}% creates a bullet list of all webs.
  • Example: %WEBLIST{"<option $marker value=$qname>$name</option>" webs="Trash,public" selection="TWiki" separator=" "}% Dropdown of all public Webs + Trash Web, current Web highlighted.
  • Related: TOPICLIST, SEARCH

WEBPREFSTOPIC -- name of web preferences topic

WIKIHOMEURL -- site home URL

  • The base URL of Galeon, is the link of the Home icon in the upper left corner, defined in TWiki.cfg
  • Syntax: %WIKIHOMEURL%
  • Expands to: http://galeon.sourceforge.net/Main
  • 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

  • Your %WIKINAME% with Main web prefix, useful to point to your Galeon home page
  • Syntax: %WIKIUSERNAME%
  • Expands to: Main.TWikiGuest, renders as TWikiGuest
  • Related: REMOTE_USER, USERNAME, WIKINAME

WIKIUSERSTOPIC -- name of topic listing all registers users

  • Syntax: %WIKIUSERSTOPIC%
  • Expands to: TWikiUsers, with Main prefix renders as TWikiUsers
  • Related: WIKIUSERNAME

WIKIVERSION -- the version of the installed TWiki engine

  • Syntax: %WIKIVERSION%
  • Expands to: 07 May 2004
  • Related: WIKITOOLNAME

Preferences Variables

Additional variables are defined in the preferences ( site-level ( SL ) in TWikiPreferences, web-level ( WL ) in WebPreferences of each web, and user level ( UL ) preferences in individual user topics):

Variable: Level: What:
%ALLOWTOPICCHANGE% (any topic) List of users and groups who are allowed to change the current topic. (More in TWikiAccessControl)
%ALLOWTOPICRENAME% (any topic) List of users and groups who are allowed to rename the current topic. (More in TWikiAccessControl)
%ALLOWWEBCHANGE% WL List of users and groups who are allowed to change topics in the Galeon web. (More in TWikiAccessControl)
%ALLOWWEBRENAME% WL List of users and groups who are allowed to rename topics in the Galeon web. (More in TWikiAccessControl)
%ATTACHLINKBOX% SL , UL Default state of the link check box in the attach file page. Check box is initially checked if value is set to CHECKED , unchecked if empty. If checked, a link is created to the attached file at the end of the topic. Value is:
%DENYTOPICCHANGE% (any topic) List of users and groups who are not allowed to change the current topic. (More in TWikiAccessControl)
%DENYTOPICRENAME% (any topic) List of users and groups who are not allowed to rename the current topic. (More in TWikiAccessControl)
%DENYWEBCHANGE% WL List of users and groups who are not allowed to change topics in the Galeon web. (More in TWikiAccessControl)
%DENYWEBRENAME% WL List of users and groups who are not allowed to rename topics in the Galeon web. (More in TWikiAccessControl)
%DONTNOTIFYCHECKBOX% SL , UL Default state of the "Minor Changes, Don't Notify" (DontNotify) check box in preview. Check box is initially checked if Set DONTNOTIFYCHECKBOX = checked="checked", or unchecked if empty. Value is:
%EDITBOXHEIGHT% SL , UL Vertical size of edit box, is 17
%EDITBOXWIDTH% SL , UL Horizontal size of edit box, is 70
%EDITBOXSTYLE% SL , UL Style of text edit box. Set to width: 99% for full window width (default; overwrites the EDITBOXWIDTH setting), or width: auto to disable. Value is: width: 99%
%FINALPREFERENCES% SL , WL List of preferences that are not allowed to be overridden by next level preferences
%HTTP_EQUIV_ON_EDIT% SL , UL http-equiv meta tags for edit script.
%HTTP_EQUIV_ON_PREVIEW% SL , UL http-equiv meta tags for preview script.
%HTTP_EQUIV_ON_VIEW% SL http-equiv meta tags for view, rdiff, attach, search* scripts.
%NEWTOPICBGCOLOR% SL , UL Background color of non existing topic. ( UL needs authentication for topic views )
%NEWTOPICFONTCOLOR% SL , UL Font color of non existing topic. ( UL needs authentication for topic views )
%NOSEARCHALL% WL Exclude web from a web="all" search (set variable to on for hidden webs)
%RELEASEEDITLOCKCHECKBOX% SL , UL Default state of the "Release edit lock" (UnlockTopic) check box in preview. Checkbox is initially checked if Set RELEASEEDITLOCKCHECKBOX = checked="checked", or unchecked if empty. If checked, make sure to click on Edit to do more changes; do not go back in your browser to the edit page, or you risk that someone else will edit the topic at the same time! Value is: checked="checked"
%WEBBGCOLOR% WL Background color of web
%WEBCOPYRIGHT% SL , WL Copyright notice (bottom right corner of topics)
%WEBTOPICLIST% WL Common links of web (second line of topics)
%WIKIWEBLIST% SL List of Galeon webs (in upper right corner of topics)
%WIKIWEBMASTER% SL Webmaster email address (sender of email notifications) , is tko@users.sourceforge.net

Note: There are some more useful variables defined in the TWikiPreferences like %BR% for line break, colors like %RED% for colored text and small icons like %H% for a HELP Help icon.

Setting Preferences

  • The syntax for Preferences 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] = [value]
    Examples:
  • Set VARIABLENAME = value
    • Set VARIABLENAME = value

Creating Custom Variables

  • You can add your own Preference Variables for us across an entire site or a single web, using the standard Preferences syntax. Whatever you include in your Variable will be expanded on display, exactly as if it had been entered directly. You can place formatted text, page links, image paths.

Example: Create a custom logo variable the TWiki web
  • To place a logo anywhere in a web by typing %MYLOGO%, define the Variable on the web's WebPreferences page, 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, ex: LogoTopic:
    • Set MYLOGO = %PUBURL%/TWiki/LogoTopic/mylogo.gif

-- TWiki:Main.PeterThoeny - 09 May 2004
-- TWiki:Main.MikeMannix - 12 May 2002

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

 <<O>>  Difference Topic TextFormattingRules (r1.3 - 09 Aug 1999 - PeterThoeny)
Line: 17 to 17

EDITING

Changed:
<
<
  • CapitalizedWordsWillProduce? a link automatically.
>
>
  • CapitalizedWordsStickedTogether? will produce a link automatically.

  • Blank lines will create new paragraphs.
Changed:
<
<
  • 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 _
Line: 36 to 36

  • Nested Item: <6spaces>*
  • Ordered List: <3spaces><number>.
  • Definition: <3spaces><term>:<definition>.
Added:
>
>
  • Table: <optional spaces>| cell 1 | cell 2 | cell 3 | ... |

EXTRAS

Line: 45 to 47

WIKI VARIABLES

Changed:
<
<
%INCLUDE:"TWikiVariables.txt"%
>
>

TWiki Variables

Special text strings expand on the fly to display user data or system info

TWikiVariables are text strings - %VARIABLE% - that expand into content whenever a page is opened. When a topic is rendered for viewing, VARIABLES are replaced by data, either user-entered, or info automatically generated by TWiki (like the date, or the current username). There are predefined variables, and Preference variables that you configure. You can also define custom variables, with new names and values.

Note: To leave a variable unexpanded, preceed it with an exclamation point, e.g. type !%TOPIC% to get %TOPIC%.

Predefined Variables

Most predefined variables return values that were either set in the lib/twiki.cfg file, when TWiki was installed, or taken from server info (like current username, or date and time). Many of the variables let you format the appearance of the display results.

  • TIP 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 - 07 May 2004 - expands the following variables (enclosed in % percent signs):

ATTACHURL -- attachment URL of the current topic

ATTACHURLPATH -- path of the attachment URL of the current topic

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

DISPLAYTIME -- display time

DISPLAYTIME{"format"} -- formatted display time

  • Formatted time - either GMT or Local server time, depending on setting in TWiki.cfg. Same format qualifiers as %GMTIME%
  • Syntax: %DISPLAYTIME{"format"}%
  • Example: %DISPLAYTIME{"$hou:$min"}% expands to 11:46
  • Related: DISPLAYTIME, GMTIME, SERVERTIME

ENCODE{"string"} -- encodes a string

  • 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 &#034; URL encoding
    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
  • Related: URLPARAM

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
    $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 2017-11-20T11:46Z
    $rcs RCS format timestamp 2017/11/20 11:46:54
    $http E-mail & http format timestamp Mon, 20 Nov 2017 11:46:54 GMT
  • Variables can be shortened to 3 characters
  • Example: %GMTIME{"$day $month, $year - $hour:$min:$sec"}% expands to 20 Nov, 2017 - 11:46:54
  • Related: DISPLAYTIME, GMTIME, SERVERTIME

HOMETOPIC -- home topic in each web

HTTP_HOST -- environment variable

ICON{"type"} -- small icon of common attachment types

  • Small 16x16 pixel icon of common attachment types. Specify file type only, file name, or full path name
  • Syntax: %ICON{"type"}%
  • Samples: bmp, doc, gif, hlp, html, mp3, pdf, ppt, txt, xls, xml, zip
  • Example: %ICON{"pdf"}% expands to
  • Related: TWikiPreferences, FileAttachments, TWikiDocGraphics

INCLUDE{"page"} -- include other topics or web pages

  • 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/"}%  
    pattern="..." A RegularExpression pattern to include a subset of a topic or page none
    rev="1.2" Include a previous topic revision; N/A for URLs top revision
    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) %INCLUDE- WARNING% preferences setting
  • Related: BASETOPIC, BASEWEB, INCLUDINGTOPIC, INCLUDINGWEB, IncludeTopicsAndWebPages

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

MAINWEB -- name of Main web

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
    required
    web="%WEB%" Wiki web to search: A web, a list of webs separated by whitespace, or all webs. required
    topic="%TOPIC%" The topic the search relates to required
    title="Title" Text that is prepended to any search results required
  • 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: "}%
  • Related: SEARCH

NOTIFYTOPIC -- name of the notify topic

PUBURL -- the base URL of attachments

  • Syntax: %PUBURL%
  • Expands to: http://galeon.sourceforge.net/twiki/pub
  • Example: You can refer to a file attached to another topic with %PUBURL%/%WEB%/OtherTopic/image.gif
  • Related: ATTACHURL, PUBURLPATH, SCRIPTURL, FileAttachments

PUBURLPATH -- the base URL path of attachments

REMOTE_ADDR -- environment variable

REMOTE_PORT -- environment variable

REMOTE_USER -- environment variable

SCRIPTURL -- script URL of Galeon

  • Syntax: %SCRIPTURL%
  • Expands to: http://galeon.sourceforge.net
  • Example: To get the authenticated version of current topic write %SCRIPTURL%/viewauth%SCRIPTSUFFIX%/%WEB%/%TOPIC% which expands to http://galeon.sourceforge.net/viewauth/TWiki/TWikiVariables
  • Related: PUBURL, SCRIPTSUFFIX, SCRIPTURLPATH

SCRIPTURLPATH -- script URL path of Galeon

SCRIPTSUFFIX -- script suffix

  • Some Galeon installations require a file extension for CGI scripts like .pl or .cgi
  • Syntax: %SCRIPTSUFFIX%
  • Expands to:
  • Related: SCRIPTURL

SEARCH{"text"} -- search content

  • Inline search, shows a search result embedded in a topic
  • Syntax: %SEARCH{"text" ...}%
  • Supported parameters: [1]
    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"
    Wiki web to search: A web, a list of webs separated by comma, or all webs. [2] 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. All topics in a web
    excludetopic="Web*"
    excludetopic="Home, WebChanges"
    Exclude topics from search: A topic, a topic with asterisk wildcards, or a list of topics separated by comma. 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; in case you want to sort across webs, create a formatted table and sort it with TablePlugin's initsort Sort by topic name
    limit="all"
    limit="16"
    Limit the number of results returned. This is done after sorting in case order is specified All results
    reverse="on" Reverse the direction of the search Ascending search
    casesensitive="on" Case sensitive search Ignore case
    nosummary="on" Show topic title only Show topic summary
    bookview="on" BookView search, e.g. show complete topic text Show topic summary
    nosearch="on" Suppress search string Show search string
    noheader="on" Suppress search header
    Topics: Changed: By:
    Show search header
    nototal="on" Do not show number of topics found Show number
    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
    separator=", " Line separator between hits Newline "$n"
  • 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)
  • HELP 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

  • [1] Note: The search form uses identical names for input fields.
  • [2] Note: A web can be excluded from a web="all" search if you define a NOSEARCHALL=on variable in its WebPreferences

SERVERTIME -- server time

SERVERTIME{"format"} -- formatted server time

  • Same format qualifiers as %GMTIME%
  • Syntax: %SERVERTIME{"format"}%
  • Example: %SERVERTIME{"$hou:$min"}% expands to 11:46
  • Related: DISPLAYTIME, GMTIME, SERVERTIME

SPACEDTOPIC -- topic name, spaced and encoded

  • The current topic name with added spaces, for regular expression search of Ref-By
  • Syntax: %SPACEDTOPIC%
  • Expands to: TWiki%20*Variables
  • Related: TOPIC

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 everyting exept the %STARTINCLUDE% variable itself.
  • Syntax: %STARTINCLUDE%
  • Related: INCLUDE, 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

TOC -- table of contents of current topic

TOC{"Topic"} -- table of contents

  • Syntax: %TOC{"SomeTopic" ...}%
  • 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
  • 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:"}%
  • Related: TOC

TOPIC -- name of current topic

TOPICLIST{"format"} -- topic index of a web

  • The "format" defines the format of one topic item. It may include variables: The $name variable gets expanded to the topic name; the $web variable gets expanded to the name of the web.
  • Syntax: %TOPICLIST{"format" ...}%
  • Supported parameters:
    Parameter: Description: Default:
    "format" Format of one line, may include $name and $web variables "$name"
    format="format" (Alternative to above) "$name"
    separator=", " line separator "\n" (new line)
    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)
  • Related: SEARCH, WEBLIST

TWIKIWEB -- name of TWiki documentation web

  • The web containing all documentation and site-wide preference settings for Galeon
  • Syntax: %TWIKIWEB%
  • Expands to: TWiki
  • Related: MAINWEB

URLPARAM{"name"} -- get value of a URL parameter

  • Returns the value of a URL parameter. Note that there is a risk that this variable could be misused for cross-scripting
  • 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, like a double quote into &#034;. This is needed if text is put into an HTML form field no encoding
    encode="url" Encode special characters for URL parameter use, like a double quote into %22 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. Test this:
  • Related: SEARCH, FormattedSearch

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 #CFCBCF
  • Related: WEBPREFSTOPIC

WEB -- name of current web

WEBLIST{"format"} -- index of all webs

  • List of all webs. Hidden 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 variable "$name"
    format="format" (Alternative to above) "$name"
    separator=", " line separator "\n" (new line)
    webs="public" comma sep list of Web, public expands to all non-hidden "public"
    marker="selected" Text for $marker where item matches selection, otherwise equals "" "selected"
    selection="%WEB%" Current value to be selected in list section="%WEB%"
  • Example: %WEBLIST{"   * [[$name.Home]]"}% creates a bullet list of all webs.
  • Example: %WEBLIST{"<option $marker value=$qname>$name</option>" webs="Trash,public" selection="TWiki" separator=" "}% Dropdown of all public Webs + Trash Web, current Web highlighted.
  • Related: TOPICLIST, SEARCH

WEBPREFSTOPIC -- name of web preferences topic

WIKIHOMEURL -- site home URL

  • The base URL of Galeon, is the link of the Home icon in the upper left corner, defined in TWiki.cfg
  • Syntax: %WIKIHOMEURL%
  • Expands to: http://galeon.sourceforge.net/Main
  • 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

  • Your %WIKINAME% with Main web prefix, useful to point to your Galeon home page
  • Syntax: %WIKIUSERNAME%
  • Expands to: Main.TWikiGuest, renders as TWikiGuest
  • Related: REMOTE_USER, USERNAME, WIKINAME

WIKIUSERSTOPIC -- name of topic listing all registers users

  • Syntax: %WIKIUSERSTOPIC%
  • Expands to: TWikiUsers, with Main prefix renders as TWikiUsers
  • Related: WIKIUSERNAME

WIKIVERSION -- the version of the installed TWiki engine

  • Syntax: %WIKIVERSION%
  • Expands to: 07 May 2004
  • Related: WIKITOOLNAME

Preferences Variables

Additional variables are defined in the preferences ( site-level ( SL ) in TWikiPreferences, web-level ( WL ) in WebPreferences of each web, and user level ( UL ) preferences in individual user topics):

Variable: Level: What:
%ALLOWTOPICCHANGE% (any topic) List of users and groups who are allowed to change the current topic. (More in TWikiAccessControl)
%ALLOWTOPICRENAME% (any topic) List of users and groups who are allowed to rename the current topic. (More in TWikiAccessControl)
%ALLOWWEBCHANGE% WL List of users and groups who are allowed to change topics in the Galeon web. (More in TWikiAccessControl)
%ALLOWWEBRENAME% WL List of users and groups who are allowed to rename topics in the Galeon web. (More in TWikiAccessControl)
%ATTACHLINKBOX% SL , UL Default state of the link check box in the attach file page. Check box is initially checked if value is set to CHECKED , unchecked if empty. If checked, a link is created to the attached file at the end of the topic. Value is:
%DENYTOPICCHANGE% (any topic) List of users and groups who are not allowed to change the current topic. (More in TWikiAccessControl)
%DENYTOPICRENAME% (any topic) List of users and groups who are not allowed to rename the current topic. (More in TWikiAccessControl)
%DENYWEBCHANGE% WL List of users and groups who are not allowed to change topics in the Galeon web. (More in TWikiAccessControl)
%DENYWEBRENAME% WL List of users and groups who are not allowed to rename topics in the Galeon web. (More in TWikiAccessControl)
%DONTNOTIFYCHECKBOX% SL , UL Default state of the "Minor Changes, Don't Notify" (DontNotify) check box in preview. Check box is initially checked if Set DONTNOTIFYCHECKBOX = checked="checked", or unchecked if empty. Value is:
%EDITBOXHEIGHT% SL , UL Vertical size of edit box, is 17
%EDITBOXWIDTH% SL , UL Horizontal size of edit box, is 70
%EDITBOXSTYLE% SL , UL Style of text edit box. Set to width: 99% for full window width (default; overwrites the EDITBOXWIDTH setting), or width: auto to disable. Value is: width: 99%
%FINALPREFERENCES% SL , WL List of preferences that are not allowed to be overridden by next level preferences
%HTTP_EQUIV_ON_EDIT% SL , UL http-equiv meta tags for edit script.
%HTTP_EQUIV_ON_PREVIEW% SL , UL http-equiv meta tags for preview script.
%HTTP_EQUIV_ON_VIEW% SL http-equiv meta tags for view, rdiff, attach, search* scripts.
%NEWTOPICBGCOLOR% SL , UL Background color of non existing topic. ( UL needs authentication for topic views )
%NEWTOPICFONTCOLOR% SL , UL Font color of non existing topic. ( UL needs authentication for topic views )
%NOSEARCHALL% WL Exclude web from a web="all" search (set variable to on for hidden webs)
%RELEASEEDITLOCKCHECKBOX% SL , UL Default state of the "Release edit lock" (UnlockTopic) check box in preview. Checkbox is initially checked if Set RELEASEEDITLOCKCHECKBOX = checked="checked", or unchecked if empty. If checked, make sure to click on Edit to do more changes; do not go back in your browser to the edit page, or you risk that someone else will edit the topic at the same time! Value is: checked="checked"
%WEBBGCOLOR% WL Background color of web
%WEBCOPYRIGHT% SL , WL Copyright notice (bottom right corner of topics)
%WEBTOPICLIST% WL Common links of web (second line of topics)
%WIKIWEBLIST% SL List of Galeon webs (in upper right corner of topics)
%WIKIWEBMASTER% SL Webmaster email address (sender of email notifications) , is tko@users.sourceforge.net

Note: There are some more useful variables defined in the TWikiPreferences like %BR% for line break, colors like %RED% for colored text and small icons like %H% for a HELP Help icon.

Setting Preferences

  • The syntax for Preferences 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] = [value]
    Examples:
  • Set VARIABLENAME = value
    • Set VARIABLENAME = value

Creating Custom Variables

  • You can add your own Preference Variables for us across an entire site or a single web, using the standard Preferences syntax. Whatever you include in your Variable will be expanded on display, exactly as if it had been entered directly. You can place formatted text, page links, image paths.

Example: Create a custom logo variable the TWiki web
  • To place a logo anywhere in a web by typing %MYLOGO%, define the Variable on the web's WebPreferences page, 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, ex: LogoTopic:
    • Set MYLOGO = %PUBURL%/TWiki/LogoTopic/mylogo.gif

-- TWiki:Main.PeterThoeny - 09 May 2004
-- TWiki:Main.MikeMannix - 12 May 2002


 <<O>>  Difference Topic TextFormattingRules (r1.2 - 23 Jun 1999 - Main.thoeny)
Line: 19 to 19

  • CapitalizedWordsWillProduce? a link automatically.
  • Blank lines will create new paragraphs.
Changed:
<
<
  • 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>*

 <<O>>  Difference Topic TextFormattingRules (r1.1 - 13 Jun 1999 - Main.thoeny)
Line: 1 to 1
Added:
>
>
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

WIKI VARIABLES

%INCLUDE:"TWikiVariables.txt"%


Revision r1.1 - 13 Jun 1999 - 07:38 - Main.thoeny
Revision r1.46 - 30 Jul 2005 - 22:38 - TWikiGuest
Copyright © 1999-2017 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding Galeon? Send feedback.