Difference between revisions of "Command/setupbackgrounds"

From ConTeXt wiki
Jump to navigationJump to search
(add links and hints about Layers)
Line 29: Line 29:
 
</table>
 
</table>
  
== Description ==  
+
== Description ==
<code>\setupbackgrounds</code> 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.
  
Because {{cmd|showframe}} and <code>\setupbackgrounds</code> both draw frameboxes over parts of the page, the order in which they are invoked matters. In most cases, <code>\setupbackgrounds</code> 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.
 +
 
 +
Backgrounds are essential for working with [[Layers]]. You enable your defined layers like <code>\setupbackgrounds[page][backgrounds=mylayer]</code>.
 +
 
 +
The <tt>backgrounds</tt> key also takes a list, and if you include "foregrounds", you can also set something on top of your general content, e.g. <code>\setupbackgrounds[page][backgrounds={mybacklayer,foreground,mytoplayer}]</code>.
  
 
== Example ==
 
== Example ==
Line 54: Line 58:
  
 
== See also ==
 
== See also ==
 +
* [[Layers]]
 
* {{cmd|setupframed}}, which is the mechanism used by \setupbackgrounds.
 
* {{cmd|setupframed}}, which is the mechanism used by \setupbackgrounds.
  

Revision as of 12:46, 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
statestart 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][backgrounds=mylayer].

The backgrounds key also takes a list, and if you include "foregrounds", you can also set something on top of your general content, e.g. \setupbackgrounds[page][backgrounds={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

Help from ConTeXt-Mailinglist/Forum

All issues with: