TWiki/TextFormattingRules.mdwn


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55

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.

**LINKS**

The Collaborative Work Area is a bunch of related links that are editable through your web browser.

The TWiki web has the following types of internal links:

* [[GoodStyle]] is a topic that is part of 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!)
* [[Know/ReadmeFirst]] is a topic in a different TWiki web. (You write it as _Web.TopicName_ , but it will show up as _TopicName_ )

External links:

* `http://...`, `https://...`, `ftp://...` and `mailto:...@...` are linked automatically.
* Email addresses like <code> <name@domainNOSPAM.com> </code> are linked automatically.

**EDITING**

* [[CapitalizedWordsStickedTogether]] will produce a link automatically.
* 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
* 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 the beginning of a line)
* List Item: &lt;3spaces&gt;\*
* Nested Item: &lt;6spaces&gt;\*
* Ordered List: &lt;3spaces&gt;&lt;number&gt;.
* Definition: &lt;3spaces&gt;&lt;term&gt;:&lt;definition&gt;.
* Table: &lt;optional spaces&gt;| cell 1 | cell 2 | cell 3 | ... |

**EXTRAS**

* Most HTML tags will work.
  * Overview of all HTML elements at <http://www.htmlhelp.com/reference/wilbur/overview.html>
  * HTML 3.2 Reference Specification at <http://www.w3.org/TR/REC-html32.html>

**WIKI VARIABLES**

Variables are names enclosed in percent signs that gets expanded on the fly.

* <code>%WEB%</code> : The current web, is **%WEB%** .
* <code>%TOPIC%</code> : The current topic name, is **%TOPIC%** .
* <code>%ATTACHURL%</code> : The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as <code>**%ATTACHURL%/image.gif**</code> to show the URL of the file or the image in your text.
* <code>%INCLUDE\{"file.ext"\}%</code> : Server side include, includes the text of a file. The default directory is the current Wiki web. Example: <code>**%INCLUDE\{"Know/TopicName.txt"\}%**</code>
* There are many more variables, see [[TWikiVariables]].