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 [[Main/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() { <code here> } } |
|||||||||||||||||||||
Separator: %BR% At least three dashes at the beginning of a line. | ------- |
|
|||||||||||||||||||||
List Item: %BR% Three spaces and an asterisk. | * bullet item |
|
|||||||||||||||||||||
Nested List Item: %BR% Six, nine, ... spaces and an asterisk. | * level 1 * level 2 |
|
|||||||||||||||||||||
Ordered List: %BR% Three spaces and a number. | 1 Sushi 1 Dim Sum |
|
|||||||||||||||||||||
Definition List: %BR% Three spaces, the term, a colon, a space, followed by the definition. %BR% 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. |
|
|||||||||||||||||||||
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.%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 | |
|
|||||||||||||||||||||
WikiWord Links: %BR% CapitalizedWordsStuckTogether (or [[Main/WikiWords]]) will produce a link automatically. %BR% Note: In case you want to link to a topic in a different %WIKITOOLNAME% web write Webname.TopicName . |
WebNotify Know.ReadmeFirst |
[[Main/WebNotify]] [[Know/ReadmeFirst]] |
|||||||||||||||||||||
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 [[Main/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, use <nop> between the leading left square brackets, that is, begin with [<nop>[.... |
[[wiki syntax]] [[Main.TWiki users]] |
[[Main/WikiSyntax]] [[Main/TWikiUsers]] |
|||||||||||||||||||||
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. [[Main/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 [[WebHome#MyAnchor][go home]] and [[http://gnu.org/#Action][GNU Action]] . |
[[WikiSyntax][syntax]] [[http://gnu.org][GNU]] [[http://xml.org XML]] |
[[Main/WikiSyntax]] | |||||||||||||||||||||
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 [[Main/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 |
[[Main/WikiWord#NotThere]] [[Main/WebHome#MyAnchor]] |
|||||||||||||||||||||
Prevent a Link: %BR% Prevent a [[Main/WikiWord]] from being linked by prepending it with the <nop> tag. |
<nop>SunOS |
SunOS | |||||||||||||||||||||
Disable Links: %BR% You can disable automatic linking of [[Main/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 [[Main/TablePlugin]]). |
<noautolink> RedHat & SuSE </noautolink> |
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]] |
**<...>**
- 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.
## Hyperlinks
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.
### Internal Links
- [[GoodStyle]] is a [[WikiWord]] that links to the GoodStyle topic located in the current %WIKITOOLNAME% web.
- [[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!)
### External Links
- `http://...`, `https://...`, `ftp://...`, `gopher://...`, `news://...`, `file://...`, `telnet://...` and `mailto:...@...` are linked automatically.
- Email addresses like `name@domain.com` are linked automatically.
- `[[Square bracket rules]]` let you easily create [[non-WikiWord links|Main/WebHome#SquareBrackets]].
- You can also write `[[http://yahoo.com Yahoo home page]]` as an easier way of doing external links with descriptive text for the link, such as [Yahoo home page](http://yahoo.com/).
## 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 **%WEB%**.
- `%TOPIC%` : The current topic name, is **%TOPIC%**.
- `%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 %WIKITOOLNAME% web is the default web. Example: **%INCLUDE\{"TWiki.SiteMap"\}%**
- `%SEARCH{"sushi"}%` : Inline search showing the search result embedded in a topic. [[FormattedSearch]] gives you control over formatting, used to create web-based applications.
- [[TWikiPreferences]] defines site-wide variables. Among others:
- **Line break:** Write %BR%
to start a new line.
- **Colored text:** Write: %RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors
to get: %RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors.
- **Documentation Graphics:** Write: %H% Help, %T% Tip, %X% Alert
to get: %H% Help, %T% Tip, %X% Alert. For more info see [[TWikiDocGraphics]].
- There are many more variables, see **[[TWikiVariables]]**.
- To "escape" a percent sign that would otherwise be interpreted as a variable, add ` %<nop>SOMEVARIABLE%
to get: %SOMEVARIABLE%.
## TWikiPlugin Formatting Extensions
Plugins provide additional text formatting capabilities and can extend the functionality of %WIKITOOLNAME% into many other areas. For example, the optional [SpreadSheetPlugin](http://twiki.org/cgi-bin/view/Plugins/SpreadSheetPlugin) lets you create a spreadsheet with the same basic notation used in TWiki tables.
Available Plugins are located in the [Plugins](http://twiki.org/cgi-bin/view/Plugins) web on TWiki.org. Currently enabled plugins on this TWiki installation, as listed by `%PLUGINDESCRIPTIONS%`:
- [[SpreadSheetPlugin]] (any TWiki, 10197):
- [[CommentPlugin]] (Dakar, 11359): Allows users to quickly post comments to a page without an edit/preview/save cycle
- [[EditTablePlugin]] (any TWiki, 11646):
- [[InterwikiPlugin]] (Dakar, $Rev: 11935$):
- [[PreferencesPlugin]] (Dakar, 9839):
- [[SlideShowPlugin]] (Any TWiki, $Rev: 12847$):
- [[SmiliesPlugin]] (Dakar, 8154):
- [[TablePlugin]] (1.020, 12339):
- [[TwistyPlugin]] (1.2.0, $Rev: 12154$):
Check on current Plugin status and settings for this site in [[TWikiPreferences]].
## 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 `