wiki-archive/twiki/data/TWiki/WikiSyntax.txt,v

742 lines
22 KiB
Plaintext

head 1.19;
access;
symbols;
locks; strict;
comment @# @;
1.19
date 2007.01.16.04.12.05; author TWikiContributor; state Exp;
branches;
next 1.18;
1.18
date 2006.04.01.05.55.27; author TWikiContributor; state Exp;
branches;
next 1.17;
1.17
date 2006.02.01.12.01.22; author TWikiContributor; state Exp;
branches;
next 1.16;
1.16
date 2003.09.04.04.43.31; author PeterThoeny; state Exp;
branches;
next 1.15;
1.15
date 2003.02.01.10.01.35; author PeterThoeny; state Exp;
branches;
next 1.14;
1.14
date 2003.01.04.21.29.00; author PeterThoeny; state Exp;
branches;
next 1.13;
1.13
date 2002.04.21.05.46.52; author PeterThoeny; state Exp;
branches;
next 1.12;
1.12
date 2001.12.03.07.23.00; author MikeMannix; state Exp;
branches;
next 1.11;
1.11
date 2001.12.02.13.02.19; author MikeMannix; state Exp;
branches;
next 1.10;
1.10
date 2001.12.02.06.55.52; author MikeMannix; state Exp;
branches;
next 1.9;
1.9
date 2001.10.01.19.05.43; author MikeMannix; state Exp;
branches;
next 1.8;
1.8
date 2001.09.16.06.18.59; author MikeMannix; state Exp;
branches;
next 1.7;
1.7
date 2001.09.14.04.08.20; author MikeMannix; state Exp;
branches;
next 1.6;
1.6
date 2001.09.14.01.34.21; author MikeMannix; state Exp;
branches;
next 1.5;
1.5
date 2001.08.30.21.18.34; author MikeMannix; state Exp;
branches;
next 1.4;
1.4
date 2001.08.30.13.16.48; author MikeMannix; state Exp;
branches;
next 1.3;
1.3
date 2001.02.01.01.03.52; author PeterThoeny; state Exp;
branches;
next 1.2;
1.2
date 2000.12.10.22.42.13; author PeterThoeny; state Exp;
branches;
next 1.1;
1.1
date 2000.07.01.05.11.03; author PeterThoeny; state Exp;
branches;
next ;
desc
@none
@
1.19
log
@buildrelease
@
text
@%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="19"}%
---# TWiki Shorthand Basics
If you can enter text, you're ready for TWiki. With a few simple, intuitive TextFormattingRules, you'll be able to use plain text to create well-styled postings, instantly. Here's a fast-track guide to shorthand basics...
%STARTINCLUDE%
* Separate each *paragraph* with a blank line.
* To display a word or phrase in *bold type*, put it in asterisks: =*bold type*=.
* To display a word or phrase in _italic_, put it in underscores: =_italic_=.
* To display a word or phrase in __bold italic__, put it in _double_ underscores: =__bold italic__=.
* To link to another Wiki topic, type the WikiWord for that topic. To link to a Wiki topic in another web, type the name of the web, and a dot, first: =Sandbox.<nop>%HOMETOPIC%=.
* If you enter a WikiWord for a topic that doesn't exist, it'll appear highlighted, with question mark at the end, prompting you (or someone else) to start off the new topic by clicking the *?* - NewTopic (click the *?*, but don't save, to preserve the example!).
* When entering <nop>WikiName signatures - like, <nop>%USERNAME% - include "%MAINWEB%." as a prefix, since all TWiki member pages are in the %MAINWEB% web: =%MAINWEB%.YourName=.
* For an external link, type the full URL: =http://twiki.org/=.
* To prevent a <nop>WikiWord from becoming a link, type =&lt;nop&gt;= or an exclamation point first: ==&lt;nop&gt;NoLinkPlease== or ==!NoLinkPlease==.
* To indent with a bullet, enter =[space][space][space][asterisk][space]=.
* Use multiples of 3 spaces to start *nested bullets*.
* That's 3-6-9-...
* To create a numbered list:
1 Start items in a *numbered list* with =[space][space][space][1][space]=.
1 The "1" (or *any number*) will be replaced by the correct number, in order.
1 To add a new paragraph without restarting list numbering, use the %<nop>BR% variable, like below:%BR% Text added (in new paragraph)
1 and list numbering continues.
* Always start *counting* spaces for bullets and such from the beginning of a new line.
* To include an image, type its URL. You also can Attach an image to the page and display it with text <br /> =%<nop>ATTACHURL%/yourimagefilename.jpg=
* To display a word or phrase in =MONOSPACED TYPE=, put it in equal signs: =<nop>=like this==. <br />Use =<nop>=<nop>=two=== for bold: ==bold mono==.
* Use ==&lt;verbatim&gt;== to enclose code excerpts, filenames, and other unformatted text:%BR%
=<b>&lt;verbatim&gt;</b>= %BR%
=unformatted text!= %BR%
=<b>&lt;/verbatim&gt;</b>= %BR%%BR%
__%X% NOTE:__ VARIABLES can be set within verbatim tags, that is, they are not disabled
* Use ==&lt;literal&gt;== to enclose anything that TWiki must not touch under any circumstances, such as in-line HTML code.
* Follow GoodStyle recommendations when editing topics.
* See TextFormattingRules for the complete set of formatting rules.
@
1.18
log
@buildrelease
@
text
@d1 1
a1 1
%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="18"}%
d48 1
a48 1
* Three (or more) consecutive *hyphens* expand into a horizontal rule:%BR% =---=
@
1.17
log
@buildrelease
@
text
@d1 1
a1 1
%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="17"}%
d8 1
a8 1
* Separate each *paragraph* with a blank line.
d10 1
a10 1
* To display a word or phrase in *bold type*, put it in asterisks: =*bold type*=.
d12 1
a12 1
* To display a word or phrase in _italic_, put it in underscores: =_italic_=.
d14 1
a14 1
* To display a word or phrase in __bold italic__, put it in _double_ underscores: =__bold italic__=.
d16 1
a16 1
* To link to another Wiki topic, type the WikiWord for that topic. To link to a Wiki topic in another web, type the name of the web, and a dot, first: =Sandbox.<nop>%HOMETOPIC%=.
d18 3
a20 3
* If you enter a WikiWord for a topic that doesn't exist, it'll appear highlighted, with question mark at the end, prompting you (or someone else) to start off the new topic by clicking the *?* - NewTopic (click the *?*, but don't save, to preserve the example!).
* When entering <nop>WikiName signatures - like, <nop>%USERNAME% - include "%MAINWEB%." as a prefix, since all TWiki member pages are in the %MAINWEB% web: =%MAINWEB%.YourName=.
d22 1
a22 1
* For an external link, type the full URL: =http://twiki.org/=.
d24 1
a24 1
* To prevent a <nop>WikiWord from becoming a link, type =&lt;nop&gt;= or an exclamation point first: ==&lt;nop&gt;NoLinkPlease== or ==!NoLinkPlease==.
d26 3
a28 3
* To indent with a bullet, enter =[space][space][space][asterisk][space]=.
* Use multiples of 3 spaces to start *nested bullets*.
* That's 3-6-9-...
d30 5
a34 5
* To create a numbered list:
1 Start items in a *numbered list* with =[space][space][space][1][space]=.
1 The "1" (or *any number*) will be replaced by the correct number, in order.
1 To add a new paragraph without restarting list numbering, use the %<nop>BR% variable, like below:%BR% Text added (in new paragraph)
1 and list numbering continues.
d36 1
a36 1
* Always start *counting* spaces for bullets and such from the beginning of a new line.
d38 1
a38 1
* To include an image, type its URL. You also can Attach an image to the page and display it with text <br /> =%<nop>ATTACHURL%/yourimagefilename.jpg=
d40 1
a40 1
* To display a word or phrase in =MONOSPACED TYPE=, put it in equal signs: =<nop>=like this==. <br />Use =<nop>=<nop>=two=== for bold: ==bold mono==.
d42 5
a46 5
* Use ==&lt;verbatim&gt;== to enclose code excerpts, filenames, and other unformatted text:%BR%
=<b>&lt;verbatim&gt;</b>= %BR%
=unformatted text!= %BR%
=<b>&lt;/verbatim&gt;</b>= %BR%%BR%
__%X% NOTE:__ VARIABLES can be set within verbatim tags, that is, they are not disabled
d48 1
a48 1
* Three (or more) consecutive *hyphens* expand into a horizontal rule:%BR% =---=
d50 1
a50 1
* Follow GoodStyle recommendations when editing topics.
d52 1
a52 1
* See TextFormattingRules for the complete set of formatting rules.
@
1.16
log
@none
@
text
@d1 52
a52 51
%META:TOPICINFO{author="PeterThoeny" date="1062650611" format="1.0" version="1.16"}%
---# TWiki Shorthand Basics
If you can enter text, you're ready for TWiki. With a few simple, intuitive TextFormattingRules, you'll be able to use plain text to create well-styled postings, instantly. Here's a fast-track guide to shorthand basics...
%STARTINCLUDE%
* Separate each *paragraph* with a blank line.
* To display a word or phrase in *bold type*, put it in asterisks: =*bold type*=.
* To display a word or phrase in _italic_, put it in underscores: =_italic_=.
* To display a word or phrase in __bold italic__, put it in _double_ underscores: =__bold italic__=.
* To link to another Wiki topic, type the WikiWord for that topic. To link to a Wiki topic in another web, type the name of the web, and a dot, first: =Sandbox.<nop>%HOMETOPIC%=.
* If you enter a WikiWord for a topic that doesn't exist, it'll appear highlighted, with question mark at the end, prompting you (or someone else) to start off the new topic by clicking the *?* - NewTopic (click the *?*, but don't save, to preserve the example!).
* When entering <nop>WikiName signatures - like, <nop>%USERNAME% - include "%MAINWEB%." as a prefix, since all TWiki member pages are in the %MAINWEB% web: =%MAINWEB%.YourName=.
* For an external link, type the full URL: =http://twiki.org/=.
* To prevent a <nop>WikiWord from becoming a link, type =&lt;nop&gt;= first, ==&lt;nop&gt;NoLinkPlease==.
* To indent with a bullet, enter =[space][space][space][asterisk][space]=.
* Use multiples of 3 spaces to start *nested bullets*.
* That's 3-6-9-...
1 Start items in a *numbered list* with =[space][space][space][1][space]=.
1 The "1" (or *any number*) will be replaced by the correct number, in order.
1 To add a new paragraph without restarting list numbering, use the %<nop>BR% variable, like below:%BR% Text added (in new paragraph)
1 and list numbering continues.
* Always start *counting* spaces for bullets and such from the beginning of a new line.
* To include an image, type its URL. You also can Attach an image to the page and display it with text <br /> =%<nop>ATTACHURL%/yourimagefilename.jpg= .
* To display a word or phrase in =MONOSPACED TYPE=, put it in equal signs: =<nop>=like this==. <br />Use =<nop>=<nop>=two=== for bold: ==bold mono==.
* Use ==&lt;verbatim&gt;== to enclose code excerpts, filenames, and other unformatted text, with the opening and closing tags on their own separate lines:
<blockquote style="background-color:#f5f5f5">
<pre>
<b>&lt;verbatim&gt;</b>
unformatted text!
<b>&lt;/verbatim&gt;</b>
</pre>
</blockquote>
* Three (or more) consecutive *hyphens* expand into a horizontal rule:%BR% =---=
* See TextFormattingRules for the complete set of formatting rules.
@
1.15
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1044093695" format="1.0" version="1.15"}%
d5 2
@
1.14
log
@none
@
text
@d1 2
a2 2
%META:TOPICINFO{author="PeterThoeny" date="1041715740" format="1.0" version="1.14"}%
---# <nop>TWikiShorthand Basics
d4 1
a4 1
If you can enter text, you're ready for TWiki. With a few simple, intuitive TWikiShorthand rules, you'll be able to use plain text to create well-styled postings, instantly. Here's a fast-track guide to shorthand basics...
d49 1
a49 1
* See TWikiShorthand for the complete set of formatting rules.
@
1.13
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1019368012" format="1.0" version="1.13"}%
d18 1
a18 1
* When entering <nop>WikiName signatures - like, <nop>%USERNAME% - include the %MAINWEB% as a prefix, since all TWiki member pages are in the %MAINWEB% web: =Main.YourName=.
d20 1
a20 1
* For an external link, type the full URL: =http://twiki.org=.
d29 2
d32 1
a32 1
* Start *counting spaces* for bullets from the beginning of a new line.
d34 1
a34 1
* To include an image, type its URL. You also can Attach an image to the page and display it with text <br />=%<nop>ATTACHURL%/yourimagefilename.jpg=.
d38 1
a38 1
* Use ==&lt;pre&gt;== to enclose code excerpts, filenames, and other unformatted text, with the opening and closing tags on their own separate lines:
d41 1
a41 1
<b>&lt;pre&gt;</b>
d43 1
a43 1
<b>&lt;/pre&gt;</b>
d47 1
a47 2
* Three (or more) consecutive *hyphens* expand into a horizontal rule: =---=
---
@
1.12
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="1007364180" format="1.0" version="1.12"}%
d14 1
a14 1
* To link to another Wiki topic, type the WikiWord for that topic. To link to a Wiki topic in another web, type the name of the web, and a dot, first: =Test.<nop>%HOMETOPIC%=.
d18 1
a18 1
* When entering <nop>WikiName signatures - like, %USERNAME% - include the %MAINWEB% as a prefix, since all TWiki member pages are in the %MAINWEB% web: =Main.YourName=.
@
1.11
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="1007298139" format="1.0" version="1.11"}%
d30 1
a30 1
* Always start *counting* for bullets and such from the beginning of a new line.
d45 2
a46 1
* Use three (or more) consecutive *hyphens* expands into a horizontal rule: =---=
a48 1
---
@
1.10
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="1007276152" format="1.0" version="1.10"}%
d36 2
d39 3
a41 4
Surround code excerpts, filenames, and other
unformatted text with &lt;pre&gt; or &lt;/pre&gt;
or the special TWiki use &lt;verbatim&gt; and
&lt;/verbatim&gt; tags.
d43 1
@
1.9
log
@none
@
text
@d1 2
a2 2
%META:TOPICINFO{author="MikeMannix" date="1001963143" format="1.0" version="1.9"}%
---# <nop>Instant TWiki Shorthand
d4 1
a4 1
If you can enter text, write an email, you're ready for TWiki. Use simple, intuitive TWiki shorthand to get even more control - instantly!
d15 2
d18 1
a18 3
* When entering WikiName signatures - like, %USERNAME% - include the %MAINWEB% as a prefix, since all TWiki member pages are in the %MAINWEB% web: =Main.YourName=.
* If you enter a WikiWord for a topic that doesn't exist, it appears highlighted, with a question mark link at the end, prompting you (or someone else) to start off the new topic by clicking the *?* - FreshTopic (try clicking the *?*, but don't save, or you'll create a ==<nop>FreshTopic== page and ruin this example).
d20 1
a20 1
* For an external link, type the full URL: =http://twiki.org= = http://twiki.org
d22 1
a22 1
* To prevent a WikiWord from becoming a link, type =&lt;nop&gt;= first, ==&lt;nop&gt;WikiWord== = <nop>WikiWord
d27 2
a28 2
1 Start items in a *numbered list* with =[space][space][space][1][space]=.
1 The "1" (or *any number*) will be replaced by the correct number, in order.
d30 1
a30 1
* Always start *counting spaces* for bullets and such from the beginning of a new line.
d34 1
a34 1
* To display a word or phrase in =MONOSPACED type=, put it in equal signs: =<nop>=like this==. <br />Use =<nop>=<nop>=two=== for bold: ==bold mono==.
d45 1
a45 1
* See [[TextFormattingRules][TWikiShorthand]] for more....
a46 2
-- MikeMannix - 01 Oct 2001 <br />
@
1.8
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="1000621139" format="1.0" version="1.8"}%
d15 2
d18 1
a18 3
* If you enter a WikiWord for a topic that doesn't exist, it'll appear highlighted, with question mark at the end, prompting you (or someone else) to start off the new topic by clicking the *?* - FreshTopic (click the *?*, but don't save, to preserve the example!).
* When entering <nop>WikiName signatures - like, %USERNAME% - include the %MAINWEB% as a prefix, since all TWiki member pages are in the %MAINWEB% web: =Main.YourName=.
d20 1
a20 1
* For an external link, type the full URL: =http://twiki.org=.
d22 1
a22 1
* To prevent a <nop>WikiWord from becoming a link, type =&lt;nop&gt;= first, ==&lt;nop&gt;NoLinkPlease==.
d26 3
a28 3
* Thats 3-6-9-...
1 Start items in a *numbered list* with =[space][space][space][1][space]=.
1 The "1" (or *any number*) will be replaced by the correct number, in order.
d30 1
a30 1
* Always start *counting* for bullets and such from the beginning of a new line.
d34 1
a34 1
* To display a word or phrase in =MONOSPACED TYPE=, put it in equal signs: =<nop>=like this==. <br />Use =<nop>=<nop>=two=== for bold: ==bold mono==.
d45 1
a45 1
* See TextFormattingRules for more....
d47 2
a48 1
-- MikeMannix - 14 Sep 2001 <br />
@
1.7
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="1000440500" format="1.0" version="1.7"}%
d44 2
a46 2
* See TextFormattingRules for more....
@
1.6
log
@none
@
text
@d1 2
a2 2
%META:TOPICINFO{author="MikeMannix" date="1000431367" format="1.0" version="1.6"}%
---# <nop>TWiki Shorthand, Quickly
d4 1
a4 1
If you can enter text, send an email, your ready for TWiki. Use some simple, intuitive TWiki shorthand, and you have even more control - instantly!
@
1.5
log
@none
@
text
@d1 4
a4 2
%META:TOPICINFO{author="MikeMannix" date="999206666" format="1.0" version="1.5"}%
---## <nop>TWiki Language by the Line
d8 1
a8 1
* To display a word or phrase in *bold type*, surround it by asterisks: =*bold type*=
d10 1
a10 1
* To display a word or phrase in _italic_, surround it by underscores: =_italic_=
d12 1
a12 1
* To display a word or phrase in __bold italic__, surround it by double underscores: =__bold italic__=
d14 1
a14 1
* *To link* to another Wiki topic, type the WikiWord for that topic. To link to a Wiki topic in another web, type the name of the web, a dot, and the <nop>WikiWord for that topic: ==Test.<nop>%HOMETOPIC%==.
d16 1
a16 1
* If you add a WikiWord for a topic that doesn't exist, you'll see a question mark after it, prompting you (or someone else) to edit the new topic: FreshTopic. Once edited, enter the new <nop>WikiName and it will appear as a link to the that page.
d18 1
a18 1
* When entering <nop>WikiName links, include the home web name as a prefix, ex: all TWiki member pages are in the Main web, so enter ==Main.YourName==.
d20 1
a20 1
* For an external link, just type the URL, starting with ==http://==.
d22 1
a22 1
* To prevent a <nop>WikiName from becoming a link, type =&lt;nop&gt;= first, ==&lt;nop&gt;NoLinkPlease==.
d24 5
a28 4
* To indent with a *bullet*, enter space-space-space-asterisk-space.
* Use a multiple of 3 spaces to start *nested bullets*.
1 Start items in a *numbered list* with space-space-space-1-space.
1 The "1" (or *any number*) will be replaced by the correct number in order.
d32 1
a32 1
* To include an *image*, type its URL. You also can Attach an image to the page and display it with text =%<nop>ATTACHURL%/yourimagefilename.jpg= .
d34 1
a34 1
* To display a word or phrase in =MONOSPACED TYPE=, surround it by '=' characters. Use two for bold: ==bold mono== .
d39 2
a40 1
&lt;verbatim&gt; and &lt;/verbatim&gt; tags.
d43 3
a45 1
* Use three or more consecutive *hyphens* for a horizontal rule: =---=
d47 1
a47 3
* To see the markup for any page, click on *Raw text* on the lower toolbar.
* See TextFormattingRules for more....
@
1.4
log
@none
@
text
@d1 4
a4 2
%META:TOPICINFO{author="MikeMannix" date="999177919" format="1.0" version="1.4"}%
* Separate each paragraph with a blank line.
d12 7
a18 1
* To link to another Wiki topic, type the WikiWord for that topic. To link to a Wiki topic in another web, type the name of the web, a dot, and the <nop>WikiWord for that topic: =Test.<nop>%HOMETOPIC%=.
d20 1
a20 1
* If you add a WikiWord for a topic that does not yet exist, you'll see a question mark after it, prompting you (or someone else) to edit the new topic: FreshTopic. After that's done, the <nop>WikiWord will be automatically recognized as a link to the new page.
d22 4
a25 1
* For an external hyperlink, just type the URL, starting with =http://=.
d27 1
a27 4
* Start a bullet point with space-space-space-asterisk-space.
* Use a multiple of 3 spaces to start nested bullets.
1 Start items in a numbered list with space-space-space-1-space.
1 The "1" will be replaced by the correct number
d29 1
a29 1
* To include an image inline, just type its URL. You also can attach an image to the page and display it with text =%<nop>ATTACHURL%/imagefile.jpg= .
d33 5
a37 5
<verbatim>
Surround code excerpts and other
formatted text with
&lt;verbatim&gt; and &lt;/verbatim&gt; tags.
</verbatim>
d39 1
a39 1
* Use three consecutive hyphens for a horizontal rule: =---=
d43 1
a43 1
* See TextFormattingRules for more detail.
@
1.3
log
@none
@
text
@d1 2
a2 1
Separate each paragraph with a blank line.
d4 1
a4 1
To display a word or phrase in *bold type*, surround it by asterisks.
d6 1
a6 1
To display a word or phrase in _italic_, surround it by underscores.
d8 1
a8 1
To display a word or phrase in __bold italic__, surround it by double underscores.
d10 1
a10 1
To link to another Wiki topic, type the WikiWord for that topic. To link to a Wiki topic in another web, type the name of the web, a dot, and the <nop>WikiWord for that topic (i.e., =Test.<nop>%HOMETOPIC%=).
d12 1
a12 1
If you add a WikiWord for a topic that does not yet exist, you'll see a question mark after it, prompting you (or someone else) to edit the new topic. After that has been done, the <nop>WikiWord will be automatically recognized as a link to the new Wiki page.
d14 1
a14 1
For an external hyperlink, just type the URL ( starting with =http://= ).
a17 1
d19 1
a19 1
1 (The "1" will be replaced by the correct number).
d21 1
a21 1
To include an image inline, just type its URL. You also can attach an image to the page and display it with text =%<nop>ATTACHURL%/imagefile.jpg= .
d23 1
a23 1
To display a word or phrase in =MONOSPACED TYPE=, surround it by '=' characters.
d25 1
a25 1
<pre>
d29 1
a29 1
</pre>
d31 1
a31 1
Use five consecutive hyphens for a horizontal rule.
d33 1
a33 1
To see the markup for any page, click on "Edit" at the bottom of the page.
d35 1
a35 1
See TextFormattingRules for more detail.
@
1.2
log
@none
@
text
@d25 5
a29 1
<pre> Surround code excerpts and other<br> formatted text with<br> &lt;pre&gt; and &lt;/pre&gt; tags.</pre>
@
1.1
log
@none
@
text
@d3 1
a3 1
To display a word or phrase in *bold type* , surround it by asterisks.
d5 1
a5 1
To display a word or phrase in _italic_ , surround it by underscores.
d7 1
a7 1
To display a word or phrase in __bold italic__ , surround it by double underscores.
d9 1
a9 1
To link to another Wiki topic, type the WikiWord for that topic. (To link to a Wiki topic in another web type the name of the web, a dot and the <nop>WikiWord for that topic, i.e. =Test.<nop>WebHome= )
d23 1
a23 1
To display a word or phrase in =MONOSPACED TYPE= , surround it by '=' characters.
@