Difference between revisions of "Command/setupbackgrounds"
m (Text replace - "Reference/en/" to "Command/") |
m (→Description: another typo) |
||
(15 intermediate revisions by 5 users not shown) | |||
Line 4: | Line 4: | ||
}} | }} | ||
+ | == [[Help:Reference|Syntax]] (autogenerated) == | ||
+ | <syntax>setupbackgrounds</syntax> | ||
== [[Help:Reference|Syntax]] == | == [[Help:Reference|Syntax]] == | ||
<table cellspacing="4" cellpadding="2" class="cmd"> | <table cellspacing="4" cellpadding="2" class="cmd"> | ||
Line 27: | Line 29: | ||
</table> | </table> | ||
+ | == Description == | ||
+ | {{cmd|setupbackgrounds}} is used to draw frames or backgrounds that cover specific areas of the page, under the text layer. | ||
− | + | The first parameter sets the main layout area; the optional second one specifies the linked subarea(s) of the prior. Not all main areas have such subareas. | |
+ | Because {{cmd|showframe}} and {{cmd|setupbackgrounds}} both draw frameboxes over parts of the page, the order in which they are invoked matters. In most cases, {{cmd|setupbackgrounds}} should come last. | ||
− | = | + | Backgrounds are essential for working with [[Layers]]. You enable your defined layers like <code>\setupbackgrounds[page][background=mylayer]</code>. |
− | The | + | The <tt>background</tt> key also takes a list, and if you include "foreground", you can also set something on top of your general content, e.g. <code>\setupbackgrounds[page][background={mybacklayer,foreground,mytoplayer}]</code>. |
− | + | == Example == | |
+ | |||
+ | <context source=yes> | ||
+ | \setuppapersize[A10] | ||
+ | \showframe | ||
− | + | % \setupbackgrounds should be placed *after* \showframe, | |
− | + | \setupbackgrounds[footer] [background=color, backgroundcolor=blue] | |
− | + | \setupbackgrounds[footer] [leftmargin] [background=color, backgroundcolor=red] | |
− | \setupbackgrounds[ | ||
− | \setupbackgrounds[ | ||
− | |||
− | + | \setupbackgrounds[text] [background=color, backgroundcolor=lightgray] | |
+ | \setupbackgrounds[text] [rightmargin] [background=color, backgroundcolor=yellow] | ||
+ | I paint modern | ||
+ | </context> | ||
== See also == | == See also == | ||
− | + | * [[Layers]] | |
+ | * {{cmd|setupframed}}, which is the mechanism used by \setupbackgrounds. | ||
+ | |||
+ | == Help from ConTeXt-Mailinglist/Forum == | ||
+ | All issues with: | ||
+ | {{Forum|{{SUBPAGENAME}}}} | ||
− | [[Category: | + | [[Category:Command/Backgrounds|setupbackgrounds]] |
Revision as of 12:47, 19 January 2020
\setupbackgrounds
Syntax (autogenerated)
\setupbackgrounds[...,...][...,...][...=...,...] | |
[...,...] | top header text footer bottom |
[...,...] | leftedge leftmargin text rightmargin rightedge |
...=...,... | inherits from \setupframed |
\setupbackgrounds[...,...][...=...,...] | |
[...,...] | paper page leftpage rightpage text hidden |
state | start stop |
...=...,... | inherits from \setupframed |
Syntax
\setupbackgrounds[...][...,...,...][...,...=...,...] | |
[...] | top header text footer bottom page paper leftpage rightpage |
[...,...,...] | leftedge leftmargin text rightmargin rightedge |
state | start stop repeat |
[...,...=...,...] | see \setupframed |
Description
\setupbackgrounds is used to draw frames or backgrounds that cover specific areas of the page, under the text layer.
The first parameter sets the main layout area; the optional second one specifies the linked subarea(s) of the prior. Not all main areas have such subareas.
Because \showframe and \setupbackgrounds both draw frameboxes over parts of the page, the order in which they are invoked matters. In most cases, \setupbackgrounds should come last.
Backgrounds are essential for working with Layers. You enable your defined layers like \setupbackgrounds[page][background=mylayer]
.
The background key also takes a list, and if you include "foreground", you can also set something on top of your general content, e.g. \setupbackgrounds[page][background={mybacklayer,foreground,mytoplayer}]
.
Example
\setuppapersize[A10] \showframe % \setupbackgrounds should be placed *after* \showframe, \setupbackgrounds[footer] [background=color, backgroundcolor=blue] \setupbackgrounds[footer] [leftmargin] [background=color, backgroundcolor=red] \setupbackgrounds[text] [background=color, backgroundcolor=lightgray] \setupbackgrounds[text] [rightmargin] [background=color, backgroundcolor=yellow] I paint modern
See also
- Layers
- \setupframed, which is the mechanism used by \setupbackgrounds.
Help from ConTeXt-Mailinglist/Forum
All issues with: