Difference: TextFormattingRules (32 vs. 33)

Revision 332002-05-02 - PeterThoeny

Line: 1 to 1
 

TWiki Text Formatting

Line: 413 to 413
 
    • 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.
Added:
>
>

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.SiteMap"}%

  • TWikiPreferences defines site-wide variables like colors. For example, write: %RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors to get: Red and blue colors.
 

TWikiPlugin Formatting Extensions

Line: 424 to 442
  Check on current Plugin status and settings for this site in TWikiPreferences.
Deleted:
<
<
-- MikeMannix? - 02 Dec 2001
 
Changed:
<
<
Updated to cover TWiki:Codev/EasierExternalLinking (in the alpha release).
>
>

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:

 
Changed:
<
<
-- RichardDonkin? - 26 Mar 2002
>
>
  • 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>'.
 
Changed:
<
<
Latest updates to this topic are in the main TWiki, since that's got the TWikiAlphaRelease code.
>
>
  • 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'.
 
Changed:
<
<
-- RichardDonkin? - 05 Apr 2002
>
>
-- MikeMannix? - 02 Dec 2001
-- PeterThoeny? - 02 May 2002
 
This site is powered by the TWiki collaboration platformCopyright © 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