Difference: TextFormattingRules (28 vs. 29)

Revision 292001-12-02 - 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, 15269): Add spreadsheet calculation like "$SUM( $ABOVE() )" to TWiki tables and other topic text
  • BackupRestorePlugin (2013-02-16, $Rev: 25107 (2013-02-16) $): Administrator utility to backup, restore and upgrade a TWiki site
  • ColorPickerPlugin (2013-02-15, $Rev: 25075 (2013-02-16) $): Color picker, packaged for use in TWiki forms and TWiki applications
  • HeadlinesPlugin (2013-02-16, $Rev: 25105 (2013-02-16) $): Show headline news in TWiki pages based on RSS and ATOM news feeds from external sites
  • JQueryPlugin (2013-01-28, $Rev: 24817 (2013-02-16) $): jQuery JavaScript library for TWiki
  • SetGetPlugin (2013-01-28, $Rev: 24823 (2013-02-16) $): Set and get variables in topics, optionally persistently across topic views
  • TWikiNetSkinPlugin: (disabled)
  • TablePlugin (1.036, 17558): Control attributes of tables and sorting of table columns
  • TagMePlugin (TWiki 4, 1.049): Tag wiki content collectively to find content by keywords
  • TwistyPlugin (1.4.12, $Rev: 15653 (19 Nov 2007) $): Twisty section JavaScript library to open/close content dynamically

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

Changed:
<
<
-- MikeMannix - 02 Oct 2001
>
>
-- MikeMannix - 02 Dec 2001
 
Copyright © 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.