Links
http://www.cs.uu.nl/wiki/TWiki/TextFormattingRules
http://twiki.org/cgi-bin/view/TWiki01/TextFormattingRules
EditTablePlugin (5.1, $Rev: 18808 (2010-05-29) $): Edit TWiki tables using edit fields, date pickers and drop down boxes
TwistyPlugin (1.6, $Rev: 18716 (2010-05-29) $): Twisty section JavaScript library to open/close content dynamically
| Formatting Command: | You write: | You get: | |||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Paragraphs: Blank lines will create new paragraphs. |
1st paragraph 2nd paragraph |
1st paragraph
2nd paragraph |
|||||||||||||||||||||||||
| Headings: Three or more dashes at the beginning of a line, followed by plus signs and the heading text. One plus creates a top level heading, two pluses a second level heading, etc. The maximum heading depth is 6. You can create a table of contents with the %TOC%
variable. If you want to exclude a heading from the
TOC, put • Empty headings are allowed, but won't appear in the table of contents. |
---++ Sushi ---+++ Maguro ---+++!! Not in TOC |
SushiMaguroNot in TOC |
|||||||||||||||||||||||||
| Bold Text: Words get shown in bold by enclosing them in *
asterisks. |
*Bold* |
Bold | |||||||||||||||||||||||||
| Italic Text: Words get shown in italic by enclosing them in _
underscores. |
_Italic_ |
Italic | |||||||||||||||||||||||||
| Bold Italic: Words get shown in bold italic by enclosing them in __ double-underscores. |
__Bold italic__ |
Bold italic | |||||||||||||||||||||||||
| Fixed Font: Words get shown in fixed font by enclosing them in =
equal signs. |
=Fixed font= |
Fixed font
|
|||||||||||||||||||||||||
| Bold Fixed Font: Words get shown in bold fixed font by enclosing them
in double equal signs. |
==Bold fixed== |
Bold fixed |
|||||||||||||||||||||||||
You can follow the closing bold, italic, or other (* _ __
= ==) indicator with normal punctuation, such as commas and full
stops. Make sure there is no space between the text and the
indicators. |
_This works_, _this does not _ |
This works, _this does not _ |
|||||||||||||||||||||||||
| Verbatim (Literal) Text: Surround code excerpts and other formatted text with <verbatim>
and </verbatim> tags.verbatim tags disable HTML code. Use <pre>
and </pre> tags instead if you want the HTML code
within the tags to be interpreted.NOTE: Preferences variables (* Set NAME = value) are set within verbatim tags. |
<verbatim>
class CatAnimal {
void purr() {
<code here>
}
}
</verbatim>
|
class CatAnimal {
void purr() {
<code here>
}
}
|
|||||||||||||||||||||||||
| Separator (Horizontal Rule): Three or more three dashes at the beginning of a line.. |
------- |
|
|||||||||||||||||||||||||
| Bulleted List: Multiple of three spaces, an asterisk, and another space. For all the list types, you can break a list item over several lines by indenting lines after the first one by at least 3 spaces. |
* level 1
* level 2
* back on 1
* A bullet
broken over
three lines
* last bullet
|
|
|||||||||||||||||||||||||
| Numbered List: Multiple of three spaces, a type character, a dot, and another space. Several types are available besides a number:
|
1. Sushi 1. Dim Sum 1. Fondue A. Sushi A. Dim Sum A. Fondue i. Sushi i. Dim Sum i. Fondue |
|
|||||||||||||||||||||||||
| Definition List: Three spaces, a dollar sign, the term, a colon, a space, followed by the definition. |
$ Sushi: Japan $ Dim Sum: S.F. |
|
|||||||||||||||||||||||||
| Table: Each row of the table is a line containing of one or more cells. Each cell starts and ends with a vertical bar '|'. Any spaces at the beginning of a line are ignored.
|^| multiple-span row functionality and
additional rendering features |
| *L* | *C* | *R* | | A2 | B2 | C2 | | A3 | B3 | C3 | | multi span ||| | A5-7 | 5 | 5 | |^| six | six | |^| seven | seven | | split\ | over\ | 3 lines | | A9 | B9 | C9 | |
|
|||||||||||||||||||||||||
| Table: [from http://twiki.org/cgi-bin/view/TWiki01/TextFormattingRules] Optional spaces followed by the cells enclosed in vertical bars. Note: | *bold* | cells are
rendered as table headers.Note: | spaced |
cells are rendered center aligned.Note: | spaced |
cells are rendered right aligned.Note: | 2 colspan || cells are
rendered as multi-span columns.Note: In case you have a long row and you want it to be more readable when you edit the table you can split the row into lines that end with a '\' backslash character. |
|||||||||||||||||||||||||||
| WikiWord Links: CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically if preceded by whitespace or parenthesis. If you want to link to a topic in a different web write Otherweb.TopicName.The link label excludes the name of the web, e.g. only the topic name is shown. As an exception, the name of the web is shown for the WebHome topic. It's generally a good idea to use the TWikiVariables %TWIKIWEB% and %MAINWEB% instead of TWiki and Main. |
WebStatistics Sandbox.WebNotify Sandbox.WebHome |
WebStatistics | |||||||||||||||||||||||||
| Anchors: You can define a reference inside a TWiki topic (called an anchor name) and link to that. To define an anchor write #AnchorName
at the beginning of a line. The anchor name must be a WikiWord.
To link to an anchor name use the [[MyTopic#MyAnchor]]
syntax. You can omit the topic name if you want to link within the same
topic. |
[[WikiWord#NotThere]] [[#MyAnchor][Jump]] #MyAnchor To here |
WikiWord#NotThere | |||||||||||||||||||||||||
| Forced Links: You can create a forced internal link by enclosing words in double square brackets. Text within the brackets may contain optional spaces; the topic name is formed by capitalizing the initial letter and by removing the spaces; for example, [[text formatting FAQ]] links to topic TextFormattingFAQ.
You can also refer to a different web and use anchors.To "escape" double square brackets that would otherwise make a link, prefix the leading left square bracket with an exclamation point. |
[[wiki syntax]] [[Main.TWiki users]] escaped: ![[wiki syntax]] |
wiki
syntax
escaped: [[wiki syntax]] |
|||||||||||||||||||||||||
| Specific Links: You can create a link where you specify the link text and the URL separately using nested square brackets [[reference][text]].
Internal link references (e.g. WikiSyntax)
and URLs (e.g. http://TWiki.org/)
are both supported. The rules described under Forced Links
apply for internal link references.Anchor names can be added as well, to create a link to a specific place in a topic. |
[[WikiSyntax][wiki syntax]] [[http://gnu.org][GNU]] |
wiki syntax | |||||||||||||||||||||||||
| Prevent a Link: Prevent a WikiWord from being linked by prepending it with an exclamation point. |
!SunOS |
SunOS | |||||||||||||||||||||||||
| Disable Links: You can disable automatic linking of WikiWords by surrounding text with <noautolink> and </noautolink>
tags.It is possible to turn off all auto-linking with a NOAUTOLINK preferences setting. |
<noautolink> RedHat & SuSE </noautolink> |
RedHat & SuSE | |||||||||||||||||||||||||
| Mailto Links: E-mail addresses are linked automatically. To create e-mail links that have more descriptive link text, specify subject lines or message bodies, or omit the e-mail address, you can write [[mailto:user@domain][descriptive
text]]. |
a@b.com [[mailto:a@b.com]\ [Mail]] [[mailto:?subject=\ Hi][Hi]] |
a@b.com | |||||||||||||||||||||||||
Colored TextTWikiPreferences defines some commonly used colors: %YELLOW%, %RED%, %PINK%, %PURPLE%, %TEAL%, %NAVY%, %BLUE%, %AQUA%, %LIME%, %GREEN%, %OLIVE%, %MAROON%, %BLACK%, %GRAY%, %SILVER% and %ENDCOLOR%.
%<color>% text must end with %ENDCOLOR% . If you want to switch from one color to another one you first need to end the active color with %ENDCOLOR%, e.g. write %RED% some text %ENDCOLOR% %GREEN% more text %ENDCOLOR%.
If you need more colors you can use HTML, like <font color="#ff0000"> red text </font>. You can also use the up-to-date style attribute - ex: style="color:#ff0000" - placed in most HTML tags. span is an all-purpose choice: <span style="color:#ff0000">CoLoR</span>. Only old (like 3.x IE & NS) browsers have a problem with style.
The code is the hexadecimal RGB color code, which is simply Red, Green and Blue values in hex notation (base 16, 0-F). For pure red, the RGB components are 255-0-0 - full red (255), no green or blue. That's FF-0-0 in hex, or "#ff0000" for Web page purposes. StandardColors lists basic colors. |
|||||||||||||||||||||||||||
| TWISTY control | %TWISTY{ mode="div" showlink="View your stuff" hidelink="Hide your stuff" showimgleft="%ICONURLPATH{toggleopen-small}%" hideimgleft="%ICONURLPATH{toggleclose-small}%" }% Put your stuff here %ENDTWISTY% |
%TWISTY{ mode="div" showlink="View image file" hidelink="Hide image file" showimgleft="%ICONURLPATH{toggleopen-small}%" hideimgleft="%ICONURLPATH{toggleclose-small}%" }% <img src="%ATTACHURLPATH%/imagefile.jpg" alt="imagefile.jpg" width='1263' height='632' /> %ENDTWISTY% |
|||||||||||||||||||||||||