9456669609

Committed 10 Jun 2024 10:52PM UTC coverage: 64.428% (-4.1%) from 68.509%

Build # 9456669609

Build Type

push

github

Committed by

alerque

Commit Message

chore(release): 0.15.3

Run Details

11119 of 17258 relevant lines covered (64.43%)

8707.56 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

87.88

/packages/footnotes/init.lua

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

1	local base = require("packages.base")	18✔
2
3	local package = pl.class(base)	18✔
4	package._name = "footnotes"	18✔
5
6	function package:_init (options)	18✔
7	base._init(self)	18✔
8	self:loadPackage("counters")	18✔
9	self:loadPackage("raiselower")	18✔
10	self:loadPackage("insertions")	18✔
11	if not SILE.scratch.counters.footnotes then	18✔
12	SILE.scratch.counters.footnote = { value = 1, display = "arabic" }	18✔
13	end
14	options = options or {}	18✔
15	self.class:initInsertionClass("footnote", {	36✔
16	insertInto = options.insertInto or "footnotes",	18✔
17	stealFrom = options.stealFrom or { "content" },	18✔
18	maxHeight = SILE.types.length("75%ph"),	36✔
19	topBox = SILE.types.node.vglue("2ex"),	36✔
20	interInsertionSkip = SILE.types.length("1ex"),	36✔
21	})
22	end
23
24	function package:registerCommands ()	18✔
25	self:registerCommand("footnotemark", function (_, _)	36✔
26	SILE.call("raise", { height = "0.7ex" }, function ()	12✔
27	SILE.call("font", { size = "1.5ex" }, function ()	12✔
28	SILE.typesetter:typeset(self.class.packages.counters:formatCounter(SILE.scratch.counters.footnote))	12✔
29	end)
30	end)
31	end)
32
33	self:registerCommand("footnote:separator", function (_, content)	36✔
34	SILE.settings:pushState()	×
35	local material = SILE.call("vbox", {}, content)	×
36	SILE.scratch.insertions.classes.footnote.topBox = material	×
37	SILE.settings:popState()	×
38	end)
39
40	self:registerCommand("footnote:options", function (options, _)	36✔
41	if options["maxHeight"] then	×
42	SILE.scratch.insertions.classes.footnote.maxHeight = SILE.types.length(options["maxHeight"])	×
43	end
44	if options["interInsertionSkip"] then	×
45	SILE.scratch.insertions.classes.footnote.interInsertionSkip = SILE.types.length(options["interInsertionSkip"])	×
46	end
47	end)
48
49	self:registerCommand("footnote", function (options, content)	36✔
50	SILE.call("footnotemark")	6✔
51	local opts = SILE.scratch.insertions.classes.footnote or {}	6✔
52	local frame = opts.insertInto and SILE.getFrame(opts.insertInto.frame)	6✔
53	local oldGetTargetLength = SILE.typesetter.getTargetLength	6✔
54	local oldFrame = SILE.typesetter.frame	6✔
55	SILE.typesetter.getTargetLength = function ()	6✔
56	return SILE.types.length(0xFFFFFF)	8✔
57	end
58	SILE.settings:pushState()	6✔
59	-- Restore the settings to the top of the queue, which should be the document #986
60	SILE.settings:toplevelState()	6✔
61	SILE.typesetter:initFrame(frame)	6✔
62
63	-- Reset settings the document may have but should not be applied to footnotes
64	-- See also same resets in folio package
65	for _, v in ipairs({	36✔
66	"current.hangAfter",
67	"current.hangIndent",
68	"linebreak.hangAfter",
69	"linebreak.hangIndent",
70	}) do	6✔
71	SILE.settings:set(v, SILE.settings.defaults[v])	24✔
72	end
73
74	-- Apply the font before boxing, so relative baselineskip applies #1027
75	local material
76	SILE.call("footnote:font", {}, function ()	12✔
77	material = SILE.call("vbox", {}, function ()	12✔
78	SILE.call("footnote:atstart", options)	6✔
79	SILE.call("footnote:counter", options)	6✔
80	SILE.process(content)	6✔
81	end)
82	end)
83	SILE.settings:popState()	6✔
84	SILE.typesetter.getTargetLength = oldGetTargetLength	6✔
85	SILE.typesetter.frame = oldFrame	6✔
86	self.class:insert("footnote", material)	6✔
87	SILE.scratch.counters.footnote.value = SILE.scratch.counters.footnote.value + 1	6✔
88	end)
89
90	self:registerCommand("footnote:font", function (_, content)	36✔
91	-- The footnote frame has is settings reset to the toplevel state, so if one does
92	-- something relative (as below), it is expected to be the main value from the
93	-- document.
94	SILE.call("font", { size = SILE.settings:get("font.size") * 0.9 }, function ()	18✔
95	SILE.process(content)	6✔
96	end)
97	end)
98
99	self:registerCommand("footnote:atstart", function (_, _) end)	24✔
100
101	self:registerCommand("footnote:counter", function (_, _)	36✔
102	SILE.call("noindent")	6✔
103	SILE.typesetter:typeset(self.class.packages.counters:formatCounter(SILE.scratch.counters.footnote) .. ".")	12✔
104	SILE.call("qquad")	6✔
105	end)
106	end
107
108	package.documentation = [[
109	\begin{document}
110	The \autodoc:package{footnotes} package allows you to add footnotes to text with the \autodoc:command{\footnote} command.
111	Other commands provided by the package, not described here, take care of formatting the footnotes.
112
113	Usually, a document class is responsible for automatically loading this package.
114	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.
115	By default, it uses, respectively, the \code{footnotes} and \code{content} frames, which are assumed to be present in the default standard layout.
116
117	For the record, it internally relies on the \autodoc:package{insertions} package and tells it which frame should receive the footnotes that are typeset.
118	\end{document}
119	]]	18✔
120
121	return package	18✔

sile-typesetter / sile / 9456669609

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous