head	1.55;
access;
symbols;
locks; strict;
comment	@# @;


1.55
date	2012.11.15.19.12.06;	author TWikiContributor;	state Exp;
branches;
next	1.54;

1.54
date	2011.06.05.00.55.39;	author TWikiContributor;	state Exp;
branches;
next	1.53;

1.53
date	2010.11.11.23.00.36;	author TWikiContributor;	state Exp;
branches;
next	1.52;

1.52
date	2010.06.12.03.28.33;	author TWikiContributor;	state Exp;
branches;
next	1.51;

1.51
date	2010.05.29.14.44.20;	author TWikiContributor;	state Exp;
branches;
next	1.50;

1.50
date	2008.01.22.03.21.27;	author TWikiContributor;	state Exp;
branches;
next	1.49;

1.49
date	2006.04.01.05.55.17;	author TWikiContributor;	state Exp;
branches;
next	1.48;

1.48
date	2006.02.01.12.01.20;	author TWikiContributor;	state Exp;
branches;
next	1.47;

1.47
date	2004.08.01.10.51.40;	author PeterThoeny;	state Exp;
branches;
next	1.46;

1.46
date	2004.07.24.08.21.33;	author PeterThoeny;	state Exp;
branches;
next	1.45;

1.45
date	2004.07.11.07.46.26;	author PeterThoeny;	state Exp;
branches;
next	1.44;

1.44
date	2004.04.25.06.29.37;	author PeterThoeny;	state Exp;
branches;
next	1.43;

1.43
date	2004.03.30.05.39.47;	author PeterThoeny;	state Exp;
branches;
next	1.42;

1.42
date	2004.03.17.07.03.50;	author PeterThoeny;	state Exp;
branches;
next	1.41;

1.41
date	2003.12.16.08.41.03;	author PeterThoeny;	state Exp;
branches;
next	1.40;

1.40
date	2003.08.01.05.12.16;	author PeterThoeny;	state Exp;
branches;
next	1.39;

1.39
date	2003.07.26.21.37.04;	author PeterThoeny;	state Exp;
branches;
next	1.38;

1.38
date	2003.07.16.23.57.00;	author PeterThoeny;	state Exp;
branches;
next	1.37;

1.37
date	2003.02.01.20.47.48;	author PeterThoeny;	state Exp;
branches;
next	1.36;

1.36
date	2003.02.01.11.12.00;	author PeterThoeny;	state Exp;
branches;
next	1.35;

1.35
date	2002.10.03.01.40.05;	author PeterThoeny;	state Exp;
branches;
next	1.34;

1.34
date	2002.06.05.01.27.00;	author PeterThoeny;	state Exp;
branches;
next	1.33;

1.33
date	2002.05.02.21.41.50;	author PeterThoeny;	state Exp;
branches;
next	1.32;

1.32
date	2002.04.05.13.36.49;	author RichardDonkin;	state Exp;
branches;
next	1.31;

1.31
date	2002.03.26.08.26.34;	author RichardDonkin;	state Exp;
branches;
next	1.30;

1.30
date	2001.12.03.04.11.51;	author MikeMannix;	state Exp;
branches;
next	1.29;

1.29
date	2001.12.02.08.07.19;	author MikeMannix;	state Exp;
branches;
next	1.28;

1.28
date	2001.10.02.07.29.52;	author MikeMannix;	state Exp;
branches;
next	1.27;

1.27
date	2001.09.18.00.12.46;	author MikeMannix;	state Exp;
branches;
next	1.26;

1.26
date	2001.09.07.04.57.56;	author MikeMannix;	state Exp;
branches;
next	1.25;

1.25
date	2001.09.06.08.50.20;	author MikeMannix;	state Exp;
branches;
next	1.24;

1.24
date	2001.09.06.07.49.13;	author MikeMannix;	state Exp;
branches;
next	1.23;

1.23
date	2001.09.06.06.32.14;	author MikeMannix;	state Exp;
branches;
next	1.22;

1.22
date	2001.08.30.17.21.03;	author MikeMannix;	state Exp;
branches;
next	1.21;

1.21
date	2001.08.30.10.06.53;	author MikeMannix;	state Exp;
branches;
next	1.20;

1.20
date	2001.08.11.07.41.20;	author PeterThoeny;	state Exp;
branches;
next	1.19;

1.19
date	2001.07.14.08.48.15;	author PeterThoeny;	state Exp;
branches;
next	1.18;

1.18
date	2001.06.28.22.15.10;	author PeterThoeny;	state Exp;
branches;
next	1.17;

1.17
date	2001.04.05.07.31.04;	author PeterThoeny;	state Exp;
branches;
next	1.16;

1.16
date	2001.03.16.00.07.53;	author PeterThoeny;	state Exp;
branches;
next	1.15;

1.15
date	2001.03.02.01.23.27;	author PeterThoeny;	state Exp;
branches;
next	1.14;

1.14
date	2001.02.25.03.14.21;	author PeterThoeny;	state Exp;
branches;
next	1.13;

1.13
date	2001.02.10.10.09.44;	author PeterThoeny;	state Exp;
branches;
next	1.12;

1.12
date	2001.02.01.01.34.06;	author PeterThoeny;	state Exp;
branches;
next	1.11;

1.11
date	2001.01.21.08.59.42;	author PeterThoeny;	state Exp;
branches;
next	1.10;

1.10
date	2000.12.12.19.01.00;	author PeterThoeny;	state Exp;
branches;
next	1.9;

1.9
date	2000.12.10.22.26.47;	author PeterThoeny;	state Exp;
branches;
next	1.8;

1.8
date	2000.11.11.06.51.06;	author PeterThoeny;	state Exp;
branches;
next	1.7;

1.7
date	2000.11.01.23.58.30;	author PeterThoeny;	state Exp;
branches;
next	1.6;

1.6
date	2000.09.19.07.37.29;	author PeterThoeny;	state Exp;
branches;
next	1.5;

1.5
date	2000.08.18.06.50.00;	author PeterThoeny;	state Exp;
branches;
next	1.4;

1.4
date	2000.02.28.08.45.06;	author PeterThoeny;	state Exp;
branches;
next	1.3;

1.3
date	99.08.09.06.25.08;	author PeterThoeny;	state Exp;
branches;
next	1.2;

1.2
date	99.06.23.16.09.34;	author thoeny;	state Exp;
branches;
next	1.1;

1.1
date	99.06.13.07.38.53;	author thoeny;	state Exp;
branches;
next	;


desc
@none
@


1.55
log
@buildrelease
@
text
@%META:TOPICINFO{author="TWikiContributor" date="1353006726" format="1.1" version="55"}%
%STARTINCLUDE%
---+ TWiki Text Formatting

_These instructions are for contributors who prefer to use the Raw Edit over the default WYSIWYG editor._ Working in TWiki is as easy as typing in text. You don't need to know HTML, though you can use it if you prefer. Links to topics are created automatically when you enter WikiWords. And TWiki shorthand gives you all the power of HTML with a simple coding system that takes no time to learn. It's all laid out below.

%TOC{depth="4"}%

#TWikiShorthand
---++ TWiki Editing Shorthand

%INCLUDE{"TWikiEditingShorthand"}%

---++ Using HTML, CSS and !JavaScript

%INCLUDE{"UsingHTML"}%

---++ Hyperlinks

Being able to create links without any special formatting is a core TWiki feature, made possible with WikiWords and inline URLs.

---+++ Internal Links

   * GoodStyle is a WikiWord that links to the <nop>GoodStyle topic located in the current web.

   * NotExistingYet is a topic waiting to be written because it is a red-link. Create the topic by clicking on the link. (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.

   * Write =[<nop>[URL][label]]= to get an external link with a descriptive text for the link, such as =[<nop>[http://google.com/][Google home page]]= to get [[http://google.com/][Google home page]].

   * E-mail addresses like =name@@domain.com= are linked automatically.

---++ TWiki Variables

%INCLUDE{"TWikiVariablesQuickStart"}%

---++ <nop>TWikiPlugin Formatting Extensions

Plugins can extend the functionality of TWiki into many other areas. There are a huge number of TWiki plugins available from the [[http://twiki.org/cgi-bin/view/Plugins][Plugins]] web on TWiki.org.

Currently enabled plugins on this TWiki installation, as listed by =%<nop>PLUGINDESCRIPTIONS%=:
%PLUGINDESCRIPTIONS%

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 =&lt;filename&gt;= is not displayed. How can I show it as it is?
      * *A:* The ='&lt;'= and ='&gt;'= characters have a special meaning in HTML, they define HTML tags. You need to escape them, so write ='&amp;lt;'= instead of ='&lt;'=, and ='&amp;gt;'= instead of ='&gt;'=. <br /> Example: Type ='prog &amp;lt;filename&amp;gt;'= to get ='prog &lt;filename&gt;'=.

   * *Q:* Why is the ='&'= character sometimes not displayed?
      * *A:* The ='&'= character has a special meaning in HTML, it starts a so-called character entity, e.g. ='&amp;copy;'= is the =&copy;= copyright character. You need to escape ='&amp;'= to see it as it is, so write ='&amp;amp;'= instead of ='&amp;'=. <br /> Example: Type ='This &amp;amp; that'= to get ='This &amp; that'=.

__Related topics:__ WikiSyntax, WikiWord, WikiNotation, TextFormattingRules, TWikiEditingShorthand, TWikiRenderingShortcut, TWikiShorthand, TWikiVariablesQuickStart
@


1.54
log
@buildrelease
@
text
@d1 1
a1 1
%META:TOPICINFO{author="TWikiContributor" date="1307235339" format="1.1" version="54"}%
d57 1
a57 1
      * *A:* The ='&'= character has a special meaning in HTML, it starts a so called character entity, i.e. ='&amp;copy;'= is the =&copy;= copyright character. You need to escape ='&amp;'= to see it as it is, so write ='&amp;amp;'= instead of ='&amp;'=. <br /> Example: Type ='This &amp;amp; that'= to get ='This &amp; that'=.
@


1.53
log
@buildrelease
@
text
@d1 1
a1 1
%META:TOPICINFO{author="TWikiContributor" date="1289516436" format="1.1" version="53"}%
d30 3
a32 2
   * =http://...=, =https://...=, =ftp://...=, =gopher://...=, =news://...=, =file://...=, =telnet://...=
     and =mailto:...@@...= are linked automatically.
a35 3
   * =[<nop>[Square bracket rules]]= let you easily create [[#SquareBrackets][non-WikiWord links]].
      * You can also write =[<nop>[http://yahoo.com Yahoo home page]]= as an easier way of doing external links with descriptive text for the link, such as [[http://yahoo.com/ Yahoo home page]].

@


1.52
log
@buildrelease
@
text
@d1 1
a1 1
%META:TOPICINFO{author="TWikiContributor" date="1276313313" format="1.1" version="52"}%
d5 1
a5 1
Working in TWiki is as easy as typing in text. You don't need to know HTML, though you can use it if you prefer. Links to topics are created automatically when you enter WikiWords. And TWiki shorthand gives you all the power of HTML with a simple coding system that takes no time to learn. It's all laid out below.
@


1.51
log
@buildrelease
@
text
@d1 1
a1 1
%META:TOPICINFO{author="TWikiContributor" date="1269909452" format="1.1" version="51"}%
d60 2
@


1.50
log
@buildrelease
@
text
@d1 1
a1 1
%META:TOPICINFO{author="TWikiContributor" date="1141756708" format="1.1" version="50"}%
d14 1
a14 1
---++ Using HTML
d26 1
a26 1
   * 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!)
@


1.49
log
@buildrelease
@
text
@d1 1
a1 2
%META:TOPICINFO{author="TWikiContributor" date="1141756708" format="1.1" version="49"}%
%TOC{depth="4"}%
d3 1
a3 1
---# TWiki Text Formatting
d7 2
a17 4
---+++ Script tags

You can use HTML =&lt;script>= tags for your TWiki applications. However note that your TWiki administrator can disable =&lt;script>= in topics, and may have chosen to do so for security considerations. TWiki markup and TWikiVariables are *not* expanded inside script tags.

@


1.48
log
@buildrelease
@
text
@d1 1
a1 1
%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="48"}%
d11 1
a11 425
%TABLE{}%
<table class="twikiTable" border="1" cellpadding="3" bgcolor="#ffffff">
<tr bgcolor="#ffffff">
<th width="50%">
 Formatting Command:
</th>
<th width="25%">
 You write:
</th>
<th width="25%">
 You get:
</th>
</tr>
<tr valign="top">
<td>
 *Paragraphs:* %BR%
 Blank lines will create new paragraphs.
</td><td>
<verbatim>
1st paragraph

2nd paragraph
</verbatim>
</td><td>
1st paragraph

2nd paragraph
</td>
</tr>
<tr valign="top">
<td>
 *Headings:* %BR%
Three or more dashes at the beginning of a line, followed by plus signs and the heading text. One plus creates a top level heading, two pluses a second level heading, etc. The maximum heading depth is 6.

You can create a table of contents with the [[TWikiVariables#VarTOC][%<nop>TOC%]] variable. If you want to *exclude* a heading from the TOC, put =!!= after the =---+=.

%X% Empty headings are allowed, but won't appear in the table of contents.
</td><td>
<verbatim>
---++ Sushi
---+++ Maguro
---+++!! Not in TOC
</verbatim>
</td><td>
<nop><h2>Sushi</h2>
<nop><h3>Maguro</h3>
<nop><h3>Not in TOC</h3>
</td>
</tr>
<tr valign="top">
<td>
 *Bold Text:* %BR%
 Words get shown in *bold* by enclosing them in =*= asterisks.
</td><td>
<verbatim>
*Bold*
</verbatim>
</td><td>
*Bold*
</td>
</tr>
<tr valign="top">
<td>
 *Italic Text:* %BR%
 Words get shown in _italic_ by enclosing them in =_= underscores.
</td><td>
<verbatim>
_Italic_
</verbatim>
</td><td>
_Italic_
</td>
</tr>
<tr valign="top">
<td>
 *Bold Italic:* %BR%
 Words get shown in __bold italic__ by enclosing them in =__= double-underscores.
</td><td>
<verbatim>
__Bold italic__
</verbatim>
</td><td>
__Bold italic__
</td>
</tr>
<tr valign="top">
<td>
 *Fixed Font:* %BR%
 Words get shown in =fixed font= by enclosing them in =<nop>=<nop>= equal signs.
</td><td>
<verbatim>
=Fixed font=
</verbatim>
</td><td>
=Fixed font=

</td>
</tr>
<tr valign="top">
<td>
 *Bold Fixed Font:* %BR%
 Words get shown in ==bold fixed font== by enclosing them in ==<nop>== double equal signs.
</td><td>
<verbatim>
==Bold fixed==
</verbatim>
</td><td>
==Bold fixed==
</td>
</tr>
<tr valign="top">
<td>
%T% You can follow the closing bold, italic, or other (=* _ __ = ===) indicator
with normal punctuation, such as commas and full stops.

%X% Make sure there is no space between the text and the indicators.
</td><td>
<verbatim>
_This works_,
_this does not _
</verbatim>
</td><td>
_This works_,%BR%
_this does not _
</td>
</tr>
<tr valign="top">
<td>
 *Verbatim (Literal) Text:* %BR%
 Surround code excerpts and other formatted text with =&lt;verbatim&gt;= and =&lt;/verbatim&gt;= tags.%BR%
%T% =verbatim= tags disable HTML code. Use =&lt;pre&gt;= and =&lt;/pre&gt;= tags instead if you want the HTML code within the tags to be interpreted.%BR%
__%X% NOTE:__ Preferences variables (* Set NAME = value) are set within verbatim tags.
</td><td>
<verbatim>
<verbatim>
class CatAnimal {
  void purr() {
	 <code here>
  }
}
</verbatim>
</verbatim>
</td><td>
<verbatim>
class CatAnimal {
  void purr() {
	 <code here>
  }
}
</verbatim>
</td>
</tr>
<tr valign="top">
<td>
 *Separator (Horizontal Rule):* %BR%
Three or more three dashes at the beginning of a line..
</td><td>
<verbatim>
-------
</verbatim>
</td><td>
-------
</td>
</tr>
<tr valign="top">
<td>
 *Bulleted List:* %BR%
Multiple of three spaces, an asterisk, and another space.%BR%
%H% For all the list types, you can break a list item over several lines by indenting lines after the first one by *at least 3 spaces*.
</td><td>
<verbatim>
	* level 1
		* level 2
	* back on 1
	* A bullet
	  broken over
	  three lines
	* last bullet
</verbatim>
</td><td>
	* level 1
		* level 2
	* back on 1
	* A bullet
	  broken over
	  three lines
	* last bullet
</td>
</tr>
<tr valign="top">
<td>
*Numbered List:* %BR%
Multiple of three spaces, a type character, a dot, and another space. Several types are available besides a number:
| *Type* | *Generated Style* | *Sample Sequence* |
| 1. | Arabic numerals | 1, 2, 3, 4... |
| A. | Uppercase letters | A, B, C, D... |
| a. | Lowercase letters | a, b, c, d... |
| I. | Uppercase Roman Numerals | I, II, III, IV... |
| i. | Lowercase Roman Numerals | i, ii, iii, iv... |
</td><td>
<verbatim>
	1. Sushi
	1. Dim Sum
	1. Fondue

	A. Sushi
	A. Dim Sum
	A. Fondue

	i. Sushi
	i. Dim Sum
	i. Fondue
</verbatim>
</td><td>
	1. Sushi
	1. Dim Sum
	1. Fondue

	A. Sushi
	A. Dim Sum
	A. Fondue

	i. Sushi
	i. Dim Sum
	i. Fondue
</td>
</tr>
<tr valign="top">
<td>
 *Definition List:* %BR%
 Three spaces, a dollar sign, the term, a colon, a space, followed by the definition.
</td><td>
<verbatim>
	$ Sushi: Japan
	$ Dim Sum: S.F.
</verbatim>
</td><td>
	$ Sushi: Japan
	$ Dim Sum: S.F.
</td>
</tr>
<tr valign="top">
<td>
 *Table:* %BR%
Each row of the table is a line containing of one or more cells. Each cell starts and ends with a vertical bar '|'. Any spaces at the beginning of a line are ignored.
	* =| <nop>*bold*<nop> |= header cell with text in asterisks
	* =|	center-aligned	|= cell with at least two, and equal number of spaces on either side
	* =|		right-aligned |= cell with more spaces on the left
	* =| 2 colspan ||= and multi-span columns with multiple <tt>|</tt>'s right next to each other
	* =|^|= cell with caret indicating follow-up row of multi-span rows
	* You can split rows over multiple lines by putting a backslash ='\'= at the end of each line
	* Contents of table cells wrap automatically as determined by the browser
%T% The %TWIKIWEB%.TablePlugin provides the =|^|= multiple-span row functionality and additional rendering features
</td><td>
<verbatim>
| *L* | *C* | *R* |
| A2 |  B2  |  C2 |
| A3 |  B3  |  C3 |
| multi span |||
| A5-7 |  5  |  5 |
|^| six | six |
|^| seven | seven |
| split\
  | over\
  | 3 lines |
| A9 |  B9  |  C9 |
</verbatim>
</td><td>
| *L* | *C* | *R* |
| A2 |  B2  |  C2 |
| A3 |  B3  |  C3 |
| multi span |||
| A5-7 |  5  |  5 |
|^| six | six |
|^| seven | seven |
| split\
  | over\
  | 3 lines |
| A9 |  B9  |  C9 |
</td>
</tr>
<tr valign="top">
<td>
 *<nop>WikiWord Links:* %BR%
 <nop>CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically if preceded by whitespace or parenthesis. %BR%
%T% If you want to link to a topic in a different web write =Otherweb.TopicName=. %BR%
%H% The link label excludes the name of the web, e.g. only the topic name is shown. As an exception, the name of the web is shown for the <nop>%HOMETOPIC% topic.

It's generally a good idea to use the TWikiVariables %<nop>TWIKIWEB% and %<nop>MAINWEB% instead of TWiki and Main.
</td><td>
<verbatim>
WebStatistics

Sandbox.WebNotify

Sandbox.WebHome
</verbatim>
</td><td>
WebStatistics

Sandbox.WebNotify

Sandbox.%HOMETOPIC%
</td>
</tr>
<tr valign="top">
<td>
 *Anchors:* %BR%
 You can define a 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 =[<nop>[MyTopic#MyAnchor]]= syntax. You can omit the topic name if you want to link within the same topic.
</td><td>
<verbatim>
[[WikiWord#NotThere]]

[[#MyAnchor][Jump]]

#MyAnchor To here
</verbatim>
</td><td>
[[WikiWord#NotThere]]

[[#MyAnchor][Jump]]

#MyAnchor To here
</td>
</tr>
<tr valign="top">
<td>
#HeRe
 *Forced Links:* %BR%
 You can create a forced internal link by enclosing words in double square brackets.
%BR% 
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, =[<nop>[text formatting FAQ]]= links to topic TextFormattingFAQ.  You can also refer to a different web and use anchors.
%BR%
%T% To "escape" double square brackets that would otherwise make a link, prefix the leading left square bracket with an exclamation point.
</td><td>
<verbatim>
[[wiki syntax]]

[[Main.TWiki users]]

escaped:
![[wiki syntax]]
</verbatim>
</td><td>
[[wiki syntax]]

[[%MAINWEB%.TWiki users]]

escaped:
![[wiki syntax]]
</td>
</tr>
<tr valign="top">
<td>
 *Specific Links:* %BR%
 You can create a link where you specify the link text and the URL separately using nested square brackets =[<nop>[reference][text]]=. Internal link references (e.g. WikiSyntax) and URLs (e.g. http://TWiki.org/) are both supported.
The rules described under __Forced Links__ apply for internal link references.
 %BR% %T% Anchor names can be added as well, to create a link to a specific place in a topic.
</td><td>
<verbatim>
[[WikiSyntax][wiki syntax]]

[[http://gnu.org][GNU]]
</verbatim>
</td><td>
[[WikiSyntax][wiki syntax]]

[[http://gnu.org][GNU]]
</td>
</tr>
<tr valign="top">
<td>
 *Prevent a Link:* %BR%
 Prevent a WikiWord from being linked by prepending it with an exclamation point.
</td><td>
<verbatim>
!SunOS
</verbatim>
</td><td>
!SunOS
</td>
</tr>
<tr valign="top">
<td>
 *Disable Links:* %BR%
 You can disable automatic linking of WikiWords by surrounding text with =&lt;noautolink&gt;= and =&lt;/noautolink&gt;= tags.%BR%
%H% It is possible to turn off all auto-linking with a NOAUTOLINK preferences setting.
</td><td>
<verbatim>
 <noautolink>
 RedHat &
 SuSE
 </noautolink>
</verbatim>
</td><td>
 <noautolink>
 RedHat &
 SuSE
 </noautolink>
</td>
</tr>
<tr valign="top">
<td>
*Mailto Links:* %BR%
E-mail addresses are linked automatically. To create e-mail links that have more descriptive link text, specify subject lines or message bodies, or omit the e-mail address, you can write =[<nop>[mailto:user@@domain][descriptive text]]=.
</td><td>
<verbatim>
a@@b.com

[[mailto:a@@b.com]\
[Mail]]

[[mailto:?subject=\
Hi][Hi]]
</verbatim>
</td><td>
a@@b.com

[[mailto:a@@b.com]\
[Mail]]

[[mailto:?subject=Hi][Hi]]
</td>
</tr>
</table>
d15 1
a15 15
You can use just about any HTML tag without a problem. You can add HTML if there is no TWiki equivalent, for example, write =&lt;strike&gt;deleted text&lt;/strike&gt;= to get <strike>deleted text</strike>.

%X% There are a few usability and technical considerations to keep in mind:
	* On collaboration pages, it's better *not* to use HTML, but to use [[#TWikiShorthand][TWiki shorthand]] instead - this keeps the text uncluttered and easy to edit.
	* If you use HTML use [[http://www.w3.org/TR/xhtml1/][XHTML 1.0 Transitional]] syntax.
	* %X% Script tags may be filtered out, at the discretion of your TWiki administrator.

Recommendations when pasting HTML from other sources:
	* Copy only text between =&lt;body&gt;= and =&lt;/body&gt;= tags.
	* Remove all empty lines. TWiki inserts =&lt;p /&gt;= paragraph tags on empty lines, which causes problems if done between HTML tags that do not allow paragraph tags, like for example between table tags.
	* Remove leading spaces. TWiki might interpret some text as lists.
	* Do not span a tag over more than one line. TWiki requires that the opening and closing angle brackets - ==&lt;...&gt;== - of an HTML tag are on the same line, or the tag will be broken.
	* In your HTML editing program, save without hard line breaks on text wrap.

%T% TWiki converts shorthand notation to HTML for display. To copy a fully marked-up page, simply view the source in your browser and save the contents. If you need to save HTML frequently, you may want to check out TWiki:Plugins/PublishAddOn.
d27 1
a27 1
	* GoodStyle is a WikiWord that links to the <nop>GoodStyle topic located in the current web.
d29 1
a29 1
	* 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!)
d33 2
a34 2
	* =http://...=, =https://...=, =ftp://...=, =gopher://...=, =news://...=, =file://...=, =telnet://...=
	  and =mailto:...@@...= are linked automatically.
d36 1
a36 1
	* E-mail addresses like =name@@domain.com= are linked automatically.
d38 2
a39 2
	* =[<nop>[Square bracket rules]]= let you easily create [[#SquareBrackets][non-WikiWord links]].
		* You can also write =[<nop>[http://yahoo.com Yahoo home page]]= as an easier way of doing external links with descriptive text for the link, such as [[http://yahoo.com/ Yahoo home page]].
d43 1
a43 22
TWiki Variables are names that are enclosed in percent signs =%= that are expanded on the fly.

	* =%<nop>TOC%= : Automatically generates a table of contents based on headings in a topic - see the top of this page for an example.

	* =%<nop>WEB%= : The current web, is <b><nop>%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 web is the default web. Example: =<b>%<nop>INCLUDE{"%TWIKIWEB%.SiteMap"}%</b>=

	* =%<nop>SEARCH{"sushi"}%= : Inline search showing the search result embedded in a topic. FormattedSearch gives you control over formatting, useful for creating web-based applications.

	* TWikiPreferences defines some site-wide variables. Among others:
		* *Line break:* Write =%<nop>BR%= to start a new line.
		* *Colored text:* Write: =%<nop>RED% Red %<nop>ENDCOLOR% and %<nop>BLUE% blue %<nop>ENDCOLOR% colors= to get: %RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors.
		* *Documentation Graphics:* Write: =%<nop>H% Help, %<nop>T% Tip, %<nop>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 variable, prefix it with an exclamation mark. Write: =!%<nop>SOMEVARIABLE%= to get: !%SOMEVARIABLE%.
d58 2
a59 8
	* *Q:* Text enclosed in angle brackets like =&lt;filename&gt;= is not displayed. How can I show it as it is?
		* *A:* The ='&lt;'= and ='&gt;'= characters have a special meaning in HTML, they define HTML tags. You need to escape them, so write ='&amp;lt;'= instead of ='&lt;'=, and ='&amp;gt;'= instead of ='&gt;'=. <br /> Example: Type ='prog &amp;lt;filename&amp;gt;'= to get ='prog &lt;filename&gt;'=.

	* *Q:* Why is the ='&'= character sometimes not displayed?
		* *A:* The ='&'= character has a special meaning in HTML, it starts a so called character entity, i.e. ='&amp;copy;'= is the =&copy;= copyright character. You need to escape ='&amp;'= to see it as it is, so write ='&amp;amp;'= instead of ='&amp;'=. <br /> Example: Type ='This &amp;amp; that'= to get ='This &amp; that'=.



d61 2
@


1.47
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1091357500" format="1.0" version="1.47"}%
d6 1
a6 1
Working in TWiki is as easy as typing in text - *exactly like email*. You don't need to know HTML, though you can use it if you prefer. Links to topics are created automatically when you enter WikiWords. And TWiki shorthand gives you all the power of HTML with a simple coding system that takes no time to learn. It's all laid out below - refer back to this page in a pop-up window from the *Edit* screen.
d11 2
a12 1
<table border="1" cellpadding="3" cellspacing="1" bgcolor="#000000">
d14 11
a25 9
 *Formatting Command:*
</td><td>
 *Example: You write:*
</td><td>
 *You get:*
</td>
</tr>
<tr bgcolor="#ffffff">
<td valign="top">
d28 2
a29 3
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<pre>
d33 2
a34 3
</pre>
</font></span>
</td><td valign="top">
d40 2
a41 2
<tr bgcolor="#ffffff">
<td valign="top">
d43 1
a43 11
 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 =%<nop>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.
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<pre>
<nop>---++ Sushi

<nop>---+++ Maguro
</pre>
</font></span>
</td><td valign="top">
<h2 >Sushi</h2>
d45 13
a57 1
<h3 >Maguro</h3>
d60 2
a61 2
<tr bgcolor="#ffffff">
<td valign="top">
d63 3
a65 4
 Words get *bold* by enclosing them in =*= asterisks.
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<pre>
d67 2
a68 3
</pre>
</font></span>
</td><td valign="top">
d72 2
a73 2
<tr bgcolor="#ffffff">
<td valign="top">
d75 3
a77 4
 Words get _italic_ by enclosing them in =_= underscores.
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<pre>
d79 2
a80 3
</pre>
</font></span>
</td><td valign="top">
d84 2
a85 2
<tr bgcolor="#ffffff">
<td valign="top">
d87 3
a89 4
 Words get __bold italic_ by enclosing them in =_= double-underscores.
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<pre>
d91 2
a92 3
</pre>
</font></span>
</td><td valign="top">
d96 2
a97 2
<tr bgcolor="#ffffff">
<td valign="top">
d100 2
a101 3
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<pre>
d103 2
a104 3
</pre>
</font></span>
</td><td valign="top">
d109 2
a110 2
<tr bgcolor="#ffffff">
<td valign="top">
d113 2
a114 3
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<pre>
d116 2
a117 3
</pre>
</font></span>
</td><td valign="top">
d121 8
a128 6
<tr bgcolor="#ffffff">
<td valign="top">
 __Note:__ Make sure there is no space between the text and the bold, italic, or other indicators (=* _ __ = ===).
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<pre>
d130 3
a132 4
_this not _
</pre>
</font></span>
</td><td valign="top">
d134 1
a134 1
_this not _
d137 9
a145 8
<tr bgcolor="#ffffff">
<td valign="top">
 *Verbatim Mode:* %BR%
 Surround code excerpts and other formatted text with =&lt;verbatim&gt;= and =&lt;/verbatim&gt;= tags. %BR% __Note:__ Use =&lt;pre&gt;= and =&lt;/pre&gt;= tags instead if you want that HTML code is interpreted. %BR% __Note:__ Each tag must be on a line by itself.
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<pre>
&lt;verbatim&gt;
d148 1
a148 1
	 &lt;code here&gt;
d151 3
a153 4
&lt;/verbatim&gt;
</pre>
</font></span>
</td><td valign="top">
d163 6
a168 7
<tr bgcolor="#ffffff">
<td valign="top">
 *Separator:* %BR%
 At least three dashes at the beginning of a line.
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<pre>
d170 2
a171 3
</pre>
</font></span>
</td><td valign="top">
d175 7
a181 21
<tr bgcolor="#ffffff">
<td valign="top">
 *List Item:* %BR%
 Three spaces, an asterisk, and another space.
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<pre>
	* bullet item
</pre>
</font></span>
</td><td valign="top">
	* bullet item
</td>
</tr>
<tr bgcolor="#ffffff">
<td valign="top">
 *Nested List Item:* %BR%
 Six, nine, ... spaces, an asterisk, and another space.
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<pre>
d184 7
a190 3
</pre>
</font></span>
</td><td valign="top">
d193 5
d200 4
a203 4
<tr bgcolor="#ffffff">
<td valign="top">
 *Ordered List:* %BR%
 Three spaces, a number, a dot, and another space. Several types are available besides a number:
d210 2
a211 4

</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<pre>
d214 1
d218 1
d222 3
a224 3
</pre>
</font></span>
</td><td valign="top">
d227 1
d231 1
d235 1
d238 2
a239 2
<tr bgcolor="#ffffff">
<td valign="top">
d242 2
a243 3
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<pre>
d246 2
a247 3
</pre>
</font></span>
</td><td valign="top">
d252 2
a253 2
<tr bgcolor="#ffffff">
<td valign="top">
d255 11
a265 12
 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%
 =| <nop>*bold*<nop> |= 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 (this functionality is provided by TablePlugin).%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.
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<pre>
d267 2
a268 2
| A2 |  2  |  2 |
| A3 |  3  |  3 |
d270 1
a270 5
| A4-6 | four | four |
|^| five | five |



d272 7
a278 3
</pre>
</font></span>
</td><td valign="top">
d280 2
a281 2
| A2 |  2  |  2 |
| A3 |  3  |  3 |
d283 1
a283 2
| A4-6 | four | four |
|^| five | five |
d285 5
d292 2
a293 2
<tr bgcolor="#ffffff">
<td valign="top">
d295 35
a329 11
 <nop>CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically. %BR% __Note:__ In case you want to link to a topic in a different %WIKITOOLNAME% web write =Otherweb.TopicName=. (The link label is the the name of the web in case the is <nop>%HOMETOPIC%, else it is the topic name)
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<pre>
WebNotify

%MAINWEB%.TWikiUsers
</pre>
</font></span>
</td><td valign="top">
WebNotify
d331 3
a333 1
%MAINWEB%.TWikiUsers
d336 3
a338 3
<tr bgcolor="#ffffff">
<td valign="top">
#SquareBrackets
d341 6
a346 5
 %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, =[<nop>[text formatting FAQ]]= links to topic 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, prefix the leading left square brackets with an exclamation point, that is, begin with =![<nop>[....=
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<pre>
d349 1
a349 1
[[%MAINWEB%.TWiki users]]
d353 2
a354 3
</pre>
</font></span>
</td><td valign="top">
d363 2
a364 2
<tr bgcolor="#ffffff">
<td valign="top">
d366 6
a371 8
 Create a link where you can specify the link text and the link reference separately, using nested square brackets like =[<nop>[reference][text]]=. Internal link references (e.g. 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 =[<nop>[%HOMETOPIC%#MyAnchor][go home]]= and =[<nop>[http://gnu.org/#Action][GNU Action]]=.
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<pre>
[[WikiSyntax][syntax]]
d374 3
a376 6

[[http://xml.org XML]]
</pre>
</font></span>
</td><td valign="top">
[[WikiSyntax][syntax]]
a378 2

[[http://xml.org XML]]
d381 2
a382 24
<tr bgcolor="#ffffff">
<td valign="top">
 *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 WikiWord. To __link to__ an anchor name use the =[<nop>[MyTopic#MyAnchor]]= syntax. You can omit the topic name if you want to link within the same topic.
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<pre>
[[WikiWord#NotThere]]

[[#MyAnchor][Jump]]

#MyAnchor To here
</pre>
</font></span>
</td><td valign="top">
[[WikiWord#NotThere]]

[[#MyAnchor][Jump]]

#MyAnchor To here
</td>
</tr>
<tr bgcolor="#ffffff">
<td valign="top">
d385 2
a386 3
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<pre>
d388 2
a389 3
</pre>
</font></span>
</td><td valign="top">
d393 2
a394 2
<tr bgcolor="#ffffff">
<td valign="top">
d396 3
a398 5
 You can disable automatic linking of WikiWords by surrounding text with =&lt;noautolink&gt;= and =&lt;/noautolink&gt;= 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 =&lt;/noautolink&gt;= tag (known issue of the TablePlugin).
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
d405 1
a405 2
</font></span>
</td><td valign="top">
d412 19
a430 14
<tr bgcolor="#ffffff">
<td valign="top">
*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 =[<nop>[mailto:user@@domain descriptive text]]=.
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<pre>
[[mailto:a@@z.com Mail]]

[[mailto:?subject=Hi Hi]]
</pre>
</font></span>
</td><td valign="top">
[[mailto:a@@z.com Mail]]
d432 1
a432 1
[[mailto:?subject=Hi Hi]]
d439 1
a439 3
You can use just about any HTML tag without a problem - however, there are a few usability and technical considerations to keep in mind.

---+++ HTML and TWiki Usability
d441 4
a444 6
	* %T% *TIP:* On collaboration pages, it's preferable NOT to use HTML, and to use [[#TWikiShorthand][TWiki shorthand]] instead - this keeps the text uncluttered and easy to edit.
	* %X% *NOTE:* TWiki is designed to work with a wide range of browsers and computer platforms, holding to HTML 4.0 and XHTML 1.0 compatibility in the standard installation - adding raw HTML, particularly browser-specific tags (or any other mark-up that doesn't degrade well) will reduce compatibility.
	* Recommondations when using HTML:
		* Use [[http://www.w3.org/TR/xhtml1/][XHTML 1.0 Transitional]] syntax
		* Do not span a tag over more then one line
		* Remove all empty lines. TWiki inserts =&lt;p /&gt;= paragraph tags on empty lines, which causes problems if done between tags that do not allow paragraph tags, like for example between table tags.
d446 6
d453 1
a453 1
---+++ TWiki HTML Rendering
d455 1
a455 5
	* TWiki converts shorthand notation to XHTML 1.0 for display. To copy a fully marked-up page, simply view source in your browser and save the contents.
		* %T% If you need to save HTML frequently, you may want to check out TWiki:Plugins/GenHTMLAddon - it will "generate a directory containing rendered versions of a set of TWiki pages together with any attached files."
	* %X% *NOTE:* The opening and closing angle brackets - ==&lt;...&gt;== - 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, =&amp;lt;=, 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. 
d457 1
a457 10
---+++ TWiki and <nop>JavaScript

You can use <nop>JavaScript for your TWiki applications. Since TWiki rendering might interfere with <nop>JavaScript code you need to escape it with HTML comments and =&lt;pre&gt;= tags:
<verbatim>
<script type="text/javascript">
<!-- Hide JavaScript and <pre> escape TWiki rendering
... put your JavaScript code here...
// Stop hiding and stop </pre> escaping TWiki rendering -->
</script>
</verbatim>
d461 1
a461 1
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. 
d465 1
a465 1
	* GoodStyle is a WikiWord that links to the <nop>GoodStyle topic located in the current %WIKITOOLNAME% web.
d474 1
a474 1
	* Email addresses like =name@@domain.com= are linked automatically.
a478 1

d481 1
a481 1
Variables are names that are enclosed in percent signs =%= that are expanded on the fly.
d485 1
a485 1
	* =%<nop>WEB%= : The current web, is <b>%WEB%</b>.
d491 1
a491 1
	* =%<nop>INCLUDE{"SomeTopic"}%= : Server side include, includes another topic. The current %WIKITOOLNAME% web is the default web. Example: =<b>%<nop>INCLUDE{"%TWIKIWEB%.SiteMap"}%</b>=
d493 1
a493 1
	* =%<nop>SEARCH{"sushi"}%= : Inline search showing the search result embedded in a topic. FormattedSearch gives you control over formatting, used to create web-based applications.
d495 4
a498 4
	* TWikiPreferences defines site-wide variables. Among others:
		* *Line break:* Write =<span style='background : #FFFFCC;'><font color="#990000">%<nop>BR%</font></span>= to start a new line.
		* *Colored text:* Write: =<span style='background : #FFFFCC;'><font color="#990000"> %<nop>RED% Red %<nop>ENDCOLOR% and %<nop>BLUE% blue %<nop>ENDCOLOR% colors</font></span>= to get: %RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors.
		* *Documentation Graphics:* Write: =<span style='background : #FFFFCC;'><font color="#990000"> %<nop>H% Help, %<nop>T% Tip, %<nop>X% Alert</font></span>= to get: %H% Help, %T% Tip, %X% Alert. For more info see TWikiDocGraphics.
d502 1
a502 1
	* To "escape" a variable, prefix it with an exclamation point. Write: =<span style='background : #FFFFCC;'><font color="#990000"> !%<nop>SOMEVARIABLE% </font></span>= to get: !%SOMEVARIABLE%.
d506 1
a506 3
Plugins provide additional text formatting capabilities and can extend the functionality of %WIKITOOLNAME% into many other areas. For example, the optional [[http://twiki.org/cgi-bin/view/Plugins/SpreadSheetPlugin][SpreadSheetPlugin]] lets you create a spreadsheet with the same basic notation used in TWiki tables.

Available Plugins are located in the [[http://twiki.org/cgi-bin/view/Plugins][Plugins]] web on TWiki.org. Currently enabled plugins on this TWiki installation, as listed by =%<nop>PLUGINDESCRIPTIONS%=:
d508 1
a512 1

d523 2
a524 2
-- TWiki:Main.MikeMannix - 02 Dec 2001 <br />
-- TWiki:Main.PeterThoeny - 01 Aug 2004
@


1.46
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1090657293" format="1.0" version="1.46"}%
d304 1
a304 1
 <nop>CapitalizedWordsStuckTogether (or 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=.
d462 1
d475 1
a475 1
<script language="JavaScript">
d550 1
a550 1
-- TWiki:Main.PeterThoeny - 25 Apr 2004
@


1.45
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1089531986" format="1.0" version="1.45"}%
d310 1
a310 1
Know.ReadmeFirst
d316 1
a316 1
Know.ReadmeFirst
@


1.44
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1082874577" format="1.0" version="1.44"}%
d455 6
a460 2
	* On collaboration pages, it's preferable NOT to use HTML, and to use [[#TWikiShorthand][TWiki shorthand]] instead - this keeps the text uncluttered and easy to edit.
	* %X% *NOTE:* TWiki is designed to work with a wide range of browsers and computer platforms, holding to HTML 3.2 compatibility in the standard installation - adding raw HTML, particularly browser-specific tags (or any other mark-up that doesn't degrade well) will reduce compatibility.
@


1.43
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1080625187" format="1.0" version="1.43"}%
d216 8
a223 1
 Three spaces, a number, and another space.
d227 8
a234 2
	1 Sushi
	1 Dim Sum
d238 8
a245 2
	1 Sushi
	1 Dim Sum
d332 3
d341 3
d468 1
a468 1
You can use <nop>JavaScript for your TWiki applications. Sice TWiki rendering might interfere with <nop>JavaScript code you need to escape it with HTML comments and =&lt;pre&gt;= tags:
d545 1
a545 1
-- TWiki:Main.PeterThoeny - 29 Mar 2004
@


1.42
log
@none
@
text
@d1 521
a521 509
%META:TOPICINFO{author="PeterThoeny" date="1079507030" format="1.0" version="1.42"}%
%TOC{depth="4"}%
%STARTINCLUDE%
---# TWiki Text Formatting

Working in TWiki is as easy as typing in text - *exactly like email*. You don't need to know HTML, though you can use it if you prefer. Links to topics are created automatically when you enter WikiWords. And TWiki shorthand gives you all the power of HTML with a simple coding system that takes no time to learn. It's all laid out below - refer back to this page in a pop-up window from the *Edit* screen.

#TWikiShorthand
---++ TWiki Editing Shorthand

<table border="1" cellpadding="3" cellspacing="1" bgcolor="#000000">
<tr bgcolor="#ffffff">
<td>
 *Formatting Command:*
</td><td>
 *Example: You write:*
</td><td>
 *You get:*
</td>
</tr>
<tr bgcolor="#ffffff">
<td valign="top">
 *Paragraphs:* %BR%
 Blank lines will create new paragraphs.
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<pre>
1st paragraph

2nd paragraph
</pre>
</font></span>
</td><td valign="top">
1st paragraph

2nd paragraph
</td>
</tr>
<tr bgcolor="#ffffff">
<td valign="top">
 *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 =%<nop>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.
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<pre>
<nop>---++ Sushi

<nop>---+++ Maguro
</pre>
</font></span>
</td><td valign="top">
<h2 >Sushi</h2>

<h3 >Maguro</h3>
</td>
</tr>
<tr bgcolor="#ffffff">
<td valign="top">
 *Bold Text:* %BR%
 Words get *bold* by enclosing them in =*= asterisks.
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<pre>
*Bold*
</pre>
</font></span>
</td><td valign="top">
*Bold*
</td>
</tr>
<tr bgcolor="#ffffff">
<td valign="top">
 *Italic Text:* %BR%
 Words get _italic_ by enclosing them in =_= underscores.
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<pre>
_Italic_
</pre>
</font></span>
</td><td valign="top">
_Italic_
</td>
</tr>
<tr bgcolor="#ffffff">
<td valign="top">
 *Bold Italic:* %BR%
 Words get __bold italic_ by enclosing them in =_= double-underscores.
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<pre>
__Bold italic__
</pre>
</font></span>
</td><td valign="top">
__Bold italic__
</td>
</tr>
<tr bgcolor="#ffffff">
<td valign="top">
 *Fixed Font:* %BR%
 Words get shown in =fixed font= by enclosing them in =<nop>=<nop>= equal signs.
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<pre>
=Fixed font=
</pre>
</font></span>
</td><td valign="top">
=Fixed font=

</td>
</tr>
<tr bgcolor="#ffffff">
<td valign="top">
 *Bold Fixed Font:* %BR%
 Words get shown in ==bold fixed font== by enclosing them in ==<nop>== double equal signs.
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<pre>
==Bold fixed==
</pre>
</font></span>
</td><td valign="top">
==Bold fixed==
</td>
</tr>
<tr bgcolor="#ffffff">
<td valign="top">
 __Note:__ Make sure there is no space between the text and the bold, italic, or other indicators (=* _ __ = ===).
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<pre>
_This works_,
_this not _
</pre>
</font></span>
</td><td valign="top">
_This works_,%BR%
_this not _
</td>
</tr>
<tr bgcolor="#ffffff">
<td valign="top">
 *Verbatim Mode:* %BR%
 Surround code excerpts and other formatted text with =&lt;verbatim&gt;= and =&lt;/verbatim&gt;= tags. %BR% __Note:__ Use =&lt;pre&gt;= and =&lt;/pre&gt;= tags instead if you want that HTML code is interpreted. %BR% __Note:__ Each tag must be on a line by itself.
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<pre>
&lt;verbatim&gt;
class CatAnimal {
  void purr() {
	 &lt;code here&gt;
  }
}
&lt;/verbatim&gt;
</pre>
</font></span>
</td><td valign="top">
<verbatim>
class CatAnimal {
  void purr() {
	 <code here>
  }
}
</verbatim>
</td>
</tr>
<tr bgcolor="#ffffff">
<td valign="top">
 *Separator:* %BR%
 At least three dashes at the beginning of a line.
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<pre>
-------
</pre>
</font></span>
</td><td valign="top">
-------
</td>
</tr>
<tr bgcolor="#ffffff">
<td valign="top">
 *List Item:* %BR%
 Three spaces and an asterisk.
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<pre>
	* bullet item
</pre>
</font></span>
</td><td valign="top">
	* bullet item
</td>
</tr>
<tr bgcolor="#ffffff">
<td valign="top">
 *Nested List Item:* %BR%
 Six, nine, ... spaces and an asterisk.
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<pre>
	* level 1
		* level 2
</pre>
</font></span>
</td><td valign="top">
	* level 1
		* level 2
</td>
</tr>
<tr bgcolor="#ffffff">
<td valign="top">
 *Ordered List:* %BR%
 Three spaces and a number.
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<pre>
	1 Sushi
	1 Dim Sum
</pre>
</font></span>
</td><td valign="top">
	1 Sushi
	1 Dim Sum
</td>
</tr>
<tr bgcolor="#ffffff">
<td valign="top">
 *Definition List:* %BR%
 Three spaces, a dollar sign, the term, a colon, a space, followed by the definition.
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<pre>
	$ Sushi: Japan
	$ Dim Sum: S.F.
</pre>
</font></span>
</td><td valign="top">
	$ Sushi: Japan
	$ Dim Sum: S.F.
</td>
</tr>
<tr bgcolor="#ffffff">
<td valign="top">
 *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%
 =| <nop>*bold*<nop> |= 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.
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<pre>
| *L* | *C* | *R* |
| A2 |  2  |  2 |
| A3 |  3  |  3 |
| multi span |||
| A4-6 | four | four |
|^| five | five |



|^| six | six |
</pre>
</font></span>
</td><td valign="top">
| *L* | *C* | *R* |
| A2 |  2  |  2 |
| A3 |  3  |  3 |
| multi span |||
| A4-6 | four | four |
|^| five | five |
|^| six | six |
</td>
</tr>
<tr bgcolor="#ffffff">
<td valign="top">
 *<nop>WikiWord Links:* %BR%
 <nop>CapitalizedWordsStuckTogether (or 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=.
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<pre>
WebNotify

Know.ReadmeFirst
</pre>
</font></span>
</td><td valign="top">
WebNotify

Know.ReadmeFirst
</td>
</tr>
<tr bgcolor="#ffffff">
<td valign="top">
#SquareBrackets
 *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, =[<nop>[text formatting FAQ]]= links to topic 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 =&lt;nop&gt;= between the leading left square brackets, that is, begin with =[&lt;nop&gt;[....=
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<pre>
[[wiki syntax]]

[[%MAINWEB%.TWiki users]]
</pre>
</font></span>
</td><td valign="top">
[[wiki syntax]]

[[%MAINWEB%.TWiki users]]
</td>
</tr>
<tr bgcolor="#ffffff">
<td valign="top">
 *Specific Links:* %BR%
 Create a link where you can specify the link text and the link reference separately, using nested square brackets like =[<nop>[reference][text]]=. Internal link references (e.g. 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 =[<nop>[%HOMETOPIC%#MyAnchor][go home]]= and =[<nop>[http://gnu.org/#Action][GNU Action]]=.
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<pre>
[[WikiSyntax][syntax]]

[[http://gnu.org][GNU]]

[[http://xml.org XML]]
</pre>
</font></span>
</td><td valign="top">
[[WikiSyntax][syntax]]

[[http://gnu.org][GNU]]

[[http://xml.org XML]]
</td>
</tr>
<tr bgcolor="#ffffff">
<td valign="top">
 *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 WikiWord. To __link to__ an anchor name use the =[<nop>[MyTopic#MyAnchor]]= syntax. You can omit the topic name if you want to link within the same topic.
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<pre>
[[WikiWord#NotThere]]

[[#MyAnchor][Jump]]

#MyAnchor To here
</pre>
</font></span>
</td><td valign="top">
[[WikiWord#NotThere]]

[[#MyAnchor][Jump]]

#MyAnchor To here
</td>
</tr>
<tr bgcolor="#ffffff">
<td valign="top">
 *Prevent a Link:* %BR%
 Prevent a WikiWord from being linked by prepending it with the =&lt;nop&gt;= tag.
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<pre>
&lt;nop&gt;SunOS
</pre>
</font></span>
</td><td valign="top">
<nop>SunOS
</td>
</tr>
<tr bgcolor="#ffffff">
<td valign="top">
 *Disable Links:* %BR%
 You can disable automatic linking of WikiWords by surrounding text with =&lt;noautolink&gt;= and =&lt;/noautolink&gt;= 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 =&lt;/noautolink&gt;= tag (known issue of the TablePlugin).
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<verbatim>
 <noautolink>
 RedHat &
 SuSE
 </noautolink>
</verbatim>
</font></span>
</td><td valign="top">
 <noautolink>
 RedHat &
 SuSE
 </noautolink>
</td>
</tr>
<tr bgcolor="#ffffff">
<td valign="top">
*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 =[<nop>[mailto:user@@domain descriptive text]]=.
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<pre>
[[mailto:a@@z.com Mail]]

[[mailto:?subject=Hi Hi]]
</pre>
</font></span>
</td><td valign="top">
[[mailto:a@@z.com Mail]]

[[mailto:?subject=Hi Hi]]
</td>
</tr>
</table>

---++ Using HTML

You can use just about any HTML tag without a problem - however, there are a few usability and technical considerations to keep in mind.

---+++ HTML and TWiki Usability

	* On collaboration pages, it's preferable NOT to use HTML, and to use [[#TWikiShorthand][TWiki shorthand]] instead - this keeps the text uncluttered and easy to edit.
	* %X% *NOTE:* TWiki is designed to work with a wide range of browsers and computer platforms, holding to HTML 3.2 compatibility in the standard installation - adding raw HTML, particularly browser-specific tags (or any other mark-up that doesn't degrade well) will reduce compatibility.

---+++ TWiki HTML Rendering

	* TWiki converts shorthand notation to XHTML 1.0 for display. To copy a fully marked-up page, simply view source in your browser and save the contents.
		* %T% If you need to save HTML frequently, you may want to check out TWiki:Plugins/GenHTMLAddon - it will "generate a directory containing rendered versions of a set of TWiki pages together with any attached files."
	* %X% *NOTE:* The opening and closing angle brackets - ==&lt;...&gt;== - 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, =&amp;lt;=, 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 <nop>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.

	* =[<nop>[Square bracket rules]]= let you easily create [[#SquareBrackets][non-WikiWord links]].
		* You can also write =[<nop>[http://yahoo.com Yahoo home page]]= as an easier way of doing external links with descriptive text for the link, such as [[http://yahoo.com/ Yahoo home page]].


---++ TWiki Variables

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

	* =%<nop>TOC%= : Automatically generates a table of contents based on headings in a topic - see the top of this page for an example.

	* =%<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%.SiteMap"}%</b>=

	* =%<nop>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 =<span style='background : #FFFFCC;'><font color="#990000">%<nop>BR%</font></span>= to start a new line.
		* *Colored text:* Write: =<span style='background : #FFFFCC;'><font color="#990000"> %<nop>RED% Red %<nop>ENDCOLOR% and %<nop>BLUE% blue %<nop>ENDCOLOR% colors</font></span>= to get: %RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors.
		* *Documentation Graphics:* Write: =<span style='background : #FFFFCC;'><font color="#990000"> %<nop>H% Help, %<nop>T% Tip, %<nop>X% Alert</font></span>= 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 =&lt;nop&gt;= after the first percent sign. Write: =<span style='background : #FFFFCC;'><font color="#990000"> %&lt;nop&gt;SOMEVARIABLE% </font></span>= to get: %<nop>SOMEVARIABLE%.

---++ <nop>TWikiPlugin Formatting Extensions

Plugins provide additional text formatting capabilities and can extend the functionality of %WIKITOOLNAME% into many other areas. For example, the optional [[http://twiki.org/cgi-bin/view/Plugins/SpreadSheetPlugin][SpreadSheetPlugin]] lets you create a spreadsheet with the same basic notation used in TWiki tables.

Available Plugins are located in the [[http://twiki.org/cgi-bin/view/Plugins][Plugins]] web on TWiki.org. Currently enabled plugins on this TWiki installation, as listed by =%<nop>PLUGINDESCRIPTIONS%=:

%PLUGINDESCRIPTIONS%

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 =&lt;filename&gt;= is not displayed. How can I show it as it is?
		* *A:* The ='&lt;'= and ='&gt;'= characters have a special meaning in HTML, they define HTML tags. You need to escape them, so write ='&amp;lt;'= instead of ='&lt;'=, and ='&amp;gt;'= instead of ='&gt;'=. <br /> Example: Type ='prog &amp;lt;filename&amp;gt;'= to get ='prog &lt;filename&gt;'=.

	* *Q:* Why is the ='&'= character sometimes not displayed?
		* *A:* The ='&'= character has a special meaning in HTML, it starts a so called character entity, i.e. ='&amp;copy;'= is the =&copy;= copyright character. You need to escape ='&amp;'= to see it as it is, so write ='&amp;amp;'= instead of ='&amp;'=. <br /> Example: Type ='This &amp;amp; that'= to get ='This &amp; that'=.

-- TWiki:Main.MikeMannix - 02 Dec 2001 <br />
-- TWiki:Main.PeterThoeny - 16 Mar 2004
@


1.41
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1071564063" format="1.0" version="1.41"}%
d232 1
a232 2
 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 =&amp;nbsp;= non-breaking-space entity.
d236 2
a237 2
	Sushi: Japan
	Dim&amp;nbsp;Sum: S.F.
d241 2
a242 2
	Sushi: Japan
	Dim&nbsp;Sum: S.F.
d266 3
d508 2
a509 2
-- Main.MikeMannix - 02 Dec 2001 <br />
-- Main.PeterThoeny - 15 Jul 2003
@


1.40
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1059714736" format="1.0" version="1.40"}%
d6 1
a6 1
Working in TWiki is as easy as typing in text - *exactly like email*. You don't need to know HTML, though you can use it if you prefer. Links to topics are created automatically when you enter WikiWords. And TWiki shorthand gives you all the power of HTML with a simple coding system that takes no time to learn. It's all layed out below - refer back to this page in a pop-up window from the *Edit* screen.
@


1.39
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1059255424" format="1.0" version="1.39"}%
d304 1
d483 1
@


1.38
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1058399820" format="1.0" version="1.38"}%
d324 1
a324 1
 %BR% __Note:__ Anchor names can be added as well, like =[<nop>[WebHome#MyAnchor][go home]]= and =[<nop>[http://gnu.org/#Action][GNU Action]]=.
d350 1
a350 1
[[WebHome#NotThere]]
d358 1
a358 1
[[WebHome#NotThere]]
@


1.37
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1044132468" format="1.0" version="1.37"}%
d111 1
d130 1
a130 1
 __Note:__ Make sure to "stick" the =* _ = <nop>==<nop>= signs to the words, that is, take away spaces.
d139 1
a139 1
_This works_,
d204 2
a205 1
		* nested stuff
d209 2
a210 1
		* nested stuff
d249 9
a257 6
 Optional spaces followed by the cells enclosed in vertical bars. %BR%
__Note:__ =| <nop>*bold*<nop> |= cells are rendered as table headers. %BR%
__Note:__ =|	spaced	|= cells are rendered center aligned. %BR%
__Note:__ =|	  spaced |= cells are rendered right aligned. %BR%
__Note:__ =| 2 colspan ||= cells are rendered as multi-span columns. %BR%
__Note:__ In case you have a long row and you want it to be more readable when you edit the table you can split the row into lines that end with a ='\'= backslash character. %BR%
d265 3
a267 1
| A4 | next | next |
d275 3
a277 1
| A4 | next | next |
d435 1
a435 1
		* 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, =&amp;lt;=, ex: ==a > b==
d505 1
a505 1
-- Main.PeterThoeny - 01 Feb 2003
@


1.36
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1044097920" format="1.0" version="1.36"}%
d440 2
a441 1
	* =http://...=, =https://...=, =ftp://...= and =mailto:...@@...= are linked automatically.
@


1.35
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1033609205" format="1.0" version="1.35"}%
d4 3
a6 2
---+ TWiki Text Formatting
Working in TWiki is as easy as typing in text - exactly like email. You don't need to know HTML, though you can use it if you prefer. Links to topics are created automatically when you enter WikiWords. And TWiki shorthand gives you all the power of HTML with a simple coding system that takes no time to learn. It's all layed out below - refer back to this page in a pop-up window from the *Edit* screen.
d11 1
a11 1
<table border="0" cellpadding="3" cellspacing="1" bgcolor="#000000">
d23 1
a23 1
 *Paragraphs:* <br>
d41 1
a41 1
 *Headings:* <br>
d59 1
a59 1
 *Bold Text:* <br>
d73 1
a73 1
 *Italic Text:* <br>
d87 1
a87 1
 *Bold Italic:* <br>
d101 1
a101 1
 *Fixed Font:* <br>
d115 1
a115 1
 *Bold Fixed Font:* <br>
d129 1
a129 1
 __Note:__ Make sure to "stick" the =* _ = <nop>==<nop>= signs to the words, e.g. take away spaces.
d144 2
a145 2
 *Verbatim Mode:* <br>
 Surround code excerpts and other formatted text with =&lt;verbatim&gt;= and =&lt;/verbatim&gt;= tags. <br> __Note:__ Use =&lt;pre&gt;= and =&lt;/pre&gt;= tags instead if you want that HTML code is interpreted. <br> __Note:__ Each tag must be on a line by itself.
d170 1
a170 1
 *Separator:* <br>
d184 1
a184 1
 *List Item:* <br>
d198 1
a198 1
 *Nested List Item:* <br>
d212 1
a212 1
 *Ordered List:* <br>
d228 2
a229 2
 *Definition List:* <br>
 Three spaces, the term, a colon, a space, followed by the definition. <br>
d245 7
a251 7
 *Table:* <br>
 Optional spaces followed by the cells enclosed in vertical bars. <br>
__Note:__ =| <nop>*bold*<nop> |= cells are rendered as table headers. <br>
__Note:__ =|	spaced	|= cells are rendered center aligned. <br>
__Note:__ =|	  spaced |= cells are rendered right aligned. <br>
__Note:__ =| 2 colspan ||= cells are rendered as multi-span columns. <br>
__Note:__ In case you have a long row and you want it to be more readable when you edit the table you can split the row into lines that end with a ='\'= backslash character. <br>
d259 1
a259 3
| A4 \<nop>
  | next \<nop>
  | next |
d267 1
a267 3
| A4 \
  | next \
  | next |
d272 2
a273 2
 *<nop>WikiWord Links:* <br>
 <nop>CapitalizedWordsStuckTogether (or 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=.
d291 3
a293 2
 *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; i.e. =[<nop>[text formatting FAQ]]= links to topic TextFormattingFAQ.  You can also refer to a different web and use anchors.
d310 5
a314 2
 *Specific Links:* <br>
 Create a link where you can specify the link text and the link reference separately, using nested square brackets like =[<nop>[reference][text]]=. Internal link references (i.e. WikiSyntax) and external link references (i.e. http://TWiki.org/) are supported. The same __Forced Links__ rules apply for internal link references. Anchor names can be added as well, like =[<nop>[WebHome#MyAnchor][go home]]= and =[<nop>[http://www.yahoo.com/#somewhere][Yahoo!]]=.
d321 2
d329 2
d335 1
a335 15
 *Easier External Links:* <br>
 An easier syntax for external links is now available: =[<nop>[externalURL text]]= - just hit the spacebar to separate the link URL from the descriptive text, e.g. =[<nop>[http://gnu.org/ GNU]]=. This also supports anchors, e.g. =[<nop>[http://www.yahoo.com/#somewhere Yahoo!]]=.
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<pre>
[[http://gnu.org GNU]]
</pre>
</font></span>
</td><td valign="top">
[[http://gnu.org GNU]]
</td>
</tr>
<tr bgcolor="#ffffff">
<td valign="top">
 *Anchors:* <br>
d372 3
a374 1
 You can disable automatic linking of WikiWords by surrounding text with =&lt;noautolink&gt;= and =&lt;/noautolink&gt;= 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 =&lt;/noautolink&gt;= tag (known issue of the TablePlugin).
d391 18
d416 1
d421 1
d445 1
a445 1
		* You can also write =[<nop>[http://yahoo.com Yahoo home page]]= as an easier way of doing external links with descriptive text for the link, such as [[http://yahoo.com Yahoo home page]].
d462 7
a470 2
	* TWikiPreferences defines site-wide variables like colors. For example, write: =<span style='background : #FFFFCC;'><font color="#990000"> %<nop>RED% Red %<nop>ENDCOLOR% and %<nop>BLUE% blue %<nop>ENDCOLOR% colors</font></span>= to get: %RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors.

d494 1
a494 1
-- Main.PeterThoeny - 02 May 2002
@


1.34
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1023240420" format="1.0" version="1.34"}%
d366 1
a366 1
 *Prevent a Link:* <br>
d376 20
@


1.33
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1020375710" format="1.0" version="1.33"}%
d41 1
a41 1
 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 =%<nop>TOC%= variable, see TWikiVariables.
d292 2
a293 1
<td valign="top">#SquareBrackets
a377 2
</table>
</td></tr>
@


1.32
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="RichardDonkin" date="1018013809" format="1.0" version="1.32"}%
d416 18
a444 1
-- Main.MikeMannix - 02 Dec 2001
d446 3
a448 1
Updated to cover TWiki:Codev/EasierExternalLinking (in the alpha release).
d450 2
a451 1
-- Main.RichardDonkin - 26 Mar 2002	
d453 2
a454 1
Latest updates to this topic are in the main TWiki, since that's got the <nop>TWikiAlphaRelease code.
d456 2
a457 1
-- Main.RichardDonkin - 05 Apr 2002	
@


1.31
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="RichardDonkin" date="1017131194" format="1.0" version="1.31"}%
d431 5
a435 1
-- Main.RichardDonkin - 26 Mar 2002	
@


1.30
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="1007352711" format="1.0" version="1.30"}%
d329 14
d413 3
d427 5
a431 1
-- Main.MikeMannix - 02 Dec 2001
@


1.29
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="1007280439" format="1.0" version="1.29"}%
d369 3
a371 1
You can use just about any HTML tag without a problem - however, to keep in mind:
d373 8
a380 2
		* __NOTE:__ TWiki converts shorthand notation to XHTML 1.0 for display. To copy a fully marked-up page, simply view source in your browser and save the contents.
		* __NOTE:__ The standard installation TWiki is compatible across a wide range of browsers and computer platforms. If this is important to you, remember that using browser-specific tags or any other mark-up that doesn't degrade well will reduce compatibility.
d410 1
a410 1
-- Main.MikeMannix - 02 Dec 2001
@


1.28
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="1002008223" format="1.0" version="1.28"}%
d4 1
a4 1
---+ Appendix C: Text Formatting Rules
d292 1
a292 2
<td valign="top">
#SquareBrackets
d392 1
a392 25
---++ TWiki Variables

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

	* =%<nop>TOC%= : Automatically generates a table of contents based on headings in a topic - see the top of this page for an example.

	* =%<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>=

	* There are many more variables, see *[[TWikiVariables]]*.

---++ 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 =&lt;filename&gt;= is not displayed. How can I show it as it is?
		* *A:* The ='&lt;'= and ='&gt;'= characters have a special meaning in HTML, they define HTML tags. You need to escape them, so write ='&amp;lt;'= instead of ='&lt;'=, and ='&amp;gt;'= instead of ='&gt;'=. <br> Example: Type ='prog &amp;lt;filename&amp;gt;'= to get ='prog &lt;filename&gt;'=.

	* *Q:* Why is the ='&amp;'= character sometimes not displayed?
		* *A:* The ='&amp;'= character has a special meaning in HTML, it starts a so called character entity, ex: ='&amp;copy;'= is the =&copy;= copyright character. You need to escape ='&amp;'= to see it as it is, so write ='&amp;amp;'= instead of ='&amp;'=. <br> Example: Type ='This &amp;amp; that'= to get ='This &amp; that'=.
d394 1
a394 1
---++ TWiki Plugins
d396 1
a396 1
Plugins provide additional text formatting capabilities and can extend the functionality of %WIKITOOLNAME% into many other areas. For example, one optional Plugin lets you create a basic spreadsheet in a similar way to tables. Available Plugins are located in the [[TWiki:Plugins][Plugins]] web on TWiki.org. Currently enabled plugins on here:
d402 1
a402 1
-- MikeMannix - 02 Oct 2001 <br />
@


1.27
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="1000771966" format="1.0" version="1.27"}%
d4 1
a4 1
---+ TWiki Text Formatting
d417 1
a417 1
		* *A:* The ='&amp;'= character has a special meaning in HTML, it starts a so called character entity, i.e. ='&amp;copy;'= is the =&copy;= copyright character. You need to escape ='&amp;'= to see it as it is, so write ='&amp;amp;'= instead of ='&amp;'=. <br> Example: Type ='This &amp;amp; that'= to get ='This &amp; that'=.
d427 1
a427 1
-- MikeMannix - 30 Aug 2001
@


1.26
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="999839103" format="1.0" version="1.26"}%
d292 2
a293 1
<td valign="top">#SquareBrackets
@


1.25
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="999766220" format="1.0" version="1.25"}%
d7 1
d292 1
a292 1
<td valign="top">
d369 4
a372 1
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. 
d376 1
a376 1
Being able to create links without any formatting required is a core TWiki feature, made possible using WikiNames. With the latest version of TWiki linking rules, a simple extension of the syntax provides an new set of flexible linking options. 
d380 3
a382 2
	* 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!)
d386 2
a387 1
	* =http://...=, =https://...=, =ftp://...= and =mailto:...@@...= are linked automatically. 
d390 1
d394 7
a400 1
Variables are names that are enclosed in percent signs; they get expanded on the fly.
a401 3
	* =%<nop>TOC%= : The table of content, is based on headings in a topic.
	* =%<nop>WEB%= : The current web, is <b>%WEB%</b> .
	* =%<nop>TOPIC%= : The current topic name, is <b>%TOPIC%</b> .
a402 2
	* =%<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.
d404 3
a406 1
---++ "Gotchas" when Editing Text
d408 3
a410 1
The formatting rules are fairly simple to use and fast to type. However, there are some things to watch out for:
a417 2
	* See more TextFormattingFAQs

d420 1
a420 1
Plugins provide additional text formatting rules and can extend the functionality of %WIKITOOLNAME% into many other areas. Available Plugins are located in the [[TWiki:Plugins][Plugins]] web. Currently enabled plugins on this site are:
@


1.24
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="999762553" format="1.0" version="1.24"}%
d4 2
a5 1
It is easy to collaborate: just type in 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. This page is also available as quick reference pop-up window from a link in the Edit screen.
d7 1
a7 1
---++ Editing
d9 2
a10 4
<table border="0" cellpadding="0" cellspacing="1" bgcolor="#000000">
<tr><td>
<table border="0" cellpadding="3" cellspacing="0" bgcolor="#ffffff">
<tr>
d19 1
a19 1
<tr>
d37 1
a37 1
<tr>
d55 1
a55 1
<tr>
d69 1
a69 1
<tr>
d83 1
a83 1
<tr>
d97 1
a97 1
<tr>
d111 1
a111 1
<tr>
d125 1
a125 1
<tr>
d140 1
a140 1
<tr>
d166 1
a166 1
<tr>
d180 1
a180 1
<tr>
d194 1
a194 1
<tr>
d208 1
a208 1
<tr>
d224 1
a224 1
<tr>
d241 1
a241 1
<tr>
d272 1
a272 1
<tr>
d290 1
a290 1
<tr>
d308 1
a308 1
<tr>
d326 1
a326 1
<tr>
d348 1
a348 1
<tr>
a364 1

@


1.23
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="999757934" format="1.0" version="1.23"}%
d8 3
a10 1
<table border="1" cellpadding="3" cellspacing="1" bgcolor="#ffffff">
d364 3
@


1.22
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="999192384" format="1.0" version="1.22"}%
a5 15
---++ Links

Being able to create links without any formatting required is a core TWiki feature, made possible using WikiNames. With the latest version of TWiki linking rules, a simple extension of the syntax provides an new set of flexible linking options. 

---+++ 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.


d8 1
a8 1
<table border="3" cellpadding="2" cellspacing="2">
d363 9
d373 2
a374 1
---++ Using HTML
d376 1
a376 1
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.
d378 2
a379 2
	* HTML 4.01 Reference Specification: http://www.w3.org/TR/html4/
	* Quick reference of all HTML elements: http://werbach.com/barebones/barebones.html
@


1.21
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="999166231" format="1.0" version="1.21"}%
d4 1
a4 1
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. This page is available in a pop-up window when in Edit mode.
d8 1
a8 1
Being able to create links without any formating required is a core TWiki feature, made possible using WikiNames. With the latest version of TWiki linking rules, by adding a few extra symbols, you can have even more powerful linking control. 
d10 1
a10 1
---+++ %WIKITOOLNAME% Internal Links
d15 1
a15 1
---+++ Remote Site Links
d410 1
a410 1
---++ %WIKITOOLNAME% Plugins
d412 1
a412 1
Plugins offer additional text formatting rules and extend the functionality of %WIKITOOLNAME%. Currently enabled plugins are:
d416 3
a418 1
Learn more about plugins in TWikiPlugins and TWikiPreferences.
@


1.20
log
@none
@
text
@d1 4
a4 4
%META:TOPICINFO{author="PeterThoeny" date="997515680" format="1.0beta2" version="1.20"}%
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.

%TOC{depth="2"}%
d8 1
a8 1
The Collaborative Work Area is a bunch of related links that are editable through your web browser. 
d15 1
a15 1
---+++ External Links
@


1.19
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{version="1.19" date="995100495" author="PeterThoeny" format="1.0beta2"}%
d241 1
a241 1
 Three spaces, the term, a colon, followed by the definition. <br>
@


1.18
log
@none
@
text
@d1 1
d412 1
a412 1
%WIKITOOLNAME% Plugins offer additional text formatting rules. Plugins currently installed are:
d414 1
a414 2
	* DefaultPlugin: The default plugin is used for some depreciated rendering of older TWiki versions.
	* 
@


1.17
log
@none
@
text
@d3 3
a5 1
---++ LINKS
d9 1
a9 1
The %WIKITOOLNAME% web has the following types of __internal links:__
d14 1
a14 1
---+++ External links:
d20 1
a20 1
---++ EDITING
d57 1
a57 1
---++ Sushi
d59 1
a59 1
---+++ Maguro
d63 1
a63 1
---++ Sushi
d65 1
a65 1
---+++ Maguro
d378 1
a378 1
---++ HTML
d382 2
a383 2
	* 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
d386 1
a386 1
---++ WIKI VARIABLES
d390 1
d397 11
d409 1
a409 1
---++ %WIKITOOLNAME% PLUGINS
@


1.16
log
@none
@
text
@d256 5
a260 1
__Note:__ In case you have a long row and you want it to be more readable when you edit the table you can split the row into lines that end with a ='\'= backslash character.
d264 5
a268 3
| A1 | B1 | C1 |
| A2 | B2 | C2 |
| A3 \<nop>
d274 5
a278 3
| A1 | B1 | C1 |
| A2 | B2 | C2 |
| A3 \
@


1.15
log
@none
@
text
@d3 1
a3 1
*LINKS*
d12 1
a12 1
__External links:__
d17 2
a18 1
*EDITING*
d368 1
a368 1
*HTML*
d375 2
a376 1
*WIKI VARIABLES*
d385 10
@


1.14
log
@none
@
text
@d49 18
d179 1
a179 1
 At least four dashes at the beginning of a line.
d313 1
a313 1
 Create a link where you can specify the link text and the link reference separately, using nested square brackets like =[<nop>[text][reference]]=. Internal link references (i.e. WikiSyntax) and external link references (i.e. http://TWiki.org/) are supported. The same __Forced Links__ rules apply for internal link references. Anchor names can be added as well, like =[<nop>[go home][WebHome@@MyAnchor]]= and =[<nop>[Yahoo!][http://www.yahoo.com/#somewhere]]=.
d317 1
a317 1
[[syntax][WikiSyntax]]
d319 1
a319 1
[[GNU][http://gnu.org]]
d323 1
a323 1
[[syntax][WikiSyntax]]
d325 1
a325 1
[[GNU][http://gnu.org]]
d331 1
a331 1
 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 WikiWord. To __link to__ an anchor name use the =[<nop>[MyTopic@@MyAnchor]]= syntax. You can omit the topic name if you want to link within the same topic.
d335 1
a335 1
[[WebHome@@NotThere]]
d337 1
a337 1
[[Jump][@@MyAnchor]]
d339 1
a339 1
@@MyAnchor To here
d343 1
a343 1
[[WebHome@@NotThere]]
d345 1
a345 1
[[Jump][@@MyAnchor]]
d347 1
a347 1
@@MyAnchor To here
@


1.13
log
@none
@
text
@d36 1
a36 1
 1st paragraph
d38 1
a38 1
 2nd paragraph
d42 1
a42 1
 1st paragraph
d44 1
a44 1
 2nd paragraph
d54 1
a54 1
 *Bold*
d58 1
a58 1
 *Bold*
d68 1
a68 1
 _Italic_
d72 1
a72 1
 _Italic_
d82 1
a82 1
 __Bold italic__
d86 1
a86 1
 __Bold italic__
d96 1
a96 1
 =Fixed font=
d100 1
a100 1
 =Fixed font=
d110 1
a110 1
 ==Bold fixed==
d114 1
a114 1
 ==Bold fixed==
d123 2
a124 2
 _This works_,
 _this not _
d128 2
a129 2
 _This works_,
 _this not _
d263 3
a265 2
 WebNotify,
 Know.ReadmeFirst
d269 3
a271 2
 WebNotify,
 Know.ReadmeFirst
d277 37
a313 1
 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; i.e. =[<nop>[text formatting FAQ]]= links to topic TextFormattingFAQ.  You can also refer to a different web.
d317 5
a321 2
 [[wiki syntax]],
 [[%MAINWEB%.TWiki users]]
d325 5
a329 2
 [[wiki syntax]],
 [[%MAINWEB%.TWiki users]]
d339 1
a339 1
 &lt;nop&gt;SunOS
d343 1
a343 1
 <nop>SunOS
@


1.12
log
@none
@
text
@d236 2
a237 1
 Optional spaces followed by the cells enclosed in vertical bars.
d243 3
d251 3
a299 20
</td>
</tr>
<tr>
<td valign="top">
 *Disable Links:* <br>
 You can disable automatic linking of WikiWords by surround text with =&lt;noautolink&gt;= and =&lt;/noautolink&gt;= tags. <br> __Note:__ Each tag must be on a line by itself.
</td><td valign="top">
<span style='background : #FFFFCC;'><font color="#990000">
<verbatim>
 <noautolink>
 RedHat &
 SuSE
 </noautolink>
</verbatim>
</font></span>
</td><td valign="top">
 <noautolink>
 RedHat &
 SuSE
 </noautolink>
@


1.11
log
@none
@
text
@d19 297
a315 23
	* <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 <b>=</b> equal signs
	* Words get shown in ==bold fixed font== by enclosing them in <b>==</b> double 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;
@


1.10
log
@none
@
text
@d25 2
a26 1
	* Words get shown in =fixed font= by enclosing them in = equal signs
@


1.9
log
@none
@
text
@d38 2
a39 1
	* Definition:  3 spaces, the term, a colon, followed by the definition.
@


1.8
log
@none
@
text
@d1 1
a1 1
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.
d10 1
a10 1
	* 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!)
@


1.7
log
@none
@
text
@d7 1
a7 1
The TWiki web has the following types of __internal links:__
d14 2
a15 2
	* <code>http://...</code>, <code>https://...</code>, <code>ftp://...</code> and <code>mailto:...@@...</code> are linked automatically. 
	* Email addresses like <code> name@@domain.com </code> are linked automatically.
d20 1
a20 1
	* 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>[Main.TWiki users]]= points to Main.TWikiUsers in the Main web. 
d56 1
a56 1
	* =%<nop>INCLUDE{"SomeTopic"}%= : Server side include, includes another topic. The current %WIKITOOLNAME% web is the default web. Example: =<b>%<nop>INCLUDE{"TWiki.TWikiWebsTable"}%</b>= </td>
@


1.6
log
@none
@
text
@d9 1
a9 1
	* GoodStyle is a topic that is part of the current TWiki web. 
a10 2
	* Know.ReadmeFirst is a topic in a different TWiki web. (You write it as _Web.TopicName_ , but it will show up as _TopicName_ )
	* 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. You can also refer to a different web, i.e. =[<nop>[Main.TWiki users]]= points to Main.TWikiUsers in the Main web. 
d19 2
a20 1
	* <NOP>CapitalizedWordsStuckTogether will produce a link automatically. 
@


1.5
log
@none
@
text
@d7 1
a7 1
The TWiki web has the following types of internal links: 
d12 1
d14 1
a14 1
External links:
@


1.4
log
@none
@
text
@d20 1
a20 1
	* CapitalizedWordsStickedTogether will produce a link automatically. 
d34 6
a39 6
	* 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 | ... |
d42 6
a47 5
*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
d51 1
a51 1
Variables are names enclosed in percent signs that gets expanded on the fly.
d56 1
a56 1
	* =%<nop>INCLUDE{"file.ext"}%= : Server side include, includes the text of a file. The default directory is the current Wiki web. Example: =<b>%<nop>INCLUDE{"Know/TopicName.txt"}%</b>= </td>
@


1.3
log
@none
@
text
@d50 7
a56 1
%INCLUDE{"TWikiVariables.txt"}%
@


1.2
log
@none
@
text
@d20 1
a20 1
	* CapitalizedWordsWillProduce a link automatically. 
d22 5
a26 5
	* Words get *bold* by enclosing them with <b>*</b> asterisks
	* Words get _italic_ by enclosing them with <b>_</b> underscores
	* Words get __bold italic__ by enclosing them with <b>__</b> two underscores
	* Words get showns in =fixed font= by enclosing it with = equal signs
	* Notes for *bold* , _italic_ , __bold italic__ and =fixed font= text:
d39 2
d50 1
a50 1
%INCLUDE:"TWikiVariables.txt"%
@


1.1
log
@none
@
text
@d22 12
a33 3
	* words get *bold* by enclosing it with * asterisks
	* words get _italic_ by enclosing it with _ underscores
	* words get showns in =fixed font= by enclosing it with = equal signs
@
