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 laid out below - refer back to this page in a pop-up window from the Edit screen.

TWiki Editing Shorthand

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

   * level 1
      * level 2

   1. Sushi
   1. Dim Sum

   A. Sushi
   A. Dim Sum

   i. Sushi
   i. Dim Sum

   $ Sushi: Japan
   $ Dim Sum: S.F.

| *L* | *C* | *R* |
| A2 |  2  |  2 |
| A3 |  3  |  3 |
| multi span |||
| A4-6 | four | four |
|^| five | five |



|^| six | six |

WebNotify

Main.TWikiUsers

[[wiki syntax]]

[[Main.TWiki users]]

escaped:
![[wiki syntax]]

[[WikiSyntax][syntax]]

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

[[http://xml.org XML]]

[[WikiWord#NotThere]]

[[#MyAnchor][Jump]]

#MyAnchor To here

!SunOS

 <noautolink>
 RedHat &
 SuSE
 </noautolink>

[[mailto:a@z.com Mail]]

[[mailto:?subject=Hi Hi]]

Using HTML

You can use just about any HTML tag without a problem - however, there are a few usability and technical considerations to keep in mind.

HTML and TWiki Usability

• TIP: 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 is designed to work with a wide range of browsers and computer platforms, holding to HTML 4.0 and XHTML 1.0 compatibility in the standard installation - adding raw HTML, particularly browser-specific tags (or any other mark-up that doesn't degrade well) will reduce compatibility.
• Recommondations when using HTML:
  • Use XHTML 1.0 Transitional syntax
  • Do not span a tag over more then one line
  • Remove all empty lines. TWiki inserts <p /> paragraph tags on empty lines, which causes problems if done between tags that do not allow paragraph tags, like for example between table tags.

TWiki HTML Rendering

• 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.
  • If you need to save HTML frequently, you may want to check out TWiki:Plugins/GenHTMLAddon - it will "generate a directory containing rendered versions of a set of TWiki pages together with any attached files."
• NOTE: The opening and closing angle brackets - <...> - of an HTML tag must be on the same line, or the tag will be broken.
  • This feature allows you to enter an unclosed angle bracket - as a greater than or less than symbol - and have it automatically rendered as if you had entered its HTML character, <, ex: a < b
  • If you're pasting in preformatted HTML text and notice problems, check the file in a text processor with no text wrap. Also, save without hard line breaks on text wrap, in your HTML editing program.

TWiki and JavaScript

You can use JavaScript for your TWiki applications. Since TWiki rendering might interfere with JavaScript code you need to escape it with HTML comments and <pre> tags:

<script language="JavaScript">
<!-- Hide JavaScript and <pre> escape TWiki rendering
... put your JavaScript code here...
// Stop hiding and stop </pre> escaping TWiki rendering -->
</script>

Hyperlinks

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.

• 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

• http://..., https://..., ftp://..., gopher://..., news://..., file://..., telnet://... and mailto:...@... are linked automatically.

• Email addresses like name@domain.com are linked automatically.

• [[Square bracket rules]] let you easily create non-WikiWord links.
  • 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.

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

• %SEARCH{"sushi"}% : Inline search showing the search result embedded in a topic. FormattedSearch gives you control over formatting, used to create web-based applications.

• TWikiPreferences defines site-wide variables. Among others:
  • Line break: Write %BR% to start a new line.
  • Colored text: Write: %RED% Red %ENDCOLOR% and %BLUE% blue %ENDCOLOR% colors to get: Red and blue colors.
  • Documentation Graphics: Write: %H% Help, %T% Tip, %X% Alert to get: Help, Tip, Alert. For more info see TWikiDocGraphics.

• There are many more variables, see TWikiVariables.

• To "escape" a variable, prefix it with an exclamation point. Write: !%SOMEVARIABLE% to get: %SOMEVARIABLE%.

TWikiPlugin Formatting Extensions

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.

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, $Rev: 17387 (11 Aug 2008) $): Add spreadsheet calculation like "$SUM( $ABOVE() )" to TWiki tables and other topic text
• AlbumOfSnapsPlugin (Dakar, $Rev: 10613 (12 Dec 2008) $):
• ApprovalPlugin (1.0, $Rev: 3923 (2009-05-16) $): Defines a set of states for one more or topics, with each state requiring approval by one or more users.
• AttachmentList: (disabled)
• AttachmentListPlugin (1.2.6, $Rev: 17172 (28 Jul 2008) $): Displays a formattable list of topic attachments, anywhere in a topic.
• BatchUploadPlugin: (disabled)
• CaptchaPlugin (Dakar, 1.5-pre4): To prevent automated bots from spamming
• CommentPlugin (03 Aug 2008, $Rev: 17302 (11 Aug 2008) $): Allows users to quickly post comments to a page without an edit/preview/save cycle
• CounterPlugin (Dakar, $Rev: 14404 (12 Dec 2008) $): This plugin maintains the Visitor Count for the site.
• EditTablePlugin (4.8.4, $Rev: 17302 (11 Aug 2008) $): Edit TWiki tables using edit fields, date pickers and drop down boxes
• EmptyPlugin (TWiki-4.2, $Rev: 15942 (11 Aug 2008) $): Empty Plugin used as a template for new Plugins
• ImageGalleryPlugin (3.72, $Rev: 17034 (16 Jul 2008) $): Displays image gallery with auto-generated thumbnails from attachments
• ImagePlugin (2010-08-01, $Rev: 19301 (2010-08-01) $): Control the display and alignment of images using an easy syntax
• InterwikiPlugin (03 Aug 2008, $Rev: 14913 (17 Sep 2007) $): Link ExternalSite:Page text to external sites based on aliases defined in a rules topic
• MultiEditPlugin: (disabled)
• NewsPlugin (Dakar, $Rev: 15565 (12 Dec 2008) $): %NEWS% generates a short headlines topic from a list of news
• PreferencesPlugin (TWiki-4.2, $Rev: 15487 (11 Aug 2008) $): Allows editing of preferences using fields predefined in a form
• RenderListPlugin (2.0, $Rev: 16235 (11 Aug 2008) $): Render bullet lists in a variety of formats
• SendEmailPlugin (1.2.2, $Rev: 17666 (12 Dec 2008) $): Allows to send e-mail through an e-mail form
• SlideShowPlugin (02 Aug 2008, $Rev: 17260 (11 Aug 2008) $): Create web based presentations based on topics with headings.
• SmiliesPlugin (Dakar, $Rev: 16049 (11 Aug 2008) $): Render smilies as icons, like for  :-) or for  :eek:
• TablePlugin (1.034, $Rev: 17367 (11 Aug 2008) $): Control attributes of tables and sorting of table columns
• TagMePlugin (TWiki 4, 1.046): Tag wiki content collectively to find content by keywords
• TinyMCEPlugin (03 Aug 2008, $Rev: 17302 (11 Aug 2008) $): Integration of TinyMCE? with WysiwygPlugin
• TopicTranslationsPlugin (Dakar, $Rev: 15568 (12 Dec 2008) $): Manages a topic's translations into several languages.
• TwistyPlugin (1.4.10, $Rev: 15653 (19 Nov 2007) $): Twisty section JavaScript library to open/close content dynamically
• WysiwygPlugin (03 Aug 2008, $Rev: 17359 (11 Aug 2008) $): Translator framework for Wysiwyg editors

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

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

-- TWiki:Main.MikeMannix - 02 Dec 2001
-- TWiki:Main.PeterThoeny - 25 Apr 2004