| | |
|
TextFormattingRules 18 - 2001-06-28 - PeterThoeny
|
| | It is easy to collaborate; just type your text. You don't need to know HTML at all, though you can use it if you prefer. Links to topics will be created automatically, as long as you follow these simple Text Formatting Rules. TextFormattingFAQ has answers to frequently asked questions about text formatting. | |
<
< | LINKS | >
> |
Links | | |
The Collaborative Work Area is a bunch of related links that are editable through your web browser. | |
<
< | The TWiki web has the following types of internal links: | >
> | TWiki Internal Links | | |
- GoodStyle is a WikiWord that links to the GoodStyle topic located in the current TWiki web.
- NotExistingYet is a topic waiting to be written. You could create that topic by clicking on the question mark. (Do not create that topic; you would wreck this example!)
| |
<
< | External links: | >
> | External Links | | |
-
http://..., https://..., ftp://... and mailto:...@... are linked automatically.
- Email addresses like
name@domain.com are linked automatically.
| |
<
< | EDITING | >
> | Editing | | |
| | | | |
<
< | Sushi | >
> | ---++ Sushi | | | | |
<
< | Maguro | >
> | ---+++ Maguro | | | | |
<
< | Sushi | >
> | Sushi | | | | |
<
< | Maguro | >
> | Maguro | | | | | | | |
<
< | HTML | >
> | Using HTML | | |
Most HTML tags will work, but it's almost always preferable not to use HTML, so that the markup remains easy for everyone to edit. | |
<
< | | >
> | | | | | |
<
< | WIKI VARIABLES | >
> | TWiki Variables | | |
Variables are names that are enclosed in percent signs; they get expanded on the fly. | |
>
> |
-
%TOC% : The table of content, is based on headings in a topic.
| | |
-
%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 TWiki web is the default web. Example: %INCLUDE{"TWiki.TWikiWebsTable"}%
- There are many more variables, see TWikiVariables.
| |
>
> | "Gotchas" when Editing Text
The formatting rules are fairly simple to use and fast to type. However, there are some things to watch out for:
- 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 | >
> | TWiki Plugins | | |
TWiki Plugins offer additional text formatting rules. Plugins currently installed are: |
|
|
TextFormattingRules 17 - 2001-04-05 - PeterThoeny
|
| |
Table:
Optional spaces followed by the cells enclosed in vertical bars.
|
| |
<
< | 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. | >
> | 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.
| | | | |
<
< |
| A3 \ | >
> |
| A4 \ | | | | next \
| | |
<
< |
| A3 | >
> |
| L |
C |
R |
| A2 |
2 |
2 |
| A3 |
3 |
3 |
| multi span |
| A4 | | |
|
|
|
TextFormattingRules 16 - 2001-03-16 - PeterThoeny
|
| | It is easy to collaborate; just type your text. You don't need to know HTML at all, though you can use it if you prefer. Links to topics will be created automatically, as long as you follow these simple Text Formatting Rules. TextFormattingFAQ has answers to frequently asked questions about text formatting. | |
<
< | LINKS | >
> | LINKS | | |
The Collaborative Work Area is a bunch of related links that are editable through your web browser. | | |
- GoodStyle is a WikiWord that links to the GoodStyle topic located in the current TWiki web.
- NotExistingYet is a topic waiting to be written. You could create that topic by clicking on the question mark. (Do not create that topic; you would wreck this example!)
| |
<
< | External links: | >
> | External links: | | |
-
http://..., https://..., ftp://... and mailto:...@... are linked automatically.
- Email addresses like
name@domain.com are linked automatically.
| |
<
< | EDITING | >
> |
EDITING | | |
| | | | |
<
< | HTML | >
> | HTML | | |
Most HTML tags will work, but it's almost always preferable not to use HTML, so that the markup remains easy for everyone to edit.
| |
<
< | WIKI VARIABLES | >
> |
WIKI VARIABLES | | |
Variables are names that are enclosed in percent signs; they get expanded on the fly. | | |
-
%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 TWiki web is the default web. Example: %INCLUDE{"TWiki.TWikiWebsTable"}%
- There are many more variables, see TWikiVariables.
| |
>
> |
TWiki PLUGINS
TWiki Plugins offer additional text formatting rules. Plugins currently installed are:
- DefaultPlugin : The default plugin is used for some depreciated rendering of older TWiki versions.
-
Learn more about plugins in TWikiPlugins and TWikiPreferences. |
|
|
TextFormattingRules 15 - 2001-03-02 - PeterThoeny
|
| | | |
>
> | 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.
| | | | | |
<
< | At least four dashes at the beginning of a line. | >
> | At least three dashes at the beginning of a line. | | | | | | | |
<
< | Create a link where you can specify the link text and the link reference separately, using nested square brackets like [[text][reference]]. Internal link references (i.e. WikiSyntax) and external link references (i.e. http://TWiki.org/) are supported. The same Forced Links rules apply for internal link references. Anchor names can be added as well, like [[go home][WebHome@MyAnchor]] and [[Yahoo!][http://www.yahoo.com/#somewhere]]. | >
> | 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 | | | | |
<
< | WikiSyntax | >
> | syntax | | | | |
<
< | http://gnu.org | >
> | GNU | | | | |
<
< | 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. | >
> | 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. | | | | |
<
< | WebHome@NotThere | >
> | WebHome#NotThere | | | | |
<
< | @MyAnchor | >
> | Jump | | | | |
<
< | @MyAnchor To here | >
> | To here | | | | |
<
< | WebHome@NotThere | >
> | WebHome#NotThere | | | | |
<
< | @MyAnchor | >
> | Jump | | | | |
<
< | @MyAnchor To here | >
> | To here | | | |
|
|
|
|
 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
|
|
| | |
