|
*Formatting Command:*
|
*Example: You write:*
|
*You get:*
|
|
*Paragraphs:* %BR%
Blank lines will create new paragraphs.
|
1st paragraph
2nd paragraph
|
1st paragraph
2nd paragraph
|
|
*Headings:* %BR%
At least three dashes at the beginning of a line, followed by plus signs and the heading text. One plus creates a level 1 heading (most important), two pluses a level 2 heading; the maximum is level 6. __Note:__ A Table of Content can be created automatically with the =%TOC%= variable, see TWikiVariables. Any heading text after =!!= is excluded from the TOC; for example, write =---+!! text= if you do not want to list a header in the TOC.
|
---++ Sushi
---+++ Maguro
|
Sushi
Maguro
|
|
*Bold Text:* %BR%
Words get *bold* by enclosing them in =*= asterisks.
|
*Bold*
|
*Bold*
|
|
*Italic Text:* %BR%
Words get _italic_ by enclosing them in =_= underscores.
|
_Italic_
|
_Italic_
|
|
*Bold Italic:* %BR%
Words get __bold italic_ by enclosing them in =_= double-underscores.
|
__Bold italic__
|
__Bold italic__
|
|
*Fixed Font:* %BR%
Words get shown in =fixed font= by enclosing them in === equal signs.
|
=Fixed font=
|
=Fixed font=
|
|
*Bold Fixed Font:* %BR%
Words get shown in ==bold fixed font== by enclosing them in ==== double equal signs.
|
==Bold fixed==
|
==Bold fixed==
|
|
__Note:__ Make sure there is no space between the text and the bold, italic, or other indicators (=* _ __ = ===).
|
_This works_,
_this not _
|
_This works_,%BR%
_this not _
|
|
*Verbatim Mode:* %BR%
Surround code excerpts and other formatted text with =<verbatim>= and =</verbatim>= tags. %BR% __Note:__ Use =<pre>= and =</pre>= tags instead if you want that HTML code is interpreted. %BR% __Note:__ Each tag must be on a line by itself.
|
<verbatim>
class CatAnimal {
void purr() {
<code here>
}
}
</verbatim>
|
class CatAnimal {
void purr() {
}
}
|
|
*Separator:* %BR%
At least three dashes at the beginning of a line.
|
-------
|
-------
|
|
*List Item:* %BR%
Three spaces, an asterisk, and another space.
|
* bullet item
|
* bullet item
|
|
*Nested List Item:* %BR%
Six, nine, ... spaces, an asterisk, and another space.
|
* level 1
* level 2
|
* level 1
* level 2
|
|
*Ordered List:* %BR%
Three spaces, a number, a dot, and another space. Several types are available besides a number:
| *Type* | *Generated Style* | *Sample Sequence* |
| 1. | Arabic numerals | 1, 2, 3, 4... |
| A. | Uppercase letters | A, B, C, D... |
| a. | Lowercase letters | a, b, c, d... |
| I. | Uppercase Roman Numerals | I, II, III, IV... |
| i. | Lowercase Roman Numerals | i, ii, iii, iv... |
|
1. Sushi
1. Dim Sum
A. Sushi
A. Dim Sum
i. Sushi
i. Dim Sum
|
1. Sushi
1. Dim Sum
A. Sushi
A. Dim Sum
i. Sushi
i. Dim Sum
|
|
*Definition List:* %BR%
Three spaces, a dollar sign, the term, a colon, a space, followed by the definition.
|
$ Sushi: Japan
$ Dim Sum: S.F.
|
$ Sushi: Japan
$ Dim Sum: S.F.
|
|
*Table:* %BR%
Any number of lines of text. Each line is one row of the table consisting of one or more cells. Each cell starts and ends with a vertical bar '|'. Any spaces at the beginning of a line are ignored.%BR%
__Notes:__ %BB%
=| *bold* |= cells are displayed as table headers.%BB%
=| center-spaced |= cells are displayed center aligned.%BB%
=| right-spaced |= cells are displayed right aligned.%BB%
=| 2 colspan ||= cells are displayed as multi-span columns (i.e., a cell with no text spans a column).%BB%
=|^|= cells with a caret indicate follow-up rows of multi-span rows (this functionality is provided by TablePlugin).%BB%
If a row contains a large amount of text, and you want it to be more readable while editing the table, split the row into multiple text lines by ending each line with a backslash character ='\'=.%BB%
Table cells wrap automatically as determined by the browser.
|
| *L* | *C* | *R* |
| A2 | 2 | 2 |
| A3 | 3 | 3 |
| multi span |||
| A4-6 | four | four |
|^| five | five |
|^| six | six |
|
| *L* | *C* | *R* |
| A2 | 2 | 2 |
| A3 | 3 | 3 |
| multi span |||
| A4-6 | four | four |
|^| five | five |
|^| six | six |
|
|
*WikiWord Links:* %BR%
CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically. %BR% __Note:__ In case you want to link to a topic in a different %WIKITOOLNAME% web write =Otherweb.TopicName=. (The link label is the the name of the web in case the is %HOMETOPIC%, else it is the topic name)
|
WebNotify
%MAINWEB%.TWikiUsers
|
WebNotify
%MAINWEB%.TWikiUsers
|
|
#SquareBrackets
*Forced Links:* %BR%
You can create a forced internal link by enclosing words in double square brackets.
%BR% __Note:__ Text within the brackets may contain optional spaces; the topic name is formed by capitalizing the initial letter and by removing the spaces; for example, =[[text formatting FAQ]]= links to topic TextFormattingFAQ. You can also refer to a different web and use anchors.
%BR% __Note:__ To "escape" double square brackets that would otherwise be a correct link, prefix the leading left square brackets with an exclamation point, that is, begin with =![[....=
|
[[wiki syntax]]
[[%MAINWEB%.TWiki users]]
escaped:
![[wiki syntax]]
|
[[wiki syntax]]
[[%MAINWEB%.TWiki users]]
escaped:
![[wiki syntax]]
|
|
*Specific Links:* %BR%
Create a link where you can specify the link text and the link reference separately, using nested square brackets like =[[reference][text]]=. Internal link references (e.g. WikiSyntax) and external link references (e.g. http://TWiki.org/) are supported.
%BR% __Note:__ The same __Forced Links__ rules apply for internal link references.
%BR% __Note:__ For external link references, you can simply use a space instead of =][= to separate the link URL from the descriptive text.
%BR% __Note:__ Anchor names can be added as well, like =[[%HOMETOPIC%#MyAnchor][go home]]= and =[[http://gnu.org/#Action][GNU Action]]=.
|
[[WikiSyntax][syntax]]
[[http://gnu.org][GNU]]
[[http://xml.org XML]]
|
[[WikiSyntax][syntax]]
[[http://gnu.org][GNU]]
[[http://xml.org XML]]
|
|
*Anchors:* %BR%
You can define a link reference inside a %WIKITOOLNAME% topic (called an anchor name) and link to that. To __define__ an anchor write =#AnchorName= at the beginning of a line. The anchor name must be a WikiWord. To __link to__ an anchor name use the =[[MyTopic#MyAnchor]]= syntax. You can omit the topic name if you want to link within the same topic.
|
[[WikiWord#NotThere]]
[[#MyAnchor][Jump]]
#MyAnchor To here
|
[[WikiWord#NotThere]]
[[#MyAnchor][Jump]]
#MyAnchor To here
|
|
*Prevent a Link:* %BR%
Prevent a WikiWord from being linked by prepending it with an exclamation point.
|
!SunOS
|
!SunOS
|
|
*Disable Links:* %BR%
You can disable automatic linking of WikiWords by surrounding text with =<noautolink>= and =</noautolink>= tags.
%BR% __Note:__ Each tag must be on a line by itself.
%BR% __Note:__ This also works for TWiki tables, but only if you add a blank line between the end of the table and the closing =</noautolink>= tag (known issue of the TablePlugin).
|
RedHat &
SuSE
|
RedHat &
SuSE
|
|
*Mailto: Links:* %BR%
To create 'mailto:' links that have more descriptive link text, specify subject lines or message bodies, or omit the email address, you can write =[[mailto:user@domain descriptive text]]=.
|
[[mailto:a@z.com Mail]]
[[mailto:?subject=Hi Hi]]
|
[[mailto:a@z.com Mail]]
[[mailto:?subject=Hi Hi]]
|
---++ Using HTML
You can use just about any HTML tag without a problem - however, there are a few usability and technical considerations to keep in mind.
---+++ HTML and TWiki Usability
* %T% *TIP:* On collaboration pages, it's preferable NOT to use HTML, and to use [[#TWikiShorthand][TWiki shorthand]] instead - this keeps the text uncluttered and easy to edit.
* %X% *NOTE:* TWiki is designed to work with a wide range of browsers and computer platforms, holding to HTML 4.0 and XHTML 1.0 compatibility in the standard installation - adding raw HTML, particularly browser-specific tags (or any other mark-up that doesn't degrade well) will reduce compatibility.
* Recommondations when using HTML:
* Use [[http://www.w3.org/TR/xhtml1/][XHTML 1.0 Transitional]] syntax
* Do not span a tag over more then one line
* Remove all empty lines. TWiki inserts =<p />= paragraph tags on empty lines, which causes problems if done between tags that do not allow paragraph tags, like for example between table tags.
---+++ TWiki HTML Rendering
* 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.
* %T% 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."
* %X% *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==
* %T% If you're pasting in preformatted HTML text and notice problems, check the file in a text processor with no text wrap. Also, save without hard line breaks on text wrap, in your HTML editing program.
---+++ TWiki and JavaScript
You can use JavaScript for your TWiki applications. Since TWiki rendering might interfere with JavaScript code you need to escape it with HTML comments and =<pre>= tags: