mdoc 0.3.0

Modern PDF creation through Markdown and LaTeX
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102

local sections = {}
local figures = {}
local figure_count = 1
local equations = {}
local eq_count = 1
local tables = {}
local table_count = 1

-- Poplate sections table with ID and number
local function populate_sections(doc)
  local function populate(elements)
    for _, el in pairs(elements) do
      if el.t == "Div" and el.attributes.number then
        sections[el.attr.identifier] = el.attributes.number
        populate(el.content)
      end
    end
  end
  populate(pandoc.utils.make_sections(true, nil, doc.blocks))
end

-- Populate figures table with ID and number
local function populate_figures(fig)
  if fig.identifier and #fig.caption ~= 0 then
    figures[fig.identifier] = figure_count
    figure_count = figure_count + 1
  end
end

-- Populate equations table with ID and number, and transform into Div with ID containing numbered equation
local function populate_equations(para)
  if para.content[1].t == "Math" and para.content[1].mathtype == "DisplayMath" then
    for i=#para.content,1,-1 do -- Iterating backwards to limit number of loops (ID often placed after the caption)
      local el = para.content[i]
      if el.t == "Str" and el.text:match("{#eq:.*}") then
        local id = el.text:gsub("{#", ""):gsub("}", "") -- Strip the prefix and brackets
        equations[id] = eq_count
        eq_count = eq_count + 1
        if FORMAT == "latex" then
          return pandoc.RawBlock("latex", "\\begin{equation}\n" .. para.content[1].text .. "\n\\label{" .. id .. "}\n\\end{equation}")
        else
          -- I'm mostly interested in HTML, in which this is the same behavior as pandoc-crossref.
          -- For other formats, there is probably a better solution than using \qquad
          return pandoc.Para(pandoc.Span(pandoc.Math("DisplayMath", "\\tag{" .. equations[id] .. "} " .. para.content[1].text ), {id = id}))
        end
      end
    end
  end
end


local function populate_tables(table)
  if table.caption and #table.caption.long > 0 then
    -- Caption might contain several blocks, extract ID from last block
    local caption = table.caption.long[#table.caption.long].content
    for i=#caption,1,-1 do -- Iterating backwards to limit number of loops (ID often placed after the caption)
      if caption[i].t == "Str" and caption[i].text:match("^{#tbl:.*}") then
        local id = caption[i].text:gsub("{#", ""):gsub("}", "") -- Strip the prefix and brackets (FIXME: Other attributes should perhaps be allowed...)
        tables[id] = table_count
        table.identifier = id
        table_count = table_count + 1
        -- Remove ID definition and the space before from caption
        caption:remove(i); if i > 2 then caption:remove(i-1) end
        if FORMAT == "latex" then
          caption:insert(i-1, pandoc.RawInline("tex", "\\label{" .. id .. "}"))
          return table
        else
          return pandoc.Div(table, {id = id})
        end
      end
    end
  end
end


local function refs(cite)
  local id = cite.citations[1].id
  local sec = id:match("^sec:.*")
  local fig = id:match("^fig:.*")
  local tbl = id:match("^tbl:.*")
  local eq = id:match("^eq:.*")

  if FORMAT == "latex" and (sec or fig or tbl or eq) then
    return pandoc.RawInline("latex", "\\ref{" .. id .. "}")
  elseif sec then
    return pandoc.Link({pandoc.Str(sections[id])}, '#' .. id, "", "")
  elseif fig then
    return pandoc.Link({pandoc.Str(figures[id])}, '#' .. id, "", "")
  elseif tbl then
    return pandoc.Link({pandoc.Str(tables[id])}, '#' .. id, "", "")
  elseif eq then
    return pandoc.Link({pandoc.Str(equations[id])}, '#' .. id, "", "")
  end
end

return {
  {Pandoc = populate_sections},
  {Image = populate_figures},
  {Para = populate_equations},
  {Table = populate_tables},
  {Cite = refs},
}