latex_ipypublish_chapter.py

"""latex article in the main ipypublish format, preprocessed with default metadata tags:
- all output/code/error is rendered
- a basic titlepage and table of contents and tables of figures/tables/code
"""
from ipypublish.filters.ansi_listings import ansi2listings
from ipypublish.filters.filters import remove_dollars, first_para, create_key, dict_to_kwds, is_equation
from ipypublish.latex.create_tplx import create_tplx
from ipypublish.latex.ipypublish import biblio_natbib as bib
from ipypublish.latex.ipypublish import contents_framed_code as code
from ipypublish.latex.ipypublish import contents_output as output
from ipypublish.latex.ipypublish import doc_article as doc
from ipypublish.latex.ipypublish import front_pages as title
from ipypublish.latex.standard import standard_definitions as defs
from ipypublish.latex.standard import standard_packages as package
from ipypublish.preprocessors.latex_doc_captions import LatexCaptions
from ipypublish.preprocessors.latex_doc_defaults import MetaDefaults
from ipypublish.preprocessors.latex_doc_links import LatexDocLinks
from ipypublish.preprocessors.split_outputs import SplitOutputs

# Additions for fuzzingbook - AZ
title.tplx_dict['document_predoc'] = r"""
((*- if nb.metadata["ipub"]: -*))
    \begingroup
    \let\cleardoublepage\relax
    \let\clearpage\relax
    ((*- if nb.metadata["ipub"]["toc"]: -*))
    \tableofcontents
    ((*- endif *))
    ((*- if nb.metadata["ipub"]["listfigures"]: -*))
    \listoffigures
    ((*- endif *))
    ((*- if nb.metadata["ipub"]["listtables"]: -*))
    \listoftables
    ((*- endif *))
    ((*- if nb.metadata["ipub"]["listcode"]: -*))
    \listof{codecell}{\GetTranslation{List of Codes}}
    ((*- endif *))
    \endgroup
((*- endif *))

% Copyright
\vfill
A chapter of \textbf{The Debugging Book}, by Andreas Zeller.

Copyright © 2020--2021 by the authors; all rights reserved.
"""

# Use 11pt
doc.tplx_dict['document_docclass'] = (
    doc.tplx_dict['document_docclass'].replace("10pt", "11pt")
)

# csquotes doesn't like utf8x
package.tplx_dict['document_packages'] = (
    package.tplx_dict['document_packages']
        .replace("utf8x", "utf8")
        .replace(r"\usepackage[mathletters]{ucs}", "")
        .replace(r"\usepackage[utf8]{inputenc}", r"""
        \usepackage{ifxetex}
        \ifxetex\else
            \usepackage[utf8]{inputenc}
        \fi
        """)
        )

fuzzingbook_tplx_dict = {
    # Need defs for inputencoding, extendedchars, and literate
    'document_definitions': r"""
    \lstdefinestyle{fuzzingbookstyle}{
        commentstyle=\color{codegreen},
        keywordstyle=\color{magenta},
        numberstyle=\tiny\color{codegray},
        stringstyle=\color{codepurple},
        basicstyle=\ttfamily,
        breakatwhitespace=false,
        keepspaces=true,
        numbers=left,
        numbersep=10pt,
        showspaces=false,
        showstringspaces=false,
        showtabs=false,
        tabsize=2,
        breaklines=true,
        literate={\-}{}{0\discretionary{-}{}{-}},
      postbreak=\mbox{\textcolor{red}{$\hookrightarrow$}\space},
      inputencoding=utf8,
      extendedchars=true,
      literate={ä}{{\"a}}1 {ö}{{\"o}}1 {ü}{{\"u}}1 {Ä}{{\"A}}1 {Ö}{{\"ö}}1 {Ü}{{\"U}}1 {ß}{{\ss}}1 {ı}{{\i}}1,
    }

    \lstset{style=fuzzingbookstyle}
    
    % Use nicer fonts with xelatex
    \ifxetex
        \usepackage{fontspec}

        \defaultfontfeatures{Mapping=tex-text}
        \defaultfontfeatures{Ligatures=TeX} % To support LaTeX quoting style

        \setmainfont{Source Serif Pro}
        \setromanfont{Source Serif Pro}
        \setmonofont{Source Code Pro}
        % \setmonofont{Fira Mono}
        \setsansfont[Color={DDA0DD}]{Raleway}
        
        % Use Heading font
        \setkomafont{sectioning}{\sffamily}
        
        % Tweaks to have heading fonts appear in title
        \let\oldHuge=\Huge
        \let\oldLARGE=\LARGE
        \def\Huge{\oldHuge\sffamily}
        \def\LARGE{\oldLARGE\rmfamily}
    \fi
    
""",

     'document_packages': r"""
% Allow for using " as quote character
\usepackage{csquotes}
\MakeOuterQuote{"}
% \MakeInnerQuote{'}
"""
}


oformat = 'Latex'
template = create_tplx([p.tplx_dict for p in
                        [package, defs, doc, title, bib, output, code]] 
                        + [fuzzingbook_tplx_dict])

_filters = {'remove_dollars': remove_dollars,
            'first_para': first_para,
            'create_key': create_key,
            'dict_to_kwds': dict_to_kwds,
            'ansi2listings': ansi2listings,
            'is_equation': is_equation}

cell_defaults = {
    "ipub": {
        "figure": {
            "placement": "H"
        },
        "table": {
            "placement": "H"
        },
        "equation": {'environment': 'equation'},
        "text": True,
        "mkdown": True,
        "code": True,
        "error": True
    }
}

nb_defaults = {
    "ipub": {
        "titlepage": {},
        "toc": True,
        "listfigures": True,
        "listtables": True,
        "listcode": True,
    }
}

config = {'TemplateExporter.filters': _filters,
          'Exporter.filters': _filters,
          'Exporter.preprocessors': [MetaDefaults, SplitOutputs, LatexDocLinks, LatexCaptions],
          'SplitOutputs.split': True,
          'MetaDefaults.cell_defaults': cell_defaults,
          'SVG2PDFPreprocessor.command': 'svg42pdf {from_filename} {to_filename}',
          'MetaDefaults.nb_defaults': nb_defaults}