netfrag.org > TWiki > TextFormattingRules (r1.1 vs. r1.30)
TWiki . { Home? | Welcome | Register | Changes | Index | Search | Go }

 <<O>>  Difference Topic TextFormattingRules (r1.30 - 03 Dec 2001 - MikeMannix?)
Line: 1 369 to 1 369
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

Line: 371 to 373
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.

 <<O>>  Difference Topic TextFormattingRules (r1.29 - 02 Dec 2001 - MikeMannix?)
Line: 1 4 to 1 4
Changed:
<
<

Appendix C: Text Formatting Rules

>
>

TWiki Text Formatting

Line: 292 to 292
Changed:
<
<
>
>
#SquareBrackets
Line: 393 to 392
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 netfrag.org 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

Line: 419 to 394
Changed:
<
<

TWiki Plugins

>
>
Plugins provide additional text formatting capabilities and can extend the functionality of netfrag.org into many other areas. For example, the optional SpreadSheetPlugin lets you create a spreadsheet with the same basic notation used in TWiki tables.
Line: 421 to 396
Changed:
<
<
Plugins provide additional text formatting capabilities and can extend the functionality of netfrag.org 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%:
Line: 427 to 402
Changed:
<
<
-- MikeMannix - 02 Oct 2001
>
>
-- MikeMannix? - 02 Dec 2001

 <<O>>  Difference Topic TextFormattingRules (r1.28 - 02 Oct 2001 - MikeMannix?)
Line: 1 4 to 1 4
Changed:
<
<

TWiki Text Formatting

>
>

Appendix C: Text Formatting Rules

Line: 417 to 417
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'.
Line: 427 to 427
Changed:
<
<
-- MikeMannix - 30 Aug 2001
>
>
-- MikeMannix - 02 Oct 2001

 <<O>>  Difference Topic TextFormattingRules (r1.27 - 18 Sep 2001 - MikeMannix?)
Line: 1 292 to 1 292
Changed:
<
<
#SquareBrackets
>
>

 <<O>>  Difference Topic TextFormattingRules (r1.26 - 07 Sep 2001 - MikeMannix?)
Line: 1 6 to 1 7
Added:
>
>
Line: 291 to 292
Changed:
<
<
>
>
#SquareBrackets
Line: 368 to 369
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.
Line: 372 to 376
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.
Line: 377 to 381
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!)
Line: 383 to 390
Added:
>
>
Line: 387 to 394
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.
Line: 389 to 397
Deleted:
<
<
  • %TOC% : The table of content, is based on headings in a topic.
Line: 393 to 402
Deleted:
<
<
  • %INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current netfrag.org web is the default web. Example: %INCLUDE{"TWiki.TWikiWebsTable"}%
  • There are many more variables, see TWikiVariables.
Line: 396 to 404
Changed:
<
<

"Gotchas" when Editing Text

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

Line: 398 to 408
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:

Line: 406 to 417
Deleted:
<
<
Line: 410 to 420
Changed:
<
<
Plugins provide additional text formatting rules and can extend the functionality of netfrag.org 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 netfrag.org 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:

 <<O>>  Difference Topic TextFormattingRules (r1.25 - 06 Sep 2001 - MikeMannix?)
Line: 1 4 to 1 4
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.
Line: 6 to 7
Changed:
<
<

Editing

>
>

TWiki Editing Shorthand

Line: 8 to 9
Changed:
<
<
>
>
Line: 20 to 19
Changed:
<
<
>
>
Line: 38 to 37
Changed:
<
<
>
>
Line: 56 to 55
Changed:
<
<
>
>
Line: 70 to 69
Changed:
<
<
>
>
Line: 84 to 83
Changed:
<
<
>
>
Line: 98 to 97
Changed:
<
<
>
>
Line: 112 to 111
Changed:
<
<
>
>
Line: 126 to 125
Changed:
<
<
>
>
Line: 141 to 140
Changed:
<
<
>
>
Line: 167 to 166
Changed:
<
<
>
>
Line: 181 to 180
Changed:
<
<
>
>
Line: 195 to 194
Changed:
<
<
>
>
Line: 209 to 208
Changed:
<
<
>
>
Line: 225 to 224
Changed:
<
<
>
>
Line: 242 to 241
Changed:
<
<
>
>
Line: 273 to 272
Changed:
<
<
>
>
Line: 291 to 290
Changed:
<
<
>
>
Line: 309 to 308
Changed:
<
<
>
>
Line: 327 to 326
Changed:
<
<
>
>
Line: 349 to 348
Changed:
<
<
>
>

 <<O>>  Difference Topic TextFormattingRules (r1.24 - 06 Sep 2001 - MikeMannix?)
Line: 1 8 to 1 8
Changed:
<
<
>
>
Line: 361 to 364
Added:
>
>

 <<O>>  Difference Topic TextFormattingRules (r1.23 - 06 Sep 2001 - MikeMannix?)
Line: 1 6 to 1 5
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 netfrag.org 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.
Line: 23 to 8
Changed:
<
<
>
>
Line: 383 to 367
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 netfrag.org 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.

 <<O>>  Difference Topic TextFormattingRules (r1.22 - 30 Aug 2001 - MikeMannix?)
Line: 1 4 to 1 4
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.
Line: 8 to 8
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.
Line: 10 to 10
Changed:
<
<

netfrag.org Internal Links

>
>

Internal Links

Line: 15 to 15
Changed:
<
<

Remote Site Links

>
>

External Links

Line: 410 to 410
Changed:
<
<

netfrag.org Plugins

>
>

TWiki Plugins

Line: 412 to 412
Changed:
<
<
Plugins offer additional text formatting rules and extend the functionality of netfrag.org. Currently enabled plugins are:
>
>
Plugins provide additional text formatting rules and can extend the functionality of netfrag.org into many other areas. Available Plugins are located in the Plugins web. Currently enabled plugins on this site are:
Line: 416 to 416
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:
<
<
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"

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

Line: 8 to 8
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.
Line: 15 to 15
Changed:
<
<

External Links

>
>

Remote Site Links


 <<O>>  Difference Topic TextFormattingRules (r1.20 - 11 Aug 2001 - PeterThoeny?)
Line: 1 241 to 1 241
Changed:
<
<
Three spaces, the term, a colon, followed by the definition.
>
>
Three spaces, the term, a colon, a space, followed by the definition.

 <<O>>  Difference Topic TextFormattingRules (r1.19 - 14 Jul 2001 - PeterThoeny?)
Line: 0 411 to 1 412
Changed:
<
<
netfrag.org Plugins offer additional text formatting rules. Plugins currently installed are:
>
>
Plugins offer additional text formatting rules and extend the functionality of netfrag.org. Currently enabled plugins are:
Line: 413 to 414
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 deprecated *_text_* as bold italic text.
  • HeadlinesPlugin: Build news portals that show headline news based on RSS news feeds from news sites.
  • InterwikiPlugin: Link ExternalSite:Page text to external sites based on aliases defined in the InterWikis topic.
  • TablePlugin: Control attributes of tables and sorting of table columns
  • VisualConfirmPlugin: Plugin for visual confirmation of new user registration.

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

LINKS

>
>

Links

Line: 7 to 9
Changed:
<
<
The netfrag.org web has the following types of internal links:
>
>

netfrag.org Internal Links

Line: 12 to 14
Changed:
<
<

External links:

>
>

External Links

Line: 18 to 20
Changed:
<
<

EDITING

>
>

Editing

Line: 55 to 57
Changed:
<
<

Sushi

>
>
---++ Sushi
Line: 57 to 59
Changed:
<
<

Maguro

>
>
---+++ Maguro
Line: 61 to 63
Changed:
<
<

Sushi

>
>

Sushi

Line: 63 to 65
Changed:
<
<

Maguro

>
>

Maguro

Line: 376 to 378
Changed:
<
<

HTML

>
>

Using HTML

Line: 380 to 382
Changed:
<
<
>
>
Line: 384 to 386
Changed:
<
<

WIKI VARIABLES

>
>

TWiki Variables

Line: 387 to 390
Added:
>
>
  • %TOC% : The table of content, is based on headings in a topic.
Line: 393 to 397
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'.

Line: 395 to 409
Changed:
<
<

netfrag.org PLUGINS

>
>

netfrag.org Plugins


 <<O>>  Difference Topic TextFormattingRules (r1.17 - 05 Apr 2001 - PeterThoeny?)
Line: 256 to 256
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.
Line: 260 to 264
Changed:
<
<
A1 B1 C1
A2 B2 C2
| A3 \
>
>
L C R
A2 2 2
A3 3 3
multi span
| A4 \
Line: 268 to 274
Changed:
<
<
A1 B1 C1
A2 B2 C2
| A3
>
>
L C down R
A2 2 2
A3 3 3
multi span
| A4

 <<O>>  Difference Topic TextFormattingRules (r1.16 - 16 Mar 2001 - PeterThoeny?)
Line: 3 to 3
Changed:
<
<
LINKS
>
>

LINKS

Line: 12 to 12
Changed:
<
<
External links:
>
>

External links:

Line: 17 to 17
Changed:
<
<
EDITING
>
>

EDITING

Line: 367 to 368
Changed:
<
<
HTML
>
>

HTML

Line: 374 to 375
Changed:
<
<
WIKI VARIABLES
>
>

WIKI VARIABLES

Line: 382 to 385
Added:
>
>

netfrag.org PLUGINS

netfrag.org 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: 48 to 49
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

Line: 161 to 179
Changed:
<
<
At least four dashes at the beginning of a line.
>
>
At least three dashes at the beginning of a line.
Line: 295 to 313
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!]].
Line: 299 to 317
Changed:
<
<
WikiSyntax?
>
>
syntax
Line: 301 to 319
Changed:
<
<
http://gnu.org?
>
>
GNU
Line: 305 to 323
Changed:
<
<
WikiSyntax?
>
>
syntax
Line: 307 to 325
Changed:
<
<
http://gnu.org?
>
>
GNU
Line: 313 to 331
Changed:
<
<
You can define a link reference inside a netfrag.org 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 netfrag.org 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: 317 to 335
Changed:
<
<
WebHome@NotThere?
>
>
WebHome#NotThere
Line: 319 to 337
Changed:
<
<
@MyAnchor?
>
>
Jump
Line: 321 to 339
Changed:
<
<
@MyAnchor To here
>
>
To here
Line: 325 to 343
Changed:
<
<
WebHome@NotThere?
>
>
WebHome#NotThere
Line: 327 to 345
Changed:
<
<
@MyAnchor?
>
>
Jump
Line: 329 to 347
Changed:
<
<
@MyAnchor To here
>
>
To here

 <<O>>  Difference Topic TextFormattingRules (r1.14 - 25 Feb 2001 - PeterThoeny?)
Line: 263 to 263
Changed:
<
<
WebNotify,
>
>
WebNotify
Line: 268 to 269
Changed:
<
<
WebNotify,
>
>
WebNotify
Line: 275 to 277
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.
Line: 279 to 281
Changed:
<
<
wiki syntax,
>
>
wiki syntax
Line: 284 to 287
Changed:
<
<
wiki syntax,
>
>
wiki syntax
Line: 289 to 294
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 netfrag.org 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


 <<O>>  Difference Topic TextFormattingRules (r1.13 - 10 Feb 2001 - PeterThoeny?)
Line: 236 to 236
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.
Line: 241 to 243
Added:
>
>
| A3 \ | next \
next
Line: 246 to 251
Added:
>
>
A3 next next
Line: 293 to 299
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: 19 to 19
Changed:
<
<
  • CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically. In case you want to link to a topic in a different netfrag.org 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 netfrag.org 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

 <<O>>  Difference Topic TextFormattingRules (r1.11 - 21 Jan 2001 - PeterThoeny?)
Line: 25 to 25
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

 <<O>>  Difference Topic TextFormattingRules (r1.10 - 12 Dec 2000 - PeterThoeny?)
Line: 38 to 38
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:.

 <<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.
Line: 10 to 10
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!)

 <<O>>  Difference Topic TextFormattingRules (r1.8 - 11 Nov 2000 - PeterThoeny?)
Line: 7 to 7
Changed:
<
<
The TWiki web has the following types of internal links:
>
>
The netfrag.org web has the following types of internal links:
Line: 14 to 14
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.
Line: 20 to 20
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.
Line: 56 to 56
Changed:
<
<
  • %INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current netfrag.org web is the default web. Example: %INCLUDE{"TWiki.TWikiWebsTable"}%
>
>
  • %INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current netfrag.org web is the default web. Example: %INCLUDE{"TWiki.TWikiWebsTable"}%

 <<O>>  Difference Topic TextFormattingRules (r1.7 - 01 Nov 2000 - PeterThoeny?)
Line: 9 to 9
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 netfrag.org web.
Line: 11 to 10
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.
Line: 21 to 19
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 netfrag.org 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.

 <<O>>  Difference Topic TextFormattingRules (r1.6 - 19 Sep 2000 - PeterThoeny?)
Line: 7 to 7
Changed:
<
<
The TWiki web has the following types of internal links:
>
>
The TWiki web has the following types of internal links:
Line: 11 to 12
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.
Line: 13 to 14
Changed:
<
<
External links:
>
>
External links:

 <<O>>  Difference Topic TextFormattingRules (r1.5 - 18 Aug 2000 - PeterThoeny?)
Line: 20 to 20
Changed:
<
<
  • CapitalizedWordsStickedTogether? will produce a link automatically.
>
>
  • CapitalizedWordsStuckTogether will produce a link automatically.
Line: 34 to 34
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 | ... |>
Line: 42 to 42
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.

Line: 44 to 45
Deleted:
<
<
  • Most HTML tags will work.
Line: 50 to 51
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.
Line: 55 to 56
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 netfrag.org web is the default web. Example: %INCLUDE{"TWiki.TWikiWebsTable"}%

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

TWiki Variables

Text strings expanded on the fly to display data or system info

Overview

TWikiVariables are text strings - %VARIABLE% - that expand into content whenever a page is opened. Variables are replaced by their actual values: stored data, or system info (like the date, or the current user). There are predefined variables, and Preference variables that you set. You can also define custom variables, with new names and values.

Predefined Variables

Most predefined variables return values that were either defined when TWiki was installed, or taken from server info (like current username, or date and time). Many of the variables let you control how the formatted results appear.

netfrag.org expands the following variables (enclosed in % percent signs):

Variable: Expanded to:
%WIKIHOMEURL% The base script URL of netfrag.org, is the link of the Home icon in the upper left corner, is http://TWiki.org/
%SCRIPTURL% The script URL of netfrag.org, is http://netfrag.org/twiki/bin
%SCRIPTURLPATH% The path of the script URL of netfrag.org, is /twiki/bin
%SCRIPTSUFFIX% The script suffix, ex: .pl, .cgi is
%PUBURL% The public URL of TWiki, is http://netfrag.org/twiki/pub
%PUBURLPATH% The path of the public URL of netfrag.org, is /twiki/pub
%ATTACHURL% The attachment URL of the current topic, is http://netfrag.org/twiki/pub/TWiki/TWikiVariables
Example: If you attach a file you can refer to it as %ATTACHURL%/image.gif
%ATTACHURLPATH% The path of the attachment URL of the current topic, is /twiki/pub/TWiki/TWikiVariables
%URLPARAM{"name"}% Returns the value of a URL parameter. Ex: %URLPARAM{"skin"}% returns print for a .../view/TWiki/TWikiVariables?skin=print URL. Is
%WIKITOOLNAME% Name of wiki tool, is netfrag.org
%WIKIVERSION% Wiki tool version is 04 Sep 2004 $Rev: 1742 $
%USERNAME% Your login username is guest
%WIKINAME% Your Wiki username. Same as %USERNAME% if not defined in the TWikiUsers topic. Is TWikiGuest
%WIKIUSERNAME% Your %WIKINAME% including the Main web name. Usefull for signatures. Is Main.TWikiGuest
%MAINWEB% The Main web containing TWikiUsers, OfficeLocations? and TWikiGroups?. Is Main
%TWIKIWEB% The web containing all documentation and configuration of netfrag.org is TWiki
%WEB% The current web is TWiki
%BASEWEB% 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.
%INCLUDINGWEB% The web name of the topic that includes the current topic. Same as %WEB% in case there is no include.
%HOMETOPIC% The home topic in each web. Is Home?
%NOTIFYTOPIC% The notify topic in each web. Is WebNotify
%WIKIUSERSTOPIC% The index topic of all registered users. Is TWikiUsers
%WIKIPREFSTOPIC% The web preferences topic. Is TWikiPreferences
%WEBPREFSTOPIC% The web preferences topic. Is WebPreferences
%STATISTICSTOPIC% The web statistics topic. Is WebStatistics
%TOPIC% The current topic name, is TWikiVariables
%BASETOPIC% The name of the topic where the includes started, e.g. the first topic of nested includes. Same as %TOPIC% in case there is no include.
%INCLUDINGTOPIC% The name of the topic that includes the current topic. Same as %TOPIC% in case there is no include.
%SPACEDTOPIC% The current topic name with added spaces, for regular expression search of Ref-By, is TWiki%20*Variables
%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. Parameters are format, separator and web:
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
Examples:
%TOPICLIST{"   * $web.$name"}% creates a bullet list of all topics.
%TOPICLIST{separator=", "}% creates a comma separated list of all topics.
%TOPICLIST{" <option>$name</option>"}% creates an option list (for drop down menus).
%WEBLIST{"format"}% Web index, e.g. 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. Parameters are format, separator and web:
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%"
Examples:
%WEBLIST{"   * [[$name.Home]]"}% creates a bullet list of all webs.
%WEBLIST{"" webs="Trash,public" selection="TWiki" separator=" "}% Dropdown of all public Webs + Trash Web, current Web highlighted.
%GMTIME% GM time, is 20 Aug 2019 - 01:45
%GMTIME{"format"}% Formatted GM time based on time variables.
Variable: Unit: Example
$seconds seconds 59
$minutes minutes 59
$hours hours 23
$day day of month 31
$month month in ISO format Dec
$mo 2 digit month 12
$year 4 digit year 1999
$ye 2 digit year 99
Variables can be shortened to 3 characters. Example:
%GMTIME{"$day $month, $year - $hour:$min:$sec"}% is
20 Aug, 2019 - 01:45:29
%SERVERTIME% Server time, is 20 Aug 2019 - 03:45
%SERVERTIME{"format"}% Formatted server time.
Example: %SERVERTIME{"$hou:$min"}% is 03:45
%HTTP_HOST% HTTP_HOST environment variable, is netfrag.org
%REMOTE_ADDR% REMOTE_ADDR environment variable, is 3.226.251.205
%REMOTE_PORT% REMOTE_PORT environment variable, is 39298
%REMOTE_USER% REMOTE_USER environment variable, is
%INCLUDE{"page" ...}% Server side include to IncludeTopicsAndWebPages. Parameters are page name, and an optional pattern="(reg-exp)". The page name is:
"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.TWikiWebsTable"}%
"http://..." A full qualified URL, i.e. %INCLUDE{"http://twiki.org/"}%
%STARTINCLUDE% 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.
%STOPINCLUDE% 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.
%TOC% Table of Contents of current topic.
%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. (But not "<H2>text</H2>", which can be used to exclude a heading from the TOC.) Parameters are topic name, web and depth:
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
Examples: %TOC{depth="2"}%, %TOC{"TWikiDocumentation" web="TWiki"}%
%SEARCH{"text" ...}% Inline search, shows a search result embedded in a topic. Parameters are the search term, web, scope, order and many more: [1]
Parameter: Description: Default:
"text" Search term. (Is a regular expression or literal, depending on the regex parameter) 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 whitespace, or all webs. [2] Current web
scope="topic"
scope="text"
Search topic name (title) or in the text (body) of the topic Topic text (body)
order="topic"
order="modified"
order="editby"
Sort the results of search by the topic names, last modified time, or last editor Sort by topic name
limit="all"
limit="16"
Limit the number of results returned All results
regex="on" RegularExpression search Literal search
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
format="..." Flexible custom result formatting: see FormattedSearch for usage Results in table
Example: %SEARCH{"wiki" web="Main" scope="topic"}%
%METASEARCH{...}% Special search of meta data
Parameter: Description: Default:
type="topicmoved" What sort of search is required?
"topicmoved" if search for a topic that may have been moved
"parent" if searcing 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 the is pre-pended to any search results required
Example: %METASEARCH{type="topicmoved" web="%WEB%" topic="%TOPIC%" title="This topic used to exist and was moved to: "}%, you may want to use this in WebTopicViewTemplate and WebTopicNonWikiTemplate
%METASEARCH{type="parent" web="%WEB%" topic="%TOPIC%" title="Children: "}%
%VAR{"NAME" web="Web"}% Get a preference value from a web other then the current one. Example: To get %WEBBGCOLOR% of the Main web write %VAR{"WEBBGCOLOR" web="Main"}%, is #444444

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

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:
%WIKIWEBMASTER% SL Webmaster email address (sender of email notifications) , is webmaster@netfrag.org
%WIKIWEBLIST% SL List of netfrag.org webs (in upper right corner of topics)
%WEBTOPICLIST% WL Common links of web (second line of topics)
%WEBCOPYRIGHT% SL , WL Copyright notice (bottom right corner of topics)
%WEBBGCOLOR% WL Background color of web
%NOSEARCHALL% WL Exclude web from a web="all" search (set variable to on for hidden webs)
%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 )
%EDITBOXWIDTH% SL , UL Horizontal size of edit box, is 100
%EDITBOXHEIGHT% SL , UL Vertical size of edit box, is 20
%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
%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: checked
%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:
%HTTP_EQUIV_ON_VIEW% SL http-equiv meta tags for view, rdiff, attach, search* scripts.
%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.
%DENYWEBCHANGE% WL List of users and groups who are not allowed to change topics in the netfrag.org web. (More in TWikiAccessControl)
%ALLOWWEBCHANGE% WL List of users and groups who are allowed to change topics in the netfrag.org web. (More in TWikiAccessControl)
%DENYTOPICCHANGE% (any topic) List of users and groups who are not allowed to change the current topic. (More in TWikiAccessControl)
%ALLOWTOPICCHANGE% (any topic) List of users and groups who are allowed to change the current topic. (More in TWikiAccessControl)
%DENYWEBRENAME% WL List of users and groups who are not allowed to rename topics in the netfrag.org web. (More in TWikiAccessControl)
%ALLOWWEBRENAME% WL List of users and groups who are allowed to rename topics in the netfrag.org web. (More in TWikiAccessControl)
%DENYTOPICRENAME% (any topic) List of users and groups who are not allowed to rename 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)
%FINALPREFERENCES% SL , WL List of preferences that are not allowed to be overridden by next level preferences

Setting Preferences

  • The syntax for Preferences variables is the same anywhere in TWiki. In Edit mode, from the start of a new line:
    [6 spaces] * [space] Set [space] VARIABLENAME [space] = [value]
    Example:
    • Set VARIABLENAME = value

Creating Custom Variables

  • You can add your own preference variables for an entire site, a single web, or a single topic, using the standard syntax. Whatever you include in your variable will be expanded on display, and treated exactly as if it had been written out. So you can place formatted text, page links, image paths.

Example: Create a custom logo variable
  • To place a logo anywhere in a web by typing %MYLOGO%, simply define the variable on the web's WebPreferences page. You also have to upload logo.gif - this can be done by attaching a file to LogoTopic (any topic name you choose):
    • Set MYLOGO = %PUBURL%/%MAINWEB%/LogoTopic/logo.gif

-- PeterThoeny - 13 Sep 2001
-- MikeMannix - 30 Nov 2001

>
>
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: 20 to 20
Changed:
<
<
  • CapitalizedWordsWillProduce? a link automatically.
>
>
  • CapitalizedWordsStickedTogether? will produce a link automatically.
Line: 22 to 22
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:
Line: 38 to 39
Added:
>
>
  • Table: <optional spaces>| cell 1 | cell 2 | cell 3 | ... |
Line: 48 to 50
Changed:
<
<
%INCLUDE:"TWikiVariables.txt"%
>
>

TWiki Variables

Text strings expanded on the fly to display data or system info

Overview

TWikiVariables are text strings - %VARIABLE% - that expand into content whenever a page is opened. Variables are replaced by their actual values: stored data, or system info (like the date, or the current user). There are predefined variables, and Preference variables that you set. You can also define custom variables, with new names and values.

Predefined Variables

Most predefined variables return values that were either defined when TWiki was installed, or taken from server info (like current username, or date and time). Many of the variables let you control how the formatted results appear.

netfrag.org expands the following variables (enclosed in % percent signs):

Variable: Expanded to:
%WIKIHOMEURL% The base script URL of netfrag.org, is the link of the Home icon in the upper left corner, is http://TWiki.org/
%SCRIPTURL% The script URL of netfrag.org, is http://netfrag.org/twiki/bin
%SCRIPTURLPATH% The path of the script URL of netfrag.org, is /twiki/bin
%SCRIPTSUFFIX% The script suffix, ex: .pl, .cgi is
%PUBURL% The public URL of TWiki, is http://netfrag.org/twiki/pub
%PUBURLPATH% The path of the public URL of netfrag.org, is /twiki/pub
%ATTACHURL% The attachment URL of the current topic, is http://netfrag.org/twiki/pub/TWiki/TWikiVariables
Example: If you attach a file you can refer to it as %ATTACHURL%/image.gif
%ATTACHURLPATH% The path of the attachment URL of the current topic, is /twiki/pub/TWiki/TWikiVariables
%URLPARAM{"name"}% Returns the value of a URL parameter. Ex: %URLPARAM{"skin"}% returns print for a .../view/TWiki/TWikiVariables?skin=print URL. Is
%WIKITOOLNAME% Name of wiki tool, is netfrag.org
%WIKIVERSION% Wiki tool version is 04 Sep 2004 $Rev: 1742 $
%USERNAME% Your login username is guest
%WIKINAME% Your Wiki username. Same as %USERNAME% if not defined in the TWikiUsers topic. Is TWikiGuest
%WIKIUSERNAME% Your %WIKINAME% including the Main web name. Usefull for signatures. Is Main.TWikiGuest
%MAINWEB% The Main web containing TWikiUsers, OfficeLocations? and TWikiGroups?. Is Main
%TWIKIWEB% The web containing all documentation and configuration of netfrag.org is TWiki
%WEB% The current web is TWiki
%BASEWEB% 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.
%INCLUDINGWEB% The web name of the topic that includes the current topic. Same as %WEB% in case there is no include.
%HOMETOPIC% The home topic in each web. Is Home?
%NOTIFYTOPIC% The notify topic in each web. Is WebNotify
%WIKIUSERSTOPIC% The index topic of all registered users. Is TWikiUsers
%WIKIPREFSTOPIC% The web preferences topic. Is TWikiPreferences
%WEBPREFSTOPIC% The web preferences topic. Is WebPreferences
%STATISTICSTOPIC% The web statistics topic. Is WebStatistics
%TOPIC% The current topic name, is TWikiVariables
%BASETOPIC% The name of the topic where the includes started, e.g. the first topic of nested includes. Same as %TOPIC% in case there is no include.
%INCLUDINGTOPIC% The name of the topic that includes the current topic. Same as %TOPIC% in case there is no include.
%SPACEDTOPIC% The current topic name with added spaces, for regular expression search of Ref-By, is TWiki%20*Variables
%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. Parameters are format, separator and web:
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
Examples:
%TOPICLIST{"   * $web.$name"}% creates a bullet list of all topics.
%TOPICLIST{separator=", "}% creates a comma separated list of all topics.
%TOPICLIST{" <option>$name</option>"}% creates an option list (for drop down menus).
%WEBLIST{"format"}% Web index, e.g. 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. Parameters are format, separator and web:
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%"
Examples:
%WEBLIST{"   * [[$name.Home]]"}% creates a bullet list of all webs.
%WEBLIST{"" webs="Trash,public" selection="TWiki" separator=" "}% Dropdown of all public Webs + Trash Web, current Web highlighted.
%GMTIME% GM time, is 20 Aug 2019 - 01:45
%GMTIME{"format"}% Formatted GM time based on time variables.
Variable: Unit: Example
$seconds seconds 59
$minutes minutes 59
$hours hours 23
$day day of month 31
$month month in ISO format Dec
$mo 2 digit month 12
$year 4 digit year 1999
$ye 2 digit year 99
Variables can be shortened to 3 characters. Example:
%GMTIME{"$day $month, $year - $hour:$min:$sec"}% is
20 Aug, 2019 - 01:45:29
%SERVERTIME% Server time, is 20 Aug 2019 - 03:45
%SERVERTIME{"format"}% Formatted server time.
Example: %SERVERTIME{"$hou:$min"}% is 03:45
%HTTP_HOST% HTTP_HOST environment variable, is netfrag.org
%REMOTE_ADDR% REMOTE_ADDR environment variable, is 3.226.251.205
%REMOTE_PORT% REMOTE_PORT environment variable, is 39298
%REMOTE_USER% REMOTE_USER environment variable, is
%INCLUDE{"page" ...}% Server side include to IncludeTopicsAndWebPages. Parameters are page name, and an optional pattern="(reg-exp)". The page name is:
"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.TWikiWebsTable"}%
"http://..." A full qualified URL, i.e. %INCLUDE{"http://twiki.org/"}%
%STARTINCLUDE% 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.
%STOPINCLUDE% 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.
%TOC% Table of Contents of current topic.
%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. (But not "<H2>text</H2>", which can be used to exclude a heading from the TOC.) Parameters are topic name, web and depth:
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
Examples: %TOC{depth="2"}%, %TOC{"TWikiDocumentation" web="TWiki"}%
%SEARCH{"text" ...}% Inline search, shows a search result embedded in a topic. Parameters are the search term, web, scope, order and many more: [1]
Parameter: Description: Default:
"text" Search term. (Is a regular expression or literal, depending on the regex parameter) 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 whitespace, or all webs. [2] Current web
scope="topic"
scope="text"
Search topic name (title) or in the text (body) of the topic Topic text (body)
order="topic"
order="modified"
order="editby"
Sort the results of search by the topic names, last modified time, or last editor Sort by topic name
limit="all"
limit="16"
Limit the number of results returned All results
regex="on" RegularExpression search Literal search
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
format="..." Flexible custom result formatting: see FormattedSearch for usage Results in table
Example: %SEARCH{"wiki" web="Main" scope="topic"}%
%METASEARCH{...}% Special search of meta data
Parameter: Description: Default:
type="topicmoved" What sort of search is required?
"topicmoved" if search for a topic that may have been moved
"parent" if searcing 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 the is pre-pended to any search results required
Example: %METASEARCH{type="topicmoved" web="%WEB%" topic="%TOPIC%" title="This topic used to exist and was moved to: "}%, you may want to use this in WebTopicViewTemplate and WebTopicNonWikiTemplate
%METASEARCH{type="parent" web="%WEB%" topic="%TOPIC%" title="Children: "}%
%VAR{"NAME" web="Web"}% Get a preference value from a web other then the current one. Example: To get %WEBBGCOLOR% of the Main web write %VAR{"WEBBGCOLOR" web="Main"}%, is #444444

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

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:
%WIKIWEBMASTER% SL Webmaster email address (sender of email notifications) , is webmaster@netfrag.org
%WIKIWEBLIST% SL List of netfrag.org webs (in upper right corner of topics)
%WEBTOPICLIST% WL Common links of web (second line of topics)
%WEBCOPYRIGHT% SL , WL Copyright notice (bottom right corner of topics)
%WEBBGCOLOR% WL Background color of web
%NOSEARCHALL% WL Exclude web from a web="all" search (set variable to on for hidden webs)
%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 )
%EDITBOXWIDTH% SL , UL Horizontal size of edit box, is 100
%EDITBOXHEIGHT% SL , UL Vertical size of edit box, is 20
%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
%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: checked
%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:
%HTTP_EQUIV_ON_VIEW% SL http-equiv meta tags for view, rdiff, attach, search* scripts.
%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.
%DENYWEBCHANGE% WL List of users and groups who are not allowed to change topics in the netfrag.org web. (More in TWikiAccessControl)
%ALLOWWEBCHANGE% WL List of users and groups who are allowed to change topics in the netfrag.org web. (More in TWikiAccessControl)
%DENYTOPICCHANGE% (any topic) List of users and groups who are not allowed to change the current topic. (More in TWikiAccessControl)
%ALLOWTOPICCHANGE% (any topic) List of users and groups who are allowed to change the current topic. (More in TWikiAccessControl)
%DENYWEBRENAME% WL List of users and groups who are not allowed to rename topics in the netfrag.org web. (More in TWikiAccessControl)
%ALLOWWEBRENAME% WL List of users and groups who are allowed to rename topics in the netfrag.org web. (More in TWikiAccessControl)
%DENYTOPICRENAME% (any topic) List of users and groups who are not allowed to rename 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)
%FINALPREFERENCES% SL , WL List of preferences that are not allowed to be overridden by next level preferences

Setting Preferences

  • The syntax for Preferences variables is the same anywhere in TWiki. In Edit mode, from the start of a new line:
    [6 spaces] * [space] Set [space] VARIABLENAME [space] = [value]
    Example:
    • Set VARIABLENAME = value

Creating Custom Variables

  • You can add your own preference variables for an entire site, a single web, or a single topic, using the standard syntax. Whatever you include in your variable will be expanded on display, and treated exactly as if it had been written out. So you can place formatted text, page links, image paths.

Example: Create a custom logo variable
  • To place a logo anywhere in a web by typing %MYLOGO%, simply define the variable on the web's WebPreferences page. You also have to upload logo.gif - this can be done by attaching a file to LogoTopic (any topic name you choose):
    • Set MYLOGO = %PUBURL%/%MAINWEB%/LogoTopic/logo.gif

-- PeterThoeny - 13 Sep 2001
-- MikeMannix - 30 Nov 2001


 <<O>>  Difference Topic TextFormattingRules (r1.2 - 23 Jun 1999 - Main.thoeny)
Line: 22 to 22
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

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


Topic TextFormattingRules . { View | Diffs | r1.30 | > | r1.29 | > | r1.28 | More }    output as: { }
Revision r1.1 - 13 Jun 1999 - 07:38 - Main.thoeny
Revision r1.30 - 03 Dec 2001 - 04:11 - MikeMannix?