Update of /cvsroot/happydoc/HappyDoc3/happydoclib/docstring In directory sc8-pr-cvs5.sourceforge.net:/tmp/cvs-serv3531/happydoclib/docstring Modified Files: __init__.py docstring_ClassicStructuredText.py docstring_PlainText.py docstring_RawText.py docstring_StructuredText.py Log Message: Fix file headers Index: __init__.py =================================================================== RCS file: /cvsroot/happydoc/HappyDoc3/happydoclib/docstring/__init__.py,v retrieving revision 1.1.1.1 retrieving revision 1.2 diff -C2 -d -r1.1.1.1 -r1.2 *** __init__.py 17 Nov 2002 00:26:19 -0000 1.1.1.1 --- __init__.py 5 Dec 2006 13:10:46 -0000 1.2 *************** *** 70,74 **** 'module_name' : '$RCSfile$', 'rcs_id' : '$Id$', ! 'creator' : 'Doug Hellmann <Dou...@bi...>', 'project' : 'HappyDoc', 'created' : 'Wed, 26-Sep-2001 09:31:19 EDT', --- 70,74 ---- 'module_name' : '$RCSfile$', 'rcs_id' : '$Id$', ! 'creator' : 'Doug Hellmann', 'project' : 'HappyDoc', 'created' : 'Wed, 26-Sep-2001 09:31:19 EDT', Index: docstring_ClassicStructuredText.py =================================================================== RCS file: /cvsroot/happydoc/HappyDoc3/happydoclib/docstring/docstring_ClassicStructuredText.py,v retrieving revision 1.3 retrieving revision 1.4 diff -C2 -d -r1.3 -r1.4 *** docstring_ClassicStructuredText.py 19 Jan 2003 22:03:44 -0000 1.3 --- docstring_ClassicStructuredText.py 5 Dec 2006 13:10:46 -0000 1.4 *************** *** 36,40 **** 'module_name' : '$RCSfile$', 'rcs_id' : '$Id$', ! 'creator' : 'Doug Hellmann <Dou...@bi...>', 'project' : 'HappyDoc', 'created' : 'Wed, 26-Sep-2001 09:52:01 EDT', --- 36,40 ---- 'module_name' : '$RCSfile$', 'rcs_id' : '$Id$', ! 'creator' : 'Doug Hellmann', 'project' : 'HappyDoc', 'created' : 'Wed, 26-Sep-2001 09:52:01 EDT', Index: docstring_PlainText.py =================================================================== RCS file: /cvsroot/happydoc/HappyDoc3/happydoclib/docstring/docstring_PlainText.py,v retrieving revision 1.1.1.1 retrieving revision 1.2 diff -C2 -d -r1.1.1.1 -r1.2 *** docstring_PlainText.py 17 Nov 2002 00:26:19 -0000 1.1.1.1 --- docstring_PlainText.py 5 Dec 2006 13:10:46 -0000 1.2 *************** *** 40,45 **** 'module_name' : '$RCSfile$', 'rcs_id' : '$Id$', ! 'creator' : 'Doug Hellmann <Dou...@bi...>', ! 'project' : 'UNSPECIFIED', 'created' : 'Wed, 26-Sep-2001 09:52:01 EDT', --- 40,45 ---- 'module_name' : '$RCSfile$', 'rcs_id' : '$Id$', ! 'creator' : 'Doug Hellmann', ! 'project' : 'HappyDoc', 'created' : 'Wed, 26-Sep-2001 09:52:01 EDT', Index: docstring_RawText.py =================================================================== RCS file: /cvsroot/happydoc/HappyDoc3/happydoclib/docstring/docstring_RawText.py,v retrieving revision 1.2 retrieving revision 1.3 diff -C2 -d -r1.2 -r1.3 *** docstring_RawText.py 19 Jan 2003 22:04:06 -0000 1.2 --- docstring_RawText.py 5 Dec 2006 13:10:46 -0000 1.3 *************** *** 37,42 **** 'module_name' : '$RCSfile$', 'rcs_id' : '$Id$', ! 'creator' : 'Doug Hellmann <Dou...@bi...>', ! 'project' : 'UNSPECIFIED', 'created' : 'Wed, 26-Sep-2001 09:52:01 EDT', --- 37,42 ---- 'module_name' : '$RCSfile$', 'rcs_id' : '$Id$', ! 'creator' : 'Doug Hellmann', ! 'project' : 'HappyDoc', 'created' : 'Wed, 26-Sep-2001 09:52:01 EDT', Index: docstring_StructuredText.py =================================================================== RCS file: /cvsroot/happydoc/HappyDoc3/happydoclib/docstring/docstring_StructuredText.py,v retrieving revision 1.2 retrieving revision 1.3 diff -C2 -d -r1.2 -r1.3 *** docstring_StructuredText.py 1 Jan 2003 14:06:38 -0000 1.2 --- docstring_StructuredText.py 5 Dec 2006 13:10:46 -0000 1.3 *************** *** 36,40 **** 'module_name' : '$RCSfile$', 'rcs_id' : '$Id$', ! 'creator' : 'Doug Hellmann <Dou...@bi...>', 'project' : 'HappyDoc', 'created' : 'Wed, 26-Sep-2001 09:52:01 EDT', --- 36,40 ---- 'module_name' : '$RCSfile$', 'rcs_id' : '$Id$', ! 'creator' : 'Doug Hellmann', 'project' : 'HappyDoc', 'created' : 'Wed, 26-Sep-2001 09:52:01 EDT', *************** *** 297,700 **** return inputText - - class StructuredTextUnitTest(happydoclib.happydocstring.DocStringConverterTest): - - html_quote_text = '<>&"\'[]{};' - html_quote_expected_text = "<>&"'[]{};" - - st_test_text_with_links = ''' - Structured Text With Links - - This "link":link.html points to link.html. - - This [1] reference points to an internal reference. - - .. [1] This is the internal reference. - ''' - - st_expected_text_with_links = ''' - <h3> Structured Text With Links</h3> - <p> This <a href="link.html">link</a> points to link.html.</p> - <p> This <a href="#1"><a href="#ref1">[1]</a></a> reference points to an internal reference.</p> - <p> <a name="1"><a href="#ref1">[1]</a></a> This is the internal reference.</p> - ''' - - st_test_text = '''Structured Text Manipulation - - Parse a structured text string into a form that can be used with - structured formats, like html. - - 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: - - - A single-line paragraph whose immediately succeeding paragraphs are lower - level is treated as a header. - - - A paragraph that begins with a '-', '*', or 'o' is treated as an - unordered list (bullet) element. - - - A paragraph that begins with a sequence of digits followed by a - white-space character is treated as an ordered list element. - - - 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. - - - A paragraph with a first line that contains some text, followed by - some white-space and '--' is treated as - a descriptive list element. The leading text is treated as the - element title. - - - Sub-paragraphs of a paragraph that ends in the word 'example' or the - word 'examples', or '::' is treated as example code and is output as is. - - - 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. - - - Text surrounded by '*' characters (with white-space to the left of the - first '*' and whitespace or puctuation to the right of the second '*') - is emphasized. - - - Text surrounded by '**' characters (with white-space to the left of the - first '**' and whitespace or puctuation to the right of the second '**') - is made strong. - - - Text surrounded by '_' underscore characters (with whitespace to the left - and whitespace or punctuation to the right) is made underlined. - - - Text encloded by double quotes followed by a colon, a URL, and concluded - by punctuation plus white space, *or* just white space, is treated as a - hyper link. For example: - - "Zope":http://www.zope.org/ is ... - - Is interpreted as '<a href="http://www.zope.org/">Zope</a> is ....' - Note: This works for relative as well as absolute URLs. - - - 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: - - "mail me", mailto:am...@di.... - - Is interpreted as '<a href="mailto:am...@di...">mail me</a>.' - - - Text enclosed in brackets which consists only of letters, digits, - underscores and dashes is treated as hyper links within the document. - For example: - - As demonstrated by Smith [12] this technique is quite effective. - - Is interpreted as '... by Smith <a href="#12">[12]</a> this ...'. Together - with the next rule this allows easy coding of references or end notes. - - - 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: - - .. [12] "Effective Techniques" Smith, Joe ... - - Is interpreted as '<a name="12">[12]</a> "Effective Techniques" ...'. - Together with the previous rule this allows easy coding of references or - end notes. - - - - A paragraph that has blocks of text enclosed in '||' 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 - can span more than one column by preceding a block of text with an - equivalent number of cell separators '||'. Newlines and '|' cannot - be a part of the cell text. For example: - - |||| **Ingredients** || - || *Name* || *Amount* || - ||Spam||10|| - ||Eggs||3|| - - is interpreted as:: - - <TABLE BORDER=1 CELLPADDING=2> - <TR> - <TD ALIGN=CENTER COLSPAN=2> <strong>Ingredients</strong> </TD> - </TR> - <TR> - <TD ALIGN=CENTER COLSPAN=1> <em>Name</em> </TD> - <TD ALIGN=CENTER COLSPAN=1> <em>Amount</em> </TD> - </TR> - <TR> - <TD ALIGN=CENTER COLSPAN=1>Spam</TD> - <TD ALIGN=CENTER COLSPAN=1>10</TD> - </TR> - <TR> - <TD ALIGN=CENTER COLSPAN=1>Eggs</TD> - <TD ALIGN=CENTER COLSPAN=1>3</TD> - </TR> - </TABLE>''' - - st_expected_text = ''' - <p>Structured Text Manipulation</p> - <p>Parse a structured text string into a form that can be used with - structured formats, like html.</p> - <p>Structured text is text that uses indentation and simple - symbology to indicate the structure of a document. </p> - <p>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.</p> - <p>Special symbology is used to indicate special constructs:</p> - - <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 - can span more than one column by preceding a block of text with an - equivalent number of cell separators <code>||</code>. Newlines and <code>|</code> cannot - be a part of the cell text. For example:<p> |||| <strong>Ingredients</strong> || - || <em>Name</em> || <em>Amount</em> || - ||Spam||10|| - ||Eggs||3||</p> - <p> is interpreted as: - <pre> - <TABLE BORDER=1 CELLPADDING=2> - <TR> - <TD ALIGN=CENTER COLSPAN=2> <strong>Ingredients</strong> </TD> - </TR> - <TR> - <TD ALIGN=CENTER COLSPAN=1> <em>Name</em> </TD> - <TD ALIGN=CENTER COLSPAN=1> <em>Amount</em> </TD> - </TR> - <TR> - <TD ALIGN=CENTER COLSPAN=1>Spam</TD> - <TD ALIGN=CENTER COLSPAN=1>10</TD> - </TR> - <TR> - <TD ALIGN=CENTER COLSPAN=1>Eggs</TD> - <TD ALIGN=CENTER COLSPAN=1>3</TD> - </TR> - </TABLE> - </pre> - </p> - </li> - - </ul> - ''' - - - def testConvertStructuredTextToHTML(self): - self._testConversion( self.st_test_text, 'StructuredText', - 'html', self.st_expected_text, - 'StructuredText-to-HTML conversion failed.' - ) - return - - def testConvertStructuredTextToHTMLWithLinks(self): - self._testConversion( self.st_test_text_with_links, 'StructuredText', - 'html', self.st_expected_text_with_links, - 'StructuredText-to-HTML-with-links conversion failed.', - ) - return - - def testQuoteStructuredTextToHTML(self): - self._testQuote(self.html_quote_text, 'StructuredText', 'html', - self.html_quote_expected_text, - 'ST-to-HTML quote failed.', - ) - return - - def testStructuredTextOneLiner(self): - stf = StructuredTextFile(filename='internal', body=self.st_test_text) - assert stf, 'Unable to create valid StructuredTextFile' - expected_oneliner = 'Structured Text Manipulation' - assert stf.oneLiner() == expected_oneliner, 'Got different one-liner "%s"' % stf.oneLiner() - return - - def testBug594026(self): - input_text = '*marié* or **marié**' - expected_text = ''' - <p><em>marié</em> or <strong>marié</strong></p> - ''' - self._testConversion(input_text, - 'StructuredText', - 'html', - expected_text, - 'StructuredText-to-HTML with accented characters failed.', - ) - return - - - def testBug471981(self): - input_text1 = """ any text - - first heading - - first - section - - second heading - - second - section - - third heading - - third - section - """ - expected_text1 = ''' - <h3> any text</h3> - <p> first - section</p> - <h3>first heading</h3> - <p> second - section</p> - <h3>second heading</h3> - <p> third - section</p> - <p>third heading</p> - ''' - - self._testConversion( - input_text1, - 'StructuredText', - 'html', - expected_text1, - 'Converting Classic ST to HTML did not produce expected results.', - ) - - input_text2 = """ - - first heading - - first - section - - second heading - - second - section - - third heading - - third - section - """ - expected_text2 = ''' - <h3>first heading</h3> - <p> first - section</p> - <h3>second heading</h3> - <p> second - section</p> - <h3>third heading</h3> - <p> third - section</p> - ''' - - self._testConversion( - input_text2, - 'StructuredText', - 'html', - expected_text2, - 'Converting Classic ST to HTML did not produce expected results.', - ) - return - - - def testWithQuotableCharacters(self): - input_text = "Here are some quotable characters. & < > < >." - expected_text = '\n<p>Here are some quotable characters. & < > < >.</p>\n' - - self._testConversion( - input_text, - 'StructuredText', - 'html', - expected_text, - 'Converting ST to HTML with quotable characters did not produce expected results.', - ) - - - def testWithQuotableCharactersInExample(self): - input_text = """Here are some quotable characters in example paragraphs - - First, a true example:: - - Begin & < > - - Finally, embedded in a code segment '& < >'. - """ - expected_text = """ - <h3>Here are some quotable characters in example paragraphs</h3> - <p> First, a true example: - <pre> - Begin & < > - </pre> - </p> - <p> Finally, embedded in a code segment '& < >'.</p> - """ - - self._testConversion( - input_text, - 'StructuredText', - 'html', - expected_text, - 'Converting ST to HTML with quotable characters did not produce expected results.', - ) - --- 297,298 ---- |
