Difference between revisions of "Command/setupbackgrounds"
< Command
Jump to navigation
Jump to search
m (→Description: another typo) |
m (→Description) |
||
| Line 32: | Line 32: | ||
{{cmd|setupbackgrounds}} is used to draw frames or backgrounds that cover specific areas of the page, under the text layer. | {{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. | + | * 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. | ||
| + | * the third parameter drive when the page background is recalculated. <tt>state=repeat</tt> makes sure that the page background is always recalculated (usefull if you want to use a variable depending on the current page like its number {{cmd|realpageno}}). <tt>state=stop</tt> and <tt>state=start</tt> allows to stop and start recalculations. | ||
| + | |||
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. | 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. | ||
Revision as of 08:31, 27 April 2024
\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.
- the third parameter drive when the page background is recalculated. state=repeat makes sure that the page background is always recalculated (usefull if you want to use a variable depending on the current page like its number \realpageno). state=stop and state=start allows to stop and start recalculations.
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:
