|
|
| 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
|
| 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.
| >
> |
-
 NOTE: TWiki is designed to work with a wide range of browsers and computer platforms, holding to HTML 3.2 compatibility in the standard installation - adding raw HTML, particularly browser-specific tags (or any other mark-up that doesn't degrade well) will reduce compatibility.
TWiki HTML Rendering
- TWiki converts shorthand notation to XHTML 1.0 for display. To copy a fully marked-up page, simply view source in your browser and save the contents.
-
 If you need to save HTML frequently, you may want to check out TWiki:Plugins/GenHTMLAddon - it will "generate a directory containing rendered versions of a set of TWiki pages together with any attached files."
- NOTE: The opening and closing angle brackets -
<...> - of an HTML tag must be on the same line, or the tag will be broken.
- This feature allows you to enter an unclosed angle bracket - as a greater than or less than symbol - and have it automatically rendered as if you had entered its HTML character,
<, ex: a > b
- If you're pasting in preformatted HTML text and notice problems, check the file in a text processor with no text wrap. Also, save without hard line breaks on text wrap, in your HTML editing program.
|
|
|
| Changed: |
<
< |
| >
> |
|
| Changed: |
<
< |
| >
> |
|
| Changed: |
<
< |
Variables are names that are enclosed in percent signs % that are expanded on the fly.
-
%TOC% : Automatically generates a table of contents based on headings in a topic - see the top of this page for an example.
-
%WEB% : The current web, is TWiki.
-
%TOPIC% : The current topic name, is TextFormattingRules.
-
%ATTACHURL% : The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as %ATTACHURL%/image.gif to show the URL of the file or the image in your text.
-
%INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current TWiki web is the default web. Example: %INCLUDE{"TWiki.TWikiWebsTable"}%
TWiki formatting rules are fairly simple to use and quick to type. However, there are some things to watch out for, taken from the TextFormattingFAQ:
- Q: Text enclosed in angle brackets like
<filename> is not displayed. How can I show it as it is?
- A: The
'<' and '>' characters have a special meaning in HTML, they define HTML tags. You need to escape them, so write '<' instead of '<', and '>' instead of '>'.
Example: Type 'prog <filename>' to get 'prog <filename>'.
- Q: Why is the
'&' character sometimes not displayed?
- A: The
'&' character has a special meaning in HTML, it starts a so called character entity, ex: '©' is the © copyright character. You need to escape '&' to see it as it is, so write '&' instead of '&'.
Example: Type 'This & that' to get 'This & that'.
| >
> |
|
| Changed: |
<
< |
| >
> |
Plugins provide additional text formatting capabilities and can extend the functionality of TWiki into many other areas. For example, the optional SpreadSheetPlugin lets you create a spreadsheet with the same basic notation used in TWiki tables.
|
| Changed: |
<
< |
Plugins provide additional text formatting capabilities and can extend the functionality of TWiki into many other areas. For example, one optional Plugin lets you create a basic spreadsheet in a similar way to tables. Available Plugins are located in the Plugins web on TWiki.org. Currently enabled plugins on here:
| >
> |
Available Plugins are located in the Plugins web on TWiki.org. Currently enabled plugins on this TWiki installation, as listed by %PLUGINDESCRIPTIONS%:
|
| Changed: |
<
< |
-- MikeMannix - 02 Oct 2001
| >
> |
-- MikeMannix? - 02 Dec 2001 |
|
|
| Changed: |
<
< |
| >
> |
|
| Changed: |
<
< |
-
- A: The
'&' character has a special meaning in HTML, it starts a so called character entity, i.e. '©' is the © copyright character. You need to escape '&' to see it as it is, so write '&' instead of '&'.
Example: Type 'This & that' to get 'This & that'.
| >
> |
-
- A: The
'&' character has a special meaning in HTML, it starts a so called character entity, ex: '©' is the © copyright character. You need to escape '&' to see it as it is, so write '&' instead of '&'.
Example: Type 'This & that' to get 'This & that'.
|
| Changed: |
<
< |
-- MikeMannix - 30 Aug 2001
| >
> |
-- MikeMannix - 02 Oct 2001
|
|
|
| Added: |
>
> |
|
| Changed: |
<
< |
| >
> |
|
| 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.
|
| 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.
|
| 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!)
|
| Added: |
>
> |
|
| Added: |
>
> |
|
| 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.
|
| Added: |
>
> |
|
| Added: |
>
> |
|
| Deleted: |
<
< |
-
%INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current TWiki web is the default web. Example: %INCLUDE{"TWiki.TWikiWebsTable"}%
- There are many more variables, see TWikiVariables.
|
| Changed: |
<
< |
| >
> |
-
%INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current TWiki 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:
| >
> |
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:
|
| Deleted: |
<
< |
|
| Changed: |
<
< |
Plugins provide additional text formatting rules and can extend the functionality of TWiki into many other areas. Available Plugins are located in the Plugins web. Currently enabled plugins on this site are:
| >
> |
Plugins provide additional text formatting capabilities and can extend the functionality of TWiki into many other areas. For example, one optional Plugin lets you create a basic spreadsheet in a similar way to tables. Available Plugins are located in the Plugins web on TWiki.org. Currently enabled plugins on here: |
|
|
| 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.
| >
> |
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: |
<
< |
| >
> |
|
| Changed: |
<
< |
| >
> |
|
| Changed: |
<
< |
|
>
> |
|
| Changed: |
<
< |
|
>
> |
|
| Changed: |
<
< |
|
>
> |
|
| Changed: |
<
< |
|
>
> |
|
| Changed: |
<
< |
|
>
> |
|
| Changed: |
<
< |
|
>
> |
|
| Changed: |
<
< |
|
>
> |
|
| Changed: |
<
< |
|
>
> |
|
| Changed: |
<
< |
|
>
> |
|
| Changed: |
<
< |
|
>
> |
|
| Changed: |
<
< |
|
>
> |
|
| Changed: |
<
< |
|
>
> |
|
| Changed: |
<
< |
|
>
> |
|
| Changed: |
<
< |
|
>
> |
|
| Changed: |
<
< |
|
>
> |
|
| Changed: |
<
< |
|
>
> |
|
| Changed: |
<
< |
|
>
> |
|
| Changed: |
<
< |
|
>
> |
|
| Changed: |
<
< |
|
>
> |
|
| Changed: |
<
< |
|
>
> |
|
| Deleted: |
<
< | |
|
|
| Deleted: |
<
< |
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.
- GoodStyle is a WikiWord that links to the GoodStyle topic located in the current TWiki web.
- NotExistingYet? is a topic waiting to be written. You could create that topic by clicking on the question mark. (Do not create that topic; you would wreck this example!)
-
http://..., https://..., ftp://... and mailto:...@... are linked automatically.
- Email addresses like
name@domain.com are linked automatically.
|
| Changed: |
<
< |
| >
> |
|
| Deleted: |
<
< |
|
| 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.
- GoodStyle is a WikiWord that links to the GoodStyle topic located in the current TWiki web.
- NotExistingYet? is a topic waiting to be written. You could create that topic by clicking on the question mark. (Do not create that topic; you would wreck this example!)
-
http://..., https://..., ftp://... and mailto:...@... are linked automatically.
- Email addresses like
name@domain.com are linked automatically.
|
|
|
| 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.
|
| 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: |
<
< |
| >
> |
|
| Changed: |
<
< |
| >
> |
|
| Changed: |
<
< |
| >
> |
|
| Changed: |
<
< |
Plugins offer additional text formatting rules and extend the functionality of TWiki. Currently enabled plugins are:
| >
> |
Plugins provide additional text formatting rules and can extend the functionality of TWiki into many other areas. Available Plugins are located in the Plugins web. Currently enabled plugins on this site are:
|
| 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 |
|
|
| 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.
|
| 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.
|
| Changed: |
<
< |
| >
> |
|
|
|
| Changed: |
<
< |
Three spaces, the term, a colon, followed by the definition.
| >
> |
Three spaces, the term, a colon, a space, followed by the definition.
|
|
|
| Added: |
>
> |
|
| Changed: |
<
< |
TWiki Plugins offer additional text formatting rules. Plugins currently installed are:
| >
> |
Plugins offer additional text formatting rules and extend the functionality of TWiki. Currently enabled plugins are:
|
| 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.
- CommentPlugin: Allows users to quickly edit a topic without going through the edit/preview/save cycle
- InterwikiPlugin: Link
ExternalSite:Page text to external sites based on aliases defined in the InterWikis topic.
- PollPlugin: A plugin to collect votes (Polls)
- SmiliesPlugin: Render smilies as icons, like
:-) for  or :cool: for 
- TablePlugin: Control attributes of tables and sorting of table columns
|
|
|
| Changed: |
<
< |
LINKS
| >
> |
|
| Changed: |
<
< |
The TWiki web has the following types of internal links:
| >
> |
|
| Changed: |
<
< |
| >
> |
|
| Changed: |
<
< |
EDITING
| >
> |
|
| Changed: |
<
< |
| >
> |
---++ Sushi
|
| Changed: |
<
< |
| >
> |
---+++ Maguro
|
| Changed: |
<
< |
| >
> |
Sushi
|
| Changed: |
<
< |
| >
> |
Maguro
|
| Changed: |
<
< |
HTML
| >
> |
Using HTML
|
| Changed: |
<
< |
| >
> |
|
| Changed: |
<
< |
WIKI VARIABLES
| >
> |
|
| Added: |
>
> |
-
%TOC% : The table of content, is based on headings in a topic.
|
| Added: |
>
> |
The formatting rules are fairly simple to use and fast to type. However, there are some things to watch out for:
- Q: Text enclosed in angle brackets like
<filename> is not displayed. How can I show it as it is?
- A: The
'<' and '>' characters have a special meaning in HTML, they define HTML tags. You need to escape them, so write '<' instead of '<', and '>' instead of '>'.
Example: Type 'prog <filename>' to get 'prog <filename>'.
- Q: Why is the
'&' character sometimes not displayed?
- A: The
'&' character has a special meaning in HTML, it starts a so called character entity, i.e. '©' is the © copyright character. You need to escape '&' to see it as it is, so write '&' instead of '&'.
Example: Type 'This & that' to get 'This & that'.
|
| Changed: |
<
< |
TWiki PLUGINS
| >
> |
|
|
|
| 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: |
<
< |
| A3 \ | >
> |
| L | C | R |
|---|
| A2 | 2 | 2 |
| A3 | 3 | 3 |
| multi span |
| A4 \ |
| Changed: |
<
< |
| A3 \
| >
> |
| L | C | R |
|---|
| A2 | 2 | 2 |
| A3 | 3 | 3 |
| multi span |
| A4 \ |
|
|
| Changed: |
<
< |
LINKS
| >
> |
LINKS
|
| Changed: |
<
< |
External links:
| >
> |
|
| Changed: |
<
< |
EDITING
| >
> |
EDITING
|
| Changed: |
<
< |
HTML
| >
> |
HTML
|
| Changed: |
<
< |
WIKI VARIABLES
| >
> |
WIKI VARIABLES
|
| Added: |
>
> |
TWiki PLUGINS
TWiki Plugins offer additional text formatting rules. Plugins currently installed are:
- DefaultPlugin: The default plugin is used for some depreciated rendering of older TWiki versions.
-
Learn more about plugins in TWikiPlugins and TWikiPreferences. |
|
|
| 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
|
|
|
|
|
| Changed: |
<
< |
At least four dashes at the beginning of a line.
| >
> |
At least three dashes at the beginning of a line.
|
| 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
|
| Changed: |
<
< |
You can define a link reference inside a TWiki topic (called an anchor name) and link to that. To define an anchor write @AnchorName at the beginning of a line. The anchor name must be a WikiWord. To link to an anchor name use the [[MyTopic@MyAnchor]] syntax. You can omit the topic name if you want to link within the same topic.
| >
> |
You can define a link reference inside a TWiki topic (called an anchor name) and link to that. To define an anchor write #AnchorName at the beginning of a line. The anchor name must be a WikiWord. To link to an anchor name use the [[MyTopic#MyAnchor]] syntax. You can omit the topic name if you want to link within the same topic.
|
| 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 |
|
|
| Changed: |
<
< |
WebNotify,
| >
> |
WebNotify
|
| Changed: |
<
< |
WebNotify,
| >
> |
WebNotify
|
| 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
|
| Changed: |
<
< |
wiki syntax,
| >
> |
wiki syntax
|
| 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 TWiki topic (called an anchor name) and link to that. To define an anchor write @AnchorName at the beginning of a line. The anchor name must be a WikiWord. To link to an anchor name use the [[MyTopic@MyAnchor]] syntax. You can omit the topic name if you want to link within the same topic.
|
[[WebHome@NotThere]]
[[Jump][@MyAnchor]]
@MyAnchor To here
|
WebHome@NotThere?
@MyAnchor?
@MyAnchor To here
|
|
| |
|
|
| 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.
|
| Added: |
>
> |
| A3 \ | next \
|
| Added: |
>
> |
|
| 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
|
|
|
|
| Changed: |
<
< |
- CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically. In case you want to link to a topic in a different TWiki web write
Web.TopicName, i.e. write Know.ReadmeFirst to link to ReadmeFirst? located in the Know web.
- You can create a forced internal link by enclosing words in double square brackets, i.e. write
[[text formatting FAQ]] to get text formatting FAQ that links to topic TextFormattingFAQ. Text within the brackets may contain optional spaces; the topic name is formed by capitalizing the initial letter and by removing the spaces. You can also refer to a different web, i.e. [[Main.TWiki users]] points to TWikiUsers in the Main web.
- Blank lines will create new paragraphs.
- Words get bold by enclosing them in * asterisks
- Words get italic by enclosing them in _ underscores
- Words get bold italic by enclosing them in __ double-underscores
- Words get shown in
fixed font by enclosing them in = equal signs
- Words get shown in
bold fixed font by enclosing them in == double equal signs
- Note for bold , italic , bold italic and
fixed font text:
- Make sure to "stick" the
* _ = signs to the characters, e.g.
- This works
- _This does not get italic because there is a space between the last word and the underline character _
- Example text to enter:
- Writing *bold text* , _italic text_ and =fixed== monospaced text
- Example text gets rendered as:
- Writing bold text , italic text and
fixed= monospaced text
- Separator: at least four dashes at the beginning of a line: <-------->
- List Item: 3 spaces and an asterisk: < *>
- Nested Item: 6 spaces and an asterisk: < *>
- Ordered List: 3 spaces and a number: < 1>
- Definition: 3 spaces, the term, a colon, followed by the definition: < term: definition>
Note that terms with spaces are not supported. In case you do have a term with more then one word, separate the words with dashes or with the non-breaking-space entity, i.e. write Character Set: to get Character Set:.
- Table: Optional spaces followed by the cells enclosed in vertical bars: < | cell 1 | cell 2 | cell 3 | ... |>
| >
> |
|
Formatting Command:
|
Example: You write:
|
You get:
|
Paragraphs:
Blank lines will create new paragraphs.
|
1st paragraph
2nd paragraph
|
1st paragraph
2nd paragraph
|
Bold Text:
Words get bold by enclosing them in * asterisks.
|
*Bold*
|
Bold
|
Italic Text:
Words get italic by enclosing them in _ underscores.
|
_Italic_
|
Italic
|
Bold Italic:
Words get _bold italic by enclosing them in _ double-underscores.
|
__Bold italic__
|
Bold italic
|
Fixed Font:
Words get shown in fixed font by enclosing them in = equal signs.
|
=Fixed font=
|
Fixed font
|
Bold Fixed Font:
Words get shown in bold fixed font by enclosing them in |
==Bold fixed==
|
Bold fixed
|
Note: Make sure to "stick" the * _ = == signs to the words, e.g. take away spaces.
|
_This works_,
_this not _
|
This works,
_this not _
|
Verbatim Mode:
Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags.
Note: Use <pre> and </pre> tags instead if you want that HTML code is interpreted.
Note: Each tag must be on a line by itself.
|
<verbatim>
class CatAnimal {
void purr() {
<code here>
}
}
</verbatim>
|
class CatAnimal {
void purr() {
<code here>
}
}
|
Separator:
At least four dashes at the beginning of a line.
|
-------
|
|
List Item:
Three spaces and an asterisk.
|
* bullet item
|
|
Nested List Item:
Six, nine, ... spaces and an asterisk.
|
* nested stuff
|
|
Ordered List:
Three spaces and a number.
|
1 Sushi
1 Dim Sum
|
- Sushi
- Dim Sum
|
Definition List:
Three spaces, the term, a colon, followed by the definition.
Note: Terms with spaces are not supported. In case you do have a term with more then one word, separate the words with dashes or with the non-breaking-space entity.
|
Sushi: Japan
Dim Sum: S.F.
|
- Sushi
- Japan
- Dim Sum
- S.F.
|
Table:
Optional spaces followed by the cells enclosed in vertical bars.
|
| A1 | B1 | C1 |
| A2 | B2 | C2 |
|
|
WikiWord Links:
CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically.
Note: In case you want to link to a topic in a different TWiki web write Webname.TopicName.
|
WebNotify,
Know.ReadmeFirst
|
WebNotify,
ReadmeFirst?
|
Forced Links:
You can create a forced internal link by enclosing words in double square brackets.
Note: Text within the brackets may contain optional spaces; the topic name is formed by capitalizing the initial letter and by removing the spaces; i.e. [[text formatting FAQ]] links to topic TextFormattingFAQ. You can also refer to a different web.
|
[[wiki syntax]],
[[Main.TWiki users]]
|
wiki syntax,
Main.TWiki users
|
Prevent a Link:
Prevent a WikiWord from being linked by prepending it with the <nop> tag.
|
<nop>SunOS
|
SunOS
|
Disable Links:
You can disable automatic linking of WikiWords by surround text with <noautolink> and </noautolink> tags.
Note: Each tag must be on a line by itself.
|
<noautolink>
RedHat &
SuSE
</noautolink>
|
RedHat &
SuSE
|
|
|
|
| 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
|
|
|
| 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 Set: to get Character Set:.
|
|
|
| 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.
|
| 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!)
|
|
|
| Changed: |
<
< |
The TWiki web has the following types of internal links:
| >
> |
The TWiki web has the following types of internal links:
|
| Changed: |
<
< |
-
http://..., https://..., ftp://... and mailto:...@... are linked automatically.
- Email addresses like
name@domainNOSPAM321.com are linked automatically.
| >
> |
-
http://..., https://..., ftp://... and mailto:...@... are linked automatically.
- Email addresses like
name@domain.com are linked automatically.
|
| 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.
|
| Changed: |
<
< |
-
%INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current TWiki web is the default web. Example: %INCLUDE{"TWiki.TWikiWebsTable"}%
| >
> |
-
%INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current TWiki web is the default web. Example: %INCLUDE{"TWiki.TWikiWebsTable"}%
|
|
|
| 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 TWiki web.
|
| 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.
|
| 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 TWiki web write
Web.TopicName, i.e. write Know.ReadmeFirst to link to ReadmeFirst? located in the Know web.
- You can create a forced internal link by enclosing words in double square brackets, i.e. write
[[text formatting FAQ]] to get text formatting FAQ that links to topic TextFormattingFAQ. Text within the brackets may contain optional spaces; the topic name is formed by capitalizing the initial letter and by removing the spaces. You can also refer to a different web, i.e. [[Main.TWiki users]] points to TWikiUsers in the Main web.
|
|
|
| Changed: |
<
< |
The TWiki web has the following types of internal links:
| >
> |
The TWiki web has the following types of internal links:
|
| 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: |
|
|
| Changed: |
<
< |
- CapitalizedWordsStickedTogether? will produce a link automatically.
| >
> |
- CapitalizedWordsStuckTogether will produce a link automatically.
|
| 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.
|
| 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.
|
| 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 TWiki web is the default web. Example: %INCLUDE{"TWiki.TWikiWebsTable"}%
|
|
|
| Changed: |
<
< |
Text strings expanded on the fly to display data or system info
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.
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.
TWiki expands the following variables (enclosed in % percent signs):
| Variable: | Expanded to: |
%WIKIHOMEURL% |
The base script URL of TWiki, is the link of the Home icon in the upper left corner, is http://www.intellij.org/twiki |
%SCRIPTURL% |
The script URL of TWiki, is http://www.intellij.org/twiki/bin |
%SCRIPTURLPATH% |
The path of the script URL of TWiki, is /twiki/bin |
%SCRIPTSUFFIX% |
The script suffix, ex: .pl, .cgi is |
%PUBURL% |
The public URL of TWiki, is http://www.intellij.org/twiki/pub |
%PUBURLPATH% |
The path of the public URL of TWiki, is /twiki/pub |
%ATTACHURL% |
The attachment URL of the current topic, is http://www.intellij.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 TWiki |
%WIKIVERSION% |
Wiki tool version is 01 Dec 2001 |
%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 TWiki 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 WebHome |
%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.WebHome]]"}% 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 Fri May 16 20:39:59 2008 |
%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
16 May, 2008 - 20:39:59 |
%SERVERTIME% |
Server time, is Sat May 17 00:39:59 2008 |
%SERVERTIME{"format"}% |
Formatted server time.
Example: %SERVERTIME{"$hou:$min"}% is 00:39 |
%HTTP_HOST% |
HTTP_HOST environment variable, is www.intellij.org |
%REMOTE_ADDR% |
REMOTE_ADDR environment variable, is 38.103.63.17 |
%REMOTE_PORT% |
REMOTE_PORT | | | |