| Formatting Command: | Example: You write: | You get: | |||||||||||||||
|
Paragraphs: Blank lines will create new paragraphs. |
1st paragraph 2nd paragraph | 1st paragraph 2nd paragraph | |||||||||||||||
|
Headings: At least three dashes at the beginning of a line, followed by plus signs, a space, then the heading text. One + creates a level 1 - H1 - heading (largest), ++ creates level 2, etc, to the maximum level 6. %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 |
SushiMaguro |
|||||||||||||||
|
Bold Text: Words get bold by enclosing them in * asterisks.
|
*Bold* | Bold | |||||||||||||||
|
Italic Text: Words get italicized by enclosing them in underscores: _.
|
_Italic_ | Italic | |||||||||||||||
|
Bold Italic: For bold italics, enclose words in double-underscores: __.
|
__Bold italic__ | Bold italic | |||||||||||||||
|
Fixed Font: Words appear as fixed font by enclosing them in equal signs: =.
|
=Fixed font= |
Fixed font
|
|||||||||||||||
|
Bold Fixed Font: For bold fixed font, enclose words in double equal signs: ==.
|
==Bold fixed== |
Bold fixed
|
|||||||||||||||
* _ = == signs to the words removing spaces.
|
_This works_, _this doesn't _ | This works, _this doesn't _ | |||||||||||||||
|
Verbatim Mode: Surround code excerpts and other formatted text with <verbatim> </verbatim> tags. <pre> </pre> tags instead if you want HTML code to be interpreted. |
<verbatim>
class CatAnimal {
void purr() {
<code here>
}
}
</verbatim>
|
class CatAnimal {
void purr() {
<code here>
}
}
|
|||||||||||||||
|
Separator: At least three dashes at the beginning of a line. |
------- |
|
|||||||||||||||
|
List Item: Three spaces and an asterisk: *. (Adding a space after looks best.) |
* bullet item |
|
|||||||||||||||
|
Nested List Item: Six, nine, ... spaces and an asterisk. |
* first level bullet
* nested stuff
|
|
|||||||||||||||
|
Ordered List: Three spaces, a number, a (recommended) space. |
1 Sushi 1 Dim Sum |
|
|||||||||||||||
|
Definition List: Three spaces, the term, a colon, a space, followed by the definition. .
|
Sushi: Japan Dim Sum: S.F. |
|
|||||||||||||||
|
Table: Optional spaces followed by the cells enclosed in vertical bars. | *bold* | cells are rendered as table headers. | spaced | cells are rendered center aligned. | spaced | cells are rendered right aligned. | 2 colspan || cells are rendered as multi-span columns. '\'. |
| *L* | *C* | *R* | | A2 | 2 | 2 | | A3 | 3 | 3 | | multi span ||| | A4 \ | next \ | next | |
|
|||||||||||||||
|
WikiWord Links: CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically. Webname.TopicName.
|
WebNotify Know.ReadmeFirst | Mail notification ReadmeFirst? | |||||||||||||||
|
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; ex: [[text formatting FAQ]] links to topic TextFormattingFAQ. You can also refer to a different web and use anchors.
|
[[wiki syntax]] [[Main.TWiki users]] | wiki syntax? Main.TWiki users | |||||||||||||||
|
Specific Links: Create a link where you can specify the link text and the link reference separately, using nested square brackets: [[reference][text]]. Internal link references (ex: WikiSyntax) and external link references (ex: http://TWiki.org/) are supported. The same Forced Links rules apply for internal link references. Anchor names can be added as well, like [[Home_#MyAnchor][go home]] and [[http://www.yahoo.com/#somewhere][Yahoo!]].
|
[[WikiSyntax][syntax]] [[http://gnu.org][GNU]] |
syntax
GNU |
|||||||||||||||
|
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]] [[#MyAnchor][Jump]] #MyAnchor To here | Home #NotThere Jump To here | |||||||||||||||
|
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 surrounding text with <noautolink> and </noautolink> tags. Note: Each tag must be on a line by itself. Note: This also works for TWiki tables, but only if you add a blank line between the end of the table and the closing </noautolink> tag (known issue of the TablePlugin).
|
<noautolink> RedHat & SuSE </noautolink> |
|
|||||||||||||||
?. (Try clicking this one, but then, Cancel or go Back - creating the topic would wreck this example!)
http://..., https://..., ftp://... and mailto:...@... are linked automatically.
name@domain.com are linked automatically.
[[Square bracket rules]] let you easily create non-WikiWord links.
% that are expanded on the fly. Using the existing variables, and creating your own, adds an amazing extra level of content to your posts. For example:
%TOC% : Automatically generates a table of contents based on headings in a topic - see the top of this page for an example.
%WEB% : Displays the name of the current web: TWiki.
%TOPIC% : The current topic name, is TWikiShorthand.
%ATTACHURL% : The attachment URL for the current topic. Ex: 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, displays the contents of another topic. The current TWiki web is the default. Example: %INCLUDE{"TWiki.SiteMap"}%
<filename> is not displayed. How can I show it as it is?
'<' and '>' characters have a special meaning in HTML, they define HTML tags. You need to escape them, so write '<' instead of '<', and '>' instead of '>'. 'prog <filename>' to get 'prog <filename>'.
'&' character sometimes not displayed?
'&' 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 '&'. 'This & that' to get 'This & that'.
| Topic TWikiShorthand . { Edit | Attach | Ref-By | Printable | Diffs | r1.8 | > | r1.7 | > | r1.6 | More } |
| Revision r1.8 - 27 Jan 2003 - 21:59 GMT - ArthurClemens | Copyright © 2003 by the contributing authors. All material on this collaboration tool is the property of the contributing authors. Ideas, requests, problems regarding TWiki? Send feedback |