highlight filter: pass metadata as an optional argument

IPython/nbconvert/filters/highlight.py

@@ -1,98 +1,104 b''
 """
 Module containing filter functions that allow code to be highlighted
 from within Jinja templates.
 """
 #-----------------------------------------------------------------------------
 # 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
 #-----------------------------------------------------------------------------
 
 import re
 
 from pygments import highlight as pygements_highlight
 from pygments.lexers import get_lexer_by_name
 from pygments.formatters import HtmlFormatter
 from pygments.formatters import LatexFormatter
 
 # Our own imports
 from IPython.nbconvert.utils.lexers import IPythonLexer
 
 #-----------------------------------------------------------------------------
 # Globals and constants
 #-----------------------------------------------------------------------------
 
 MULTILINE_OUTPUTS = ['text', 'html', 'svg', 'latex', 'javascript', 'json']
 
 #-----------------------------------------------------------------------------
 # Utility functions
 #-----------------------------------------------------------------------------
 
 __all__ = [
     'highlight2html',
     'highlight2latex'
 ]
 
-def highlight2html(cell, language='ipython'):
+def highlight2html(source, metadata=None, language='ipython'):
     """
     Return a syntax-highlighted version of the input source as html output.
 
     Parameters
     ----------
-    cell : NotebookNode cell
-        cell to highlight
+    source : str
+        source of the cell to highlight.
+    metadata : NotebookNode cell metadata
+        metadata of the cell to highlight.
     language : str
         Language to highlight the syntax of.
     """
 
-    return _pygment_highlight(cell, HtmlFormatter(), language)
+    return _pygment_highlight(source, HtmlFormatter(), metadata, language)
 
 
-def highlight2latex(cell, language='ipython'):
+def highlight2latex(source, metadata=None, language='ipython'):
     """
     Return a syntax-highlighted version of the input source as latex output.
 
     Parameters
     ----------
-    cell : NotebookNode cell
-        cell to highlight
+    source : str
+        source of the cell to highlight.
+    metadata : NotebookNode cell metadata
+        metadata of the cell to highlight.
     language : str
         Language to highlight the syntax of.
     """
-    return _pygment_highlight(cell, LatexFormatter(), language)
+    return _pygment_highlight(source, LatexFormatter(), metadata, language)
 
 
 
-def _pygment_highlight(cell, output_formatter, language='ipython'):
+def _pygment_highlight(source, output_formatter, metadata=None, language='ipython'):
     """
     Return a syntax-highlighted version of the input source
 
     Parameters
     ----------
-    cell : NotebookNode cell
-        cell to highlight
+    source : str
+        source of the cell to highlight.
     output_formatter : Pygments formatter
+    metadata : NotebookNode cell metadata
+        metadata of the cell to highlight.
     language : str
         Language to highlight the syntax of.
     """
 
     # If the cell uses a magic extension language,
     # use the magic language instead.
     if language == 'ipython' \
-        and 'metadata' in cell \
-        and 'magics_language' in cell['metadata']:
+        and metadata \
+        and 'magics_language' in metadata:
 
-        language = cell['metadata']['magics_language']
+        language = metadata['magics_language']
 
     if language == 'ipython':
         lexer = IPythonLexer()
     else:
         lexer = get_lexer_by_name(language, stripall=True)
 
-    return pygements_highlight(cell['input'], lexer, output_formatter)
+    return pygements_highlight(source, lexer, output_formatter)

IPython/nbconvert/filters/tests/test_highlight.py

@@ -1,65 +1,65 b''
 """
 Module with tests for Highlight
 """
 
 #-----------------------------------------------------------------------------
 # 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
 #-----------------------------------------------------------------------------
 
 from ...tests.base import TestsBase
 from ..highlight import highlight2html, highlight2latex
 
 
 #-----------------------------------------------------------------------------
 # Class
 #-----------------------------------------------------------------------------
 
 class TestHighlight(TestsBase):
     """Contains test functions for highlight.py"""
 
     #Hello world test, magics test, blank string test
     tests = [
         """
         #Hello World Example
 
         def say(text):
             print(text)
 
         say('Hello World!')
         """,
         """
         %%pylab
         plot(x,y, 'r')
         """
         ]   
 
     tokens = [
         ['Hello World Example', 'say', 'text', 'print', 'def'],
         ['pylab', 'plot']]
 
 
     def test_highlight2html(self):
         """highlight2html test"""
         for index, test in enumerate(self.tests):
             self._try_highlight(highlight2html, test, self.tokens[index])
 
 
     def test_highlight2latex(self):
         """highlight2latex test"""
         for index, test in enumerate(self.tests):
             self._try_highlight(highlight2latex, test, self.tokens[index])
 
 
     def _try_highlight(self, method, test, tokens):
         """Try highlighting source, look for key tokens"""
-        results = method({'input': test})
+        results = method(test)
         for token in tokens:
             assert token in results

IPython/nbconvert/templates/html_basic.tpl

@@ -1,148 +1,148 b''
 {%- extends 'display_priority.tpl' -%}
 
 
 {% block codecell %}
 <div class="cell border-box-sizing code_cell vbox">
 {{ super() }}
 </div>
 {%- endblock codecell %}
 
 {% block input_group -%}
 <div class="input hbox">
 {{ super() }}
 </div>
 {% endblock input_group %}
 
 {% block output_group %}
 <div class="vbox output_wrapper">
 <div class="output vbox">
 {{ super() }}
 </div>
 </div>
 {% endblock output_group %}
 
 {% block in_prompt -%}
 <div class="prompt input_prompt">
 In&nbsp;[{{ cell.prompt_number }}]:
 </div>
 {%- endblock in_prompt %}
 
 {# 
   output_prompt doesn't do anything in HTML,
   because there is a prompt div in each output area (see output block)
 #}
 {% block output_prompt %}
 {% endblock output_prompt %}
 
 {% block input %}
 <div class="input_area box-flex1">
-{{ cell | highlight2html }}
+{{ cell.input | highlight2html(metadata=cell.metadata) }}
 </div>
 {%- endblock input %}
 
 {% block output %}
 <div class="hbox output_area">
 {%- if output.output_type == 'pyout' -%}
     <div class="prompt output_prompt">
     Out[{{ cell.prompt_number }}]:
 {%- else -%}
     <div class="prompt">
 {%- endif -%}
     </div>
 {{ super() }}
 </div>
 {% endblock output %}
 
 {% block markdowncell scoped %}
 <div class="text_cell_render border-box-sizing rendered_html">
 {{ cell.source | strip_math_space | markdown2html | strip_files_prefix }}
 </div>
 {%- endblock markdowncell %}
 
 {% block headingcell scoped %}
 <div class="text_cell_render border-box-sizing rendered_html">
 {{ ("#" * cell.level + cell.source) | replace('\n', ' ') | strip_math_space | markdown2html | strip_files_prefix | add_anchor }}
 </div>
 {% endblock headingcell %}
 
 {% block rawcell scoped %}
 {{ cell.source }}
 {% endblock rawcell %}
 
 {% block unknowncell scoped %}
 unknown type  {{ cell.type }}
 {% endblock unknowncell %}
 
 {% block pyout -%}
 <div class="box-flex1 output_subarea output_pyout">
 {% block data_priority scoped %}
 {{ super() }}
 {% endblock %}
 </div>
 {%- endblock pyout %}
 
 {% block stream_stdout -%}
 <div class="box-flex1 output_subarea output_stream output_stdout">
 <pre>
 {{ output.text | ansi2html }}
 </pre>
 </div>
 {%- endblock stream_stdout %}
 
 {% block stream_stderr -%}
 <div class="box-flex1 output_subarea output_stream output_stderr">
 <pre>
 {{ output.text | ansi2html }}
 </pre>
 </div>
 {%- endblock stream_stderr %}
 
 {% block data_svg -%}
 {{ output.svg }}
 {%- endblock data_svg %}
 
 {% block data_html -%}
 <div class="output_html rendered_html">
 {{ output.html }}
 </div>
 {%- endblock data_html %}
 
 {% block data_png %}
 <img src="data:image/png;base64,{{ output.png }}">
 {%- endblock data_png %}
 
 {% block data_jpg %}
 <img src="data:image/jpeg;base64,{{ output.jpeg }}">
 {%- endblock data_jpg %}
 
 {% block data_latex %}
 {{ output.latex }}
 {%- endblock data_latex %}
 
 {% block pyerr -%}
 <div class="box-flex1 output_subarea output_pyerr">
 <pre>{{ super() }}</pre>
 </div>
 {%- endblock pyerr %}
 
 {%- block traceback_line %}
 {{ line | ansi2html }}
 {%- endblock traceback_line %}
 
 {%- block data_text %}
 <pre>
 {{ output.text | ansi2html }}
 </pre>
 {%- endblock -%}
 
 {%- block data_javascript %}
 <script type="text/javascript">
 {{ output.javascript }}
 </script>
 {%- endblock -%}
 
 {%- block display_data scoped -%}
 <div class="box-flex1 output_subarea output_display_data">
 {{ super() }}
 </div>
 {%- endblock display_data -%}
  No newline at end of file

IPython/nbconvert/templates/latex/sphinx.tplx

@@ -1,472 +1,472 b''
 ((= NBConvert Sphinx-Latex Template
 
 Purpose: Allow export of PDF friendly Latex inspired by Sphinx.  Most of the
        template is derived directly from Sphinx source.
 
 Inheritance: null>display_priority 
 
 Note: For best display, use latex syntax highlighting. =))
 
 ((*- extends 'display_priority.tplx' -*))
 
 
 \nonstopmode
 
 %==============================================================================
 % Declarations
 %==============================================================================
 
 % In order to make sure that the input/output header follows the code it 
 % preceeds, the needspace package is used to request that a certain
 % amount of lines (specified by this variable) are reserved.  If those
 % lines aren't available on the current page, the documenter will break
 % to the next page and the header along with accomanying lines will be
 % rendered together.  This value specifies the number of lines that
 % the header will be forced to group with without a page break.
 ((*- set min_header_lines = 4 -*))
 
 % This is the number of characters that are permitted per line.  It's
 % important that this limit is set so characters do not run off the
 % edges of latex pages (since latex does not always seem smart enough
 % to prevent this in some cases.)  This is only applied to textual output
 ((* if resources.sphinx.outputstyle == 'simple' *))
     ((*- set wrap_size = 85 -*))
 ((* elif resources.sphinx.outputstyle == 'notebook' *))
     ((*- set wrap_size = 70 -*))
 ((* endif *))
 
 %==============================================================================
 % Header
 %==============================================================================
 ((* block header *))
 
 % Header, overrides base
 
     % Make sure that the sphinx doc style knows who it inherits from.
     \def\sphinxdocclass{(((parentdocumentclass)))}
 
     % Declare the document class
     \documentclass[letterpaper,10pt,english]{((( resources.sphinx.texinputs | posix_path )))/sphinx(((documentclass)))}
 
     % Imports
     \usepackage[utf8]{inputenc}
     \DeclareUnicodeCharacter{00A0}{\\nobreakspace}
     \usepackage[T1]{fontenc}
     \usepackage{babel}
     \usepackage{times}
     \usepackage{import}
     \usepackage[((( resources.sphinx.chapterstyle )))]{((( resources.sphinx.texinputs | posix_path )))/fncychap}
     \usepackage{longtable}
     \usepackage{((( resources.sphinx.texinputs | posix_path )))/sphinx}
     \usepackage{multirow}
 
     \usepackage{amsmath}
     \usepackage{amssymb}
     \usepackage{ucs}
     \usepackage{enumerate}
 
     % Used to make the Input/Output rules follow around the contents.
     \usepackage{needspace}
 
     % Pygments requirements
     \usepackage{fancyvrb}
     \usepackage{color}
     % ansi colors additions
     \definecolor{darkgreen}{rgb}{.12,.54,.11}
     \definecolor{lightgray}{gray}{.95}
     \definecolor{brown}{rgb}{0.54,0.27,0.07}
     \definecolor{purple}{rgb}{0.5,0.0,0.5}
     \definecolor{darkgray}{gray}{0.25}
     \definecolor{lightred}{rgb}{1.0,0.39,0.28}
     \definecolor{lightgreen}{rgb}{0.48,0.99,0.0}
     \definecolor{lightblue}{rgb}{0.53,0.81,0.92}
     \definecolor{lightpurple}{rgb}{0.87,0.63,0.87}
     \definecolor{lightcyan}{rgb}{0.5,1.0,0.83}
 
     % Needed to box output/input
     \usepackage{tikz}
         \usetikzlibrary{calc,arrows,shadows}
     \usepackage[framemethod=tikz]{mdframed}
 
     \usepackage{alltt}
 
     % Used to load and display graphics
     \usepackage{graphicx}
     \graphicspath{ {figs/} }
     \usepackage[Export]{adjustbox} % To resize
 
     % used so that images for notebooks which have spaces in the name can still be included
     \usepackage{grffile}
 
 
     % For formatting output while also word wrapping.
     \usepackage{listings}
     \lstset{breaklines=true}
     \lstset{basicstyle=\small\ttfamily}
     \def\smaller{\fontsize{9.5pt}{9.5pt}\selectfont}
 
     %Pygments definitions
     ((( resources.sphinx.pygment_definitions )))
 
     %Set pygments styles if needed...
     ((* if resources.sphinx.outputstyle == 'notebook' *))
         \definecolor{nbframe-border}{rgb}{0.867,0.867,0.867}
         \definecolor{nbframe-bg}{rgb}{0.969,0.969,0.969}
         \definecolor{nbframe-in-prompt}{rgb}{0.0,0.0,0.502}
         \definecolor{nbframe-out-prompt}{rgb}{0.545,0.0,0.0}
 
         \newenvironment{ColorVerbatim}
         {\begin{mdframed}[%
             roundcorner=1.0pt, %
             backgroundcolor=nbframe-bg, %
             userdefinedwidth=1\linewidth, %
             leftmargin=0.1\linewidth, %
             innerleftmargin=0pt, %
             innerrightmargin=0pt, %
             linecolor=nbframe-border, %
             linewidth=1pt, %
             usetwoside=false, %
             everyline=true, %
             innerlinewidth=3pt, %
             innerlinecolor=nbframe-bg, %
             middlelinewidth=1pt, %
             middlelinecolor=nbframe-bg, %
             outerlinewidth=0.5pt, %
             outerlinecolor=nbframe-border, %
             needspace=0pt
         ]}
         {\end{mdframed}}
         
         \newenvironment{InvisibleVerbatim}
         {\begin{mdframed}[leftmargin=0.1\linewidth,innerleftmargin=3pt,innerrightmargin=3pt, userdefinedwidth=1\linewidth, linewidth=0pt, linecolor=white, usetwoside=false]}
         {\end{mdframed}}
 
         \renewenvironment{Verbatim}[1][\unskip]
         {\begin{alltt}\smaller}
         {\end{alltt}}
     ((* endif *))
 
     % Help prevent overflowing lines due to urls and other hard-to-break 
     % entities.  This doesn't catch everything...
     \sloppy
 
     % Document level variables
     \title{((( resources.metadata.name | escape_latex )))}
     \date{((( resources.sphinx.date | escape_latex )))}
     \release{((( resources.sphinx.version | escape_latex )))}
     \author{((( resources.sphinx.author | escape_latex )))}
     \renewcommand{\releasename}{((( resources.sphinx.release | escape_latex )))}
 
     % TODO: Add option for the user to specify a logo for his/her export.
     \newcommand{\sphinxlogo}{}
 
     % Make the index page of the document.
     \makeindex
 
     % Import sphinx document type specifics.
     ((* block sphinxheader *))((* endblock sphinxheader *)) 
 ((* endblock header *))
 
 %==============================================================================
 % Body
 %==============================================================================
 ((* block body *))
 ((* block bodyBegin *))
 % Body
 
     % Start of the document
     \begin{document}
 
         ((* if resources.sphinx.header *))
             \maketitle
         ((* endif *))
 
         ((* block toc *))
             \tableofcontents 
         ((* endblock toc *))
 
         ((* endblock bodyBegin *))
         ((( super() )))
         ((* block bodyEnd *))
 
         \renewcommand{\indexname}{Index}
         \printindex
 
         ((* block bibliography *))
         ((* endblock bibliography *))
 
     % End of document
     \end{document}
 ((* endblock bodyEnd *))
 ((* endblock body *))
 
 %==============================================================================
 % Footer
 %==============================================================================
 ((* block footer *))
 ((* endblock footer *))
 
 %==============================================================================
 % Headings
 %
 % Purpose: Format pynb headers as sphinx headers.  Depending on the Sphinx
 %          style that is active, this will change.  Thus sphinx styles will
 %          override the values here.
 %==============================================================================
 ((* block headingcell -*))
     \
     ((*- if cell.level == 1 -*))
         ((* block h1 -*))part((* endblock h1 -*))
     ((*- elif cell.level == 2 -*))
         ((* block h2 -*))chapter((* endblock h2 -*))
     ((*- elif cell.level == 3 -*))
         ((* block h3 -*))section((* endblock h3 -*))
     ((*- elif cell.level == 4 -*))
         ((* block h4 -*))subsection((* endblock h4 -*))
     ((*- elif cell.level == 5 -*))
         ((* block h5 -*))subsubsection((* endblock h5 -*))
     ((*- elif cell.level == 6 -*))
         ((* block h6 -*))paragraph((* endblock h6 -*))
 
     ((= It's important to make sure that underscores (which tend to be common
     in IPYNB file titles) do not make their way into latex.  Sometimes this
     causes latex to barf. =))
     ((*- endif -*))
     {((( cell.source | replace('\n', ' ') | citation2latex | markdown2latex )))}
 ((*- endblock headingcell *))
 
 %==============================================================================
 % Markdown
 %
 % Purpose: Convert markdown to latex.  Here markdown2latex is explicitly
 %          called since we know we want latex output.
 %==============================================================================
 ((*- block markdowncell scoped-*))
 ((( cell.source | citation2latex | markdown2latex )))
 ((*- endblock markdowncell -*))
 
 %==============================================================================
 % Rawcell
 %
 % Purpose: Raw text cells allow the user to manually inject document code that 
 %          will not get touched by the templating system.
 %==============================================================================
 ((*- block rawcell *))
 ((( cell.source | wrap_text(wrap_size) )))
 ((* endblock rawcell -*))
 
 %==============================================================================
 % Unknowncell
 %
 % Purpose: This is the catch anything unhandled.  To display this data, we
 %          remove all possible latex conflicts and wrap the characters so they
 %          can't flow off of the page.
 %==============================================================================
 ((* block unknowncell scoped*))
 % Unsupported cell type, no formatting
 ((( cell.source | wrap_text | escape_latex )))
 ((* endblock unknowncell *))
 
 %==============================================================================
 % Input
 %==============================================================================
 ((* block input *))
 
     % Make sure that atleast 4 lines are below the HR
     \needspace{((( min_header_lines )))\baselineskip}
 
     ((* if resources.sphinx.outputstyle == 'simple' *))
 
         % Add a horizantal break, along with break title.
         \vspace{10pt}
         {\scriptsize Input}\\*
         \rule[10pt]{\linewidth}{0.5pt}
         \vspace{-25pt}
 
         % Add contents below.
-        ((( cell | highlight2latex )))
+        ((( cell.input | highlight2latex(metadata=cell.metadata) )))
 
     ((* elif resources.sphinx.outputstyle == 'notebook' *))
         \vspace{6pt}
         ((( write_prompt("In", cell.prompt_number, "nbframe-in-prompt") )))
         \vspace{-2.65\baselineskip}
         \begin{ColorVerbatim}
             \vspace{-0.7\baselineskip}
-            ((( cell | highlight2latex )))
+            ((( cell.input | highlight2latex(metadata=cell.metadata) )))
             ((* if cell.input == None or cell.input == '' *))
                 \vspace{0.3\baselineskip}
             ((* else *))
                 \vspace{-0.2\baselineskip}
             ((* endif *))
         \end{ColorVerbatim}
     ((* endif *))
 ((* endblock input *))
 
 %==============================================================================
 % Output_Group
 %
 % Purpose: Make sure that only one header bar only attaches to the output 
 %          once.  By keeping track of when an input group is started
 %==============================================================================
 ((* block output_group *))
     ((* if cell.outputs.__len__() > 0 *))
 
         % If the first block is an image, minipage the image.  Else
         % request a certain amount of space for the input text.
         ((( iff_figure(cell.outputs[0], "\\begin{minipage}{1.0\\textwidth}", "\\needspace{"  ~ min_header_lines ~ "\\baselineskip}") )))
         
         ((* if resources.sphinx.outputstyle == 'simple' *))
 
             % Add a horizantal break, along with break title.
             \vspace{10pt}
             {\scriptsize Output}\\*
             \rule[10pt]{\linewidth}{0.5pt}
             \vspace{-20pt}
 
             % Add the contents of the first block.
             ((( render_output(cell.outputs[0]) )))
 
             % Close the minipage.
             ((( iff_figure(cell.outputs[0], "\\end{minipage}", "") )))
 
             % Add remainer of the document contents below.
             ((* for output in cell.outputs[1:] *))
                 ((( render_output(output, cell.prompt_number) )))
             ((* endfor *))
         ((* elif resources.sphinx.outputstyle == 'notebook' *))
 
             % Add document contents.
             ((* for output in cell.outputs *))
                 ((( render_output(output, cell.prompt_number) )))
             ((* endfor *))
         ((* endif *))
     ((* endif *))
 ((* endblock *))
 
 %==============================================================================
 % Additional formating
 %==============================================================================
 ((* block data_text *))
 ((( custom_verbatim(output.text) | ansi2latex )))
 ((* endblock *))
 
 ((* block traceback_line *))
 ((( conditionally_center_output( line | indent| strip_ansi ) )))
 ((* endblock traceback_line *))
 
 %==============================================================================
 % Supported image formats
 %==============================================================================
 ((*- block data_png -*))
 ((( conditionally_center_output(insert_graphics(output.png_filename | posix_path)) )))
 ((*- endblock -*))
 
 ((*- block data_jpg -*))
 ((( conditionally_center_output(insert_graphics(output.jpeg_filename | posix_path)) )))
 ((*- endblock -*))
 
 ((*- block data_svg -*))
 ((( conditionally_center_output(insert_graphics(output.svg_filename | posix_path)) )))
 ((*- endblock -*))
 
 ((*- block data_pdf -*))
 ((( conditionally_center_output(insert_graphics(output.pdf_filename | posix_path)) )))
 ((*- endblock -*))
 
 ((*- block data_latex *))
 ((* if resources.sphinx.centeroutput *))
     \begin{center}
 ((* endif -*))
 ((( output.latex | strip_math_space )))
 ((*- if resources.sphinx.centeroutput *))
     \end{center}
 ((* endif -*))
 ((*- endblock -*))
 
 %==============================================================================
 % Support Macros
 %==============================================================================
 
 % Name: write_prompt
 % Purpose: Renders an output/input prompt for notebook style pdfs
 ((* macro write_prompt(prompt, number, color) -*))
     \makebox[0.1\linewidth]{\smaller\hfill\tt\color{((( color )))}((( prompt )))\hspace{4pt}{[}((( number ))){]}:\hspace{4pt}}\\*
 ((*- endmacro *))
 
 % Name: render_output
 % Purpose: Renders an output block appropriately.
 ((* macro render_output(output, prompt_number) -*))
     ((*- if output.output_type == 'pyerr' -*))
         ((*- block pyerr scoped *))
             ((( custom_verbatim(super()) )))
         ((* endblock pyerr -*))
     ((*- else -*))
 
         ((* if resources.sphinx.outputstyle == 'notebook' *))
             ((*- if output.output_type == 'pyout' -*))
                 ((( write_prompt("Out", prompt_number, "nbframe-out-prompt") )))
                 \vspace{-2.55\baselineskip}
             ((*- endif -*))
 
             \begin{InvisibleVerbatim}
                 \vspace{-0.5\baselineskip}
         ((*- endif -*))
 
         ((*- block display_data scoped -*))
             ((( super() )))
         ((*- endblock display_data -*))
 
         ((* if resources.sphinx.outputstyle == 'notebook' *))
             \end{InvisibleVerbatim}
         ((*- endif -*))
     ((*- endif -*))
 ((*- endmacro *))
 
 % Name: iff_figure
 % Purpose: If the output block provided is a figure type, the 'true_content'
 %          parameter will be returned.  Else, the 'false_content'. 
 ((* macro iff_figure(output, true_content, false_content) -*))
     ((*- set is_figure = false -*))
     ((*- for type in output | filter_data_type -*))
         ((*- if type in ['pdf', 'svg', 'png', 'jpeg','html']*))
             ((*- set is_figure = true -*))
         ((*- endif -*))
     ((*- endfor -*))
     
     ((* if is_figure -*))
         ((( true_content )))
     ((*- else -*))
         ((( false_content )))
     ((*- endif *))
 ((*- endmacro *))
 
 % Name: custom_verbatim
 % Purpose: This macro creates a verbatim style block that fits the existing
 %          sphinx style more readily than standard verbatim blocks.
 ((* macro custom_verbatim(text) -*))
     \begin{alltt}
     ((*- if resources.sphinx.centeroutput *))\begin{center} ((* endif -*))
 ((( text | wrap_text(wrap_size) | escape_latex )))
     ((*- if resources.sphinx.centeroutput *))\end{center}((* endif -*))
     \end{alltt}
 ((*- endmacro *))
 
 % Name: conditionally_center_output
 % Purpose: This macro centers the output if the output centering is enabled.
 ((* macro conditionally_center_output(text) -*))
     ((* if resources.sphinx.centeroutput *))
         {\centering
     ((* endif *))
     ((( text )))
     ((* if resources.sphinx.centeroutput *))}
     ((* endif *))
 ((*- endmacro *))
 
 % Name: insert_graphics
 % Purpose: This macro will insert an image in the latex document given a path.
 ((* macro insert_graphics(path) -*))
     \begin{center}
     \includegraphics[max size={\textwidth}{\textheight}]{((( path )))}
     \par
     \end{center}
 ((*- endmacro *))