sile 0.15.8

Simon’s Improved Layout Engine
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

SILE = require("core.sile")
SILE.input.backend = "dummy"
SILE.init()
SILE.utilities.error = error

describe("#counters #package", function ()
   -- We need to instantiate a class first, in order to load a package.
   -- Minimally emulate what SILE does.
   local constructor = require("classes.plain")
   local class = constructor({})
   SILE.documentState.documentClass = class
   -- Then we load the package and can use it as actual code would do.
   class:loadPackage("counters")

   it("should create a simple counter", function ()
      local count = class.packages.counters:formatCounter(class:getCounter("simple"))
      assert.is.equal("0", count)
   end)

   it("should increment a simple counter", function ()
      SILE.call("increment-counter", { id = "simple" })
      local count = class.packages.counters:formatCounter(class:getCounter("simple"))
      assert.is.equal("1", count)
   end)

   it("should increment a simple counter, changing its display", function ()
      SILE.call("increment-counter", { id = "simple", display = "roman" })
      local count = class.packages.counters:formatCounter(class:getCounter("simple"))
      assert.is.equal("ii", count)
   end)

   it("should set a simple counter", function ()
      SILE.call("set-counter", { id = "simple", value = 5 })
      local count = class.packages.counters:formatCounter(class:getCounter("simple"))
      assert.is.equal("v", count)
   end)

   it("should set a simple counter, changing its display", function ()
      SILE.call("set-counter", { id = "simple", display = "alpha" })
      local count = class.packages.counters:formatCounter(class:getCounter("simple"))
      assert.is.equal("e", count)
   end)

   it("should create a multilevel counter", function ()
      local count = class.packages.counters:formatMultilevelCounter(class:getMultilevelCounter("multi"))
      assert.is.equal("0", count)
   end)

   it("should increment a multilevel counter at current level", function ()
      SILE.call("increment-multilevel-counter", { id = "multi" })
      local count = class.packages.counters:formatMultilevelCounter(class:getMultilevelCounter("multi"))
      assert.is.equal("1", count)
   end)

   it("should increment a multilevel counter at level 2", function ()
      SILE.call("increment-multilevel-counter", { id = "multi", level = 2 })
      local count = class.packages.counters:formatMultilevelCounter(class:getMultilevelCounter("multi"))
      assert.is.equal("1.1", count)
   end)

   it("should increment a multilevel counter at level 3", function ()
      SILE.call("increment-multilevel-counter", { id = "multi", level = 3 })
      local count = class.packages.counters:formatMultilevelCounter(class:getMultilevelCounter("multi"))
      assert.is.equal("1.1.1", count)
   end)

   it("should increment a multilevel counter at level 2, clearing sub-levels", function ()
      SILE.call("increment-multilevel-counter", { id = "multi", level = 2 })
      local count = class.packages.counters:formatMultilevelCounter(class:getMultilevelCounter("multi"))
      assert.is.equal("1.2", count)
   end)

   it("should set a multilevel counter", function ()
      SILE.call("set-multilevel-counter", { id = "multi", level = 3, value = 5 })
      local count = class.packages.counters:formatMultilevelCounter(class:getMultilevelCounter("multi"))
      assert.is.equal("1.2.5", count)
   end)

   it("should set a multilevel counter, changing its display", function ()
      SILE.call("set-multilevel-counter", { id = "multi", level = 3, display = "alpha" })
      local count = class.packages.counters:formatMultilevelCounter(class:getMultilevelCounter("multi"))
      assert.is.equal("1.2.e", count)
   end)

   it("should format a counter with or without leading zeros", function ()
      SILE.call("set-multilevel-counter", { id = "multi", level = 1, value = 0 })
      SILE.call("increment-multilevel-counter", { id = "multi", level = 2 })
      local count = class.packages.counters:formatMultilevelCounter(class:getMultilevelCounter("multi"))
      assert.is.equal("0.1", count)
      count =
         class.packages.counters:formatMultilevelCounter(class:getMultilevelCounter("multi"), { noleadingzeros = true })
      assert.is.equal("1", count)
   end)
end)