mirror of https://github.com/mpastell/Weave.jl
255 lines
7.8 KiB
Julia
255 lines
7.8 KiB
Julia
# Tex
|
|
# ---
|
|
|
|
abstract type TexFormat <: WeaveFormat end
|
|
|
|
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
|
|
caption = chunk.options[:fig_cap]
|
|
width = chunk.options[:out_width]
|
|
height = chunk.options[:out_height]
|
|
f_pos = chunk.options[:fig_pos]
|
|
f_env = chunk.options[:fig_env]
|
|
result = ""
|
|
figstring = ""
|
|
|
|
if isnothing(f_env) && !isnothing(caption)
|
|
f_env = "figure"
|
|
end
|
|
|
|
(isnothing(f_pos)) && (f_pos = "!h")
|
|
# Set size
|
|
attribs = ""
|
|
isnothing(width) || (attribs = "width=$(md_length_to_latex(width,"\\linewidth"))")
|
|
(!isempty(attribs) && !isnothing(height)) && (attribs *= ",")
|
|
isnothing(height) || (attribs *= "height=$(md_length_to_latex(height,"\\paperheight"))")
|
|
|
|
if !isnothing(f_env)
|
|
result *= "\\begin{$f_env}"
|
|
(!isempty(f_pos)) && (result *= "[$f_pos]")
|
|
result *= "\n"
|
|
end
|
|
|
|
for fig in fignames
|
|
if splitext(fig)[2] == ".tex" # Tikz figures
|
|
figstring *= "\\resizebox{$width}{!}{\\input{$fig}}\n"
|
|
else
|
|
if isempty(attribs)
|
|
figstring *= "\\includegraphics{$fig}\n"
|
|
else
|
|
figstring *= "\\includegraphics[$attribs]{$fig}\n"
|
|
end
|
|
end
|
|
end
|
|
|
|
# Figure environment
|
|
if !isnothing(caption)
|
|
result *= string("\\center\n", "$figstring", "\\caption{$caption}\n")
|
|
else
|
|
result *= figstring
|
|
end
|
|
|
|
if !isnothing(chunk.options[:label]) && !isnothing(f_env)
|
|
label = chunk.options[:label]
|
|
result *= "\\label{fig:$label}\n"
|
|
end
|
|
|
|
if !isnothing(f_env)
|
|
result *= "\\end{$f_env}\n"
|
|
end
|
|
|
|
return result
|
|
end
|
|
|
|
function md_length_to_latex(def, reference)
|
|
if occursin("%", def)
|
|
_def = tryparse(Float64, replace(def, "%" => ""))
|
|
isnothing(_def) && return def
|
|
perc = round(_def / 100, digits = 2)
|
|
return "$perc$reference"
|
|
end
|
|
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
|
|
template = nothing
|
|
tex_deps = ""
|
|
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}"
|
|
codeend = "\\end{minted}"
|
|
termstart = "\\begin{minted}[fontsize=\\footnotesize, xleftmargin=0.5em, mathescape]{jlcon}"
|
|
termend = "\\end{minted}"
|
|
outputstart = "\\begin{minted}[fontsize=\\small, xleftmargin=0.5em, mathescape, frame = leftline]{text}"
|
|
outputend = "\\end{minted}"
|
|
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
|
|
template = nothing
|
|
tex_deps = "\\usepackage{minted}"
|
|
end
|
|
register_format!("texminted", TexMinted())
|
|
|
|
# Tex (directly to PDF)
|
|
# ---------------------
|
|
|
|
Base.@kwdef mutable struct JMarkdown2tex <: TexFormat
|
|
description = "Julia markdown to latex"
|
|
extension = "tex"
|
|
codestart = ""
|
|
codeend = ""
|
|
termstart = codestart
|
|
termend = codeend
|
|
outputstart = "\\begin{lstlisting}"
|
|
outputend = "\\end{lstlisting}\n"
|
|
mimetypes = ["application/pdf", "image/png", "image/jpg",
|
|
"text/latex", "text/markdown", "text/plain"]
|
|
fig_ext = ".pdf"
|
|
out_width = "\\linewidth"
|
|
out_height = nothing
|
|
fig_pos = nothing
|
|
fig_env = nothing
|
|
# specials
|
|
highlight_theme = nothing
|
|
template = nothing
|
|
keep_unicode = false
|
|
tex_deps = ""
|
|
end
|
|
register_format!("md2tex", JMarkdown2tex())
|
|
register_format!("md2pdf", JMarkdown2tex())
|
|
|
|
function set_rendering_options!(docformat::JMarkdown2tex; template = nothing, highlight_theme = nothing, keep_unicode = false, kwargs...)
|
|
docformat.template = get_tex_template(template)
|
|
docformat.highlight_theme = get_highlight_theme(highlight_theme)
|
|
docformat.keep_unicode |= keep_unicode
|
|
end
|
|
|
|
get_tex_template(::Nothing) = get_template(normpath(TEMPLATE_DIR, "md2pdf.tpl"))
|
|
get_tex_template(x) = get_template(x)
|
|
|
|
highlight_str(docformat::TexFormat) = ""
|
|
highlight_str(docformat::JMarkdown2tex) =
|
|
get_highlight_stylesheet(MIME("text/latex"), docformat.highlight_theme)
|
|
|
|
function render_doc(docformat::TexFormat, body, doc)
|
|
return Mustache.render(
|
|
docformat.template;
|
|
body = body,
|
|
highlight = highlight_str(docformat),
|
|
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::TexFormat)
|
|
out = IOBuffer()
|
|
io = IOBuffer()
|
|
for inline in chunk.content
|
|
if isa(inline, InlineText)
|
|
write(io, inline.content)
|
|
elseif !isempty(inline.rich_output)
|
|
clear_buffer_and_format!(io, out, WeaveMarkdown.latex)
|
|
write(out, addlines(inline.rich_output, inline))
|
|
elseif !isempty(inline.figures)
|
|
write(io, inline.figures[end], inline)
|
|
elseif !isempty(inline.output)
|
|
write(io, addlines(inline.output, inline))
|
|
end
|
|
end
|
|
clear_buffer_and_format!(io, out, WeaveMarkdown.latex)
|
|
out = take2string!(out)
|
|
return docformat.keep_unicode ? out : uc2tex(out)
|
|
end
|
|
|
|
function format_output(result, docformat::TexFormat)
|
|
# Highligts has some extra escaping defined, eg of $, ", ...
|
|
result_escaped = sprint(
|
|
(io, x) ->
|
|
Highlights.Format.escape(io, MIME("text/latex"), x, charescape = true),
|
|
result,
|
|
)
|
|
docformat.keep_unicode || return uc2tex(result_escaped, true)
|
|
return result_escaped
|
|
end
|
|
|
|
# Highlight code is currently only compatible with lstlistings (JMarkdown2tex)
|
|
highlight_code(code, docformat::TexFormat) = code
|
|
highlight_code(code, docformat::JMarkdown2tex) =
|
|
highlight_code(MIME("text/latex"), code, docformat.highlight_theme)
|
|
|
|
function format_code(code, docformat::TexFormat)
|
|
ret = highlight_code(code, docformat)
|
|
docformat.keep_unicode || return uc2tex(ret)
|
|
return ret
|
|
end
|
|
|
|
# Convert unicode to tex, escape listings if needed
|
|
function uc2tex(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) : ""
|
|
|
|
# Make julia symbols (\bf* etc.) valid latex
|
|
function texify(s)
|
|
return if occursin(r"^\\bf[A-Z]$", s)
|
|
replace(s, "\\bf" => "\\bm{\\mathrm{") * "}}"
|
|
elseif startswith(s, "\\bfrak")
|
|
replace(s, "\\bfrak" => "\\bm{\\mathfrak{") * "}}"
|
|
elseif startswith(s, "\\bf")
|
|
replace(s, "\\bf" => "\\bm{\\") * "}"
|
|
elseif startswith(s, "\\frak")
|
|
replace(s, "\\frak" => "\\mathfrak{") * "}"
|
|
else
|
|
s
|
|
end
|
|
end
|