login  home  contents  what's new  discussion  bug reports help  links  subscribe  changes  refresh  edit

Structured Text is a simple plain text markup format used by Zope and ZWiki. It's similar in effect to WikiWikiWebMarkup but is more intuitive and standardized. The idea is to have text that is easy to read both in source and rendered form.

The LatexWiki extensions allow LaTeX commands to be embedded in Structured Text. MathAction also permits Axiom and Reduce commands to be embedded.

Zwiki supports other text formatting rules, but Structured Text is still the default for these reasons: it was the first in zope, it's a standard, it's simple, it's forgiving, and it allows embedded HTML and DTML.

## Structured Text rules

1. 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.
2. text emphasis:
       *italic*
**bold**
_underlined_
'monospaced'

      WikiName
[bracketed free-form name]
http://bare/url
[1] (structured text footnote)

4. separate paragraphs with blank lines
5. 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.
6. 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.
7. HTML tags may be used if necessary; on sites which permit it, DTML (server-side code) may also be used
8. 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.


## References

Usage on every page --unknown, Mon, 31 Oct 2005 12:56:22 -0600 reply
Any hint about the usage of structured text on all the pages that are editable will be useful. It is rather hard to remember all of these all the times(esp. at the times of need) and would be helpful to any newcomers.

Hints for using Structured Text --Bill Page, Sun, 27 Nov 2005 01:04:07 -0600 reply
I have changed the point-and-click menu that appears below the comment and the edit windows to include some basic some basic help for StructuredText commands. This works the same way as for Axiom commands, LaTeX commands, and Latex Symbols.

For example clicking on ** in the header of the Text area will display a list of commonly used methods for text highlighting. To add bold highlighting select some text in the comment or edit box and click:

  **bold**


This will insert the necessary markup.