TWiki Text Formatting

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

      * 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

NotExistingYet

[[wiki syntax]]

[[User.TWiki users]]

[[WikiSyntax][syntax]]

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

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

[[WebHome#NotThere]]

[[#MyAnchor][Jump]]

#MyAnchor To here

<nop>SunOS

 <noautolink>
 RedHat &
 SuSE
 </noautolink>

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

[[mailto:?subject=Hi Hi]]

Using HTML

HTML and TWiki Usability

• 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 3.2 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.

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.

Hyperlinks

Internal Links

• GoodStyle is a WikiWord that links to the GoodStyle topic located in the current 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

• %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 Support.

• %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 Foswiki web is the default web. Example: %INCLUDE{"System.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.

TWikiPlugin Formatting Extensions

• TWikiCompatibilityPlugin (1.1.2, v1.1.2): Add TWiki personality to Foswiki
• SpreadSheetPlugin (1.1.7, v1.1.7): Add spreadsheet calculations like "$SUM($ABOVE())" to Foswiki tables and other topic text
• AutoViewTemplatePlugin (2012-12-16, v1.1.7): Automatically sets VIEW_TEMPLATE and EDIT_TEMPLATE
• BibtexPlugin (2.2.1, $Rev: 14850 (2012-05-18) $): Embed BibTeX entries.
• ChecklistPlugin (Cairo, Dakar, Edinburgh, ..., $Rev: 5335 (2009-10-21) $): Create simple checklists.
• CommentPlugin (1.1.6, v1.1.6): Quickly post comments to a page without an edit/save cycle
• EditTablePlugin (4.43, 4.43): Edit tables using edit fields, date pickers and drop down boxes
• HistoryPlugin (1.11, 1.11): Shows a complete history of a topic
• HomePagePlugin ($Date: 2008-12-15 04:49:56 +1100 (Mon, 15 Dec 2008) $, 1340): Allow User specified home pages - on login
• ImageGalleryPlugin (6.00, $Rev: 11854 (2011-06-06) $): Displays image gallery with auto-generated thumbnails from attachments
• InterwikiPlugin (1.1.7, v1.1.7): Link ExternalSite:Page text to external sites based on aliases defined in a rules topic
• JQueryPlugin (4.91, 4.91): jQuery JavaScript library for Foswiki
• MailerContribPlugin (2.5.3, v2.5.3): Supports e-mail notification of changes
• PreferencesPlugin (1.1.5, v1.1.5): Allows editing of preferences using fields predefined in a form
• RedDotPlugin (3.00, $Rev: 9958 (2010-11-11) $): Renders edit-links as little red dots
• RedirectPlugin (1.1, $Rev: 7923 (2010-06-26) $): Create a redirect to another topic or website.
• RenderListPlugin (2.2.7, v2.2.7): Render bullet lists in a variety of formats
• SlideShowPlugin (2.1.6, v2.1.6): Create web based presentations based on topics with headings
• SmiliesPlugin (28 Nov 2012, v1.1.6): Render smilies like as icons
• TablePlugin (1.142, 1.142): Control attributes of tables and sorting of table columns
• TinyMCEPlugin (1.2.9, v1.2.9): Integration of the Tiny MCE WYSIWYG Editor
• TwistyPlugin (1.6.18, v1.6.18): Twisty section Javascript library to open/close content dynamically
• WebLinkPlugin (1.20, $Rev: 14758 (2012-05-07) $): A parametrized %WEB macro
• WysiwygPlugin (16 May 2013, v1.1.16): Translator framework for WYSIWYG editors

Common Editing Errors

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