axiom-developer
[Top][All Lists]
Advanced
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Axiom-developer] [StructuredText]

From: Bill Page
Subject: [Axiom-developer] [StructuredText]
Date: Fri, 08 Apr 2005 10:04:33 -0500 
Changes http://page.axiom-developer.org/zope/mathaction/StructuredText/diff
--

++added:
Structured Text rules

   0. 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":TextFormattingRules or "ask for 
help":UserDiscussion#bottom
      when you get really stuck or curious.

   0. text emphasis::

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

   0. linking (see link types above)::

      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)

   0. separate paragraphs with blank lines

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

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

   0. HTML tags may be used if necessary; on sites which permit it,
      DTML (server-side code) may also be used

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

--
forwarded from http://page.axiom-developer.org/zope/mathaction/address@hidden
reply via email to
[Prev in Thread] Current Thread [Next in Thread]