Improvements to the tex rendering pipeline

src/rendering/texformats.jl

@@ -3,7 +3,10 @@
 
 abstract type TexFormat <: WeaveFormat end
 
-set_rendering_options!(docformat::TexFormat; keep_unicode = false, kwargs...) = docformat.keep_unicode |= keep_unicode
+function set_rendering_options!(docformat::TexFormat; keep_unicode = false, template=nothing, kwargs...)
+    docformat.keep_unicode |= keep_unicode
+    docformat.template = get_tex_template(template)
+end
 
 function formatfigures(chunk, docformat::TexFormat)
     fignames = chunk.figures
@@ -73,40 +76,17 @@ function md_length_to_latex(def, reference)
     return def
 end
 
-# plain Tex
-# ---------
-
-Base.@kwdef mutable struct Tex <: TexFormat
-    description = "Latex with custom code environments"
-    extension = "tex"
-    codestart = "\\begin{juliacode}"
-    codeend = "\\end{juliacode}"
-    termstart = "\\begin{juliaterm}"
-    termend = "\\end{juliaterm}"
-    outputstart = "\\begin{juliaout}"
-    outputend = "\\end{juliaout}"
-    mimetypes = ["application/pdf", "image/png", "text/latex", "text/plain"]
-    fig_ext = ".pdf"
-    out_width = "\\linewidth"
-    out_height = nothing
-    fig_pos = "htpb"
-    fig_env = "figure"
-    # specials
-    keep_unicode = false
-end
-register_format!("tex", Tex())
-
 # minted Tex
 # ----------
 
 Base.@kwdef mutable struct TexMinted <: TexFormat
     description = "Latex using minted for highlighting"
     extension = "tex"
-    codestart = "\\begin{minted}[mathescape, fontsize=\\small, xleftmargin=0.5em]{julia}"
+    codestart = "\\begin{minted}[escapeinside=||, mathescape, fontsize=\\small, xleftmargin=0.5em]{julia}"
     codeend = "\\end{minted}"
-    termstart = "\\begin{minted}[fontsize=\\footnotesize, xleftmargin=0.5em, mathescape]{jlcon}"
+    termstart = "\\begin{minted}[escapeinside=||, mathescape, fontsize=\\footnotesize, xleftmargin=0.5em]{jlcon}"
     termend = "\\end{minted}"
-    outputstart = "\\begin{minted}[fontsize=\\small, xleftmargin=0.5em, mathescape, frame = leftline]{text}"
+    outputstart = "\\begin{minted}[escapeinside=||, mathescape, fontsize=\\small, xleftmargin=0.5em, frame = leftline]{text}"
     outputend = "\\end{minted}"
     mimetypes = ["application/pdf", "image/png", "text/latex", "text/plain"]
     fig_ext = ".pdf"
@@ -116,6 +96,8 @@ Base.@kwdef mutable struct TexMinted <: TexFormat
     fig_env = "figure"
     # specials
     keep_unicode = false
+    template = nothing
+    tex_deps = "\\usepackage{minted}"
 end
 register_format!("texminted", TexMinted())
 
@@ -142,6 +124,7 @@ Base.@kwdef mutable struct JMarkdown2tex <: TexFormat
     highlight_theme = nothing
     template = nothing
     keep_unicode = false
+    tex_deps = ""
 end
 register_format!("md2tex", JMarkdown2tex())
 register_format!("md2pdf", JMarkdown2tex())
@@ -155,17 +138,28 @@ end
 get_tex_template(::Nothing) = get_template(normpath(TEMPLATE_DIR, "md2pdf.tpl"))
 get_tex_template(x) = get_template(x)
 
+function render_doc(docformat::TexFormat, body, doc)
+    return Mustache.render(
+        docformat.template;
+        body = body,
+        highlight = "",
+        tex_deps = docformat.tex_deps,
+        [Pair(Symbol(k), v) for (k, v) in doc.header]...,
+    )
+end
+
 function render_doc(docformat::JMarkdown2tex, body, doc)
     return Mustache.render(
         docformat.template;
         body = body,
         highlight = get_highlight_stylesheet(MIME("text/latex"), docformat.highlight_theme),
+        tex_deps = docformat.tex_deps,
         [Pair(Symbol(k), v) for (k, v) in doc.header]...,
     )
 end
 
 # very similar to export to html
-function format_chunk(chunk::DocChunk, docformat::JMarkdown2tex)
+function format_chunk(chunk::DocChunk, docformat::TexFormat)
     out = IOBuffer()
     io = IOBuffer()
     for inline in chunk.content
@@ -182,7 +176,12 @@ function format_chunk(chunk::DocChunk, docformat::JMarkdown2tex)
     end
     clear_buffer_and_format!(io, out, WeaveMarkdown.latex)
     out = take2string!(out)
-    return docformat.keep_unicode ? out : uc2tex(out)
+    return docformat.keep_unicode ? out : uc2tex(docformat, out)
+end
+
+function format_output(result, docformat::TexFormat)
+    docformat.keep_unicode || return uc2tex(docformat, result, true)
+    return result
 end
 
 function format_output(result, docformat::JMarkdown2tex)
@@ -192,18 +191,22 @@ function format_output(result, docformat::JMarkdown2tex)
             Highlights.Format.escape(io, MIME("text/latex"), x, charescape = true),
         result,
     )
-    docformat.keep_unicode || return uc2tex(result_escaped, true)
+    docformat.keep_unicode || return uc2tex(docformat, result_escaped, true)
     return result_escaped
 end
 
+function format_code(code, docformat::TexFormat)
+    docformat.keep_unicode || return uc2tex(docformat, code, true)
+    return ret
+end
 function format_code(code, docformat::JMarkdown2tex)
     ret = highlight_code(MIME("text/latex"), code, docformat.highlight_theme)
-    docformat.keep_unicode || return uc2tex(ret)
+    docformat.keep_unicode || return uc2tex(docformat, ret, false)
     return ret
 end
 
 # Convert unicode to tex, escape listings if needed
-function uc2tex(s, escape = false)
+function uc2tex(::JMarkdown2tex, s, escape = false)
     for key in keys(latex_symbols)
         if escape
             s = replace(s, latex_symbols[key] => "(*@\\ensuremath{$(texify(key))}@*)")
@@ -214,7 +217,20 @@ function uc2tex(s, escape = false)
     return s
 end
 
-# should_render(chunk) ? highlight_term(MIME("text/latex"), , docformat.highlight_theme) : ""
+function uc2tex(::TexFormat, s, escape = false)
+    for key in keys(latex_symbols)
+        if escape
+            s = replace(s, latex_symbols[key] => "|\$\\ensuremath{$(texify(key))}\$|")
+        else
+            s = replace(s, latex_symbols[key] => "\\ensuremath{$(texify(key))}")
+        end
+    end
+    return s
+end
+
+format_termchunk(chunk, docformat::TexFormat) =
+    string(docformat.termstart, chunk.output, docformat.termend, "\n")
+
 format_termchunk(chunk, docformat::JMarkdown2tex) =
     should_render(chunk) ? highlight_term(MIME("text/latex"), chunk.output, docformat.highlight_theme) : ""
 

templates/md2pdf.tpl

@@ -7,7 +7,9 @@
 \usepackage{graphicx}
 \usepackage{microtype}
 \usepackage{hyperref}
-
+{{#:tex_deps}}
+{{{ :tex_deps }}}
+{{/:tex_deps}}
 \setlength{\parindent}{0pt}
 \setlength{\parskip}{1.2ex}