U C^.@sdZdZddlZddlZddlmZmZmZmZddl m Z ddl m Z Gdddej j Z Gd d d ej jZGd d d ej jZdS) a/ Simple HyperText Markup Language document tree Writer. The output conforms to the XHTML version 1.0 Transitional DTD (*almost* strict). The output contains a minimum of formatting information. The cascading style sheet "html4css1.css" is required for proper viewing with a modern graphical browser. ZreStructuredTextN)frontendnodeswritersio) writer_aux) _html_basec@s eZdZdZdgZdejeje ejej ejeje dgZ dZ ej ejeje e Z ddde d ge d d fd d gddejdfdd edgddejedfddgddejdfddgddd fd!e d"gd#eje d$fd%d&gd'd(d)d*fd+d,gd-d)ejd.fd/d0gd-d)ejd.fd1d2gd3d4gd4d5d6d7fd8d9gd:d;dd?gddejdfd@dAgdBdd fdCdDgddejdfdEdFgdGdd fdHdIgdJdKifdLdMgdJdNifdOdPgdQddejdRfdSdTgdejdUfffZdVZdWdXZdS)YWriter)htmlZhtml4Z html4css1ZxhtmlZxhtml10z html4css1.css.Zhtml5_polyglotz template.txtzHTML-Specific OptionsNz)defaultmetavarzhComma separated list of stylesheet URLs. Overrides previous --stylesheet and --stylesheet-path settings.z --stylesheetzZstylesheet_path)r overrides validatorzComma separated list of stylesheet paths. Relative paths are expanded if a matching file is found in the --stylesheet-dirs. With --link-stylesheet, the path is rewritten relative to the output HTML file. Default: "%s",z--stylesheet-pathzZ stylesheet)r r rr zEmbed the stylesheet(s) in the output HTML file. The stylesheet files must be accessible during processing. This is the default.z--embed-stylesheet store_true)r actionrzNLink to the stylesheet(s) in the output HTML file. Default: embed stylesheets.z--link-stylesheetZembed_stylesheet store_false)destrzComma-separated list of directories where stylesheets are found. Used by --stylesheet-path when expanding relative path arguments. Default: "%s"z--stylesheet-dirsz)r rr z|Specify the initial header level. Default is 1 for "

". Does not affect document title & subtitle (see --no-doc-title).z--initial-header-levelz 1 2 3 4 5 61z)choicesr r zSpecify the maximum width (in characters) for one-column field names. Longer field names will span an entire row of the table used to render the field list. Default is 14 characters. Use 0 for "no limit".z--field-name-limit)r r rzSpecify the maximum width (in characters) for options in option lists. Longer options will span an entire row of the table used to render the option list. Default is 14 characters. Use 0 for "no limit".z--option-limitz[Format for footnote references: one of "superscript" or "brackets". Default is "brackets".z--footnote-references superscriptbracketszZtrim_footnote_reference_space)rr r r z{Format for block quote attributions: one of "dash" (em-dash prefix), "parentheses"/"parens", or "none". Default is "dash".z --attributiondash parenthesesparensnonezpRemove extra vertical whitespace between items of "simple" bullet lists and enumerated lists. Default: enabled.z--compact-listsz3Disable compact simple bullet and enumerated lists.z--no-compact-lists compact_listszXRemove extra vertical whitespace between items of simple field lists. Default: enabled.z--compact-field-listsz#Disable compact simple field lists.z--no-compact-field-listscompact_field_listszJAdded to standard table classes. Defined styles: "borderless". Default: ""z --table-styler z[Math output format, one of "MathML", "HTML", "MathJax" or "LaTeX". Default: "HTML math.css"z --math-outputz HTML math.cssz,Omit the XML declaration. Use with caution.z--no-xml-declarationxml_declaration)rr rrzyObfuscate email addresses to confuse harvesters while still keeping email links usable with standards-compliant browsers.z--cloak-email-addresses)rrzhtml4css1 writercCsi|_t|_dSN)partsHTMLTranslatorZtranslator_classselfr'I/tmp/pip-install-6_kvzl1k/docutils/docutils/writers/html4css1/__init__.py__init__szWriter.__init__)__name__ __module__ __qualname__ supportedZdefault_stylesheetsospathabspathdirname__file__joinZdefault_stylesheet_dirsZdefault_templateZdefault_template_pathrZvalidate_comma_separated_listZvalidate_booleansplitZvalidate_nonnegative_intZ settings_specZconfig_sectionr)r'r'r'r(rs    drc@sjeZdZdZdZdZdZeej j Z de d<dddd d Z d d Z d dZ ddZddZddZddZddZddZddZddZdd Zd!d"Zd#d$Zd%d&Zd'd(Zd)d*Zd+d,Zd-d.Zd/d0Zdd2d3Zd4d5Z d6d7Z!d8d9Z"d:d;Z#dd?Z%d@dAZ&dBdCZ'dDdEZ(dFdGZ)dHdIZ*dJdKZ+dLdMZ,dNdOZ-dPdQZ.dRdSZ/dTdUZ0dVdWZ1dXdYZ2dZd[d\Z3d]d^Z4d_d`Z5dadbZ6dcddZ7dedfZ8dgdhZ9didjZ:dkdlZ;dmdnZdsdtZ?dudvZ@dwdxZAdydzZBd{d|ZCd}d~ZDddZEddZFddZGddZHddZIddZJddZKddZLddZMddZNddZOddZPdS)r$aH The html4css1 writer has been optimized to produce visually compact lists (less vertical whitespace). HTML's mixed content models allow list items to contain "
  • body elements

  • " or "
  • just text
  • " or even "
  • text

    and body elements

    combined
  • ", each with different effects. It would be best to stick with strict body elements in list items, but they affect vertical spacing in older browsers (although they really shouldn't). The html5_polyglot writer solves this using CSS2. Here is an outline of the optimization: - Check for and omit

    tags in "simple" lists: list items contain either a single paragraph, a nested simple list, or a paragraph followed by a nested simple list. This means that this list can be compact: - Item 1. - Item 2. But this list cannot be compact: - Item 1. This second paragraph forces space between list items. - Item 2. - In non-list contexts, omit

    tags on a paragraph if that paragraph is the only child of its parent (footnotes & citations are allowed a label first). - Regardless of the above, in definitions, table cells, field bodies, option descriptions, and list items, mark the first child with 'class="first"' and the last child with 'class="last"'. The stylesheet sets the margins (top & bottom respectively) to 0 for these elements. The ``no_compact_lists`` setting (``--no-compact-lists`` command-line option) disables list whitespace optimization. zz zC zO  )z—r )())r r )rrrrcCs ||dd||dddS)Nfirstrlast)set_class_on_childr&noder'r'r(set_first_lastszHTMLTranslator.set_first_lastcCs,|j|ddd|j|j|ddddS)NaddressF)metapreCLASS)visit_docinfo_itembodyappendstarttagr=r'r'r( visit_addressszHTMLTranslator.visit_addresscCs2|ddd|j||d||dS)NclassesrZ admonitiondiv)insertrFrGrHr?r=r'r'r(visit_admonitionszHTMLTranslator.visit_admonitioncCs2t|jtjr"|jr.|jdn ||ddS)Nz
    author) isinstanceparentrauthorsauthor_in_authorsrFrGrEr=r'r'r( visit_authorszHTMLTranslator.visit_authorcCs"t|jtjrd|_n|dS)NT)rOrPrrQrRdepart_docinfo_itemr=r'r'r( depart_authorszHTMLTranslator.depart_authorcCs||dd|_dS)NrQF)rErRr=r'r'r( visit_authorss zHTMLTranslator.visit_authorscCs |dSr")rTr=r'r'r(depart_authorsszHTMLTranslator.depart_authorscCs&|j||jj|jddS)NZstub)colspecsrGrPZstubs attributesgetr=r'r'r( visit_colspecs zHTMLTranslator.visit_colspeccCst|jdddtjrdSd|jjdksFd|jjkrJd|jjdkrJdStdd|jD}|j | |d |jD]8}t |d d |d }|j |j |d d|dqx|j ddS)NFT)ZdescendZsiblingszcolwidths-autorJzcolwidths-givencss|]}|dVqdS)colwidthNr').0r>r'r'r( sz0HTMLTranslator.depart_colspec..colgroupr\gY@g?colz%i%%)widthz )rOZ next_noderZcolspecrPsettings table_stylesumrXrFrGrHintZemptytag)r&r>Z total_widthr\r'r'r(depart_colspecs$   zHTMLTranslator.depart_colspeccCs<d|dkp:|jjo:d|dko:|jp:|jdgkp:||S)NcompactrJopencontents)rbrcompact_simpleZ topic_classesZcheck_simple_listr=r'r'r(is_compactables   zHTMLTranslator.is_compactablec Cs6|j|j|ddddd|jd||dS)Ntablezdocutils citationvoidrrDframerulesK rFrGrHfootnote_backrefsr=r'r'r(visit_citations zHTMLTranslator.visit_citationcCs|jddSNz rFrGr=r'r'r(depart_citation'szHTMLTranslator.depart_citationcCs*|jd|j|j|dddddS)Nz- : spanr classifierrCrFrGrHr=r'r'r(visit_classifier,s zHTMLTranslator.visit_classifiercCs0|jd|j||dd||dS)Nz ddr rFrGrHr?r=r'r'r(visit_definition1s zHTMLTranslator.visit_definitioncCs|j|j|ddddS)NdldocutilsrCrzr=r'r'r(visit_definition_list7sz$HTMLTranslator.visit_definition_listcCs$|j||dd||dS)Ntdr r}r=r'r'r(visit_description;sz HTMLTranslator.visit_descriptioncCs|jddS)Nzrvr=r'r'r(depart_description?sz!HTMLTranslator.depart_descriptionc CsD|jt|j|j|j|ddddd|jdd|_dS)NrldocinformrrnzR T)contextrGlenrFrH in_docinfor=r'r'r( visit_docinfoCs zHTMLTranslator.visit_docinfocCs6|jdd|_|j}|j|d|_g|_dS)N F)rFrGrrpopr)r&r>startr'r'r(depart_docinfoMs   zHTMLTranslator.depart_docinfoTcCs|r$d|||f}|||j||dd|jd|jj|t|rt |dt j r||dddt |dt j r|ddd dS) Nz trr z&%s: rrJr9r;r:) ZattvalastextZadd_metarFrGrHlanguagelabelsrrOrElement)r&r>namerAZmeta_tagr'r'r(rETs  z!HTMLTranslator.visit_docinfo_itemcCs|jddS)Nz rvr%r'r'r(rTbsz"HTMLTranslator.depart_docinfo_itemcCs|j|j|ddddS)NrBz doctest-blockrCrzr=r'r'r(visit_doctest_blockfsz"HTMLTranslator.visit_doctest_blockcCs6tjj||t|dkr(|jd||dS)Nrr5)rrr$ visit_entryrrFrGr?r=r'r'r(rjs  zHTMLTranslator.visit_entrycCsi}d|kr|d|d<d|kr,|d|d<|j}|j|j|jfd|_|||_|jrz|sz|ddd|d<|j|j|df|dS)z The 'start' attribute does not conform to HTML 4.01's strict.dtd, but cannot be emulated in CSS1 (HTML 5 reincludes it). rZenumtypeclassNr z simpleol) rjrrG compact_prkrZstriprFrH)r&r>attsZold_compact_simpler'r'r(visit_enumerated_listqs    z$HTMLTranslator.visit_enumerated_listcCs"|j\|_|_|jddS)Nz )rrrjrrFrGr=r'r'r(depart_enumerated_listsz%HTMLTranslator.depart_enumerated_listcCs|j|j|dddddS)Nrr fieldrCrzr=r'r'r( visit_fieldszHTMLTranslator.visit_fieldcCs|jddSN rvr=r'r'r( depart_fieldszHTMLTranslator.depart_fieldcCsn|j|j|dddd||dd|j}|js\t|jtjs\|j |t |jdkrj||dd dS) Nrr z field-bodyrCr9rrr:r;) rFrGrHr<rPcompact_field_listrOrrindexr)r&r>rr'r'r(visit_field_bodys zHTMLTranslator.visit_field_bodycCs|jddS)Nz rvr=r'r'r(depart_field_bodysz HTMLTranslator.depart_field_bodyc Cs|j|j|jfd|_d|dkr.d|_n|jjrHd|dkrHd|_|jr|D]b}|d}t|tjsnt dd|D}t |dksRt |d krt|dtj tj fsRd |_qqR|j |j|d d d dd|j ddS)NrgrJTrhr;cSsg|]}t|tjs|qSr')rOr Invisibler]nr'r'r( s z3HTMLTranslator.visit_field_list..rrFrlrmrzdocutils field-list)rorprDzK )rrGrrrbrrOr field_bodyAssertionErrorr paragraphZ line_blockrFrH)r&r>rrchildrenr'r'r(visit_field_lists6     zHTMLTranslator.visit_field_listcCs"|jd|j\|_|_dSNr)rFrGrrrrr=r'r'r(depart_field_lists z HTMLTranslator.depart_field_listc Csi}|jrd|d<nd|d<|jjrft||jjkrfd|d<|jd|j|jddd d d n |jd|j |j|d df|dS) Nz docinfo-namerz field-namecolspanrrr rrCz th) rrbZfield_name_limitrrrrGrHrPrFr&r>rr'r'r(visit_field_names"   zHTMLTranslator.visit_field_namecCs"|jd|j|jdS)Nz:rFrGrrr=r'r'r(depart_field_names z HTMLTranslator.depart_field_namec Cs6|j|j|ddddd|jd||dS)Nrlzdocutils footnotermrrnrqrrr=r'r'r(visit_footnotes zHTMLTranslator.visit_footnotecCsg}|d}|jjr|rt|dkrR|jd|jd|jd|dqt|dD]\}}|d||fq\|jdd ||jddg7_n|jd|jddg7_t|dkr|s|dd d |d d d dS)Nbackrefsrr z!rz'%sz(%s) , rJr9r;r:)rbZfootnote_backlinksrrrG enumerater3)r&r> backlinksribackrefr'r'r(rss*      z HTMLTranslator.footnote_backrefscCs|jddSrurvr=r'r'r(depart_footnoteszHTMLTranslator.depart_footnotec Csjd|d}|jj}|dkr.d}|jdn|dks:td}|jd|j|j|d |d |d dS) N#Zrefidr[]rzazfootnote-reference)rDhref)rbZfootnote_referencesrrGrrFrH)r&r>rformatsuffixr'r'r(visit_footnote_references   z'HTMLTranslator.visit_footnote_referencecCs|j|jddS)Nrrr=r'r'r(depart_footnote_reference sz(HTMLTranslator.depart_footnote_referencecCsdSr"r'r=r'r'r(visit_generated szHTMLTranslator.visit_generatedz image/svg+xmlzapplication/x-shockwave-flash)z.svgz.swfcCs(|j|j|dd|jdddS)Nrz%s[labelrC)rFrGrHrrr=r'r'r( visit_labelszHTMLTranslator.visit_labelcCs$|jd|j|jfdS)Nz]%s%srr=r'r'r( depart_labelszHTMLTranslator.depart_labelcCs4|j||ddt|r0|ddddS)Nlir rrJr9)rFrGrHrr=r'r'r(visit_list_item!szHTMLTranslator.visit_list_itemcCs|dg}d|kr@dd|D|d<|j||dddS|j|j|dddd|}|j|D]v}|r|j |r|jd | |q|j| |qn|d kr|j|qn|jd t |d d qn|jdt j dS)NrJcodecSsg|]}|dkr|qS)rr')r]clsr'r'r(r-sz0HTMLTranslator.visit_literal..r ttzdocutils literalrCz%s)  r5rrz)rZrFrGrHrZwords_and_spacesfindallrZin_word_wrap_pointsearchencoderrSkipNode)r&r>rJtexttokenr'r'r( visit_literal(s*   zHTMLTranslator.visit_literalcCs|j|j|ddddS)NrBz literal-blockrCrzr=r'r'r(visit_literal_blockGsz"HTMLTranslator.visit_literal_blockcCs|jddS)Nz rvr=r'r'r(depart_literal_blockKsz#HTMLTranslator.depart_literal_blockcCs~i}|jjr6t||jjkr6d|d<|jdn |jd|j|j|dfddi||jd|jd dS) Nrrz  r rrDz option-groupzr)rbZ option_limitrrrrGrFrHrr'r'r(visit_option_groupOs  z!HTMLTranslator.visit_option_groupcCs,|j|jd|j|jdS)Nz )rrrFrGr=r'r'r(depart_option_group\s  z"HTMLTranslator.depart_option_groupc Cs,|j|j|ddddd|jddS)Nrlzdocutils option-listrmrrnzH rzr=r'r'r(visit_option_listas z HTMLTranslator.visit_option_listcCs|jddSrrvr=r'r'r(depart_option_listisz!HTMLTranslator.depart_option_listcCs|j||dddS)Nrr rzr=r'r'r(visit_option_list_itemlsz%HTMLTranslator.visit_option_list_itemcCs|jddSrrvr=r'r'r(depart_option_list_itemosz&HTMLTranslator.depart_option_list_itemcCst|jtjst|jtjr dS|D]8\}}||r(|dkrZ|gdgdgddgfks(dSq(t|jdtj}|jj|dD]"}t|tj rq||krqdSt dd|jD}|j s|j s|j r|d krd SdS) zU Determine if the

    tags around paragraph ``node`` can be omitted. FrJr9r:rNcSs"g|]}t|tjtjfs|qSr')rOrrrrr'r'r(rs  z>HTMLTranslator.should_be_compact_paragraph..rT)rOrPrdocumentZcompoundattlistZis_not_defaultrrrrrjrr)r&r>keyvaluer9childZ parent_lengthr'r'r(should_be_compact_paragraphts<   z*HTMLTranslator.should_be_compact_paragraphcCs>||r|jdn"|j||dd|jddS)Nr p

    )rrrGrFrHr=r'r'r(visit_paragraphs zHTMLTranslator.visit_paragraphcCs|j|jdSr"rr=r'r'r(depart_paragraphszHTMLTranslator.depart_paragraphcCs,|j|j|ddd||d|_dS)NrKsidebarrCT)rFrGrHr?Z in_sidebarr=r'r'r( visit_sidebars  zHTMLTranslator.visit_sidebarcCsDt|jtjr*|j|j|ddddn|j||dddS)Nrxr Z subscriptrCsubrOrPr literal_blockrFrGrHr=r'r'r(visit_subscripts  zHTMLTranslator.visit_subscriptcCs,t|jtjr|jdn |jddS)NzrOrPrrrFrGr=r'r'r(depart_subscriptszHTMLTranslator.depart_subscriptc Cst|jtjr6|j|j|dddd|jdnt|jtjrx|j|j|dddd|jdt |j|_ n^t|jtj rd |j |j d }|j|j||dd d|jid dd d|jd |dS)Nrr zsidebar-subtitlerCrh2subtitlez

    zh%srzsection-subtitlerxz )rOrPrrrFrGrHrrrin_document_titlesectionZ section_levelZinitial_header_level)r&r>tagr'r'r(visit_subtitles" zHTMLTranslator.visit_subtitlecCs\|j|j|jrX|j|jd|_d|_|j|j|j|j|jdd=dS)Nr;r) rFrGrrrrZbody_pre_docinfoextendZ html_subtitler=r'r'r(depart_subtitleszHTMLTranslator.depart_subtitlecCsDt|jtjr*|j|j|ddddn|j||dddS)Nrxr rrCsuprr=r'r'r(visit_superscripts  z HTMLTranslator.visit_superscriptcCs,t|jtjr|jdn |jddS)Nrrrr=r'r'r(depart_superscriptsz!HTMLTranslator.depart_superscriptc Cs|j|j|ddd|jdd}t|dr|d}t|dkrVd|d }n:d}g}|D]}|d ||f|d7}qbd d |}|d rd|d }nd}|jd|d|d||d||fdS)NrKzsystem-messagerCz

    r rrz%; backlinkrz%sz; backlinks: %srlinez , line %sz=System Message: %s/%s (%s%s)%s

    typelevelsource)rFrGrHrr3hasattrr)r&r>Z backref_textrrrrrr'r'r(visit_system_messages6       z#HTMLTranslator.visit_system_messagecCs|j|jd|_ddi}d|jjg}d|krB|d|dd|krZd|d|d <|j|j|d fd d |i|dS) NTZborderrrZalignzalign-%sraz width: %sstylerlrDr)rrGrrbrcrFrHr3)r&r>rrJr'r'r( visit_tables zHTMLTranslator.visit_tablecCs|j|_|jddS)Nz )rrrrFrGr=r'r'r( depart_tables zHTMLTranslator.depart_tablecCs|j|j|ddddS)NtbodytopZvalignrzr=r'r'r( visit_tbodyszHTMLTranslator.visit_tbodycCs|jddS)Nz rvr=r'r'r( depart_tbody szHTMLTranslator.depart_tbodycCs|j|j|ddddS)NtheadZbottomrrzr=r'r'r( visit_thead szHTMLTranslator.visit_theadcCs|jddS)Nz rvr=r'r'r( depart_theadszHTMLTranslator.depart_theadN)T)Qr*r+r,__doc__doctype content_typeZcontent_type_mathmldictrr$Zspecial_charactersZattribution_formatsr?rIrMrSrUrVrWr[rfrkrtrwr{r~rrrrrrErTrrrrrrrrrrrrrrsrrrrZobject_image_typesrrrrrrrrrrrrrrrrrrrrrrrr r rrrrr'r'r'r(r$s.           r$c@s0eZdZdZddZddZddZdd Zd S) SimpleListCheckerz Raise `nodes.NodeFound` if non-simple list item is encountered. Here "simple" means a list item containing nothing other than a single paragraph, a simple list, or a paragraph followed by a simple list. cCs|g}|jD]}t|tjs ||q |rbt|dtjrbt|dtjsZt|dtjrb|t |dkrrdStj dS)Nrr;r) rrOrrrGrZ bullet_listZenumerated_listrr NodeFound)r&r>rrr'r'r(rs    z!SimpleListChecker.visit_list_itemcCs tjdSr")rrr=r'r'r(r1sz!SimpleListChecker.visit_paragraphcCs tjdSr"rrr=r'r'r(r4sz'SimpleListChecker.visit_definition_listcCs tjdSr"rr=r'r'r(r7szSimpleListChecker.visit_docinfoN)r*r+r,rrrrrr'r'r'r(rs r)rZ __docformat__os.pathr.rrrrrZdocutils.transformsrZdocutils.writersrrr$rr'r'r'r(s   |