Difference: TextFormattingRules (1 vs. 49)

Sandbox

Anchors:
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 [[MyTopic#MyAnchor]] syntax. You can omit the topic name if you want to link within the same topic.

[[WikiWord#NotThere]]

[[#MyAnchor][Jump]]

#MyAnchor To here

To here

Forced Links:
You can create a forced internal link by enclosing words in double square brackets.
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, [[text formatting FAQ]] links to topic TextFormattingFAQ. You can also refer to a different web and use anchors.

To "escape" double square brackets that would otherwise make a link, prefix the leading left square bracket with an exclamation point.

[[wiki syntax]]

[[Main.TWiki users]]

escaped:
![[wiki syntax]]

escaped: [[wiki syntax]]

Specific Links:
You can create a link where you specify the link text and the URL separately using nested square brackets [[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.

Anchor names can be added as well, to create a link to a specific place in a topic.

[[WikiSyntax][wiki syntax]]

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

Prevent a Link:
Prevent a WikiWord from being linked by prepending it with an exclamation point.

!SunOS

SunOS

Disable Links:
You can disable automatic linking of WikiWords by surrounding text with <noautolink> and </noautolink> tags.

It is possible to turn off all auto-linking with a NOAUTOLINK preferences setting.

 <noautolink>
 RedHat &
 SuSE
 </noautolink>

RedHat & SuSE

Mailto Links:
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 [[mailto:user@domain][descriptive text]].

a@b.com

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

[[mailto:?subject=\
Hi][Hi]]

a@b.com

Mail

Deleted:

<
<

Formatting Command:	You write:	You get:
Paragraphs: Blank lines will create new paragraphs.	1st paragraph

Deleted:

<
<

2nd paragraph

1st paragraph

2nd paragraph

Headings:
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 %TOC% variable. If you want to exclude a heading from the TOC, put !! after the ---+.

Empty headings are allowed, but won't appear in the table of contents.

---++ Sushi
---+++ Maguro
---+++!! Not in TOC

Sushi

Maguro

Not in TOC

Bold Text:
Words get shown in bold by enclosing them in * asterisks.

*Bold*

Bold

Italic Text:
Words get shown in italic by enclosing them in _ underscores.

_Italic_

Italic

Bold Italic:
Words get shown in bold italic by enclosing them in __ double-underscores.

__Bold italic__

Bold italic

Fixed Font:
Words get shown in fixed font by enclosing them in = equal signs.

=Fixed font=

Fixed font

Bold Fixed Font:
Words get shown in bold fixed font by enclosing them in double equal signs.

==Bold fixed==

Bold fixed

You can follow the closing bold, italic, or other (* _ __ = ==) indicator with normal punctuation, such as commas and full stops.

Make sure there is no space between the text and the indicators.

_This works_,
_this does not _

This works,
_this does not _

Verbatim (Literal) Text:
Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags.

verbatim tags disable HTML code. Use <pre> and </pre> tags instead if you want the HTML code within the tags to be interpreted.
NOTE: Preferences variables (* Set NAME = value) are set within verbatim tags.

<verbatim>
class CatAnimal {
  void purr() {
    <code here>
  }
}
</verbatim>

class CatAnimal {
  void purr() {
    <code here>
  }
}

Separator (Horizontal Rule):
Three or more three dashes at the beginning of a line..

-------

Bulleted List:
Multiple of three spaces, an asterisk, and another space.

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.

   * level 1
      * level 2
   * back on 1
   * A bullet
     broken over
     three lines
   * last bullet

level 1
- level 2
back on 1
A bullet broken over three lines
last bullet

Numbered List:
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...

   1. Sushi
   1. Dim Sum
   1. Fondue

   A. Sushi
   A. Dim Sum
   A. Fondue

   i. Sushi
   i. Dim Sum
   i. Fondue

Sushi
Dim Sum
Fondue

Sushi
Dim Sum
Fondue

Sushi
Dim Sum
Fondue

Definition List:
Three spaces, a dollar sign, the term, a colon, a space, followed by the definition.

   $ Sushi: Japan
   $ Dim Sum: S.F.

Sushi: Japan
Dim Sum: S.F.

Table:
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.

| *bold* | 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 |'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

The TablePlugin provides the |^| multiple-span row functionality and additional rendering features

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

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

WikiWord Links:
CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically if preceded by whitespace or parenthesis.

If you want to link to a topic in a different web write Otherweb.TopicName.

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 WebHome topic.

It's generally a good idea to use the TWikiVariables %TWIKIWEB% and %MAINWEB% instead of TWiki and Main.

WebStatistics

Sandbox.WebNotify

Sandbox.WebHome

WebStatistics

Sandbox

Anchors:
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 [[MyTopic#MyAnchor]] syntax. You can omit the topic name if you want to link within the same topic.

[[WikiWord#NotThere]]

[[#MyAnchor][Jump]]

#MyAnchor To here

To here

Forced Links:
You can create a forced internal link by enclosing words in double square brackets.
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, [[text formatting FAQ]] links to topic TextFormattingFAQ. You can also refer to a different web and use anchors.

To "escape" double square brackets that would otherwise make a link, prefix the leading left square bracket with an exclamation point.

[[wiki syntax]]

[[Main.TWiki users]]

escaped:
![[wiki syntax]]

escaped: [[wiki syntax]]

Specific Links:
You can create a link where you specify the link text and the URL separately using nested square brackets [[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.

Anchor names can be added as well, to create a link to a specific place in a topic.

[[WikiSyntax][wiki syntax]]

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

Prevent a Link:
Prevent a WikiWord from being linked by prepending it with an exclamation point.

!SunOS

SunOS

Disable Links:
You can disable automatic linking of WikiWords by surrounding text with <noautolink> and </noautolink> tags.

It is possible to turn off all auto-linking with a NOAUTOLINK preferences setting.

 <noautolink>
 RedHat &
 SuSE
 </noautolink>

RedHat & SuSE

Mailto Links:
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 [[mailto:user@domain][descriptive text]].

a@b.com

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

[[mailto:?subject=\
Hi][Hi]]

a@b.com

Mail

Using HTML

Changed:

<
< You can use just about any HTML tag without a problem. You can add HTML if there is no TWiki equivalent, for example, write <strike>deleted text</strike> to get ~~deleted text~~.

>
>

You can use just about any HTML tag without a problem. You can add HTML if there is no TWiki equivalent, for example, write <strike>deleted text</strike> to get ~~deleted text~~.

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 TWiki shorthand instead - this keeps the text uncluttered and easy to edit.
If you use HTML use XHTML 1.0 Transitional syntax.
Script tags may be filtered out, at the discretion of your TWiki administrator.

Recommendations when pasting HTML from other sources:

Copy only text between <body> and </body> tags.
Remove all empty lines. TWiki inserts <p /> 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 - <...> - 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.

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.

Deleted:

<
<

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 TWiki shorthand instead - this keeps the text uncluttered and easy to edit.
If you use HTML use XHTML 1.0 Transitional syntax.
Script tags may be filtered out, at the discretion of your TWiki administrator.

Recommendations when pasting HTML from other sources:

Copy only text between <body> and </body> tags.
Remove all empty lines. TWiki inserts <p /> 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 - <...> - 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.

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.

Script tags

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

Hyperlinks

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

Internal Links

Changed:

<
<

GoodStyle is a WikiWord that links to the GoodStyle topic located in the current web.

>
>

GoodStyle is a WikiWord that links to the GoodStyle topic located in the current web.

Changed:

<
<

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!)

>
>

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

Changed:

<
<

http://..., https://..., ftp://..., gopher://..., news://..., file://..., telnet://... and mailto:...@... are linked automatically.

>
>

http://..., https://..., ftp://..., gopher://..., news://..., file://..., telnet://... and mailto:...@... are linked automatically.

Changed:

<
<

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

>
>

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

Changed:

<
<

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

>
>

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

TWiki Variables

Changed:

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

>
>

TWiki Variables are names that are enclosed in percent signs % that are expanded on the fly. Some variables take arguments, such as %INCLUDE%. For those variables, the arguments are included in curly braces ({ and }).

Variable	In brief	Full documentation
`%TOC%`	Automatically generates a table of contents based on headings in a topic - see the top of this page for an example.	VarTOC
`%WEB%`	The current web, is TWiki.	VarWEB
`%TOPIC%`	The current topic name, is TextFormattingRules. <-- using BASETOPIC instead of TOPIC for the example because this document is normally included in TextFormattingRules -->	VarTOPIC
`%ATTACHURL%`	The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as `%ATTACHURL%/image.gif` to show the URL of the file or the image in your text.	VarATTACHURL
`%INCLUDE{"SomeTopic"}%`	Server side include, includes another topic. The current web is the default web. Example: `%INCLUDE{"TWiki.SiteMap"}%`	VarINCLUDE
`%SEARCH{"sushi"}%`	Inline search showing the search result embedded in a topic. FormattedSearch gives you control over formatting, useful for creating web-based applications.	VarSEARCH

TWikiPreferences defines some site-wide variables. Among them are:

Line break: Write %BR% to start a new line.
Colored text: Write: %RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors to get: Red and blue colors.

There are many more variables. To see them all, go to TWikiVariables.

Documentation Graphics: There are many graphics available to use in your topics. Use %ICON{"help"}%, %ICON{"tip"}%, and %ICON{"warning"}% to get: , , and , respectively. TWikiDocGraphics lists them all.

To "escape" a variable, prefix it with an exclamation mark. Write: !%SOMEVARIABLE% to get: %SOMEVARIABLE%.

Deleted:

<
<

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

%WEB% : The current web, is TWiki.

%TOPIC% : The current topic name, is TextFormattingRules.

%ATTACHURL% : The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as %ATTACHURL%/image.gif to show the URL of the file or the image in your text.

%INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current web is the default web. Example: %INCLUDE{"TWiki.SiteMap"}%

%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 %BR% to start a new line.
- Colored text: Write: %RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors to get: Red and blue colors.
- Documentation Graphics: Write: %H% Help, %T% Tip, %X% Alert to get: Help, Tip, Alert. For more info see TWikiDocGraphics.

There are many more variables, see TWikiVariables.

To "escape" a variable, prefix it with an exclamation mark. Write: !%SOMEVARIABLE% to get: %SOMEVARIABLE%.

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 Plugins web on TWiki.org.

Currently enabled plugins on this TWiki installation, as listed by %PLUGINDESCRIPTIONS%:

SpreadSheetPlugin (2018-07-05, $Rev: 30478 (2018-07-16) $): Add spreadsheet calculation like "$SUM( $ABOVE() )" to TWiki tables and other topic text
BackupRestorePlugin (2018-07-10, $Rev: 30551 (2018-07-16) $): Administrator utility to backup, restore and upgrade a TWiki site
ColorPickerPlugin (2018-07-05, $Rev: 30442 (2018-07-16) $): Color picker, packaged for use in TWiki forms and TWiki applications
CommentPlugin (2018-07-05, $Rev: 30530 (2018-07-16) $): Quickly post comments to a page without an edit/preview/save cycle
DatePickerPlugin (2018-07-05, $Rev: 30446 (2018-07-16) $): Pop-up calendar with date picker, for use in TWiki forms, HTML forms and TWiki plugins
EditTablePlugin (2018-07-05, $Rev: 30448 (2018-07-16) $): Edit TWiki tables using edit fields, date pickers and drop down boxes
HeadlinesPlugin (2018-07-13, $Rev: 30560 (2018-07-16) $): Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites
InterwikiPlugin (2018-07-05, $Rev: 30454 (2018-07-16) $): Write ExternalSite:Page to link to a page on an external site based on aliases defined in a rules topic
JQueryPlugin (2018-07-05, $Rev: 30456 (2018-07-16) $): jQuery JavaScript library for TWiki
PreferencesPlugin (2018-07-05, $Rev: 30528 (2018-07-16) $): Allows editing of preferences using fields predefined in a form
SetGetPlugin (2018-07-05, $Rev: 30472 (2018-07-16) $): Set and get variables and JSON objects in topics, optionally persistently across topic views
SlideShowPlugin (2018-07-05, $Rev: 30474 (2018-07-16) $): Create web based presentations based on topics with headings.
SmiliesPlugin (2018-07-05, $Rev: 30476 (2018-07-16) $): Render smilies as icons, like for :-) or for :eek:
TWikiSheetPlugin (2018-07-15, $Rev: 30604 (2018-07-16) $): Add TWiki Sheet spreadsheet functionality to TWiki tables
TablePlugin (2018-07-05, $Rev: 30480 (2018-07-16) $): Control attributes of tables and sorting of table columns
TagMePlugin (2018-07-05, $Rev: 30482 (2018-07-16) $): Tag wiki content collectively or authoritatively to find content by keywords
TinyMCEPlugin (2018-07-10, $Rev: 30541 (2018-07-16) $): Integration of the Tiny MCE WYSIWYG Editor
TwistyPlugin (2018-07-06, $Rev: 30497 (2018-07-16) $): Twisty section JavaScript library to open/close content dynamically
WatchlistPlugin (2018-07-10, $Rev: 30536 (2018-07-16) $): Watch topics of interest and get notified of changes by e-mail
WysiwygPlugin (2018-07-06, $Rev: 30528 (2018-07-16) $): Translator framework for WYSIWYG editors

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:

Changed:

<
<

Q: Text enclosed in angle brackets like <filename> is not displayed. How can I show it as it is?
- A: The '<' and '>' characters have a special meaning in HTML, they define HTML tags. You need to escape them, so write '<' instead of '<', and '>' instead of '>'.
  Example: Type 'prog <filename>' to get 'prog <filename>'.

>
>

Q: Text enclosed in angle brackets like <filename> is not displayed. How can I show it as it is?
- A: The '<' and '>' characters have a special meaning in HTML, they define HTML tags. You need to escape them, so write '<' instead of '<', and '>' instead of '>'.
  Example: Type 'prog <filename>' to get 'prog <filename>'.

Changed:

<
<

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. '©' is the © copyright character. You need to escape '&' to see it as it is, so write '&' instead of '&'.
  Example: Type 'This & that' to get 'This & that'.

>
>

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. '©' is the © copyright character. You need to escape '&' to see it as it is, so write '&' instead of '&'.
  Example: Type 'This & that' to get 'This & that'.

Deleted:

<
<

Revision 482005-03-27 - TWikiContributor

   TWiki Text Formatting 
  TWiki Editing Shorthand
   Using HTML 
  Script tags
 
   Hyperlinks 
  Internal Links
   External Links
 
   TWiki Variables
   TWikiPlugin Formatting Extensions
   Common Editing Errors
 
 


 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.
->
>
+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.
  TWiki Editing Shorthand
-<
<
->
>
->
>
-<
<
+ Formatting Command:

 Example: You write:

 You get:
- Formatting Command:
+ You get:
->
>
+ Formatting Command:


 You write:
- Formatting Command:
+ You write:
->
>
+ You get:
-<
<
->
>
  Paragraphs: 

 Blank lines will create new paragraphs.
-<
<
->
>
-<
<
 st paragraph

2nd paragraph
-<
<
->
>
-<
<
 st paragraph

2nd paragraph
-<
<
->
>
  Headings:
-<
<
+ 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 %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.
->
>
+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.
-<
<
+---++ Sushi
 ---++ Sushi
-<
<
+---+++ Maguro
->
>
+You can create a table of contents with the %TOC% variable. If you want to exclude a heading from the TOC, put !! after the ---+.
-<
<
+Sushi
 Sushi
-<
<
+Maguro
->
>
+ Empty headings are allowed, but won't appear in the table of contents.
->
>
+---++ Sushi
---+++ Maguro
---+++!! Not in TOC


Sushi
Maguro
Not in TOC
----++ Sushi
---+++ Maguro
---+++!! Not in TOC
+Sushi
Maguro
Not in TOC
-<
<
->
>
  Bold Text:
-<
<
+ Words get bold by enclosing them in * asterisks.
->
>
+ Words get shown in bold by enclosing them in * asterisks.
-<
<
 Bold
-<
<
->
>
-<
<
 Bold
-<
<
->
>
  Italic Text:
-<
<
+ Words get italic by enclosing them in _ underscores.
->
>
+ Words get shown in italic by enclosing them in _ underscores.
-<
<
 Italic
-<
<
->
>
-<
<
 Italic
-<
<
->
>
  Bold Italic:
-<
<
+ Words get _bold italic by enclosing them in _ double-underscores.
->
>
+ Words get shown in bold italic by enclosing them in __ double-underscores.
-<
<
 Bold italic
-<
<
->
>
-<
<
 Bold italic
-<
<
->
>
  Fixed Font: 

 Words get shown in fixed font by enclosing them in = equal signs.
-<
<
->
>
-<
<
 Fixed font
-<
<
->
>
-<
<
 Fixed font
-<
<
->
>
  Bold Fixed Font: 

 Words get shown in bold fixed font by enclosing them in  double equal signs.
-<
<
->
>
-<
<
 Bold fixed
-<
<
->
>
-<
<
 Bold fixed
-<
<
+ Note: Make sure there is no space between the text and the bold, italic, or other indicators (* _ __ = ==).
  Note: Make sure there is no space between the text and the bold, italic, or other indicators (* _ __ = ==).
->
>
+ You can follow the closing bold, italic, or other (* _ __ = ==) indicator
with normal punctuation, such as commas and full stops.

 Make sure there is no space between the text and the indicators.
  You can follow the closing bold, italic, or other (* _ __ = ==) indicator
with normal punctuation, such as commas and full stops.

 Make sure there is no space between the text and the indicators.
->
>
 This works,
-<
<
+_this not _
->
>
+_this does not _
-<
<
 This works,
-<
<
+_this not _
->
>
+_this does not _
-<
<
+ Verbatim Mode: 

 Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags. 
 Note: Use <pre> and </pre> tags instead if you want that HTML code is interpreted. 
 Note: Each tag must be on a line by itself.


<verbatim>
- Verbatim Mode: 

 Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags. 
 Note: Use <pre> and </pre> tags instead if you want that HTML code is interpreted. 
 Note: Each tag must be on a line by itself.
+<verbatim>
->
>
+ Verbatim (Literal) Text: 

 Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags.

 verbatim tags disable HTML code. Use <pre> and </pre> tags instead if you want the HTML code within the tags to be interpreted.

 NOTE: Preferences variables (* Set NAME = value) are set within verbatim tags.
  Verbatim (Literal) Text: 

 Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags.

 verbatim tags disable HTML code. Use <pre> and </pre> tags instead if you want the HTML code within the tags to be interpreted.

 NOTE: Preferences variables (* Set NAME = value) are set within verbatim tags.
->
>
 class CatAnimal? {
  void purr() {
-<
<
+	 <code here>
->
>
   }
}
-<
<
+</verbatim>
->
>
-<
<
 class CatAnimal {
  void purr() {
    <code here>
  }
}
-<
<
+ Separator: 

 At least three dashes at the beginning of a line.
  Separator: 

 At least three dashes at the beginning of a line.
->
>
+ Separator (Horizontal Rule): 

Three or more three dashes at the beginning of a line..
  Separator (Horizontal Rule): 

Three or more three dashes at the beginning of a line..
-<
<
-<
<
->
>
-<
<
-<
<
+ List Item: 

 Three spaces, an asterisk, and another space.
  List Item: 

 Three spaces, an asterisk, and another space.
->
>
+ Bulleted List: 

Multiple of three spaces, an asterisk, and another space.

 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.
  Bulleted List: 

Multiple of three spaces, an asterisk, and another space.

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


 
 bullet item
 




 Nested List Item: 

 Six, nine, ... spaces, an asterisk, and another space.
  bullet item
  Nested List Item: 

 Six, nine, ... spaces, an asterisk, and another space.
  level 1 
 level 2
-<
<
->
>
+ back on 1
  A bullet	  broken over
->
>
+	  three lines 
 last bullet
  level 1 
 level 2
->
>
+ back on 1
  A bullet	  broken over	  three lines
  last bullet
-<
<
+ Ordered List: 

 Three spaces, a number, a dot, and another space. Several types are available besides a number:
  Ordered List: 

 Three spaces, a number, a dot, and another space. Several types are available besides a number:
->
>
+Numbered List: 

Multiple of three spaces, a type character, a dot, and another space. Several types are available besides a number:
 Numbered List: 

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...
- Type
+ Sample Sequence
-.
+, 2, 3, 4...
- A.
+ A, B, C, D...
- a.
+ a, b, c, d...
- I.
+ I, II, III, IV...
- i.
+ i, ii, iii, iv...
-<
<
->
>
-<
<
  Sushi
  Dim Sum
->
>
+ Fondue
  Sushi
  Dim Sum
->
>
+ Fondue
  Sushi
  Dim Sum
-<
<
->
>
+ Fondue
  Sushi
  Dim Sum
->
>
+ Fondue
  Sushi
  Dim Sum
->
>
+ Fondue
  Sushi
  Dim Sum
->
>
+ Fondue
-<
<
->
>
  Definition List: 

 Three spaces, a dollar sign, the term, a colon, a space, followed by the definition.
-<
<
->
>
-<
<
  Sushi 
 Japan
  Dim Sum 
 S.F.
-<
<
->
>
-<
<
  Sushi 
 Japan
  Dim Sum 
 S.F.
-<
<
->
>
  Table:
-<
<
+ 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.
Notes:
•
 | *bold* | cells are displayed as table headers.
•
 |   center-spaced   | cells are displayed center aligned.
•
 |     right-spaced | cells are displayed right aligned.
•
 | 2 colspan || cells are displayed as multi-span columns (i.e., a cell with no text spans a column).
•
 |^| cells with a caret indicate follow-up rows of multi-span rows (this functionality is provided by TablePlugin).
•
 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 '\'.
•
 Table cells wrap automatically as determined by the browser.
->
>
+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. 
 | *bold* | 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 |'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
 The TablePlugin provides the |^| multiple-span row functionality and additional rendering features
-<
<
  L 
 C 
 R
- L
+ R
-<
<
+ A2 
 2 
 2 


 A3 
 3 
 3
  A2
  A3
->
>
+ A2 
 B2 
 C2 


 A3 
 B3 
 C3
- A2
+ C2
- A3
+ C3
  multi span
-<
<
+ A4-6 
 four 
 four
- A4-6
+ four
->
>
+ A5-7 
 5 
 5
  A5-7
-<
<
+ five 
 five
  five
  six 
 six
  six
-<
<
->
>
+ seven 
 seven 

| split  | over
  seven
->
>
+lines 


 A9 
 B9 
 C9
 lines
- A9
+ C9
  L 
 C 
 R
- L
+ R
-<
<
+ A2 
 2 
 2 


 A3 
 3 
 3
  A2
  A3
->
>
+ A2 
 B2 
 C2 


 A3 
 B3 
 C3
- A2
+ C2
- A3
+ C3
  multi span
-<
<
+ A4-6 
 four 
 four
- A4-6
+ four
->
>
+ A5-7 
 5 
 5
  A5-7
-<
<
+ five 
 five
  five
  six 
 six
  six
->
>
+ seven 
 seven 


 split 
 over 
 3 lines 


 A9 
 B9 
 C9
  seven
- split
+lines
- A9
+ C9
-<
<
->
>
  WikiWord Links:
-<
<
+ CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically. 
Note: In case you want to link to a topic in a different KoreaCmsWiki? web write Otherweb.TopicName. (The link label is the the name of the web in case the is WebHome, else it is the topic name)
->
>
+ CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically if preceded by whitespace or parenthesis. 

 If you want to link to a topic in a different web write Otherweb.TopicName. 

 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 WebHome topic.
-<
<
+WebNotify
-<
<
+TWikiUsers
->
>
+It's generally a good idea to use the TWikiVariables %TWIKIWEB% and %MAINWEB% instead of TWiki and Main.

WebStatistics
 WebStatistics
-<
<
+WebNotify
-<
<
+TWikiUsers
->
>
+WebNotify
->
>
+Sandbox



WebStatistics

WebNotify

Sandbox
 WebStatistics

WebNotify

Sandbox
-<
<
->
>
+ Anchors:
  Anchors:
->
>
+ 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 [[MyTopic#MyAnchor]] syntax. You can omit the topic name if you want to link within the same topic.

[[WikiWord#NotThere]]

[[#MyAnchor][Jump]]

#MyAnchor To here


WikiWord#NotThere

Jump

 To here
-[[WikiWord#NotThere]]

[[#MyAnchor][Jump]]

#MyAnchor To here
+WikiWord#NotThere

Jump

 To here
  Forced Links: 

 You can create a forced internal link by enclosing words in double square brackets.
-<
<
+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, [[text formatting FAQ]] links to topic TextFormattingFAQ.  You can also refer to a different web and use anchors.
 
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 ![[....
->
>
+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, [[text formatting FAQ]] links to topic TextFormattingFAQ.  You can also refer to a different web and use anchors.

 To "escape" double square brackets that would otherwise make a link, prefix the leading left square bracket with an exclamation point.
->
>
 wiki syntax
-<
<
+Main.TWiki users
->
>
+Main.TWiki users
 escaped:
[[wiki syntax]]
-<
<
->
>
-<
<
 wiki syntax
Main.TWiki users

escaped:
[[wiki syntax]]
-<
<
->
>
  Specific Links:
-<
<
+ Create a link where you can specify the link text and the link reference separately, using nested square brackets like [[reference][text]]. Internal link references (e.g. WikiSyntax) and external link references (e.g. http://TWiki.org/) are supported.
 
Note: The same Forced Links rules apply for internal link references.
 
Note: For external link references, you can simply use a space instead of ][ to separate the link URL from the descriptive text.
 
Note: Anchor names can be added as well, like [[WebHome#MyAnchor][go home]] and [[http://gnu.org/#Action][GNU Action]].
->
>
+ You can create a link where you specify the link text and the URL separately using nested square brackets [[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.
 
 Anchor names can be added as well, to create a link to a specific place in a topic.
 
[[WikiSyntax][wiki syntax]]
 [[WikiSyntax][wiki syntax]]
-<
<
+[[WikiSyntax][syntax]]
 GNU
->
>
+wiki syntax
 wiki syntax
-<
<
+XML



syntax
 syntax
 GNU
-<
<
+XML
-<
<
->
>
-<
<
+Anchors:

 You can define a link reference inside a KoreaCmsWiki? 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 [[MyTopic#MyAnchor]] syntax. You can omit the topic name if you want to link within the same topic.
  

[[WikiWord#NotThere]]

[[#MyAnchor][Jump]]

#MyAnchor To here



WikiWord#NotThere

Jump

 To here
-[[WikiWord#NotThere]]

[[#MyAnchor][Jump]]

#MyAnchor To here
+WikiWord#NotThere

Jump

 To here
  Prevent a Link: 

 Prevent a WikiWord from being linked by prepending it with an exclamation point.
-<
<
->
>
-<
<
 SunOS
-<
<
->
>
-<
<
 SunOS
-<
<
->
>
  Disable Links:
-<
<
+ You can disable automatic linking of WikiWords by surrounding text with <noautolink> and </noautolink> tags.
 
 Note: Each tag must be on a line by itself.
 
 Note: This also works for TWiki tables, but only if you add a blank line between the end of the table and the closing </noautolink> tag (known issue of the TablePlugin).
->
>
+ You can disable automatic linking of WikiWords by surrounding text with <noautolink> and </noautolink> tags.
 It is possible to turn off all auto-linking with a NOAUTOLINK preferences setting.
-<
<
  <noautolink>
 RedHat &
 SuSE
 </noautolink>
-<
<
->
>
-<
<
  RedHat &
 SuSE
-<
<
+Mailto: Links: 

To create 'mailto:' links that have more descriptive link text, specify subject lines or message bodies, or omit the email address, you can write [[mailto:user@domain descriptive text]].
 Mailto: Links: 

To create 'mailto:' links that have more descriptive link text, specify subject lines or message bodies, or omit the email address, you can write [[mailto:user@domain descriptive text]].
->
>
+Mailto Links: 

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 [[mailto:user@domain][descriptive text]].

a@b.com
-Mailto Links: 

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 [[mailto:user@domain][descriptive text]].
+a@b.com
-<
<
+Mail
-<
<
+Hi
->
>
+Mail
-<
<
+Mail
 Mail
-<
<
+Hi
->
>
+[[mailto:?subject=
->
>
+Hi][Hi]]


a@b.com

Mail

Hi
 a@b.com

Mail

Hi
  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.
->
>
+You can use just about any HTML tag without a problem. You can add HTML if there is no TWiki equivalent, for example, write <strike>deleted text</strike> to get deleted text.
-<
<
+ HTML and TWiki Usability
->
>
+ 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 TWiki shorthand instead - this keeps the text uncluttered and easy to edit.
  If you use HTML use XHTML 1.0 Transitional syntax.
   Script tags may be filtered out, at the discretion of your TWiki administrator.
-<
<
+  TIP: On collaboration pages, it's preferable NOT to use HTML, and to use TWiki shorthand instead - this keeps the text uncluttered and easy to edit.
   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 XHTML 1.0 Transitional syntax
  Do not span a tag over more then one line
  Remove all empty lines. TWiki inserts <p /> paragraph tags on empty lines, which causes problems if done between tags that do not allow paragraph tags, like for example between table tags.
->
>
+Recommendations when pasting HTML from other sources: 
 Copy only text between <body> and </body> tags.
  Remove all empty lines. TWiki inserts <p /> 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 - <...> - 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.
->
>
+ 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.
-<
<
+ TWiki HTML Rendering
->
>
+ Script tags
-<
<
+ 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.
->
>
+You can use HTML <script> tags for your TWiki applications. However note that your TWiki administrator can disable <script> in topics, and may have chosen to do so for security considerations. TWiki markup and TWikiVariables are not expanded inside script tags.
-<
<
+  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."
 
   NOTE: The opening and closing angle brackets - <...> - 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, &lt;, ex: a < b
   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.
-<
<
+ TWiki and JavaScript 

You can use JavaScript for your TWiki applications. Since TWiki rendering might interfere with JavaScript code you need to escape it with HTML comments and <pre> tags:
<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>
  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.
->
>
+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 GoodStyle topic located in the current KoreaCmsWiki? web.
->
>
+ GoodStyle is a WikiWord that links to the GoodStyle topic located in the current 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.
->
>
+ E-mail addresses like name@domain.com are linked automatically.
  [[Square bracket rules]] let you easily create non-WikiWord links. 
 You can also write [[http://yahoo.com Yahoo home page]] as an easier way of doing external links with descriptive text for the link, such as Yahoo home page.
-<
<
  TWiki Variables
-<
<
+Variables are names that are enclosed in percent signs % that are expanded on the fly.
->
>
+TWiki Variables are names that are enclosed in percent signs % that are expanded on the fly.
  %TOC% : Automatically generates a table of contents based on headings in a topic - see the top of this page for an example.
-<
<
+ %WEB% : The current web, is TWiki.
->
>
+ %WEB% : The current web, is TWiki.
  %TOPIC% : The current topic name, is TextFormattingRules.
 
 

 %ATTACHURL% : The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as %ATTACHURL%/image.gif to show the URL of the file or the image in your text.
-<
<
+ %INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current KoreaCmsWiki? web is the default web. Example: %INCLUDE{"TWiki.SiteMap"}%
->
>
+ %INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current web is the default web. Example: %INCLUDE{"TWiki.SiteMap"}%
-<
<
+ %SEARCH{"sushi"}% : Inline search showing the search result embedded in a topic. FormattedSearch gives you control over formatting, used to create web-based applications.
->
>
+ %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 site-wide variables. Among others: 
 Line break: Write %BR% to start a new line.
  Colored text: Write:  %RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors to get:  Red  and  blue  colors.
  Documentation Graphics: Write:  %H% Help, %T% Tip, %X% Alert to get:  Help,  Tip,  Alert. For more info see TWikiDocGraphics.
->
>
+ TWikiPreferences defines some site-wide variables. Among others: 
 Line break: Write %BR% to start a new line.
  Colored text: Write: %RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors to get:  Red  and  blue  colors.
  Documentation Graphics: Write: %H% Help, %T% Tip, %X% Alert to get:  Help,  Tip,  Alert. For more info see TWikiDocGraphics.
  There are many more variables, see TWikiVariables.
-<
<
+ To "escape" a variable, prefix it with an exclamation point. Write:  !%SOMEVARIABLE%  to get: %SOMEVARIABLE%.
->
>
+ To "escape" a variable, prefix it with an exclamation mark. Write: !%SOMEVARIABLE% to get: %SOMEVARIABLE%.
  TWikiPlugin Formatting Extensions
-<
<
+Plugins provide additional text formatting capabilities and can extend the functionality of KoreaCmsWiki? into many other areas. For example, the optional SpreadSheetPlugin lets you create a spreadsheet with the same basic notation used in TWiki tables.
->
>
+Plugins can extend the functionality of TWiki into many other areas. There are a huge number of TWiki plugins available from the Plugins web on TWiki.org.
-<
<
+Available Plugins are located in the Plugins web on TWiki.org. Currently enabled plugins on this TWiki installation, as listed by %PLUGINDESCRIPTIONS%:
->
>
+Currently enabled plugins on this TWiki installation, as listed by %PLUGINDESCRIPTIONS%:
-<
<
  SpreadSheetPlugin (2018-07-05, $Rev: 30478 (2018-07-16) $): Add spreadsheet calculation like "$SUM( $ABOVE() )" to TWiki tables and other topic text 
 BackupRestorePlugin (2018-07-10, $Rev: 30551 (2018-07-16) $): Administrator utility to backup, restore and upgrade a TWiki site 
 ColorPickerPlugin (2018-07-05, $Rev: 30442 (2018-07-16) $): Color picker, packaged for use in TWiki forms and TWiki applications 
 CommentPlugin (2018-07-05, $Rev: 30530 (2018-07-16) $): Quickly post comments to a page without an edit/preview/save cycle 
 DatePickerPlugin (2018-07-05, $Rev: 30446 (2018-07-16) $): Pop-up calendar with date picker, for use in TWiki forms, HTML forms and TWiki plugins 
 EditTablePlugin (2018-07-05, $Rev: 30448 (2018-07-16) $): Edit TWiki tables using edit fields, date pickers and drop down boxes 
 HeadlinesPlugin (2018-07-13, $Rev: 30560 (2018-07-16) $): Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites 
 InterwikiPlugin (2018-07-05, $Rev: 30454 (2018-07-16) $): Write ExternalSite:Page to link to a page on an external site based on aliases defined in a rules topic 
 JQueryPlugin (2018-07-05, $Rev: 30456 (2018-07-16) $): jQuery JavaScript library for TWiki 
 PreferencesPlugin (2018-07-05, $Rev: 30528 (2018-07-16) $): Allows editing of preferences using fields predefined in a form 
 SetGetPlugin (2018-07-05, $Rev: 30472 (2018-07-16) $): Set and get variables and JSON objects in topics, optionally persistently across topic views 
 SlideShowPlugin (2018-07-05, $Rev: 30474 (2018-07-16) $): Create web based presentations based on topics with headings. 
 SmiliesPlugin (2018-07-05, $Rev: 30476 (2018-07-16) $): Render smilies as icons, like  for  :-) or  for  :eek: 
 TWikiSheetPlugin (2018-07-15, $Rev: 30604 (2018-07-16) $): Add TWiki Sheet spreadsheet functionality to TWiki tables 
 TablePlugin (2018-07-05, $Rev: 30480 (2018-07-16) $): Control attributes of tables and sorting of table columns 
 TagMePlugin (2018-07-05, $Rev: 30482 (2018-07-16) $): Tag wiki content collectively or authoritatively to find content by keywords 
 TinyMCEPlugin (2018-07-10, $Rev: 30541 (2018-07-16) $): Integration of the Tiny MCE WYSIWYG Editor 
 TwistyPlugin (2018-07-06, $Rev: 30497 (2018-07-16) $): Twisty section JavaScript library to open/close content dynamically 
 WatchlistPlugin (2018-07-10, $Rev: 30536 (2018-07-16) $): Watch topics of interest and get notified of changes by e-mail 
 WysiwygPlugin (2018-07-06, $Rev: 30528 (2018-07-16) $): Translator framework for WYSIWYG editors 

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

 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. '&copy;' is the © copyright character. You need to escape '&' to see it as it is, so write '&amp;' instead of '&'. 
 Example: Type 'This &amp; that' to get 'This & that'.
-<
<
+-- TWiki:Main.MikeMannix - 02 Dec 2001 

-- TWiki:Main.PeterThoeny - 01 Aug 2004
->
>

Revision 472004-08-01 - PeterThoeny?

TWiki Text Formatting

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.

TWiki Editing Shorthand

Formatting Command: Example: You write: You get:

Paragraphs:
Blank lines will create new paragraphs.

1st paragraph

2nd paragraph

1st paragraph

2nd paragraph

Headings:
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 %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.

---++ Sushi

---+++ Maguro

Sushi

Maguro

Bold Text:
Words get bold by enclosing them in * asterisks.

*Bold*

Bold

Italic Text:
Words get italic by enclosing them in _ underscores.

_Italic_

Italic

Bold Italic:
Words get _bold italic by enclosing them in _ double-underscores.

__Bold italic__

Bold italic

Fixed Font:
Words get shown in fixed font by enclosing them in = equal signs.

=Fixed font=

Fixed font

Bold Fixed Font:
Words get shown in bold fixed font by enclosing them in double equal signs.

==Bold fixed==

Bold fixed

Note: Make sure there is no space between the text and the bold, italic, or other indicators (* _ __ = ==).

_This works_,
_this not _

This works,
_this not _

Verbatim Mode:
Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags.
Note: Use <pre> and </pre> tags instead if you want that HTML code is interpreted.
Note: Each tag must be on a line by itself.

<verbatim>
class CatAnimal {
  void purr() {
	 <code here>
  }
}
</verbatim>

class CatAnimal {
  void purr() {
    <code here>
  }
}

Separator:
At least three dashes at the beginning of a line.

-------

List Item:
Three spaces, an asterisk, and another space.

	* bullet item

bullet item

Nested List Item:
Six, nine, ... spaces, an asterisk, and another space.

	* level 1
		* level 2

level 1
- level 2

Ordered List:
Three spaces, a number, 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...

	1. Sushi
	1. Dim Sum

	A. Sushi
	A. Dim Sum

	i. Sushi
	i. Dim Sum

Sushi
Dim Sum

Sushi
Dim Sum

Sushi
Dim Sum

Definition List:
Three spaces, a dollar sign, the term, a colon, a space, followed by the definition.

	$ Sushi: Japan
	$ Dim Sum: S.F.

Sushi: Japan
Dim Sum: S.F.

Table:
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.
Notes:
• | *bold* | cells are displayed as table headers.
• | center-spaced | cells are displayed center aligned.
• | right-spaced | cells are displayed right aligned.
• | 2 colspan || cells are displayed as multi-span columns (i.e., a cell with no text spans a column).
• |^| cells with a caret indicate follow-up rows of multi-span rows (this functionality is provided by TablePlugin).
• 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 '\'.
• Table cells wrap automatically as determined by the browser.

| *L* | *C* | *R* |
| A2 |  2  |  2 |
| A3 |  3  |  3 |
| multi span |||
| A4-6 | four | four |
|^| five | five |



|^| six | six |

L	C	R
A2	2	2
A3	3	3
multi span
A4-6	four	four
	five	five
	six	six

WikiWord Links:

Changed:

<
< CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically.
Note: In case you want to link to a topic in a different KoreaCmsWiki? web write Webname.TopicName.

>
> CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically.
Note: In case you want to link to a topic in a different KoreaCmsWiki? web write Otherweb.TopicName. (The link label is the the name of the web in case the is WebHome, else it is the topic name)

WebNotify Main.TWikiUsers	WebNotify TWikiUsers
Forced Links: You can create a forced internal link by enclosing words in double square brackets. *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, `[[text formatting FAQ]]` links to topic TextFormattingFAQ. You can also refer to a different web and use anchors. *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 `![[....`	[[wiki syntax]] [[Main.TWiki users]] escaped: ![[wiki syntax]]	wiki syntax Main.TWiki users escaped: [[wiki syntax]]
Specific Links: Create a link where you can specify the link text and the link reference separately, using nested square brackets like `[[reference][text]]`. Internal link references (e.g. WikiSyntax) and external link references (e.g. http://TWiki.org/) are supported. *Note:* The same *Forced Links* rules apply for internal link references. *Note:* For external link references, you can simply use a space instead of `][` to separate the link URL from the descriptive text. *Note:* Anchor names can be added as well, like `[[WebHome#MyAnchor][go home]]` and `[[http://gnu.org/#Action][GNU Action]]`.	[[WikiSyntax][syntax]] [[http://gnu.org][GNU]] [[http://xml.org XML]]	syntax GNU XML
Anchors: You can define a link reference inside a KoreaCmsWiki? 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 `[[MyTopic#MyAnchor]]` syntax. You can omit the topic name if you want to link within the same topic.	[[WikiWord#NotThere]] [[#MyAnchor][Jump]] #MyAnchor To here	WikiWord#NotThere Jump To here
Prevent a Link: Prevent a WikiWord from being linked by prepending it with an exclamation point.	!SunOS	SunOS
Disable Links: You can disable automatic linking of WikiWords by surrounding text with `<noautolink>` and `</noautolink>` tags. *Note:* Each tag must be on a line by itself. *Note:* This also works for TWiki tables, but only if you add a blank line between the end of the table and the closing `</noautolink>` tag (known issue of the TablePlugin).	<noautolink> RedHat & SuSE </noautolink>	RedHat & SuSE
Mailto: Links: To create 'mailto:' links that have more descriptive link text, specify subject lines or message bodies, or omit the email address, you can write `[[mailto:user@domain descriptive text]]`.	[[mailto:a@z.com Mail]] [[mailto:?subject=Hi Hi]]	Mail Hi

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

TIP: On collaboration pages, it's preferable NOT to use HTML, and to use TWiki shorthand instead - this keeps the text uncluttered and easy to edit.
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 XHTML 1.0 Transitional syntax
- Do not span a tag over more then one line
- Remove all empty lines. TWiki inserts <p /> paragraph tags on empty lines, which causes problems if done between tags that do not allow paragraph tags, like for example between table tags.

Added:

>
>

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.
- 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."
NOTE: The opening and closing angle brackets - <...> - 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, <, ex: a < b
- 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.

TWiki and JavaScript

You can use JavaScript for your TWiki applications. Since TWiki rendering might interfere with JavaScript code you need to escape it with HTML comments and <pre> tags:

Changed:

<
<

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 GoodStyle topic located in the current KoreaCmsWiki? 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.

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

TWiki Variables

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

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

%WEB% : The current web, is TWiki.

%TOPIC% : The current topic name, is TextFormattingRules.

%ATTACHURL% : The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as %ATTACHURL%/image.gif to show the URL of the file or the image in your text.

%INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current KoreaCmsWiki? web is the default web. Example: %INCLUDE{"TWiki.SiteMap"}%

%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 %BR% to start a new line.
- Colored text: Write: %RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors to get: Red and blue colors.
- Documentation Graphics: Write: %H% Help, %T% Tip, %X% Alert to get: Help, Tip, Alert. For more info see TWikiDocGraphics.

There are many more variables, see TWikiVariables.

To "escape" a variable, prefix it with an exclamation point. Write: !%SOMEVARIABLE% to get: %SOMEVARIABLE%.

TWikiPlugin Formatting Extensions

Plugins provide additional text formatting capabilities and can extend the functionality of KoreaCmsWiki? into many other areas. For example, the optional SpreadSheetPlugin lets you create a spreadsheet with the same basic notation used in TWiki tables.

Available Plugins are located in the Plugins web on TWiki.org. Currently enabled plugins on this TWiki installation, as listed by %PLUGINDESCRIPTIONS%:

SpreadSheetPlugin (2018-07-05, $Rev: 30478 (2018-07-16) $): Add spreadsheet calculation like "$SUM( $ABOVE() )" to TWiki tables and other topic text
BackupRestorePlugin (2018-07-10, $Rev: 30551 (2018-07-16) $): Administrator utility to backup, restore and upgrade a TWiki site
ColorPickerPlugin (2018-07-05, $Rev: 30442 (2018-07-16) $): Color picker, packaged for use in TWiki forms and TWiki applications
CommentPlugin (2018-07-05, $Rev: 30530 (2018-07-16) $): Quickly post comments to a page without an edit/preview/save cycle
DatePickerPlugin (2018-07-05, $Rev: 30446 (2018-07-16) $): Pop-up calendar with date picker, for use in TWiki forms, HTML forms and TWiki plugins
EditTablePlugin (2018-07-05, $Rev: 30448 (2018-07-16) $): Edit TWiki tables using edit fields, date pickers and drop down boxes
HeadlinesPlugin (2018-07-13, $Rev: 30560 (2018-07-16) $): Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites
InterwikiPlugin (2018-07-05, $Rev: 30454 (2018-07-16) $): Write ExternalSite:Page to link to a page on an external site based on aliases defined in a rules topic
JQueryPlugin (2018-07-05, $Rev: 30456 (2018-07-16) $): jQuery JavaScript library for TWiki
PreferencesPlugin (2018-07-05, $Rev: 30528 (2018-07-16) $): Allows editing of preferences using fields predefined in a form
SetGetPlugin (2018-07-05, $Rev: 30472 (2018-07-16) $): Set and get variables and JSON objects in topics, optionally persistently across topic views
SlideShowPlugin (2018-07-05, $Rev: 30474 (2018-07-16) $): Create web based presentations based on topics with headings.
SmiliesPlugin (2018-07-05, $Rev: 30476 (2018-07-16) $): Render smilies as icons, like for :-) or for :eek:
TWikiSheetPlugin (2018-07-15, $Rev: 30604 (2018-07-16) $): Add TWiki Sheet spreadsheet functionality to TWiki tables
TablePlugin (2018-07-05, $Rev: 30480 (2018-07-16) $): Control attributes of tables and sorting of table columns
TagMePlugin (2018-07-05, $Rev: 30482 (2018-07-16) $): Tag wiki content collectively or authoritatively to find content by keywords
TinyMCEPlugin (2018-07-10, $Rev: 30541 (2018-07-16) $): Integration of the Tiny MCE WYSIWYG Editor
TwistyPlugin (2018-07-06, $Rev: 30497 (2018-07-16) $): Twisty section JavaScript library to open/close content dynamically
WatchlistPlugin (2018-07-10, $Rev: 30536 (2018-07-16) $): Watch topics of interest and get notified of changes by e-mail
WysiwygPlugin (2018-07-06, $Rev: 30528 (2018-07-16) $): Translator framework for WYSIWYG editors

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

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. '©' is the © copyright character. You need to escape '&' to see it as it is, so write '&' instead of '&'.
  Example: Type 'This & that' to get 'This & that'.

-- TWiki:Main.MikeMannix - 02 Dec 2001

Changed:

<
< -- TWiki:Main.PeterThoeny - 25 Apr 2004

>
> -- TWiki:Main.PeterThoeny - 01 Aug 2004

Revision 462004-07-24 - PeterThoeny?

TWiki Text Formatting

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.

TWiki Editing Shorthand

Formatting Command: Example: You write: You get:

Paragraphs:
Blank lines will create new paragraphs.

1st paragraph

2nd paragraph

1st paragraph

2nd paragraph

Headings:
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 %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.

---++ Sushi

---+++ Maguro

Sushi

Maguro

Bold Text:
Words get bold by enclosing them in * asterisks.

*Bold*

Bold

Italic Text:
Words get italic by enclosing them in _ underscores.

_Italic_

Italic

Bold Italic:
Words get _bold italic by enclosing them in _ double-underscores.

__Bold italic__

Bold italic

Fixed Font:
Words get shown in fixed font by enclosing them in = equal signs.

=Fixed font=

Fixed font

Bold Fixed Font:
Words get shown in bold fixed font by enclosing them in double equal signs.

==Bold fixed==

Bold fixed

Note: Make sure there is no space between the text and the bold, italic, or other indicators (* _ __ = ==).

_This works_,
_this not _

This works,
_this not _

Verbatim Mode:
Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags.
Note: Use <pre> and </pre> tags instead if you want that HTML code is interpreted.
Note: Each tag must be on a line by itself.

<verbatim>
class CatAnimal {
  void purr() {
	 <code here>
  }
}
</verbatim>

class CatAnimal {
  void purr() {
    <code here>
  }
}

Separator:
At least three dashes at the beginning of a line.

-------

List Item:
Three spaces, an asterisk, and another space.

	* bullet item

bullet item

Nested List Item:
Six, nine, ... spaces, an asterisk, and another space.

	* level 1
		* level 2

level 1
- level 2

Ordered List:
Three spaces, a number, 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...

	1. Sushi
	1. Dim Sum

	A. Sushi
	A. Dim Sum

	i. Sushi
	i. Dim Sum

Sushi
Dim Sum

Sushi
Dim Sum

Sushi
Dim Sum

Definition List:
Three spaces, a dollar sign, the term, a colon, a space, followed by the definition.

	$ Sushi: Japan
	$ Dim Sum: S.F.

Sushi: Japan
Dim Sum: S.F.

Table:
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.
Notes:
• | *bold* | cells are displayed as table headers.
• | center-spaced | cells are displayed center aligned.
• | right-spaced | cells are displayed right aligned.
• | 2 colspan || cells are displayed as multi-span columns (i.e., a cell with no text spans a column).
• |^| cells with a caret indicate follow-up rows of multi-span rows (this functionality is provided by TablePlugin).
• 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 '\'.
• Table cells wrap automatically as determined by the browser.

| *L* | *C* | *R* |
| A2 |  2  |  2 |
| A3 |  3  |  3 |
| multi span |||
| A4-6 | four | four |
|^| five | five |



|^| six | six |

L	C	R
A2	2	2
A3	3	3
multi span
A4-6	four	four
	five	five
	six	six

WikiWord Links:
CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically.
Note: In case you want to link to a topic in a different KoreaCmsWiki? web write Webname.TopicName.

WebNotify

Changed:

<
< ReadmeFirst?

>
> TWikiUsers

Changed:

<
< ReadmeFirst?

>
> TWikiUsers

Forced Links: You can create a forced internal link by enclosing words in double square brackets. *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, `[[text formatting FAQ]]` links to topic TextFormattingFAQ. You can also refer to a different web and use anchors. *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 `![[....`	[[wiki syntax]] [[Main.TWiki users]] escaped: ![[wiki syntax]]	wiki syntax Main.TWiki users escaped: [[wiki syntax]]
Specific Links: Create a link where you can specify the link text and the link reference separately, using nested square brackets like `[[reference][text]]`. Internal link references (e.g. WikiSyntax) and external link references (e.g. http://TWiki.org/) are supported. *Note:* The same *Forced Links* rules apply for internal link references. *Note:* For external link references, you can simply use a space instead of `][` to separate the link URL from the descriptive text. *Note:* Anchor names can be added as well, like `[[WebHome#MyAnchor][go home]]` and `[[http://gnu.org/#Action][GNU Action]]`.	[[WikiSyntax][syntax]] [[http://gnu.org][GNU]] [[http://xml.org XML]]	syntax GNU XML
Anchors: You can define a link reference inside a KoreaCmsWiki? 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 `[[MyTopic#MyAnchor]]` syntax. You can omit the topic name if you want to link within the same topic.	[[WikiWord#NotThere]] [[#MyAnchor][Jump]] #MyAnchor To here	WikiWord#NotThere Jump To here
Prevent a Link: Prevent a WikiWord from being linked by prepending it with an exclamation point.	!SunOS	SunOS
Disable Links: You can disable automatic linking of WikiWords by surrounding text with `<noautolink>` and `</noautolink>` tags. *Note:* Each tag must be on a line by itself. *Note:* This also works for TWiki tables, but only if you add a blank line between the end of the table and the closing `</noautolink>` tag (known issue of the TablePlugin).	<noautolink> RedHat & SuSE </noautolink>	RedHat & SuSE
Mailto: Links: To create 'mailto:' links that have more descriptive link text, specify subject lines or message bodies, or omit the email address, you can write `[[mailto:user@domain descriptive text]]`.	[[mailto:a@z.com Mail]] [[mailto:?subject=Hi Hi]]	Mail Hi

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

TIP: On collaboration pages, it's preferable NOT to use HTML, and to use TWiki shorthand instead - this keeps the text uncluttered and easy to edit.
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 XHTML 1.0 Transitional syntax
- Do not span a tag over more then one line
- Remove all empty lines. TWiki inserts <p /> paragraph tags on empty lines, which causes problems if done between tags that do not allow paragraph tags, like for example between table tags.

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.
- 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."
NOTE: The opening and closing angle brackets - <...> - 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, <, ex: a < b
- 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.

TWiki and JavaScript

You can use JavaScript for your TWiki applications. Since TWiki rendering might interfere with JavaScript code you need to escape it with HTML comments and <pre> tags:

<script language="JavaScript">
<!-- Hide JavaScript and <pre> escape TWiki rendering
... put your JavaScript code here...
// Stop hiding and stop </pre> escaping TWiki rendering -->
</script>

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 GoodStyle topic located in the current KoreaCmsWiki? 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.

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

TWiki Variables

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

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

%WEB% : The current web, is TWiki.

%TOPIC% : The current topic name, is TextFormattingRules.

%ATTACHURL% : The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as %ATTACHURL%/image.gif to show the URL of the file or the image in your text.

%INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current KoreaCmsWiki? web is the default web. Example: %INCLUDE{"TWiki.SiteMap"}%

%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 %BR% to start a new line.
- Colored text: Write: %RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors to get: Red and blue colors.
- Documentation Graphics: Write: %H% Help, %T% Tip, %X% Alert to get: Help, Tip, Alert. For more info see TWikiDocGraphics.

There are many more variables, see TWikiVariables.

To "escape" a variable, prefix it with an exclamation point. Write: !%SOMEVARIABLE% to get: %SOMEVARIABLE%.

TWikiPlugin Formatting Extensions

Plugins provide additional text formatting capabilities and can extend the functionality of KoreaCmsWiki? into many other areas. For example, the optional SpreadSheetPlugin lets you create a spreadsheet with the same basic notation used in TWiki tables.

Available Plugins are located in the Plugins web on TWiki.org. Currently enabled plugins on this TWiki installation, as listed by %PLUGINDESCRIPTIONS%:

SpreadSheetPlugin (2018-07-05, $Rev: 30478 (2018-07-16) $): Add spreadsheet calculation like "$SUM( $ABOVE() )" to TWiki tables and other topic text
BackupRestorePlugin (2018-07-10, $Rev: 30551 (2018-07-16) $): Administrator utility to backup, restore and upgrade a TWiki site
ColorPickerPlugin (2018-07-05, $Rev: 30442 (2018-07-16) $): Color picker, packaged for use in TWiki forms and TWiki applications
CommentPlugin (2018-07-05, $Rev: 30530 (2018-07-16) $): Quickly post comments to a page without an edit/preview/save cycle
DatePickerPlugin (2018-07-05, $Rev: 30446 (2018-07-16) $): Pop-up calendar with date picker, for use in TWiki forms, HTML forms and TWiki plugins
EditTablePlugin (2018-07-05, $Rev: 30448 (2018-07-16) $): Edit TWiki tables using edit fields, date pickers and drop down boxes
HeadlinesPlugin (2018-07-13, $Rev: 30560 (2018-07-16) $): Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites
InterwikiPlugin (2018-07-05, $Rev: 30454 (2018-07-16) $): Write ExternalSite:Page to link to a page on an external site based on aliases defined in a rules topic
JQueryPlugin (2018-07-05, $Rev: 30456 (2018-07-16) $): jQuery JavaScript library for TWiki
PreferencesPlugin (2018-07-05, $Rev: 30528 (2018-07-16) $): Allows editing of preferences using fields predefined in a form
SetGetPlugin (2018-07-05, $Rev: 30472 (2018-07-16) $): Set and get variables and JSON objects in topics, optionally persistently across topic views
SlideShowPlugin (2018-07-05, $Rev: 30474 (2018-07-16) $): Create web based presentations based on topics with headings.
SmiliesPlugin (2018-07-05, $Rev: 30476 (2018-07-16) $): Render smilies as icons, like for :-) or for :eek:
TWikiSheetPlugin (2018-07-15, $Rev: 30604 (2018-07-16) $): Add TWiki Sheet spreadsheet functionality to TWiki tables
TablePlugin (2018-07-05, $Rev: 30480 (2018-07-16) $): Control attributes of tables and sorting of table columns
TagMePlugin (2018-07-05, $Rev: 30482 (2018-07-16) $): Tag wiki content collectively or authoritatively to find content by keywords
TinyMCEPlugin (2018-07-10, $Rev: 30541 (2018-07-16) $): Integration of the Tiny MCE WYSIWYG Editor
TwistyPlugin (2018-07-06, $Rev: 30497 (2018-07-16) $): Twisty section JavaScript library to open/close content dynamically
WatchlistPlugin (2018-07-10, $Rev: 30536 (2018-07-16) $): Watch topics of interest and get notified of changes by e-mail
WysiwygPlugin (2018-07-06, $Rev: 30528 (2018-07-16) $): Translator framework for WYSIWYG editors

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

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. '©' is the © copyright character. You need to escape '&' to see it as it is, so write '&' instead of '&'.
  Example: Type 'This & that' to get 'This & that'.

-- TWiki:Main.MikeMannix - 02 Dec 2001
-- TWiki:Main.PeterThoeny - 25 Apr 2004

Revision 452004-07-11 - PeterThoeny?

TWiki Text Formatting

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.

TWiki Editing Shorthand

Formatting Command: Example: You write: You get:

Paragraphs:
Blank lines will create new paragraphs.

1st paragraph

2nd paragraph

1st paragraph

2nd paragraph

Headings:
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 %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.

---++ Sushi

---+++ Maguro

Sushi

Maguro

Bold Text:
Words get bold by enclosing them in * asterisks.

*Bold*

Bold

Italic Text:
Words get italic by enclosing them in _ underscores.

_Italic_

Italic

Bold Italic:
Words get _bold italic by enclosing them in _ double-underscores.

__Bold italic__

Bold italic

Fixed Font:
Words get shown in fixed font by enclosing them in = equal signs.

=Fixed font=

Fixed font

Bold Fixed Font:
Words get shown in bold fixed font by enclosing them in double equal signs.

==Bold fixed==

Bold fixed

Note: Make sure there is no space between the text and the bold, italic, or other indicators (* _ __ = ==).

_This works_,
_this not _

This works,
_this not _

Verbatim Mode:
Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags.
Note: Use <pre> and </pre> tags instead if you want that HTML code is interpreted.
Note: Each tag must be on a line by itself.

<verbatim>
class CatAnimal {
  void purr() {
	 <code here>
  }
}
</verbatim>

class CatAnimal {
  void purr() {
    <code here>
  }
}

Separator:
At least three dashes at the beginning of a line.

-------

List Item:
Three spaces, an asterisk, and another space.

	* bullet item

bullet item

Nested List Item:
Six, nine, ... spaces, an asterisk, and another space.

	* level 1
		* level 2

level 1
- level 2

Ordered List:
Three spaces, a number, 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...

	1. Sushi
	1. Dim Sum

	A. Sushi
	A. Dim Sum

	i. Sushi
	i. Dim Sum

Sushi
Dim Sum

Sushi
Dim Sum

Sushi
Dim Sum

Definition List:
Three spaces, a dollar sign, the term, a colon, a space, followed by the definition.

	$ Sushi: Japan
	$ Dim Sum: S.F.

Sushi: Japan
Dim Sum: S.F.

Table:
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.
Notes:
• | *bold* | cells are displayed as table headers.
• | center-spaced | cells are displayed center aligned.
• | right-spaced | cells are displayed right aligned.
• | 2 colspan || cells are displayed as multi-span columns (i.e., a cell with no text spans a column).
• |^| cells with a caret indicate follow-up rows of multi-span rows (this functionality is provided by TablePlugin).
• 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 '\'.
• Table cells wrap automatically as determined by the browser.

| *L* | *C* | *R* |
| A2 |  2  |  2 |
| A3 |  3  |  3 |
| multi span |||
| A4-6 | four | four |
|^| five | five |



|^| six | six |

L	C	R
A2	2	2
A3	3	3
multi span
A4-6	four	four
	five	five
	six	six

WikiWord Links:
CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically.
Note: In case you want to link to a topic in a different KoreaCmsWiki? web write Webname.TopicName.

WebNotify

Know.ReadmeFirst

ReadmeFirst?

Forced Links:
You can create a forced internal link by enclosing words in double square brackets.
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, [[text formatting FAQ]] links to topic TextFormattingFAQ. You can also refer to a different web and use anchors.
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 ![[....

[[wiki syntax]]

[[Main.TWiki users]]

escaped:
![[wiki syntax]]

escaped: [[wiki syntax]]

Specific Links:
Create a link where you can specify the link text and the link reference separately, using nested square brackets like [[reference][text]]. Internal link references (e.g. WikiSyntax) and external link references (e.g. http://TWiki.org/

) are supported.
Note: The same Forced Links rules apply for internal link references.
Note: For external link references, you can simply use a space instead of ][ to separate the link URL from the descriptive text.
Note: Anchor names can be added as well, like [[WebHome#MyAnchor][go home]] and [[http://gnu.org/#Action][GNU Action]].

[[WikiSyntax][syntax]]

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

[[http://xml.org XML]]

Anchors:
You can define a link reference inside a KoreaCmsWiki? 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 [[MyTopic#MyAnchor]] syntax. You can omit the topic name if you want to link within the same topic.

[[WikiWord#NotThere]]

[[#MyAnchor][Jump]]

#MyAnchor To here

To here

Prevent a Link:
Prevent a WikiWord from being linked by prepending it with an exclamation point.

!SunOS

SunOS

Disable Links:
You can disable automatic linking of WikiWords by surrounding text with <noautolink> and </noautolink> tags.
Note: Each tag must be on a line by itself.
Note: This also works for TWiki tables, but only if you add a blank line between the end of the table and the closing </noautolink> tag (known issue of the TablePlugin).

 <noautolink>
 RedHat &
 SuSE
 </noautolink>

RedHat & SuSE

Mailto: Links:
To create 'mailto:' links that have more descriptive link text, specify subject lines or message bodies, or omit the email address, you can write [[mailto:user@domain descriptive text]].

[[mailto:a@z.com Mail]]

[[mailto:?subject=Hi Hi]]

Mail

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

Changed:

<
<

On collaboration pages, it's preferable NOT to use HTML, and to use TWiki shorthand instead - this keeps the text uncluttered and easy to edit.
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.

>
>

TIP: On collaboration pages, it's preferable NOT to use HTML, and to use TWiki shorthand instead - this keeps the text uncluttered and easy to edit.
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.

Added:

>
>

Recommondations when using HTML:
- Use XHTML 1.0 Transitional syntax
- Do not span a tag over more then one line
- Remove all empty lines. TWiki inserts <p /> paragraph tags on empty lines, which causes problems if done between tags that do not allow paragraph tags, like for example between table tags.

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.
- 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."
NOTE: The opening and closing angle brackets - <...> - 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, <, ex: a < b
- 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.

TWiki and JavaScript

You can use JavaScript for your TWiki applications. Since TWiki rendering might interfere with JavaScript code you need to escape it with HTML comments and <pre> tags:

<script language="JavaScript">
<!-- Hide JavaScript and <pre> escape TWiki rendering
... put your JavaScript code here...
// Stop hiding and stop </pre> escaping TWiki rendering -->
</script>

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 GoodStyle topic located in the current KoreaCmsWiki? 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.

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

TWiki Variables

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

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

%WEB% : The current web, is TWiki.

%TOPIC% : The current topic name, is TextFormattingRules.

%ATTACHURL% : The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as %ATTACHURL%/image.gif to show the URL of the file or the image in your text.

%INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current KoreaCmsWiki? web is the default web. Example: %INCLUDE{"TWiki.SiteMap"}%

%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 %BR% to start a new line.
- Colored text: Write: %RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors to get: Red and blue colors.
- Documentation Graphics: Write: %H% Help, %T% Tip, %X% Alert to get: Help, Tip, Alert. For more info see TWikiDocGraphics.

There are many more variables, see TWikiVariables.

To "escape" a variable, prefix it with an exclamation point. Write: !%SOMEVARIABLE% to get: %SOMEVARIABLE%.

TWikiPlugin Formatting Extensions

Plugins provide additional text formatting capabilities and can extend the functionality of KoreaCmsWiki? into many other areas. For example, the optional SpreadSheetPlugin lets you create a spreadsheet with the same basic notation used in TWiki tables.

Available Plugins are located in the Plugins web on TWiki.org. Currently enabled plugins on this TWiki installation, as listed by %PLUGINDESCRIPTIONS%:

SpreadSheetPlugin (2018-07-05, $Rev: 30478 (2018-07-16) $): Add spreadsheet calculation like "$SUM( $ABOVE() )" to TWiki tables and other topic text
BackupRestorePlugin (2018-07-10, $Rev: 30551 (2018-07-16) $): Administrator utility to backup, restore and upgrade a TWiki site
ColorPickerPlugin (2018-07-05, $Rev: 30442 (2018-07-16) $): Color picker, packaged for use in TWiki forms and TWiki applications
CommentPlugin (2018-07-05, $Rev: 30530 (2018-07-16) $): Quickly post comments to a page without an edit/preview/save cycle
DatePickerPlugin (2018-07-05, $Rev: 30446 (2018-07-16) $): Pop-up calendar with date picker, for use in TWiki forms, HTML forms and TWiki plugins
EditTablePlugin (2018-07-05, $Rev: 30448 (2018-07-16) $): Edit TWiki tables using edit fields, date pickers and drop down boxes
HeadlinesPlugin (2018-07-13, $Rev: 30560 (2018-07-16) $): Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites
InterwikiPlugin (2018-07-05, $Rev: 30454 (2018-07-16) $): Write ExternalSite:Page to link to a page on an external site based on aliases defined in a rules topic
JQueryPlugin (2018-07-05, $Rev: 30456 (2018-07-16) $): jQuery JavaScript library for TWiki
PreferencesPlugin (2018-07-05, $Rev: 30528 (2018-07-16) $): Allows editing of preferences using fields predefined in a form
SetGetPlugin (2018-07-05, $Rev: 30472 (2018-07-16) $): Set and get variables and JSON objects in topics, optionally persistently across topic views
SlideShowPlugin (2018-07-05, $Rev: 30474 (2018-07-16) $): Create web based presentations based on topics with headings.
SmiliesPlugin (2018-07-05, $Rev: 30476 (2018-07-16) $): Render smilies as icons, like for :-) or for :eek:
TWikiSheetPlugin (2018-07-15, $Rev: 30604 (2018-07-16) $): Add TWiki Sheet spreadsheet functionality to TWiki tables
TablePlugin (2018-07-05, $Rev: 30480 (2018-07-16) $): Control attributes of tables and sorting of table columns
TagMePlugin (2018-07-05, $Rev: 30482 (2018-07-16) $): Tag wiki content collectively or authoritatively to find content by keywords
TinyMCEPlugin (2018-07-10, $Rev: 30541 (2018-07-16) $): Integration of the Tiny MCE WYSIWYG Editor
TwistyPlugin (2018-07-06, $Rev: 30497 (2018-07-16) $): Twisty section JavaScript library to open/close content dynamically
WatchlistPlugin (2018-07-10, $Rev: 30536 (2018-07-16) $): Watch topics of interest and get notified of changes by e-mail
WysiwygPlugin (2018-07-06, $Rev: 30528 (2018-07-16) $): Translator framework for WYSIWYG editors

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

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. '©' is the © copyright character. You need to escape '&' to see it as it is, so write '&' instead of '&'.
  Example: Type 'This & that' to get 'This & that'.

-- TWiki:Main.MikeMannix - 02 Dec 2001
-- TWiki:Main.PeterThoeny - 25 Apr 2004

Revision 442004-04-25 - PeterThoeny?

TWiki Text Formatting

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.

TWiki Editing Shorthand

Formatting Command:	Example: You write:	You get:
Paragraphs: Blank lines will create new paragraphs.	1st paragraph 2nd paragraph	1st paragraph 2nd paragraph
Headings: 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 `%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.	---++ Sushi ---+++ Maguro	Sushi Maguro
Bold Text: Words get bold by enclosing them in `*` asterisks.	Bold	Bold
Italic Text: Words get italic by enclosing them in `_` underscores.	_Italic_	Italic
Bold Italic: Words get _bold italic by enclosing them in `_` double-underscores.	__Bold italic__	*Bold italic*
Fixed Font: Words get shown in `fixed font` by enclosing them in `=` equal signs.	=Fixed font=	`Fixed font`
Bold Fixed Font: Words get shown in `bold fixed font` by enclosing them in double equal signs.	==Bold fixed==	`Bold fixed`
*Note:* Make sure there is no space between the text and the bold, italic, or other indicators (`* _ __ = ==`).	_This works_, _this not _	This works, _this not _
Verbatim Mode: Surround code excerpts and other formatted text with `<verbatim>` and `</verbatim>` tags. *Note:* Use `<pre>` and `</pre>` tags instead if you want that HTML code is interpreted. *Note:* Each tag must be on a line by itself.	<verbatim> class CatAnimal { void purr() { <code here> } } </verbatim>	class CatAnimal { void purr() { <code here> } }
Separator: At least three dashes at the beginning of a line.	-------
List Item: Three spaces, an asterisk, and another space.	* bullet item	bullet item
Nested List Item: Six, nine, ... spaces, an asterisk, and another space.	* level 1 * level 2	level 1 level 2
Ordered List:

Changed:

<
< Three spaces, a number, and another space.

>
> Three spaces, a number, a dot, and another space. Several types are available besides a number:

Added:

>
>

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

Changed:

<
<

Sushi
Dim Sum

>
>

Sushi
Dim Sum

Added:

>
>

Sushi
Dim Sum

Sushi
Dim Sum

Changed:

<
<

Sushi
Dim Sum

>
>

Sushi
Dim Sum

Added:

>
>

Sushi
Dim Sum

Sushi
Dim Sum

Definition List:
Three spaces, a dollar sign, the term, a colon, a space, followed by the definition.

	$ Sushi: Japan
	$ Dim Sum: S.F.

Sushi: Japan
Dim Sum: S.F.

Table:
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.
Notes:
• | *bold* | cells are displayed as table headers.
• | center-spaced | cells are displayed center aligned.
• | right-spaced | cells are displayed right aligned.
• | 2 colspan || cells are displayed as multi-span columns (i.e., a cell with no text spans a column).
• |^| cells with a caret indicate follow-up rows of multi-span rows (this functionality is provided by TablePlugin).
• 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 '\'.
• Table cells wrap automatically as determined by the browser.

| *L* | *C* | *R* |
| A2 |  2  |  2 |
| A3 |  3  |  3 |
| multi span |||
| A4-6 | four | four |
|^| five | five |



|^| six | six |

L	C	R
A2	2	2
A3	3	3
multi span
A4-6	four	four
	five	five
	six	six

WikiWord Links:
CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically.
Note: In case you want to link to a topic in a different KoreaCmsWiki? web write Webname.TopicName.

WebNotify

Know.ReadmeFirst

ReadmeFirst?

Forced Links:
You can create a forced internal link by enclosing words in double square brackets.
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, [[text formatting FAQ]] links to topic TextFormattingFAQ. You can also refer to a different web and use anchors.
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 ![[....

[[wiki syntax]]

[[Main.TWiki users]]

Added:

>
> escaped: [[wiki syntax]]

Added:

>
> escaped: [[wiki syntax]]

Specific Links: Create a link where you can specify the link text and the link reference separately, using nested square brackets like `[[reference][text]]`. Internal link references (e.g. WikiSyntax) and external link references (e.g. http://TWiki.org/) are supported. *Note:* The same *Forced Links* rules apply for internal link references. *Note:* For external link references, you can simply use a space instead of `][` to separate the link URL from the descriptive text. *Note:* Anchor names can be added as well, like `[[WebHome#MyAnchor][go home]]` and `[[http://gnu.org/#Action][GNU Action]]`.	[[WikiSyntax][syntax]] [[http://gnu.org][GNU]] [[http://xml.org XML]]	syntax GNU XML
Anchors: You can define a link reference inside a KoreaCmsWiki? 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 `[[MyTopic#MyAnchor]]` syntax. You can omit the topic name if you want to link within the same topic.	[[WikiWord#NotThere]] [[#MyAnchor][Jump]] #MyAnchor To here	WikiWord#NotThere Jump To here
Prevent a Link: Prevent a WikiWord from being linked by prepending it with an exclamation point.	!SunOS	SunOS
Disable Links: You can disable automatic linking of WikiWords by surrounding text with `<noautolink>` and `</noautolink>` tags. *Note:* Each tag must be on a line by itself. *Note:* This also works for TWiki tables, but only if you add a blank line between the end of the table and the closing `</noautolink>` tag (known issue of the TablePlugin).	<noautolink> RedHat & SuSE </noautolink>	RedHat & SuSE
Mailto: Links: To create 'mailto:' links that have more descriptive link text, specify subject lines or message bodies, or omit the email address, you can write `[[mailto:user@domain descriptive text]]`.	[[mailto:a@z.com Mail]] [[mailto:?subject=Hi Hi]]	Mail Hi

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 TWiki shorthand instead - this keeps the text uncluttered and easy to edit.
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.
- 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."
NOTE: The opening and closing angle brackets - <...> - 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, <, ex: a < b
- 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.

TWiki and JavaScript

Changed:

<
< You can use JavaScript for your TWiki applications. Sice TWiki rendering might interfere with JavaScript code you need to escape it with HTML comments and <pre> tags:

>
> You can use JavaScript for your TWiki applications. Since TWiki rendering might interfere with JavaScript code you need to escape it with HTML comments and <pre> tags:

<script language="JavaScript">
<!-- Hide JavaScript and <pre> escape TWiki rendering
... put your JavaScript code here...
// Stop hiding and stop </pre> escaping TWiki rendering -->
</script>

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 GoodStyle topic located in the current KoreaCmsWiki? 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.

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

TWiki Variables

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

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

%WEB% : The current web, is TWiki.

%TOPIC% : The current topic name, is TextFormattingRules.

%ATTACHURL% : The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as %ATTACHURL%/image.gif to show the URL of the file or the image in your text.

%INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current KoreaCmsWiki? web is the default web. Example: %INCLUDE{"TWiki.SiteMap"}%

%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 %BR% to start a new line.
- Colored text: Write: %RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors to get: Red and blue colors.
- Documentation Graphics: Write: %H% Help, %T% Tip, %X% Alert to get: Help, Tip, Alert. For more info see TWikiDocGraphics.

There are many more variables, see TWikiVariables.

To "escape" a variable, prefix it with an exclamation point. Write: !%SOMEVARIABLE% to get: %SOMEVARIABLE%.

TWikiPlugin Formatting Extensions

Plugins provide additional text formatting capabilities and can extend the functionality of KoreaCmsWiki? into many other areas. For example, the optional SpreadSheetPlugin lets you create a spreadsheet with the same basic notation used in TWiki tables.

Available Plugins are located in the Plugins web on TWiki.org. Currently enabled plugins on this TWiki installation, as listed by %PLUGINDESCRIPTIONS%:

SpreadSheetPlugin (2018-07-05, $Rev: 30478 (2018-07-16) $): Add spreadsheet calculation like "$SUM( $ABOVE() )" to TWiki tables and other topic text
BackupRestorePlugin (2018-07-10, $Rev: 30551 (2018-07-16) $): Administrator utility to backup, restore and upgrade a TWiki site
ColorPickerPlugin (2018-07-05, $Rev: 30442 (2018-07-16) $): Color picker, packaged for use in TWiki forms and TWiki applications
CommentPlugin (2018-07-05, $Rev: 30530 (2018-07-16) $): Quickly post comments to a page without an edit/preview/save cycle
DatePickerPlugin (2018-07-05, $Rev: 30446 (2018-07-16) $): Pop-up calendar with date picker, for use in TWiki forms, HTML forms and TWiki plugins
EditTablePlugin (2018-07-05, $Rev: 30448 (2018-07-16) $): Edit TWiki tables using edit fields, date pickers and drop down boxes
HeadlinesPlugin (2018-07-13, $Rev: 30560 (2018-07-16) $): Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites
InterwikiPlugin (2018-07-05, $Rev: 30454 (2018-07-16) $): Write ExternalSite:Page to link to a page on an external site based on aliases defined in a rules topic
JQueryPlugin (2018-07-05, $Rev: 30456 (2018-07-16) $): jQuery JavaScript library for TWiki
PreferencesPlugin (2018-07-05, $Rev: 30528 (2018-07-16) $): Allows editing of preferences using fields predefined in a form
SetGetPlugin (2018-07-05, $Rev: 30472 (2018-07-16) $): Set and get variables and JSON objects in topics, optionally persistently across topic views
SlideShowPlugin (2018-07-05, $Rev: 30474 (2018-07-16) $): Create web based presentations based on topics with headings.
SmiliesPlugin (2018-07-05, $Rev: 30476 (2018-07-16) $): Render smilies as icons, like for :-) or for :eek:
TWikiSheetPlugin (2018-07-15, $Rev: 30604 (2018-07-16) $): Add TWiki Sheet spreadsheet functionality to TWiki tables
TablePlugin (2018-07-05, $Rev: 30480 (2018-07-16) $): Control attributes of tables and sorting of table columns
TagMePlugin (2018-07-05, $Rev: 30482 (2018-07-16) $): Tag wiki content collectively or authoritatively to find content by keywords
TinyMCEPlugin (2018-07-10, $Rev: 30541 (2018-07-16) $): Integration of the Tiny MCE WYSIWYG Editor
TwistyPlugin (2018-07-06, $Rev: 30497 (2018-07-16) $): Twisty section JavaScript library to open/close content dynamically
WatchlistPlugin (2018-07-10, $Rev: 30536 (2018-07-16) $): Watch topics of interest and get notified of changes by e-mail
WysiwygPlugin (2018-07-06, $Rev: 30528 (2018-07-16) $): Translator framework for WYSIWYG editors

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

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. '©' is the © copyright character. You need to escape '&' to see it as it is, so write '&' instead of '&'.
  Example: Type 'This & that' to get 'This & that'.

-- TWiki:Main.MikeMannix - 02 Dec 2001

Changed:

<
< -- TWiki:Main.PeterThoeny - 29 Mar 2004

>
> -- TWiki:Main.PeterThoeny - 25 Apr 2004

Revision 432004-03-30 - PeterThoeny?

Changed:

<
<

TWiki Text Formatting

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.

TWiki Editing Shorthand

Formatting Command: Example: You write: You get:

Paragraphs:
Blank lines will create new paragraphs.

1st paragraph

2nd paragraph

1st paragraph

2nd paragraph

Headings:
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 %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.

---++ Sushi

---+++ Maguro

Sushi

Maguro

Bold Text:
Words get bold by enclosing them in * asterisks.

*Bold*

Bold

Italic Text:
Words get italic by enclosing them in _ underscores.

_Italic_

Italic

Bold Italic:
Words get _bold italic by enclosing them in _ double-underscores.

__Bold italic__

Bold italic

Fixed Font:
Words get shown in fixed font by enclosing them in = equal signs.

=Fixed font=

Fixed font

Bold Fixed Font:
Words get shown in bold fixed font by enclosing them in double equal signs.

==Bold fixed==

Bold fixed

Note: Make sure there is no space between the text and the bold, italic, or other indicators (* _ __ = ==).

_This works_,
_this not _

This works,
_this not _

Verbatim Mode:
Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags.
Note: Use <pre> and </pre> tags instead if you want that HTML code is interpreted.
Note: Each tag must be on a line by itself.

<verbatim>
class CatAnimal {
  void purr() {
	 <code here>
  }
}
</verbatim>

class CatAnimal {
  void purr() {
    <code here>
  }
}

Separator:
At least three dashes at the beginning of a line.

-------

List Item:
Three spaces and an asterisk.

	* bullet item

bullet item

Nested List Item:
Six, nine, ... spaces and an asterisk.

	* level 1
		* level 2

level 1
- level 2

Ordered List:
Three spaces and a number.

	1 Sushi
	1 Dim Sum

Sushi
Dim Sum

Definition List:
Three spaces, a dollar sign, the term, a colon, a space, followed by the definition.

	$ Sushi: Japan
	$ Dim Sum: S.F.

Sushi: Japan
Dim Sum: S.F.

Table:
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.
Notes:
• | *bold* | cells are displayed as table headers.
• | center-spaced | cells are displayed center aligned.
• | right-spaced | cells are displayed right aligned.
• | 2 colspan || cells are displayed as multi-span columns (i.e., a cell with no text spans a column).
• |^| cells with a caret indicate follow-up rows of multi-span rows.
• 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 '\'.
• Table cells wrap automatically as determined by the browser.

| *L* | *C* | *R* |
| A2 |  2  |  2 |
| A3 |  3  |  3 |
| multi span |||
| A4-6 | four | four |
|^| five | five |



|^| six | six |

L	C	R
A2	2	2
A3	3	3
multi span
A4-6	four	four
	five	five
	six	six

WikiWord Links:
CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically.
Note: In case you want to link to a topic in a different KoreaCmsWiki? web write Webname.TopicName.

WebNotify

Know.ReadmeFirst

ReadmeFirst?

Forced Links:
You can create a forced internal link by enclosing words in double square brackets.
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, [[text formatting FAQ]] links to topic TextFormattingFAQ. You can also refer to a different web and use anchors.
Note: To "escape" double square brackets that would otherwise be a correct link, use <nop> between the leading left square brackets, that is, begin with [<nop>[....

[[wiki syntax]]

[[Main.TWiki users]]

Specific Links:
Create a link where you can specify the link text and the link reference separately, using nested square brackets like [[reference][text]]. Internal link references (e.g. WikiSyntax) and external link references (e.g. http://TWiki.org/

) are supported.
Note: The same Forced Links rules apply for internal link references.
Note: For external link references, you can simply use a space instead of ][ to separate the link URL from the descriptive text.
Note: Anchor names can be added as well, like [[WebHome#MyAnchor][go home]] and [[http://gnu.org/#Action][GNU Action]].

[[WikiSyntax][syntax]]

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

[[http://xml.org XML]]

Anchors:
You can define a link reference inside a KoreaCmsWiki? 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 [[MyTopic#MyAnchor]] syntax. You can omit the topic name if you want to link within the same topic.

[[WikiWord#NotThere]]

[[#MyAnchor][Jump]]

#MyAnchor To here

To here

Prevent a Link:
Prevent a WikiWord from being linked by prepending it with the <nop> tag.

<nop>SunOS

SunOS

Disable Links:
You can disable automatic linking of WikiWords by surrounding text with <noautolink> and </noautolink> tags.
Note: Each tag must be on a line by itself.
Note: This also works for TWiki tables, but only if you add a blank line between the end of the table and the closing </noautolink> tag (known issue of the TablePlugin).

 <noautolink>
 RedHat &
 SuSE
 </noautolink>

RedHat & SuSE

Mailto: Links:
To create 'mailto:' links that have more descriptive link text, specify subject lines or message bodies, or omit the email address, you can write [[mailto:user@domain descriptive text]].

[[mailto:a@z.com Mail]]

[[mailto:?subject=Hi Hi]]

Mail

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 TWiki shorthand instead - this keeps the text uncluttered and easy to edit.
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.
- 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."
NOTE: The opening and closing angle brackets - <...> - 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, <, ex: a < b
- 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 GoodStyle topic located in the current KoreaCmsWiki? 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.

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

TWiki Variables

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

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

%WEB% : The current web, is TWiki.

%TOPIC% : The current topic name, is TextFormattingRules.

%ATTACHURL% : The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as %ATTACHURL%/image.gif to show the URL of the file or the image in your text.

%INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current KoreaCmsWiki? web is the default web. Example: %INCLUDE{"TWiki.SiteMap"}%

%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 %BR% to start a new line.
- Colored text: Write: %RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors to get: Red and blue colors.
- Documentation Graphics: Write: %H% Help, %T% Tip, %X% Alert to get: Help, Tip, 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 <nop> after the first percent sign. Write: %<nop>SOMEVARIABLE% to get: %SOMEVARIABLE%.

TWikiPlugin Formatting Extensions

Plugins provide additional text formatting capabilities and can extend the functionality of KoreaCmsWiki? into many other areas. For example, the optional SpreadSheetPlugin lets you create a spreadsheet with the same basic notation used in TWiki tables.

Available Plugins are located in the Plugins web on TWiki.org. Currently enabled plugins on this TWiki installation, as listed by %PLUGINDESCRIPTIONS%:

SpreadSheetPlugin (2018-07-05, $Rev: 30478 (2018-07-16) $): Add spreadsheet calculation like "$SUM( $ABOVE() )" to TWiki tables and other topic text
BackupRestorePlugin (2018-07-10, $Rev: 30551 (2018-07-16) $): Administrator utility to backup, restore and upgrade a TWiki site
ColorPickerPlugin (2018-07-05, $Rev: 30442 (2018-07-16) $): Color picker, packaged for use in TWiki forms and TWiki applications
CommentPlugin (2018-07-05, $Rev: 30530 (2018-07-16) $): Quickly post comments to a page without an edit/preview/save cycle
DatePickerPlugin (2018-07-05, $Rev: 30446 (2018-07-16) $): Pop-up calendar with date picker, for use in TWiki forms, HTML forms and TWiki plugins
EditTablePlugin (2018-07-05, $Rev: 30448 (2018-07-16) $): Edit TWiki tables using edit fields, date pickers and drop down boxes
HeadlinesPlugin (2018-07-13, $Rev: 30560 (2018-07-16) $): Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites
InterwikiPlugin (2018-07-05, $Rev: 30454 (2018-07-16) $): Write ExternalSite:Page to link to a page on an external site based on aliases defined in a rules topic
JQueryPlugin (2018-07-05, $Rev: 30456 (2018-07-16) $): jQuery JavaScript library for TWiki
PreferencesPlugin (2018-07-05, $Rev: 30528 (2018-07-16) $): Allows editing of preferences using fields predefined in a form
SetGetPlugin (2018-07-05, $Rev: 30472 (2018-07-16) $): Set and get variables and JSON objects in topics, optionally persistently across topic views
SlideShowPlugin (2018-07-05, $Rev: 30474 (2018-07-16) $): Create web based presentations based on topics with headings.
SmiliesPlugin (2018-07-05, $Rev: 30476 (2018-07-16) $): Render smilies as icons, like for :-) or for :eek:
TWikiSheetPlugin (2018-07-15, $Rev: 30604 (2018-07-16) $): Add TWiki Sheet spreadsheet functionality to TWiki tables
TablePlugin (2018-07-05, $Rev: 30480 (2018-07-16) $): Control attributes of tables and sorting of table columns
TagMePlugin (2018-07-05, $Rev: 30482 (2018-07-16) $): Tag wiki content collectively or authoritatively to find content by keywords
TinyMCEPlugin (2018-07-10, $Rev: 30541 (2018-07-16) $): Integration of the Tiny MCE WYSIWYG Editor
TwistyPlugin (2018-07-06, $Rev: 30497 (2018-07-16) $): Twisty section JavaScript library to open/close content dynamically
WatchlistPlugin (2018-07-10, $Rev: 30536 (2018-07-16) $): Watch topics of interest and get notified of changes by e-mail
WysiwygPlugin (2018-07-06, $Rev: 30528 (2018-07-16) $): Translator framework for WYSIWYG editors

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

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. '©' is the © copyright character. You need to escape '&' to see it as it is, so write '&' instead of '&'.
  Example: Type 'This & that' to get 'This & that'.

-- TWiki:Main.MikeMannix - 02 Dec 2001
-- TWiki:Main.PeterThoeny - 16 Mar 2004

>
>

TWiki Text Formatting

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.

TWiki Editing Shorthand

Formatting Command: Example: You write: You get:

Paragraphs:
Blank lines will create new paragraphs.

1st paragraph

2nd paragraph

1st paragraph

2nd paragraph

Headings:
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 %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.

---++ Sushi

---+++ Maguro

Sushi

Maguro

Bold Text:
Words get bold by enclosing them in * asterisks.

*Bold*

Bold

Italic Text:
Words get italic by enclosing them in _ underscores.

_Italic_

Italic

Bold Italic:
Words get _bold italic by enclosing them in _ double-underscores.

__Bold italic__

Bold italic

Fixed Font:
Words get shown in fixed font by enclosing them in = equal signs.

=Fixed font=

Fixed font

Bold Fixed Font:
Words get shown in bold fixed font by enclosing them in double equal signs.

==Bold fixed==

Bold fixed

Note: Make sure there is no space between the text and the bold, italic, or other indicators (* _ __ = ==).

_This works_,
_this not _

This works,
_this not _

Verbatim Mode:
Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags.
Note: Use <pre> and </pre> tags instead if you want that HTML code is interpreted.
Note: Each tag must be on a line by itself.

<verbatim>
class CatAnimal {
  void purr() {
	 <code here>
  }
}
</verbatim>

class CatAnimal {
  void purr() {
    <code here>
  }
}

Separator:
At least three dashes at the beginning of a line.

-------

List Item:
Three spaces, an asterisk, and another space.

	* bullet item

bullet item

Nested List Item:
Six, nine, ... spaces, an asterisk, and another space.

	* level 1
		* level 2

level 1
- level 2

Ordered List:
Three spaces, a number, and another space.

	1 Sushi
	1 Dim Sum

Sushi
Dim Sum

Definition List:
Three spaces, a dollar sign, the term, a colon, a space, followed by the definition.

	$ Sushi: Japan
	$ Dim Sum: S.F.

Sushi: Japan
Dim Sum: S.F.

Table:
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.
Notes:
• | *bold* | cells are displayed as table headers.
• | center-spaced | cells are displayed center aligned.
• | right-spaced | cells are displayed right aligned.
• | 2 colspan || cells are displayed as multi-span columns (i.e., a cell with no text spans a column).
• |^| cells with a caret indicate follow-up rows of multi-span rows (this functionality is provided by TablePlugin).
• 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 '\'.
• Table cells wrap automatically as determined by the browser.

| *L* | *C* | *R* |
| A2 |  2  |  2 |
| A3 |  3  |  3 |
| multi span |||
| A4-6 | four | four |
|^| five | five |



|^| six | six |

L	C	R
A2	2	2
A3	3	3
multi span
A4-6	four	four
	five	five
	six	six

WikiWord Links:
CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically.
Note: In case you want to link to a topic in a different KoreaCmsWiki? web write Webname.TopicName.

WebNotify

Know.ReadmeFirst

ReadmeFirst?

Forced Links:
You can create a forced internal link by enclosing words in double square brackets.
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, [[text formatting FAQ]] links to topic TextFormattingFAQ. You can also refer to a different web and use anchors.
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 ![[....

[[wiki syntax]]

[[Main.TWiki users]]

Specific Links:
Create a link where you can specify the link text and the link reference separately, using nested square brackets like [[reference][text]]. Internal link references (e.g. WikiSyntax) and external link references (e.g. http://TWiki.org/

) are supported.
Note: The same Forced Links rules apply for internal link references.
Note: For external link references, you can simply use a space instead of ][ to separate the link URL from the descriptive text.
Note: Anchor names can be added as well, like [[WebHome#MyAnchor][go home]] and [[http://gnu.org/#Action][GNU Action]].

[[WikiSyntax][syntax]]

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

[[http://xml.org XML]]

Anchors:
You can define a link reference inside a KoreaCmsWiki? 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 [[MyTopic#MyAnchor]] syntax. You can omit the topic name if you want to link within the same topic.

[[WikiWord#NotThere]]

[[#MyAnchor][Jump]]

#MyAnchor To here

To here

Prevent a Link:
Prevent a WikiWord from being linked by prepending it with an exclamation point.

!SunOS

SunOS

Disable Links:
You can disable automatic linking of WikiWords by surrounding text with <noautolink> and </noautolink> tags.
Note: Each tag must be on a line by itself.
Note: This also works for TWiki tables, but only if you add a blank line between the end of the table and the closing </noautolink> tag (known issue of the TablePlugin).

 <noautolink>
 RedHat &
 SuSE
 </noautolink>

RedHat & SuSE

Mailto: Links:
To create 'mailto:' links that have more descriptive link text, specify subject lines or message bodies, or omit the email address, you can write [[mailto:user@domain descriptive text]].

[[mailto:a@z.com Mail]]

[[mailto:?subject=Hi Hi]]

Mail

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 TWiki shorthand instead - this keeps the text uncluttered and easy to edit.
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.
- 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."
NOTE: The opening and closing angle brackets - <...> - 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, <, ex: a < b
- 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.

TWiki and JavaScript

You can use JavaScript for your TWiki applications. Sice TWiki rendering might interfere with JavaScript code you need to escape it with HTML comments and <pre> tags:

<script language="JavaScript">
<!-- Hide JavaScript and <pre> escape TWiki rendering
... put your JavaScript code here...
// Stop hiding and stop </pre> escaping TWiki rendering -->
</script>

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 GoodStyle topic located in the current KoreaCmsWiki? 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.

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

TWiki Variables

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

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

%WEB% : The current web, is TWiki.

%TOPIC% : The current topic name, is TextFormattingRules.

%ATTACHURL% : The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as %ATTACHURL%/image.gif to show the URL of the file or the image in your text.

%INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current KoreaCmsWiki? web is the default web. Example: %INCLUDE{"TWiki.SiteMap"}%

%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 %BR% to start a new line.
- Colored text: Write: %RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors to get: Red and blue colors.
- Documentation Graphics: Write: %H% Help, %T% Tip, %X% Alert to get: Help, Tip, Alert. For more info see TWikiDocGraphics.

There are many more variables, see TWikiVariables.

To "escape" a variable, prefix it with an exclamation point. Write: !%SOMEVARIABLE% to get: %SOMEVARIABLE%.

TWikiPlugin Formatting Extensions

Plugins provide additional text formatting capabilities and can extend the functionality of KoreaCmsWiki? into many other areas. For example, the optional SpreadSheetPlugin lets you create a spreadsheet with the same basic notation used in TWiki tables.

Available Plugins are located in the Plugins web on TWiki.org. Currently enabled plugins on this TWiki installation, as listed by %PLUGINDESCRIPTIONS%:

SpreadSheetPlugin (2018-07-05, $Rev: 30478 (2018-07-16) $): Add spreadsheet calculation like "$SUM( $ABOVE() )" to TWiki tables and other topic text
BackupRestorePlugin (2018-07-10, $Rev: 30551 (2018-07-16) $): Administrator utility to backup, restore and upgrade a TWiki site
ColorPickerPlugin (2018-07-05, $Rev: 30442 (2018-07-16) $): Color picker, packaged for use in TWiki forms and TWiki applications
CommentPlugin (2018-07-05, $Rev: 30530 (2018-07-16) $): Quickly post comments to a page without an edit/preview/save cycle
DatePickerPlugin (2018-07-05, $Rev: 30446 (2018-07-16) $): Pop-up calendar with date picker, for use in TWiki forms, HTML forms and TWiki plugins
EditTablePlugin (2018-07-05, $Rev: 30448 (2018-07-16) $): Edit TWiki tables using edit fields, date pickers and drop down boxes
HeadlinesPlugin (2018-07-13, $Rev: 30560 (2018-07-16) $): Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites
InterwikiPlugin (2018-07-05, $Rev: 30454 (2018-07-16) $): Write ExternalSite:Page to link to a page on an external site based on aliases defined in a rules topic
JQueryPlugin (2018-07-05, $Rev: 30456 (2018-07-16) $): jQuery JavaScript library for TWiki
PreferencesPlugin (2018-07-05, $Rev: 30528 (2018-07-16) $): Allows editing of preferences using fields predefined in a form
SetGetPlugin (2018-07-05, $Rev: 30472 (2018-07-16) $): Set and get variables and JSON objects in topics, optionally persistently across topic views
SlideShowPlugin (2018-07-05, $Rev: 30474 (2018-07-16) $): Create web based presentations based on topics with headings.
SmiliesPlugin (2018-07-05, $Rev: 30476 (2018-07-16) $): Render smilies as icons, like for :-) or for :eek:
TWikiSheetPlugin (2018-07-15, $Rev: 30604 (2018-07-16) $): Add TWiki Sheet spreadsheet functionality to TWiki tables
TablePlugin (2018-07-05, $Rev: 30480 (2018-07-16) $): Control attributes of tables and sorting of table columns
TagMePlugin (2018-07-05, $Rev: 30482 (2018-07-16) $): Tag wiki content collectively or authoritatively to find content by keywords
TinyMCEPlugin (2018-07-10, $Rev: 30541 (2018-07-16) $): Integration of the Tiny MCE WYSIWYG Editor
TwistyPlugin (2018-07-06, $Rev: 30497 (2018-07-16) $): Twisty section JavaScript library to open/close content dynamically
WatchlistPlugin (2018-07-10, $Rev: 30536 (2018-07-16) $): Watch topics of interest and get notified of changes by e-mail
WysiwygPlugin (2018-07-06, $Rev: 30528 (2018-07-16) $): Translator framework for WYSIWYG editors

Check on current Plugin status and settings for this site in TWikiPreferences.

Common Editing Errors

Added:

>
>

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

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. '©' is the © copyright character. You need to escape '&' to see it as it is, so write '&' instead of '&'.
  Example: Type 'This & that' to get 'This & that'.

-- TWiki:Main.MikeMannix - 02 Dec 2001
-- TWiki:Main.PeterThoeny - 29 Mar 2004

Revision 422004-03-17 - PeterThoeny?

TWiki Text Formatting

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.

TWiki Editing Shorthand

Formatting Command:	Example: You write:	You get:
Paragraphs: Blank lines will create new paragraphs.	1st paragraph 2nd paragraph	1st paragraph 2nd paragraph
Headings: 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 `%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.	---++ Sushi ---+++ Maguro	Sushi Maguro
Bold Text: Words get bold by enclosing them in `*` asterisks.	Bold	Bold
Italic Text: Words get italic by enclosing them in `_` underscores.	_Italic_	Italic
Bold Italic: Words get _bold italic by enclosing them in `_` double-underscores.	__Bold italic__	*Bold italic*
Fixed Font: Words get shown in `fixed font` by enclosing them in `=` equal signs.	=Fixed font=	`Fixed font`
Bold Fixed Font: Words get shown in `bold fixed font` by enclosing them in double equal signs.	==Bold fixed==	`Bold fixed`
*Note:* Make sure there is no space between the text and the bold, italic, or other indicators (`* _ __ = ==`).	_This works_, _this not _	This works, _this not _
Verbatim Mode: Surround code excerpts and other formatted text with `<verbatim>` and `</verbatim>` tags. *Note:* Use `<pre>` and `</pre>` tags instead if you want that HTML code is interpreted. *Note:* Each tag must be on a line by itself.	<verbatim> class CatAnimal { void purr() { <code here> } } </verbatim>	class CatAnimal { void purr() { <code here> } }
Separator: At least three dashes at the beginning of a line.	-------
List Item: Three spaces and an asterisk.	* bullet item	bullet item
Nested List Item: Six, nine, ... spaces and an asterisk.	* level 1 * level 2	level 1 level 2
Ordered List: Three spaces and a number.	1 Sushi 1 Dim Sum	Sushi Dim Sum
Definition List:

Changed:

<
< Three spaces, the term, a colon, a space, followed by the definition.

>
> Three spaces, a dollar sign, the term, a colon, a space, followed by the definition.

Deleted:

<
< 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   non-breaking-space entity.

Changed:

<
<

Sushi: Japan
Dim Sum: S.F.

>
>

Sushi: Japan
Dim Sum: S.F.

Changed:

<
<

Sushi: Japan
Dim Sum: S.F.

>
>

Sushi: Japan
Dim Sum: S.F.

Table:
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.
Notes:
• | *bold* | cells are displayed as table headers.
• | center-spaced | cells are displayed center aligned.
• | right-spaced | cells are displayed right aligned.
• | 2 colspan || cells are displayed as multi-span columns (i.e., a cell with no text spans a column).
• |^| cells with a caret indicate follow-up rows of multi-span rows.
• 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 '\'.
• Table cells wrap automatically as determined by the browser.

| *L* | *C* | *R* |
| A2 |  2  |  2 |
| A3 |  3  |  3 |
| multi span |||
| A4-6 | four | four |
|^| five | five |

Added:

>
>

six

L	C	R
A2	2	2
A3	3	3
multi span
A4-6	four	four
	five	five
	six	six

WikiWord Links:
CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically.
Note: In case you want to link to a topic in a different KoreaCmsWiki? web write Webname.TopicName.

WebNotify

Know.ReadmeFirst

ReadmeFirst?

Forced Links:
You can create a forced internal link by enclosing words in double square brackets.
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, [[text formatting FAQ]] links to topic TextFormattingFAQ. You can also refer to a different web and use anchors.
Note: To "escape" double square brackets that would otherwise be a correct link, use <nop> between the leading left square brackets, that is, begin with [<nop>[....

[[wiki syntax]]

[[Main.TWiki users]]

Specific Links:
Create a link where you can specify the link text and the link reference separately, using nested square brackets like [[reference][text]]. Internal link references (e.g. WikiSyntax) and external link references (e.g. http://TWiki.org/

) are supported.
Note: The same Forced Links rules apply for internal link references.
Note: For external link references, you can simply use a space instead of ][ to separate the link URL from the descriptive text.
Note: Anchor names can be added as well, like [[WebHome#MyAnchor][go home]] and [[http://gnu.org/#Action][GNU Action]].

[[WikiSyntax][syntax]]

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

[[http://xml.org XML]]

Anchors:
You can define a link reference inside a KoreaCmsWiki? 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 [[MyTopic#MyAnchor]] syntax. You can omit the topic name if you want to link within the same topic.

[[WikiWord#NotThere]]

[[#MyAnchor][Jump]]

#MyAnchor To here

To here

Prevent a Link:
Prevent a WikiWord from being linked by prepending it with the <nop> tag.

<nop>SunOS

SunOS

Disable Links:
You can disable automatic linking of WikiWords by surrounding text with <noautolink> and </noautolink> tags.
Note: Each tag must be on a line by itself.
Note: This also works for TWiki tables, but only if you add a blank line between the end of the table and the closing </noautolink> tag (known issue of the TablePlugin).

 <noautolink>
 RedHat &
 SuSE
 </noautolink>

RedHat & SuSE

Mailto: Links:
To create 'mailto:' links that have more descriptive link text, specify subject lines or message bodies, or omit the email address, you can write [[mailto:user@domain descriptive text]].

[[mailto:a@z.com Mail]]

[[mailto:?subject=Hi Hi]]

Mail

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 TWiki shorthand instead - this keeps the text uncluttered and easy to edit.
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.
- 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."
NOTE: The opening and closing angle brackets - <...> - 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, <, ex: a < b
- 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 GoodStyle topic located in the current KoreaCmsWiki? 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.

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

TWiki Variables

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

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

%WEB% : The current web, is TWiki.

%TOPIC% : The current topic name, is TextFormattingRules.

%ATTACHURL% : The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as %ATTACHURL%/image.gif to show the URL of the file or the image in your text.

%INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current KoreaCmsWiki? web is the default web. Example: %INCLUDE{"TWiki.SiteMap"}%

%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 %BR% to start a new line.
- Colored text: Write: %RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors to get: Red and blue colors.
- Documentation Graphics: Write: %H% Help, %T% Tip, %X% Alert to get: Help, Tip, 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 <nop> after the first percent sign. Write: %<nop>SOMEVARIABLE% to get: %SOMEVARIABLE%.

TWikiPlugin Formatting Extensions

Plugins provide additional text formatting capabilities and can extend the functionality of KoreaCmsWiki? into many other areas. For example, the optional SpreadSheetPlugin lets you create a spreadsheet with the same basic notation used in TWiki tables.

Available Plugins are located in the Plugins web on TWiki.org. Currently enabled plugins on this TWiki installation, as listed by %PLUGINDESCRIPTIONS%:

SpreadSheetPlugin (2018-07-05, $Rev: 30478 (2018-07-16) $): Add spreadsheet calculation like "$SUM( $ABOVE() )" to TWiki tables and other topic text
BackupRestorePlugin (2018-07-10, $Rev: 30551 (2018-07-16) $): Administrator utility to backup, restore and upgrade a TWiki site
ColorPickerPlugin (2018-07-05, $Rev: 30442 (2018-07-16) $): Color picker, packaged for use in TWiki forms and TWiki applications
CommentPlugin (2018-07-05, $Rev: 30530 (2018-07-16) $): Quickly post comments to a page without an edit/preview/save cycle
DatePickerPlugin (2018-07-05, $Rev: 30446 (2018-07-16) $): Pop-up calendar with date picker, for use in TWiki forms, HTML forms and TWiki plugins
EditTablePlugin (2018-07-05, $Rev: 30448 (2018-07-16) $): Edit TWiki tables using edit fields, date pickers and drop down boxes
HeadlinesPlugin (2018-07-13, $Rev: 30560 (2018-07-16) $): Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites
InterwikiPlugin (2018-07-05, $Rev: 30454 (2018-07-16) $): Write ExternalSite:Page to link to a page on an external site based on aliases defined in a rules topic
JQueryPlugin (2018-07-05, $Rev: 30456 (2018-07-16) $): jQuery JavaScript library for TWiki
PreferencesPlugin (2018-07-05, $Rev: 30528 (2018-07-16) $): Allows editing of preferences using fields predefined in a form
SetGetPlugin (2018-07-05, $Rev: 30472 (2018-07-16) $): Set and get variables and JSON objects in topics, optionally persistently across topic views
SlideShowPlugin (2018-07-05, $Rev: 30474 (2018-07-16) $): Create web based presentations based on topics with headings.
SmiliesPlugin (2018-07-05, $Rev: 30476 (2018-07-16) $): Render smilies as icons, like for :-) or for :eek:
TWikiSheetPlugin (2018-07-15, $Rev: 30604 (2018-07-16) $): Add TWiki Sheet spreadsheet functionality to TWiki tables
TablePlugin (2018-07-05, $Rev: 30480 (2018-07-16) $): Control attributes of tables and sorting of table columns
TagMePlugin (2018-07-05, $Rev: 30482 (2018-07-16) $): Tag wiki content collectively or authoritatively to find content by keywords
TinyMCEPlugin (2018-07-10, $Rev: 30541 (2018-07-16) $): Integration of the Tiny MCE WYSIWYG Editor
TwistyPlugin (2018-07-06, $Rev: 30497 (2018-07-16) $): Twisty section JavaScript library to open/close content dynamically
WatchlistPlugin (2018-07-10, $Rev: 30536 (2018-07-16) $): Watch topics of interest and get notified of changes by e-mail
WysiwygPlugin (2018-07-06, $Rev: 30528 (2018-07-16) $): Translator framework for WYSIWYG editors

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

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. '©' is the © copyright character. You need to escape '&' to see it as it is, so write '&' instead of '&'.
  Example: Type 'This & that' to get 'This & that'.

Changed: <
<-- MikeMannix? - 02 Dec 2001
-- PeterThoeny? - 15 Jul 2003>
>-- TWiki:Main.MikeMannix

- 02 Dec 2001
-- TWiki:Main.PeterThoeny

- 16 Mar 2004

Revision 412003-12-16 - PeterThoeny?

TWiki Text Formatting

TWiki Text Formatting

Changed:

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

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

TWiki Editing Shorthand

Formatting Command: Example: You write: You get:

Paragraphs:
Blank lines will create new paragraphs.

1st paragraph

2nd paragraph

1st paragraph

2nd paragraph

Headings:
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 %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.

---++ Sushi

---+++ Maguro

Sushi

Maguro

Bold Text:
Words get bold by enclosing them in * asterisks.

*Bold*

Bold

Italic Text:
Words get italic by enclosing them in _ underscores.

_Italic_

Italic

Bold Italic:
Words get _bold italic by enclosing them in _ double-underscores.

__Bold italic__

Bold italic

Fixed Font:
Words get shown in fixed font by enclosing them in = equal signs.

=Fixed font=

Fixed font

Bold Fixed Font:
Words get shown in bold fixed font by enclosing them in double equal signs.

==Bold fixed==

Bold fixed

Note: Make sure there is no space between the text and the bold, italic, or other indicators (* _ __ = ==).

_This works_,
_this not _

This works,
_this not _

Verbatim Mode:
Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags.
Note: Use <pre> and </pre> tags instead if you want that HTML code is interpreted.
Note: Each tag must be on a line by itself.

<verbatim>
class CatAnimal {
  void purr() {
	 <code here>
  }
}
</verbatim>

class CatAnimal {
  void purr() {
    <code here>
  }
}

Separator:
At least three dashes at the beginning of a line.

-------

List Item:
Three spaces and an asterisk.

	* bullet item

bullet item

Nested List Item:
Six, nine, ... spaces and an asterisk.

	* level 1
		* level 2

level 1
- level 2

Ordered List:
Three spaces and a number.

	1 Sushi
	1 Dim Sum

Sushi
Dim Sum

Definition List:
Three spaces, the term, a colon, a space, followed by the definition.
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   non-breaking-space entity.

	Sushi: Japan
	Dim&nbsp;Sum: S.F.

Sushi: Japan
Dim Sum: S.F.

Table:
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.
Notes:
• | *bold* | cells are displayed as table headers.
• | center-spaced | cells are displayed center aligned.
• | right-spaced | cells are displayed right aligned.
• | 2 colspan || cells are displayed as multi-span columns (i.e., a cell with no text spans a column).
• |^| cells with a caret indicate follow-up rows of multi-span rows.
• 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 '\'.
• Table cells wrap automatically as determined by the browser.

| *L* | *C* | *R* |
| A2 |  2  |  2 |
| A3 |  3  |  3 |
| multi span |||
| A4-6 | four | four |
|^| five | five |
|^| six | six |

L	C	R
A2	2	2
A3	3	3
multi span
A4-6	four	four
	five	five
	six	six

WikiWord Links:
CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically.
Note: In case you want to link to a topic in a different KoreaCmsWiki? web write Webname.TopicName.

WebNotify

Know.ReadmeFirst

ReadmeFirst?

Forced Links:
You can create a forced internal link by enclosing words in double square brackets.
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, [[text formatting FAQ]] links to topic TextFormattingFAQ. You can also refer to a different web and use anchors.
Note: To "escape" double square brackets that would otherwise be a correct link, use <nop> between the leading left square brackets, that is, begin with [<nop>[....

[[wiki syntax]]

[[Main.TWiki users]]

Specific Links:
Create a link where you can specify the link text and the link reference separately, using nested square brackets like [[reference][text]]. Internal link references (e.g. WikiSyntax) and external link references (e.g. http://TWiki.org/

) are supported.
Note: The same Forced Links rules apply for internal link references.
Note: For external link references, you can simply use a space instead of ][ to separate the link URL from the descriptive text.
Note: Anchor names can be added as well, like [[WebHome#MyAnchor][go home]] and [[http://gnu.org/#Action][GNU Action]].

[[WikiSyntax][syntax]]

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

[[http://xml.org XML]]

Anchors:
You can define a link reference inside a KoreaCmsWiki? 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 [[MyTopic#MyAnchor]] syntax. You can omit the topic name if you want to link within the same topic.

[[WikiWord#NotThere]]

[[#MyAnchor][Jump]]

#MyAnchor To here

To here

Prevent a Link:
Prevent a WikiWord from being linked by prepending it with the <nop> tag.

<nop>SunOS

SunOS

Disable Links:
You can disable automatic linking of WikiWords by surrounding text with <noautolink> and </noautolink> tags.
Note: Each tag must be on a line by itself.
Note: This also works for TWiki tables, but only if you add a blank line between the end of the table and the closing </noautolink> tag (known issue of the TablePlugin).

 <noautolink>
 RedHat &
 SuSE
 </noautolink>

RedHat & SuSE

Mailto: Links:
To create 'mailto:' links that have more descriptive link text, specify subject lines or message bodies, or omit the email address, you can write [[mailto:user@domain descriptive text]].

[[mailto:a@z.com Mail]]

[[mailto:?subject=Hi Hi]]

Mail

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 TWiki shorthand instead - this keeps the text uncluttered and easy to edit.
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.
- 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."
NOTE: The opening and closing angle brackets - <...> - 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, <, ex: a < b
- 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 GoodStyle topic located in the current KoreaCmsWiki? 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.

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

TWiki Variables

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

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

%WEB% : The current web, is TWiki.

%TOPIC% : The current topic name, is TextFormattingRules.

%ATTACHURL% : The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as %ATTACHURL%/image.gif to show the URL of the file or the image in your text.

%INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current KoreaCmsWiki? web is the default web. Example: %INCLUDE{"TWiki.SiteMap"}%

%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 %BR% to start a new line.
- Colored text: Write: %RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors to get: Red and blue colors.
- Documentation Graphics: Write: %H% Help, %T% Tip, %X% Alert to get: Help, Tip, 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 <nop> after the first percent sign. Write: %<nop>SOMEVARIABLE% to get: %SOMEVARIABLE%.

TWikiPlugin Formatting Extensions

Plugins provide additional text formatting capabilities and can extend the functionality of KoreaCmsWiki? into many other areas. For example, the optional SpreadSheetPlugin lets you create a spreadsheet with the same basic notation used in TWiki tables.

Available Plugins are located in the Plugins web on TWiki.org. Currently enabled plugins on this TWiki installation, as listed by %PLUGINDESCRIPTIONS%:

SpreadSheetPlugin (2018-07-05, $Rev: 30478 (2018-07-16) $): Add spreadsheet calculation like "$SUM( $ABOVE() )" to TWiki tables and other topic text
BackupRestorePlugin (2018-07-10, $Rev: 30551 (2018-07-16) $): Administrator utility to backup, restore and upgrade a TWiki site
ColorPickerPlugin (2018-07-05, $Rev: 30442 (2018-07-16) $): Color picker, packaged for use in TWiki forms and TWiki applications
CommentPlugin (2018-07-05, $Rev: 30530 (2018-07-16) $): Quickly post comments to a page without an edit/preview/save cycle
DatePickerPlugin (2018-07-05, $Rev: 30446 (2018-07-16) $): Pop-up calendar with date picker, for use in TWiki forms, HTML forms and TWiki plugins
EditTablePlugin (2018-07-05, $Rev: 30448 (2018-07-16) $): Edit TWiki tables using edit fields, date pickers and drop down boxes
HeadlinesPlugin (2018-07-13, $Rev: 30560 (2018-07-16) $): Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites
InterwikiPlugin (2018-07-05, $Rev: 30454 (2018-07-16) $): Write ExternalSite:Page to link to a page on an external site based on aliases defined in a rules topic
JQueryPlugin (2018-07-05, $Rev: 30456 (2018-07-16) $): jQuery JavaScript library for TWiki
PreferencesPlugin (2018-07-05, $Rev: 30528 (2018-07-16) $): Allows editing of preferences using fields predefined in a form
SetGetPlugin (2018-07-05, $Rev: 30472 (2018-07-16) $): Set and get variables and JSON objects in topics, optionally persistently across topic views
SlideShowPlugin (2018-07-05, $Rev: 30474 (2018-07-16) $): Create web based presentations based on topics with headings.
SmiliesPlugin (2018-07-05, $Rev: 30476 (2018-07-16) $): Render smilies as icons, like for :-) or for :eek:
TWikiSheetPlugin (2018-07-15, $Rev: 30604 (2018-07-16) $): Add TWiki Sheet spreadsheet functionality to TWiki tables
TablePlugin (2018-07-05, $Rev: 30480 (2018-07-16) $): Control attributes of tables and sorting of table columns
TagMePlugin (2018-07-05, $Rev: 30482 (2018-07-16) $): Tag wiki content collectively or authoritatively to find content by keywords
TinyMCEPlugin (2018-07-10, $Rev: 30541 (2018-07-16) $): Integration of the Tiny MCE WYSIWYG Editor
TwistyPlugin (2018-07-06, $Rev: 30497 (2018-07-16) $): Twisty section JavaScript library to open/close content dynamically
WatchlistPlugin (2018-07-10, $Rev: 30536 (2018-07-16) $): Watch topics of interest and get notified of changes by e-mail
WysiwygPlugin (2018-07-06, $Rev: 30528 (2018-07-16) $): Translator framework for WYSIWYG editors

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

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. '©' is the © copyright character. You need to escape '&' to see it as it is, so write '&' instead of '&'.
  Example: Type 'This & that' to get 'This & that'.

-- MikeMannix? - 02 Dec 2001
-- PeterThoeny? - 15 Jul 2003

Revision 402003-08-01 - PeterThoeny?

TWiki Text Formatting

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.

TWiki Editing Shorthand

Formatting Command: Example: You write: You get:

Paragraphs:
Blank lines will create new paragraphs.

1st paragraph

2nd paragraph

1st paragraph

2nd paragraph

Headings:
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 %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.

---++ Sushi

---+++ Maguro

Sushi

Maguro

Bold Text:
Words get bold by enclosing them in * asterisks.

*Bold*

Bold

Italic Text:
Words get italic by enclosing them in _ underscores.

_Italic_

Italic

Bold Italic:
Words get _bold italic by enclosing them in _ double-underscores.

__Bold italic__

Bold italic

Fixed Font:
Words get shown in fixed font by enclosing them in = equal signs.

=Fixed font=

Fixed font

Bold Fixed Font:
Words get shown in bold fixed font by enclosing them in double equal signs.

==Bold fixed==

Bold fixed

Note: Make sure there is no space between the text and the bold, italic, or other indicators (* _ __ = ==).

_This works_,
_this not _

This works,
_this not _

Verbatim Mode:
Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags.
Note: Use <pre> and </pre> tags instead if you want that HTML code is interpreted.
Note: Each tag must be on a line by itself.

<verbatim>
class CatAnimal {
  void purr() {
	 <code here>
  }
}
</verbatim>

class CatAnimal {
  void purr() {
    <code here>
  }
}

Separator:
At least three dashes at the beginning of a line.

-------

List Item:
Three spaces and an asterisk.

	* bullet item

bullet item

Nested List Item:
Six, nine, ... spaces and an asterisk.

	* level 1
		* level 2

level 1
- level 2

Ordered List:
Three spaces and a number.

	1 Sushi
	1 Dim Sum

Sushi
Dim Sum

Definition List:
Three spaces, the term, a colon, a space, followed by the definition.
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   non-breaking-space entity.

	Sushi: Japan
	Dim&nbsp;Sum: S.F.

Sushi: Japan
Dim Sum: S.F.

Table:
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.
Notes:
• | *bold* | cells are displayed as table headers.
• | center-spaced | cells are displayed center aligned.
• | right-spaced | cells are displayed right aligned.
• | 2 colspan || cells are displayed as multi-span columns (i.e., a cell with no text spans a column).
• |^| cells with a caret indicate follow-up rows of multi-span rows.
• 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 '\'.
• Table cells wrap automatically as determined by the browser.

| *L* | *C* | *R* |
| A2 |  2  |  2 |
| A3 |  3  |  3 |
| multi span |||
| A4-6 | four | four |
|^| five | five |
|^| six | six |

L	C	R
A2	2	2
A3	3	3
multi span
A4-6	four	four
	five	five
	six	six

WikiWord Links:
CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically.
Note: In case you want to link to a topic in a different KoreaCmsWiki? web write Webname.TopicName.

WebNotify

Know.ReadmeFirst

ReadmeFirst?

Forced Links:
You can create a forced internal link by enclosing words in double square brackets.
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, [[text formatting FAQ]] links to topic TextFormattingFAQ. You can also refer to a different web and use anchors.

Added:

>
> Note: To "escape" double square brackets that would otherwise be a correct link, use <nop> between the leading left square brackets, that is, begin with [<nop>[....

[[wiki syntax]] [[Main.TWiki users]]	wiki syntax Main.TWiki users
Specific Links: Create a link where you can specify the link text and the link reference separately, using nested square brackets like `[[reference][text]]`. Internal link references (e.g. WikiSyntax) and external link references (e.g. http://TWiki.org/) are supported. *Note:* The same *Forced Links* rules apply for internal link references. *Note:* For external link references, you can simply use a space instead of `][` to separate the link URL from the descriptive text. *Note:* Anchor names can be added as well, like `[[WebHome#MyAnchor][go home]]` and `[[http://gnu.org/#Action][GNU Action]]`.	[[WikiSyntax][syntax]] [[http://gnu.org][GNU]] [[http://xml.org XML]]	syntax GNU XML
Anchors: You can define a link reference inside a KoreaCmsWiki? 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 `[[MyTopic#MyAnchor]]` syntax. You can omit the topic name if you want to link within the same topic.	[[WikiWord#NotThere]] [[#MyAnchor][Jump]] #MyAnchor To here	WikiWord#NotThere Jump To here
Prevent a Link: Prevent a WikiWord from being linked by prepending it with the `<nop>` tag.	<nop>SunOS	SunOS
Disable Links: You can disable automatic linking of WikiWords by surrounding text with `<noautolink>` and `</noautolink>` tags. *Note:* Each tag must be on a line by itself. *Note:* This also works for TWiki tables, but only if you add a blank line between the end of the table and the closing `</noautolink>` tag (known issue of the TablePlugin).	<noautolink> RedHat & SuSE </noautolink>	RedHat & SuSE
Mailto: Links: To create 'mailto:' links that have more descriptive link text, specify subject lines or message bodies, or omit the email address, you can write `[[mailto:user@domain descriptive text]]`.	[[mailto:a@z.com Mail]] [[mailto:?subject=Hi Hi]]	Mail Hi

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 TWiki shorthand instead - this keeps the text uncluttered and easy to edit.
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.
- 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."
NOTE: The opening and closing angle brackets - <...> - 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, <, ex: a < b
- 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 GoodStyle topic located in the current KoreaCmsWiki? 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.

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

TWiki Variables

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

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

%WEB% : The current web, is TWiki.

%TOPIC% : The current topic name, is TextFormattingRules.

%ATTACHURL% : The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as %ATTACHURL%/image.gif to show the URL of the file or the image in your text.

%INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current KoreaCmsWiki? web is the default web. Example: %INCLUDE{"TWiki.SiteMap"}%

%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 %BR% to start a new line.
- Colored text: Write: %RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors to get: Red and blue colors.
- Documentation Graphics: Write: %H% Help, %T% Tip, %X% Alert to get: Help, Tip, Alert. For more info see TWikiDocGraphics.

There are many more variables, see TWikiVariables.

Added:

>
>

To "escape" a percent sign that would otherwise be interpreted as a variable, add <nop> after the first percent sign. Write: %<nop>SOMEVARIABLE% to get: %SOMEVARIABLE%.

TWikiPlugin Formatting Extensions

Plugins provide additional text formatting capabilities and can extend the functionality of KoreaCmsWiki? into many other areas. For example, the optional SpreadSheetPlugin lets you create a spreadsheet with the same basic notation used in TWiki tables.

Available Plugins are located in the Plugins web on TWiki.org. Currently enabled plugins on this TWiki installation, as listed by %PLUGINDESCRIPTIONS%:

SpreadSheetPlugin (2018-07-05, $Rev: 30478 (2018-07-16) $): Add spreadsheet calculation like "$SUM( $ABOVE() )" to TWiki tables and other topic text
BackupRestorePlugin (2018-07-10, $Rev: 30551 (2018-07-16) $): Administrator utility to backup, restore and upgrade a TWiki site
ColorPickerPlugin (2018-07-05, $Rev: 30442 (2018-07-16) $): Color picker, packaged for use in TWiki forms and TWiki applications
CommentPlugin (2018-07-05, $Rev: 30530 (2018-07-16) $): Quickly post comments to a page without an edit/preview/save cycle
DatePickerPlugin (2018-07-05, $Rev: 30446 (2018-07-16) $): Pop-up calendar with date picker, for use in TWiki forms, HTML forms and TWiki plugins
EditTablePlugin (2018-07-05, $Rev: 30448 (2018-07-16) $): Edit TWiki tables using edit fields, date pickers and drop down boxes
HeadlinesPlugin (2018-07-13, $Rev: 30560 (2018-07-16) $): Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites
InterwikiPlugin (2018-07-05, $Rev: 30454 (2018-07-16) $): Write ExternalSite:Page to link to a page on an external site based on aliases defined in a rules topic
JQueryPlugin (2018-07-05, $Rev: 30456 (2018-07-16) $): jQuery JavaScript library for TWiki
PreferencesPlugin (2018-07-05, $Rev: 30528 (2018-07-16) $): Allows editing of preferences using fields predefined in a form
SetGetPlugin (2018-07-05, $Rev: 30472 (2018-07-16) $): Set and get variables and JSON objects in topics, optionally persistently across topic views
SlideShowPlugin (2018-07-05, $Rev: 30474 (2018-07-16) $): Create web based presentations based on topics with headings.
SmiliesPlugin (2018-07-05, $Rev: 30476 (2018-07-16) $): Render smilies as icons, like for :-) or for :eek:
TWikiSheetPlugin (2018-07-15, $Rev: 30604 (2018-07-16) $): Add TWiki Sheet spreadsheet functionality to TWiki tables
TablePlugin (2018-07-05, $Rev: 30480 (2018-07-16) $): Control attributes of tables and sorting of table columns
TagMePlugin (2018-07-05, $Rev: 30482 (2018-07-16) $): Tag wiki content collectively or authoritatively to find content by keywords
TinyMCEPlugin (2018-07-10, $Rev: 30541 (2018-07-16) $): Integration of the Tiny MCE WYSIWYG Editor
TwistyPlugin (2018-07-06, $Rev: 30497 (2018-07-16) $): Twisty section JavaScript library to open/close content dynamically
WatchlistPlugin (2018-07-10, $Rev: 30536 (2018-07-16) $): Watch topics of interest and get notified of changes by e-mail
WysiwygPlugin (2018-07-06, $Rev: 30528 (2018-07-16) $): Translator framework for WYSIWYG editors

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

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. '©' is the © copyright character. You need to escape '&' to see it as it is, so write '&' instead of '&'.
  Example: Type 'This & that' to get 'This & that'.

-- MikeMannix? - 02 Dec 2001
-- PeterThoeny? - 15 Jul 2003

Revision 392003-07-26 - PeterThoeny?

TWiki Text Formatting

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.

TWiki Editing Shorthand

Formatting Command: Example: You write: You get:

Paragraphs:
Blank lines will create new paragraphs.

1st paragraph

2nd paragraph

1st paragraph

2nd paragraph

Headings:
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 %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.

---++ Sushi

---+++ Maguro

Sushi

Maguro

Bold Text:
Words get bold by enclosing them in * asterisks.

*Bold*

Bold

Italic Text:
Words get italic by enclosing them in _ underscores.

_Italic_

Italic

Bold Italic:
Words get _bold italic by enclosing them in _ double-underscores.

__Bold italic__

Bold italic

Fixed Font:
Words get shown in fixed font by enclosing them in = equal signs.

=Fixed font=

Fixed font

Bold Fixed Font:
Words get shown in bold fixed font by enclosing them in double equal signs.

==Bold fixed==

Bold fixed

Note: Make sure there is no space between the text and the bold, italic, or other indicators (* _ __ = ==).

_This works_,
_this not _

This works,
_this not _

Verbatim Mode:
Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags.
Note: Use <pre> and </pre> tags instead if you want that HTML code is interpreted.
Note: Each tag must be on a line by itself.

<verbatim>
class CatAnimal {
  void purr() {
	 <code here>
  }
}
</verbatim>

class CatAnimal {
  void purr() {
    <code here>
  }
}

Separator:
At least three dashes at the beginning of a line.

-------

List Item:
Three spaces and an asterisk.

	* bullet item

bullet item

Nested List Item:
Six, nine, ... spaces and an asterisk.

	* level 1
		* level 2

level 1
- level 2

Ordered List:
Three spaces and a number.

	1 Sushi
	1 Dim Sum

Sushi
Dim Sum

Definition List:
Three spaces, the term, a colon, a space, followed by the definition.
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   non-breaking-space entity.

	Sushi: Japan
	Dim&nbsp;Sum: S.F.

Sushi: Japan
Dim Sum: S.F.

Table:
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.
Notes:
• | *bold* | cells are displayed as table headers.
• | center-spaced | cells are displayed center aligned.
• | right-spaced | cells are displayed right aligned.
• | 2 colspan || cells are displayed as multi-span columns (i.e., a cell with no text spans a column).
• |^| cells with a caret indicate follow-up rows of multi-span rows.
• 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 '\'.
• Table cells wrap automatically as determined by the browser.

| *L* | *C* | *R* |
| A2 |  2  |  2 |
| A3 |  3  |  3 |
| multi span |||
| A4-6 | four | four |
|^| five | five |
|^| six | six |

L	C	R
A2	2	2
A3	3	3
multi span
A4-6	four	four
	five	five
	six	six

WikiWord Links:
CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically.
Note: In case you want to link to a topic in a different KoreaCmsWiki? web write Webname.TopicName.

WebNotify

Know.ReadmeFirst

ReadmeFirst?

Forced Links:
You can create a forced internal link by enclosing words in double square brackets.
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, [[text formatting FAQ]] links to topic TextFormattingFAQ. You can also refer to a different web and use anchors.

[[wiki syntax]]

[[Main.TWiki users]]

Specific Links:
Create a link where you can specify the link text and the link reference separately, using nested square brackets like [[reference][text]]. Internal link references (e.g. WikiSyntax) and external link references (e.g. http://TWiki.org/

) are supported.
Note: The same Forced Links rules apply for internal link references.
Note: For external link references, you can simply use a space instead of ][ to separate the link URL from the descriptive text.

Changed:

<
< Note: Anchor names can be added as well, like [[WebHome#MyAnchor][go home]] and [[http://gnu.org/#Action][GNU Action]].

>
> Note: Anchor names can be added as well, like [[WebHome#MyAnchor][go home]] and [[http://gnu.org/#Action][GNU Action]].

[[WikiSyntax][syntax]]

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

[[http://xml.org XML]]

Anchors:
You can define a link reference inside a KoreaCmsWiki? 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 [[MyTopic#MyAnchor]] syntax. You can omit the topic name if you want to link within the same topic.

Changed:

<
< WebHome#NotThere

>
> WikiWord#NotThere

To here

Changed:

<
< WebHome#NotThere

>
> WikiWord#NotThere

To here

Prevent a Link: Prevent a WikiWord from being linked by prepending it with the `<nop>` tag.	<nop>SunOS	SunOS
Disable Links: You can disable automatic linking of WikiWords by surrounding text with `<noautolink>` and `</noautolink>` tags. *Note:* Each tag must be on a line by itself. *Note:* This also works for TWiki tables, but only if you add a blank line between the end of the table and the closing `</noautolink>` tag (known issue of the TablePlugin).	<noautolink> RedHat & SuSE </noautolink>	RedHat & SuSE
Mailto: Links: To create 'mailto:' links that have more descriptive link text, specify subject lines or message bodies, or omit the email address, you can write `[[mailto:user@domain descriptive text]]`.	[[mailto:a@z.com Mail]] [[mailto:?subject=Hi Hi]]	Mail Hi

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 TWiki shorthand instead - this keeps the text uncluttered and easy to edit.
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.
- 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."
NOTE: The opening and closing angle brackets - <...> - 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, <, ex: a < b
- 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 GoodStyle topic located in the current KoreaCmsWiki? 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.

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

TWiki Variables

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

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

%WEB% : The current web, is TWiki.

%TOPIC% : The current topic name, is TextFormattingRules.

%ATTACHURL% : The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as %ATTACHURL%/image.gif to show the URL of the file or the image in your text.

%INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current KoreaCmsWiki? web is the default web. Example: %INCLUDE{"TWiki.SiteMap"}%

%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 %BR% to start a new line.
- Colored text: Write: %RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors to get: Red and blue colors.
- Documentation Graphics: Write: %H% Help, %T% Tip, %X% Alert to get: Help, Tip, Alert. For more info see TWikiDocGraphics.

There are many more variables, see TWikiVariables.

TWikiPlugin Formatting Extensions

Plugins provide additional text formatting capabilities and can extend the functionality of KoreaCmsWiki? into many other areas. For example, the optional SpreadSheetPlugin lets you create a spreadsheet with the same basic notation used in TWiki tables.

Available Plugins are located in the Plugins web on TWiki.org. Currently enabled plugins on this TWiki installation, as listed by %PLUGINDESCRIPTIONS%:

SpreadSheetPlugin (2018-07-05, $Rev: 30478 (2018-07-16) $): Add spreadsheet calculation like "$SUM( $ABOVE() )" to TWiki tables and other topic text
BackupRestorePlugin (2018-07-10, $Rev: 30551 (2018-07-16) $): Administrator utility to backup, restore and upgrade a TWiki site
ColorPickerPlugin (2018-07-05, $Rev: 30442 (2018-07-16) $): Color picker, packaged for use in TWiki forms and TWiki applications
CommentPlugin (2018-07-05, $Rev: 30530 (2018-07-16) $): Quickly post comments to a page without an edit/preview/save cycle
DatePickerPlugin (2018-07-05, $Rev: 30446 (2018-07-16) $): Pop-up calendar with date picker, for use in TWiki forms, HTML forms and TWiki plugins
EditTablePlugin (2018-07-05, $Rev: 30448 (2018-07-16) $): Edit TWiki tables using edit fields, date pickers and drop down boxes
HeadlinesPlugin (2018-07-13, $Rev: 30560 (2018-07-16) $): Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites
InterwikiPlugin (2018-07-05, $Rev: 30454 (2018-07-16) $): Write ExternalSite:Page to link to a page on an external site based on aliases defined in a rules topic
JQueryPlugin (2018-07-05, $Rev: 30456 (2018-07-16) $): jQuery JavaScript library for TWiki
PreferencesPlugin (2018-07-05, $Rev: 30528 (2018-07-16) $): Allows editing of preferences using fields predefined in a form
SetGetPlugin (2018-07-05, $Rev: 30472 (2018-07-16) $): Set and get variables and JSON objects in topics, optionally persistently across topic views
SlideShowPlugin (2018-07-05, $Rev: 30474 (2018-07-16) $): Create web based presentations based on topics with headings.
SmiliesPlugin (2018-07-05, $Rev: 30476 (2018-07-16) $): Render smilies as icons, like for :-) or for :eek:
TWikiSheetPlugin (2018-07-15, $Rev: 30604 (2018-07-16) $): Add TWiki Sheet spreadsheet functionality to TWiki tables
TablePlugin (2018-07-05, $Rev: 30480 (2018-07-16) $): Control attributes of tables and sorting of table columns
TagMePlugin (2018-07-05, $Rev: 30482 (2018-07-16) $): Tag wiki content collectively or authoritatively to find content by keywords
TinyMCEPlugin (2018-07-10, $Rev: 30541 (2018-07-16) $): Integration of the Tiny MCE WYSIWYG Editor
TwistyPlugin (2018-07-06, $Rev: 30497 (2018-07-16) $): Twisty section JavaScript library to open/close content dynamically
WatchlistPlugin (2018-07-10, $Rev: 30536 (2018-07-16) $): Watch topics of interest and get notified of changes by e-mail
WysiwygPlugin (2018-07-06, $Rev: 30528 (2018-07-16) $): Translator framework for WYSIWYG editors

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

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. '©' is the © copyright character. You need to escape '&' to see it as it is, so write '&' instead of '&'.
  Example: Type 'This & that' to get 'This & that'.

-- MikeMannix? - 02 Dec 2001
-- PeterThoeny? - 15 Jul 2003

Revision 382003-07-16 - PeterThoeny?

TWiki Text Formatting

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.

TWiki Editing Shorthand

Formatting Command:	Example: You write:	You get:
Paragraphs: Blank lines will create new paragraphs.	1st paragraph 2nd paragraph	1st paragraph 2nd paragraph
Headings: 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 `%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.	---++ Sushi ---+++ Maguro	Sushi Maguro
Bold Text: Words get bold by enclosing them in `*` asterisks.	Bold	Bold
Italic Text: Words get italic by enclosing them in `_` underscores.	_Italic_	Italic
Bold Italic: Words get _bold italic by enclosing them in `_` double-underscores.	__Bold italic__	*Bold italic*
Fixed Font: Words get shown in `fixed font` by enclosing them in `=` equal signs.	=Fixed font=	`Fixed font`

Added:

>
>

Bold Fixed Font: Words get shown in `bold fixed font` by enclosing them in double equal signs.	==Bold fixed==	`Bold fixed`

Changed:

<
< Note: Make sure to "stick" the * _ = == signs to the words, that is, take away spaces.

>
> Note: Make sure there is no space between the text and the bold, italic, or other indicators (* _ __ = ==).

_This works_,
_this not _

Changed:

<
< This works,

>
> This works,

_this not _

Verbatim Mode: Surround code excerpts and other formatted text with `<verbatim>` and `</verbatim>` tags. *Note:* Use `<pre>` and `</pre>` tags instead if you want that HTML code is interpreted. *Note:* Each tag must be on a line by itself.	<verbatim> class CatAnimal { void purr() { <code here> } } </verbatim>	class CatAnimal { void purr() { <code here> } }
Separator: At least three dashes at the beginning of a line.	-------
List Item: Three spaces and an asterisk.	* bullet item	bullet item
Nested List Item: Six, nine, ... spaces and an asterisk.

Changed:

<
<

- nested stuff

>
>

level 1

Added:

>
>

- level 2

Changed:

<
<

- nested stuff

>
>

level 1

Added:

>
>

- level 2

Ordered List: Three spaces and a number.	1 Sushi 1 Dim Sum	Sushi Dim Sum
Definition List: Three spaces, the term, a colon, a space, followed by the definition. *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 ` ` non-breaking-space entity.	Sushi: Japan Dim Sum: S.F.	Sushi Japan Dim Sum S.F.
Table:

Changed:

<
< Optional spaces followed by the cells enclosed in vertical bars.
Note: | *bold* | cells are rendered as table headers.
Note: | spaced | cells are rendered center aligned.
Note: | spaced | cells are rendered right aligned.
Note: | 2 colspan || cells are rendered as multi-span columns.
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.

>
> 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.
Notes:
• | *bold* | cells are displayed as table headers.
• | center-spaced | cells are displayed center aligned.
• | right-spaced | cells are displayed right aligned.
• | 2 colspan || cells are displayed as multi-span columns (i.e., a cell with no text spans a column).
•

Added:

>
> |^| cells with a caret indicate follow-up rows of multi-span rows.
• 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 '\'.
• Table cells wrap automatically as determined by the browser.

| *L* | *C* | *R* |
| A2 |  2  |  2 |
| A3 |  3  |  3 |
| multi span |||

Changed:

<
<

A4

>
>

A4-6

four

Added:

>
>

five	five
six	six

L	C	R
A2	2	2
A3	3	3
multi span

Changed:

<
<

A4

>
>

A4-6

four

Added:

>
>

five	five
six	six

WikiWord Links: CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically. *Note:* In case you want to link to a topic in a different KoreaCmsWiki? web write `Webname.TopicName`.	WebNotify Know.ReadmeFirst	WebNotify ReadmeFirst?
Forced Links: You can create a forced internal link by enclosing words in double square brackets. *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, `[[text formatting FAQ]]` links to topic TextFormattingFAQ. You can also refer to a different web and use anchors.	[[wiki syntax]] [[Main.TWiki users]]	wiki syntax Main.TWiki users
Specific Links: Create a link where you can specify the link text and the link reference separately, using nested square brackets like `[[reference][text]]`. Internal link references (e.g. WikiSyntax) and external link references (e.g. http://TWiki.org/) are supported. *Note:* The same *Forced Links* rules apply for internal link references. *Note:* For external link references, you can simply use a space instead of `][` to separate the link URL from the descriptive text. *Note:* Anchor names can be added as well, like `[[WebHome#MyAnchor][go home]]` and `[[http://gnu.org/#Action][GNU Action]]`.	[[WikiSyntax][syntax]] [[http://gnu.org][GNU]] [[http://xml.org XML]]	syntax GNU XML
Anchors: You can define a link reference inside a KoreaCmsWiki? 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 `[[MyTopic#MyAnchor]]` syntax. You can omit the topic name if you want to link within the same topic.	[[WebHome#NotThere]] [[#MyAnchor][Jump]] #MyAnchor To here	WebHome#NotThere Jump To here
Prevent a Link: Prevent a WikiWord from being linked by prepending it with the `<nop>` tag.	<nop>SunOS	SunOS
Disable Links: You can disable automatic linking of WikiWords by surrounding text with `<noautolink>` and `</noautolink>` tags. *Note:* Each tag must be on a line by itself. *Note:* This also works for TWiki tables, but only if you add a blank line between the end of the table and the closing `</noautolink>` tag (known issue of the TablePlugin).	<noautolink> RedHat & SuSE </noautolink>	RedHat & SuSE
Mailto: Links: To create 'mailto:' links that have more descriptive link text, specify subject lines or message bodies, or omit the email address, you can write `[[mailto:user@domain descriptive text]]`.	[[mailto:a@z.com Mail]] [[mailto:?subject=Hi Hi]]	Mail Hi

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 TWiki shorthand instead - this keeps the text uncluttered and easy to edit.
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.
- 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."
NOTE: The opening and closing angle brackets - <...> - of an HTML tag must be on the same line, or the tag will be broken.

Changed:

<
<

- 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, <, ex: a > b

>
>

- 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, <, ex: a < b

- 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 GoodStyle topic located in the current KoreaCmsWiki? 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.

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

TWiki Variables

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

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

%WEB% : The current web, is TWiki.

%TOPIC% : The current topic name, is TextFormattingRules.

%ATTACHURL% : The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as %ATTACHURL%/image.gif to show the URL of the file or the image in your text.

%INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current KoreaCmsWiki? web is the default web. Example: %INCLUDE{"TWiki.SiteMap"}%

%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 %BR% to start a new line.
- Colored text: Write: %RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors to get: Red and blue colors.
- Documentation Graphics: Write: %H% Help, %T% Tip, %X% Alert to get: Help, Tip, Alert. For more info see TWikiDocGraphics.

There are many more variables, see TWikiVariables.

TWikiPlugin Formatting Extensions

Plugins provide additional text formatting capabilities and can extend the functionality of KoreaCmsWiki? into many other areas. For example, the optional SpreadSheetPlugin lets you create a spreadsheet with the same basic notation used in TWiki tables.

Available Plugins are located in the Plugins web on TWiki.org. Currently enabled plugins on this TWiki installation, as listed by %PLUGINDESCRIPTIONS%:

SpreadSheetPlugin (2018-07-05, $Rev: 30478 (2018-07-16) $): Add spreadsheet calculation like "$SUM( $ABOVE() )" to TWiki tables and other topic text
BackupRestorePlugin (2018-07-10, $Rev: 30551 (2018-07-16) $): Administrator utility to backup, restore and upgrade a TWiki site
ColorPickerPlugin (2018-07-05, $Rev: 30442 (2018-07-16) $): Color picker, packaged for use in TWiki forms and TWiki applications
CommentPlugin (2018-07-05, $Rev: 30530 (2018-07-16) $): Quickly post comments to a page without an edit/preview/save cycle
DatePickerPlugin (2018-07-05, $Rev: 30446 (2018-07-16) $): Pop-up calendar with date picker, for use in TWiki forms, HTML forms and TWiki plugins
EditTablePlugin (2018-07-05, $Rev: 30448 (2018-07-16) $): Edit TWiki tables using edit fields, date pickers and drop down boxes
HeadlinesPlugin (2018-07-13, $Rev: 30560 (2018-07-16) $): Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites
InterwikiPlugin (2018-07-05, $Rev: 30454 (2018-07-16) $): Write ExternalSite:Page to link to a page on an external site based on aliases defined in a rules topic
JQueryPlugin (2018-07-05, $Rev: 30456 (2018-07-16) $): jQuery JavaScript library for TWiki
PreferencesPlugin (2018-07-05, $Rev: 30528 (2018-07-16) $): Allows editing of preferences using fields predefined in a form
SetGetPlugin (2018-07-05, $Rev: 30472 (2018-07-16) $): Set and get variables and JSON objects in topics, optionally persistently across topic views
SlideShowPlugin (2018-07-05, $Rev: 30474 (2018-07-16) $): Create web based presentations based on topics with headings.
SmiliesPlugin (2018-07-05, $Rev: 30476 (2018-07-16) $): Render smilies as icons, like for :-) or for :eek:
TWikiSheetPlugin (2018-07-15, $Rev: 30604 (2018-07-16) $): Add TWiki Sheet spreadsheet functionality to TWiki tables
TablePlugin (2018-07-05, $Rev: 30480 (2018-07-16) $): Control attributes of tables and sorting of table columns
TagMePlugin (2018-07-05, $Rev: 30482 (2018-07-16) $): Tag wiki content collectively or authoritatively to find content by keywords
TinyMCEPlugin (2018-07-10, $Rev: 30541 (2018-07-16) $): Integration of the Tiny MCE WYSIWYG Editor
TwistyPlugin (2018-07-06, $Rev: 30497 (2018-07-16) $): Twisty section JavaScript library to open/close content dynamically
WatchlistPlugin (2018-07-10, $Rev: 30536 (2018-07-16) $): Watch topics of interest and get notified of changes by e-mail
WysiwygPlugin (2018-07-06, $Rev: 30528 (2018-07-16) $): Translator framework for WYSIWYG editors

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

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. '©' is the © copyright character. You need to escape '&' to see it as it is, so write '&' instead of '&'.
  Example: Type 'This & that' to get 'This & that'.

-- MikeMannix? - 02 Dec 2001

Changed:

<
< -- PeterThoeny? - 01 Feb 2003

>
> -- PeterThoeny? - 15 Jul 2003

Revision 372003-02-01 - PeterThoeny?

TWiki Text Formatting

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.

TWiki Editing Shorthand

Formatting Command: Example: You write: You get:

Paragraphs:
Blank lines will create new paragraphs.

1st paragraph

2nd paragraph

1st paragraph

2nd paragraph

Headings:
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 %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.

---++ Sushi

---+++ Maguro

Sushi

Maguro

Bold Text:
Words get bold by enclosing them in * asterisks.

*Bold*

Bold

Italic Text:
Words get italic by enclosing them in _ underscores.

_Italic_

Italic

Bold Italic:
Words get _bold italic by enclosing them in _ double-underscores.

__Bold italic__

Bold italic

Fixed Font:
Words get shown in fixed font by enclosing them in = equal signs.

=Fixed font=

Fixed font

Bold Fixed Font:
Words get shown in bold fixed font by enclosing them in double equal signs.

==Bold fixed==

Bold fixed

Note: Make sure to "stick" the * _ = == signs to the words, that is, take away spaces.

_This works_,
_this not _

This works, _this not _

Verbatim Mode:
Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags.
Note: Use <pre> and </pre> tags instead if you want that HTML code is interpreted.
Note: Each tag must be on a line by itself.

<verbatim>
class CatAnimal {
  void purr() {
	 <code here>
  }
}
</verbatim>

class CatAnimal {
  void purr() {
    <code here>
  }
}

Separator:
At least three dashes at the beginning of a line.

-------

List Item:
Three spaces and an asterisk.

	* bullet item

bullet item

Nested List Item:
Six, nine, ... spaces and an asterisk.

		* nested stuff

- nested stuff

Ordered List:
Three spaces and a number.

	1 Sushi
	1 Dim Sum

Sushi
Dim Sum

Definition List:
Three spaces, the term, a colon, a space, followed by the definition.
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   non-breaking-space entity.

	Sushi: Japan
	Dim&nbsp;Sum: S.F.

Sushi: Japan
Dim Sum: S.F.

Table:
Optional spaces followed by the cells enclosed in vertical bars.
Note: | *bold* | cells are rendered as table headers.
Note: | spaced | cells are rendered center aligned.
Note: | spaced | cells are rendered right aligned.
Note: | 2 colspan || cells are rendered as multi-span columns.
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.

| *L* | *C* | *R* |
| A2 |  2  |  2 |
| A3 |  3  |  3 |
| multi span |||
| A4 | next | next |

L	C	R
A2	2	2
A3	3	3
multi span
A4	next	next

WikiWord Links:
CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically.
Note: In case you want to link to a topic in a different KoreaCmsWiki? web write Webname.TopicName.

WebNotify

Know.ReadmeFirst

ReadmeFirst?

Forced Links:
You can create a forced internal link by enclosing words in double square brackets.
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, [[text formatting FAQ]] links to topic TextFormattingFAQ. You can also refer to a different web and use anchors.

[[wiki syntax]]

[[Main.TWiki users]]

Specific Links:
Create a link where you can specify the link text and the link reference separately, using nested square brackets like [[reference][text]]. Internal link references (e.g. WikiSyntax) and external link references (e.g. http://TWiki.org/

) are supported.
Note: The same Forced Links rules apply for internal link references.
Note: For external link references, you can simply use a space instead of ][ to separate the link URL from the descriptive text.
Note: Anchor names can be added as well, like [[WebHome#MyAnchor][go home]] and [[http://gnu.org/#Action][GNU Action]].

[[WikiSyntax][syntax]]

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

[[http://xml.org XML]]

Anchors:
You can define a link reference inside a KoreaCmsWiki? 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 [[MyTopic#MyAnchor]] syntax. You can omit the topic name if you want to link within the same topic.

[[WebHome#NotThere]]

[[#MyAnchor][Jump]]

#MyAnchor To here

To here

Prevent a Link:
Prevent a WikiWord from being linked by prepending it with the <nop> tag.

<nop>SunOS

SunOS

Disable Links:
You can disable automatic linking of WikiWords by surrounding text with <noautolink> and </noautolink> tags.
Note: Each tag must be on a line by itself.
Note: This also works for TWiki tables, but only if you add a blank line between the end of the table and the closing </noautolink> tag (known issue of the TablePlugin).

 <noautolink>
 RedHat &
 SuSE
 </noautolink>

RedHat & SuSE

Mailto: Links:
To create 'mailto:' links that have more descriptive link text, specify subject lines or message bodies, or omit the email address, you can write [[mailto:user@domain descriptive text]].

[[mailto:a@z.com Mail]]

[[mailto:?subject=Hi Hi]]

Mail

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 TWiki shorthand instead - this keeps the text uncluttered and easy to edit.
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.
- 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."
NOTE: The opening and closing angle brackets - <...> - 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, <, ex: a > b
- 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 GoodStyle topic located in the current KoreaCmsWiki? 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

Changed:

<
<

http://..., https://..., ftp://... and mailto:...@... are linked automatically.

>
>

http://..., https://..., ftp://..., gopher://..., news://..., file://..., telnet://...

Added:

>
> and mailto:...@... are linked automatically.

Email addresses like name@domain.com are linked automatically.

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

TWiki Variables

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

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

%WEB% : The current web, is TWiki.

%TOPIC% : The current topic name, is TextFormattingRules.

%ATTACHURL% : The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as %ATTACHURL%/image.gif to show the URL of the file or the image in your text.

%INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current KoreaCmsWiki? web is the default web. Example: %INCLUDE{"TWiki.SiteMap"}%

%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 %BR% to start a new line.
- Colored text: Write: %RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors to get: Red and blue colors.
- Documentation Graphics: Write: %H% Help, %T% Tip, %X% Alert to get: Help, Tip, Alert. For more info see TWikiDocGraphics.

There are many more variables, see TWikiVariables.

TWikiPlugin Formatting Extensions

Plugins provide additional text formatting capabilities and can extend the functionality of KoreaCmsWiki? into many other areas. For example, the optional SpreadSheetPlugin lets you create a spreadsheet with the same basic notation used in TWiki tables.

Available Plugins are located in the Plugins web on TWiki.org. Currently enabled plugins on this TWiki installation, as listed by %PLUGINDESCRIPTIONS%:

SpreadSheetPlugin (2018-07-05, $Rev: 30478 (2018-07-16) $): Add spreadsheet calculation like "$SUM( $ABOVE() )" to TWiki tables and other topic text
BackupRestorePlugin (2018-07-10, $Rev: 30551 (2018-07-16) $): Administrator utility to backup, restore and upgrade a TWiki site
ColorPickerPlugin (2018-07-05, $Rev: 30442 (2018-07-16) $): Color picker, packaged for use in TWiki forms and TWiki applications
CommentPlugin (2018-07-05, $Rev: 30530 (2018-07-16) $): Quickly post comments to a page without an edit/preview/save cycle
DatePickerPlugin (2018-07-05, $Rev: 30446 (2018-07-16) $): Pop-up calendar with date picker, for use in TWiki forms, HTML forms and TWiki plugins
EditTablePlugin (2018-07-05, $Rev: 30448 (2018-07-16) $): Edit TWiki tables using edit fields, date pickers and drop down boxes
HeadlinesPlugin (2018-07-13, $Rev: 30560 (2018-07-16) $): Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites
InterwikiPlugin (2018-07-05, $Rev: 30454 (2018-07-16) $): Write ExternalSite:Page to link to a page on an external site based on aliases defined in a rules topic
JQueryPlugin (2018-07-05, $Rev: 30456 (2018-07-16) $): jQuery JavaScript library for TWiki
PreferencesPlugin (2018-07-05, $Rev: 30528 (2018-07-16) $): Allows editing of preferences using fields predefined in a form
SetGetPlugin (2018-07-05, $Rev: 30472 (2018-07-16) $): Set and get variables and JSON objects in topics, optionally persistently across topic views
SlideShowPlugin (2018-07-05, $Rev: 30474 (2018-07-16) $): Create web based presentations based on topics with headings.
SmiliesPlugin (2018-07-05, $Rev: 30476 (2018-07-16) $): Render smilies as icons, like for :-) or for :eek:
TWikiSheetPlugin (2018-07-15, $Rev: 30604 (2018-07-16) $): Add TWiki Sheet spreadsheet functionality to TWiki tables
TablePlugin (2018-07-05, $Rev: 30480 (2018-07-16) $): Control attributes of tables and sorting of table columns
TagMePlugin (2018-07-05, $Rev: 30482 (2018-07-16) $): Tag wiki content collectively or authoritatively to find content by keywords
TinyMCEPlugin (2018-07-10, $Rev: 30541 (2018-07-16) $): Integration of the Tiny MCE WYSIWYG Editor
TwistyPlugin (2018-07-06, $Rev: 30497 (2018-07-16) $): Twisty section JavaScript library to open/close content dynamically
WatchlistPlugin (2018-07-10, $Rev: 30536 (2018-07-16) $): Watch topics of interest and get notified of changes by e-mail
WysiwygPlugin (2018-07-06, $Rev: 30528 (2018-07-16) $): Translator framework for WYSIWYG editors

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

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. '©' is the © copyright character. You need to escape '&' to see it as it is, so write '&' instead of '&'.
  Example: Type 'This & that' to get 'This & that'.

-- MikeMannix? - 02 Dec 2001
-- PeterThoeny? - 01 Feb 2003

Revision 362003-02-01 - PeterThoeny?

TWiki Text Formatting

Changed:

<
<

TWiki Text Formatting

>
>

TWiki Text Formatting

Deleted:

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

Added:

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

TWiki Editing Shorthand

Changed:

<
<

>
>

Formatting Command:	Example: You write:	You get:

Changed:

<
< Paragraphs:

>
> Paragraphs:

Blank lines will create new paragraphs.

1st paragraph 2nd paragraph	1st paragraph 2nd paragraph

Changed:

<
< Headings:

>
> Headings:

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

---++ Sushi

---+++ Maguro

Sushi

Maguro

Changed:

<
< Bold Text:

>
> Bold Text:

Words get bold by enclosing them in * asterisks.

Bold	Bold

Changed:

<
< Italic Text:

>
> Italic Text:

Words get italic by enclosing them in _ underscores.

_Italic_	Italic

Changed:

<
< Bold Italic:

>
> Bold Italic:

Words get _bold italic by enclosing them in _ double-underscores.

__Bold italic__	*Bold italic*

Changed:

<
< Fixed Font:

>
> Fixed Font:

Words get shown in fixed font by enclosing them in = equal signs.

=Fixed font=	`Fixed font`

Changed:

<
< Bold Fixed Font:

>
> Bold Fixed Font:

Words get shown in bold fixed font by enclosing them in double equal signs.

==Bold fixed==	`Bold fixed`

Changed:

<
< Note: Make sure to "stick" the * _ = == signs to the words, e.g. take away spaces.

>
> Note: Make sure to "stick" the * _ = == signs to the words, that is, take away spaces.

_This works_, _this not _	This works, _this not _

Changed:

<
< Verbatim Mode:
Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags.
Note: Use <pre> and </pre> tags instead if you want that HTML code is interpreted.
Note: Each tag must be on a line by itself.

>
> Verbatim Mode:
Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags.
Note: Use <pre> and </pre> tags instead if you want that HTML code is interpreted.
Note: Each tag must be on a line by itself.

<verbatim> class CatAnimal { void purr() { <code here> } } </verbatim>	class CatAnimal { void purr() { <code here> } }

Changed:

<
< Separator:

>
> Separator:

At least three dashes at the beginning of a line.

-------

Changed:

<
< List Item:

>
> List Item:

Three spaces and an asterisk.

* bullet item	bullet item

Changed:

<
< Nested List Item:

>
> Nested List Item:

Six, nine, ... spaces and an asterisk.

* nested stuff	nested stuff

Changed:

<
< Ordered List:

>
> Ordered List:

Three spaces and a number.

1 Sushi 1 Dim Sum	Sushi Dim Sum

Changed:

<
< Definition List:
Three spaces, the term, a colon, a space, followed by the definition.

>
> Definition List:
Three spaces, the term, a colon, a space, followed by the definition.

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   non-breaking-space entity.

Sushi: Japan Dim Sum: S.F.	Sushi Japan Dim Sum S.F.

Changed:

<
< Table:
Optional spaces followed by the cells enclosed in vertical bars.
Note: | *bold* | cells are rendered as table headers.
Note: | spaced | cells are rendered center aligned.
Note: | spaced | cells are rendered right aligned.
Note: | 2 colspan || cells are rendered as multi-span columns.
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.

>
> Table:
Optional spaces followed by the cells enclosed in vertical bars.
Note: | *bold* | cells are rendered as table headers.
Note: | spaced | cells are rendered center aligned.
Note: | spaced | cells are rendered right aligned.
Note: | 2 colspan || cells are rendered as multi-span columns.
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.

| *L* | *C* | *R* |
| A2 |  2  |  2 |
| A3 |  3  |  3 |
| multi span |||

Changed:

<
< | A4 \

>
>

A4

Deleted:

<
<

| next \

L	C	R
A2	2	2
A3	3	3
multi span

Changed:

<
< | A4

>
>

A4

Deleted:

<
<

Changed:

<
< WikiWord Links:
CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically.
Note: In case you want to link to a topic in a different KoreaCmsWiki? web write Webname.TopicName.

>
> WikiWord Links:
CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically.
Note: In case you want to link to a topic in a different KoreaCmsWiki? web write Webname.TopicName.

WebNotify Know.ReadmeFirst	WebNotify ReadmeFirst?

Changed:

<
< Forced Links:
You can create a forced internal link by enclosing words in double square brackets.
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. [[text formatting FAQ]] links to topic TextFormattingFAQ. You can also refer to a different web and use anchors.

>
> Forced Links:
You can create a forced internal link by enclosing words in double square brackets.

Added:

>
> 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, [[text formatting FAQ]] links to topic TextFormattingFAQ. You can also refer to a different web and use anchors.

[[wiki syntax]] [[Main.TWiki users]]	wiki syntax Main.TWiki users

Changed:

<
< Specific Links:
Create a link where you can specify the link text and the link reference separately, using nested square brackets like [[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 [[WebHome#MyAnchor][go home]] and [[http://www.yahoo.com/#somewhere][Yahoo!]].

>
> Specific Links:
Create a link where you can specify the link text and the link reference separately, using nested square brackets like [[reference][text]]. Internal link references (e.g. WikiSyntax) and external link references (e.g. http://TWiki.org/) are supported.

Added:

>
> Note: The same Forced Links rules apply for internal link references.
Note: For external link references, you can simply use a space instead of ][ to separate the link URL from the descriptive text.
Note: Anchor names can be added as well, like [[WebHome#MyAnchor][go home]] and [[http://gnu.org/#Action][GNU Action]].

[[WikiSyntax][syntax]]

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

Added:

>
> XML

Added:

>
> XML

Changed:

<
< Easier External Links:

>
> Anchors:

Deleted:

<
<

An easier syntax for external links is now available: [[externalURL text]] - just hit the spacebar to separate the link URL from the descriptive text, e.g. [[http://gnu.org/ GNU]]. This also supports anchors, e.g. [[http://www.yahoo.com/#somewhere Yahoo!]].

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

You can define a link reference inside a KoreaCmsWiki? 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 [[MyTopic#MyAnchor]] syntax. You can omit the topic name if you want to link within the same topic.

[[WebHome#NotThere]]

[[#MyAnchor][Jump]]

#MyAnchor To here

To here

Prevent a Link:
Prevent a WikiWord from being linked by prepending it with the <nop> tag.

<nop>SunOS

SunOS

Disable Links:

Changed:

<
< You can disable automatic linking of WikiWords by surrounding text with <noautolink> and </noautolink> tags.
Note: Each tag must be on a line by itself.
Note: This also works for TWiki tables, but only if you add a blank line between the end of the table and the closing </noautolink> tag (known issue of the TablePlugin).

>
> You can disable automatic linking of WikiWords by surrounding text with <noautolink> and </noautolink> tags.

Added:

>
> Note: Each tag must be on a line by itself.
Note: This also works for TWiki tables, but only if you add a blank line between the end of the table and the closing </noautolink> tag (known issue of the TablePlugin).

 <noautolink>
 RedHat &
 SuSE
 </noautolink>

RedHat & SuSE

Added:

>
>

Mailto: Links:
To create 'mailto:' links that have more descriptive link text, specify subject lines or message bodies, or omit the email address, you can write [[mailto:user@domain descriptive text]].

[[mailto:a@z.com Mail]]

[[mailto:?subject=Hi Hi]]

Mail

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

Added:

>
>

On collaboration pages, it's preferable NOT to use HTML, and to use TWiki shorthand instead - this keeps the text uncluttered and easy to edit.
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

Added:

>
>

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.
- 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."
NOTE: The opening and closing angle brackets - <...> - 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, <, ex: a > b
- 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 GoodStyle topic located in the current KoreaCmsWiki? 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://... and mailto:...@... are linked automatically.

Email addresses like name@domain.com are linked automatically.

[[Square bracket rules]] let you easily create non-WikiWord links.

Changed:

<
<

- You can also write [[http://yahoo.com Yahoo home page]] as an easier way of doing external links with descriptive text for the link, such as Yahoo home page.

>
>

- You can also write [[http://yahoo.com Yahoo home page]] as an easier way of doing external links with descriptive text for the link, such as Yahoo home page.

TWiki Variables

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

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

%WEB% : The current web, is TWiki.

%TOPIC% : The current topic name, is TextFormattingRules.

%ATTACHURL% : The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as %ATTACHURL%/image.gif to show the URL of the file or the image in your text.

%INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current KoreaCmsWiki? web is the default web. Example: %INCLUDE{"TWiki.SiteMap"}%

Changed:

<
<

There are many more variables, see TWikiVariables.

>
>

%SEARCH{"sushi"}% : Inline search showing the search result embedded in a topic. FormattedSearch gives you control over formatting, used to create web-based applications.

Changed:

<
<

TWikiPreferences defines site-wide variables like colors. For example, write: %RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors to get: Red and blue colors.

>
>

TWikiPreferences defines site-wide variables. Among others:

Added:

>
>

- Line break: Write %BR% to start a new line.
- Colored text: Write: %RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors to get: Red and blue colors.
- Documentation Graphics: Write: %H% Help, %T% Tip, %X% Alert to get: Help, Tip, Alert. For more info see TWikiDocGraphics.

Added:

>
>

There are many more variables, see TWikiVariables.

Added:

>
>

TWikiPlugin Formatting Extensions

Plugins provide additional text formatting capabilities and can extend the functionality of KoreaCmsWiki? into many other areas. For example, the optional SpreadSheetPlugin lets you create a spreadsheet with the same basic notation used in TWiki tables.

Available Plugins are located in the Plugins web on TWiki.org. Currently enabled plugins on this TWiki installation, as listed by %PLUGINDESCRIPTIONS%:

SpreadSheetPlugin (2018-07-05, $Rev: 30478 (2018-07-16) $): Add spreadsheet calculation like "$SUM( $ABOVE() )" to TWiki tables and other topic text
BackupRestorePlugin (2018-07-10, $Rev: 30551 (2018-07-16) $): Administrator utility to backup, restore and upgrade a TWiki site
ColorPickerPlugin (2018-07-05, $Rev: 30442 (2018-07-16) $): Color picker, packaged for use in TWiki forms and TWiki applications
CommentPlugin (2018-07-05, $Rev: 30530 (2018-07-16) $): Quickly post comments to a page without an edit/preview/save cycle
DatePickerPlugin (2018-07-05, $Rev: 30446 (2018-07-16) $): Pop-up calendar with date picker, for use in TWiki forms, HTML forms and TWiki plugins
EditTablePlugin (2018-07-05, $Rev: 30448 (2018-07-16) $): Edit TWiki tables using edit fields, date pickers and drop down boxes
HeadlinesPlugin (2018-07-13, $Rev: 30560 (2018-07-16) $): Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites
InterwikiPlugin (2018-07-05, $Rev: 30454 (2018-07-16) $): Write ExternalSite:Page to link to a page on an external site based on aliases defined in a rules topic
JQueryPlugin (2018-07-05, $Rev: 30456 (2018-07-16) $): jQuery JavaScript library for TWiki
PreferencesPlugin (2018-07-05, $Rev: 30528 (2018-07-16) $): Allows editing of preferences using fields predefined in a form
SetGetPlugin (2018-07-05, $Rev: 30472 (2018-07-16) $): Set and get variables and JSON objects in topics, optionally persistently across topic views
SlideShowPlugin (2018-07-05, $Rev: 30474 (2018-07-16) $): Create web based presentations based on topics with headings.
SmiliesPlugin (2018-07-05, $Rev: 30476 (2018-07-16) $): Render smilies as icons, like for :-) or for :eek:
TWikiSheetPlugin (2018-07-15, $Rev: 30604 (2018-07-16) $): Add TWiki Sheet spreadsheet functionality to TWiki tables
TablePlugin (2018-07-05, $Rev: 30480 (2018-07-16) $): Control attributes of tables and sorting of table columns
TagMePlugin (2018-07-05, $Rev: 30482 (2018-07-16) $): Tag wiki content collectively or authoritatively to find content by keywords
TinyMCEPlugin (2018-07-10, $Rev: 30541 (2018-07-16) $): Integration of the Tiny MCE WYSIWYG Editor
TwistyPlugin (2018-07-06, $Rev: 30497 (2018-07-16) $): Twisty section JavaScript library to open/close content dynamically
WatchlistPlugin (2018-07-10, $Rev: 30536 (2018-07-16) $): Watch topics of interest and get notified of changes by e-mail
WysiwygPlugin (2018-07-06, $Rev: 30528 (2018-07-16) $): Translator framework for WYSIWYG editors

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

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. '©' is the © copyright character. You need to escape '&' to see it as it is, so write '&' instead of '&'.
  Example: Type 'This & that' to get 'This & that'.

-- MikeMannix? - 02 Dec 2001

Changed:

<
< -- PeterThoeny? - 02 May 2002

>
> -- PeterThoeny? - 01 Feb 2003

Revision 352002-10-03 - PeterThoeny?

TWiki Text Formatting

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.

TWiki Editing Shorthand

Formatting Command: Example: You write: You get:

Paragraphs:
Blank lines will create new paragraphs.

1st paragraph

2nd paragraph

1st paragraph

2nd paragraph

Headings:
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 %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.

---++ Sushi

---+++ Maguro

Sushi

Maguro

Bold Text:
Words get bold by enclosing them in * asterisks.

*Bold*

Bold

Italic Text:
Words get italic by enclosing them in _ underscores.

_Italic_

Italic

Bold Italic:
Words get _bold italic by enclosing them in _ double-underscores.

__Bold italic__

Bold italic

Fixed Font:
Words get shown in fixed font by enclosing them in = equal signs.

=Fixed font=

Fixed font

Bold Fixed Font:
Words get shown in bold fixed font by enclosing them in double equal signs.

==Bold fixed==

Bold fixed

Note: Make sure to "stick" the * _ = == signs to the words, e.g. take away spaces.

_This works_,
_this not _

This works, _this not _

Verbatim Mode:
Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags.
Note: Use <pre> and </pre> tags instead if you want that HTML code is interpreted.
Note: Each tag must be on a line by itself.

<verbatim>
class CatAnimal {
  void purr() {
	 <code here>
  }
}
</verbatim>

class CatAnimal {
  void purr() {
    <code here>
  }
}

Separator:
At least three dashes at the beginning of a line.

-------

List Item:
Three spaces and an asterisk.

	* bullet item

bullet item

Nested List Item:
Six, nine, ... spaces and an asterisk.

		* nested stuff

- nested stuff

Ordered List:
Three spaces and a number.

	1 Sushi
	1 Dim Sum

Sushi
Dim Sum

Definition List:
Three spaces, the term, a colon, a space, followed by the definition.
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   non-breaking-space entity.

	Sushi: Japan
	Dim&nbsp;Sum: S.F.

Sushi: Japan
Dim Sum: S.F.

Table:
Optional spaces followed by the cells enclosed in vertical bars.
Note: | *bold* | cells are rendered as table headers.
Note: | spaced | cells are rendered center aligned.
Note: | spaced | cells are rendered right aligned.
Note: | 2 colspan || cells are rendered as multi-span columns.
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.

| *L* | *C* | *R* |
| A2 |  2  |  2 |
| A3 |  3  |  3 |
| multi span |||
| A4 \
  | next \
  | next |

L	C	R
A2	2	2
A3	3	3
multi span
A4	next	next

WikiWord Links:
CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically.
Note: In case you want to link to a topic in a different KoreaCmsWiki? web write Webname.TopicName.

WebNotify

Know.ReadmeFirst

ReadmeFirst?

Forced Links:
You can create a forced internal link by enclosing words in double square brackets.
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. [[text formatting FAQ]] links to topic TextFormattingFAQ. You can also refer to a different web and use anchors.

[[wiki syntax]]

[[Main.TWiki users]]

Specific Links:
Create a link where you can specify the link text and the link reference separately, using nested square brackets like [[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 [[WebHome#MyAnchor][go home]] and [[http://www.yahoo.com/#somewhere][Yahoo!]].

[[WikiSyntax][syntax]]

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

Easier External Links:
An easier syntax for external links is now available: [[externalURL text]] - just hit the spacebar to separate the link URL from the descriptive text, e.g. [[http://gnu.org/ GNU]]. This also supports anchors, e.g. [[http://www.yahoo.com/#somewhere Yahoo!]].

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

Anchors:
You can define a link reference inside a KoreaCmsWiki? 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 [[MyTopic#MyAnchor]] syntax. You can omit the topic name if you want to link within the same topic.

[[WebHome#NotThere]]

[[#MyAnchor][Jump]]

#MyAnchor To here

To here

Changed:

<
< Prevent a Link:

>
> Prevent a Link:

Prevent a WikiWord from being linked by prepending it with the <nop> tag.

<nop>SunOS

SunOS

Added:

>
>

Disable Links:
You can disable automatic linking of WikiWords by surrounding text with <noautolink> and </noautolink> tags.
Note: Each tag must be on a line by itself.
Note: This also works for TWiki tables, but only if you add a blank line between the end of the table and the closing </noautolink> tag (known issue of the TablePlugin).

 <noautolink>
 RedHat &
 SuSE
 </noautolink>

RedHat & SuSE

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 TWiki shorthand instead - this keeps the text uncluttered and easy to edit.
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.
- 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."
NOTE: The opening and closing angle brackets - <...> - 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, <, ex: a > b
- 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 GoodStyle topic located in the current KoreaCmsWiki? 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://... and mailto:...@... are linked automatically.

Email addresses like name@domain.com are linked automatically.

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

TWiki Variables

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

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

%WEB% : The current web, is TWiki.

%TOPIC% : The current topic name, is TextFormattingRules.

%ATTACHURL% : The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as %ATTACHURL%/image.gif to show the URL of the file or the image in your text.

%INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current KoreaCmsWiki? web is the default web. Example: %INCLUDE{"TWiki.SiteMap"}%

There are many more variables, see TWikiVariables.

TWikiPreferences defines site-wide variables like colors. For example, write: %RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors to get: Red and blue colors.

TWikiPlugin Formatting Extensions

Plugins provide additional text formatting capabilities and can extend the functionality of KoreaCmsWiki? into many other areas. For example, the optional SpreadSheetPlugin lets you create a spreadsheet with the same basic notation used in TWiki tables.

Available Plugins are located in the Plugins web on TWiki.org. Currently enabled plugins on this TWiki installation, as listed by %PLUGINDESCRIPTIONS%:

SpreadSheetPlugin (2018-07-05, $Rev: 30478 (2018-07-16) $): Add spreadsheet calculation like "$SUM( $ABOVE() )" to TWiki tables and other topic text
BackupRestorePlugin (2018-07-10, $Rev: 30551 (2018-07-16) $): Administrator utility to backup, restore and upgrade a TWiki site
ColorPickerPlugin (2018-07-05, $Rev: 30442 (2018-07-16) $): Color picker, packaged for use in TWiki forms and TWiki applications
CommentPlugin (2018-07-05, $Rev: 30530 (2018-07-16) $): Quickly post comments to a page without an edit/preview/save cycle
DatePickerPlugin (2018-07-05, $Rev: 30446 (2018-07-16) $): Pop-up calendar with date picker, for use in TWiki forms, HTML forms and TWiki plugins
EditTablePlugin (2018-07-05, $Rev: 30448 (2018-07-16) $): Edit TWiki tables using edit fields, date pickers and drop down boxes
HeadlinesPlugin (2018-07-13, $Rev: 30560 (2018-07-16) $): Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites
InterwikiPlugin (2018-07-05, $Rev: 30454 (2018-07-16) $): Write ExternalSite:Page to link to a page on an external site based on aliases defined in a rules topic
JQueryPlugin (2018-07-05, $Rev: 30456 (2018-07-16) $): jQuery JavaScript library for TWiki
PreferencesPlugin (2018-07-05, $Rev: 30528 (2018-07-16) $): Allows editing of preferences using fields predefined in a form
SetGetPlugin (2018-07-05, $Rev: 30472 (2018-07-16) $): Set and get variables and JSON objects in topics, optionally persistently across topic views
SlideShowPlugin (2018-07-05, $Rev: 30474 (2018-07-16) $): Create web based presentations based on topics with headings.
SmiliesPlugin (2018-07-05, $Rev: 30476 (2018-07-16) $): Render smilies as icons, like for :-) or for :eek:
TWikiSheetPlugin (2018-07-15, $Rev: 30604 (2018-07-16) $): Add TWiki Sheet spreadsheet functionality to TWiki tables
TablePlugin (2018-07-05, $Rev: 30480 (2018-07-16) $): Control attributes of tables and sorting of table columns
TagMePlugin (2018-07-05, $Rev: 30482 (2018-07-16) $): Tag wiki content collectively or authoritatively to find content by keywords
TinyMCEPlugin (2018-07-10, $Rev: 30541 (2018-07-16) $): Integration of the Tiny MCE WYSIWYG Editor
TwistyPlugin (2018-07-06, $Rev: 30497 (2018-07-16) $): Twisty section JavaScript library to open/close content dynamically
WatchlistPlugin (2018-07-10, $Rev: 30536 (2018-07-16) $): Watch topics of interest and get notified of changes by e-mail
WysiwygPlugin (2018-07-06, $Rev: 30528 (2018-07-16) $): Translator framework for WYSIWYG editors

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

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. '©' is the © copyright character. You need to escape '&' to see it as it is, so write '&' instead of '&'.
  Example: Type 'This & that' to get 'This & that'.

-- MikeMannix? - 02 Dec 2001
-- PeterThoeny? - 02 May 2002

Revision 342002-06-05 - PeterThoeny?

TWiki Text Formatting

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.

TWiki Editing Shorthand

Formatting Command:	Example: You write:	You get:
Paragraphs: Blank lines will create new paragraphs.	1st paragraph 2nd paragraph	1st paragraph 2nd paragraph
Headings:

Changed:

<
< 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 %TOC% variable, see TWikiVariables.

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

---++ Sushi

---+++ Maguro

Sushi

Maguro

Bold Text:
Words get bold by enclosing them in * asterisks.

*Bold*

Bold

Italic Text:
Words get italic by enclosing them in _ underscores.

_Italic_

Italic

Bold Italic:
Words get _bold italic by enclosing them in _ double-underscores.

__Bold italic__

Bold italic

Fixed Font:
Words get shown in fixed font by enclosing them in = equal signs.

=Fixed font=

Fixed font

Bold Fixed Font:
Words get shown in bold fixed font by enclosing them in double equal signs.

==Bold fixed==

Bold fixed

Note: Make sure to "stick" the * _ = == signs to the words, e.g. take away spaces.

_This works_,
_this not _

This works, _this not _

Verbatim Mode:
Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags.
Note: Use <pre> and </pre> tags instead if you want that HTML code is interpreted.
Note: Each tag must be on a line by itself.

<verbatim>
class CatAnimal {
  void purr() {
	 <code here>
  }
}
</verbatim>

class CatAnimal {
  void purr() {
    <code here>
  }
}

Separator:
At least three dashes at the beginning of a line.

-------

List Item:
Three spaces and an asterisk.

	* bullet item

bullet item

Nested List Item:
Six, nine, ... spaces and an asterisk.

		* nested stuff

- nested stuff

Ordered List:
Three spaces and a number.

	1 Sushi
	1 Dim Sum

Sushi
Dim Sum

Definition List:
Three spaces, the term, a colon, a space, followed by the definition.
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   non-breaking-space entity.

	Sushi: Japan
	Dim&nbsp;Sum: S.F.

Sushi: Japan
Dim Sum: S.F.

Table:
Optional spaces followed by the cells enclosed in vertical bars.
Note: | *bold* | cells are rendered as table headers.
Note: | spaced | cells are rendered center aligned.
Note: | spaced | cells are rendered right aligned.
Note: | 2 colspan || cells are rendered as multi-span columns.
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.

| *L* | *C* | *R* |
| A2 |  2  |  2 |
| A3 |  3  |  3 |
| multi span |||
| A4 \
  | next \
  | next |

L	C	R
A2	2	2
A3	3	3
multi span
A4	next	next

WikiWord Links:
CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically.
Note: In case you want to link to a topic in a different KoreaCmsWiki? web write Webname.TopicName.

WebNotify

Know.ReadmeFirst

ReadmeFirst?

Changed:

<
<

#SquareBrackets

>
>

Added:

>
>

Forced Links:
You can create a forced internal link by enclosing words in double square brackets.
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. [[text formatting FAQ]] links to topic TextFormattingFAQ. You can also refer to a different web and use anchors.

[[wiki syntax]] [[Main.TWiki users]]	wiki syntax Main.TWiki users
Specific Links: Create a link where you can specify the link text and the link reference separately, using nested square brackets like `[[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 `[[WebHome#MyAnchor][go home]]` and `[[http://www.yahoo.com/#somewhere][Yahoo!]]`.	[[WikiSyntax][syntax]] [[http://gnu.org][GNU]]	syntax GNU
Easier External Links: An easier syntax for external links is now available: `[[externalURL text]]` - just hit the spacebar to separate the link URL from the descriptive text, e.g. `[[http://gnu.org/ GNU]]`. This also supports anchors, e.g. `[[http://www.yahoo.com/#somewhere Yahoo!]]`.	[[http://gnu.org GNU]]	GNU
Anchors: You can define a link reference inside a KoreaCmsWiki? 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 `[[MyTopic#MyAnchor]]` syntax. You can omit the topic name if you want to link within the same topic.	[[WebHome#NotThere]] [[#MyAnchor][Jump]] #MyAnchor To here	WebHome#NotThere Jump To here
Prevent a Link: Prevent a WikiWord from being linked by prepending it with the `<nop>` tag.	<nop>SunOS	SunOS

Deleted:

<
<

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 TWiki shorthand instead - this keeps the text uncluttered and easy to edit.
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.
- 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."
NOTE: The opening and closing angle brackets - <...> - 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, <, ex: a > b
- 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 GoodStyle topic located in the current KoreaCmsWiki? 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://... and mailto:...@... are linked automatically.

Email addresses like name@domain.com are linked automatically.

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

TWiki Variables

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

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

%WEB% : The current web, is TWiki.

%TOPIC% : The current topic name, is TextFormattingRules.

%ATTACHURL% : The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as %ATTACHURL%/image.gif to show the URL of the file or the image in your text.

%INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current KoreaCmsWiki? web is the default web. Example: %INCLUDE{"TWiki.SiteMap"}%

There are many more variables, see TWikiVariables.

TWikiPreferences defines site-wide variables like colors. For example, write: %RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors to get: Red and blue colors.

TWikiPlugin Formatting Extensions

Plugins provide additional text formatting capabilities and can extend the functionality of KoreaCmsWiki? into many other areas. For example, the optional SpreadSheetPlugin lets you create a spreadsheet with the same basic notation used in TWiki tables.

Available Plugins are located in the Plugins web on TWiki.org. Currently enabled plugins on this TWiki installation, as listed by %PLUGINDESCRIPTIONS%:

SpreadSheetPlugin (2018-07-05, $Rev: 30478 (2018-07-16) $): Add spreadsheet calculation like "$SUM( $ABOVE() )" to TWiki tables and other topic text
BackupRestorePlugin (2018-07-10, $Rev: 30551 (2018-07-16) $): Administrator utility to backup, restore and upgrade a TWiki site
ColorPickerPlugin (2018-07-05, $Rev: 30442 (2018-07-16) $): Color picker, packaged for use in TWiki forms and TWiki applications
CommentPlugin (2018-07-05, $Rev: 30530 (2018-07-16) $): Quickly post comments to a page without an edit/preview/save cycle
DatePickerPlugin (2018-07-05, $Rev: 30446 (2018-07-16) $): Pop-up calendar with date picker, for use in TWiki forms, HTML forms and TWiki plugins
EditTablePlugin (2018-07-05, $Rev: 30448 (2018-07-16) $): Edit TWiki tables using edit fields, date pickers and drop down boxes
HeadlinesPlugin (2018-07-13, $Rev: 30560 (2018-07-16) $): Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites
InterwikiPlugin (2018-07-05, $Rev: 30454 (2018-07-16) $): Write ExternalSite:Page to link to a page on an external site based on aliases defined in a rules topic
JQueryPlugin (2018-07-05, $Rev: 30456 (2018-07-16) $): jQuery JavaScript library for TWiki
PreferencesPlugin (2018-07-05, $Rev: 30528 (2018-07-16) $): Allows editing of preferences using fields predefined in a form
SetGetPlugin (2018-07-05, $Rev: 30472 (2018-07-16) $): Set and get variables and JSON objects in topics, optionally persistently across topic views
SlideShowPlugin (2018-07-05, $Rev: 30474 (2018-07-16) $): Create web based presentations based on topics with headings.
SmiliesPlugin (2018-07-05, $Rev: 30476 (2018-07-16) $): Render smilies as icons, like for :-) or for :eek:
TWikiSheetPlugin (2018-07-15, $Rev: 30604 (2018-07-16) $): Add TWiki Sheet spreadsheet functionality to TWiki tables
TablePlugin (2018-07-05, $Rev: 30480 (2018-07-16) $): Control attributes of tables and sorting of table columns
TagMePlugin (2018-07-05, $Rev: 30482 (2018-07-16) $): Tag wiki content collectively or authoritatively to find content by keywords
TinyMCEPlugin (2018-07-10, $Rev: 30541 (2018-07-16) $): Integration of the Tiny MCE WYSIWYG Editor
TwistyPlugin (2018-07-06, $Rev: 30497 (2018-07-16) $): Twisty section JavaScript library to open/close content dynamically
WatchlistPlugin (2018-07-10, $Rev: 30536 (2018-07-16) $): Watch topics of interest and get notified of changes by e-mail
WysiwygPlugin (2018-07-06, $Rev: 30528 (2018-07-16) $): Translator framework for WYSIWYG editors

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

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. '©' is the © copyright character. You need to escape '&' to see it as it is, so write '&' instead of '&'.
  Example: Type 'This & that' to get 'This & that'.

-- MikeMannix? - 02 Dec 2001
-- PeterThoeny? - 02 May 2002

Revision 332002-05-02 - PeterThoeny?

TWiki Text Formatting

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.

TWiki Editing Shorthand

Formatting Command: Example: You write: You get:

Paragraphs:
Blank lines will create new paragraphs.

1st paragraph

2nd paragraph

1st paragraph

2nd paragraph

Headings:
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 %TOC% variable, see TWikiVariables.

---++ Sushi

---+++ Maguro

Sushi

Maguro

Bold Text:
Words get bold by enclosing them in * asterisks.

*Bold*

Bold

Italic Text:
Words get italic by enclosing them in _ underscores.

_Italic_

Italic

Bold Italic:
Words get _bold italic by enclosing them in _ double-underscores.

__Bold italic__

Bold italic

Fixed Font:
Words get shown in fixed font by enclosing them in = equal signs.

=Fixed font=

Fixed font

Bold Fixed Font:
Words get shown in bold fixed font by enclosing them in double equal signs.

==Bold fixed==

Bold fixed

Note: Make sure to "stick" the * _ = == signs to the words, e.g. take away spaces.

_This works_,
_this not _

This works, _this not _

Verbatim Mode:
Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags.
Note: Use <pre> and </pre> tags instead if you want that HTML code is interpreted.
Note: Each tag must be on a line by itself.

<verbatim>
class CatAnimal {
  void purr() {
	 <code here>
  }
}
</verbatim>

class CatAnimal {
  void purr() {
    <code here>
  }
}

Separator:
At least three dashes at the beginning of a line.

-------

List Item:
Three spaces and an asterisk.

	* bullet item

bullet item

Nested List Item:
Six, nine, ... spaces and an asterisk.

		* nested stuff

- nested stuff

Ordered List:
Three spaces and a number.

	1 Sushi
	1 Dim Sum

Sushi
Dim Sum

Definition List:
Three spaces, the term, a colon, a space, followed by the definition.
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   non-breaking-space entity.

	Sushi: Japan
	Dim&nbsp;Sum: S.F.

Sushi: Japan
Dim Sum: S.F.

Table:
Optional spaces followed by the cells enclosed in vertical bars.
Note: | *bold* | cells are rendered as table headers.
Note: | spaced | cells are rendered center aligned.
Note: | spaced | cells are rendered right aligned.
Note: | 2 colspan || cells are rendered as multi-span columns.
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.

| *L* | *C* | *R* |
| A2 |  2  |  2 |
| A3 |  3  |  3 |
| multi span |||
| A4 \
  | next \
  | next |

L	C	R
A2	2	2
A3	3	3
multi span
A4	next	next

WikiWord Links:
CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically.
Note: In case you want to link to a topic in a different KoreaCmsWiki? web write Webname.TopicName.

WebNotify

Know.ReadmeFirst

ReadmeFirst?

#SquareBrackets Forced Links:
You can create a forced internal link by enclosing words in double square brackets.
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. [[text formatting FAQ]] links to topic TextFormattingFAQ. You can also refer to a different web and use anchors.

[[wiki syntax]]

[[Main.TWiki users]]

Specific Links:
Create a link where you can specify the link text and the link reference separately, using nested square brackets like [[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 [[WebHome#MyAnchor][go home]] and [[http://www.yahoo.com/#somewhere][Yahoo!]].

[[WikiSyntax][syntax]]

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

Easier External Links:
An easier syntax for external links is now available: [[externalURL text]] - just hit the spacebar to separate the link URL from the descriptive text, e.g. [[http://gnu.org/ GNU]]. This also supports anchors, e.g. [[http://www.yahoo.com/#somewhere Yahoo!]].

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

Anchors:
You can define a link reference inside a KoreaCmsWiki? 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 [[MyTopic#MyAnchor]] syntax. You can omit the topic name if you want to link within the same topic.

[[WebHome#NotThere]]

[[#MyAnchor][Jump]]

#MyAnchor To here

To here

Prevent a Link:
Prevent a WikiWord from being linked by prepending it with the <nop> tag.

<nop>SunOS

SunOS

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 TWiki shorthand instead - this keeps the text uncluttered and easy to edit.
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.
- 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."
NOTE: The opening and closing angle brackets - <...> - 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, <, ex: a > b
- 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 GoodStyle topic located in the current KoreaCmsWiki? 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://... and mailto:...@... are linked automatically.

Email addresses like name@domain.com are linked automatically.

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

Added: >
>

TWiki Variables

Added: >
>Variables are names that are enclosed in percent signs % that are expanded on the fly.

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

%WEB% : The current web, is TWiki.

%TOPIC% : The current topic name, is TextFormattingRules.

%ATTACHURL% : The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as %ATTACHURL%/image.gif to show the URL of the file or the image in your text.

%INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current KoreaCmsWiki? web is the default web. Example: %INCLUDE{"TWiki.SiteMap"}%

There are many more variables, see TWikiVariables.

TWikiPreferences defines site-wide variables like colors. For example, write: %RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors to get: Red and blue colors.

TWikiPlugin Formatting Extensions

Plugins provide additional text formatting capabilities and can extend the functionality of KoreaCmsWiki? into many other areas. For example, the optional SpreadSheetPlugin lets you create a spreadsheet with the same basic notation used in TWiki tables.

Available Plugins are located in the Plugins web on TWiki.org. Currently enabled plugins on this TWiki installation, as listed by %PLUGINDESCRIPTIONS%:

SpreadSheetPlugin (2018-07-05, $Rev: 30478 (2018-07-16) $): Add spreadsheet calculation like "$SUM( $ABOVE() )" to TWiki tables and other topic text
BackupRestorePlugin (2018-07-10, $Rev: 30551 (2018-07-16) $): Administrator utility to backup, restore and upgrade a TWiki site
ColorPickerPlugin (2018-07-05, $Rev: 30442 (2018-07-16) $): Color picker, packaged for use in TWiki forms and TWiki applications
CommentPlugin (2018-07-05, $Rev: 30530 (2018-07-16) $): Quickly post comments to a page without an edit/preview/save cycle
DatePickerPlugin (2018-07-05, $Rev: 30446 (2018-07-16) $): Pop-up calendar with date picker, for use in TWiki forms, HTML forms and TWiki plugins
EditTablePlugin (2018-07-05, $Rev: 30448 (2018-07-16) $): Edit TWiki tables using edit fields, date pickers and drop down boxes
HeadlinesPlugin (2018-07-13, $Rev: 30560 (2018-07-16) $): Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites
InterwikiPlugin (2018-07-05, $Rev: 30454 (2018-07-16) $): Write ExternalSite:Page to link to a page on an external site based on aliases defined in a rules topic
JQueryPlugin (2018-07-05, $Rev: 30456 (2018-07-16) $): jQuery JavaScript library for TWiki
PreferencesPlugin (2018-07-05, $Rev: 30528 (2018-07-16) $): Allows editing of preferences using fields predefined in a form
SetGetPlugin (2018-07-05, $Rev: 30472 (2018-07-16) $): Set and get variables and JSON objects in topics, optionally persistently across topic views
SlideShowPlugin (2018-07-05, $Rev: 30474 (2018-07-16) $): Create web based presentations based on topics with headings.
SmiliesPlugin (2018-07-05, $Rev: 30476 (2018-07-16) $): Render smilies as icons, like for :-) or for :eek:
TWikiSheetPlugin (2018-07-15, $Rev: 30604 (2018-07-16) $): Add TWiki Sheet spreadsheet functionality to TWiki tables
TablePlugin (2018-07-05, $Rev: 30480 (2018-07-16) $): Control attributes of tables and sorting of table columns
TagMePlugin (2018-07-05, $Rev: 30482 (2018-07-16) $): Tag wiki content collectively or authoritatively to find content by keywords
TinyMCEPlugin (2018-07-10, $Rev: 30541 (2018-07-16) $): Integration of the Tiny MCE WYSIWYG Editor
TwistyPlugin (2018-07-06, $Rev: 30497 (2018-07-16) $): Twisty section JavaScript library to open/close content dynamically
WatchlistPlugin (2018-07-10, $Rev: 30536 (2018-07-16) $): Watch topics of interest and get notified of changes by e-mail
WysiwygPlugin (2018-07-06, $Rev: 30528 (2018-07-16) $): Translator framework for WYSIWYG editors

Check on current Plugin status and settings for this site in TWikiPreferences.Deleted: <
<-- MikeMannix? - 02 Dec 2001 Changed: <
<Updated to cover TWiki:Codev/EasierExternalLinking (in the alpha release).>
>

Common Editing Errors

Changed: <
<-- RichardDonkin? - 26 Mar 2002 >
>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: Changed: <
<Latest updates to this topic are in the main TWiki, since that's got the TWikiAlphaRelease code.>
>

Q: Text enclosed in angle brackets like <filename> is not displayed. How can I show it as it is?

Added: >
>

- A: The '<' and '>' characters have a special meaning in HTML, they define HTML tags. You need to escape them, so write '<' instead of '<', and '>' instead of '>'.
  Example: Type 'prog <filename>' to get 'prog <filename>'.

Changed: <
<-- RichardDonkin? - 05 Apr 2002 >
>

Q: Why is the '&' character sometimes not displayed?

Added: >
>

- A: The '&' character has a special meaning in HTML, it starts a so called character entity, i.e. '©' is the © copyright character. You need to escape '&' to see it as it is, so write '&' instead of '&'.
  Example: Type 'This & that' to get 'This & that'.

-- MikeMannix? - 02 Dec 2001
-- PeterThoeny? - 02 May 2002

Revision 322002-04-05 - RichardDonkin?

TWiki Text Formatting

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.

TWiki Editing Shorthand

Formatting Command: Example: You write: You get:

Paragraphs:
Blank lines will create new paragraphs.

1st paragraph

2nd paragraph

1st paragraph

2nd paragraph

Headings:
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 %TOC% variable, see TWikiVariables.

---++ Sushi

---+++ Maguro

Sushi

Maguro

Bold Text:
Words get bold by enclosing them in * asterisks.

*Bold*

Bold

Italic Text:
Words get italic by enclosing them in _ underscores.

_Italic_

Italic

Bold Italic:
Words get _bold italic by enclosing them in _ double-underscores.

__Bold italic__

Bold italic

Fixed Font:
Words get shown in fixed font by enclosing them in = equal signs.

=Fixed font=

Fixed font

Bold Fixed Font:
Words get shown in bold fixed font by enclosing them in double equal signs.

==Bold fixed==

Bold fixed

Note: Make sure to "stick" the * _ = == signs to the words, e.g. take away spaces.

_This works_,
_this not _

This works, _this not _

Verbatim Mode:
Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags.
Note: Use <pre> and </pre> tags instead if you want that HTML code is interpreted.
Note: Each tag must be on a line by itself.

<verbatim>
class CatAnimal {
  void purr() {
	 <code here>
  }
}
</verbatim>

class CatAnimal {
  void purr() {
    <code here>
  }
}

Separator:
At least three dashes at the beginning of a line.

-------

List Item:
Three spaces and an asterisk.

	* bullet item

bullet item

Nested List Item:
Six, nine, ... spaces and an asterisk.

		* nested stuff

- nested stuff

Ordered List:
Three spaces and a number.

	1 Sushi
	1 Dim Sum

Sushi
Dim Sum

Definition List:
Three spaces, the term, a colon, a space, followed by the definition.
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   non-breaking-space entity.

	Sushi: Japan
	Dim&nbsp;Sum: S.F.

Sushi: Japan
Dim Sum: S.F.

Table:
Optional spaces followed by the cells enclosed in vertical bars.
Note: | *bold* | cells are rendered as table headers.
Note: | spaced | cells are rendered center aligned.
Note: | spaced | cells are rendered right aligned.
Note: | 2 colspan || cells are rendered as multi-span columns.
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.

| *L* | *C* | *R* |
| A2 |  2  |  2 |
| A3 |  3  |  3 |
| multi span |||
| A4 \
  | next \
  | next |

L	C	R
A2	2	2
A3	3	3
multi span
A4	next	next

WikiWord Links:
CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically.
Note: In case you want to link to a topic in a different KoreaCmsWiki? web write Webname.TopicName.

WebNotify

Know.ReadmeFirst

ReadmeFirst?

#SquareBrackets Forced Links:
You can create a forced internal link by enclosing words in double square brackets.
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. [[text formatting FAQ]] links to topic TextFormattingFAQ. You can also refer to a different web and use anchors.

[[wiki syntax]]

[[Main.TWiki users]]

Specific Links:
Create a link where you can specify the link text and the link reference separately, using nested square brackets like [[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 [[WebHome#MyAnchor][go home]] and [[http://www.yahoo.com/#somewhere][Yahoo!]].

[[WikiSyntax][syntax]]

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

Easier External Links:
An easier syntax for external links is now available: [[externalURL text]] - just hit the spacebar to separate the link URL from the descriptive text, e.g. [[http://gnu.org/ GNU]]. This also supports anchors, e.g. [[http://www.yahoo.com/#somewhere Yahoo!]].

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

Anchors:
You can define a link reference inside a KoreaCmsWiki? 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 [[MyTopic#MyAnchor]] syntax. You can omit the topic name if you want to link within the same topic.

[[WebHome#NotThere]]

[[#MyAnchor][Jump]]

#MyAnchor To here

To here

Prevent a Link:
Prevent a WikiWord from being linked by prepending it with the <nop> tag.

<nop>SunOS

SunOS

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 TWiki shorthand instead - this keeps the text uncluttered and easy to edit.
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.
- 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."
NOTE: The opening and closing angle brackets - <...> - 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, <, ex: a > b
- 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 GoodStyle topic located in the current KoreaCmsWiki? 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://... and mailto:...@... are linked automatically.

Email addresses like name@domain.com are linked automatically.

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

TWikiPlugin Formatting Extensions

Plugins provide additional text formatting capabilities and can extend the functionality of KoreaCmsWiki? into many other areas. For example, the optional SpreadSheetPlugin lets you create a spreadsheet with the same basic notation used in TWiki tables.

Available Plugins are located in the Plugins web on TWiki.org. Currently enabled plugins on this TWiki installation, as listed by %PLUGINDESCRIPTIONS%:

SpreadSheetPlugin (2018-07-05, $Rev: 30478 (2018-07-16) $): Add spreadsheet calculation like "$SUM( $ABOVE() )" to TWiki tables and other topic text
BackupRestorePlugin (2018-07-10, $Rev: 30551 (2018-07-16) $): Administrator utility to backup, restore and upgrade a TWiki site
ColorPickerPlugin (2018-07-05, $Rev: 30442 (2018-07-16) $): Color picker, packaged for use in TWiki forms and TWiki applications
CommentPlugin (2018-07-05, $Rev: 30530 (2018-07-16) $): Quickly post comments to a page without an edit/preview/save cycle
DatePickerPlugin (2018-07-05, $Rev: 30446 (2018-07-16) $): Pop-up calendar with date picker, for use in TWiki forms, HTML forms and TWiki plugins
EditTablePlugin (2018-07-05, $Rev: 30448 (2018-07-16) $): Edit TWiki tables using edit fields, date pickers and drop down boxes
HeadlinesPlugin (2018-07-13, $Rev: 30560 (2018-07-16) $): Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites
InterwikiPlugin (2018-07-05, $Rev: 30454 (2018-07-16) $): Write ExternalSite:Page to link to a page on an external site based on aliases defined in a rules topic
JQueryPlugin (2018-07-05, $Rev: 30456 (2018-07-16) $): jQuery JavaScript library for TWiki
PreferencesPlugin (2018-07-05, $Rev: 30528 (2018-07-16) $): Allows editing of preferences using fields predefined in a form
SetGetPlugin (2018-07-05, $Rev: 30472 (2018-07-16) $): Set and get variables and JSON objects in topics, optionally persistently across topic views
SlideShowPlugin (2018-07-05, $Rev: 30474 (2018-07-16) $): Create web based presentations based on topics with headings.
SmiliesPlugin (2018-07-05, $Rev: 30476 (2018-07-16) $): Render smilies as icons, like for :-) or for :eek:
TWikiSheetPlugin (2018-07-15, $Rev: 30604 (2018-07-16) $): Add TWiki Sheet spreadsheet functionality to TWiki tables
TablePlugin (2018-07-05, $Rev: 30480 (2018-07-16) $): Control attributes of tables and sorting of table columns
TagMePlugin (2018-07-05, $Rev: 30482 (2018-07-16) $): Tag wiki content collectively or authoritatively to find content by keywords
TinyMCEPlugin (2018-07-10, $Rev: 30541 (2018-07-16) $): Integration of the Tiny MCE WYSIWYG Editor
TwistyPlugin (2018-07-06, $Rev: 30497 (2018-07-16) $): Twisty section JavaScript library to open/close content dynamically
WatchlistPlugin (2018-07-10, $Rev: 30536 (2018-07-16) $): Watch topics of interest and get notified of changes by e-mail
WysiwygPlugin (2018-07-06, $Rev: 30528 (2018-07-16) $): Translator framework for WYSIWYG editors

Check on current Plugin status and settings for this site in TWikiPreferences.

-- MikeMannix? - 02 Dec 2001

Updated to cover TWiki:Codev/EasierExternalLinking (in the alpha release).Changed: <
<-- RichardDonkin? - 26 Mar 2002 >
>-- RichardDonkin? - 26 Mar 2002 Added: >
> Latest updates to this topic are in the main TWiki, since that's got the TWikiAlphaRelease code.

-- RichardDonkin? - 05 Apr 2002

Revision 312002-03-26 - RichardDonkin?

TWiki Text Formatting

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.

TWiki Editing Shorthand

Formatting Command: Example: You write: You get:

Paragraphs:
Blank lines will create new paragraphs.

1st paragraph

2nd paragraph

1st paragraph

2nd paragraph

Headings:
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 %TOC% variable, see TWikiVariables.

---++ Sushi

---+++ Maguro

Sushi

Maguro

Bold Text:
Words get bold by enclosing them in * asterisks.

*Bold*

Bold

Italic Text:
Words get italic by enclosing them in _ underscores.

_Italic_

Italic

Bold Italic:
Words get _bold italic by enclosing them in _ double-underscores.

__Bold italic__

Bold italic

Fixed Font:
Words get shown in fixed font by enclosing them in = equal signs.

=Fixed font=

Fixed font

Bold Fixed Font:
Words get shown in bold fixed font by enclosing them in double equal signs.

==Bold fixed==

Bold fixed

Note: Make sure to "stick" the * _ = == signs to the words, e.g. take away spaces.

_This works_,
_this not _

This works, _this not _

Verbatim Mode:
Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags.
Note: Use <pre> and </pre> tags instead if you want that HTML code is interpreted.
Note: Each tag must be on a line by itself.

<verbatim>
class CatAnimal {
  void purr() {
	 <code here>
  }
}
</verbatim>

class CatAnimal {
  void purr() {
    <code here>
  }
}

Separator:
At least three dashes at the beginning of a line.

-------

List Item:
Three spaces and an asterisk.

	* bullet item

bullet item

Nested List Item:
Six, nine, ... spaces and an asterisk.

		* nested stuff

- nested stuff

Ordered List:
Three spaces and a number.

	1 Sushi
	1 Dim Sum

Sushi
Dim Sum

Definition List:
Three spaces, the term, a colon, a space, followed by the definition.
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   non-breaking-space entity.

	Sushi: Japan
	Dim&nbsp;Sum: S.F.

Sushi: Japan
Dim Sum: S.F.

Table:
Optional spaces followed by the cells enclosed in vertical bars.
Note: | *bold* | cells are rendered as table headers.
Note: | spaced | cells are rendered center aligned.
Note: | spaced | cells are rendered right aligned.
Note: | 2 colspan || cells are rendered as multi-span columns.
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.

| *L* | *C* | *R* |
| A2 |  2  |  2 |
| A3 |  3  |  3 |
| multi span |||
| A4 \
  | next \
  | next |

L	C	R
A2	2	2
A3	3	3
multi span
A4	next	next

WikiWord Links:
CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically.
Note: In case you want to link to a topic in a different KoreaCmsWiki? web write Webname.TopicName.

WebNotify

Know.ReadmeFirst

ReadmeFirst?

#SquareBrackets Forced Links:
You can create a forced internal link by enclosing words in double square brackets.
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. [[text formatting FAQ]] links to topic TextFormattingFAQ. You can also refer to a different web and use anchors.

[[wiki syntax]]

[[Main.TWiki users]]

Specific Links:
Create a link where you can specify the link text and the link reference separately, using nested square brackets like [[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 [[WebHome#MyAnchor][go home]] and [[http://www.yahoo.com/#somewhere][Yahoo!]].

[[WikiSyntax][syntax]]

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

Added:

>
>

Easier External Links:
An easier syntax for external links is now available: [[externalURL text]] - just hit the spacebar to separate the link URL from the descriptive text, e.g. [[http://gnu.org/ GNU]]. This also supports anchors, e.g. [[http://www.yahoo.com/#somewhere Yahoo!]].

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

Anchors:
You can define a link reference inside a KoreaCmsWiki? 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 [[MyTopic#MyAnchor]] syntax. You can omit the topic name if you want to link within the same topic.

[[WebHome#NotThere]]

[[#MyAnchor][Jump]]

#MyAnchor To here

To here

Prevent a Link:
Prevent a WikiWord from being linked by prepending it with the <nop> tag.

<nop>SunOS

SunOS

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 TWiki shorthand instead - this keeps the text uncluttered and easy to edit.
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.
- 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."
NOTE: The opening and closing angle brackets - <...> - 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, <, ex: a > b
- 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 GoodStyle topic located in the current KoreaCmsWiki? 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://... and mailto:...@... are linked automatically.

Email addresses like name@domain.com are linked automatically.

[[Square bracket rules]] let you easily create non-WikiWord links.

Added: >
>

- You can also write [[http://yahoo.com Yahoo home page]] as an easier way of doing external links with descriptive text for the link, such as Yahoo home page.

Added: >
>

TWikiPlugin Formatting Extensions

Plugins provide additional text formatting capabilities and can extend the functionality of KoreaCmsWiki? into many other areas. For example, the optional SpreadSheetPlugin lets you create a spreadsheet with the same basic notation used in TWiki tables.

Available Plugins are located in the Plugins web on TWiki.org. Currently enabled plugins on this TWiki installation, as listed by %PLUGINDESCRIPTIONS%:

SpreadSheetPlugin (2018-07-05, $Rev: 30478 (2018-07-16) $): Add spreadsheet calculation like "$SUM( $ABOVE() )" to TWiki tables and other topic text
BackupRestorePlugin (2018-07-10, $Rev: 30551 (2018-07-16) $): Administrator utility to backup, restore and upgrade a TWiki site
ColorPickerPlugin (2018-07-05, $Rev: 30442 (2018-07-16) $): Color picker, packaged for use in TWiki forms and TWiki applications
CommentPlugin (2018-07-05, $Rev: 30530 (2018-07-16) $): Quickly post comments to a page without an edit/preview/save cycle
DatePickerPlugin (2018-07-05, $Rev: 30446 (2018-07-16) $): Pop-up calendar with date picker, for use in TWiki forms, HTML forms and TWiki plugins
EditTablePlugin (2018-07-05, $Rev: 30448 (2018-07-16) $): Edit TWiki tables using edit fields, date pickers and drop down boxes
HeadlinesPlugin (2018-07-13, $Rev: 30560 (2018-07-16) $): Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites
InterwikiPlugin (2018-07-05, $Rev: 30454 (2018-07-16) $): Write ExternalSite:Page to link to a page on an external site based on aliases defined in a rules topic
JQueryPlugin (2018-07-05, $Rev: 30456 (2018-07-16) $): jQuery JavaScript library for TWiki
PreferencesPlugin (2018-07-05, $Rev: 30528 (2018-07-16) $): Allows editing of preferences using fields predefined in a form
SetGetPlugin (2018-07-05, $Rev: 30472 (2018-07-16) $): Set and get variables and JSON objects in topics, optionally persistently across topic views
SlideShowPlugin (2018-07-05, $Rev: 30474 (2018-07-16) $): Create web based presentations based on topics with headings.
SmiliesPlugin (2018-07-05, $Rev: 30476 (2018-07-16) $): Render smilies as icons, like for :-) or for :eek:
TWikiSheetPlugin (2018-07-15, $Rev: 30604 (2018-07-16) $): Add TWiki Sheet spreadsheet functionality to TWiki tables
TablePlugin (2018-07-05, $Rev: 30480 (2018-07-16) $): Control attributes of tables and sorting of table columns
TagMePlugin (2018-07-05, $Rev: 30482 (2018-07-16) $): Tag wiki content collectively or authoritatively to find content by keywords
TinyMCEPlugin (2018-07-10, $Rev: 30541 (2018-07-16) $): Integration of the Tiny MCE WYSIWYG Editor
TwistyPlugin (2018-07-06, $Rev: 30497 (2018-07-16) $): Twisty section JavaScript library to open/close content dynamically
WatchlistPlugin (2018-07-10, $Rev: 30536 (2018-07-16) $): Watch topics of interest and get notified of changes by e-mail
WysiwygPlugin (2018-07-06, $Rev: 30528 (2018-07-16) $): Translator framework for WYSIWYG editors

Check on current Plugin status and settings for this site in TWikiPreferences.Changed: <
<-- MikeMannix? - 02 Dec 2001>
>-- MikeMannix? - 02 Dec 2001Added: >
> Updated to cover TWiki:Codev/EasierExternalLinking (in the alpha release).

-- RichardDonkin? - 26 Mar 2002

Revision 302001-12-03 - MikeMannix?

TWiki Text Formatting

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.

TWiki Editing Shorthand

Formatting Command: Example: You write: You get:

Paragraphs:
Blank lines will create new paragraphs.

1st paragraph

2nd paragraph

1st paragraph

2nd paragraph

Headings:
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 %TOC% variable, see TWikiVariables.

---++ Sushi

---+++ Maguro

Sushi

Maguro

Bold Text:
Words get bold by enclosing them in * asterisks.

*Bold*

Bold

Italic Text:
Words get italic by enclosing them in _ underscores.

_Italic_

Italic

Bold Italic:
Words get _bold italic by enclosing them in _ double-underscores.

__Bold italic__

Bold italic

Fixed Font:
Words get shown in fixed font by enclosing them in = equal signs.

=Fixed font=

Fixed font

Bold Fixed Font:
Words get shown in bold fixed font by enclosing them in double equal signs.

==Bold fixed==

Bold fixed

Note: Make sure to "stick" the * _ = == signs to the words, e.g. take away spaces.

_This works_,
_this not _

This works, _this not _

Verbatim Mode:
Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags.
Note: Use <pre> and </pre> tags instead if you want that HTML code is interpreted.
Note: Each tag must be on a line by itself.

<verbatim>
class CatAnimal {
  void purr() {
	 <code here>
  }
}
</verbatim>

class CatAnimal {
  void purr() {
    <code here>
  }
}

Separator:
At least three dashes at the beginning of a line.

-------

List Item:
Three spaces and an asterisk.

	* bullet item

bullet item

Nested List Item:
Six, nine, ... spaces and an asterisk.

		* nested stuff

- nested stuff

Ordered List:
Three spaces and a number.

	1 Sushi
	1 Dim Sum

Sushi
Dim Sum

Definition List:
Three spaces, the term, a colon, a space, followed by the definition.
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   non-breaking-space entity.

	Sushi: Japan
	Dim&nbsp;Sum: S.F.

Sushi: Japan
Dim Sum: S.F.

Table:
Optional spaces followed by the cells enclosed in vertical bars.
Note: | *bold* | cells are rendered as table headers.
Note: | spaced | cells are rendered center aligned.
Note: | spaced | cells are rendered right aligned.
Note: | 2 colspan || cells are rendered as multi-span columns.
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.

| *L* | *C* | *R* |
| A2 |  2  |  2 |
| A3 |  3  |  3 |
| multi span |||
| A4 \
  | next \
  | next |

L	C	R
A2	2	2
A3	3	3
multi span
A4	next	next

WikiWord Links:
CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically.
Note: In case you want to link to a topic in a different KoreaCmsWiki? web write Webname.TopicName.

WebNotify

Know.ReadmeFirst

ReadmeFirst?

#SquareBrackets Forced Links:
You can create a forced internal link by enclosing words in double square brackets.
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. [[text formatting FAQ]] links to topic TextFormattingFAQ. You can also refer to a different web and use anchors.

[[wiki syntax]]

[[Main.TWiki users]]

Specific Links:
Create a link where you can specify the link text and the link reference separately, using nested square brackets like [[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 [[WebHome#MyAnchor][go home]] and [[http://www.yahoo.com/#somewhere][Yahoo!]].

[[WikiSyntax][syntax]]

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

Anchors:
You can define a link reference inside a KoreaCmsWiki? 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 [[MyTopic#MyAnchor]] syntax. You can omit the topic name if you want to link within the same topic.

[[WebHome#NotThere]]

[[#MyAnchor][Jump]]

#MyAnchor To here

To here

Prevent a Link:
Prevent a WikiWord from being linked by prepending it with the <nop> tag.

<nop>SunOS

SunOS

Using HTML

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

HTML and TWiki Usability

On collaboration pages, it's preferable NOT to use HTML, and to use TWiki shorthand instead - this keeps the text uncluttered and easy to edit.

Changed: <
<

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

Deleted: <
<

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

Added: >
>

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.
- 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."
NOTE: The opening and closing angle brackets - <...> - 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, <, ex: a > b
- 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 GoodStyle topic located in the current KoreaCmsWiki? 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://... and mailto:...@... are linked automatically.

Email addresses like name@domain.com are linked automatically.

[[Square bracket rules]] let you easily create non-WikiWord links.

TWikiPlugin Formatting Extensions

Plugins provide additional text formatting capabilities and can extend the functionality of KoreaCmsWiki? into many other areas. For example, the optional SpreadSheetPlugin lets you create a spreadsheet with the same basic notation used in TWiki tables.

Available Plugins are located in the Plugins web on TWiki.org. Currently enabled plugins on this TWiki installation, as listed by %PLUGINDESCRIPTIONS%:

SpreadSheetPlugin (2018-07-05, $Rev: 30478 (2018-07-16) $): Add spreadsheet calculation like "$SUM( $ABOVE() )" to TWiki tables and other topic text
BackupRestorePlugin (2018-07-10, $Rev: 30551 (2018-07-16) $): Administrator utility to backup, restore and upgrade a TWiki site
ColorPickerPlugin (2018-07-05, $Rev: 30442 (2018-07-16) $): Color picker, packaged for use in TWiki forms and TWiki applications
CommentPlugin (2018-07-05, $Rev: 30530 (2018-07-16) $): Quickly post comments to a page without an edit/preview/save cycle
DatePickerPlugin (2018-07-05, $Rev: 30446 (2018-07-16) $): Pop-up calendar with date picker, for use in TWiki forms, HTML forms and TWiki plugins
EditTablePlugin (2018-07-05, $Rev: 30448 (2018-07-16) $): Edit TWiki tables using edit fields, date pickers and drop down boxes
HeadlinesPlugin (2018-07-13, $Rev: 30560 (2018-07-16) $): Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites
InterwikiPlugin (2018-07-05, $Rev: 30454 (2018-07-16) $): Write ExternalSite:Page to link to a page on an external site based on aliases defined in a rules topic
JQueryPlugin (2018-07-05, $Rev: 30456 (2018-07-16) $): jQuery JavaScript library for TWiki
PreferencesPlugin (2018-07-05, $Rev: 30528 (2018-07-16) $): Allows editing of preferences using fields predefined in a form
SetGetPlugin (2018-07-05, $Rev: 30472 (2018-07-16) $): Set and get variables and JSON objects in topics, optionally persistently across topic views
SlideShowPlugin (2018-07-05, $Rev: 30474 (2018-07-16) $): Create web based presentations based on topics with headings.
SmiliesPlugin (2018-07-05, $Rev: 30476 (2018-07-16) $): Render smilies as icons, like for :-) or for :eek:
TWikiSheetPlugin (2018-07-15, $Rev: 30604 (2018-07-16) $): Add TWiki Sheet spreadsheet functionality to TWiki tables
TablePlugin (2018-07-05, $Rev: 30480 (2018-07-16) $): Control attributes of tables and sorting of table columns
TagMePlugin (2018-07-05, $Rev: 30482 (2018-07-16) $): Tag wiki content collectively or authoritatively to find content by keywords
TinyMCEPlugin (2018-07-10, $Rev: 30541 (2018-07-16) $): Integration of the Tiny MCE WYSIWYG Editor
TwistyPlugin (2018-07-06, $Rev: 30497 (2018-07-16) $): Twisty section JavaScript library to open/close content dynamically
WatchlistPlugin (2018-07-10, $Rev: 30536 (2018-07-16) $): Watch topics of interest and get notified of changes by e-mail
WysiwygPlugin (2018-07-06, $Rev: 30528 (2018-07-16) $): Translator framework for WYSIWYG editors

Check on current Plugin status and settings for this site in TWikiPreferences.Changed: <
<-- MikeMannix? - 02 Dec 2001>
>-- MikeMannix? - 02 Dec 2001

Revision 292001-12-02 - MikeMannix?

TWiki Text Formatting

Changed:

<
<

Appendix C: Text Formatting Rules

>
>

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.

TWiki Editing Shorthand

Formatting Command: Example: You write: You get:

Paragraphs:
Blank lines will create new paragraphs.

1st paragraph

2nd paragraph

1st paragraph

2nd paragraph

Headings:
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 %TOC% variable, see TWikiVariables.

---++ Sushi

---+++ Maguro

Sushi

Maguro

Bold Text:
Words get bold by enclosing them in * asterisks.

*Bold*

Bold

Italic Text:
Words get italic by enclosing them in _ underscores.

_Italic_

Italic

Bold Italic:
Words get _bold italic by enclosing them in _ double-underscores.

__Bold italic__

Bold italic

Fixed Font:
Words get shown in fixed font by enclosing them in = equal signs.

=Fixed font=

Fixed font

Bold Fixed Font:
Words get shown in bold fixed font by enclosing them in double equal signs.

==Bold fixed==

Bold fixed

Note: Make sure to "stick" the * _ = == signs to the words, e.g. take away spaces.

_This works_,
_this not _

This works, _this not _

Verbatim Mode:
Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags.
Note: Use <pre> and </pre> tags instead if you want that HTML code is interpreted.
Note: Each tag must be on a line by itself.

<verbatim>
class CatAnimal {
  void purr() {
	 <code here>
  }
}
</verbatim>

class CatAnimal {
  void purr() {
    <code here>
  }
}

Separator:
At least three dashes at the beginning of a line.

-------

List Item:
Three spaces and an asterisk.

	* bullet item

bullet item

Nested List Item:
Six, nine, ... spaces and an asterisk.

		* nested stuff

- nested stuff

Ordered List:
Three spaces and a number.

	1 Sushi
	1 Dim Sum

Sushi
Dim Sum

Definition List:
Three spaces, the term, a colon, a space, followed by the definition.
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   non-breaking-space entity.

	Sushi: Japan
	Dim&nbsp;Sum: S.F.

Sushi: Japan
Dim Sum: S.F.

Table:
Optional spaces followed by the cells enclosed in vertical bars.
Note: | *bold* | cells are rendered as table headers.
Note: | spaced | cells are rendered center aligned.
Note: | spaced | cells are rendered right aligned.
Note: | 2 colspan || cells are rendered as multi-span columns.
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.

| *L* | *C* | *R* |
| A2 |  2  |  2 |
| A3 |  3  |  3 |
| multi span |||
| A4 \
  | next \
  | next |

L	C	R
A2	2	2
A3	3	3
multi span
A4	next	next

WikiWord Links:
CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically.
Note: In case you want to link to a topic in a different KoreaCmsWiki? web write Webname.TopicName.

WebNotify

Know.ReadmeFirst

ReadmeFirst?

Changed:

<
<

>
>

#SquareBrackets

Deleted:

<
<

Forced Links:
You can create a forced internal link by enclosing words in double square brackets.
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. [[text formatting FAQ]] links to topic TextFormattingFAQ. You can also refer to a different web and use anchors.

[[wiki syntax]] [[Main.TWiki users]]	wiki syntax Main.TWiki users
Specific Links: Create a link where you can specify the link text and the link reference separately, using nested square brackets like `[[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 `[[WebHome#MyAnchor][go home]]` and `[[http://www.yahoo.com/#somewhere][Yahoo!]]`.	[[WikiSyntax][syntax]] [[http://gnu.org][GNU]]	syntax GNU
Anchors: You can define a link reference inside a KoreaCmsWiki? 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 `[[MyTopic#MyAnchor]]` syntax. You can omit the topic name if you want to link within the same topic.	[[WebHome#NotThere]] [[#MyAnchor][Jump]] #MyAnchor To here	WebHome#NotThere Jump To here
Prevent a Link: Prevent a WikiWord from being linked by prepending it with the `<nop>` tag.	<nop>SunOS	SunOS

Using HTML

You can use just about any HTML tag without a problem - however, to keep in mind:

On collaboration pages, it's preferable NOT to use HTML, and to use TWiki shorthand instead - this keeps the text uncluttered and easy to edit.
- 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.

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 GoodStyle topic located in the current KoreaCmsWiki? 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://... and mailto:...@... are linked automatically.

Email addresses like name@domain.com are linked automatically.

[[Square bracket rules]] let you easily create non-WikiWord links.

Changed: <
<

TWiki Variables

>
>

TWikiPlugin Formatting Extensions

Changed: <
<Variables are names that are enclosed in percent signs % that are expanded on the fly.>
>Plugins provide additional text formatting capabilities and can extend the functionality of KoreaCmsWiki? into many other areas. For example, the optional SpreadSheetPlugin

lets you create a spreadsheet with the same basic notation used in TWiki tables. Changed: <
<

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

>
>Available Plugins are located in the Plugins

web on TWiki.org. Currently enabled plugins on this TWiki installation, as listed by %PLUGINDESCRIPTIONS%: Deleted: <
<

%WEB% : The current web, is TWiki.

%TOPIC% : The current topic name, is TextFormattingRules.

%ATTACHURL% : The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as %ATTACHURL%/image.gif to show the URL of the file or the image in your text.

%INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current KoreaCmsWiki? web is the default web. Example: %INCLUDE{"TWiki.TWikiWebsTable"}%

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

Q: Why is the '&' character sometimes not displayed?
- A: The '&' character has a special meaning in HTML, it starts a so called character entity, ex: '©' is the © copyright character. You need to escape '&' to see it as it is, so write '&' instead of '&'.
  Example: Type 'This & that' to get 'This & that'.

TWiki Plugins

Plugins provide additional text formatting capabilities and can extend the functionality of KoreaCmsWiki? 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 Plugins web on TWiki.org. Currently enabled plugins on here:

SpreadSheetPlugin (2018-07-05, $Rev: 30478 (2018-07-16) $): Add spreadsheet calculation like "$SUM( $ABOVE() )" to TWiki tables and other topic text
BackupRestorePlugin (2018-07-10, $Rev: 30551 (2018-07-16) $): Administrator utility to backup, restore and upgrade a TWiki site
ColorPickerPlugin (2018-07-05, $Rev: 30442 (2018-07-16) $): Color picker, packaged for use in TWiki forms and TWiki applications
CommentPlugin (2018-07-05, $Rev: 30530 (2018-07-16) $): Quickly post comments to a page without an edit/preview/save cycle
DatePickerPlugin (2018-07-05, $Rev: 30446 (2018-07-16) $): Pop-up calendar with date picker, for use in TWiki forms, HTML forms and TWiki plugins
EditTablePlugin (2018-07-05, $Rev: 30448 (2018-07-16) $): Edit TWiki tables using edit fields, date pickers and drop down boxes
HeadlinesPlugin (2018-07-13, $Rev: 30560 (2018-07-16) $): Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites
InterwikiPlugin (2018-07-05, $Rev: 30454 (2018-07-16) $): Write ExternalSite:Page to link to a page on an external site based on aliases defined in a rules topic
JQueryPlugin (2018-07-05, $Rev: 30456 (2018-07-16) $): jQuery JavaScript library for TWiki
PreferencesPlugin (2018-07-05, $Rev: 30528 (2018-07-16) $): Allows editing of preferences using fields predefined in a form
SetGetPlugin (2018-07-05, $Rev: 30472 (2018-07-16) $): Set and get variables and JSON objects in topics, optionally persistently across topic views
SlideShowPlugin (2018-07-05, $Rev: 30474 (2018-07-16) $): Create web based presentations based on topics with headings.
SmiliesPlugin (2018-07-05, $Rev: 30476 (2018-07-16) $): Render smilies as icons, like for :-) or for :eek:
TWikiSheetPlugin (2018-07-15, $Rev: 30604 (2018-07-16) $): Add TWiki Sheet spreadsheet functionality to TWiki tables
TablePlugin (2018-07-05, $Rev: 30480 (2018-07-16) $): Control attributes of tables and sorting of table columns
TagMePlugin (2018-07-05, $Rev: 30482 (2018-07-16) $): Tag wiki content collectively or authoritatively to find content by keywords
TinyMCEPlugin (2018-07-10, $Rev: 30541 (2018-07-16) $): Integration of the Tiny MCE WYSIWYG Editor
TwistyPlugin (2018-07-06, $Rev: 30497 (2018-07-16) $): Twisty section JavaScript library to open/close content dynamically
WatchlistPlugin (2018-07-10, $Rev: 30536 (2018-07-16) $): Watch topics of interest and get notified of changes by e-mail
WysiwygPlugin (2018-07-06, $Rev: 30528 (2018-07-16) $): Translator framework for WYSIWYG editors

Check on current Plugin status and settings for this site in TWikiPreferences.Changed: <
<-- MikeMannix? - 02 Oct 2001
>
>-- MikeMannix? - 02 Dec 2001

Revision 282001-10-02 - MikeMannix?

TWiki Text Formatting

Changed:

<
<

TWiki Text Formatting

>
>

Appendix C: Text Formatting Rules

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.

TWiki Editing Shorthand

Formatting Command: Example: You write: You get:

Paragraphs:
Blank lines will create new paragraphs.

1st paragraph

2nd paragraph

1st paragraph

2nd paragraph

Headings:
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 %TOC% variable, see TWikiVariables.

---++ Sushi

---+++ Maguro

Sushi

Maguro

Bold Text:
Words get bold by enclosing them in * asterisks.

*Bold*

Bold

Italic Text:
Words get italic by enclosing them in _ underscores.

_Italic_

Italic

Bold Italic:
Words get _bold italic by enclosing them in _ double-underscores.

__Bold italic__

Bold italic

Fixed Font:
Words get shown in fixed font by enclosing them in = equal signs.

=Fixed font=

Fixed font

Bold Fixed Font:
Words get shown in bold fixed font by enclosing them in double equal signs.

==Bold fixed==

Bold fixed

Note: Make sure to "stick" the * _ = == signs to the words, e.g. take away spaces.

_This works_,
_this not _

This works, _this not _

Verbatim Mode:
Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags.
Note: Use <pre> and </pre> tags instead if you want that HTML code is interpreted.
Note: Each tag must be on a line by itself.

<verbatim>
class CatAnimal {
  void purr() {
	 <code here>
  }
}
</verbatim>

class CatAnimal {
  void purr() {
    <code here>
  }
}

Separator:
At least three dashes at the beginning of a line.

-------

List Item:
Three spaces and an asterisk.

	* bullet item

bullet item

Nested List Item:
Six, nine, ... spaces and an asterisk.

		* nested stuff

- nested stuff

Ordered List:
Three spaces and a number.

	1 Sushi
	1 Dim Sum

Sushi
Dim Sum

Definition List:
Three spaces, the term, a colon, a space, followed by the definition.
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   non-breaking-space entity.

	Sushi: Japan
	Dim&nbsp;Sum: S.F.

Sushi: Japan
Dim Sum: S.F.

Table:
Optional spaces followed by the cells enclosed in vertical bars.
Note: | *bold* | cells are rendered as table headers.
Note: | spaced | cells are rendered center aligned.
Note: | spaced | cells are rendered right aligned.
Note: | 2 colspan || cells are rendered as multi-span columns.
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.

| *L* | *C* | *R* |
| A2 |  2  |  2 |
| A3 |  3  |  3 |
| multi span |||
| A4 \
  | next \
  | next |

L	C	R
A2	2	2
A3	3	3
multi span
A4	next	next

WikiWord Links:
CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically.
Note: In case you want to link to a topic in a different KoreaCmsWiki? web write Webname.TopicName.

WebNotify

Know.ReadmeFirst

ReadmeFirst?

Forced Links:
You can create a forced internal link by enclosing words in double square brackets.
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. [[text formatting FAQ]] links to topic TextFormattingFAQ. You can also refer to a different web and use anchors.

[[wiki syntax]]

[[Main.TWiki users]]

Specific Links:
Create a link where you can specify the link text and the link reference separately, using nested square brackets like [[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 [[WebHome#MyAnchor][go home]] and [[http://www.yahoo.com/#somewhere][Yahoo!]].

[[WikiSyntax][syntax]]

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

Anchors:
You can define a link reference inside a KoreaCmsWiki? 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 [[MyTopic#MyAnchor]] syntax. You can omit the topic name if you want to link within the same topic.

[[WebHome#NotThere]]

[[#MyAnchor][Jump]]

#MyAnchor To here

To here

Prevent a Link:
Prevent a WikiWord from being linked by prepending it with the <nop> tag.

<nop>SunOS

SunOS

Using HTML

You can use just about any HTML tag without a problem - however, to keep in mind:

On collaboration pages, it's preferable NOT to use HTML, and to use TWiki shorthand instead - this keeps the text uncluttered and easy to edit.
- 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.

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 GoodStyle topic located in the current KoreaCmsWiki? 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://... and mailto:...@... are linked automatically.

Email addresses like name@domain.com are linked automatically.

[[Square bracket rules]] let you easily create non-WikiWord links.

TWiki Variables

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

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

%WEB% : The current web, is TWiki.

%TOPIC% : The current topic name, is TextFormattingRules.

%ATTACHURL% : The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as %ATTACHURL%/image.gif to show the URL of the file or the image in your text.

%INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current KoreaCmsWiki? web is the default web. Example: %INCLUDE{"TWiki.TWikiWebsTable"}%

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

Q: Why is the '&' character sometimes not displayed?

Changed: <
<

- A: The '&' character has a special meaning in HTML, it starts a so called character entity, i.e. '©' is the © copyright character. You need to escape '&' to see it as it is, so write '&' instead of '&'.
  Example: Type 'This & that' to get 'This & that'.

>
>

- A: The '&' character has a special meaning in HTML, it starts a so called character entity, ex: '©' is the © copyright character. You need to escape '&' to see it as it is, so write '&' instead of '&'.
  Example: Type 'This & that' to get 'This & that'.

TWiki Plugins

Plugins provide additional text formatting capabilities and can extend the functionality of KoreaCmsWiki? 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 Plugins web on TWiki.org. Currently enabled plugins on here:

SpreadSheetPlugin (2018-07-05, $Rev: 30478 (2018-07-16) $): Add spreadsheet calculation like "$SUM( $ABOVE() )" to TWiki tables and other topic text
BackupRestorePlugin (2018-07-10, $Rev: 30551 (2018-07-16) $): Administrator utility to backup, restore and upgrade a TWiki site
ColorPickerPlugin (2018-07-05, $Rev: 30442 (2018-07-16) $): Color picker, packaged for use in TWiki forms and TWiki applications
CommentPlugin (2018-07-05, $Rev: 30530 (2018-07-16) $): Quickly post comments to a page without an edit/preview/save cycle
DatePickerPlugin (2018-07-05, $Rev: 30446 (2018-07-16) $): Pop-up calendar with date picker, for use in TWiki forms, HTML forms and TWiki plugins
EditTablePlugin (2018-07-05, $Rev: 30448 (2018-07-16) $): Edit TWiki tables using edit fields, date pickers and drop down boxes
HeadlinesPlugin (2018-07-13, $Rev: 30560 (2018-07-16) $): Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites
InterwikiPlugin (2018-07-05, $Rev: 30454 (2018-07-16) $): Write ExternalSite:Page to link to a page on an external site based on aliases defined in a rules topic
JQueryPlugin (2018-07-05, $Rev: 30456 (2018-07-16) $): jQuery JavaScript library for TWiki
PreferencesPlugin (2018-07-05, $Rev: 30528 (2018-07-16) $): Allows editing of preferences using fields predefined in a form
SetGetPlugin (2018-07-05, $Rev: 30472 (2018-07-16) $): Set and get variables and JSON objects in topics, optionally persistently across topic views
SlideShowPlugin (2018-07-05, $Rev: 30474 (2018-07-16) $): Create web based presentations based on topics with headings.
SmiliesPlugin (2018-07-05, $Rev: 30476 (2018-07-16) $): Render smilies as icons, like for :-) or for :eek:
TWikiSheetPlugin (2018-07-15, $Rev: 30604 (2018-07-16) $): Add TWiki Sheet spreadsheet functionality to TWiki tables
TablePlugin (2018-07-05, $Rev: 30480 (2018-07-16) $): Control attributes of tables and sorting of table columns
TagMePlugin (2018-07-05, $Rev: 30482 (2018-07-16) $): Tag wiki content collectively or authoritatively to find content by keywords
TinyMCEPlugin (2018-07-10, $Rev: 30541 (2018-07-16) $): Integration of the Tiny MCE WYSIWYG Editor
TwistyPlugin (2018-07-06, $Rev: 30497 (2018-07-16) $): Twisty section JavaScript library to open/close content dynamically
WatchlistPlugin (2018-07-10, $Rev: 30536 (2018-07-16) $): Watch topics of interest and get notified of changes by e-mail
WysiwygPlugin (2018-07-06, $Rev: 30528 (2018-07-16) $): Translator framework for WYSIWYG editors

Check on current Plugin status and settings for this site in TWikiPreferences.Changed: <
<-- MikeMannix? - 30 Aug 2001>
>-- MikeMannix? - 02 Oct 2001

Revision 272001-09-18 - MikeMannix?

TWiki Text Formatting

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.

TWiki Editing Shorthand

Formatting Command: Example: You write: You get:

Paragraphs:
Blank lines will create new paragraphs.

1st paragraph

2nd paragraph

1st paragraph

2nd paragraph

Headings:
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 %TOC% variable, see TWikiVariables.

---++ Sushi

---+++ Maguro

Sushi

Maguro

Bold Text:
Words get bold by enclosing them in * asterisks.

*Bold*

Bold

Italic Text:
Words get italic by enclosing them in _ underscores.

_Italic_

Italic

Bold Italic:
Words get _bold italic by enclosing them in _ double-underscores.

__Bold italic__

Bold italic

Fixed Font:
Words get shown in fixed font by enclosing them in = equal signs.

=Fixed font=

Fixed font

Bold Fixed Font:
Words get shown in bold fixed font by enclosing them in double equal signs.

==Bold fixed==

Bold fixed

Note: Make sure to "stick" the * _ = == signs to the words, e.g. take away spaces.

_This works_,
_this not _

This works, _this not _

Verbatim Mode:
Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags.
Note: Use <pre> and </pre> tags instead if you want that HTML code is interpreted.
Note: Each tag must be on a line by itself.

<verbatim>
class CatAnimal {
  void purr() {
	 <code here>
  }
}
</verbatim>

class CatAnimal {
  void purr() {
    <code here>
  }
}

Separator:
At least three dashes at the beginning of a line.

-------

List Item:
Three spaces and an asterisk.

	* bullet item

bullet item

Nested List Item:
Six, nine, ... spaces and an asterisk.

		* nested stuff

- nested stuff

Ordered List:
Three spaces and a number.

	1 Sushi
	1 Dim Sum

Sushi
Dim Sum

Definition List:
Three spaces, the term, a colon, a space, followed by the definition.
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   non-breaking-space entity.

	Sushi: Japan
	Dim&nbsp;Sum: S.F.

Sushi: Japan
Dim Sum: S.F.

Table:
Optional spaces followed by the cells enclosed in vertical bars.
Note: | *bold* | cells are rendered as table headers.
Note: | spaced | cells are rendered center aligned.
Note: | spaced | cells are rendered right aligned.
Note: | 2 colspan || cells are rendered as multi-span columns.
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.

| *L* | *C* | *R* |
| A2 |  2  |  2 |
| A3 |  3  |  3 |
| multi span |||
| A4 \
  | next \
  | next |

L	C	R
A2	2	2
A3	3	3
multi span
A4	next	next

WikiWord Links:
CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically.
Note: In case you want to link to a topic in a different KoreaCmsWiki? web write Webname.TopicName.

WebNotify

Know.ReadmeFirst

ReadmeFirst?

Changed:

<
<

#SquareBrackets

>
>

Added:

>
>

Forced Links:
You can create a forced internal link by enclosing words in double square brackets.
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. [[text formatting FAQ]] links to topic TextFormattingFAQ. You can also refer to a different web and use anchors.

[[wiki syntax]] [[Main.TWiki users]]	wiki syntax Main.TWiki users
Specific Links: Create a link where you can specify the link text and the link reference separately, using nested square brackets like `[[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 `[[WebHome#MyAnchor][go home]]` and `[[http://www.yahoo.com/#somewhere][Yahoo!]]`.	[[WikiSyntax][syntax]] [[http://gnu.org][GNU]]	syntax GNU
Anchors: You can define a link reference inside a KoreaCmsWiki? 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 `[[MyTopic#MyAnchor]]` syntax. You can omit the topic name if you want to link within the same topic.	[[WebHome#NotThere]] [[#MyAnchor][Jump]] #MyAnchor To here	WebHome#NotThere Jump To here
Prevent a Link: Prevent a WikiWord from being linked by prepending it with the `<nop>` tag.	<nop>SunOS	SunOS

Using HTML

You can use just about any HTML tag without a problem - however, to keep in mind:

On collaboration pages, it's preferable NOT to use HTML, and to use TWiki shorthand instead - this keeps the text uncluttered and easy to edit.
- 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.

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 GoodStyle topic located in the current KoreaCmsWiki? 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://... and mailto:...@... are linked automatically.

Email addresses like name@domain.com are linked automatically.

[[Square bracket rules]] let you easily create non-WikiWord links.

TWiki Variables

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

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

%WEB% : The current web, is TWiki.

%TOPIC% : The current topic name, is TextFormattingRules.

%ATTACHURL% : The attachment URL of the current topic. Example usage: If you attach a file to a topic you can refer to it as %ATTACHURL%/image.gif to show the URL of the file or the image in your text.

%INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current KoreaCmsWiki? web is the default web. Example: %INCLUDE{"TWiki.TWikiWebsTable"}%

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

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. '©' is the © copyright character. You need to escape '&' to see it as it is, so write '&' instead of '&'.
  Example: Type 'This & that' to get 'This & that'.

TWiki Plugins

Plugins provide additional text formatting capabilities and can extend the functionality of KoreaCmsWiki? 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 Plugins web on TWiki.org. Currently enabled plugins on here:

SpreadSheetPlugin (2018-07-05, $Rev: 30478 (2018-07-16) $): Add spreadsheet calculation like "$SUM( $ABOVE() )" to TWiki tables and other topic text
BackupRestorePlugin (2018-07-10, $Rev: 30551 (2018-07-16) $): Administrator utility to backup, restore and upgrade a TWiki site
ColorPickerPlugin (2018-07-05, $Rev: 30442 (2018-07-16) $): Color picker, packaged for use in TWiki forms and TWiki applications
CommentPlugin (2018-07-05, $Rev: 30530 (2018-07-16) $): Quickly post comments to a page without an edit/preview/save cycle
DatePickerPlugin (2018-07-05, $Rev: 30446 (2018-07-16) $): Pop-up calendar with date picker, for use in TWiki forms, HTML forms and TWiki plugins
EditTablePlugin (2018-07-05, $Rev: 30448 (2018-07-16) $): Edit TWiki tables using edit fields, date pickers and drop down boxes
HeadlinesPlugin (2018-07-13, $Rev: 30560 (2018-07-16) $): Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites
InterwikiPlugin (2018-07-05, $Rev: 30454 (2018-07-16) $): Write ExternalSite:Page to link to a page on an external site based on aliases defined in a rules topic
JQueryPlugin (2018-07-05, $Rev: 30456 (2018-07-16) $): jQuery JavaScript library for TWiki
PreferencesPlugin (2018-07-05, $Rev: 30528 (2018-07-16) $): Allows editing of preferences using fields predefined in a form
SetGetPlugin (2018-07-05, $Rev: 30472 (2018-07-16) $): Set and get variables and JSON objects in topics, optionally persistently across topic views
SlideShowPlugin (2018-07-05, $Rev: 30474 (2018-07-16) $): Create web based presentations based on topics with headings.
SmiliesPlugin (2018-07-05, $Rev: 30476 (2018-07-16) $): Render smilies as icons, like for :-) or for :eek:
TWikiSheetPlugin (2018-07-15, $Rev: 30604 (2018-07-16) $): Add TWiki Sheet spreadsheet functionality to TWiki tables
TablePlugin (2018-07-05, $Rev: 30480 (2018-07-16) $): Control attributes of tables and sorting of table columns
TagMePlugin (2018-07-05, $Rev: 30482 (2018-07-16) $): Tag wiki content collectively or authoritatively to find content by keywords
TinyMCEPlugin (2018-07-10, $Rev: 30541 (2018-07-16) $): Integration of the Tiny MCE WYSIWYG Editor
TwistyPlugin (2018-07-06, $Rev: 30497 (2018-07-16) $): Twisty section JavaScript library to open/close content dynamically
WatchlistPlugin (2018-07-10, $Rev: 30536 (2018-07-16) $): Watch topics of interest and get notified of changes by e-mail
WysiwygPlugin (2018-07-06, $Rev: 30528 (2018-07-16) $): Translator framework for WYSIWYG editors

Check on current Plugin status and settings for this site in TWikiPreferences.

-- MikeMannix? - 30 Aug 2001

Revision 262001-09-07 - MikeMannix?

TWiki Text Formatting

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.

Added:

>
>

TWiki Editing Shorthand

Formatting Command: Example: You write: You get:

Paragraphs:
Blank lines will create new paragraphs.

1st paragraph

2nd paragraph

1st paragraph

2nd paragraph

Headings:
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 %TOC% variable, see TWikiVariables.

---++ Sushi

---+++ Maguro

Sushi

Maguro

Bold Text:
Words get bold by enclosing them in * asterisks.

*Bold*

Bold

Italic Text:
Words get italic by enclosing them in _ underscores.

_Italic_

Italic

Bold Italic:
Words get _bold italic by enclosing them in _ double-underscores.

__Bold italic__

Bold italic

Fixed Font:
Words get shown in fixed font by enclosing them in = equal signs.

=Fixed font=

Fixed font

Bold Fixed Font:
Words get shown in bold fixed font by enclosing them in double equal signs.

==Bold fixed==

Bold fixed

Note: Make sure to "stick" the * _ = == signs to the words, e.g. take away spaces.

_This works_,
_this not _

This works, _this not _

Verbatim Mode:
Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags.
Note: Use <pre> and </pre> tags instead if you want that HTML code is interpreted.
Note: Each tag must be on a line by itself.

<verbatim>
class CatAnimal {
  void purr() {
	 <code here>
  }
}
</verbatim>

class CatAnimal {
  void purr() {
    <code here>
  }
}

Separator:
At least three dashes at the beginning of a line.

-------

List Item:
Three spaces and an asterisk.

	* bullet item

bullet item

Nested List Item:
Six, nine, ... spaces and an asterisk.

		* nested stuff

- nested stuff

Ordered List:
Three spaces and a number.

	1 Sushi
	1 Dim Sum

Sushi
Dim Sum

Definition List:
Three spaces, the term, a colon, a space, followed by the definition.
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   non-breaking-space entity.

	Sushi: Japan
	Dim&nbsp;Sum: S.F.

Sushi: Japan
Dim Sum: S.F.

Table:
Optional spaces followed by the cells enclosed in vertical bars.
Note: | *bold* | cells are rendered as table headers.
Note: | spaced | cells are rendered center aligned.
Note: | spaced | cells are rendered right aligned.
Note: | 2 colspan || cells are rendered as multi-span columns.
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.

| *L* | *C* | *R* |
| A2 |  2  |  2 |
| A3 |  3  |  3 |
| multi span |||
| A4 \
  | next \
  | next |

L	C	R
A2	2	2
A3	3	3
multi span
A4	next	next

WikiWord Links:
CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically.
Note: In case you want to link to a topic in a different KoreaCmsWiki? web write Webname.TopicName.

WebNotify

Know.ReadmeFirst