o i*@sdZddlmZdZddlZddlZddlZddlZddlZddl Z ddl m m Z ddlmZddlZddlmZmZmZmZmZddlmZddlmZdd lmZdd lmZmZmZm Z m!Z!m"Z"d Z#e#rodd lm$Z$Gd ddej%Z%Gdddej&Z'Gdddej(Z)dS)z-Common definitions for Docutils HTML writers.) annotationsreStructuredTextN)Path)frontend languagesnodesutilswriters) length_or_percentage_or_unitless)PIL) writer_aux) latex2mathml math2htmltex2mathml_extern unichar2texwrap_math_code MathErrorF) TransformcseZdZdZ ddddgddifdd gd d ejd fd dgddejd fddgdejdfddgddejdfddgdddfdd gd!d"d#d$fd%d&gd'd(gd(d)d*d+fd,d-ggd.d/d)d$fd0d1gddejdfd2d3gd4ddfd5d6gddejdfd7d8gd9ddfd:d;gdfd?d@gdAdBejdCfdDdEgdFdejdfdGdHgdIddfdJdKgdejdLfffZ dMdNiZ dOZ dPZ dQZ dRZdafdUdV ZdbdXdYZdcd[d\Zd]d^Zdbfd_d` ZZS)dWriter)htmlxhtmlzHTML Writer OptionsNzFSpecify the template file (UTF-8 encoded). (default: writer dependent)z --templatemetavarzzhComma separated list of stylesheet URLs. Overrides previous --stylesheet and --stylesheet-path settings.z --stylesheetzstylesheet_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: writer dependent)z--stylesheet-pathz stylesheetzComma-separated list of directories where stylesheets are found. Used by --stylesheet-path when expanding relative path arguments. (default: writer dependent)z--stylesheet-dirsz)rrzvEmbed the stylesheet(s) in the output HTML file. The stylesheet files must be accessible during processing. (default)z--embed-stylesheetT store_true)defaultactionrz3Link to the stylesheet(s) in the output HTML file. z--link-stylesheetembed_stylesheet store_false)destrz}Specify the initial header level. Does not affect document title & subtitle (see --no-doc-title).(default: writer dependent).z--initial-header-levelz 1 2 3 4 5 62z)choicesrrzYFormat for footnote references: one of "superscript" or "brackets". (default: "brackets")z--footnote-references superscriptbracketsztrim_footnote_reference_space)r#rrrzyFormat for block quote attributions: one of "dash" (em-dash prefix), "parentheses"/"parens", or "none". (default: "dash")z --attributiondash parenthesesparensnoner(zgRemove extra vertical whitespace between items of "simple" bullet lists and enumerated lists. (default)z--compact-listsz3Disable compact simple bullet and enumerated lists.z--no-compact-lists compact_listszORemove extra vertical whitespace between items of simple field lists. (default)z--compact-field-listsz#Disable compact simple field lists.z--no-compact-field-listscompact_field_listszClass value(s) assigned to all tables. Defined styles: borderless, booktabs, align-left, align-center, align-right, colwidths-auto, colwidths-grid.z --table-stylez z [^ \n]+| +|\nz.+\W\W.+|[-?].+lang&z&z>@@)z video/mp4z video/webmz video/oggrFrRcst|j}t|j|j_t|j _ d}t |dddur3|j r'd}t j d|dtddt |d|_tjjtrJtjjj_jj\__g_d g_g_d g_g_g_g_g_g_g_g_ j!g_"g_#g_$g_%j&g_'fd d t()|D_*g_+g_,|j-rj.t(-|j/j#.t(-d |j/r|j/0dkrƈj'1dj!|j/g_2 d_3g_4d_5d_6d_7d_8d_9d_:d_;d_dS)Nlink embed_imagesembedz`The configuration setting "embed_images" will be removed in Docutils 2.0. Use "image_loading: z".) stacklevel image_loadingz z csg|]}|qSrP)stylesheet_call).0pathrLrPrQ Psz+HTMLTranslator.__init__..z%sunicoderTF)?rI__init__rbr get_language language_codereporterlanguageintinitial_header_levelrYrwarningswarn FutureWarningr isinstance math_outputr^rrz math_optionsr9r6r7r:r8r>r@r5r4r=rE content_typerBrArDrC generatorr?rget_stylesheet_listrr;r<r0appendrjlowerinsertcontext section_levelcolspecs compact_pcompact_simplecompact_field_list in_docinfo in_sidebarin_document_title in_mailtoauthor_in_authors math_headermessages)rMrTrb_image_loading_defaultrNrLrQr$s      zHTMLTranslator.__init__cCs6d|j|j|j|j|j|j|j|jSrn) rhr4r5rr6r7r8r9r:rLrPrPrQastextvszHTMLTranslator.astextz[ ]cCs<||d|}|jr|jjr|dd}|dd}|S)z6Cleanse, HTML encode, and return attribute value text. %40z%40.z.)encodesubrrbcloak_email_addressesreplace)rMtext whitespaceencodedrPrPrQattval|s   zHTMLTranslator.attvalcCs|dd}|ddS)z;Try to hide the link text of a email link from harversters.rz@rz.r)rMaddrrPrPrQ cloak_emails  zHTMLTranslator.cloak_emailcCs |ddS)z*Try to hide a mailto: URL from harvesters.rrr)rMurirPrPrQ cloak_mailtos zHTMLTranslator.cloak_mailtocCst|}||jS)z-Encode special characters in `text` & return.)r^r]special_characters)rMrrPrPrQrs zHTMLTranslator.encodenode nodes.imagedict[str, str]c Csd}i}|D]}||vrt||||<qd|vr;t|dkr;||}|r;t||D]\}}||vr:|df||<q,|ddd}i}g} |D]"\}\}} ||9}| rf| |d|d| dqKt|||<qK| rwd | |d <|S) aDetermine the image size from node arguments or the image file. Return as dictionary of attributes, e.g., ``{height': '32', 'style': 'width: 4 em;'}``. Auxiliary method called from `self.visit_image()`. Provisional. widthheightscaler.d: g;rstyle) r parse_measurelenread_size_with_PILzipgetitemsrroundrh) rMr dimensionsmeasures dimensionimgsizevaluescaling_factor size_atts declarationsunitrPrPrQ image_sizes0   zHTMLTranslator.image_sizetuple[int, int] | Nonec Csg}|d}ts |dt|d|jvr|d|jjs%|d|skz ||}tj | }|j }Wdn1sAwYWnt t t fyc}z |t|WYd}~n d}~ww|jj||rdd|dg|}|j|jjjd ||d dS|S) Nrz Requires Python Imaging Library.rzPIL cannot read video images.z Reading external files disabled.zCannot scale image!zCould not get size from "z":z  base_node)r r mimetypes guess_type videotypesrbfile_insertion_enableduri2pathImageopensize ValueErrorOSErrorUnicodeEncodeErrorr^record_dependenciesaddrrTrwarningrh) rMrreading_problemsr imagepathimgrerrmsgrPrPrQrs>      z!HTMLTranslator.read_size_with_PILcoder^ nodes.Elementattsdictc Csddd}|D] \}}t||q zt|}Wn*tjyE}z|j|jjj d|dd||d|WYd}~Sd}~wwd|vri} | dd  d } |d d } | | D]} | sgq`| d \}} }| | | <q`|dd d d| DdD]}||vr||||qd|vs|dr| dd  }||d| dg7}|dd |d|vr|d|durtd}|d|_|d|tj|ddS)Nzhttp://www.w3.org/2000/svgzhttp://www.w3.org/1999/xlink)r.xlinkzCannot parse SVG image "r": rrr.r:rcss$|] \}}|d|dVqdS)rrNrP)rkvrPrPrQ sz-HTMLTranslator.prepare_svg..rclassesclassaltr;rrr`)rETregister_namespace fromstring ParseErrorrrrTrerrorrrystrip partitionsetrhfindElementrrtostring)rMrrrsvg_nskeyrsvgrdeclaration_dictsvg_declarationsnode_declarations declaration_rr svg_titlerPrPrQ prepare_svgsP     zHTMLTranslator.prepare_svgNc Cs|dur t|jj}|jjrGz t|jdd}Wn"ty:}zd|}|jj |d|WYd}~Sd}~ww|jj ||j |S|rQt |jj|}|j||S)z8Return code to reference or embed stylesheet file `path`Nr_r`zCannot embed stylesheet: z <--- %s ---> )boolrbrrrrcrrTrrrrembedded_stylesheetr relative_path output_pathstylesheet_linkr)rMr adjust_pathcontentrrrPrPrQr s    zHTMLTranslator.stylesheet_callrfFc s|}g}i}|D] \}} | ||<q |dg} g} |dg|ddD]} | dr=| | dq-| rJ| | vrJ| | q-| rT| d||j <dt |t j refdd| D} | rnd | |d<d |vstJ|d g} | |d g| r| d|d <| d d D]}|st |t jt jt j fr|d|q|d|7}qt|}|g}|D]8\}} | d usJt | trdd| D}|d||d |fq|d||t| fq|rd}nd}d |dd ||d|S)z Construct and return a start tag given a node (id & class attributes are extracted), tag name, and optional attributes. rr r.z language-r)colwidths-autocolwidths-givencolwidths-gridcsg|]}|vr|qSrPrP)rclsinternalrPrQr7sz+HTMLTranslator.starttag..rididsNzcSsg|]}t|qSrP)r^)rrrPrPrQrUsz%s="%s"z /rr)rrpoprry startswithr removeprefixrlang_attributerrtablerhextend Sequentialr8sortedlistrr^)rMrrsuffixempty attributesprefixrnamerrrr*r.r-attlistrpvaluesinfixrPr+rQstarttags`                 $zHTMLTranslator.starttagcKs|j|||fddi|S)z1Construct and return an XML-compatible empty tag.r:T)rA)rMrrr9r;rPrPrQemptytagazHTMLTranslator.emptytagcCsRt|jtjtjfr dS|jr'|jd}|jj|dkr"| ||jsdSdS)Nrlevel) rparentrsystem_messageentryrr0rb report_levelrV)rMrmessagerPrPrQreport_messageses  zHTMLTranslator.report_messagesrcCsBdd|D}z||}Wn tyYdSw|d|dS)z Set class `class_` on the visible child no. index of `node`. Do nothing if node has fewer children than `index`. cSg|] }t|tjs|qSrPrr Invisible)rnrPrPrQrrsz5HTMLTranslator.set_class_on_child..Nr) IndexErrorr)rMrclass_indexchildrenchildrPrPrQset_class_on_childms  z!HTMLTranslator.set_class_on_childcCs:|}||}|jr|jjr||}|j|dSrH)rrrrbrrr9r)rMrrrrPrPrQ visit_Textys   zHTMLTranslator.visit_TextcCdSrHrPrMrrPrPrQ depart_TextzHTMLTranslator.depart_TextcC|j||dddS)Nabbrr.r9rrArWrPrPrQvisit_abbreviationrCz!HTMLTranslator.visit_abbreviationcC|jddS)Nzr9rrWrPrPrQdepart_abbreviationz"HTMLTranslator.depart_abbreviationcCrZ)Nacronymr.r\rWrPrPrQ visit_acronymrCzHTMLTranslator.visit_acronymcCr^)Nz r_rWrPrPrQdepart_acronymrazHTMLTranslator.depart_acronymcCs.|j|ddd|j|j|dddddS)NaddressFr?prer.r9r)visit_docinfo_itemr9rrArWrPrPrQ visit_addresss zHTMLTranslator.visit_addresscCs|jd|dSNz )r9rdepart_docinfo_itemrWrPrPrQdepart_addresss  zHTMLTranslator.depart_addresscCs|j|j|ddgddS)Naside admonitionrr\rWrPrPrQvisit_admonitionzHTMLTranslator.visit_admonitioncCr^N r_rWrPrPrQdepart_admonitionraz HTMLTranslator.depart_admonition)u—r.)())r.r.r'cCs<|j|jj\}}|j||j|j|d|dddS)Np attributionr)attribution_formatsrbryrrr9rA)rMrr<r9rPrPrQvisit_attributions  z HTMLTranslator.visit_attributioncCs|j|jddSN

r9rrr0rWrPrPrQdepart_attributionz!HTMLTranslator.depart_attributioncCs*t|jtjs ||d|jddS)Nauthorz

)rrErauthorsrir9rrWrPrPrQ visit_authors zHTMLTranslator.visit_authorcCs6|jdt|jtjr|jddS|dS)N

rf)r9rrrErrrlrWrPrPrQ depart_authors  zHTMLTranslator.depart_authorcC||ddS)NrrirWrPrPrQ visit_authorsrazHTMLTranslator.visit_authorscC |dSrHrlrWrPrPrQdepart_authors zHTMLTranslator.depart_authorscC|j||ddS)N blockquoter\rWrPrPrQvisit_block_quotez HTMLTranslator.visit_block_quotecCr^)Nz r_rWrPrPrQdepart_block_quoteraz!HTMLTranslator.depart_block_quoter cCs2t|j}z||WdStjyYdSw)z7Check for a simple list that can be rendered compactly.FT)SimpleListCheckerrTwalkr NodeFound)rMrrUrPrPrQcheck_simple_lists  z HTMLTranslator.check_simple_listcCsxd|dvrdSd|dvrdSt|tjtjfr|jjsdSt|tjtjfr.|jjs.dSd|j dvr7dS| |S)NcompactrTrFcontents) rr field_listdefinition_listrbr-enumerated_list bullet_listr,rErrWrPrPrQis_compactables   zHTMLTranslator.is_compactablecCsbi}|j}|j|j|jfd|_|||_|jr!|s!d|d<|j|j|dfi|dS)Nsimpler ul)rrrrrr9rA)rMrrold_compact_simplerPrPrQvisit_bullet_lists   z HTMLTranslator.visit_bullet_listcCs"|j\|_|_|jddS)Nz )rr0rrr9rrWrPrPrQdepart_bullet_listsz!HTMLTranslator.depart_bullet_listcC|j|j|dddddS)Nrxr.captionrzr\rWrPrPrQ visit_captionrrzHTMLTranslator.visit_captioncCr^r}r_rWrPrPrQdepart_captionrazHTMLTranslator.depart_captioncCs@t|t|s|jd|j|j|d|jgdddS)Nz(
rzdoc-biblioentryrrole)rprevious_siblingtyper9rrArrWrPrPrQvisit_citations   zHTMLTranslator.visit_citationcC8|jdt|jdddt|s|jddSdS)N
FTdescendsiblingsr9rr next_noderrWrPrPrQdepart_citation zHTMLTranslator.depart_citationc CsZd}d|vr ||d7}nd|vr||jj|d7}|j|j|dd|dgdddS) N#refidrefnamea[zcitation-referencez doc-biblioref)r9hrefrr)rTnameidsr9rrA)rMrrrPrPrQvisit_citation_references z'HTMLTranslator.visit_citation_referencecCr^)Nz]r_rWrPrPrQdepart_citation_referenceraz(HTMLTranslator.depart_citation_referencecCr)Nspanr. classifierrzr\rWrPrPrQvisit_classifierrrzHTMLTranslator.visit_classifiercC|jd||dSN)r9r depart_termrWrPrPrQdepart_classifier! z HTMLTranslator.depart_classifiercCs&|j||jj|jddS)Nstub)rrrEstubsr;rrWrPrPrQ visit_colspec%s zHTMLTranslator.visit_colspecc Cst|jdddtjr dSd|jjdvs#d|jjvr%d|jjdvr%dS|j| |dt d d |j D}|j D]}| |}|j|j |d d |d dq<|jddS)NFTrr'rr)r(colgroupcss|]}|VqdSrH) propwidth)rrrPrPrQr4sz0HTMLTranslator.depart_colspec..colwidth: z.1%)rz )rrrcolspecrErb table_styler9rrAsumrrrB)rMr total_widthcolwidthrPrPrQdepart_colspec*s      zHTMLTranslator.depart_colspecz-(?=-)cCs |jd|d|tj)z%Escape double-dashes in comment text.z z- )r9rrrSkipNode)rMrrrPrPrQ visit_comment;szHTMLTranslator.visit_commentcC|j|j|ddddS)Nrcompoundrzr\rWrPrPrQvisit_compoundBzHTMLTranslator.visit_compoundcCr^Nrr_rWrPrPrQdepart_compoundErazHTMLTranslator.depart_compoundcCr)Nrzdocutils containerrzr\rWrPrPrQvisit_containerHs zHTMLTranslator.visit_containercCr^rr_rWrPrPrQdepart_containerLrazHTMLTranslator.depart_containercC|j|ddddS)NcontactFrfrrWrPrPrQ visit_contactOzHTMLTranslator.visit_contactcCrrHrrWrPrPrQdepart_contactRrzHTMLTranslator.depart_contactcCr)N copyrightrrWrPrPrQvisit_copyrightUrazHTMLTranslator.visit_copyrightcCrrHrrWrPrPrQdepart_copyrightXrzHTMLTranslator.depart_copyrightcCr)NdaterrWrPrPrQ visit_date[razHTMLTranslator.visit_datecCrrHrrWrPrPrQ depart_date^rzHTMLTranslator.depart_datecCrVrHrPrWrPrPrQvisit_decorationarYzHTMLTranslator.visit_decorationcCrVrHrPrWrPrPrQdepart_decorationdrYz HTMLTranslator.depart_decorationcCs.d|jjdvr|j||dddSdS)Ndetailsrddr.rEr9rrArWrPrPrQvisit_definitiongszHTMLTranslator.visit_definitioncCs$d|jjdvr|jddSdS)Nrr rEr9rrWrPrPrQdepart_definitionksz HTMLTranslator.depart_definitioncCsTd|dvr|j||ddS||rdgng}|j|j|d|ddS)Nrrrrdlrp)r9rrArrMrrrPrPrQvisit_definition_listos z$HTMLTranslator.visit_definition_listcCs,d|dvr|jddS|jddS)Nrrr r_rWrPrPrQdepart_definition_listvs z%HTMLTranslator.depart_definition_listcCsLd|jdvr$i}d|jdvrd|d<|j|j|dfi|dSdS)NrrrrrMrrrPrPrQvisit_definition_list_item}s  z)HTMLTranslator.visit_definition_list_itemcCs"d|jdvr|jddSdS)Nrrz rrWrPrPrQdepart_definition_list_itemsz*HTMLTranslator.depart_definition_list_itemcCrZ)Nrr.r\rWrPrPrQvisit_descriptionrz HTMLTranslator.visit_descriptioncCr^Nrr_rWrPrPrQdepart_descriptionraz!HTMLTranslator.depart_descriptioncCsH|jt|jdg}||r|d|j|j|d|ddS)Nr8rrrp)rrrr9rrArrPrPrQ visit_docinfos   zHTMLTranslator.visit_docinfocCs0|jd|j}|j|d|_g|_dSNr)r9rrr0r8)rMrstartrPrPrQdepart_docinfos   zHTMLTranslator.depart_docinfoTc Csh|r|jd|d||d|jd|d|jj|d|j|j|dd|d dS) Nz z
":
rr.rz)r?rrrr9rlabelsrA)rMrr=r?rPrPrQris   "z!HTMLTranslator.visit_docinfo_itemcCr^rr_rLrPrPrQrlraz"HTMLTranslator.depart_docinfo_itemcCs"|j|j|ddgdddS)Nrgr.)rpythondoctestr9rr\rWrPrPrQvisit_doctest_blocks z"HTMLTranslator.visit_doctest_blockcCr^rkr_rWrPrPrQdepart_doctest_blockraz#HTMLTranslator.depart_doctest_blockcCsB|dptj|dpdpd}|jd||ddS)Nr;sourcer.zuntitled Docutils documentzz )rosrbasenamer5rr)rMrr;rPrPrQvisit_documents zHTMLTranslator.visit_documentcCsf|j|j|jd|jjig|j|j|jdd|j |_ dd |jvr0|j d|j rG|j dkr@|j |j n|j |j |jjr_|jjdkr_|j|j ddn|j|j |j|j|fi|j|jdd |jd d |j|j|j|jdd|j|j|j|jdd |jrJd t|jdS)Nrzname="dcterms.r.z=mathjaxrr/r zlen(context) = )r4r5doctypehead_prefix_templaterbrrArr?r5rhrrrrjrrBr6rAdocumenttag_argsr:rr@r9rEr7r8rrrWrPrPrQdepart_documents8     zHTMLTranslator.depart_documentcCrZ)Nemr.r\rWrPrPrQvisit_emphasisrzHTMLTranslator.visit_emphasiscCr^)Nzr_rWrPrPrQdepart_emphasisrazHTMLTranslator.depart_emphasiscCsdgi}t|jjtjr|dd|jjjj|jjr$|dd|dr+d}nd}|jjd7_d|vrA|dd|d<d |vrW|d d|d <|jj|d 7_|j|j||d fi||j d | dS) Nrr5rthtdr/morerowsrowspanmorecolscolspanr. ) rrErtheadrrcolumnr9rArr)rMrrrrPrPrQ visit_entrys zHTMLTranslator.visit_entrycC|j|jdSrHrrWrPrPrQ depart_entryzHTMLTranslator.depart_entrycCsndgi}d|vr|d|d<d|vr|d|d||r'|dd|j|j|dfi|dS)Nrrenumtyperol)rrr9rArrPrPrQvisit_enumerated_lists   z$HTMLTranslator.visit_enumerated_listcCr^)Nz r_rWrPrPrQdepart_enumerated_listraz%HTMLTranslator.depart_enumerated_listc Csi}|dg}t|D]+\}}|dr7z t|dd}Wn ty)Ynwd||d<||nq |d||rG|d|j |j |dfi|dS) Nrz field-indent-pxz--field-indent: %s;rz field-listrr) setdefault enumerater1r r2rr0rrr9rA)rMrrrir* indent_lengthrPrPrQvisit_field_lists&         zHTMLTranslator.visit_field_listcCr^rr_rWrPrPrQdepart_field_list raz HTMLTranslator.depart_field_listcCs,|D]}t|tjr|d|dqdS)Nr.)rr field_namer5)rMrrSrPrPrQ visit_fields  zHTMLTranslator.visit_fieldcCrVrHrPrWrPrPrQ depart_fieldrYzHTMLTranslator.depart_fieldcCs$|j|j|dd|jdddS)Ndtr.rrp)r9rrArErWrPrPrQvisit_field_names zHTMLTranslator.visit_field_namecCr^)Nrr_rWrPrPrQdepart_field_nameraz HTMLTranslator.depart_field_namecCs:|j|j|dd|jdd|js|jddSdS)Nrr.rrpz

)r9rrArErRrWrPrPrQvisit_field_body s zHTMLTranslator.visit_field_bodycCr^rr_rWrPrPrQdepart_field_body'raz HTMLTranslator.depart_field_bodycCsdddi}|drd|d|d<|dr"|dd|d7<|j|j|dfi|dS) Nr figurerz width: %sralignz align-r)rr9rrArrPrPrQ visit_figure*s    zHTMLTranslator.visit_figurecCr^rr_rWrPrPrQ depart_figure2razHTMLTranslator.depart_figurecC|jt|jdSrHrrrr9rWrPrPrQ visit_footer5r#zHTMLTranslator.visit_footercCsf|j}|j|ddddg}||j|d|d|j|||jdd<|j|d=dS)Nrr>rzz
z r)rr0rAr5r9rr>r:)rMrrr>rPrPrQ depart_footer8s   zHTMLTranslator.depart_footercCsR|jj}t|t|s|jd|d|j|j|d|j|gdddS)Nz