zopewiki.org TextFormattingRules

See HelpPage for more help.

Structured Text rules

See ZWiki:StructuredText for full details. Zwiki adds linking and some fixes to standard STX.

don't bother trying to learn all the text formatting rules and their interactions. Mimic the text around you; when STX doesn't do what you want, tweak it until it looks right. Note STX usually does not support non-latin characters. Go to the docs or ask for help when you get really stuck or curious.

text emphasis:

       *italic*
       **bold**
       _underlined_
       'monospaced'

linking (see Link types below):

      WikiName
      [bracketed free-form name]
      ZWiki:RemoteWikiLink
      http://bare/url
      <a href="http://some/where">html link</a>
      "Structured Text link":http://some/where
      [1] (structured text footnote)

separate paragraphs with blank lines
a one-line paragraph becomes a heading when followed by a more-indented paragraph (all indented, or just the first line). A more-indented heading becomes a subheading.
a paragraph beginning with - or * or a number followed by a space makes a bullet or numbered list item. A more-indented list item starts a sub-list.
HTML tags may be used if necessary; on sites which permit it, DTML (server-side code) may also be used

to quote text, avoiding all the above: indent it after a paragraph ending with a double colon:

       parent paragraph::

         This is the only reliable way to quote WikiLinks, <HTML tags> and &dtml-code;
         or preserve fixed-width formatting. Use this eg when posting zope tracebacks.

Page types

See ZWiki:TextFormattingRules for more about these.

Structured Text: The default & most popular Zwiki page type, despite its quirks. Applies Zope's StructuredText? (STX) formatting rules, which also permit HTML. If enabled, DTML is also allowed and this appears as Structured Text + DTML.
reStructured Text: Applies the ReStructuredText? (RST) formatting rules. These are more strict than STX.
WikiWikiWeb markup: Applies the original WikiWikiWebMarkup? (WWML) rules, or something very like them. For wikizens who have those rules hard-wired in their brain.
HTML: Allows standard HTML, does not apply any text formatting rules. Useful for pasting in HTML or editing with a real HTML editor. Ignores any HTML head section for convenience. If enabled, DTML is also allowed and this appears as HTML + DTML.
Plain text: Does no text formatting or linking at all.

Note all of the above except plain text also do zwiki-style linking, unless disabled.

Link types

Here are (almost) all the ways you can make a hyperlink in a zwiki page.

Wiki links

The classic wiki link that started it all. Zwiki's allow one-letter words and digits on the end. :

  WikiName
  AName
  WikiNamePlus001

Bracket links

A simple syntax for linking to free-form page names, now used on many wikis. Zwiki's bracket links are fuzzy - they ignore capitalization, whitespace and punctuation. :

  [free-form name]

Double-bracket links

As used by wikipedia. Less likely to be triggered accidentally than single-bracket links. :

  [[free-form name]]

URL links

Bare urls :

  http://some/where
  ftp://some/where
  mailto:someone@there
  etc.

HTML links

Standard HTML hyperlinks, on pages which allow it. :

  <a href="http://some/where">link text</a>

STX links

Structured Text hyperlink syntax. Will not accept all characters. :

  "link text":http://some/where

STX footnotes

Structured Text footnote links. :

  [1] (any number)

  .. [1] footnote text.. something like that

RST links

reStructured Text has a plethora of linking methods. See the ReStructuredText ? docs. :

  _[hard-to-remember stuff]

Remote wiki links

See RemoteWikiLinks?. The local page defines a partial url for a remote wiki or other site. :

  LocalWikiPage:RemoteWikiPage
  LocalWikiPage:someotherthing

For more detail on DTML, TAL and other errors: use the error_log and event.log *

subject: