-
G2;c       s     d  Z     h  d d <d d <d d <d d <d	 d
 <d d <d d <d d <Z 1 y 2 e d i d  d Z Wn 3 4 d Z n X9 d k Z : d k Z A d   Z I d e i i i	 f d     YZ
 d S(   s/   Formatter which produces simple DocBook SGML.

s"   $RCSfile: formatter_DocBook.py,v $s   module_namesF   $Id: formatter_DocBook.py,v 1.1 2001/10/24 21:27:35 doughellmann Exp $s   rcs_ids#   Balazs Scheidler <bazsi@balabit.hu>s   creators   HappyDocs   projects   Sat, 03-Feb-2001 12:53:37 ESTs   createds   $Author: doughellmann $s   authors   $Revision: 1.1 $s   versions   $Date: 2001/10/24 21:27:35 $s   dates    i   s   0.0Nc      s#   A B C h  d d <t  d <Sd S(   s;   Return information about this module to the dynamic loader.s   SGMLDocBooks   names   factoryN(   s   DocBookFormatter(    (    (    se   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBook.pys
   entryPointA s   s   DocBookFormatterc      s  I d  Z  J L d   Z T d d  Z ] d   Z c d   Z g d   Z m d d  Z  d	   Z  d
   Z  e	 d d  Z
  d   Z  d   Z  d   Z  d   Z  d   Z  d   Z  d   Z  d   Z  d   Z  d   Z  d   Z  d d  Z  d   Z  d   Z  d   Z  e	 d  Z  d   Z d   Z d    Z d!   Z d"   Z RS(#   s-   Formatter which produces simple DocBook SGML.c    sQ   L M d |  _ N d |  _ O t t i i i i P |  | f Q |  R d  Sd  S(   Ni   i    (   s   selfs   _section_level_counters   debugs   applys   happydoclibs	   formatters   fileformatterbases   FileBasedFormatters   __init__s   docSets   configuration(   s   selfs   docSets   configuration(    (    se   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBook.pys   __init__L s   
s    c    sN   T U V t  i i i i |  X | Y |  } Z |  i	 | | |  [ | Sd S(   s8   Write the formatting for a file header to the open file.N(   s   happydoclibs	   formatters   fileformatterbases   FileBasedFormatters
   openOutputs   selfs   names   title1s   fs
   fileHeaders   title2(   s   selfs   names   title1s   title2s   f(    (    se   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBook.pys
   openOutputT s   c    s.   ] ^ _ |  i |  ` | i   a d Sd S(   s   Close the 'output' handle.N(   s   selfs
   fileFooters   outputs   close(   s   selfs   output(    (    se   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBook.pys   closeOutput] s   c    s!   c d |  i d |  e d  Sd  S(   Ns   file_header(   s   selfs   comments   output(   s   selfs   title1s   title2s   output(    (    se   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBook.pys
   fileHeaderc s   c    s!   g h |  i d |  i d  Sd  S(   Ns   file_footer(   s   selfs   comments   output(   s   selfs   output(    (    se   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBook.pys
   fileFooterg s   i    c    s6   m { | |  i |  } } |  i | |  ~ d Sd S(   sV  Format and write the 'text' to the 'output'.

        Arguments:

          'text' -- String to be written.

          'output' -- Stream to which 'text' should be written.

          'textFormat' -- Ignored.

          'quote=1' -- Boolean option to control whether the text
          should be quoted to escape special characters.

        N(   s   selfs   _unquoteStrings   texts   writeRaws   output(   s   selfs   texts   outputs
   textFormats   quote(    (    se   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBook.pys	   writeTextm s   c    sN      | d d d f j o  d | } n  t d |    | Sd S(   s7   Format 'text' as source code and return the new string.s   HTMLs   StructuredTexts	   PlainTexts&   <programlisting>
%s
</programlisting>
s2   DocBook formatter cannot handle sourcde code as %sN(   s
   textFormats   texts   formatted_texts
   ValueError(   s   selfs   texts
   textFormats   formatted_text(    (    se   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBook.pys
   formatCode s
   c    s      d | }  | Sd S(   s5   Format 'text' as a keyword and return the new string.s   <literal>%s</literal>N(   s   texts   formatted_text(   s   selfs   texts   formatted_text(    (    se   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBook.pys   formatKeyword s   i   c    s(      |  i d | |   d Sd S(   s   Output 'title' as a heading for a list.  If 'allowMultiColumn' is
        true, set up the list to have more than one column.
        s4   <formalpara>
<title>%s</title>
<para><itemizedlist>
N(   s   selfs   writeRaws   titles   output(   s   selfs   outputs   titles   allowMultiColumn(    (    se   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBook.pys
   listHeader s   c    s(      |  i d | |   d Sd S(   s/   Format and output the 'text' as a list element.s%   <listitem><para>%s</para></listitem>
N(   s   selfs   writeRaws   texts   output(   s   selfs   outputs   text(    (    se   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBook.pys   listItem s   c    s$      |  i d |   d Sd S(   s4   Write the closing footer for a list to the 'output'.s$   
</itemizedlist></para></formalpara>N(   s   selfs   writeRaws   output(   s   selfs   output(    (    se   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBook.pys
   listFooter s   c    s>      |  i d |  |   |  i d |   d Sd S(   sH   Write the 'title' as the heading for a descriptive list to the 'output'.s3   <formalpara><title>%s</title>
<para><variablelist>
s   descriptive list headerN(   s   selfs   writeRaws   titles   outputs   comment(   s   selfs   outputs   title(    (    se   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBook.pys   descriptiveListHeader s
   
c    sT      |  i d |  |   |  i | | |   |  i d |   d Sd S(   sU   Format and write the 'item' and 'description' for a descriptive list to the 'output'.s,   <varlistitem><term>%s</term><listitem><para>s!   </para></listitem></varlistitem>
N(   s   selfs   writeRaws   items   outputs	   writeTexts   descriptions   descriptionFormat(   s   selfs   outputs   items   descriptions   descriptionFormat(    (    se   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBook.pys   descriptiveListItem s   
c    s$      |  i d |   d Sd S(   s@   Write the closing footer for a descriptive list to the 'output'.s$   </variablelist></para></formalpara>
N(   s   selfs   writeRaws   output(   s   selfs   output(    (    se   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBook.pys   descriptiveListFooter s   c    s4      |  i d |  i | f  |   d Sd S(   s?   Write a general purpose section openning title to the 'output'.s   <sect%d>
<title>%s</title>N(   s   selfs   writeRaws   _section_level_counters   titles   output(   s   selfs   outputs   title(    (    se   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBook.pys   sectionHeader s   
c    s+      |  i d |  i |   d Sd S(   s?   Write a general purpose section closing footer to the 'output'.s	   </sect%d>N(   s   selfs   writeRaws   _section_level_counters   output(   s   selfs   output(    (    se   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBook.pys   sectionFooter s   c    s3      | i   }  |  i | |   d Sd S(   sD   Write a section openning header for an 'infoObject' to the 'output'.N(   s
   infoObjects   getNames   names   selfs   sectionHeaders   output(   s   selfs   outputs
   infoObjects   name(    (    se   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBook.pys
   itemHeader s   c    s!      |  i |   d Sd S(   s/   Write a section closing footer to the 'output'.N(   s   selfs   sectionFooters   output(   s   selfs   output(    (    se   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBook.pys
   itemFooter s   c    s!     |  i d |  _  d  Sd  S(   Ni   (   s   selfs   _section_level_counter(   s   selfs   output(    (    se   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBook.pys   pushSectionLevel s   c    s!     |  i d |  _  d  Sd  S(   Ni   (   s   selfs   _section_level_counter(   s   selfs   output(    (    se   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBook.pys   popSectionLevel s   s   -c    s      d Sd S(   sV   Write a sectional dividing line made up of repeated 'fill' characters to the 'output'.N(    (   s   selfs   outputs   fill(    (    se   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBook.pys   dividingLine s   c    s9      |  i o  |  i d | |  n  d Sd S(   s   Output text as a comment.s   <!-- %s -->
N(   s   selfs   debugs   writeRaws   texts   output(   s   selfs   texts   output(    (    se   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBook.pys   comment s    c    s!     |  i d |   d  Sd  S(   Ns   indent(   s   selfs   comments   output(   s   selfs   output(    (    se   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBook.pys   indent s   c    s!     |  i d |   d  Sd  S(   Ns   dedent(   s   selfs   comments   output(   s   selfs   output(    (    se   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBook.pys   dedent s   c    sQ      | o  |  i |  } n  h  | d <}  d | }  | Sd S(   sG   Returns a reference to the 'infoSource' from 'relativeSource'.
        s   names   <xref linkend="%(name)s">N(   s   names   selfs   getNameForInfoSources
   infoSources   infos   ref(   s   selfs
   infoSources   relativeSources   names   infos   ref(    (    se   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBook.pys   getReference s   c    s3     h  | i   d <} d | } | Sd  S(   Ns   names   <xref linkend="%(name)s">(   s
   infoSources   getNames   infos   ref(   s   selfs
   infoSources   names   relativeSources   infos   ref(    (    se   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBook.pys   getNamedReference s   c    s6   h  | i   d <} d | } | Sd S(   sI   Returns a reference to 'infoSource' within the current document.
        s   names   <xref linkend="%(name)s">N(   s
   infoSources   getNames   infos   ref(   s   selfs
   infoSources   infos   ref(    (    se   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBook.pys   getInternalReferences   c    s6   | |  i j o d t   Sn | Sd S(   s   Returns a reference to 'moduleName' documentation on the
       
        "Python.org":http://www.python.org documentation site.
        sd   <ulink url="http://www.python.org/doc/current/lib/module-%(moduleName)s.html">%(moduleName)s</ulink>N(   s
   moduleNames   selfs   sys_moduless   locals(   s   selfs
   moduleName(    (    se   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBook.pys   getPythonReferences   c    s   d Sd S(   s0   Returns the extension for creating output files.s   sgmlN(    (   s   self(    (    se   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBook.pys   getFilenameExtensions   c    s   d Sd  S(   Ns	   book.sgml(    (   s   self(    (    se   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBook.pys   getRootNodeNames   (    s   __doc__s   __init__s
   openOutputs   closeOutputs
   fileHeaders
   fileFooters	   writeTexts
   formatCodes   formatKeywords   Nones
   listHeaders   listItems
   listFooters   descriptiveListHeaders   descriptiveListItems   descriptiveListFooters   sectionHeaders   sectionFooters
   itemHeaders
   itemFooters   pushSectionLevels   popSectionLevels   dividingLines   comments   indents   dedents   getReferences   getNamedReferences   getInternalReferences   getPythonReferences   getFilenameExtensions   getRootNodeName(    (    (    se   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBook.pys   DocBookFormatterI s>   				
(   s   __doc__s   __rcs_info__s   splits   __version__s   happydoclibs'   happydoclib.formatter.fileformatterbases
   entryPoints	   formatters   fileformatterbases   FileBasedFormatters   DocBookFormatter(   s   __version__s
   entryPoints   DocBookFormatters   happydoclibs   __rcs_info__(    (    se   /home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBook.pys   ? s   Q