Difference: TextFormattingRules (24 vs. 25)

Revision 252001-09-06 - MikeMannix

Line: 1 to 1
 
Changed:
<
<
It is easy to collaborate: just type in your text. You don't need to know HTML at all, though you can use it if you prefer. Links to topics will be created automatically, as long as you follow these simple Text Formatting Rules. TextFormattingFAQ has answers to frequently asked questions about text formatting. This page is also available as quick reference pop-up window from a link in the Edit screen.
>
>

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

Editing

>
>

TWiki Editing Shorthand

 
Changed:
<
<
>
>
 
Formatting Command:
Line: 17 to 16
 You get:
Changed:
<
<
>
>
 
Paragraphs:
Blank lines will create new paragraphs.
Line: 35 to 34
 2nd paragraph
Changed:
<
<
>
>
 
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.
Line: 53 to 52
 

Maguro

Changed:
<
<
>
>
 
Bold Text:
Words get bold by enclosing them in * asterisks.
Line: 67 to 66
 Bold
Changed:
<
<
>
>
 
Italic Text:
Words get italic by enclosing them in _ underscores.
Line: 81 to 80
 Italic
Changed:
<
<
>
>
 
Bold Italic:
Words get _bold italic by enclosing them in _ double-underscores.
Line: 95 to 94
 Bold italic
Changed:
<
<
>
>
 
Fixed Font:
Words get shown in fixed font by enclosing them in = equal signs.
Line: 109 to 108
 Fixed font
Changed:
<
<
>
>
 
Bold Fixed Font:
Words get shown in bold fixed font by enclosing them in double equal signs.
Line: 123 to 122
 Bold fixed
Changed:
<
<
>
>
 
Note: Make sure to "stick" the * _ = == signs to the words, e.g. take away spaces.
Line: 138 to 137
 _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.
Line: 164 to 163
 
Changed:
<
<
>
>
 
Separator:
At least three dashes at the beginning of a line.
Line: 178 to 177
 
Changed:
<
<
>
>
 
List Item:
Three spaces and an asterisk.
Line: 192 to 191
 
  • bullet item
Changed:
<
<
>
>
 
Nested List Item:
Six, nine, ... spaces and an asterisk.
Line: 206 to 205
 
    • nested stuff
Changed:
<
<
>
>
 
Ordered List:
Three spaces and a number.
Line: 222 to 221
 
  1. Dim Sum
Changed:
<
<
>
>
 
Definition List:
Three spaces, the term, a colon, a space, followed by the definition.
Line: 239 to 238
 
Dim Sum
S.F.
Changed:
<
<
>
>
 
Table:
Optional spaces followed by the cells enclosed in vertical bars.
Line: 270 to 269
 
next
Changed:
<
<
>
>
 
WikiWord Links:
CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically.
Note: In case you want to link to a topic in a different TWiki web write Webname.TopicName.
Line: 288 to 287
 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.
Line: 306 to 305
 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!]].
Line: 324 to 323
 GNU
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.
Line: 346 to 345
  To here
Changed:
<
<
>
>
 
Prevent a Link:
Prevent a WikiWord from being linked by prepending it with the <nop> tag.
 
This site is powered by the TWiki collaboration platform Powered by PerlCopyright & 1999-2020 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.