Welcome, Registration, and other StartingPoints; TWiki history & Wiki style; All the docs...
View   r29  >  r28  >  r27  >  r26  >  r25  >  r24  ...
TextFormattingRules 29 - 02 Dec 2001 - Main.MikeMannix
Line: 1 to 1
 
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.

Line: 289 to 289
 
Changed:
<
<
>
>
#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.
Line: 390 to 389
 
Changed:
<
<

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 TWiki web is the default web. Example: %INCLUDE{"TWiki.TWikiWebsTable"}%

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, ex: '&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'.
>
>

TWikiPlugin Formatting Extensions

 
Changed:
<
<

TWiki Plugins

>
>
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.
 
Changed:
<
<
Plugins provide additional text formatting capabilities and can extend the functionality of TWiki 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:
>
>
Available Plugins are located in the Plugins web on TWiki.org. Currently enabled plugins on this TWiki installation, as listed by %PLUGINDESCRIPTIONS%:
 
  • SpreadSheetPlugin (any TWiki, 10197): Add spreadsheet calculation like "$SUM( $ABOVE() )" to TWiki tables and other topic text
  • ActionTrackerPlugin (21 May 2007, $Rev: 14969 (20 Sep 2007) $): Adds support for action tags in topics, and automatic notification of action statuses
  • AttachmentListPlugin (1.0.1, $Rev: 15921 (07 Dec 2007) $): Displays a formattable list of topic attachments, anywhere in a topic.
  • BreadCrumbsPlugin (v1.00, $Rev: 13657 (08 May 2007) $): A flexible way to display breadcrumbs navigation
  • CalendarPlugin (Dakar, 9113): Show a monthly calendar with highlighted events
  • CommentPlugin (Dakar, 11359): Allows users to quickly post comments to a page without an edit/preview/save cycle
  • CompareRevisionsAddonPlugin (Dakar, $Rev: 9808$):
  • EditTablePlugin (any TWiki, 11646): Edit TWiki tables using edit fields, date pickers and drop down boxes
  • FilterPlugin (1.40, $Rev: 15932 (07 Dec 2007) $): Substitute and extract information from content by using regular expressions
  • FlexWebListPlugin (v1.21, $Rev: 16132 (03 Jan 2008) $): Flexible way to display hierarchical weblists
  • FootNotePlugin (2.006): Footnotes are notes placed at the end of a topic.
  • GluePlugin (2.00, $Rev: 15708 (23 Nov 2007) $): Enable markup to span multiple lines
  • IfDefinedPlugin (v1.01, $Rev: 15157 (05 Oct 2007) $): Render content conditionally
  • InterwikiPlugin (Dakar, $Rev: 11935$): Link ExternalSite:Page text to external sites based on aliases defined in a rules topic
  • JQueryPlugin (v0.4, $Rev: 15608 (15 Nov 2007) $): jQuery JavaScript library for TWiki
  • NatSkinPlugin (3.00-pre17, $Rev: 15581 (13 Nov 2007) $): Supplements the bare bones NatSkin theme for TWiki
  • PreferencesPlugin (Dakar, 9839): Allows editing of preferences using fields predefined in a form
  • RedDotPlugin (1.40, $Rev: 16137 (03 Jan 2008) $): Renders edit-links as little red dots
  • RenderListPlugin (any TWiki, 1.034): Render bullet lists in a variety of formats
  • SlideShowPlugin (Any TWiki, $Rev: 12847$): Create web based presentations based on topics with headings.
  • SmiliesPlugin (Dakar, 8154): Render smilies as icons, like smile for  :-) or eek! for = :eek:=
  • TablePlugin (1.020, 12339): Control attributes of tables and sorting of table columns
  • TreeBrowserPlugin (v1.8): Renders a list as a collapsable/expandable tree.
  • TreePlugin (1.7): Dynamic generation of TWiki topic trees
  • TwistyPlugin (1.2.0, $Rev: 12154$): Twisty section JavaScript library to open/close content dynamically
  • VotePlugin (1.33, $Rev: 14312 (01 Jul 2007) $): Simple way to count votes
  • WysiwygPlugin (Dakar, 12422): 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

TextFormattingRules 28 - 02 Oct 2001 - Main.MikeMannix
Line: 1 to 1
 
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.

Line: 414 to 414
 
    • 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?
Changed:
<
<
    • 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'.
>
>
    • A: The '&' character has a special meaning in HTML, it starts a so called character entity, ex: '&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 Plugins

Line: 424 to 424
 Check on current Plugin status and settings for this site in TWikiPreferences.
Changed:
<
<
-- MikeMannix? - 30 Aug 2001
>
>
-- MikeMannix? - 02 Oct 2001

TextFormattingRules 27 - 18 Sep 2001 - Main.MikeMannix
Line: 1 to 1
 

TWiki Text Formatting

Line: 289 to 289
 
Changed:
<
<
#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.

TextFormattingRules 26 - 07 Sep 2001 - Main.MikeMannix
Line: 1 to 1
 

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

Line: 288 to 289
 
Changed:
<
<
>
>
#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.
Line: 365 to 366
 

Using HTML

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

Changed:
<
<
Being able to create links without any formatting required is a core TWiki feature, made possible using WikiNames. With the latest version of TWiki linking rules, a simple extension of the syntax provides an new set of flexible linking options.
>
>
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 TWiki web.
Changed:
<
<
  • 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!)
>
>
  • 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

Line: 379 to 384
 

External Links

  • http://..., https://..., ftp://... and mailto:...@... are linked automatically.
Added:
>
>
 
  • Email addresses like name@domain.com are linked automatically.
Added:
>
>
 

TWiki Variables

Changed:
<
<
Variables are names that are enclosed in percent signs; they get expanded on the fly.
>
>
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.
 
Deleted:
<
<
  • %TOC% : The table of content, is based on headings in a topic.
 
  • %WEB% : The current web, is TWiki .
Added:
>
>
 
  • %TOPIC% : The current topic name, is TextFormattingRules .
Added:
>
>
 
  • %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.
Deleted:
<
<
  • %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.
 
Changed:
<
<

"Gotchas" when Editing Text

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

 
Changed:
<
<
The formatting rules are fairly simple to use and fast to type. However, there are some things to watch out for:
>
>

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>'.
Line: 403 to 415
 
  • 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'.
Deleted:
<
<
 

TWiki Plugins

Changed:
<
<
Plugins provide additional text formatting rules and can extend the functionality of TWiki into many other areas. Available Plugins are located in the Plugins web. Currently enabled plugins on this site are:
>
>
Plugins provide additional text formatting capabilities and can extend the functionality of TWiki 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 (any TWiki, 10197): Add spreadsheet calculation like "$SUM( $ABOVE() )" to TWiki tables and other topic text
  • ActionTrackerPlugin (21 May 2007, $Rev: 14969 (20 Sep 2007) $): Adds support for action tags in topics, and automatic notification of action statuses
  • AttachmentListPlugin (1.0.1, $Rev: 15921 (07 Dec 2007) $): Displays a formattable list of topic attachments, anywhere in a topic.
  • BreadCrumbsPlugin (v1.00, $Rev: 13657 (08 May 2007) $): A flexible way to display breadcrumbs navigation
  • CalendarPlugin (Dakar, 9113): Show a monthly calendar with highlighted events
  • CommentPlugin (Dakar, 11359): Allows users to quickly post comments to a page without an edit/preview/save cycle
  • CompareRevisionsAddonPlugin (Dakar, $Rev: 9808$):
  • EditTablePlugin (any TWiki, 11646): Edit TWiki tables using edit fields, date pickers and drop down boxes
  • FilterPlugin (1.40, $Rev: 15932 (07 Dec 2007) $): Substitute and extract information from content by using regular expressions
  • FlexWebListPlugin (v1.21, $Rev: 16132 (03 Jan 2008) $): Flexible way to display hierarchical weblists
  • FootNotePlugin (2.006): Footnotes are notes placed at the end of a topic.
  • GluePlugin (2.00, $Rev: 15708 (23 Nov 2007) $): Enable markup to span multiple lines
  • IfDefinedPlugin (v1.01, $Rev: 15157 (05 Oct 2007) $): Render content conditionally
  • InterwikiPlugin (Dakar, $Rev: 11935$): Link ExternalSite:Page text to external sites based on aliases defined in a rules topic
  • JQueryPlugin (v0.4, $Rev: 15608 (15 Nov 2007) $): jQuery JavaScript library for TWiki
  • NatSkinPlugin (3.00-pre17, $Rev: 15581 (13 Nov 2007) $): Supplements the bare bones NatSkin theme for TWiki
  • PreferencesPlugin (Dakar, 9839): Allows editing of preferences using fields predefined in a form
  • RedDotPlugin (1.40, $Rev: 16137 (03 Jan 2008) $): Renders edit-links as little red dots
  • RenderListPlugin (any TWiki, 1.034): Render bullet lists in a variety of formats
  • SlideShowPlugin (Any TWiki, $Rev: 12847$): Create web based presentations based on topics with headings.
  • SmiliesPlugin (Dakar, 8154): Render smilies as icons, like smile for  :-) or eek! for = :eek:=
  • TablePlugin (1.020, 12339): Control attributes of tables and sorting of table columns
  • TreeBrowserPlugin (v1.8): Renders a list as a collapsable/expandable tree.
  • TreePlugin (1.7): Dynamic generation of TWiki topic trees
  • TwistyPlugin (1.2.0, $Rev: 12154$): Twisty section JavaScript library to open/close content dynamically
  • VotePlugin (1.33, $Rev: 14312 (01 Jul 2007) $): Simple way to count votes
  • WysiwygPlugin (Dakar, 12422): Translator framework for Wysiwyg editors

TextFormattingRules 25 - 06 Sep 2001 - Main.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.

Revision 29r29 - 02 Dec 2001 - 08:07:19 - MikeMannix?
Revision 28r28 - 02 Oct 2001 - 07:37:03 - MikeMannix?
Revision 27r27 - 18 Sep 2001 - 00:12:46 - MikeMannix?
Revision 26r26 - 07 Sep 2001 - 05:05:03 - MikeMannix?
Revision 25r25 - 06 Sep 2001 - 08:50:20 - MikeMannix?
Revision 24r24 - 06 Sep 2001 - 07:49:13 - MikeMannix?
This site is powered by the TWiki collaboration platform.
All material on this collaboration platform is the property of the contributing authors.
All material marked as authored by Eben Moglen is available under the license terms CC-BY-SA version 4.
Syndicate this site RSSATOM