1
%META:TOPICINFO{author="ProjectContributor" date="1231502400" format="1.1" version="$Rev$"}%
6
_If you can enter text, you're ready for Foswiki. With a few simple rules, you'll be able to use plain text to create well-styled postings, instantly. What you are going to learn here is called <b>T</b>opic <b>M</b>arkup <b>L</b>anguage, or simply TML. So here comes a fast-track guide to shorthand basics:_
8
---++ General text formatting
10
* Separate each *paragraph* with a blank line.
12
* To display a *bold type* word or phrase, use asterisks: =*bold type*=.
14
* To display an _italic_ word or phrase, use underscores: =_italic_=.
16
* To display __bold with italics__ word or phrase, use _double_ underscores: =__bold italic__=.
18
* To display a word or phrase in =MONOSPACED TYPE=, use equal signs: =<nop>=like this==.
20
* Use =<nop>=<nop>=double equal signs=== for bold: ==bold mono==.
22
* To display colored text, enter:__ =%<nop>RED% red text %<nop>ENDCOLOR% and %<nop>GREEN% green text %<nop>ENDCOLOR%= to get %RED% red text %ENDCOLOR% and %GREEN% green text %ENDCOLOR%.
23
* =%<color>%= text must end with =%<nop>ENDCOLOR%=. If you want to switch from one color to another one you first need to end the active color with =%<nop>ENDCOLOR%=, e.g. write =%<nop>RED% some text %<nop>ENDCOLOR% %<nop>GREEN% more text %<nop>ENDCOLOR%=.
24
* DefaultPreferences defines some commonly used colors: *%YELLOW% %<nop>YELLOW%%ENDCOLOR%, %RED% %<nop>RED%%ENDCOLOR%, %PINK% %<nop>PINK%%ENDCOLOR%, %PURPLE% %<nop>PURPLE%%ENDCOLOR%, %TEAL% %<nop>TEAL%%ENDCOLOR%, %NAVY% %<nop>NAVY%%ENDCOLOR%, %BLUE% %<nop>BLUE%%ENDCOLOR%, %AQUA% %<nop>AQUA%%ENDCOLOR%, %LIME% %<nop>LIME%%ENDCOLOR%, %GREEN% %<nop>GREEN%%ENDCOLOR%, %OLIVE% %<nop>OLIVE%%ENDCOLOR%, %MAROON% %<nop>MAROON%%ENDCOLOR%, %BLACK% %<nop>BLACK%%ENDCOLOR%, %GRAY% %<nop>GRAY%%ENDCOLOR%, %SILVER% %<nop>SILVER%%ENDCOLOR%* and *%<nop>ENDCOLOR%*.
26
* To display headings, type (from the beginning of a line) three dashes (-), from one to six plus signs (+), a space, and your heading text.
27
* The quantity of plus signs is related to the size of the heading - the more plus signs you use, the smaller the heading.
28
* You can insert a nested table of contents, generated from headings, by placing =%<nop>TOC%= wherever you like on a page (see [[%SYSTEMWEB%.Macros]] for more =%<nop>TOC%= options).
30
* Use ==<verbatim>== to enclose code excerpts, filenames, and other unformatted text:%BR%
31
=<b><verbatim></b>= %BR%
32
=unformatted text!= %BR%
33
=and more of it!= %BR%
34
=<b></verbatim></b>=
36
---+++ Macros and special characters (advanced)
37
* <nop>%MACROS% can be set inside verbatim tags - they are not disabled. For more detailed information, see [[Macros]].
39
* If you want to display angle brackets, enter them as HTML codes instead of typing them in directly:
40
* =&lt;= = =<= %BR%
42
* __You enter:__ =(a &gt; 0)= %BR%
43
__Result:__ =(a > 0)=
45
* Sometimes you will not see the =&= charachter and you need to excape it to see it as it is. The reason behind is that =&= has a special meaning in HTML - it starts so called character entities, like ='&copy;'= which is the =©= copyright character.
46
* Type ='This &amp; that'= to get ='This & that'=.
48
---++ Internal and external links
50
* To link to another Wiki topic in the same web, type the WikiWord of that topic: =<nop>%HOMETOPIC%=.
52
* To link to a Wiki topic in a different web, type the name of the web, and a dot, first: =Sandbox.<nop>%HOMETOPIC%=.
54
* A Wiki topic that doesn't exist will appear highlighted, with question mark at the end, prompting you (or someone else) to start that topic by clicking the *?*: ExampleOfANewTopic (click the *?*, but don't save, to preserve the example!).
56
* To create an external link, type the full URL: =http://foswiki.org/=.
58
* To prevent a <nop>WikiWord from becoming a link, place =<nop>= or an exclamation mark (=!=) in front of the <nop>WikiWord: ==<nop>NoLinkPlease== or ==!NoLinkPlease==.
60
* To escape the exclamation mark escape, try prefixing a =<nop>=, e.g. write =A <nop>!=<nop> B= to get "A <nop>!= B". Alternatively, use the HTML entity =&#33;=, which renders as an exclamation mark, e.g. write =A &#33;=<nop> B= to get "A != B".
62
---++ Bullet and numbered lists
64
* To indent with a bullet, enter =[space][space][space][asterisk][space]=.
65
* Use multiples of 3 spaces to *nest bullets*.
66
* That's 3-6-9 spaces...
68
* To create a numbered list:
69
1 Start items in a *numbered list* with =[space][space][space][1][space]=.
70
1 The "1" (or *any number*) will be replaced by a correct numbering order.
71
1 To add a new paragraph without restarting list numbering, use the %<nop>BR% variable, like this:%BR% Text added (in a new paragraph)
72
1 and the numbered list continues.
74
Always start *counting* spaces for bullets or numbers from the beginning of a new line.
78
* To display an image in a topic, [[FileAttachment][attach it]] and type in edit mode: <br /> =%<nop>ATTACHURL%/yourimagefilename.jpg=
80
* Three (or more) consecutive *hyphens* will create a horizontal rule:%BR% =---=
82
Follow GoodStyle recommendations when editing topics. In general, it is always nice to add one's signature at the end of a topic or comments. To add your signature, type =%USERSWEB%.YourName=, it will then expand to %USERNAME%.
84
See EditingShorthand for the complete set of formatting rules.
87
__Related Topics:__ WikiWords, [[Macros]], EditingShorthand, FileAttachment