Text Formatting

Working in Foswiki is as easy as typing in text. 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 Foswiki 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.

Editing Shorthand

Formatting Command: You write: You get:
Blank lines will create new paragraphs.
1st paragraph

2nd paragraph

1st paragraph

2nd paragraph
Three or more dashes at the beginning of a line, followed by plus signs and the heading text. One plus creates a top level heading, two pluses a second level heading, etc. The maximum heading depth is 6.

You can create a table of contents with the %TOC% macro. If you want to exclude a heading from the TOC, put !! after the ---+.

ALERT! Empty headings are allowed, but won't appear in the table of contents.
---++ Sushi
---+++ Maguro
---+++!! Not in TOC



Not in TOC

Bold Text:
Words get shown in bold by enclosing them in * asterisks.

Italic Text:
Words get shown in italic by enclosing them in _ underscores.

Bold Italic:
Words get shown in bold italic by enclosing them in __ double-underscores.
__Bold italic__

Bold italic
Fixed Font:
Words get shown in fixed font by enclosing them in = equal signs.
=Fixed font=

Fixed font

Bold Fixed Font:
Words get shown in bold fixed font by enclosing them in double equal signs.
==Bold fixed==

Bold fixed
TIP You can follow the closing bold, italic, or other (* _ __ = ==) indicator with normal punctuation, such as commas and full stops.

ALERT! Make sure there is no space between the text and the indicators.
_This works_,
_this does not _

This works,
_this does not _
Verbatim (Literal) Text:
Surround code excerpts and other formatted text with <verbatim> and </verbatim> tags.

TIP verbatim tags disable HTML code. Use <pre> and </pre> tags instead if you want the HTML code within the tags to be interpreted.

ALERT! Preferences settings (* Set NAME = value) are set within verbatim tags.
class CatAnimal {
  void purr() {
    <code here>
class CatAnimal {
  void purr() {
    <code here>
Verbatim (Literal) Code Highlighting:
Surround code excerpts and other formatted text e.g. with <verbatim class="bash"> and </verbatim> tags.

IDEA! This type of code highlighting is based on Chili - the jQuery code highlighter plugin. Please find supported class attributes in JQueryChili.

TIP verbatim tags disable HTML code. Use <pre class="bash"> and </pre> tags instead if you want the HTML code within the tags to be interpreted.

ALERT! Preferences settings (* Set NAME = value) are set within verbatim tags.
<verbatim class="bash">
while [ -n "$(ls . ~/ \
~/pub* /var/www 2>/dev/null \
| fgrep foswiki )" ] ; do
 printf "\nFoswiki rules!\n"
 sleep 10
 printf "\nFoswiki still rules!\n"
 sleep 10
done; exit 0
while [ -n "$(ls . ~/ \
~/pub* /var/www 2>/dev/null \
| fgrep foswiki )" ] ; do
 printf "\nFoswiki rules!\n"
 sleep 10
 printf "\nFoswiki still rules!\n"
 sleep 10
done; exit 0

Separator (Horizontal Rule):
Three or more three dashes at the beginning of a line..

Bulleted List:
Multiple of three spaces, an asterisk, and another space.

HELP For all the list types, you can break a list item over several lines by indenting lines after the first one by at least 3 spaces.
   * level 1
      * level 2
   * back on 1
   * A bullet
     broken over
     three lines
   * last bullet

  • level 1
    • level 2
  • back on 1
  • A bullet broken over three lines
  • last bullet
Numbered List:
Multiple of three spaces, a type character, a dot, and another space. Several types are available besides a number:
Type Generated Style Sample Sequence
1. Arabic numerals 1, 2, 3, 4...
A. Uppercase letters A, B, C, D...
a. Lowercase letters a, b, c, d...
I. Uppercase Roman Numerals I, II, III, IV...
i. Lowercase Roman Numerals i, ii, iii, iv...
   1. Sushi
   1. Dim Sum
   1. Fondue

   A. Sushi
   A. Dim Sum
   A. Fondue

   i. Sushi
   i. Dim Sum
   i. Fondue

  1. Sushi
  2. Dim Sum
  3. Fondue

  1. Sushi
  2. Dim Sum
  3. Fondue

  1. Sushi
  2. Dim Sum
  3. Fondue
Definition List:
Three spaces, a dollar sign, the term, a colon, a space, followed by the definition.
   $ Sushi: Japan
   $ Dim Sum: S.F.

Dim Sum
Definition List: (deprecated)
Three spaces, the term (a single word, no spaces), a colon, a space, followed by the definition.
   Sushi: Japan
   Dim-Sum: S.F.

Each row of the table is a line containing of one or more cells. Each cell starts and ends with a vertical bar '|'. Any spaces at the beginning of a line are ignored.
  • | *bold* | header cell with text in asterisks
  • |   center-aligned   | cell with at least two, and equal number of spaces on either side
  • |      right-aligned | cell with more spaces on the left
  • | 2 colspan || and multi-span columns with multiple |'s right next to each other
  • |^| cell with caret indicating follow-up row of multi-span rows
  • You can split rows over multiple lines by putting a backslash '\' at the end of each line
  • Contents of table cells wrap automatically as determined by the browser
  • Use %VBAR% or &#124; to add | characters in tables.
  • Use %CARET% or &#94; to add ^ characters in tables.
TIP The TablePlugin provides the |^| multiple-span row functionality and additional rendering features
| *L* | *C* | *R* |
| A2 |  B2  |  C2 |
  | A3 |  B3  |  C3 |
| multi span |||
| A5-7 |  5  |  5 |
|^| six | six |
|^| seven | seven |
| split\
  | over\
  | 3 lines |
| A9 |  B9  |  C9 |
| %CARET% | B10 |%VBAR%|
| &#94; | B11 |&#124;|

A2 B2 C2
A3 B3 C3
multi span
A5-7 5 5
six six
seven seven
split over 3 lines
A9 B9 C9
^ B10 |
^ B11 |
WikiWord Links:
CapitalizedWordsStuckTogether (or WikiWords) will produce a link automatically if preceded by whitespace or parenthesis.
TIP If you want to link to a topic in a different web write Otherweb.TopicName.
To link to a topic in a subweb write Otherweb.Subweb.TopicName.
HELP The link label excludes the name of the web, e.g. only the topic name is shown. As an exception, the name of the web is shown for the WebHome topic.
ALERT! Dots '.' are used to separate webs and subwebs from topic names and therefore cannot be used in topic names.

It's generally a good idea to use the macros %SYSTEMWEB%, %SANDBOXWEB% and %USERSWEB% instead of System, Sandbox and Main.







Acronym Links:
Words that are all capitals will produce a link automatically only if the topic already exists!.



You can define a reference inside a topic (called an anchor name) and link to that. To define an anchor write #AnchorName at the beginning of a line. The anchor name must be a WikiWord of no more than 32 characters. To link to an anchor name use the [[MyTopic#MyAnchor]] syntax. You can omit the topic name if you want to link within the same topic.


#MyAnchor To here



To here
Forced Links:
You can create a forced internal link by enclosing words in double square brackets.
Text within the brackets may contain optional spaces; the topic name is formed by capitalizing the initial letter and by removing the spaces; for example, [[wiki syntax]] links to topic WikiSyntax. You can also refer to a different web and use anchors.
TIP To "escape" double square brackets that would otherwise make a link, prefix the leading left square bracket with an exclamation point.
[[wiki syntax]]

[[Main.Wiki groups]]

![[wiki syntax]]

wiki syntax

Main.Wiki groups

escaped: [[wiki syntax]]
Specific Links:
You can create a link where you specify the link text and the URL separately using nested square brackets [[reference][text]]. Internal link references (e.g. WikiSyntax) and URLs (e.g. http://foswiki.org/) are both supported. The rules described under Forced Links apply for internal link references.
TIP Anchor names can be added as well, to create a link to a specific place in a topic.
[[WikiSyntax][wiki syntax]]


wiki syntax

Prevent a Link:
Prevent a WikiWord from being linked by prepending it with an exclamation point.
Disable Links:
You can disable automatic linking of WikiWords by surrounding text with <noautolink> and </noautolink> tags.
HELP It is possible to turn off all auto-linking with a NOAUTOLINK preference setting.
 RedHat & SuSE

RedHat & SuSE
Mailto Links:
E-mail addresses are linked automatically. To create e-mail links that have more descriptive link text, specify subject lines or message bodies, or omit the e-mail address, you can write [[mailto:user@domain][descriptive text]].





Literal content:
Foswiki generates HTML code from TML shorthand. Experts surround anything that must be output literally in the HTML code, without the application of shorthand rules, with <literal>..</literal> tags.
ALERT! Any HTML within literal tags must be well formed i.e. all tags must be properly closed before the end of the literal block.
IDEA! Macros are expanded within literal blocks.
| Not | A | Table |
| Not | A | Table |
Protected content:
Experts protect text from mangling by WYSIWYG editors using <sticky>..</sticky> tags. Sticky tags don't have any effect on normal topic display; they are only relevant when content has to be protected from a WYSIWYG editor (usually because it isn't well-formed HTML, or because it is HTML that WYSIWYG would normally filter out or modify). Protected content appears as plain text in the WYSIWYG editor.
ALERT! Any HTML within sticky tags must be well formed i.e. all tags must be properly closed before the end of the sticky block.
IDEA! Macros are expanded within sticky blocks.
This div 

This div is required

Using HTML

You can use most HTML tags in topics without a problem. This is useful where you want to add some content that is formatted in a way that is not supported using wiki syntax, for example, you can write <strike>deleted text</strike> to get deleted text.

There are a few usability and technical considerations to keep in mind:
  • On collaboration pages, it's better not to use HTML, but to use wiki syntax instead - this keeps the text uncluttered and easy to edit using the plaintext editor.
  • If you must use HTML, use XHTML 1.0 Transitional syntax.
  • Use <literal>..</literal> tags around blocks of HTML to avoid accidental interpretation of Wiki syntax within the HTML.
ALERT! Script tags may be filtered out, at the discretion of your Wiki administrator.

Recommendations when pasting HTML from other sources (using the plain-text editor):
  • Copy only text between <body> and </body> tags.
  • Remove all empty lines. Foswiki inserts <p /> paragraph tags on empty lines, which causes problems if done between HTML tags that do not allow paragraph tags, like for example between table tags.
  • Remove leading spaces. Foswiki might interpret some text as lists.
  • Do not span a tag over more than one line. Foswiki requires that the opening and closing angle brackets - <...> - of a HTML tag are on the same line, or the tag will be broken.
  • In your HTML editing program, save without hard line breaks on text wrap.

When using a WYSIWYG editor, you can just copy-paste directly into the editor, and the content will be converted to wiki syntax automatically when you save.


Being able to create links without any special formatting is a core Foswiki feature, made possible with WikiWords, Acronyms, and inline URLs.

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!)

  • ACRONYM links to a topic name consisting of only upper-case letters. Acronyms are linked only if the target topic actually exists.

External Links

  • Protocols matching the configuration parameter LinkProtocolPattern, which by default is set to (file|ftp|gopher|https|http|irc|mailto|news|nntp|telnet), are linked automatically. You might change this setting to add more protocols (such as smb).
    TIP LinkProtocolPattern is an expert setting in the Foswiki configuration and can only be changed by a systems administrator.
    Thus, all lines containing:
    • file://...
    • ftp://...
    • gopher://...
    • https://...
    • http://...
    • irc://...
    • mailto:...@...
    • news://...
    • nntp://...
    • telnet://... are linked automatically.
  • E-mail 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.


Macros are names enclosed in percent signs that are that are expanded to some other text when the topic is displayed. For example, %TOPIC% is expanded to TextFormattingRules, the title of this topic.

Some macros can take arguments in curly braces - for example, %INCLUDE{"OtherTopic" ARG="arg"}%.

Many macro definitions are built-in, and others (preference settings) are predefined for your convenience. You can also define your own preference settings at the entire site, individual web, or individual topic level. For more information, see Macros

Macros are fully expanded before any of the text formatting rules are applied.

Plugin Formatting Extensions

Plugins can extend the functionality of Foswiki into many other areas. There are a huge number of plugins available from the foswiki site.

Currently enabled plugins on this installation, as listed by %PLUGINDESCRIPTIONS%:
  • SpreadSheetPlugin (1.1.7, v1.1.7): Add spreadsheet calculations like "$SUM($ABOVE())" to Foswiki tables and other topic text
  • ActionTrackerPlugin (2013-02-27, 2.4.10): Adds support for action tags in topics, and automatic notification of action statuses
  • AutoViewTemplatePlugin (2012-12-16, v1.1.7): Automatically sets VIEW_TEMPLATE and EDIT_TEMPLATE
  • BeautifierPlugin (1.0, $Rev: 7136 (2010-04-09) $): Provides the %CODE% and %ENDCODE% macros to display code fragments with formatting and syntax highlighting for improved readbility in wiki topics.
  • BlackListPlugin (08 Jan 2010, $Rev: 5969 (2010-01-07) $): Utility to keep malicious users away from a public Foswiki site
  • CalendarPlugin (2.000, $Rev: 8058 (2010-07-07) $): Show a monthly calendar with highlighted events
  • CommentPlugin (1.1.6, v1.1.6): Quickly post comments to a page without an edit/save cycle
  • CompareRevisionsAddonPlugin (1.1.11, v1.1.11):
  • DirectedGraphPlugin (1.13, 1.13): Draw graphs using the GraphViz utility
  • EditTablePlugin (4.43, 4.43): Edit tables using edit fields, date pickers and drop down boxes
  • ExplicitNumberingPlugin (1.6.2, $Rev: 12385 (2011-08-25) $): Use the ##., ##.. etc. notation to insert outline numbering sequences (1, 1.1, 2, 2.1) in topic's text. Also support numbered headings.
  • ForEachPlugin (1.102, $Rev: 10382 (2010-12-22) $): Loop over successive elements of a list, or a range of numbers.
  • FormPlugin (2.4.0, $Rev: 14547 (2012-04-03) $): Lets you create simple and advanced HTML forms
  • GenPDFAddOnPlugin (1.3, 1.3): GenPDFAddOnPlugin helper plugin for GenPDFAddOn renders the %GENPDF% tag
  • HeadlinesPlugin (2.21.2, $Rev: 6822 (2010-03-21) $): Show headline news in Foswiki pages based on RSS and ATOM news feeds from external sites
  • HistoryPlugin (1.11, 1.11): Shows a complete history of a topic
  • HolidaylistPlugin (2.001, $Rev: 14328 (2012-03-15) $): Create a table with a list of people on holidays
  • InterwikiPlugin (1.1.7, v1.1.7): Link ExternalSite:Page text to external sites based on aliases defined in a rules topic
  • JHotDrawPlugin (29 Oct 2010, $Rev: 9801 (2010-10-29) $): Java Applet based drawing editor
  • JQueryPlugin (4.91, 4.91): jQuery JavaScript library for Foswiki
  • LatexModePlugin (4.0, $Rev: 4721 (2009-08-28) $): Enables LaTeX markup (mathematics and more) in Foswiki topics
  • MailerContribPlugin (2.5.3, v2.5.3): Supports e-mail notification of changes
  • MetaDataPlugin (3.21, 3.21): Bring custom meta data to wiki apps
  • PreferencesPlugin (1.1.5, v1.1.5): Allows editing of preferences using fields predefined in a form
  • 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 smile 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
  • TreeBrowserPlugin (v2.0, $Rev: 5479 (2009-11-10) $): Renders a list as a collapsable/expandable tree.
  • TreePlugin (1.9.1, $Rev: 6156 (2010-01-27) $): Renders topics' parent-child relationships as hierarchical tree view. Useful for dynamic site maps and threads.
  • TwistyPlugin (1.6.18, v1.6.18): Twisty section Javascript library to open/close content dynamically
  • WorkflowPlugin (1.12.8, $Rev: 14978 (2012-06-13) $): Associate a "state" with a topic and then control the work flow that the topic progresses through as content is added.
  • WysiwygPlugin (16 May 2013, v1.1.16): Translator framework for WYSIWYG editors

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

Common Editing Errors

Foswiki formatting rules are fairly simple to use and quick 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 '&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, 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'.
Topic revision: r1 - 20 Sep 2010, ProjectContributor
This site is powered by FoswikiCopyright © by the contributing authors. All material on this site is the property of the contributing authors.
Ideas, requests, problems regarding Hades Wiki? Send feedback