2016-12-13 19:03:07 +01:00
|
|
|
import Mustache, Highlights, Documenter
|
2016-12-13 12:26:34 +01:00
|
|
|
|
|
|
|
function format(doc::WeaveDoc)
|
|
|
|
formatted = AbstractString[]
|
|
|
|
docformat = doc.format
|
|
|
|
|
|
|
|
#Complete format dictionaries with defaults
|
|
|
|
formatdict = docformat.formatdict
|
|
|
|
get!(formatdict, :termstart, formatdict[:codestart])
|
|
|
|
get!(formatdict, :termend, formatdict[:codeend])
|
|
|
|
get!(formatdict, :out_width, nothing)
|
|
|
|
get!(formatdict, :out_height, nothing)
|
|
|
|
get!(formatdict, :fig_pos, nothing)
|
|
|
|
get!(formatdict, :fig_env, nothing)
|
|
|
|
|
2016-12-13 14:30:23 +01:00
|
|
|
docformat.formatdict[:cwd] = doc.cwd #pass wd to figure formatters
|
2016-12-13 12:26:34 +01:00
|
|
|
|
|
|
|
for chunk in copy(doc.chunks)
|
|
|
|
result = format_chunk(chunk, formatdict, docformat)
|
|
|
|
push!(formatted, result)
|
|
|
|
end
|
|
|
|
|
|
|
|
formatted = join(formatted, "\n")
|
|
|
|
# Render using a template if needed
|
2016-12-13 14:43:37 +01:00
|
|
|
rendered = render_doc(formatted, doc, doc.format)
|
2016-12-13 12:26:34 +01:00
|
|
|
|
|
|
|
return rendered
|
|
|
|
end
|
|
|
|
|
|
|
|
"""
|
|
|
|
render_doc(formatted::AbstractString, format)
|
|
|
|
|
|
|
|
Render formatted document to a template
|
|
|
|
"""
|
2016-12-13 14:43:37 +01:00
|
|
|
function render_doc(formatted, doc::WeaveDoc, format)
|
2016-12-13 12:26:34 +01:00
|
|
|
return formatted
|
|
|
|
end
|
|
|
|
|
2016-12-13 14:43:37 +01:00
|
|
|
function render_doc(formatted, doc::WeaveDoc, format::JMarkdown2HTML)
|
2016-12-13 12:26:34 +01:00
|
|
|
buf = PipeBuffer()
|
|
|
|
Highlights.stylesheet(buf, MIME("text/css"))
|
|
|
|
flush(buf)
|
|
|
|
css = readstring(buf)
|
|
|
|
close(buf)
|
|
|
|
|
2016-12-13 19:51:34 +01:00
|
|
|
title = get_title(doc)
|
2016-12-13 14:52:33 +01:00
|
|
|
path, wsource = splitdir(abspath(doc.source))
|
|
|
|
wversion = string(Pkg.installed("Weave"))
|
|
|
|
wtime = string(Date(now()))
|
|
|
|
|
2016-12-13 12:26:34 +01:00
|
|
|
theme_css = readstring(joinpath(dirname(@__FILE__), "../templates/skeleton_css.txt"))
|
|
|
|
template = Mustache.template_from_file(joinpath(dirname(@__FILE__), "../templates/julia_html.txt"))
|
|
|
|
|
2016-12-13 13:20:40 +01:00
|
|
|
return Mustache.render(template, themecss = theme_css,
|
2016-12-13 14:52:33 +01:00
|
|
|
highlightcss = css, body = formatted, header_script = doc.header_script,
|
2016-12-13 19:51:34 +01:00
|
|
|
source = wsource, wtime = wtime, wversion = wversion,
|
|
|
|
title = title)
|
|
|
|
end
|
|
|
|
|
|
|
|
function get_title(doc::WeaveDoc)
|
|
|
|
if isa(doc.chunks[1], CodeChunk)
|
|
|
|
return doc.source
|
|
|
|
end
|
|
|
|
|
2016-12-13 21:02:42 +01:00
|
|
|
isempty(doc.chunks[1].content) && return doc.source
|
2016-12-13 19:51:34 +01:00
|
|
|
m = Base.Markdown.parse(doc.chunks[1].content)
|
|
|
|
|
|
|
|
if isa(m.content[1], Base.Markdown.Header)
|
|
|
|
title = m.content[1].text[1]
|
|
|
|
else
|
|
|
|
title = doc.source
|
|
|
|
end
|
|
|
|
|
|
|
|
return title
|
2016-12-13 12:26:34 +01:00
|
|
|
end
|
|
|
|
|
|
|
|
function format_chunk(chunk::DocChunk, formatdict, docformat)
|
|
|
|
return chunk.content
|
|
|
|
end
|
|
|
|
|
|
|
|
function format_chunk(chunk::DocChunk, formatdict, docformat::JMarkdown2HTML)
|
|
|
|
m = Base.Markdown.parse(chunk.content)
|
2016-12-13 19:03:07 +01:00
|
|
|
#Base.Markdown.html(m)
|
|
|
|
return string(Documenter.Writers.HTMLWriter.mdconvert(m))
|
2016-12-13 12:26:34 +01:00
|
|
|
end
|
|
|
|
|
|
|
|
|
|
|
|
function format_chunk(chunk::CodeChunk, formatdict, docformat)
|
|
|
|
#Fill undefined options with format specific defaults
|
|
|
|
chunk.options[:out_width] == nothing &&
|
|
|
|
(chunk.options[:out_width] = formatdict[:out_width])
|
|
|
|
chunk.options[:fig_pos] == nothing &&
|
|
|
|
(chunk.options[:fig_pos] = formatdict[:fig_pos])
|
|
|
|
|
|
|
|
#Only use floats if chunk has caption or sets fig_env
|
|
|
|
if chunk.options[:fig_cap] != nothing && chunk.options[:fig_env] == nothing
|
|
|
|
(chunk.options[:fig_env] = formatdict[:fig_env])
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
|
|
if haskey(formatdict, :indent)
|
|
|
|
chunk.content = indent(chunk.content, formatdict[:indent])
|
|
|
|
end
|
|
|
|
|
2016-12-13 14:30:23 +01:00
|
|
|
chunk.content = format_code(chunk.content, docformat)
|
|
|
|
|
2016-12-13 12:26:34 +01:00
|
|
|
if !chunk.options[:eval]
|
|
|
|
if chunk.options[:echo]
|
|
|
|
result = "$(formatdict[:codestart])$(chunk.content)\n$(formatdict[:codeend])"
|
|
|
|
return result
|
|
|
|
else
|
|
|
|
r = ""
|
|
|
|
return r
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
if chunk.options[:term]
|
2016-12-13 13:20:40 +01:00
|
|
|
result = format_termchunk(chunk, formatdict, docformat)
|
2016-12-13 12:26:34 +01:00
|
|
|
else
|
|
|
|
|
|
|
|
if chunk.options[:echo]
|
|
|
|
#Convert to output format and highlight (html, tex...) if needed
|
2016-12-13 14:30:23 +01:00
|
|
|
result = "$(formatdict[:codestart])$(chunk.content)\n$(formatdict[:codeend])\n"
|
2016-12-13 12:26:34 +01:00
|
|
|
else
|
|
|
|
result = ""
|
|
|
|
end
|
|
|
|
|
|
|
|
if (strip(chunk.output)!= "" || strip(chunk.rich_output) != "") && (chunk.options[:results] != "hidden")
|
|
|
|
chunk.output = format_output(chunk.output, docformat)
|
|
|
|
if chunk.options[:results] != "markup" && chunk.options[:results] != "hold"
|
|
|
|
strip(chunk.output) ≠ "" && (result *= "$(chunk.output)\n")
|
|
|
|
strip(chunk.rich_output) ≠ "" && (result *= "$(chunk.rich_output)\n")
|
|
|
|
else
|
|
|
|
if chunk.options[:wrap]
|
|
|
|
chunk.output = "\n" * wraplines(chunk.output,
|
|
|
|
chunk.options[:line_width])
|
|
|
|
end
|
|
|
|
|
|
|
|
if haskey(formatdict, :indent)
|
|
|
|
chunk.output = indent(chunk.output, formatdict[:indent])
|
|
|
|
end
|
|
|
|
strip(chunk.output) ≠ "" &&
|
|
|
|
(result *= "$(formatdict[:outputstart])$(chunk.output)\n$(formatdict[:outputend])\n")
|
|
|
|
strip(chunk.rich_output) ≠ "" && (result *= chunk.rich_output * "\n")
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
end
|
|
|
|
|
|
|
|
#Handle figures
|
|
|
|
if chunk.options[:fig] && length(chunk.figures) > 0
|
|
|
|
if chunk.options[:include]
|
|
|
|
result *= formatfigures(chunk, docformat)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
return result
|
|
|
|
end
|
|
|
|
|
|
|
|
function format_output(result::AbstractString, docformat)
|
|
|
|
return(result)
|
|
|
|
end
|
|
|
|
|
|
|
|
function format_output(result::AbstractString, docformat::JMarkdown2HTML)
|
|
|
|
return(Base.Markdown.htmlesc(result))
|
|
|
|
end
|
|
|
|
|
|
|
|
function format_code(result::AbstractString, docformat)
|
|
|
|
return result
|
|
|
|
end
|
|
|
|
|
|
|
|
function format_code(result::AbstractString, docformat::JMarkdown2HTML)
|
|
|
|
buf = PipeBuffer()
|
|
|
|
Highlights.highlight(buf, MIME("text/html"), strip(result), Highlights.Lexers.JuliaLexer)
|
|
|
|
flush(buf)
|
|
|
|
highlighted = readstring(buf)
|
|
|
|
close(buf)
|
|
|
|
return highlighted
|
|
|
|
end
|
|
|
|
|
2016-12-13 13:20:40 +01:00
|
|
|
function format_termchunk(chunk, formatdict, docformat)
|
2016-12-13 12:26:34 +01:00
|
|
|
if chunk.options[:echo] && chunk.options[:results] != "hidden"
|
|
|
|
result = "$(formatdict[:termstart])$(chunk.output)\n" * "$(formatdict[:termend])\n"
|
2016-12-13 13:20:40 +01:00
|
|
|
else
|
|
|
|
result = ""
|
|
|
|
end
|
|
|
|
return result
|
|
|
|
end
|
|
|
|
|
|
|
|
function format_termchunk(chunk, formatdict, docformat::JMarkdown2HTML)
|
|
|
|
if chunk.options[:echo] && chunk.options[:results] != "hidden"
|
|
|
|
buf = PipeBuffer()
|
|
|
|
Highlights.highlight(buf, MIME("text/html"), strip(chunk.output), Highlights.Lexers.JuliaConsoleLexer)
|
|
|
|
flush(buf)
|
|
|
|
result = readstring(buf)
|
|
|
|
close(buf)
|
2016-12-13 12:26:34 +01:00
|
|
|
else
|
|
|
|
result = ""
|
|
|
|
end
|
|
|
|
return result
|
|
|
|
end
|
|
|
|
|
|
|
|
function indent(text, nindent)
|
|
|
|
return join(map(x->
|
|
|
|
string(repeat(" ", nindent), x), split(text, "\n")), "\n")
|
|
|
|
end
|
|
|
|
|
|
|
|
|
|
|
|
function wraplines(text, line_width=75)
|
|
|
|
result = AbstractString[]
|
|
|
|
lines = split(text, "\n")
|
|
|
|
for line in lines
|
|
|
|
if length(line) > line_width
|
|
|
|
push!(result, wrapline(line, line_width))
|
|
|
|
else
|
|
|
|
push!(result, line)
|
|
|
|
end
|
|
|
|
end
|
|
|
|
|
|
|
|
#return result
|
|
|
|
return strip(join(result, "\n"))
|
|
|
|
end
|
|
|
|
|
|
|
|
function wrapline(text, line_width=75)
|
|
|
|
result = ""
|
|
|
|
while length(text) > line_width
|
|
|
|
result*= text[1:line_width] * "\n"
|
|
|
|
text = text[(line_width+1):end]
|
|
|
|
end
|
|
|
|
result *= text
|
|
|
|
end
|