- adei i i fdYZ dS(sXXML DocBook formatter. All files contains XML and doctype declaration, so every document is a valid XML file. This way, it is possible to use every file separately. Every index file indicates a chapter. Every module or class document indicates section. It was tested with libxml 2.4.10 and libxslt 1.0.6 (http://xmlsoft.org). Use your favourite XML and XSLT processors with XInclude support. Example: happydoc -T mstruct -F docbookx my_module formatter_encoding=utf-8 xsltproc --xinclude my_custom_docbook_to_html.xsl my_module/index.docb > my_module.html N(s*s#$RCSfile: formatter_DocBookX.py,v $s module_nameswrobell screatorsHappyDocsprojects 24-08-2001screateds$Author: wrobell $sauthors$Revision: 1.5 $sversions$Date: 2002/02/07 01:21:03 $sdatecs#678hdd<tddZ@BdddddZhdZxdZ~dZd Zd Zd Zd Zd Z dZ dZ dZ dZ dZ dZRS(sXML DocBook formatter. ss iso-8859-1sindexsxmlc szBVXttiiiiY|||||f|Zd|_ [||_ ]hdt <dt<dt<|_dS(sInitialize the XMLDocBookFormatter. Parameters 'docset' -- the DocSet instance containing global cross-reference information 'title' -- documentation title 'encoding' -- documentation file encoding (default 'iso-8859-1') 'index_file_name' -- package index filename (default 'index') 'file_name_ext' -- documentation filename extension (default 'xml') '**conf' -- additional, optional, configuration values sdocbschapterssectionN(sapplys happydoclibs formattersxmlformatterbases XMLFormatters__init__sselfsdocsetsencodingsindex_file_names file_name_extsconfstitles INDEX_FILEs MODULE_FILEs CLASS_FILEsdoctypes(sselfsdocsetstitlesencodingsindex_file_names file_name_extsconf((sf/home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBookX.pys__init__Bs   cshjk|tjo?l|id|i|m|id|i||no|tjop|tjoMq|i d|hdd<r|i os|i d|i |nn(t|t jou|i d|nndS(s;XMLFormatter class abstract method implementation. s$ sx schaptershttp://www.w3.org/2001/XIncludesxmlns:xistitleN(sstagesSTARTsselfswriteRaws getEncodingsoutputsdoctypessrtypes INDEX_FILEstagstitleswriteTaggedTextsENDsendTag(sselfsoutputsstagesrtype((sf/home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBookX.pys processRooths" !cs xz{dS(s;XMLFormatter class abstract method implementation. N((sselfsinfosoutputsstage((sf/home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBookX.pysprocessPackagexscs~|tjoh|id|hdd<|i}ti |ddd }|i dd||n(|t jo|i d|nd S( s;XMLFormatter class abstract method implementation. ssectionshttp://www.w3.org/2001/XIncludesxmlns:xis/s.istitles Module %sN( sstagesSTARTsselfstagsoutputsinfosgetFullyQualifiedNamesnamesstringsreplaceswriteTaggedTextsENDsendTag(sselfsinfosoutputsstagesname((sf/home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBookX.pys processModule~scs dS(s;XMLFormatter class abstract method implementation. N((sselfsinfosoutputsstage((sf/home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBookX.pysprocessDocStringscs|tjo=|id||id||id|n|tjo=|id||id||i||nu|tjo*|i d||i d|n;|t jo*|i d||i d|ndS(s;XMLFormatter class abstract method implementation. sparas"Imported modules and (or) symbols:s itemizedlistslistitemN( sstagesPREsselfstagsoutputs writeTextsSTARTsiinfosENDsendTagsPOST(sselfsiinfosminfosoutputsstage((sf/home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBookX.pys processImportscs|tjoet|djo|ddjo|id|n$|idti|d|ndS(s;XMLFormatter class abstract method implementation. iis*s - all symbolss- %ss,N( sstagesSTARTslensinfosselfs writeTextsoutputsstringsjoin(sselfsinfosoutputsstage((sf/home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBookX.pysprocessImportSymbols 'csx|tjo7|id||idd|i|n(|tjo|i d|ndS(s;XMLFormatter class abstract method implementation. ssectionstitlesClass %sN( sstagesSTARTsselfstagsoutputswriteTaggedTextsinfosgetNamesENDsendTag(sselfsinfosoutputsstage((sf/home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBookX.pys processClasss $cs|tjo=|id||id||id|n|tjor|id|t|t jo |}n|i }|i d|||i d|n;|tjo*|i d||i d|ndS(s;XMLFormatter class abstract method implementation. sparasRaised exceptions:s itemizedlistslistitemN(sstagesPREsselfstagsoutputs writeTextsSTARTstypeseinfos StringTypesnamesgetNameswriteTaggedTextsendTagsPOST(sselfseinfosoutputsstagesname((sf/home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBookX.pysprocessExceptions cs|tjoY|id||id||id||id|i|nN|tjo=|i d||i d||i d|ndS(s;XMLFormatter class abstract method implementation. s funcsynopsiss funcprototypesfuncdefsfunctionN( sstagesSTARTsselfstagsoutputswriteTaggedTextsinfosgetNamesENDsendTag(sselfsinfosoutputsstage((sf/home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBookX.pysprocessFunctions cs|tjo=|id||id||id|n|tjo=|id||id||i||nu|tjo*|i d||i d|n;|t jo*|i d||i d|ndS(s;XMLFormatter class abstract method implementation. sparas Derives from:s itemizedlistslistitemN( sstagesPREsselfstagsoutputs writeTextsSTARTscinfosENDsendTagsPOST(sselfsinfoscinfosoutputsstage((sf/home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBookX.pysprocessClassBasesc s|tjos|\}}}}}|i d||o$|i dd||f|n|i d||n(|t jo|i d|ndS(s;XMLFormatter class abstract method implementation. sparamdefs parameters%s=%sN(sstagesSTARTsinfosnamesfinfosdefault_specifieds default_valuesdefault_value_typesselfstagsoutputswriteTaggedTextsENDsendTag( sselfsinfosoutputsstages default_valuesnamesdefault_specifiedsdefault_value_typesfinfo((sf/home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBookX.pys processParams $csGtii|i|}|id|h|d<dS(s;XMLFormatter class abstract method implementation. s xi:includeshrefN( sosspathsbasenamesselfsgetOutputNameForObjects class_infosnamesemptyTagsoutput(sselfs class_infosoutputsname((sf/home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBookX.pys classIndexscsGtii|i|}|id|h|d<dS(s;XMLFormatter class abstract method implementation. s xi:includeshrefN( sosspathsbasenamesselfsgetOutputNameForObjects module_infosnamesemptyTagsoutput(sselfs module_infosoutputsname((sf/home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBookX.pys moduleIndexscsw  |io|i}n|i}d||idf}|id|h|d<dS(s;XMLFormatter class abstract method implementation. s%s/%s#%ssxpointer(/chapter/section)s xi:includeshrefN( s package_infosgetNamespnames getFilenamesselfsgetIndexFileNamesnamesemptyTagsoutput(sselfs package_infosoutputspnamesname((sf/home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBookX.pys packageIndex s (s__doc__s__init__s processRootsprocessPackages processModulesprocessDocStrings processImportsprocessImportSymbols processClasssprocessExceptionsprocessFunctionsprocessClassBases processParams classIndexs moduleIndexs packageIndex(((sf/home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBookX.pysXMLDocBookFormatter>s &          (s__doc__sos.pathsossstringstypess&happydoclib.formatter.xmlformatterbases happydoclibs happydoclib.docset.mstruct_consts __rcs_info__s entryPoints formattersxmlformatterbases XMLFormattersXMLDocBookFormatter(s entryPointsXMLDocBookFormatters __rcs_info__soss happydoclibsstring((sf/home/dhellmann/Personal/Devel/HappyDoc/dist/HappyDoc-r2_1/happydoclib/formatter/formatter_DocBookX.pys?s      H