Command/setupbackgrounds

\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.
• about the third parameter
  • the key state determines when the page background is recalculated.
    • state=repeat ensures that the page background is always recalculated (useful if you want to use a variable that depends on the current page, such as its number with \realpageno).
    • state=start recalculates the page background, and stops its automatic recalculation,
    • state=stop doesn't recalculate the page background, and stops its automatic recalculation.

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:

• setupbackgrounds on the mailing list (all results)
• setupbackgrounds on the mailing list (subject only)
• setupbackgrounds on stack exchange
• setupbackgrounds in ConTeXt's source