sile 0.15.0

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

local base = require("packages.base")

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

function package:_init ()
   base._init(self)
   self:loadPackage("infonode")
   if not SILE.scratch.chapterverse then
      SILE.scratch.chapterverse = {}
   end
end

function package:registerCommands ()
   self:registerCommand("save-book-title", function (_, content)
      SU.debug("chapterverse", "book:", content[1])
      SILE.scratch.chapterverse.book = content[1]
   end)

   self:registerCommand("save-chapter-number", function (_, content)
      SU.debug("chapterverse", "chapter:", content[1])
      SILE.scratch.chapterverse.chapter = content[1]
   end)

   self:registerCommand("save-verse-number", function (_, content)
      SU.debug("chapterverse", "verse:", content[1])
      SILE.scratch.chapterverse.verse = content[1]
      local ref = {
         book = SILE.scratch.chapterverse.book,
         chapter = SILE.scratch.chapterverse.chapter,
         verse = SILE.scratch.chapterverse.verse,
      }
      SU.debug("chapterverse", "ref:", ref)
      SILE.call("info", { category = "references", value = ref }, {})
   end)

   self:registerCommand("first-reference", function (_, _)
      local refs = SILE.scratch.info.thispage.references
      SU.debug("chapterverse", "first-reference:", SILE.scratch.info)
      if refs then
         SU.debug("chapterverse", "first-reference:", refs[1])
         SILE.call("format-reference", {}, refs[1])
      else
         SU.debug("chapterverse", "first-reference: none")
      end
   end)

   self:registerCommand("last-reference", function (options, _)
      local refs = SILE.scratch.info.thispage.references
      if refs then
         SU.debug("chapterverse", "last-reference:", refs[#refs])
         SILE.call("format-reference", options, refs[#refs])
      else
         SU.debug("chapterverse", "last-reference: none")
      end
   end)

   self:registerCommand("format-reference", function (options, content)
      if type(options.showbook) == "nil" then
         options.showbook = true
      end
      SU.debug("chapterverse", "formatting:", content)
      local ref
      if content.book and options.showbook then
         ref = tostring(content.book) .. " " .. tostring(content.chapter) .. ":" .. tostring(content.verse)
      else
         ref = tostring(content.chapter) .. ":" .. tostring(content.verse)
      end
      SU.debug("chapterverse", "formatting:", ref)
      SILE.typesetter:typeset(ref)
   end)
end

package.documentation = [[
\begin{document}
The \autodoc:package{chapterverse} package is designed as a helper package for book classes which deal with versified content such as scriptures.
It provides commands which will generally be called by the higher-level \autodoc:command[check=false]{\verse} and \autodoc:command[check=false]{\chapter} (or moral equivalent) commands of the classes which handle this kind of content:

\begin{itemize}
\item{\autodoc:command{\save-book-title} takes its argument and squirrels it away as the current book name.}
\item{\autodoc:command{\save-chapter-number} and \autodoc:command{\save-verse-number} does the same but for the chapter and verse reference respectively.}
\item{\autodoc:command{\format-reference} is expected to be called from Lua code with a content table of \code{\{book = ..., chapter = ..., verse = ...\}} and typesets the reference in the form \code{cc:vv}.
      If the parameter \autodoc:parameter{showbook=true} is given then the book name is also output.
      (You can override this command to output your references in a different format.)}
\item{\autodoc:command{\first-reference} and \autodoc:command{\last-reference} typeset (using \autodoc:command{\format-reference}) the first reference on the page and the last reference on the page respectively.
      This is helpful for running headers.}
\end{itemize}
\end{document}
]]

return package