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.

Editing

1st paragraph

2nd paragraph

---++ Sushi

---+++ Maguro

*Bold*

_Italic_

__Bold italic__

=Fixed font=

==Bold fixed==

_This works_,
_this not _

<verbatim>
class CatAnimal {
  void purr() {
    <code here>
  }
}
</verbatim>

class CatAnimal {
  void purr() {
    <code here>
  }
}

-------

   * bullet item

      * nested stuff

   1 Sushi
   1 Dim Sum

   Sushi: Japan
   Dim Sum: S.F.

| *L* | *C* | *R* |
| A2 |  2  |  2 |
| A3 |  3  |  3 |
| multi span |||
| A4 \  | next \  | next |

WebNotify

Know.ReadmeFirst

[[wiki syntax]]

[[Main.TWiki users]]

[[WikiSyntax][syntax]]

[[http://gnu.org][GNU]]

[[WebHome#NotThere]]

[[#MyAnchor][Jump]]

#MyAnchor To here

<nop>SunOS

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.

Hyperlinks

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.

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

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

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'.

• See more TextFormattingFAQs

TWiki Plugins

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:

• SpreadSheetPlugin (any TWiki, 10197): Add spreadsheet calculation like "$SUM( $ABOVE() )" to tables located in TWiki topics.
• CommentPlugin (Dakar, 8164): Allows users to quickly post comments to a page without an edit/preview/save cycle.
• EditTablePlugin (Dakar, 8154): Edit TWiki tables using edit fields, date pickers and drop down boxes
• InterwikiPlugin (Dakar, $Rev: 8329$): Link ExternalSite:Page text to external sites based on aliases defined in a rules topic
• PreferencesPlugin (Dakar, 9839): Allows editing of preferences using fields predefined in a form
• SlideShowPlugin (Dakar, $Rev: 8154$): Create web based presentations based on topics with headings.
• SmiliesPlugin (Dakar, 8154): Render smilies as icons, like  :-) for or  :cool: for :cool:
• TablePlugin (Dakar, 8154): Control attributes of tables and sorting of table columns

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

-- MikeMannix^? - 30 Aug 2001