|
|
"""
|
|
|
Exporter that allows Latex Jinja templates to work. Contains logic to
|
|
|
appropriately prepare IPYNB files for export to LaTeX. Including but
|
|
|
not limited to escaping LaTeX, fixing math region tags, using special
|
|
|
tags to circumvent Jinja/Latex syntax conflicts.
|
|
|
"""
|
|
|
#-----------------------------------------------------------------------------
|
|
|
# Copyright (c) 2013, the IPython Development Team.
|
|
|
#
|
|
|
# Distributed under the terms of the Modified BSD License.
|
|
|
#
|
|
|
# The full license is in the file COPYING.txt, distributed with this software.
|
|
|
#-----------------------------------------------------------------------------
|
|
|
|
|
|
#-----------------------------------------------------------------------------
|
|
|
# Imports
|
|
|
#-----------------------------------------------------------------------------
|
|
|
|
|
|
# Stdlib imports
|
|
|
import os
|
|
|
|
|
|
# IPython imports
|
|
|
from IPython.utils.traitlets import Unicode
|
|
|
from IPython.config import Config
|
|
|
|
|
|
from IPython.nbconvert import filters, transformers
|
|
|
from .exporter import Exporter
|
|
|
|
|
|
#-----------------------------------------------------------------------------
|
|
|
# Classes and functions
|
|
|
#-----------------------------------------------------------------------------
|
|
|
|
|
|
class LatexExporter(Exporter):
|
|
|
"""
|
|
|
Exports to a Latex template. Inherit from this class if your template is
|
|
|
LaTeX based and you need custom tranformers/filters. Inherit from it if
|
|
|
you are writing your own HTML template and need custom tranformers/filters.
|
|
|
If you don't need custom tranformers/filters, just change the
|
|
|
'template_file' config option. Place your template in the special "/latex"
|
|
|
subfolder of the "../templates" folder.
|
|
|
"""
|
|
|
|
|
|
file_extension = Unicode(
|
|
|
'tex', config=True,
|
|
|
help="Extension of the file that should be written to disk")
|
|
|
|
|
|
template_file = Unicode(
|
|
|
'base', config=True,
|
|
|
help="Name of the template file to use")
|
|
|
|
|
|
#Latex constants
|
|
|
template_path = Unicode(
|
|
|
os.path.join("..", "templates", "latex"), config=True,
|
|
|
help="Path where the template files are located.")
|
|
|
|
|
|
template_skeleton_path = Unicode(
|
|
|
os.path.join("..", "templates", "latex", "skeleton"), config=True,
|
|
|
help="Path where the template skeleton files are located.")
|
|
|
|
|
|
#Special Jinja2 syntax that will not conflict when exporting latex.
|
|
|
jinja_comment_block_start = Unicode("((=", config=True)
|
|
|
jinja_comment_block_end = Unicode("=))", config=True)
|
|
|
jinja_variable_block_start = Unicode("(((", config=True)
|
|
|
jinja_variable_block_end = Unicode(")))", config=True)
|
|
|
jinja_logic_block_start = Unicode("((*", config=True)
|
|
|
jinja_logic_block_end = Unicode("*))", config=True)
|
|
|
|
|
|
#Extension that the template files use.
|
|
|
template_extension = Unicode(".tplx", config=True)
|
|
|
|
|
|
def _register_filters(self):
|
|
|
"""
|
|
|
Register all of the filters required for the exporter.
|
|
|
"""
|
|
|
|
|
|
#Register the filters of the base class.
|
|
|
super(LatexExporter, self)._register_filters()
|
|
|
|
|
|
#Add latex filters to the Jinja2 environment
|
|
|
self.register_filter('escape_tex', filters.escape_latex)
|
|
|
self.register_filter('highlight', filters.highlight2latex)
|
|
|
|
|
|
|
|
|
def _register_transformers(self):
|
|
|
"""
|
|
|
Register all of the transformers needed for this exporter.
|
|
|
"""
|
|
|
|
|
|
#Register ConvertSvgTransformer before any other transformers!
|
|
|
#Important because it allows the conversion of svg->png BEFORE the
|
|
|
#extract figure transformer acts on the data.
|
|
|
self.register_transformer(transformers.ConvertSvgTransformer, True)
|
|
|
|
|
|
#Register transformers
|
|
|
super(LatexExporter, self)._register_transformers()
|
|
|
self.register_transformer(transformers.LatexTransformer, True)
|
|
|
|
|
|
@property
|
|
|
def default_config(self):
|
|
|
c = Config({
|
|
|
'GlobalConfigurable': {
|
|
|
'display_data_priority' : ['latex', 'png', 'jpg', 'jpeg', 'text']
|
|
|
},
|
|
|
'ExtractFigureTransformer': {
|
|
|
'enabled':True
|
|
|
}
|
|
|
|
|
|
})
|
|
|
c.merge(super(LatexExporter,self).default_config)
|
|
|
return c
|
|
|
|
|
|
|
