"Structured text is text that uses indentation and simple symbology to indicate the structure of a document.
A structured string consists of a sequence of paragraphs separated by one or more blank lines. Each paragraph has a level which is defined as the minimum indentation of the paragraph. A paragraph is a sub-paragraph of another paragraph if the other paragraph is the last preceding paragraph that has a lower level.
Special symbology is used to indicate special constructs:
ois treated as an unordered list (bullet) element.
--is treated as a descriptive list element. The leading text is treated as the element title.
exampleor the word
::is treated as example code and is output as is:
<table border=0> <tr> <td> Foo </table>
*characters (with white-space to the left of the first
*and whitespace or puctuation to the right of the second
*) is emphasized.
**characters (with white-space to the left of the first
**and whitespace or puctuation to the right of the second
**) is made strong.
_underscore characters (with whitespace to the left and whitespace or punctuation to the right) is made underlined.
"Zope":http://www.zope.org/ is interpreted as
Note: This works for relative as well as absolute URLs?.
"mail me", mailto:email@example.com is
interpreted as mail me
"As demonstrated by Smith  this technique ..."
Is interpreted as: "As demonstrated by Smith  this technique"
Together with the next rule this allows easy coding of references or end notes.
..  "Effective Techniques" Smith, Joe ...
Is interpreted as
Note: see the <A NAME="12"> in the HTML source.
Together with the previous rule this allows easy coding of references or end notes."
See also: TextFormattingRules
|Page history||Last edited Fri, 22 Feb 2008 15:43:43 +0000||Edit this page|