Difference: TextFormattingRules (47 vs. 48)

Revision 4827 Mar 2005 - Main.TWikiContributor

Line: 1 to 1

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

Changed:

<
<

>
>

Changed:

<
<

Formatting Command:

Example: You write:

You get:

>
>

Formatting Command:	You write:	You get:

Changed:

<
<

>
>

Paragraphs:
Blank lines will create new paragraphs.

Changed:

<
<

>
>

1st paragraph

2nd paragraph

Changed:

<
<

>
>

1st paragraph

2nd paragraph

Changed:

<
<

>
>

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

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

Changed:

<
<

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

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

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

Sushi

Maguro

Not in TOC

Changed:

<
<

>
>

Bold Text:

Changed:

<
<

Words get bold by enclosing them in * asterisks.

>
>

Words get shown in bold by enclosing them in * asterisks.

Bold

Changed:

<
<

>
>

Bold

Changed:

<
<

>
>

Italic Text:

Changed:

<
<

Words get italic by enclosing them in _ underscores.

>
>

Words get shown in italic by enclosing them in _ underscores.

Italic

Changed:

<
<

>
>

Italic

Changed:

<
<

>
>

Bold Italic:

Changed:

<
<

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

>
>

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

Bold italic

Changed:

<
<

>
>

Bold italic

Changed:

<
<

>
>

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

Changed:

<
<

>
>

Fixed font

Changed:

<
<

>
>

Fixed font

Changed:

<
<

>
>

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

Changed:

<
<

>
>

Bold fixed

Changed:

<
<

>
>

Bold fixed

Changed:

<
<

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.

This works,

Changed:

<
<

_this not _

>
>

_this does not _

This works,

Changed:

<
< _this not _

>
> _this does 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>

>
>

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></verbatim>
<nop>

class CatAnimal^? { void purr() {

Changed:

<
< <code here>

>
>

} }

Changed:

<
<

</verbatim>

>
>

class CatAnimal {
  void purr() {

Line: 166 to 160

Changed:

<
<

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

Changed:

<
<

>
>

Changed:

<
<

List Item: Three spaces, an asterisk, and another space.	* bullet item	bullet item
Nested List Item: Six, nine, ... 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.

level 1
- level 2

Changed:

<
<

>
>

back on 1
A bullet broken over three lines
last bullet

level 1
- level 2

Added:

>
>

back on 1
A bullet broken over three lines
last bullet

Changed:

<
<

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:

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

Added:

>
>

Fondue

Sushi
Dim Sum

Added:

>
>

Fondue

Sushi
Dim Sum

Changed:

<
<

>
>

Fondue

Sushi
Dim Sum

Added:

>
>

Fondue

Sushi
Dim Sum

Added:

>
>

Fondue

Sushi
Dim Sum

Added:

>
>

Fondue

Changed:

<
<

>
>

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

Changed:

<
<

>
>

Sushi: Japan
Dim Sum: S.F.

Changed:

<
<

>
>

Sushi: Japan
Dim Sum: S.F.

Changed:

<
<

>
>

Table:

Changed:

<
<

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

Changed:

<
<

A2	2	2
A3	3	3

>
>

A2	B2	C2
A3	B3	C3

multi span

Changed:

<
<

A4-6	four	four
A4-6	five	five

>
>

A5-7

six

Changed:

<
<

>
>

seven	seven
split	over	3 lines
A9	B9	C9

L	C	R

Changed:

<
<

A2	2	2
A3	3	3

>
>

A2	B2	C2
A3	B3	C3

multi span

Changed:

<
<

A4-6	four	four
A4-6	five	five

>
>

A5-7

six

Added:

>
>

seven	seven
split	over	3 lines
A9	B9	C9

Changed:

<
<

>
>

WikiWord Links:

Changed:

<
<

CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically.
Note: In case you want to link to a topic in a different TWiki 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

>
>

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

Changed:

<
< TWikiUsers

>
>

Changed:

<
<

>
>

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

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

Changed:

<
<

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

Changed:

<
< Main.TWiki users

>
> Main.TWiki users

escaped: [[wiki syntax]]

Changed:

<
<

>
>

wiki syntax

Main.TWiki users

Line: 343 to 360

[[wiki syntax]]

Changed:

<
<

>
>

Specific Links:

Changed:

<
<

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

>
>

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

GNU

Changed:

<
<

>
>

Deleted:

<
< XML

Changed:

<
<

Anchors:
You can define a link 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

>
>

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

Changed:

<
<

>
>

SunOS

Changed:

<
<

>
>

SunOS

Changed:

<
<

>
>

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.

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

 <noautolink>
 RedHat &
 SuSE
 </noautolink>

Changed:

<
<

>
>

RedHat & SuSE

Changed:

<
<

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

>
>

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

Changed:

<
< Hi

>
>

Mail

a@b.com

Mail

Using HTML

Changed:

<
<

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

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

Changed:

<
<

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.

>
>

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.

Added:

>
>

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.

Changed:

<
<

TWiki HTML Rendering

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

Changed:

<
<

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.

>
>

Script tags

Changed:

<
<

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>

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

Changed:

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

Changed:

<
<

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

Line: 494 to 471

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

Changed:

<
<

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.

Line: 499 to 476

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

Deleted:

<
<

TWiki Variables

Changed:

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

Changed:

<
<

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

Changed:

<
<

%INCLUDE{"SomeTopic"}% : Server side include, includes another topic. The current TWiki 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"}%

Changed:

<
<

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

Changed:

<
<

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.

Changed:

<
<

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

Changed:

<
<

Plugins provide additional text formatting capabilities and can extend the functionality of TWiki 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%:

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

Added:

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

SpreadSheetPlugin (any TWiki, 10197): Add spreadsheet calculation like "$SUM( $ABOVE() )" to tables located in TWiki topics.
CommentPlugin (Dakar, 8164): Allows users to quickly post comments to a page without an edit/preview/save cycle.
EditTablePlugin (Dakar, 8154): Edit TWiki tables using edit fields, date pickers and drop down boxes
InterwikiPlugin (Dakar, $Rev: 8329$): Link ExternalSite:Page text to external sites based on aliases defined in a rules topic
PreferencesPlugin (Dakar, 9839): Allows editing of preferences using fields predefined in a form
SlideShowPlugin (Dakar, $Rev: 8154$): Create web based presentations based on topics with headings.
SmiliesPlugin (Dakar, 8154): Render smilies as icons, like :-) for or :cool: for :cool:
TablePlugin (Dakar, 8154): Control attributes of tables and sorting of table columns

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

Line: 546 to 520

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:

<
< -- TWiki:Main.MikeMannix - 02 Dec 2001
-- TWiki:Main.PeterThoeny - 01 Aug 2004

>
>

View topic | History: r49 < r48 < r47 < r46 | More topic actions...

Copyright © by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.TextFormattingRules