|
From: Doug H. <dou...@us...> - 2002-08-25 14:41:01
|
Update of /cvsroot/happydoc/HappyDoc/happydoclib/docstring
In directory usw-pr-cvs1:/tmp/cvs-serv474/happydoclib/docstring
Modified Files:
docstring_StructuredText.py
Log Message:
Updated to the latest StructuredText implementation from Zope CVS.
Index: docstring_StructuredText.py
===================================================================
RCS file: /cvsroot/happydoc/HappyDoc/happydoclib/docstring/docstring_StructuredText.py,v
retrieving revision 1.5
retrieving revision 1.6
diff -C2 -d -r1.5 -r1.6
*** docstring_StructuredText.py 12 May 2002 21:22:29 -0000 1.5
--- docstring_StructuredText.py 25 Aug 2002 14:40:58 -0000 1.6
***************
*** 449,502 ****
<ul>
! <li><p>A single-line paragraph whose immediately succeeding paragraphs are lower
! level is treated as a header.</p></li>
! <li><p>A paragraph that begins with a '-', <code>*</code>, or <code>o</code> is treated as an
! unordered list (bullet) element.</p></li>
! <li><p>A paragraph that begins with a sequence of digits followed by a
! white-space character is treated as an ordered list element.</p></li>
! <li><p>A paragraph that begins with a sequence of sequences, where each
sequence is a sequence of digits or a sequence of letters followed
! by a period, is treated as an ordered list element.</p></li>
! <li><p>A paragraph with a first line that contains some text, followed by
some white-space and <code>--</code> is treated as
a descriptive list element. The leading text is treated as the
! element title.</p></li>
! <li><p>Sub-paragraphs of a paragraph that ends in the word <code>example</code> or the
! word <code>examples</code>, or <code>::</code> is treated as example code and is output as is.</p></li>
! <li><p>Text enclosed single quotes (with white-space to the left of the
first quote and whitespace or puctuation to the right of the second quote)
! is treated as example code.</p></li>
! <li><p>Text surrounded by '<em><code> characters (with white-space to the left of the
! first </code></em>' and whitespace or puctuation to the right of the second <code>*</code>)
! is emphasized.</p></li>
! <li><p>Text surrounded by '<strong><code> characters (with white-space to the left of the
! first </code></strong>' and whitespace or puctuation to the right of the second <code>**</code>)
! is made strong.</p></li>
! <li><p>Text surrounded by <code>_</code> underscore characters (with whitespace to the left
! and whitespace or punctuation to the right) is made underlined.</p></li>
! <li><p>Text encloded by double quotes followed by a colon, a URL, and concluded
by punctuation plus white space, <em>or</em> just white space, is treated as a
hyper link. For example:<p> <a href="http://www.zope.org/">Zope</a> is ...</p>
<p> Is interpreted as '<a href="http://www.zope.org/">Zope</a> is ....'
Note: This works for relative as well as absolute URLs.</p>
! </p></li>
! <li><p>Text enclosed by double quotes followed by a comma, one or more spaces,
an absolute URL and concluded by punctuation plus white space, or just
white space, is treated as a hyper link. For example: <p> <a href="mailto:am...@di...">mail me</a>.</p>
<p> Is interpreted as '<a href="mailto:am...@di...">mail me</a>.' </p>
! </p></li>
! <li><p>Text enclosed in brackets which consists only of letters, digits,
underscores and dashes is treated as hyper links within the document.
For example:<p> As demonstrated by Smith <a href="#12"><a href="#ref12">[12]</a></a> this technique is quite effective.</p>
<p> Is interpreted as '... by Smith <a href="#12"><a href="#ref12">[12]</a></a> this ...'. Together
with the next rule this allows easy coding of references or end notes.</p>
! </p></li>
! <li><p>Text enclosed in brackets which is preceded by the start of a line, two
periods and a space is treated as a named link. For example:<p> .. <a href="#12"><a href="#ref12">[12]</a></a> "Effective Techniques" Smith, Joe ... </p>
<p> Is interpreted as '<a name="12"><a href="#ref12">[12]</a></a> "Effective Techniques" ...'.
Together with the previous rule this allows easy coding of references or
end notes. </p>
! </p></li>
! <li><p>A paragraph that has blocks of text enclosed in <code>||</code> is treated as a
table. The text blocks correspond to table cells and table rows are
denoted by newlines. By default the cells are center aligned. A cell
--- 449,502 ----
<ul>
! <li>A single-line paragraph whose immediately succeeding paragraphs are lower
! level is treated as a header.</li>
! <li>A paragraph that begins with a '-', <code>*</code>, or <code>o</code> is treated as an
! unordered list (bullet) element.</li>
! <li>A paragraph that begins with a sequence of digits followed by a
! white-space character is treated as an ordered list element.</li>
! <li>A paragraph that begins with a sequence of sequences, where each
sequence is a sequence of digits or a sequence of letters followed
! by a period, is treated as an ordered list element.</li>
! <li>A paragraph with a first line that contains some text, followed by
some white-space and <code>--</code> is treated as
a descriptive list element. The leading text is treated as the
! element title.</li>
! <li>Sub-paragraphs of a paragraph that ends in the word <code>example</code> or the
! word <code>examples</code>, or <code>::</code> is treated as example code and is output as is.</li>
! <li>Text enclosed single quotes (with white-space to the left of the
first quote and whitespace or puctuation to the right of the second quote)
! is treated as example code.</li>
! <li>Text surrounded by <code>*</code> characters (with white-space to the left of the
! first <code>*</code> and whitespace or puctuation to the right of the second <code>*</code>)
! is emphasized.</li>
! <li>Text surrounded by <code>**</code> characters (with white-space to the left of the
! first <code>**</code> and whitespace or puctuation to the right of the second <code>**</code>)
! is made strong.</li>
! <li>Text surrounded by <code>_</code> underscore characters (with whitespace to the left
! and whitespace or punctuation to the right) is made underlined.</li>
! <li>Text encloded by double quotes followed by a colon, a URL, and concluded
by punctuation plus white space, <em>or</em> just white space, is treated as a
hyper link. For example:<p> <a href="http://www.zope.org/">Zope</a> is ...</p>
<p> Is interpreted as '<a href="http://www.zope.org/">Zope</a> is ....'
Note: This works for relative as well as absolute URLs.</p>
! </li>
! <li>Text enclosed by double quotes followed by a comma, one or more spaces,
an absolute URL and concluded by punctuation plus white space, or just
white space, is treated as a hyper link. For example: <p> <a href="mailto:am...@di...">mail me</a>.</p>
<p> Is interpreted as '<a href="mailto:am...@di...">mail me</a>.' </p>
! </li>
! <li>Text enclosed in brackets which consists only of letters, digits,
underscores and dashes is treated as hyper links within the document.
For example:<p> As demonstrated by Smith <a href="#12"><a href="#ref12">[12]</a></a> this technique is quite effective.</p>
<p> Is interpreted as '... by Smith <a href="#12"><a href="#ref12">[12]</a></a> this ...'. Together
with the next rule this allows easy coding of references or end notes.</p>
! </li>
! <li>Text enclosed in brackets which is preceded by the start of a line, two
periods and a space is treated as a named link. For example:<p> .. <a href="#12"><a href="#ref12">[12]</a></a> "Effective Techniques" Smith, Joe ... </p>
<p> Is interpreted as '<a name="12"><a href="#ref12">[12]</a></a> "Effective Techniques" ...'.
Together with the previous rule this allows easy coding of references or
end notes. </p>
! </li>
! <li>A paragraph that has blocks of text enclosed in <code>||</code> is treated as a
table. The text blocks correspond to table cells and table rows are
denoted by newlines. By default the cells are center aligned. A cell
***************
*** 528,532 ****
</pre>
</p>
! </p></li>
</ul>
--- 528,532 ----
</pre>
</p>
! </li>
</ul>
|
