sile 0.15.6

Simon’s Improved Layout Engine
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
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

local base = require("packages.base")

local package = pl.class(base)
package._name = "footnotes"

function package:_init (options)
   base._init(self)
   self:loadPackage("counters")
   self:loadPackage("raiselower")
   self:loadPackage("insertions")
   if not SILE.scratch.counters.footnotes then
      SILE.scratch.counters.footnote = { value = 1, display = "arabic" }
   end
   options = options or {}
   self.class:initInsertionClass("footnote", {
      insertInto = options.insertInto or "footnotes",
      stealFrom = options.stealFrom or { "content" },
      maxHeight = SILE.types.length("75%ph"),
      topBox = SILE.types.node.vglue("2ex"),
      interInsertionSkip = SILE.types.length("1ex"),
   })
end

function package:registerCommands ()
   self:registerCommand("footnotemark", function (_, _)
      SILE.call("raise", { height = "0.7ex" }, function ()
         SILE.call("font", { size = "1.5ex" }, function ()
            SILE.typesetter:typeset(self.class.packages.counters:formatCounter(SILE.scratch.counters.footnote))
         end)
      end)
   end)

   self:registerCommand("footnote:separator", function (_, content)
      SILE.settings:pushState()
      local material = SILE.call("vbox", {}, content)
      SILE.scratch.insertions.classes.footnote.topBox = material
      SILE.settings:popState()
   end)

   self:registerCommand("footnote:options", function (options, _)
      if options["maxHeight"] then
         SILE.scratch.insertions.classes.footnote.maxHeight = SILE.types.length(options["maxHeight"])
      end
      if options["interInsertionSkip"] then
         SILE.scratch.insertions.classes.footnote.interInsertionSkip = SILE.types.length(options["interInsertionSkip"])
      end
   end)

   self:registerCommand("footnote", function (options, content)
      SILE.call("footnotemark")
      local opts = SILE.scratch.insertions.classes.footnote or {}
      local frame = opts.insertInto and SILE.getFrame(opts.insertInto.frame)
      local oldGetTargetLength = SILE.typesetter.getTargetLength
      local oldFrame = SILE.typesetter.frame
      SILE.typesetter.getTargetLength = function ()
         return SILE.types.length(0xFFFFFF)
      end
      SILE.settings:pushState()
      -- Restore the settings to the top of the queue, which should be the document #986
      SILE.settings:toplevelState()
      SILE.typesetter:initFrame(frame)

      -- Reset settings the document may have but should not be applied to footnotes
      -- See also same resets in folio package
      for _, v in ipairs({
         "current.hangAfter",
         "current.hangIndent",
         "linebreak.hangAfter",
         "linebreak.hangIndent",
      }) do
         SILE.settings:set(v, SILE.settings.defaults[v])
      end

      -- Apply the font before boxing, so relative baselineskip applies #1027
      local material
      SILE.call("footnote:font", {}, function ()
         material = SILE.call("vbox", {}, function ()
            SILE.call("footnote:atstart", options)
            SILE.call("footnote:counter", options)
            SILE.process(content)
         end)
      end)
      SILE.settings:popState()
      SILE.typesetter.getTargetLength = oldGetTargetLength
      SILE.typesetter.frame = oldFrame
      self.class:insert("footnote", material)
      SILE.scratch.counters.footnote.value = SILE.scratch.counters.footnote.value + 1
   end)

   self:registerCommand("footnote:font", function (_, content)
      -- The footnote frame has is settings reset to the toplevel state, so if one does
      -- something relative (as below), it is expected to be the main value from the
      -- document.
      SILE.call("font", { size = SILE.settings:get("font.size") * 0.9 }, function ()
         SILE.process(content)
      end)
   end)

   self:registerCommand("footnote:atstart", function (_, _) end)

   self:registerCommand("footnote:counter", function (_, _)
      SILE.call("noindent")
      SILE.typesetter:typeset(self.class.packages.counters:formatCounter(SILE.scratch.counters.footnote) .. ".")
      SILE.call("qquad")
   end)
end

package.documentation = [[
\begin{document}
The \autodoc:package{footnotes} package allows you to add footnotes to text with the \autodoc:command{\footnote} command.
Other commands provided by the package, not described here, take care of formatting the footnotes.

Usually, a document class is responsible for automatically loading this package.
Minimally, upon initialization, it needs a frame identifier for the the footnotes, and one or more frame(s) which will be reduced as the footnotes take place.
By default, it uses, respectively, the \code{footnotes} and \code{content} frames, which are assumed to be present in the default standard layout.

For the record, it internally relies on the \autodoc:package{insertions} package and tells it which frame should receive the footnotes that are typeset.
\end{document}
]]

return package