gardener, Interface administrators, Administrators
1,540
edits
Changes
Jump to navigation
Jump to search
m
Command/setupbackgrounds (view source)
Revision as of 12:47, 19 January 2020
, 12:47, 19 January 2020→Description: another typo
}}
== [[Help:Reference|Syntax]] (autogenerated)] ==
<syntax>setupbackgrounds</syntax>
== [[Help:Reference|Syntax]] ==
</table>
== Description == <code>\{{cmd|setupbackgrounds</code> }} 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 <code>\{{cmd|setupbackgrounds</code> }} 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 <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> should come last.
== Example ==
== See also ==
* [[Layers]]
* {{cmd|setupframed}}, which is the mechanism used by \setupbackgrounds.
