| # -*- coding: utf8 -*- |
| # $Id: __init__.py 6385 2010-08-13 12:17:01Z milde $ |
| # Author: Engelbert Gruber <grubert@users.sourceforge.net> |
| # Copyright: This module has been placed in the public domain. |
| |
| """LaTeX2e document tree Writer.""" |
| |
| __docformat__ = 'reStructuredText' |
| |
| # code contributions from several people included, thanks to all. |
| # some named: David Abrahams, Julien Letessier, Lele Gaifax, and others. |
| # |
| # convention deactivate code by two # i.e. ##. |
| |
| import sys |
| import os |
| import time |
| import re |
| import string |
| from docutils import frontend, nodes, languages, writers, utils, io |
| from docutils.transforms import writer_aux |
| |
| # compatibility module for Python 2.3 |
| if not hasattr(string, 'Template'): |
| import docutils._string_template_compat |
| string.Template = docutils._string_template_compat.Template |
| |
| class Writer(writers.Writer): |
| |
| supported = ('latex','latex2e') |
| """Formats this writer supports.""" |
| |
| default_template = 'default.tex' |
| default_template_path = os.path.dirname(__file__) |
| |
| default_preamble = '\n'.join([r'% PDF Standard Fonts', |
| r'\usepackage{mathptmx} % Times', |
| r'\usepackage[scaled=.90]{helvet}', |
| r'\usepackage{courier}']) |
| settings_spec = ( |
| 'LaTeX-Specific Options', |
| None, |
| (('Specify documentclass. Default is "article".', |
| ['--documentclass'], |
| {'default': 'article', }), |
| ('Specify document options. Multiple options can be given, ' |
| 'separated by commas. Default is "a4paper".', |
| ['--documentoptions'], |
| {'default': 'a4paper', }), |
| ('Footnotes with numbers/symbols by Docutils. (default)', |
| ['--docutils-footnotes'], |
| {'default': True, 'action': 'store_true', |
| 'validator': frontend.validate_boolean}), |
| ('Alias for --docutils-footnotes (deprecated)', |
| ['--use-latex-footnotes'], |
| {'action': 'store_true', |
| 'validator': frontend.validate_boolean}), |
| ('Use figure floats for footnote text (deprecated)', |
| ['--figure-footnotes'], |
| {'action': 'store_true', |
| 'validator': frontend.validate_boolean}), |
| ('Format for footnote references: one of "superscript" or ' |
| '"brackets". Default is "superscript".', |
| ['--footnote-references'], |
| {'choices': ['superscript', 'brackets'], 'default': 'superscript', |
| 'metavar': '<format>', |
| 'overrides': 'trim_footnote_reference_space'}), |
| ('Use \\cite command for citations. ', |
| ['--use-latex-citations'], |
| {'default': 0, 'action': 'store_true', |
| 'validator': frontend.validate_boolean}), |
| ('Use figure floats for citations ' |
| '(might get mixed with real figures). (default)', |
| ['--figure-citations'], |
| {'dest': 'use_latex_citations', 'action': 'store_false', |
| 'validator': frontend.validate_boolean}), |
| ('Format for block quote attributions: one of "dash" (em-dash ' |
| 'prefix), "parentheses"/"parens", or "none". Default is "dash".', |
| ['--attribution'], |
| {'choices': ['dash', 'parentheses', 'parens', 'none'], |
| 'default': 'dash', 'metavar': '<format>'}), |
| ('Specify LaTeX packages/stylesheets. ' |
| ' A style is referenced with \\usepackage if extension is ' |
| '".sty" or omitted and with \\input else. ' |
| ' Overrides previous --stylesheet and --stylesheet-path settings.', |
| ['--stylesheet'], |
| {'default': '', 'metavar': '<file>', |
| 'overrides': 'stylesheet_path'}), |
| ('Like --stylesheet, but the path is rewritten ' |
| 'relative to the output file. ', |
| ['--stylesheet-path'], |
| {'metavar': '<file>', 'overrides': 'stylesheet'}), |
| ('Link to the stylesheet(s) in the output file. (default)', |
| ['--link-stylesheet'], |
| {'dest': 'embed_stylesheet', 'action': 'store_false'}), |
| ('Embed the stylesheet(s) in the output file. ' |
| 'Stylesheets must be accessible during processing. ', |
| ['--embed-stylesheet'], |
| {'default': 0, 'action': 'store_true', |
| 'validator': frontend.validate_boolean}), |
| ('Customization by LaTeX code in the preamble. ' |
| 'Default: select PDF standard fonts (Times, Helvetica, Courier).', |
| ['--latex-preamble'], |
| {'default': default_preamble}), |
| ('Specify the template file. Default: "%s".' % default_template, |
| ['--template'], |
| {'default': default_template, 'metavar': '<file>'}), |
| ('Table of contents by LaTeX. (default) ', |
| ['--use-latex-toc'], |
| {'default': 1, 'action': 'store_true', |
| 'validator': frontend.validate_boolean}), |
| ('Table of contents by Docutils (without page numbers). ', |
| ['--use-docutils-toc'], |
| {'dest': 'use_latex_toc', 'action': 'store_false', |
| 'validator': frontend.validate_boolean}), |
| ('Add parts on top of the section hierarchy.', |
| ['--use-part-section'], |
| {'default': 0, 'action': 'store_true', |
| 'validator': frontend.validate_boolean}), |
| ('Attach author and date to the document info table. (default) ', |
| ['--use-docutils-docinfo'], |
| {'dest': 'use_latex_docinfo', 'action': 'store_false', |
| 'validator': frontend.validate_boolean}), |
| ('Attach author and date to the document title.', |
| ['--use-latex-docinfo'], |
| {'default': 0, 'action': 'store_true', |
| 'validator': frontend.validate_boolean}), |
| ("Typeset abstract as topic. (default)", |
| ['--topic-abstract'], |
| {'dest': 'use_latex_abstract', 'action': 'store_false', |
| 'validator': frontend.validate_boolean}), |
| ("Use LaTeX abstract environment for the document's abstract. ", |
| ['--use-latex-abstract'], |
| {'default': 0, 'action': 'store_true', |
| 'validator': frontend.validate_boolean}), |
| ('Color of any hyperlinks embedded in text ' |
| '(default: "blue", "0" to disable).', |
| ['--hyperlink-color'], {'default': 'blue'}), |
| ('Enable compound enumerators for nested enumerated lists ' |
| '(e.g. "1.2.a.ii"). Default: disabled.', |
| ['--compound-enumerators'], |
| {'default': None, 'action': 'store_true', |
| 'validator': frontend.validate_boolean}), |
| ('Disable compound enumerators for nested enumerated lists. ' |
| 'This is the default.', |
| ['--no-compound-enumerators'], |
| {'action': 'store_false', 'dest': 'compound_enumerators'}), |
| ('Enable section ("." subsection ...) prefixes for compound ' |
| 'enumerators. This has no effect without --compound-enumerators.' |
| 'Default: disabled.', |
| ['--section-prefix-for-enumerators'], |
| {'default': None, 'action': 'store_true', |
| 'validator': frontend.validate_boolean}), |
| ('Disable section prefixes for compound enumerators. ' |
| 'This is the default.', |
| ['--no-section-prefix-for-enumerators'], |
| {'action': 'store_false', 'dest': 'section_prefix_for_enumerators'}), |
| ('Set the separator between section number and enumerator ' |
| 'for compound enumerated lists. Default is "-".', |
| ['--section-enumerator-separator'], |
| {'default': '-', 'metavar': '<char>'}), |
| ('When possibile, use the specified environment for literal-blocks. ' |
| 'Default is quoting of whitespace and special chars.', |
| ['--literal-block-env'], |
| {'default': ''}), |
| ('When possibile, use verbatim for literal-blocks. ' |
| 'Compatibility alias for "--literal-block-env=verbatim".', |
| ['--use-verbatim-when-possible'], |
| {'default': 0, 'action': 'store_true', |
| 'validator': frontend.validate_boolean}), |
| ('Table style. "standard" with horizontal and vertical lines, ' |
| '"booktabs" (LaTeX booktabs style) only horizontal lines ' |
| 'above and below the table and below the header or "borderless". ' |
| 'Default: "standard"', |
| ['--table-style'], |
| {'choices': ['standard', 'booktabs','nolines', 'borderless'], |
| 'default': 'standard', |
| 'metavar': '<format>'}), |
| ('LaTeX graphicx package option. ' |
| 'Possible values are "dvips", "pdftex". "auto" includes LaTeX code ' |
| 'to use "pdftex" if processing with pdf(la)tex and dvips otherwise. ' |
| 'Default is no option.', |
| ['--graphicx-option'], |
| {'default': ''}), |
| ('LaTeX font encoding. ' |
| 'Possible values are "", "T1" (default), "OT1", "LGR,T1" or ' |
| 'any other combination of options to the `fontenc` package. ', |
| ['--font-encoding'], |
| {'default': 'T1'}), |
| ('Per default the latex-writer puts the reference title into ' |
| 'hyperreferences. Specify "ref*" or "pageref*" to get the section ' |
| 'number or the page number.', |
| ['--reference-label'], |
| {'default': None, }), |
| ('Specify style and database for bibtex, for example ' |
| '"--use-bibtex=mystyle,mydb1,mydb2".', |
| ['--use-bibtex'], |
| {'default': None, }), |
| ),) |
| |
| settings_defaults = {'sectnum_depth': 0 # updated by SectNum transform |
| } |
| relative_path_settings = ('stylesheet_path',) |
| |
| config_section = 'latex2e writer' |
| config_section_dependencies = ('writers',) |
| |
| head_parts = ('head_prefix', 'requirements', 'latex_preamble', |
| 'stylesheet', 'fallbacks', 'pdfsetup', 'title', 'subtitle') |
| visitor_attributes = head_parts + ('body_pre_docinfo', 'docinfo', |
| 'dedication', 'abstract', 'body') |
| |
| output = None |
| """Final translated form of `document`.""" |
| |
| def __init__(self): |
| writers.Writer.__init__(self) |
| self.translator_class = LaTeXTranslator |
| |
| # Override parent method to add latex-specific transforms |
| def get_transforms(self): |
| # call the parent class' method |
| transform_list = writers.Writer.get_transforms(self) |
| # print transform_list |
| # Convert specific admonitions to generic one |
| transform_list.append(writer_aux.Admonitions) |
| # TODO: footnote collection transform |
| # transform_list.append(footnotes.collect) |
| return transform_list |
| |
| |
| def translate(self): |
| visitor = self.translator_class(self.document) |
| self.document.walkabout(visitor) |
| # copy parts |
| for part in self.visitor_attributes: |
| setattr(self, part, getattr(visitor, part)) |
| # get template string from file |
| try: |
| file = open(self.document.settings.template, 'rb') |
| except IOError: |
| file = open(os.path.join(os.path.dirname(__file__), |
| self.document.settings.template), 'rb') |
| template = string.Template(unicode(file.read(), 'utf-8')) |
| file.close() |
| # fill template |
| self.assemble_parts() # create dictionary of parts |
| self.output = template.substitute(self.parts) |
| |
| def assemble_parts(self): |
| """Assemble the `self.parts` dictionary of output fragments.""" |
| writers.Writer.assemble_parts(self) |
| for part in self.visitor_attributes: |
| lines = getattr(self, part) |
| if part in self.head_parts: |
| if lines: |
| lines.append('') # to get a trailing newline |
| self.parts[part] = '\n'.join(lines) |
| else: |
| # body contains inline elements, so join without newline |
| self.parts[part] = ''.join(lines) |
| |
| |
| class Babel(object): |
| """Language specifics for LaTeX.""" |
| # country code by a.schlock. |
| # partly manually converted from iso and babel stuff, dialects and some |
| _ISO639_TO_BABEL = { |
| 'no': 'norsk', #XXX added by hand ( forget about nynorsk?) |
| 'gd': 'scottish', #XXX added by hand |
| 'hu': 'magyar', #XXX added by hand |
| 'pt': 'portuguese',#XXX added by hand |
| 'sl': 'slovenian', |
| 'af': 'afrikaans', |
| 'bg': 'bulgarian', |
| 'br': 'breton', |
| 'ca': 'catalan', |
| 'cs': 'czech', |
| 'cy': 'welsh', |
| 'da': 'danish', |
| 'fr': 'french', |
| # french, francais, canadien, acadian |
| 'de': 'ngerman', #XXX rather than german |
| # ngerman, naustrian, german, germanb, austrian |
| 'el': 'greek', |
| 'en': 'english', |
| # english, USenglish, american, UKenglish, british, canadian |
| 'eo': 'esperanto', |
| 'es': 'spanish', |
| 'et': 'estonian', |
| 'eu': 'basque', |
| 'fi': 'finnish', |
| 'ga': 'irish', |
| 'gl': 'galician', |
| 'he': 'hebrew', |
| 'hr': 'croatian', |
| 'hu': 'hungarian', |
| 'is': 'icelandic', |
| 'it': 'italian', |
| 'la': 'latin', |
| 'nl': 'dutch', |
| 'pl': 'polish', |
| 'pt': 'portuguese', |
| 'ro': 'romanian', |
| 'ru': 'russian', |
| 'sk': 'slovak', |
| 'sr': 'serbian', |
| 'sv': 'swedish', |
| 'tr': 'turkish', |
| 'uk': 'ukrainian' |
| } |
| |
| def __init__(self, lang): |
| self.language = lang |
| self.quote_index = 0 |
| self.quotes = ('``', "''") |
| self.setup = '' # language dependent configuration code |
| # double quotes are "active" in some languages (e.g. German). |
| # TODO: use \textquotedbl in OT1 font encoding? |
| self.literal_double_quote = u'"' |
| if self.language.startswith('de'): |
| self.quotes = (r'\glqq{}', r'\grqq{}') |
| self.literal_double_quote = ur'\dq{}' |
| if self.language.startswith('it'): |
| self.literal_double_quote = ur'{\char`\"}' |
| if self.language.startswith('es'): |
| # reset tilde ~ to the original binding (nobreakspace): |
| self.setup = ('\n' |
| r'\addto\shorthandsspanish{\spanishdeactivate{."~<>}}') |
| |
| def next_quote(self): |
| q = self.quotes[self.quote_index] |
| self.quote_index = (self.quote_index+1) % 2 |
| return q |
| |
| def quote_quotes(self,text): |
| t = None |
| for part in text.split('"'): |
| if t == None: |
| t = part |
| else: |
| t += self.next_quote() + part |
| return t |
| |
| def get_language(self): |
| lang = self.language.split('_')[0] # filter dialects |
| return self._ISO639_TO_BABEL.get(lang, "") |
| |
| # Building blocks for the latex preamble |
| # -------------------------------------- |
| |
| class SortableDict(dict): |
| """Dictionary with additional sorting methods |
| |
| Tip: use key starting with with '_' for sorting before small letters |
| and with '~' for sorting after small letters. |
| """ |
| def sortedkeys(self): |
| """Return sorted list of keys""" |
| keys = self.keys() |
| keys.sort() |
| return keys |
| |
| def sortedvalues(self): |
| """Return list of values sorted by keys""" |
| return [self[key] for key in self.sortedkeys()] |
| |
| |
| # PreambleCmds |
| # ````````````` |
| # A container for LaTeX code snippets that can be |
| # inserted into the preamble if required in the document. |
| # |
| # .. The package 'makecmds' would enable shorter definitions using the |
| # \providelength and \provideenvironment commands. |
| # However, it is pretty non-standard (texlive-latex-extra). |
| |
| class PreambleCmds(object): |
| """Building blocks for the latex preamble.""" |
| |
| PreambleCmds.abstract = r""" |
| % abstract title |
| \providecommand*{\DUtitleabstract}[1]{\centerline{\textbf{#1}}}""" |
| |
| PreambleCmds.admonition = r""" |
| % admonition (specially marked topic) |
| \providecommand{\DUadmonition}[2][class-arg]{% |
| % try \DUadmonition#1{#2}: |
| \ifcsname DUadmonition#1\endcsname% |
| \csname DUadmonition#1\endcsname{#2}% |
| \else |
| \begin{center} |
| \fbox{\parbox{0.9\textwidth}{#2}} |
| \end{center} |
| \fi |
| }""" |
| |
| ## PreambleCmds.caption = r"""% configure caption layout |
| ## \usepackage{caption} |
| ## \captionsetup{singlelinecheck=false}% no exceptions for one-liners""" |
| |
| PreambleCmds.color = r"""\usepackage{color}""" |
| |
| PreambleCmds.docinfo = r""" |
| % docinfo (width of docinfo table) |
| \DUprovidelength{\DUdocinfowidth}{0.9\textwidth}""" |
| # PreambleCmds.docinfo._depends = 'providelength' |
| |
| PreambleCmds.embedded_package_wrapper = r"""\makeatletter |
| %% embedded stylesheet: %s |
| %s |
| \makeatother""" |
| |
| PreambleCmds.dedication = r""" |
| % dedication topic |
| \providecommand{\DUtopicdedication}[1]{\begin{center}#1\end{center}}""" |
| |
| PreambleCmds.error = r""" |
| % error admonition title |
| \providecommand*{\DUtitleerror}[1]{\DUtitle{\color{red}#1}}""" |
| # PreambleCmds.errortitle._depends = 'color' |
| |
| PreambleCmds.fieldlist = r""" |
| % fieldlist environment |
| \ifthenelse{\isundefined{\DUfieldlist}}{ |
| \newenvironment{DUfieldlist}% |
| {\quote\description} |
| {\enddescription\endquote} |
| }{}""" |
| |
| PreambleCmds.float_settings = r"""\usepackage{float} % float configuration |
| \floatplacement{figure}{H} % place figures here definitely""" |
| |
| PreambleCmds.footnotes = r"""% numeric or symbol footnotes with hyperlinks |
| \providecommand*{\DUfootnotemark}[3]{% |
| \raisebox{1em}{\hypertarget{#1}{}}% |
| \hyperlink{#2}{\textsuperscript{#3}}% |
| } |
| \providecommand{\DUfootnotetext}[4]{% |
| \begingroup% |
| \renewcommand{\thefootnote}{% |
| \protect\raisebox{1em}{\protect\hypertarget{#1}{}}% |
| \protect\hyperlink{#2}{#3}}% |
| \footnotetext{#4}% |
| \endgroup% |
| }""" |
| |
| PreambleCmds.footnote_floats = r"""% settings for footnotes as floats: |
| \setlength{\floatsep}{0.5em} |
| \setlength{\textfloatsep}{\fill} |
| \addtolength{\textfloatsep}{3em} |
| \renewcommand{\textfraction}{0.5} |
| \renewcommand{\topfraction}{0.5} |
| \renewcommand{\bottomfraction}{0.5} |
| \setcounter{totalnumber}{50} |
| \setcounter{topnumber}{50} |
| \setcounter{bottomnumber}{50}""" |
| |
| PreambleCmds.graphicx_auto = r"""% Check output format |
| \ifx\pdftexversion\undefined |
| \usepackage{graphicx} |
| \else |
| \usepackage[pdftex]{graphicx} |
| \fi'))""" |
| |
| |
| PreambleCmds.inline = r""" |
| % inline markup (custom roles) |
| % \DUrole{#1}{#2} tries \DUrole#1{#2} |
| \providecommand*{\DUrole}[2]{% |
| \ifcsname DUrole#1\endcsname% |
| \csname DUrole#1\endcsname{#2}% |
| \else% backwards compatibility: try \docutilsrole#1{#2} |
| \ifcsname docutilsrole#1\endcsname% |
| \csname docutilsrole#1\endcsname{#2}% |
| \else% |
| #2% |
| \fi% |
| \fi% |
| }""" |
| |
| PreambleCmds.legend = r""" |
| % legend environment |
| \ifthenelse{\isundefined{\DUlegend}}{ |
| \newenvironment{DUlegend}{\small}{} |
| }{}""" |
| |
| PreambleCmds.lineblock = r""" |
| % lineblock environment |
| \DUprovidelength{\DUlineblockindent}{2.5em} |
| \ifthenelse{\isundefined{\DUlineblock}}{ |
| \newenvironment{DUlineblock}[1]{% |
| \list{}{\setlength{\partopsep}{\parskip} |
| \addtolength{\partopsep}{\baselineskip} |
| \setlength{\topsep}{0pt} |
| \setlength{\itemsep}{0.15\baselineskip} |
| \setlength{\parsep}{0pt} |
| \setlength{\leftmargin}{#1}} |
| \raggedright |
| } |
| {\endlist} |
| }{}""" |
| # PreambleCmds.lineblock._depends = 'providelength' |
| |
| PreambleCmds.linking = r""" |
| %% hyperlinks: |
| \ifthenelse{\isundefined{\hypersetup}}{ |
| \usepackage[unicode,colorlinks=%s,linkcolor=%s,urlcolor=%s]{hyperref} |
| \urlstyle{same} %% normal text font (alternatives: tt, rm, sf) |
| }{}""" |
| |
| PreambleCmds.minitoc = r"""%% local table of contents |
| \usepackage{minitoc}""" |
| |
| PreambleCmds.optionlist = r""" |
| % optionlist environment |
| \providecommand*{\DUoptionlistlabel}[1]{\bf #1 \hfill} |
| \DUprovidelength{\DUoptionlistindent}{3cm} |
| \ifthenelse{\isundefined{\DUoptionlist}}{ |
| \newenvironment{DUoptionlist}{% |
| \list{}{\setlength{\labelwidth}{\DUoptionlistindent} |
| \setlength{\rightmargin}{1cm} |
| \setlength{\leftmargin}{\rightmargin} |
| \addtolength{\leftmargin}{\labelwidth} |
| \addtolength{\leftmargin}{\labelsep} |
| \renewcommand{\makelabel}{\DUoptionlistlabel}} |
| } |
| {\endlist} |
| }{}""" |
| # PreambleCmds.optionlist._depends = 'providelength' |
| |
| PreambleCmds.providelength = r""" |
| % providelength (provide a length variable and set default, if it is new) |
| \providecommand*{\DUprovidelength}[2]{ |
| \ifthenelse{\isundefined{#1}}{\newlength{#1}\setlength{#1}{#2}}{} |
| }""" |
| |
| PreambleCmds.rubric = r""" |
| % rubric (informal heading) |
| \providecommand*{\DUrubric}[2][class-arg]{% |
| \subsubsection*{\centering\textit{\textmd{#2}}}}""" |
| |
| PreambleCmds.sidebar = r""" |
| % sidebar (text outside the main text flow) |
| \providecommand{\DUsidebar}[2][class-arg]{% |
| \begin{center} |
| \colorbox[gray]{0.80}{\parbox{0.9\textwidth}{#2}} |
| \end{center} |
| }""" |
| |
| PreambleCmds.subtitle = r""" |
| % subtitle (for topic/sidebar) |
| \providecommand*{\DUsubtitle}[2][class-arg]{\par\emph{#2}\smallskip}""" |
| |
| PreambleCmds.table = r"""\usepackage{longtable} |
| \usepackage{array} |
| \setlength{\extrarowheight}{2pt} |
| \newlength{\DUtablewidth} % internal use in tables""" |
| |
| # Options [force,almostfull] prevent spurious error messages, see |
| # de.comp.text.tex/2005-12/msg01855 |
| PreambleCmds.textcomp = """\ |
| \\usepackage{textcomp} % text symbol macros""" |
| |
| PreambleCmds.documenttitle = r""" |
| %% Document title |
| \title{%s} |
| \author{%s} |
| \date{%s} |
| \maketitle |
| """ |
| |
| PreambleCmds.titlereference = r""" |
| % titlereference role |
| \providecommand*{\DUroletitlereference}[1]{\textsl{#1}}""" |
| |
| PreambleCmds.title = r""" |
| % title for topics, admonitions and sidebar |
| \providecommand*{\DUtitle}[2][class-arg]{% |
| % call \DUtitle#1{#2} if it exists: |
| \ifcsname DUtitle#1\endcsname% |
| \csname DUtitle#1\endcsname{#2}% |
| \else |
| \smallskip\noindent\textbf{#2}\smallskip% |
| \fi |
| }""" |
| |
| PreambleCmds.topic = r""" |
| % topic (quote with heading) |
| \providecommand{\DUtopic}[2][class-arg]{% |
| \ifcsname DUtopic#1\endcsname% |
| \csname DUtopic#1\endcsname{#2}% |
| \else |
| \begin{quote}#2\end{quote} |
| \fi |
| }""" |
| |
| PreambleCmds.transition = r""" |
| % transition (break, fancybreak, anonymous section) |
| \providecommand*{\DUtransition}[1][class-arg]{% |
| \hspace*{\fill}\hrulefill\hspace*{\fill} |
| \vskip 0.5\baselineskip |
| }""" |
| |
| |
| class DocumentClass(object): |
| """Details of a LaTeX document class.""" |
| |
| def __init__(self, document_class, with_part=False): |
| self.document_class = document_class |
| self._with_part = with_part |
| self.sections = ['section', 'subsection', 'subsubsection', |
| 'paragraph', 'subparagraph'] |
| if self.document_class in ('book', 'memoir', 'report', |
| 'scrbook', 'scrreprt'): |
| self.sections.insert(0, 'chapter') |
| if self._with_part: |
| self.sections.insert(0, 'part') |
| |
| def section(self, level): |
| """Return the LaTeX section name for section `level`. |
| |
| The name depends on the specific document class. |
| Level is 1,2,3..., as level 0 is the title. |
| """ |
| |
| if level <= len(self.sections): |
| return self.sections[level-1] |
| else: |
| return self.sections[-1] |
| |
| |
| class Table(object): |
| """Manage a table while traversing. |
| |
| Maybe change to a mixin defining the visit/departs, but then |
| class Table internal variables are in the Translator. |
| |
| Table style might be |
| |
| :standard: horizontal and vertical lines |
| :booktabs: only horizontal lines (requires "booktabs" LaTeX package) |
| :borderless: no borders around table cells |
| :nolines: alias for borderless |
| """ |
| def __init__(self,translator,latex_type,table_style): |
| self._translator = translator |
| self._latex_type = latex_type |
| self._table_style = table_style |
| self._open = 0 |
| # miscellaneous attributes |
| self._attrs = {} |
| self._col_width = [] |
| self._rowspan = [] |
| self.stubs = [] |
| self._in_thead = 0 |
| |
| def open(self): |
| self._open = 1 |
| self._col_specs = [] |
| self.caption = [] |
| self._attrs = {} |
| self._in_head = 0 # maybe context with search |
| def close(self): |
| self._open = 0 |
| self._col_specs = None |
| self.caption = [] |
| self._attrs = {} |
| self.stubs = [] |
| def is_open(self): |
| return self._open |
| |
| def set_table_style(self, table_style): |
| if not table_style in ('standard','booktabs','borderless','nolines'): |
| return |
| self._table_style = table_style |
| |
| def get_latex_type(self): |
| return self._latex_type |
| |
| def set(self,attr,value): |
| self._attrs[attr] = value |
| def get(self,attr): |
| if attr in self._attrs: |
| return self._attrs[attr] |
| return None |
| |
| def get_vertical_bar(self): |
| if self._table_style == 'standard': |
| return '|' |
| return '' |
| |
| # horizontal lines are drawn below a row, |
| def get_opening(self): |
| if self._latex_type == 'longtable': |
| # otherwise longtable might move before paragraph and subparagraph |
| prefix = '\\leavevmode\n' |
| else: |
| prefix = '' |
| prefix += '\setlength{\DUtablewidth}{\linewidth}' |
| return '%s\n\\begin{%s}[c]' % (prefix, self._latex_type) |
| |
| def get_closing(self): |
| line = '' |
| if self._table_style == 'booktabs': |
| line = '\\bottomrule\n' |
| elif self._table_style == 'standard': |
| lines = '\\hline\n' |
| return '%s\\end{%s}' % (line,self._latex_type) |
| |
| def visit_colspec(self, node): |
| self._col_specs.append(node) |
| # "stubs" list is an attribute of the tgroup element: |
| self.stubs.append(node.attributes.get('stub')) |
| |
| def get_colspecs(self): |
| """Return column specification for longtable. |
| |
| Assumes reST line length being 80 characters. |
| Table width is hairy. |
| |
| === === |
| ABC DEF |
| === === |
| |
| usually gets to narrow, therefore we add 1 (fiddlefactor). |
| """ |
| width = 80 |
| |
| total_width = 0.0 |
| # first see if we get too wide. |
| for node in self._col_specs: |
| colwidth = float(node['colwidth']+1) / width |
| total_width += colwidth |
| self._col_width = [] |
| self._rowspan = [] |
| # donot make it full linewidth |
| factor = 0.93 |
| if total_width > 1.0: |
| factor /= total_width |
| bar = self.get_vertical_bar() |
| latex_table_spec = '' |
| for node in self._col_specs: |
| colwidth = factor * float(node['colwidth']+1) / width |
| self._col_width.append(colwidth+0.005) |
| self._rowspan.append(0) |
| latex_table_spec += '%sp{%.3f\\DUtablewidth}' % (bar, colwidth+0.005) |
| return latex_table_spec+bar |
| |
| def get_column_width(self): |
| """Return columnwidth for current cell (not multicell).""" |
| return '%.2f\\DUtablewidth' % self._col_width[self._cell_in_row-1] |
| |
| def get_caption(self): |
| if not self.caption: |
| return '' |
| caption = ''.join(self.caption) |
| if 1 == self._translator.thead_depth(): |
| return r'\caption{%s}\\' '\n' % caption |
| return r'\caption[]{%s (... continued)}\\' '\n' % caption |
| |
| def need_recurse(self): |
| if self._latex_type == 'longtable': |
| return 1 == self._translator.thead_depth() |
| return 0 |
| |
| def visit_thead(self): |
| self._in_thead += 1 |
| if self._table_style == 'standard': |
| return ['\\hline\n'] |
| elif self._table_style == 'booktabs': |
| return ['\\toprule\n'] |
| return [] |
| def depart_thead(self): |
| a = [] |
| #if self._table_style == 'standard': |
| # a.append('\\hline\n') |
| if self._table_style == 'booktabs': |
| a.append('\\midrule\n') |
| if self._latex_type == 'longtable': |
| if 1 == self._translator.thead_depth(): |
| a.append('\\endfirsthead\n') |
| else: |
| a.append('\\endhead\n') |
| a.append(r'\multicolumn{%d}{c}' % len(self._col_specs) + |
| r'{\hfill ... continued on next page} \\') |
| a.append('\n\\endfoot\n\\endlastfoot\n') |
| # for longtable one could add firsthead, foot and lastfoot |
| self._in_thead -= 1 |
| return a |
| def visit_row(self): |
| self._cell_in_row = 0 |
| def depart_row(self): |
| res = [' \\\\\n'] |
| self._cell_in_row = None # remove cell counter |
| for i in range(len(self._rowspan)): |
| if (self._rowspan[i]>0): |
| self._rowspan[i] -= 1 |
| |
| if self._table_style == 'standard': |
| rowspans = [i+1 for i in range(len(self._rowspan)) |
| if (self._rowspan[i]<=0)] |
| if len(rowspans)==len(self._rowspan): |
| res.append('\\hline\n') |
| else: |
| cline = '' |
| rowspans.reverse() |
| # TODO merge clines |
| while 1: |
| try: |
| c_start = rowspans.pop() |
| except: |
| break |
| cline += '\\cline{%d-%d}\n' % (c_start,c_start) |
| res.append(cline) |
| return res |
| |
| def set_rowspan(self,cell,value): |
| try: |
| self._rowspan[cell] = value |
| except: |
| pass |
| def get_rowspan(self,cell): |
| try: |
| return self._rowspan[cell] |
| except: |
| return 0 |
| def get_entry_number(self): |
| return self._cell_in_row |
| def visit_entry(self): |
| self._cell_in_row += 1 |
| def is_stub_column(self): |
| if len(self.stubs) >= self._cell_in_row: |
| return self.stubs[self._cell_in_row-1] |
| return False |
| |
| |
| class LaTeXTranslator(nodes.NodeVisitor): |
| |
| # When options are given to the documentclass, latex will pass them |
| # to other packages, as done with babel. |
| # Dummy settings might be taken from document settings |
| |
| # Config setting defaults |
| # ----------------------- |
| |
| # TODO: use mixins for different implementations. |
| # list environment for docinfo. else tabularx |
| ## use_optionlist_for_docinfo = False # TODO: NOT YET IN USE |
| |
| # Use compound enumerations (1.A.1.) |
| compound_enumerators = 0 |
| |
| # If using compound enumerations, include section information. |
| section_prefix_for_enumerators = 0 |
| |
| # This is the character that separates the section ("." subsection ...) |
| # prefix from the regular list enumerator. |
| section_enumerator_separator = '-' |
| |
| # default link color |
| hyperlink_color = 'blue' |
| |
| # Auxiliary variables |
| # ------------------- |
| |
| has_latex_toc = False # is there a toc in the doc? (needed by minitoc) |
| is_toc_list = False # is the current bullet_list a ToC? |
| section_level = 0 |
| |
| # Flags to encode(): |
| # inside citation reference labels underscores dont need to be escaped |
| inside_citation_reference_label = False |
| verbatim = False # do not encode |
| insert_non_breaking_blanks = False # replace blanks by "~" |
| insert_newline = False # add latex newline commands |
| literal = False # literal text (block or inline) |
| |
| |
| def __init__(self, document): |
| nodes.NodeVisitor.__init__(self, document) |
| # Reporter |
| # ~~~~~~~~ |
| self.warn = self.document.reporter.warning |
| self.error = self.document.reporter.error |
| |
| # Settings |
| # ~~~~~~~~ |
| self.settings = settings = document.settings |
| self.latex_encoding = self.to_latex_encoding(settings.output_encoding) |
| self.use_latex_toc = settings.use_latex_toc |
| self.use_latex_docinfo = settings.use_latex_docinfo |
| self._use_latex_citations = settings.use_latex_citations |
| self.embed_stylesheet = settings.embed_stylesheet |
| self._reference_label = settings.reference_label |
| self.hyperlink_color = settings.hyperlink_color |
| self.compound_enumerators = settings.compound_enumerators |
| self.font_encoding = settings.font_encoding |
| self.section_prefix_for_enumerators = ( |
| settings.section_prefix_for_enumerators) |
| self.section_enumerator_separator = ( |
| settings.section_enumerator_separator.replace('_', '\\_')) |
| # literal blocks: |
| self.literal_block_env = '' |
| self.literal_block_options = '' |
| if settings.literal_block_env != '': |
| (none, |
| self.literal_block_env, |
| self.literal_block_options, |
| none ) = re.split('(\w+)(.*)', settings.literal_block_env) |
| elif settings.use_verbatim_when_possible: |
| self.literal_block_env = 'verbatim' |
| # |
| if self.settings.use_bibtex: |
| self.bibtex = self.settings.use_bibtex.split(',',1) |
| # TODO avoid errors on not declared citations. |
| else: |
| self.bibtex = None |
| # language: |
| # (labels, bibliographic_fields, and author_separators) |
| self.language = languages.get_language(settings.language_code) |
| self.babel = Babel(settings.language_code) |
| self.author_separator = self.language.author_separators[0] |
| self.d_options = [self.settings.documentoptions, |
| self.babel.get_language()] |
| self.d_options = ','.join([opt for opt in self.d_options if opt]) |
| self.d_class = DocumentClass(settings.documentclass, |
| settings.use_part_section) |
| # graphic package options: |
| if self.settings.graphicx_option == '': |
| self.graphicx_package = r'\usepackage{graphicx}' |
| elif self.settings.graphicx_option.lower() == 'auto': |
| self.graphicx_package = PreambleCmds.graphicx_auto |
| else: |
| self.graphicx_package = (r'\usepackage[%s]{graphicx}' % |
| self.settings.graphicx_option) |
| # footnotes: |
| self.docutils_footnotes = settings.docutils_footnotes |
| if settings.use_latex_footnotes: |
| self.docutils_footnotes = True |
| self.warn('`use_latex_footnotes` is deprecated. ' |
| 'The setting has been renamed to `docutils_footnotes` ' |
| 'and the alias will be removed in a future version.') |
| self.figure_footnotes = settings.figure_footnotes |
| if self.figure_footnotes: |
| self.docutils_footnotes = True |
| self.warn('The "figure footnotes" workaround/setting is strongly ' |
| 'deprecated and will be removed in a future version.') |
| |
| # Output collection stacks |
| # ~~~~~~~~~~~~~~~~~~~~~~~~ |
| |
| # Document parts |
| self.head_prefix = [r'\documentclass[%s]{%s}' % |
| (self.d_options, self.settings.documentclass)] |
| self.requirements = SortableDict() # made a list in depart_document() |
| self.latex_preamble = [settings.latex_preamble] |
| self.stylesheet = [] |
| self.fallbacks = SortableDict() # made a list in depart_document() |
| self.pdfsetup = [] # PDF properties (hyperref package) |
| self.title = [] |
| self.subtitle = [] |
| ## self.body_prefix = ['\\begin{document}\n'] |
| self.body_pre_docinfo = [] # title data and \maketitle |
| self.docinfo = [] |
| self.dedication = [] |
| self.abstract = [] |
| self.body = [] |
| ## self.body_suffix = ['\\end{document}\n'] |
| |
| # A heterogenous stack used in conjunction with the tree traversal. |
| # Make sure that the pops correspond to the pushes: |
| self.context = [] |
| |
| # Title metadata: |
| self.title_labels = [] |
| self.subtitle_labels = [] |
| # (if use_latex_docinfo: collects lists of |
| # author/organization/contact/address lines) |
| self.author_stack = [] |
| # date (the default supresses the "auto-date" feature of \maketitle) |
| self.date = [] |
| |
| # PDF properties: pdftitle, pdfauthor |
| # TODO?: pdfcreator, pdfproducer, pdfsubject, pdfkeywords |
| self.pdfinfo = [] |
| self.pdfauthor = [] |
| |
| # Stack of section counters so that we don't have to use_latex_toc. |
| # This will grow and shrink as processing occurs. |
| # Initialized for potential first-level sections. |
| self._section_number = [0] |
| |
| # The current stack of enumerations so that we can expand |
| # them into a compound enumeration. |
| self._enumeration_counters = [] |
| # The maximum number of enumeration counters we've used. |
| # If we go beyond this number, we need to create a new |
| # counter; otherwise, just reuse an old one. |
| self._max_enumeration_counters = 0 |
| |
| self._bibitems = [] |
| |
| # object for a table while proccessing. |
| self.table_stack = [] |
| self.active_table = Table(self, 'longtable', settings.table_style) |
| |
| # Where to collect the output of visitor methods (default: body) |
| self.out = self.body |
| self.out_stack = [] # stack of output collectors |
| |
| # Process settings |
| # ~~~~~~~~~~~~~~~~ |
| |
| # Static requirements |
| # TeX font encoding |
| if self.font_encoding: |
| encodings = [r'\usepackage[%s]{fontenc}' % self.font_encoding] |
| else: |
| encodings = [r'%\usepackage[OT1]{fontenc}'] # just a comment |
| # Docutils' output-encoding => TeX input encoding: |
| if self.latex_encoding != 'ascii': |
| encodings.append(r'\usepackage[%s]{inputenc}' |
| % self.latex_encoding) |
| self.requirements['_static'] = '\n'.join( |
| encodings + [ |
| r'\usepackage{ifthen}', |
| # multi-language support (language is in document options) |
| '\\usepackage{babel}%s' % self.babel.setup, |
| ]) |
| # page layout with typearea (if there are relevant document options) |
| if (settings.documentclass.find('scr') == -1 and |
| (self.d_options.find('DIV') != -1 or |
| self.d_options.find('BCOR') != -1)): |
| self.requirements['typearea'] = r'\usepackage{typearea}' |
| |
| # Stylesheets |
| # get list of style sheets from settings |
| styles = utils.get_stylesheet_list(settings) |
| # adapt path if --stylesheet_path is used |
| if settings.stylesheet_path and not(self.embed_stylesheet): |
| styles = [utils.relative_path(settings._destination, sheet) |
| for sheet in styles] |
| for sheet in styles: |
| (base, ext) = os.path.splitext(sheet) |
| is_package = ext in ['.sty', ''] |
| if self.embed_stylesheet: |
| if is_package: |
| sheet = base + '.sty' # adapt package name |
| # wrap in \makeatletter, \makeatother |
| wrapper = PreambleCmds.embedded_package_wrapper |
| else: |
| wrapper = '%% embedded stylesheet: %s\n%s' |
| settings.record_dependencies.add(sheet) |
| self.stylesheet.append(wrapper % |
| (sheet, io.FileInput(source_path=sheet, encoding='utf-8').read())) |
| else: # link to style sheet |
| if is_package: |
| self.stylesheet.append(r'\usepackage{%s}' % base) |
| else: |
| self.stylesheet.append(r'\input{%s}' % sheet) |
| |
| # PDF setup |
| if self.hyperlink_color == '0': |
| self.hyperlink_color = 'black' |
| self.colorlinks = 'false' |
| else: |
| self.colorlinks = 'true' |
| |
| # LaTeX Toc |
| # include all supported sections in toc and PDF bookmarks |
| # (or use documentclass-default (as currently))? |
| ## if self.use_latex_toc: |
| ## self.requirements['tocdepth'] = (r'\setcounter{tocdepth}{%d}' % |
| ## len(self.d_class.sections)) |
| |
| # LaTeX section numbering |
| if not self.settings.sectnum_xform: # section numbering by LaTeX: |
| # sectnum_depth: |
| # None "sectnum" directive without depth arg -> LaTeX default |
| # 0 no "sectnum" directive -> no section numbers |
| # else value of the "depth" argument: translate to LaTeX level |
| # -1 part (0 with "article" document class) |
| # 0 chapter (missing in "article" document class) |
| # 1 section |
| # 2 subsection |
| # 3 subsubsection |
| # 4 paragraph |
| # 5 subparagraph |
| if settings.sectnum_depth is not None: |
| # limit to supported levels |
| sectnum_depth = min(settings.sectnum_depth, |
| len(self.d_class.sections)) |
| # adjust to document class and use_part_section settings |
| if 'chapter' in self.d_class.sections: |
| sectnum_depth -= 1 |
| if self.d_class.sections[0] == 'part': |
| sectnum_depth -= 1 |
| self.requirements['sectnum_depth'] = ( |
| r'\setcounter{secnumdepth}{%d}' % sectnum_depth) |
| # start with specified number: |
| if (hasattr(settings, 'sectnum_start') and |
| settings.sectnum_start != 1): |
| self.requirements['sectnum_start'] = ( |
| r'\setcounter{%s}{%d}' % (self.d_class.sections[0], |
| settings.sectnum_start-1)) |
| # currently ignored (configure in a stylesheet): |
| ## settings.sectnum_prefix |
| ## settings.sectnum_suffix |
| |
| |
| # Auxiliary Methods |
| # ----------------- |
| |
| def to_latex_encoding(self,docutils_encoding): |
| """Translate docutils encoding name into LaTeX's. |
| |
| Default method is remove "-" and "_" chars from docutils_encoding. |
| """ |
| tr = { 'iso-8859-1': 'latin1', # west european |
| 'iso-8859-2': 'latin2', # east european |
| 'iso-8859-3': 'latin3', # esperanto, maltese |
| 'iso-8859-4': 'latin4', # north european, scandinavian, baltic |
| 'iso-8859-5': 'iso88595', # cyrillic (ISO) |
| 'iso-8859-9': 'latin5', # turkish |
| 'iso-8859-15': 'latin9', # latin9, update to latin1. |
| 'mac_cyrillic': 'maccyr', # cyrillic (on Mac) |
| 'windows-1251': 'cp1251', # cyrillic (on Windows) |
| 'koi8-r': 'koi8-r', # cyrillic (Russian) |
| 'koi8-u': 'koi8-u', # cyrillic (Ukrainian) |
| 'windows-1250': 'cp1250', # |
| 'windows-1252': 'cp1252', # |
| 'us-ascii': 'ascii', # ASCII (US) |
| # unmatched encodings |
| #'': 'applemac', |
| #'': 'ansinew', # windows 3.1 ansi |
| #'': 'ascii', # ASCII encoding for the range 32--127. |
| #'': 'cp437', # dos latin us |
| #'': 'cp850', # dos latin 1 |
| #'': 'cp852', # dos latin 2 |
| #'': 'decmulti', |
| #'': 'latin10', |
| #'iso-8859-6': '' # arabic |
| #'iso-8859-7': '' # greek |
| #'iso-8859-8': '' # hebrew |
| #'iso-8859-10': '' # latin6, more complete iso-8859-4 |
| } |
| encoding = docutils_encoding.lower() |
| if encoding in tr: |
| return tr[encoding] |
| # convert: latin-1, latin_1, utf-8 and similar things |
| encoding = encoding.replace('_', '').replace('-', '') |
| # strip the error handler |
| return encoding.split(':')[0] |
| |
| def language_label(self, docutil_label): |
| return self.language.labels[docutil_label] |
| |
| def ensure_math(self, text): |
| if not hasattr(self, 'ensure_math_re'): |
| chars = { # lnot,pm,twosuperior,threesuperior,mu,onesuperior,times,div |
| 'latin1' : '\xac\xb1\xb2\xb3\xb5\xb9\xd7\xf7' , # ¬±²³µ¹×÷ |
| # TODO?: use texcomp instead. |
| } |
| self.ensure_math_re = re.compile('([%s])' % chars['latin1']) |
| text = self.ensure_math_re.sub(r'\\ensuremath{\1}', text) |
| return text |
| |
| def encode(self, text): |
| """Return text with 'problematic' characters escaped. |
| |
| Escape the ten special printing characters ``# $ % & ~ _ ^ \ { }``, |
| square brackets ``[ ]``, double quotes and (in OT1) ``< | >``. |
| |
| Separate ``-`` (and more in literal text) to prevent input ligatures. |
| |
| Translate non-supported Unicode characters. |
| """ |
| if self.verbatim: |
| return text |
| # Separate compound characters, e.g. '--' to '-{}-'. |
| separate_chars = '-' |
| # In monospace-font, we also separate ',,', '``' and "''" and some |
| # other characters which can't occur in non-literal text. |
| if self.literal: |
| separate_chars += ',`\'"<>' |
| # LaTeX encoding maps: |
| special_chars = { |
| ord('#'): ur'\#', |
| ord('$'): ur'\$', |
| ord('%'): ur'\%', |
| ord('&'): ur'\&', |
| ord('~'): ur'\textasciitilde{}', |
| ord('_'): ur'\_', |
| ord('^'): ur'\textasciicircum{}', |
| ord('\\'): ur'\textbackslash{}', |
| ord('{'): ur'\{', |
| ord('}'): ur'\}', |
| # Square brackets are ordinary chars and cannot be escaped with '\', |
| # so we put them in a group '{[}'. (Alternative: ensure that all |
| # macros with optional arguments are terminated with {} and text |
| # inside any optional argument is put in a group ``[{text}]``). |
| # Commands with optional args inside an optional arg must be put |
| # in a group, e.g. ``\item[{\hyperref[label]{text}}]``. |
| ord('['): ur'{[}', |
| ord(']'): ur'{]}' |
| } |
| # Unicode chars that are not recognized by LaTeX's utf8 encoding |
| unsupported_unicode_chars = { |
| 0x00A0: ur'~', # NO-BREAK SPACE |
| 0x00AD: ur'\-', # SOFT HYPHEN |
| # |
| 0x2011: ur'\hbox{-}', # NON-BREAKING HYPHEN |
| 0x21d4: ur'$\Leftrightarrow$', |
| # Docutils footnote symbols: |
| 0x2660: ur'$\spadesuit$', |
| 0x2663: ur'$\clubsuit$', |
| } |
| # Unicode chars that are recognized by LaTeX's utf8 encoding |
| unicode_chars = { |
| 0x200C: ur'\textcompwordmark', # ZERO WIDTH NON-JOINER |
| 0x2013: ur'\textendash{}', |
| 0x2014: ur'\textemdash{}', |
| 0x2018: ur'\textquoteleft{}', |
| 0x2019: ur'\textquoteright{}', |
| 0x201A: ur'\quotesinglbase{}', # SINGLE LOW-9 QUOTATION MARK |
| 0x201C: ur'\textquotedblleft{}', |
| 0x201D: ur'\textquotedblright{}', |
| 0x201E: ur'\quotedblbase{}', # DOUBLE LOW-9 QUOTATION MARK |
| 0x2030: ur'\textperthousand{}', # PER MILLE SIGN |
| 0x2031: ur'\textpertenthousand{}', # PER TEN THOUSAND SIGN |
| 0x2039: ur'\guilsinglleft{}', |
| 0x203A: ur'\guilsinglright{}', |
| 0x2423: ur'\textvisiblespace{}', # OPEN BOX |
| 0x2020: ur'\dag{}', |
| 0x2021: ur'\ddag{}', |
| 0x2026: ur'\dots{}', |
| 0x2122: ur'\texttrademark{}', |
| } |
| # Unicode chars that require a feature/package to render |
| pifont_chars = { |
| 0x2665: ur'\ding{170}', # black heartsuit |
| 0x2666: ur'\ding{169}', # black diamondsuit |
| } |
| # recognized with 'utf8', if textcomp is loaded |
| textcomp_chars = { |
| # Latin-1 Supplement |
| 0x00a2: ur'\textcent{}', # ¢ CENT SIGN |
| 0x00a4: ur'\textcurrency{}', # ¤ CURRENCY SYMBOL |
| 0x00a5: ur'\textyen{}', # ¥ YEN SIGN |
| 0x00a6: ur'\textbrokenbar{}', # ¦ BROKEN BAR |
| 0x00a7: ur'\textsection{}', # § SECTION SIGN |
| 0x00a8: ur'\textasciidieresis{}', # ¨ DIAERESIS |
| 0x00a9: ur'\textcopyright{}', # © COPYRIGHT SIGN |
| 0x00aa: ur'\textordfeminine{}', # ª FEMININE ORDINAL INDICATOR |
| 0x00ac: ur'\textlnot{}', # ¬ NOT SIGN |
| 0x00ae: ur'\textregistered{}', # ® REGISTERED SIGN |
| 0x00af: ur'\textasciimacron{}', # ¯ MACRON |
| 0x00b0: ur'\textdegree{}', # ° DEGREE SIGN |
| 0x00b1: ur'\textpm{}', # ± PLUS-MINUS SIGN |
| 0x00b2: ur'\texttwosuperior{}', # ² SUPERSCRIPT TWO |
| 0x00b3: ur'\textthreesuperior{}', # ³ SUPERSCRIPT THREE |
| 0x00b4: ur'\textasciiacute{}', # ´ ACUTE ACCENT |
| 0x00b5: ur'\textmu{}', # µ MICRO SIGN |
| 0x00b6: ur'\textparagraph{}', # ¶ PILCROW SIGN # not equal to \textpilcrow |
| 0x00b9: ur'\textonesuperior{}', # ¹ SUPERSCRIPT ONE |
| 0x00ba: ur'\textordmasculine{}', # º MASCULINE ORDINAL INDICATOR |
| 0x00bc: ur'\textonequarter{}', # 1/4 FRACTION |
| 0x00bd: ur'\textonehalf{}', # 1/2 FRACTION |
| 0x00be: ur'\textthreequarters{}', # 3/4 FRACTION |
| 0x00d7: ur'\texttimes{}', # × MULTIPLICATION SIGN |
| 0x00f7: ur'\textdiv{}', # ÷ DIVISION SIGN |
| # |
| 0x0192: ur'\textflorin{}', # LATIN SMALL LETTER F WITH HOOK |
| 0x02b9: ur'\textasciiacute{}', # MODIFIER LETTER PRIME |
| 0x02ba: ur'\textacutedbl{}', # MODIFIER LETTER DOUBLE PRIME |
| 0x2016: ur'\textbardbl{}', # DOUBLE VERTICAL LINE |
| 0x2022: ur'\textbullet{}', # BULLET |
| 0x2032: ur'\textasciiacute{}', # PRIME |
| 0x2033: ur'\textacutedbl{}', # DOUBLE PRIME |
| 0x2035: ur'\textasciigrave{}', # REVERSED PRIME |
| 0x2036: ur'\textgravedbl{}', # REVERSED DOUBLE PRIME |
| 0x203b: ur'\textreferencemark{}', # REFERENCE MARK |
| 0x203d: ur'\textinterrobang{}', # INTERROBANG |
| 0x2044: ur'\textfractionsolidus{}', # FRACTION SLASH |
| 0x2045: ur'\textlquill{}', # LEFT SQUARE BRACKET WITH QUILL |
| 0x2046: ur'\textrquill{}', # RIGHT SQUARE BRACKET WITH QUILL |
| 0x2052: ur'\textdiscount{}', # COMMERCIAL MINUS SIGN |
| 0x20a1: ur'\textcolonmonetary{}', # COLON SIGN |
| 0x20a3: ur'\textfrenchfranc{}', # FRENCH FRANC SIGN |
| 0x20a4: ur'\textlira{}', # LIRA SIGN |
| 0x20a6: ur'\textnaira{}', # NAIRA SIGN |
| 0x20a9: ur'\textwon{}', # WON SIGN |
| 0x20ab: ur'\textdong{}', # DONG SIGN |
| 0x20ac: ur'\texteuro{}', # EURO SIGN |
| 0x20b1: ur'\textpeso{}', # PESO SIGN |
| 0x20b2: ur'\textguarani{}', # GUARANI SIGN |
| 0x2103: ur'\textcelsius{}', # DEGREE CELSIUS |
| 0x2116: ur'\textnumero{}', # NUMERO SIGN |
| 0x2117: ur'\textcircledP{}', # SOUND RECORDING COYRIGHT |
| 0x211e: ur'\textrecipe{}', # PRESCRIPTION TAKE |
| 0x2120: ur'\textservicemark{}', # SERVICE MARK |
| 0x2122: ur'\texttrademark{}', # TRADE MARK SIGN |
| 0x2126: ur'\textohm{}', # OHM SIGN |
| 0x2127: ur'\textmho{}', # INVERTED OHM SIGN |
| 0x212e: ur'\textestimated{}', # ESTIMATED SYMBOL |
| 0x2190: ur'\textleftarrow{}', # LEFTWARDS ARROW |
| 0x2191: ur'\textuparrow{}', # UPWARDS ARROW |
| 0x2192: ur'\textrightarrow{}', # RIGHTWARDS ARROW |
| 0x2193: ur'\textdownarrow{}', # DOWNWARDS ARROW |
| 0x2212: ur'\textminus{}', # MINUS SIGN |
| 0x2217: ur'\textasteriskcentered{}', # ASTERISK OPERATOR |
| 0x221a: ur'\textsurd{}', # SQUARE ROOT |
| 0x2422: ur'\textblank{}', # BLANK SYMBOL |
| 0x25e6: ur'\textopenbullet{}', # WHITE BULLET |
| 0x25ef: ur'\textbigcircle{}', # LARGE CIRCLE |
| 0x266a: ur'\textmusicalnote{}', # EIGHTH NOTE |
| 0x26ad: ur'\textmarried{}', # MARRIAGE SYMBOL |
| 0x26ae: ur'\textdivorced{}', # DIVORCE SYMBOL |
| 0x27e8: ur'\textlangle{}', # MATHEMATICAL LEFT ANGLE BRACKET |
| 0x27e9: ur'\textrangle{}', # MATHEMATICAL RIGHT ANGLE BRACKET |
| } |
| # TODO: greek alphabet ... ? |
| # see also LaTeX codec |
| # http://aspn.activestate.com/ASPN/Cookbook/Python/Recipe/252124 |
| # and unimap.py from TeXML |
| |
| # set up the translation table: |
| table = special_chars |
| # keep the underscore in citation references |
| if self.inside_citation_reference_label: |
| del(table[ord('_')]) |
| # Workarounds for OT1 font-encoding |
| if self.font_encoding in ['OT1', '']: |
| # * out-of-order characters in cmtt |
| if self.literal: |
| # replace underscore by underlined blank, |
| # because this has correct width. |
| table[ord('_')] = u'\\underline{~}' |
| # the backslash doesn't work, so we use a mirrored slash. |
| # \reflectbox is provided by graphicx: |
| self.requirements['graphicx'] = self.graphicx_package |
| table[ord('\\')] = ur'\reflectbox{/}' |
| # * ``< | >`` come out as different chars (except for cmtt): |
| else: |
| table[ord('|')] = ur'\textbar{}' |
| table[ord('<')] = ur'\textless{}' |
| table[ord('>')] = ur'\textgreater{}' |
| if self.insert_non_breaking_blanks: |
| table[ord(' ')] = ur'~' |
| if self.literal: |
| # double quotes are 'active' in some languages |
| table[ord('"')] = self.babel.literal_double_quote |
| else: |
| text = self.babel.quote_quotes(text) |
| # Unicode chars: |
| table.update(unsupported_unicode_chars) |
| table.update(pifont_chars) |
| if not self.latex_encoding.startswith('utf8'): |
| table.update(unicode_chars) |
| table.update(textcomp_chars) |
| # Characters that require a feature/package to render |
| for ch in text: |
| if ord(ch) in pifont_chars: |
| self.requirements['pifont'] = '\\usepackage{pifont}' |
| if ord(ch) in textcomp_chars: |
| self.requirements['textcomp'] = PreambleCmds.textcomp |
| |
| text = text.translate(table) |
| |
| # Break up input ligatures |
| for char in separate_chars * 2: |
| # Do it twice ("* 2") because otherwise we would replace |
| # '---' by '-{}--'. |
| text = text.replace(char + char, char + '{}' + char) |
| # Literal line breaks (in address or literal blocks): |
| if self.insert_newline: |
| # for blank lines, insert a protected space, to avoid |
| # ! LaTeX Error: There's no line here to end. |
| textlines = [line + '~'*(not line.lstrip()) |
| for line in text.split('\n')] |
| text = '\\\\\n'.join(textlines) |
| if self.literal and not self.insert_non_breaking_blanks: |
| # preserve runs of spaces but allow wrapping |
| text = text.replace(' ', ' ~') |
| if not self.latex_encoding.startswith('utf8'): |
| text = self.ensure_math(text) |
| return text |
| |
| def attval(self, text, |
| whitespace=re.compile('[\n\r\t\v\f]')): |
| """Cleanse, encode, and return attribute value text.""" |
| return self.encode(whitespace.sub(' ', text)) |
| |
| # TODO: is this used anywhere? (update or delete) |
| ## def astext(self): |
| ## """Assemble document parts and return as string.""" |
| ## head = '\n'.join(self.head_prefix + self.stylesheet + self.head) |
| ## body = ''.join(self.body_prefix + self.body + self.body_suffix) |
| ## return head + '\n' + body |
| |
| def is_inline(self, node): |
| """Check whether a node represents an inline element""" |
| return isinstance(node.parent, nodes.TextElement) |
| |
| def append_hypertargets(self, node): |
| """Append hypertargets for all ids of `node`""" |
| # hypertarget places the anchor at the target's baseline, |
| # so we raise it explicitely |
| self.out.append('%\n'.join(['\\raisebox{1em}{\\hypertarget{%s}{}}' % |
| id for id in node['ids']])) |
| |
| def ids_to_labels(self, node, set_anchor=True): |
| """Return list of label definitions for all ids of `node` |
| |
| If `set_anchor` is True, an anchor is set with \phantomsection. |
| """ |
| labels = ['\\label{%s}' % id for id in node.get('ids', [])] |
| if set_anchor and labels: |
| labels.insert(0, '\\phantomsection') |
| return labels |
| |
| def push_output_collector(self, new_out): |
| self.out_stack.append(self.out) |
| self.out = new_out |
| |
| def pop_output_collector(self): |
| self.out = self.out_stack.pop() |
| |
| # Visitor methods |
| # --------------- |
| |
| def visit_Text(self, node): |
| self.out.append(self.encode(node.astext())) |
| |
| def depart_Text(self, node): |
| pass |
| |
| def visit_address(self, node): |
| self.visit_docinfo_item(node, 'address') |
| |
| def depart_address(self, node): |
| self.depart_docinfo_item(node) |
| |
| def visit_admonition(self, node): |
| self.fallbacks['admonition'] = PreambleCmds.admonition |
| if 'error' in node['classes']: |
| self.fallbacks['error'] = PreambleCmds.error |
| # strip the generic 'admonition' from the list of classes |
| node['classes'] = [cls for cls in node['classes'] |
| if cls != 'admonition'] |
| self.out.append('\n\\DUadmonition[%s]{\n' % ','.join(node['classes'])) |
| |
| def depart_admonition(self, node=None): |
| self.out.append('}\n') |
| |
| def visit_author(self, node): |
| self.visit_docinfo_item(node, 'author') |
| |
| def depart_author(self, node): |
| self.depart_docinfo_item(node) |
| |
| def visit_authors(self, node): |
| # not used: visit_author is called anyway for each author. |
| pass |
| |
| def depart_authors(self, node): |
| pass |
| |
| def visit_block_quote(self, node): |
| self.out.append( '%\n\\begin{quote}\n') |
| |
| def depart_block_quote(self, node): |
| self.out.append( '\n\\end{quote}\n') |
| |
| def visit_bullet_list(self, node): |
| if self.is_toc_list: |
| self.out.append( '%\n\\begin{list}{}{}\n' ) |
| else: |
| self.out.append( '%\n\\begin{itemize}\n' ) |
| |
| def depart_bullet_list(self, node): |
| if self.is_toc_list: |
| self.out.append( '\n\\end{list}\n' ) |
| else: |
| self.out.append( '\n\\end{itemize}\n' ) |
| |
| def visit_superscript(self, node): |
| self.out.append(r'\textsuperscript{') |
| if node['classes']: |
| self.visit_inline(node) |
| |
| def depart_superscript(self, node): |
| if node['classes']: |
| self.depart_inline(node) |
| self.out.append('}') |
| |
| def visit_subscript(self, node): |
| self.out.append(r'\textsubscript{') # requires `fixltx2e` |
| if node['classes']: |
| self.visit_inline(node) |
| |
| def depart_subscript(self, node): |
| if node['classes']: |
| self.depart_inline(node) |
| self.out.append('}') |
| |
| def visit_caption(self, node): |
| self.out.append( '\\caption{' ) |
| |
| def depart_caption(self, node): |
| self.out.append('}\n') |
| |
| def visit_title_reference(self, node): |
| self.fallbacks['titlereference'] = PreambleCmds.titlereference |
| self.out.append(r'\DUroletitlereference{') |
| if node['classes']: |
| self.visit_inline(node) |
| |
| def depart_title_reference(self, node): |
| if node['classes']: |
| self.depart_inline(node) |
| self.out.append( '}' ) |
| |
| def visit_citation(self, node): |
| # TODO maybe use cite bibitems |
| if self._use_latex_citations: |
| self.push_output_collector([]) |
| else: |
| # TODO: do we need these? |
| ## self.requirements['~fnt_floats'] = PreambleCmds.footnote_floats |
| self.out.append(r'\begin{figure}[b]') |
| self.append_hypertargets(node) |
| |
| def depart_citation(self, node): |
| if self._use_latex_citations: |
| label = self.out[0] |
| text = ''.join(self.out[1:]) |
| self._bibitems.append([label, text]) |
| self.pop_output_collector() |
| else: |
| self.out.append('\\end{figure}\n') |
| |
| def visit_citation_reference(self, node): |
| if self._use_latex_citations: |
| if not self.inside_citation_reference_label: |
| self.out.append(r'\cite{') |
| self.inside_citation_reference_label = 1 |
| else: |
| assert self.body[-1] in (' ', '\n'),\ |
| 'unexpected non-whitespace while in reference label' |
| del self.body[-1] |
| else: |
| href = '' |
| if 'refid' in node: |
| href = node['refid'] |
| elif 'refname' in node: |
| href = self.document.nameids[node['refname']] |
| self.out.append('[\\hyperlink{%s}{' % href) |
| |
| def depart_citation_reference(self, node): |
| if self._use_latex_citations: |
| followup_citation = False |
| # check for a following citation separated by a space or newline |
| next_siblings = node.traverse(descend=0, siblings=1, |
| include_self=0) |
| if len(next_siblings) > 1: |
| next = next_siblings[0] |
| if (isinstance(next, nodes.Text) and |
| next.astext() in (' ', '\n')): |
| if next_siblings[1].__class__ == node.__class__: |
| followup_citation = True |
| if followup_citation: |
| self.out.append(',') |
| else: |
| self.out.append('}') |
| self.inside_citation_reference_label = False |
| else: |
| self.out.append('}]') |
| |
| def visit_classifier(self, node): |
| self.out.append( '(\\textbf{' ) |
| |
| def depart_classifier(self, node): |
| self.out.append( '})\n' ) |
| |
| def visit_colspec(self, node): |
| self.active_table.visit_colspec(node) |
| |
| def depart_colspec(self, node): |
| pass |
| |
| def visit_comment(self, node): |
| # Precede every line with a comment sign, wrap in newlines |
| self.out.append('\n%% %s\n' % node.astext().replace('\n', '\n% ')) |
| raise nodes.SkipNode |
| |
| def depart_comment(self, node): |
| pass |
| |
| def visit_compound(self, node): |
| pass |
| |
| def depart_compound(self, node): |
| pass |
| |
| def visit_contact(self, node): |
| self.visit_docinfo_item(node, 'contact') |
| |
| def depart_contact(self, node): |
| self.depart_docinfo_item(node) |
| |
| def visit_container(self, node): |
| pass |
| |
| def depart_container(self, node): |
| pass |
| |
| def visit_copyright(self, node): |
| self.visit_docinfo_item(node, 'copyright') |
| |
| def depart_copyright(self, node): |
| self.depart_docinfo_item(node) |
| |
| def visit_date(self, node): |
| self.visit_docinfo_item(node, 'date') |
| |
| def depart_date(self, node): |
| self.depart_docinfo_item(node) |
| |
| def visit_decoration(self, node): |
| # header and footer |
| pass |
| |
| def depart_decoration(self, node): |
| pass |
| |
| def visit_definition(self, node): |
| pass |
| |
| def depart_definition(self, node): |
| self.out.append('\n') |
| |
| def visit_definition_list(self, node): |
| self.out.append( '%\n\\begin{description}\n' ) |
| |
| def depart_definition_list(self, node): |
| self.out.append( '\\end{description}\n' ) |
| |
| def visit_definition_list_item(self, node): |
| pass |
| |
| def depart_definition_list_item(self, node): |
| pass |
| |
| def visit_description(self, node): |
| self.out.append(' ') |
| |
| def depart_description(self, node): |
| pass |
| |
| def visit_docinfo(self, node): |
| self.push_output_collector(self.docinfo) |
| |
| def depart_docinfo(self, node): |
| self.pop_output_collector() |
| # Some itmes (e.g. author) end up at other places |
| if self.docinfo: |
| # tabularx: automatic width of columns, no page breaks allowed. |
| self.requirements['tabularx'] = r'\usepackage{tabularx}' |
| self.fallbacks['_providelength'] = PreambleCmds.providelength |
| self.fallbacks['docinfo'] = PreambleCmds.docinfo |
| # |
| self.docinfo.insert(0, '\n% Docinfo\n' |
| '\\begin{center}\n' |
| '\\begin{tabularx}{\\DUdocinfowidth}{lX}\n') |
| self.docinfo.append('\\end{tabularx}\n' |
| '\\end{center}\n') |
| |
| def visit_docinfo_item(self, node, name): |
| if name == 'author': |
| self.pdfauthor.append(self.attval(node.astext())) |
| if self.use_latex_docinfo: |
| if name in ('author', 'organization', 'contact', 'address'): |
| # We attach these to the last author. If any of them precedes |
| # the first author, put them in a separate "author" group |
| # (in lack of better semantics). |
| if name == 'author' or not self.author_stack: |
| self.author_stack.append([]) |
| if name == 'address': # newlines are meaningful |
| self.insert_newline = 1 |
| text = self.encode(node.astext()) |
| self.insert_newline = False |
| else: |
| text = self.attval(node.astext()) |
| self.author_stack[-1].append(text) |
| raise nodes.SkipNode |
| elif name == 'date': |
| self.date.append(self.attval(node.astext())) |
| raise nodes.SkipNode |
| self.out.append('\\textbf{%s}: &\n\t' % self.language_label(name)) |
| if name == 'address': |
| self.insert_newline = 1 |
| self.out.append('{\\raggedright\n') |
| self.context.append(' } \\\\\n') |
| else: |
| self.context.append(' \\\\\n') |
| |
| def depart_docinfo_item(self, node): |
| self.out.append(self.context.pop()) |
| # for address we did set insert_newline |
| self.insert_newline = False |
| |
| def visit_doctest_block(self, node): |
| self.visit_literal_block(node) |
| |
| def depart_doctest_block(self, node): |
| self.depart_literal_block(node) |
| |
| def visit_document(self, node): |
| # titled document? |
| if (self.use_latex_docinfo or len(node) and |
| isinstance(node[0], nodes.title)): |
| self.title_labels += self.ids_to_labels(node) |
| |
| def depart_document(self, node): |
| # Complete header with information gained from walkabout |
| # a) conditional requirements (before style sheet) |
| self.requirements = self.requirements.sortedvalues() |
| # b) coditional fallback definitions (after style sheet) |
| self.fallbacks = self.fallbacks.sortedvalues() |
| # c) PDF properties |
| self.pdfsetup.append(PreambleCmds.linking % (self.colorlinks, |
| self.hyperlink_color, |
| self.hyperlink_color)) |
| if self.pdfauthor: |
| authors = self.author_separator.join(self.pdfauthor) |
| self.pdfinfo.append(' pdfauthor={%s}' % authors) |
| if self.pdfinfo: |
| self.pdfsetup += [r'\hypersetup{'] + self.pdfinfo + ['}'] |
| # Complete body |
| # a) document title (part 'body_prefix'): |
| # NOTE: Docutils puts author/date into docinfo, so normally |
| # we do not want LaTeX author/date handling (via \maketitle). |
| # To deactivate it, we add \title, \author, \date, |
| # even if the arguments are empty strings. |
| if self.title or self.author_stack or self.date: |
| authors = ['\\\\\n'.join(author_entry) |
| for author_entry in self.author_stack] |
| title = [''.join(self.title)] + self.title_labels |
| if self.subtitle: |
| title += [r'\\ % subtitle', |
| r'\large{%s}' % ''.join(self.subtitle) |
| ] + self.subtitle_labels |
| self.body_pre_docinfo.append(PreambleCmds.documenttitle % ( |
| '%\n '.join(title), |
| ' \\and\n'.join(authors), |
| ', '.join(self.date))) |
| # b) bibliography |
| # TODO insertion point of bibliography should be configurable. |
| if self._use_latex_citations and len(self._bibitems)>0: |
| if not self.bibtex: |
| widest_label = '' |
| for bi in self._bibitems: |
| if len(widest_label)<len(bi[0]): |
| widest_label = bi[0] |
| self.out.append('\n\\begin{thebibliography}{%s}\n' % |
| widest_label) |
| for bi in self._bibitems: |
| # cite_key: underscores must not be escaped |
| cite_key = bi[0].replace(r'\_','_') |
| self.out.append('\\bibitem[%s]{%s}{%s}\n' % |
| (bi[0], cite_key, bi[1])) |
| self.out.append('\\end{thebibliography}\n') |
| else: |
| self.out.append('\n\\bibliographystyle{%s}\n' % |
| self.bibtex[0]) |
| self.out.append('\\bibliography{%s}\n' % self.bibtex[1]) |
| # c) make sure to generate a toc file if needed for local contents: |
| if 'minitoc' in self.requirements and not self.has_latex_toc: |
| self.out.append('\n\\faketableofcontents % for local ToCs\n') |
| |
| def visit_emphasis(self, node): |
| self.out.append('\\emph{') |
| if node['classes']: |
| self.visit_inline(node) |
| |
| def depart_emphasis(self, node): |
| if node['classes']: |
| self.depart_inline(node) |
| self.out.append('}') |
| |
| def visit_entry(self, node): |
| self.active_table.visit_entry() |
| # cell separation |
| # BUG: the following fails, with more than one multirow |
| # starting in the second column (or later) see |
| # ../../../test/functional/input/data/latex.txt |
| if self.active_table.get_entry_number() == 1: |
| # if the first row is a multirow, this actually is the second row. |
| # this gets hairy if rowspans follow each other. |
| if self.active_table.get_rowspan(0): |
| count = 0 |
| while self.active_table.get_rowspan(count): |
| count += 1 |
| self.out.append(' & ') |
| self.active_table.visit_entry() # increment cell count |
| else: |
| self.out.append(' & ') |
| # multirow, multicolumn |
| # IN WORK BUG TODO HACK continues here |
| # multirow in LaTeX simply will enlarge the cell over several rows |
| # (the following n if n is positive, the former if negative). |
| if 'morerows' in node and 'morecols' in node: |
| raise NotImplementedError('Cells that ' |
| 'span multiple rows *and* columns are not supported, sorry.') |
| if 'morerows' in node: |
| self.requirements['multirow'] = r'\usepackage{multirow}' |
| count = node['morerows'] + 1 |
| self.active_table.set_rowspan( |
| self.active_table.get_entry_number()-1,count) |
| self.out.append('\\multirow{%d}{%s}{%%' % |
| (count,self.active_table.get_column_width())) |
| self.context.append('}') |
| elif 'morecols' in node: |
| # the vertical bar before column is missing if it is the first |
| # column. the one after always. |
| if self.active_table.get_entry_number() == 1: |
| bar1 = self.active_table.get_vertical_bar() |
| else: |
| bar1 = '' |
| count = node['morecols'] + 1 |
| self.out.append('\\multicolumn{%d}{%sl%s}{' % |
| (count, bar1, self.active_table.get_vertical_bar())) |
| self.context.append('}') |
| else: |
| self.context.append('') |
| |
| # header / not header |
| if isinstance(node.parent.parent, nodes.thead): |
| self.out.append('\\textbf{%') |
| self.context.append('}') |
| elif self.active_table.is_stub_column(): |
| self.out.append('\\textbf{') |
| self.context.append('}') |
| else: |
| self.context.append('') |
| |
| def depart_entry(self, node): |
| self.out.append(self.context.pop()) # header / not header |
| self.out.append(self.context.pop()) # multirow/column |
| # if following row is spanned from above. |
| if self.active_table.get_rowspan(self.active_table.get_entry_number()): |
| self.out.append(' & ') |
| self.active_table.visit_entry() # increment cell count |
| |
| def visit_row(self, node): |
| self.active_table.visit_row() |
| |
| def depart_row(self, node): |
| self.out.extend(self.active_table.depart_row()) |
| |
| def visit_enumerated_list(self, node): |
| # We create our own enumeration list environment. |
| # This allows to set the style and starting value |
| # and unlimited nesting. |
| enum_style = {'arabic':'arabic', |
| 'loweralpha':'alph', |
| 'upperalpha':'Alph', |
| 'lowerroman':'roman', |
| 'upperroman':'Roman' } |
| enum_suffix = '' |
| if 'suffix' in node: |
| enum_suffix = node['suffix'] |
| enum_prefix = '' |
| if 'prefix' in node: |
| enum_prefix = node['prefix'] |
| if self.compound_enumerators: |
| pref = '' |
| if self.section_prefix_for_enumerators and self.section_level: |
| for i in range(self.section_level): |
| pref += '%d.' % self._section_number[i] |
| pref = pref[:-1] + self.section_enumerator_separator |
| enum_prefix += pref |
| for ctype, cname in self._enumeration_counters: |
| enum_prefix += '\\%s{%s}.' % (ctype, cname) |
| enum_type = 'arabic' |
| if 'enumtype' in node: |
| enum_type = node['enumtype'] |
| if enum_type in enum_style: |
| enum_type = enum_style[enum_type] |
| |
| counter_name = 'listcnt%d' % len(self._enumeration_counters) |
| self._enumeration_counters.append((enum_type, counter_name)) |
| # If we haven't used this counter name before, then create a |
| # new counter; otherwise, reset & reuse the old counter. |
| if len(self._enumeration_counters) > self._max_enumeration_counters: |
| self._max_enumeration_counters = len(self._enumeration_counters) |
| self.out.append('\\newcounter{%s}\n' % counter_name) |
| else: |
| self.out.append('\\setcounter{%s}{0}\n' % counter_name) |
| |
| self.out.append('\\begin{list}{%s\\%s{%s}%s}\n' % |
| (enum_prefix,enum_type,counter_name,enum_suffix)) |
| self.out.append('{\n') |
| self.out.append('\\usecounter{%s}\n' % counter_name) |
| # set start after usecounter, because it initializes to zero. |
| if 'start' in node: |
| self.out.append('\\addtocounter{%s}{%d}\n' % |
| (counter_name,node['start']-1)) |
| ## set rightmargin equal to leftmargin |
| self.out.append('\\setlength{\\rightmargin}{\\leftmargin}\n') |
| self.out.append('}\n') |
| |
| def depart_enumerated_list(self, node): |
| self.out.append('\\end{list}\n') |
| self._enumeration_counters.pop() |
| |
| def visit_field(self, node): |
| # real output is done in siblings: _argument, _body, _name |
| pass |
| |
| def depart_field(self, node): |
| self.out.append('\n') |
| ##self.out.append('%[depart_field]\n') |
| |
| def visit_field_argument(self, node): |
| self.out.append('%[visit_field_argument]\n') |
| |
| def depart_field_argument(self, node): |
| self.out.append('%[depart_field_argument]\n') |
| |
| def visit_field_body(self, node): |
| pass |
| |
| def depart_field_body(self, node): |
| if self.out is self.docinfo: |
| self.out.append(r'\\') |
| |
| def visit_field_list(self, node): |
| if self.out is not self.docinfo: |
| self.fallbacks['fieldlist'] = PreambleCmds.fieldlist |
| self.out.append('%\n\\begin{DUfieldlist}\n') |
| |
| def depart_field_list(self, node): |
| if self.out is not self.docinfo: |
| self.out.append('\\end{DUfieldlist}\n') |
| |
| def visit_field_name(self, node): |
| if self.out is self.docinfo: |
| self.out.append('\\textbf{') |
| else: |
| # Commands with optional args inside an optional arg must be put |
| # in a group, e.g. ``\item[{\hyperref[label]{text}}]``. |
| self.out.append('\\item[{') |
| |
| def depart_field_name(self, node): |
| if self.out is self.docinfo: |
| self.out.append('}: &') |
| else: |
| self.out.append(':}]') |
| |
| def visit_figure(self, node): |
| self.requirements['float_settings'] = PreambleCmds.float_settings |
| # ! the 'align' attribute should set "outer alignment" ! |
| # For "inner alignment" use LaTeX default alignment (similar to HTML) |
| ## if ('align' not in node.attributes or |
| ## node.attributes['align'] == 'center'): |
| ## align = '\n\\centering' |
| ## align_end = '' |
| ## else: |
| ## # TODO non vertical space for other alignments. |
| ## align = '\\begin{flush%s}' % node.attributes['align'] |
| ## align_end = '\\end{flush%s}' % node.attributes['align'] |
| ## self.out.append( '\\begin{figure}%s\n' % align ) |
| ## self.context.append( '%s\\end{figure}\n' % align_end ) |
| self.out.append('\\begin{figure}') |
| if node.get('ids'): |
| self.out += ['\n'] + self.ids_to_labels(node) |
| |
| def depart_figure(self, node): |
| self.out.append('\\end{figure}\n') |
| |
| def visit_footer(self, node): |
| self.push_output_collector([]) |
| self.out.append(r'\newcommand{\DUfooter}{') |
| |
| def depart_footer(self, node): |
| self.out.append('}') |
| self.requirements['~footer'] = ''.join(self.out) |
| self.pop_output_collector() |
| |
| def visit_footnote(self, node): |
| try: |
| backref = node['backrefs'][0] |
| except IndexError: |
| backref = node['ids'][0] # no backref, use self-ref instead |
| if self.settings.figure_footnotes: |
| self.requirements['~fnt_floats'] = PreambleCmds.footnote_floats |
| self.out.append('\\begin{figure}[b]') |
| self.append_hypertargets(node) |
| if node.get('id') == node.get('name'): # explicite label |
| self.out += self.ids_to_labels(node) |
| elif self.docutils_footnotes: |
| self.fallbacks['footnotes'] = PreambleCmds.footnotes |
| num,text = node.astext().split(None,1) |
| if self.settings.footnote_references == 'brackets': |
| num = '[%s]' % num |
| self.out.append('%%\n\\DUfootnotetext{%s}{%s}{%s}{' % |
| (node['ids'][0], backref, self.encode(num))) |
| if node['ids'] == node['names']: |
| self.out += self.ids_to_labels(node) |
| # mask newline to prevent spurious whitespace: |
| self.out.append('%') |
| ## else: # TODO: "real" LaTeX \footnote{}s |
| |
| def depart_footnote(self, node): |
| if self.figure_footnotes: |
| self.out.append('\\end{figure}\n') |
| else: |
| self.out.append('}\n') |
| |
| def visit_footnote_reference(self, node): |
| href = '' |
| if 'refid' in node: |
| href = node['refid'] |
| elif 'refname' in node: |
| href = self.document.nameids[node['refname']] |
| # if not self.docutils_footnotes: |
| # TODO: insert footnote content at (or near) this place |
| # print "footnote-ref to", node['refid'] |
| # footnotes = (self.document.footnotes + |
| # self.document.autofootnotes + |
| # self.document.symbol_footnotes) |
| # for footnote in footnotes: |
| # # print footnote['ids'] |
| # if node.get('refid', '') in footnote['ids']: |
| # print 'matches', footnote['ids'] |
| format = self.settings.footnote_references |
| if format == 'brackets': |
| self.append_hypertargets(node) |
| self.out.append('\\hyperlink{%s}{[' % href) |
| self.context.append(']}') |
| else: |
| self.fallbacks['footnotes'] = PreambleCmds.footnotes |
| self.out.append(r'\DUfootnotemark{%s}{%s}{' % |
| (node['ids'][0], href)) |
| self.context.append('}') |
| |
| def depart_footnote_reference(self, node): |
| self.out.append(self.context.pop()) |
| |
| # footnote/citation label |
| def label_delim(self, node, bracket, superscript): |
| if isinstance(node.parent, nodes.footnote): |
| if not self.figure_footnotes: |
| raise nodes.SkipNode |
| if self.settings.footnote_references == 'brackets': |
| self.out.append(bracket) |
| else: |
| self.out.append(superscript) |
| else: |
| assert isinstance(node.parent, nodes.citation) |
| if not self._use_latex_citations: |
| self.out.append(bracket) |
| |
| def visit_label(self, node): |
| """footnote or citation label: in brackets or as superscript""" |
| self.label_delim(node, '[', '\\textsuperscript{') |
| |
| def depart_label(self, node): |
| self.label_delim(node, ']', '}') |
| |
| # elements generated by the framework e.g. section numbers. |
| def visit_generated(self, node): |
| pass |
| |
| def depart_generated(self, node): |
| pass |
| |
| def visit_header(self, node): |
| self.push_output_collector([]) |
| self.out.append(r'\newcommand{\DUheader}{') |
| |
| def depart_header(self, node): |
| self.out.append('}') |
| self.requirements['~header'] = ''.join(self.out) |
| self.pop_output_collector() |
| |
| def to_latex_length(self, length_str): |
| """Convert string with rst lenght to LaTeX""" |
| match = re.match('(\d*\.?\d*)\s*(\S*)', length_str) |
| if not match: |
| return length_str |
| value, unit = match.groups()[:2] |
| # no unit or "DTP" points (called 'bp' in TeX): |
| if unit in ('', 'pt'): |
| length_str = '%sbp' % value |
| # percentage: relate to current line width |
| elif unit == '%': |
| length_str = '%.3f\\linewidth' % (float(value)/100.0) |
| return length_str |
| |
| def visit_image(self, node): |
| self.requirements['graphicx'] = self.graphicx_package |
| attrs = node.attributes |
| # Add image URI to dependency list, assuming that it's |
| # referring to a local file. |
| self.settings.record_dependencies.add(attrs['uri']) |
| # alignment defaults: |
| if not 'align' in attrs: |
| # Set default align of image in a figure to 'center' |
| if isinstance(node.parent, nodes.figure): |
| attrs['align'] = 'center' |
| # query 'align-*' class argument |
| for cls in node['classes']: |
| if cls.startswith('align-'): |
| attrs['align'] = cls.split('-')[1] |
| # pre- and postfix (prefix inserted in reverse order) |
| pre = [] |
| post = [] |
| include_graphics_options = [] |
| display_style = ('block-', 'inline-')[self.is_inline(node)] |
| align_codes = { |
| # inline images: by default latex aligns the bottom. |
| 'bottom': ('', ''), |
| 'middle': (r'\raisebox{-0.5\height}{', '}'), |
| 'top': (r'\raisebox{-\height}{', '}'), |
| # block level images: |
| 'center': (r'\noindent\makebox[\textwidth][c]{', '}'), |
| 'left': (r'\noindent{', r'\hfill}'), |
| 'right': (r'\noindent{\hfill', '}'),} |
| if 'align' in attrs: |
| try: |
| align_code = align_codes[attrs['align']] |
| pre.append(align_code[0]) |
| post.append(align_code[1]) |
| except KeyError: |
| pass # TODO: warn? |
| if 'height' in attrs: |
| include_graphics_options.append('height=%s' % |
| self.to_latex_length(attrs['height'])) |
| if 'scale' in attrs: |
| include_graphics_options.append('scale=%f' % |
| (attrs['scale'] / 100.0)) |
| if 'width' in attrs: |
| include_graphics_options.append('width=%s' % |
| self.to_latex_length(attrs['width'])) |
| if not self.is_inline(node): |
| pre.append('\n') |
| post.append('\n') |
| pre.reverse() |
| self.out.extend(pre) |
| options = '' |
| if include_graphics_options: |
| options = '[%s]' % (','.join(include_graphics_options)) |
| self.out.append('\\includegraphics%s{%s}' % (options, attrs['uri'])) |
| self.out.extend(post) |
| |
| def depart_image(self, node): |
| if node.get('ids'): |
| self.out += self.ids_to_labels(node) + ['\n'] |
| |
| def visit_interpreted(self, node): |
| # @@@ Incomplete, pending a proper implementation on the |
| # Parser/Reader end. |
| self.visit_literal(node) |
| |
| def depart_interpreted(self, node): |
| self.depart_literal(node) |
| |
| def visit_legend(self, node): |
| self.fallbacks['legend'] = PreambleCmds.legend |
| self.out.append('\\begin{DUlegend}') |
| |
| def depart_legend(self, node): |
| self.out.append('\\end{DUlegend}\n') |
| |
| def visit_line(self, node): |
| self.out.append('\item[] ') |
| |
| def depart_line(self, node): |
| self.out.append('\n') |
| |
| def visit_line_block(self, node): |
| self.fallbacks['_providelength'] = PreambleCmds.providelength |
| self.fallbacks['lineblock'] = PreambleCmds.lineblock |
| if isinstance(node.parent, nodes.line_block): |
| self.out.append('\\item[]\n' |
| '\\begin{DUlineblock}{\\DUlineblockindent}\n') |
| else: |
| self.out.append('\n\\begin{DUlineblock}{0em}\n') |
| |
| def depart_line_block(self, node): |
| self.out.append('\\end{DUlineblock}\n') |
| |
| def visit_list_item(self, node): |
| self.out.append('\n\\item ') |
| |
| def depart_list_item(self, node): |
| pass |
| |
| def visit_literal(self, node): |
| self.literal = True |
| self.out.append('\\texttt{') |
| if node['classes']: |
| self.visit_inline(node) |
| |
| def depart_literal(self, node): |
| self.literal = False |
| if node['classes']: |
| self.depart_inline(node) |
| self.out.append('}') |
| |
| # Literal blocks are used for '::'-prefixed literal-indented |
| # blocks of text, where the inline markup is not recognized, |
| # but are also the product of the "parsed-literal" directive, |
| # where the markup is respected. |
| # |
| # In both cases, we want to use a typewriter/monospaced typeface. |
| # For "real" literal-blocks, we can use \verbatim, while for all |
| # the others we must use \mbox or \alltt. |
| # |
| # We can distinguish between the two kinds by the number of |
| # siblings that compose this node: if it is composed by a |
| # single element, it's either |
| # * a real one, |
| # * a parsed-literal that does not contain any markup, or |
| # * a parsed-literal containing just one markup construct. |
| def is_plaintext(self, node): |
| """Check whether a node can be typeset verbatim""" |
| return (len(node) == 1) and isinstance(node[0], nodes.Text) |
| |
| def visit_literal_block(self, node): |
| """Render a literal block.""" |
| # environments and packages to typeset literal blocks |
| packages = {'listing': r'\usepackage{moreverb}', |
| 'lstlisting': r'\usepackage{listings}', |
| 'Verbatim': r'\usepackage{fancyvrb}', |
| # 'verbatim': '', |
| 'verbatimtab': r'\usepackage{moreverb}'} |
| |
| if not self.active_table.is_open(): |
| # no quote inside tables, to avoid vertical space between |
| # table border and literal block. |
| # BUG: fails if normal text preceeds the literal block. |
| self.out.append('%\n\\begin{quote}') |
| self.context.append('\n\\end{quote}\n') |
| else: |
| self.out.append('\n') |
| self.context.append('\n') |
| if self.literal_block_env != '' and self.is_plaintext(node): |
| self.requirements['literal_block'] = packages.get( |
| self.literal_block_env, '') |
| self.verbatim = True |
| self.out.append('\\begin{%s}%s\n' % (self.literal_block_env, |
| self.literal_block_options)) |
| else: |
| self.literal = True |
| self.insert_newline = True |
| self.insert_non_breaking_blanks = True |
| self.out.append('{\\ttfamily \\raggedright \\noindent\n') |
| |
| def depart_literal_block(self, node): |
| if self.verbatim: |
| self.out.append('\n\\end{%s}\n' % self.literal_block_env) |
| self.verbatim = False |
| else: |
| self.out.append('\n}') |
| self.insert_non_breaking_blanks = False |
| self.insert_newline = False |
| self.literal = False |
| self.out.append(self.context.pop()) |
| |
| ## def visit_meta(self, node): |
| ## self.out.append('[visit_meta]\n') |
| # TODO: set keywords for pdf? |
| # But: |
| # The reStructuredText "meta" directive creates a "pending" node, |
| # which contains knowledge that the embedded "meta" node can only |
| # be handled by HTML-compatible writers. The "pending" node is |
| # resolved by the docutils.transforms.components.Filter transform, |
| # which checks that the calling writer supports HTML; if it doesn't, |
| # the "pending" node (and enclosed "meta" node) is removed from the |
| # document. |
| # --- docutils/docs/peps/pep-0258.html#transformer |
| |
| ## def depart_meta(self, node): |
| ## self.out.append('[depart_meta]\n') |
| |
| def visit_option(self, node): |
| if self.context[-1]: |
| # this is not the first option |
| self.out.append(', ') |
| |
| def depart_option(self, node): |
| # flag tha the first option is done. |
| self.context[-1] += 1 |
| |
| def visit_option_argument(self, node): |
| """Append the delimiter betweeen an option and its argument to body.""" |
| self.out.append(node.get('delimiter', ' ')) |
| |
| def depart_option_argument(self, node): |
| pass |
| |
| def visit_option_group(self, node): |
| self.out.append('\n\\item[') |
| # flag for first option |
| self.context.append(0) |
| |
| def depart_option_group(self, node): |
| self.context.pop() # the flag |
| self.out.append('] ') |
| |
| def visit_option_list(self, node): |
| self.fallbacks['_providelength'] = PreambleCmds.providelength |
| self.fallbacks['optionlist'] = PreambleCmds.optionlist |
| self.out.append('%\n\\begin{DUoptionlist}\n') |
| |
| def depart_option_list(self, node): |
| self.out.append('\n\\end{DUoptionlist}\n') |
| |
| def visit_option_list_item(self, node): |
| pass |
| |
| def depart_option_list_item(self, node): |
| pass |
| |
| def visit_option_string(self, node): |
| ##self.out.append(self.starttag(node, 'span', '', CLASS='option')) |
| pass |
| |
| def depart_option_string(self, node): |
| ##self.out.append('</span>') |
| pass |
| |
| def visit_organization(self, node): |
| self.visit_docinfo_item(node, 'organization') |
| |
| def depart_organization(self, node): |
| self.depart_docinfo_item(node) |
| |
| def visit_paragraph(self, node): |
| # no newline if the paragraph is first in a list item |
| if ((isinstance(node.parent, nodes.list_item) or |
| isinstance(node.parent, nodes.description)) and |
| node is node.parent[0]): |
| return |
| index = node.parent.index(node) |
| if (isinstance(node.parent, nodes.compound) and |
| index > 0 and |
| not isinstance(node.parent[index - 1], nodes.paragraph) and |
| not isinstance(node.parent[index - 1], nodes.compound)): |
| return |
| self.out.append('\n') |
| if node.get('ids'): |
| self.out += self.ids_to_labels(node) + ['\n'] |
| |
| def depart_paragraph(self, node): |
| self.out.append('\n') |
| |
| def visit_problematic(self, node): |
| self.requirements['color'] = PreambleCmds.color |
| self.out.append('%\n') |
| self.append_hypertargets(node) |
| self.out.append(r'\hyperlink{%s}{\textbf{\color{red}' % node['refid']) |
| |
| def depart_problematic(self, node): |
| self.out.append('}}') |
| |
| def visit_raw(self, node): |
| if not 'latex' in node.get('format', '').split(): |
| raise nodes.SkipNode |
| if node['classes']: |
| self.visit_inline(node) |
| # append "as-is" skipping any LaTeX-encoding |
| self.verbatim = True |
| |
| def depart_raw(self, node): |
| self.verbatim = False |
| if node['classes']: |
| self.depart_inline(node) |
| |
| def has_unbalanced_braces(self, string): |
| """Test whether there are unmatched '{' or '}' characters.""" |
| level = 0 |
| for ch in string: |
| if ch == '{': |
| level += 1 |
| if ch == '}': |
| level -= 1 |
| if level < 0: |
| return True |
| return level != 0 |
| |
| def visit_reference(self, node): |
| # We need to escape #, \, and % if we use the URL in a command. |
| special_chars = {ord('#'): ur'\#', |
| ord('%'): ur'\%', |
| ord('\\'): ur'\\', |
| } |
| # external reference (URL) |
| if 'refuri' in node: |
| href = unicode(node['refuri']).translate(special_chars) |
| # problematic chars double caret and unbalanced braces: |
| if href.find('^^') != -1 or self.has_unbalanced_braces(href): |
| self.error( |
| 'External link "%s" not supported by LaTeX.\n' |
| ' (Must not contain "^^" or unbalanced braces.)' % href) |
| if node['refuri'] == node.astext(): |
| self.out.append(r'\url{%s}' % href) |
| raise nodes.SkipNode |
| self.out.append(r'\href{%s}{' % href) |
| return |
| # internal reference |
| if 'refid' in node: |
| href = node['refid'] |
| elif 'refname' in node: |
| href = self.document.nameids[node['refname']] |
| else: |
| raise AssertionError('Unknown reference.') |
| if not self.is_inline(node): |
| self.out.append('\n') |
| self.out.append('\\hyperref[%s]{' % href) |
| if self._reference_label: |
| self.out.append('\\%s{%s}}' % |
| (self._reference_label, href.replace('#', ''))) |
| raise nodes.SkipNode |
| |
| def depart_reference(self, node): |
| self.out.append('}') |
| if not self.is_inline(node): |
| self.out.append('\n') |
| |
| def visit_revision(self, node): |
| self.visit_docinfo_item(node, 'revision') |
| |
| def depart_revision(self, node): |
| self.depart_docinfo_item(node) |
| |
| def visit_section(self, node): |
| self.section_level += 1 |
| # Initialize counter for potential subsections: |
| self._section_number.append(0) |
| # Counter for this section's level (initialized by parent section): |
| self._section_number[self.section_level - 1] += 1 |
| |
| def depart_section(self, node): |
| # Remove counter for potential subsections: |
| self._section_number.pop() |
| self.section_level -= 1 |
| |
| def visit_sidebar(self, node): |
| self.requirements['color'] = PreambleCmds.color |
| self.fallbacks['sidebar'] = PreambleCmds.sidebar |
| self.out.append('\n\\DUsidebar{\n') |
| |
| def depart_sidebar(self, node): |
| self.out.append('}\n') |
| |
| attribution_formats = {'dash': ('---', ''), |
| 'parentheses': ('(', ')'), |
| 'parens': ('(', ')'), |
| 'none': ('', '')} |
| |
| def visit_attribution(self, node): |
| prefix, suffix = self.attribution_formats[self.settings.attribution] |
| self.out.append('\n\\begin{flushright}\n') |
| self.out.append(prefix) |
| self.context.append(suffix) |
| |
| def depart_attribution(self, node): |
| self.out.append(self.context.pop() + '\n') |
| self.out.append('\\end{flushright}\n') |
| |
| def visit_status(self, node): |
| self.visit_docinfo_item(node, 'status') |
| |
| def depart_status(self, node): |
| self.depart_docinfo_item(node) |
| |
| def visit_strong(self, node): |
| self.out.append('\\textbf{') |
| if node['classes']: |
| self.visit_inline(node) |
| |
| def depart_strong(self, node): |
| if node['classes']: |
| self.depart_inline(node) |
| self.out.append('}') |
| |
| def visit_substitution_definition(self, node): |
| raise nodes.SkipNode |
| |
| def visit_substitution_reference(self, node): |
| self.unimplemented_visit(node) |
| |
| def visit_subtitle(self, node): |
| if isinstance(node.parent, nodes.document): |
| self.push_output_collector(self.subtitle) |
| self.subtitle_labels += self.ids_to_labels(node, set_anchor=False) |
| # section subtitle: "starred" (no number, not in ToC) |
| elif isinstance(node.parent, nodes.section): |
| self.out.append(r'\%s*{' % |
| self.d_class.section(self.section_level + 1)) |
| else: |
| self.fallbacks['subtitle'] = PreambleCmds.subtitle |
| self.out.append('\n\\DUsubtitle[%s]{' % node.parent.tagname) |
| |
| def depart_subtitle(self, node): |
| if isinstance(node.parent, nodes.document): |
| self.pop_output_collector() |
| else: |
| self.out.append('}\n') |
| |
| def visit_system_message(self, node): |
| self.requirements['color'] = PreambleCmds.color |
| self.fallbacks['title'] = PreambleCmds.title |
| node['classes'] = ['system-message'] |
| self.visit_admonition(node) |
| self.out.append('\\DUtitle[system-message]{system-message}\n') |
| self.append_hypertargets(node) |
| try: |
| line = ', line~%s' % node['line'] |
| except KeyError: |
| line = '' |
| self.out.append('\n\n{\color{red}%s/%s} in \\texttt{%s}%s\n' % |
| (node['type'], node['level'], |
| self.encode(node['source']), line)) |
| if len(node['backrefs']) == 1: |
| self.out.append('\n\\hyperlink{%s}{' % node['backrefs'][0]) |
| self.context.append('}') |
| else: |
| backrefs = ['\\hyperlink{%s}{%d}' % (href, i+1) |
| for (i, href) in enumerate(node['backrefs'])] |
| self.context.append('backrefs: ' + ' '.join(backrefs)) |
| |
| def depart_system_message(self, node): |
| self.out.append(self.context.pop()) |
| self.depart_admonition() |
| |
| def visit_table(self, node): |
| self.requirements['table'] = PreambleCmds.table |
| if self.active_table.is_open(): |
| self.table_stack.append(self.active_table) |
| # nesting longtable does not work (e.g. 2007-04-18) |
| self.active_table = Table(self,'tabular',self.settings.table_style) |
| self.active_table.open() |
| for cls in node['classes']: |
| self.active_table.set_table_style(cls) |
| if self.active_table._table_style == 'booktabs': |
| self.requirements['booktabs'] = r'\usepackage{booktabs}' |
| self.out.append('\n' + self.active_table.get_opening()) |
| |
| def depart_table(self, node): |
| self.out.append(self.active_table.get_closing() + '\n') |
| self.active_table.close() |
| if len(self.table_stack)>0: |
| self.active_table = self.table_stack.pop() |
| else: |
| self.active_table.set_table_style(self.settings.table_style) |
| # Insert hyperlabel after (long)table, as |
| # other places (beginning, caption) result in LaTeX errors. |
| if node.get('ids'): |
| self.out += self.ids_to_labels(node, set_anchor=False) + ['\n'] |
| |
| def visit_target(self, node): |
| # Skip indirect targets: |
| if ('refuri' in node # external hyperlink |
| or 'refid' in node # resolved internal link |
| or 'refname' in node): # unresolved internal link |
| ## self.out.append('%% %s\n' % node) # for debugging |
| return |
| self.out.append('%\n') |
| # do we need an anchor (\phantomsection)? |
| set_anchor = not(isinstance(node.parent, nodes.caption) or |
| isinstance(node.parent, nodes.title)) |
| # TODO: where else can/must we omit the \phantomsection? |
| self.out += self.ids_to_labels(node, set_anchor) |
| |
| def depart_target(self, node): |
| pass |
| |
| def visit_tbody(self, node): |
| # BUG write preamble if not yet done (colspecs not []) |
| # for tables without heads. |
| if not self.active_table.get('preamble written'): |
| self.visit_thead(None) |
| self.depart_thead(None) |
| |
| def depart_tbody(self, node): |
| pass |
| |
| def visit_term(self, node): |
| """definition list term""" |
| # Commands with optional args inside an optional arg must be put |
| # in a group, e.g. ``\item[{\hyperref[label]{text}}]``. |
| self.out.append('\\item[{') |
| |
| def depart_term(self, node): |
| # \leavevmode results in a line break if the |
| # term is followed by an item list. |
| self.out.append('}] \leavevmode ') |
| |
| def visit_tgroup(self, node): |
| #self.out.append(self.starttag(node, 'colgroup')) |
| #self.context.append('</colgroup>\n') |
| pass |
| |
| def depart_tgroup(self, node): |
| pass |
| |
| _thead_depth = 0 |
| def thead_depth (self): |
| return self._thead_depth |
| |
| def visit_thead(self, node): |
| self._thead_depth += 1 |
| if 1 == self.thead_depth(): |
| self.out.append('{%s}\n' % self.active_table.get_colspecs()) |
| self.active_table.set('preamble written',1) |
| self.out.append(self.active_table.get_caption()) |
| self.out.extend(self.active_table.visit_thead()) |
| |
| def depart_thead(self, node): |
| if node is not None: |
| self.out.extend(self.active_table.depart_thead()) |
| if self.active_table.need_recurse(): |
| node.walkabout(self) |
| self._thead_depth -= 1 |
| |
| def bookmark(self, node): |
| """Return label and pdfbookmark string for titles.""" |
| result = [''] |
| if self.settings.sectnum_xform: # "starred" section cmd |
| # add to the toc and pdfbookmarks |
| section_name = self.d_class.section(max(self.section_level, 1)) |
| section_title = self.encode(node.astext()) |
| result.append(r'\phantomsection') |
| result.append(r'\addcontentsline{toc}{%s}{%s}' % |
| (section_name, section_title)) |
| result += self.ids_to_labels(node.parent, set_anchor=False) |
| return '%\n '.join(result) + '%\n' |
| |
| def visit_title(self, node): |
| """Append section and other titles.""" |
| # Document title |
| if node.parent.tagname == 'document': |
| self.push_output_collector(self.title) |
| self.context.append('') |
| self.pdfinfo.append(' pdftitle={%s},' % |
| self.encode(node.astext())) |
| # Topic titles (topic, admonition, sidebar) |
| elif (isinstance(node.parent, nodes.topic) or |
| isinstance(node.parent, nodes.admonition) or |
| isinstance(node.parent, nodes.sidebar)): |
| self.fallbacks['title'] = PreambleCmds.title |
| classes = ','.join(node.parent['classes']) |
| if not classes: |
| classes = node.tagname |
| self.out.append('\\DUtitle[%s]{' % classes) |
| self.context.append('}\n') |
| # Table caption |
| elif isinstance(node.parent, nodes.table): |
| self.push_output_collector(self.active_table.caption) |
| self.context.append('') |
| # Section title |
| else: |
| self.out.append('\n\n') |
| self.out.append('%' + '_' * 75) |
| self.out.append('\n\n') |
| # |
| section_name = self.d_class.section(self.section_level) |
| # number sections? |
| if (self.settings.sectnum_xform # numbering by Docutils |
| or (self.section_level > len(self.d_class.sections))): |
| section_star = '*' |
| else: # LaTeX numbered sections |
| section_star = '' |
| self.out.append(r'\%s%s{' % (section_name, section_star)) |
| # System messages heading in red: |
| if ('system-messages' in node.parent['classes']): |
| self.requirements['color'] = PreambleCmds.color |
| self.out.append('\color{red}') |
| # label and ToC entry: |
| self.context.append(self.bookmark(node) + '}\n') |
| # MAYBE postfix paragraph and subparagraph with \leavemode to |
| # ensure floats stay in the section and text starts on a new line. |
| |
| def depart_title(self, node): |
| self.out.append(self.context.pop()) |
| if (isinstance(node.parent, nodes.table) or |
| node.parent.tagname == 'document'): |
| self.pop_output_collector() |
| |
| def minitoc(self, node, title, depth): |
| """Generate a local table of contents with LaTeX package minitoc""" |
| section_name = self.d_class.section(self.section_level) |
| # name-prefix for current section level |
| minitoc_names = {'part': 'part', 'chapter': 'mini'} |
| if 'chapter' not in self.d_class.sections: |
| minitoc_names['section'] = 'sect' |
| try: |
| minitoc_name = minitoc_names[section_name] |
| except KeyError: # minitoc only supports part- and toplevel |
| self.warn('Skipping local ToC at %s level.\n' % section_name + |
| ' Feature not supported with option "use-latex-toc"', |
| base_node=node) |
| return |
| # Requirements/Setup |
| self.requirements['minitoc'] = PreambleCmds.minitoc |
| self.requirements['minitoc-'+minitoc_name] = (r'\do%stoc' % |
| minitoc_name) |
| # depth: (Docutils defaults to unlimited depth) |
| maxdepth = len(self.d_class.sections) |
| self.requirements['minitoc-%s-depth' % minitoc_name] = ( |
| r'\mtcsetdepth{%stoc}{%d}' % (minitoc_name, maxdepth)) |
| # Process 'depth' argument (!Docutils stores a relative depth while |
| # minitoc expects an absolute depth!): |
| offset = {'sect': 1, 'mini': 0, 'part': 0} |
| if 'chapter' in self.d_class.sections: |
| offset['part'] = -1 |
| if depth: |
| self.out.append('\\setcounter{%stocdepth}{%d}' % |
| (minitoc_name, depth + offset[minitoc_name])) |
| # title: |
| self.out.append('\\mtcsettitle{%stoc}{%s}\n' % (minitoc_name, title)) |
| # the toc-generating command: |
| self.out.append('\\%stoc\n' % minitoc_name) |
| |
| def visit_topic(self, node): |
| # Topic nodes can be generic topic, abstract, dedication, or ToC. |
| # table of contents: |
| if 'contents' in node['classes']: |
| self.out.append('\n') |
| self.out += self.ids_to_labels(node) |
| # add contents to PDF bookmarks sidebar |
| if isinstance(node.next_node(), nodes.title): |
| self.out.append('\n\\pdfbookmark[%d]{%s}{%s}\n' % |
| (self.section_level+1, |
| node.next_node().astext(), |
| node.get('ids', ['contents'])[0] |
| )) |
| if self.use_latex_toc: |
| title = '' |
| if isinstance(node.next_node(), nodes.title): |
| title = self.encode(node.pop(0).astext()) |
| depth = node.get('depth', 0) |
| if 'local' in node['classes']: |
| self.minitoc(node, title, depth) |
| self.context.append('') |
| return |
| if depth: |
| self.out.append('\\setcounter{tocdepth}{%d}\n' % depth) |
| if title != 'Contents': |
| self.out.append('\\renewcommand{\\contentsname}{%s}\n' % |
| title) |
| self.out.append('\\tableofcontents\n\n') |
| self.has_latex_toc = True |
| else: # Docutils generated contents list |
| # set flag for visit_bullet_list() and visit_title() |
| self.is_toc_list = True |
| self.context.append('') |
| elif ('abstract' in node['classes'] and |
| self.settings.use_latex_abstract): |
| self.push_output_collector(self.abstract) |
| self.out.append('\\begin{abstract}') |
| self.context.append('\\end{abstract}\n') |
| if isinstance(node.next_node(), nodes.title): |
| node.pop(0) # LaTeX provides its own title |
| else: |
| self.fallbacks['topic'] = PreambleCmds.topic |
| # special topics: |
| if 'abstract' in node['classes']: |
| self.fallbacks['abstract'] = PreambleCmds.abstract |
| self.push_output_collector(self.abstract) |
| if 'dedication' in node['classes']: |
| self.fallbacks['dedication'] = PreambleCmds.dedication |
| self.push_output_collector(self.dedication) |
| self.out.append('\n\\DUtopic[%s]{\n' % ','.join(node['classes'])) |
| self.context.append('}\n') |
| |
| def depart_topic(self, node): |
| self.out.append(self.context.pop()) |
| self.is_toc_list = False |
| if ('abstract' in node['classes'] or |
| 'dedication' in node['classes']): |
| self.pop_output_collector() |
| |
| def visit_inline(self, node): # <span>, i.e. custom roles |
| # insert fallback definition |
| self.fallbacks['inline'] = PreambleCmds.inline |
| self.out += [r'\DUrole{%s}{' % cls for cls in node['classes']] |
| self.context.append('}' * (len(node['classes']))) |
| |
| def depart_inline(self, node): |
| self.out.append(self.context.pop()) |
| |
| def visit_rubric(self, node): |
| self.fallbacks['rubric'] = PreambleCmds.rubric |
| self.out.append('\n\\DUrubric{') |
| self.context.append('}\n') |
| |
| def depart_rubric(self, node): |
| self.out.append(self.context.pop()) |
| |
| def visit_transition(self, node): |
| self.fallbacks['transition'] = PreambleCmds.transition |
| self.out.append('\n\n') |
| self.out.append('%' + '_' * 75 + '\n') |
| self.out.append(r'\DUtransition') |
| self.out.append('\n\n') |
| |
| def depart_transition(self, node): |
| pass |
| |
| def visit_version(self, node): |
| self.visit_docinfo_item(node, 'version') |
| |
| def depart_version(self, node): |
| self.depart_docinfo_item(node) |
| |
| def unimplemented_visit(self, node): |
| raise NotImplementedError('visiting unimplemented node type: %s' % |
| node.__class__.__name__) |
| |
| # def unknown_visit(self, node): |
| # def default_visit(self, node): |
| |
| # vim: set ts=4 et ai : |