TextFormattingRules < TWiki/

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 %WIKITOOLNAME% web has the following types of __internal links:__

	* GoodStyle is a WikiWord that links to the <nop>GoodStyle topic located in the current %WIKITOOLNAME% 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!)

__External links:__

	* =http://...=, =https://...=, =ftp://...= and =mailto:...@...= are linked automatically. 
	* Email addresses like =name@domain.com= are linked automatically.

*EDITING*

	* <NOP>CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically. In case you want to link to a topic in a different %WIKITOOLNAME% web write =Web.TopicName=, i.e. write =Know.ReadmeFirst= to link to Know.ReadmeFirst located in the Know web.
	* You can create a forced internal link by enclosing words in double square brackets, i.e. write =[<nop>[text formatting FAQ]]= to get [[text formatting FAQ]] that links to topic TextFormattingFAQ. Text within the brackets may contain optional spaces; the topic name is formed by capitalizing the initial letter and by removing the spaces. You can also refer to a different web, i.e. =[<nop>[%MAINWEB%.TWiki users]]= points to %MAINWEB%.TWikiUsers in the %MAINWEB% web. 
	* Blank lines will create new paragraphs. 
	* Words get *bold* by enclosing them in <b>*</b> asterisks
	* Words get _italic_ by enclosing them in <b>_</b> underscores
	* Words get __bold italic__ by enclosing them in <b>__</b> 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 <nop>*bold text* , <nop>_italic text_ and <nop>=fixed== monospaced text
		* Example text gets rendered as:
			* Writing *bold text* , _italic text_ and =fixed== monospaced text
	* Separator: at least four dashes at the beginning of a line: &lt;--------&gt;
	* List Item: 3 spaces and an asterisk: &lt;&nbsp;&nbsp;&nbsp;*&gt;
	* Nested Item: 6 spaces and an asterisk:  &lt;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;*&gt;
	* Ordered List: 3 spaces and a number: &lt;&nbsp;&nbsp;&nbsp;1&gt;
	* Definition:  3 spaces, the term, a colon, followed by the definition: &lt;&nbsp;&nbsp;&nbsp;term:&nbsp;definition&gt; <br>
	  Note that 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, i.e. write =Character&amp;nbsp;Set:= to get =Character&nbsp;Set:=.
	* Table: Optional spaces followed by the cells enclosed in vertical bars: &lt;&nbsp;&nbsp;&nbsp;|&nbsp;cell&nbsp;1&nbsp;|&nbsp;cell&nbsp;2&nbsp;|&nbsp;cell&nbsp;3&nbsp;|&nbsp;...&nbsp;|&gt;


*HTML*

Most HTML tags will work, but it's almost always preferable not to use HTML, so that the markup remains easy for everyone to edit.

	* 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 that are enclosed in percent signs; they get expanded on the fly.

	* =%<nop>WEB%= : The current web, is <b>%WEB%</b> .
	* =%<nop>TOPIC%= : The current topic name, is <b>%TOPIC%</b> .
	* =%<nop>ATTACHURL%= : The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as =<b>%<nop>ATTACHURL%/image.gif</b>= to show the URL of the file or the image in your text.
	* =%<nop>INCLUDE{"SomeTopic"}%= : Server side include, includes another topic. The current %WIKITOOLNAME% web is the default web. Example: =<b>%<nop>INCLUDE{"%TWIKIWEB%.TWikiWebsTable"}%</b>= </td>
	* There are many more variables, see TWikiVariables.
This topic: TWiki/ > TextFormattingRules
Topic revision: r10 - 12 Dec 2000 - 17:01:00 - PeterThoeny
Copyright � by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback