7207579583

Committed 14 Dec 2023 10:27AM UTC coverage: 68.747% (-5.9%) from 74.636%

Build # 7207579583

Build Type

push

github

Committed by

web-flow

Commit Message

Merge 16f939414 into 44b7f10ee

Run Details

10827 of 15749 relevant lines covered (68.75%)

3733.12 hits per line

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

0.0

/packages/background/init.lua

local base = require("packages.base")

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

local outputBackground = function (color)
  local page = SILE.getFrame("page")
  local backgroundColor = SILE.color(color)
  SILE.outputter:pushColor(backgroundColor)
  SILE.outputter:drawRule(page:left(), page:top(), page:right(), page:bottom())
  SILE.outputter:popColor()
end

function package:_init ()
  base._init(self)
  self:loadPackage("color")
end

function package:registerCommands ()

  self:registerCommand("background", function (options, _)
    options.color = options.color or "white"
    options.allpages = options.allpages or true
    outputBackground(options.color)
    if options.allpages and options.allpages ~= "false" then
      local oldNewPage = SILE.documentState.documentClass.newPage
      SILE.documentState.documentClass.newPage = function (self_)
        local page = oldNewPage(self_)
        outputBackground(options.color)
        return page
      end
    end
  end, "Draws a solid background color <color> on pages after initialization.")

end

package.documentation = [[
\begin{document}
\use[module=packages.background]
The \autodoc:package{background} package allows you to set the color of the canvas background (by drawing a solid color block the full size of the page on page initialization).
The package provides a \autodoc:command{\background} command which requires at least one parameter, \autodoc:parameter{color=<color specification>}, and sets the background of the current and all following pages to that color.
If you want to set only the current page background different from the default, use the parameter \autodoc:parameter{allpages=false}.
The color specification in the same as specified in the \autodoc:package{color} package.

\background[color=#e9d8ba,allpages=false]

So, for example, \autodoc:command{\background[color=#e9d8ba,allpages=false]} will set a sepia tone background on the current page.
\end{document}
]]

return package

1	local base = require("packages.base")	×
2
3	local package = pl.class(base)	×
4	package._name = "background"	×
5
6	local outputBackground = function (color)
7	local page = SILE.getFrame("page")	×
8	local backgroundColor = SILE.color(color)	×
9	SILE.outputter:pushColor(backgroundColor)	×
10	SILE.outputter:drawRule(page:left(), page:top(), page:right(), page:bottom())	×
11	SILE.outputter:popColor()	×
12	end
13
14	function package:_init ()	×
15	base._init(self)	×
16	self:loadPackage("color")	×
17	end
18
19	function package:registerCommands ()	×
20
21	self:registerCommand("background", function (options, _)	×
22	options.color = options.color or "white"	×
23	options.allpages = options.allpages or true	×
24	outputBackground(options.color)	×
25	if options.allpages and options.allpages ~= "false" then	×
26	local oldNewPage = SILE.documentState.documentClass.newPage	×
27	SILE.documentState.documentClass.newPage = function (self_)	×
28	local page = oldNewPage(self_)	×
29	outputBackground(options.color)	×
30	return page	×
31	end
32	end
33	end, "Draws a solid background color <color> on pages after initialization.")	×
34
35	end
36
37	package.documentation = [[
38	\begin{document}
39	\use[module=packages.background]
40	The \autodoc:package{background} package allows you to set the color of the canvas background (by drawing a solid color block the full size of the page on page initialization).
41	The package provides a \autodoc:command{\background} command which requires at least one parameter, \autodoc:parameter{color=<color specification>}, and sets the background of the current and all following pages to that color.
42	If you want to set only the current page background different from the default, use the parameter \autodoc:parameter{allpages=false}.
43	The color specification in the same as specified in the \autodoc:package{color} package.
44
45	\background[color=#e9d8ba,allpages=false]
46
47	So, for example, \autodoc:command{\background[color=#e9d8ba,allpages=false]} will set a sepia tone background on the current page.
48	\end{document}
49	]]	×
50
51	return package	×

sile-typesetter / sile / 7207579583

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