*λ Ι ά;csdZ hdd<dd<dd<dd<d d <d d <d d<dddkZDd„ZLdeiifd„ƒYZ ]deii fd„ƒYZ ½deii fd„ƒYZ dS(s9Docstring converter for original StructuredText format. s0$RCSfile: docstring_ClassicStructuredText.py,v $s module_namesT$Id: docstring_ClassicStructuredText.py,v 1.2 2001/10/28 13:40:25 doughellmann Exp $srcs_ids(Doug Hellmann screatorsHappyDocsprojectsWed, 26-Sep-2001 09:52:01 EDTscreateds$Author: doughellmann $sauthors$Revision: 1.2 $sversions$Date: 2001/10/28 13:40:25 $sdates is0.0Ncs,DEFhdd<td<gd"""Classic 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 punctuation 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 punctuation to the right of the second *) is emphasized.

  • Text surrounded by ** characters (with white-space to the left of the first ** and whitespace or punctuation 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 Zope 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:amos@digicool.com.

    Is interpreted as mail me.

  • 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 [12] 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 [12] "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:

          |||| **Ingredient** ||
      || *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>

    and appear as:

    Ingredient
    Name Amount
    Spam 10
    Eggs 3

"""

csoded}fdk}g|ii|ƒ}h|i}j|i |ldmdn|i odƒqdSdS(Ns(TestCases/test_classic_structuredtext.pysClassicStructuredTextshtmls?Converting Classic ST to HTML did not produce expected results.( sfilenameshappydoclib.parseinfos happydoclibs parseinfosgetDocss parsed_modules _docstrings input_textsselfs_testConversionsexpectedOutput(sselfsfilenames happydoclibs parsed_modules input_text((ss/home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_0/happydoclib/docstring/docstring_ClassicStructuredText.pys#testClassicStructuredTextConversionds      cs‚std}…d}™|i|›dœd|ždƒ‘d}²d}Θ|i|ΚdΛdΜ|ΝdƒΟdSdS(Ns~ any text first heading first section second heading second section third heading third section s·

any text

first heading

first section

second heading

second section

third heading

third section

sClassicStructuredTextshtmls?Converting Classic ST to HTML did not produce expected results.su first heading first section second heading second section third heading third section sΦ

first heading

first section

second heading

second section

third heading

third section

(s input_text1sexpected_text1sselfs_testConversions input_text2sexpected_text2(sselfsexpected_text2s input_text2sexpected_text1s input_text1((ss/home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_0/happydoclib/docstring/docstring_ClassicStructuredText.pystestBug471981Classicss        (sexpectedOutputs#testClassicStructuredTextConversionstestBug471981Classic(((ss/home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_0/happydoclib/docstring/docstring_ClassicStructuredText.pysClassicSTUnitTest½s ₯ (s__doc__s __rcs_info__ssplits __version__sres happydoclibs entryPointshappydocstringsExternalDocumentationFileBasesClassicStructuredTextFilesHappyDocStringConverterBasesClassicStructuredTextConvertersDocStringConverterTestsClassicSTUnitTest(s __rcs_info__s happydoclibsClassicStructuredTextFiles __version__sClassicSTUnitTestsClassicStructuredTextConverters entryPointsre((ss/home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_0/happydoclib/docstring/docstring_ClassicStructuredText.pys?s Q    `