Changes

Jump to navigation Jump to search
10,366 bytes added ,  12:38, 11 April 2010
Create reference page
<!-- please remove this and the following line if you have checked this page -->
{{Reference_Cleanup}}
{{Reference
|name=setuplayout
|attributes=
}}

== [[Help:Reference|Syntax]] ==
<table cellspacing="4" cellpadding="2" class="cmd">
<tr>
<td colspan="2" class="cmd">\setuplayout<span class="first" >[...,...=...,...]</span></td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[[Reference/en/keyword:width|width]]</td>
<td>[[Reference/en/value:dimension|dimension]] [[Reference/en/value:fit|fit]] [[Reference/en/value:middle|middle]] </td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[[Reference/en/keyword:height|height]]</td>
<td>[[Reference/en/value:dimension|dimension]] [[Reference/en/value:fit|fit]] [[Reference/en/value:middle|middle]] </td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[[Reference/en/keyword:backspace|backspace]]</td>
<td>[[Reference/en/value:dimension|dimension]] </td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[[Reference/en/keyword:topspace|topspace]]</td>
<td>[[Reference/en/value:dimension|dimension]] </td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[[Reference/en/keyword:margin|margin]]</td>
<td>[[Reference/en/value:dimension|dimension]] </td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[[Reference/en/keyword:leftmargin|leftmargin]]</td>
<td>[[Reference/en/value:dimension|dimension]] </td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[[Reference/en/keyword:rightmargin|rightmargin]]</td>
<td>[[Reference/en/value:dimension|dimension]] </td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[[Reference/en/keyword:header|header]]</td>
<td>[[Reference/en/value:dimension|dimension]] </td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[[Reference/en/keyword:footer|footer]]</td>
<td>[[Reference/en/value:dimension|dimension]] </td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[[Reference/en/keyword:top|top]]</td>
<td>[[Reference/en/value:dimension|dimension]] </td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[[Reference/en/keyword:bottom|bottom]]</td>
<td>[[Reference/en/value:dimension|dimension]] </td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[[Reference/en/keyword:leftedge|leftedge]]</td>
<td>[[Reference/en/value:dimension|dimension]] </td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[[Reference/en/keyword:rightedge|rightedge]]</td>
<td>[[Reference/en/value:dimension|dimension]] </td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[[Reference/en/keyword:headerdistance|headerdistance]]</td>
<td>[[Reference/en/value:dimension|dimension]] </td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[[Reference/en/keyword:footerdistance|footerdistance]]</td>
<td>[[Reference/en/value:dimension|dimension]] </td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[[Reference/en/keyword:topdistance|topdistance]]</td>
<td>[[Reference/en/value:dimension|dimension]] </td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[[Reference/en/keyword:bottomdistance|bottomdistance]]</td>
<td>[[Reference/en/value:dimension|dimension]] </td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[[Reference/en/keyword:leftmargindistance|leftmargindistance]]</td>
<td>[[Reference/en/value:dimension|dimension]] </td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[[Reference/en/keyword:rightmargindistance|rightmargindistance]]</td>
<td>[[Reference/en/value:dimension|dimension]] </td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[[Reference/en/keyword:leftedgedistance|leftedgedistance]]</td>
<td>[[Reference/en/value:dimension|dimension]] </td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[[Reference/en/keyword:rightedgedistance|rightedgedistance]]</td>
<td>[[Reference/en/value:dimension|dimension]] </td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[[Reference/en/keyword:horoffset|horoffset]]</td>
<td>[[Reference/en/value:dimension|dimension]] </td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[[Reference/en/keyword:veroffset|veroffset]]</td>
<td>[[Reference/en/value:dimension|dimension]] </td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[[Reference/en/keyword:style|style]]</td>
<td>[[Reference/en/value:normal|normal]] [[Reference/en/value:bold|bold]] [[Reference/en/value:slanted|slanted]] [[Reference/en/value:boldslanted|boldslanted]] [[Reference/en/value:type|type]] [[Reference/en/value:cap|cap]] [[Reference/en/value:small...|small...]] [[Reference/en/value:command|command]] </td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[[Reference/en/keyword:color|color]]</td>
<td>[[Reference/en/value:name|name]] </td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[[Reference/en/keyword:marking|marking]]</td>
<td>[[Reference/en/value:on|on]] [[Reference/en/value:off|off]] [[Reference/en/value:color|color]] [[Reference/en/value:screen|screen]] [[Reference/en/value:text|text]] </td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[[Reference/en/keyword:location|location]]</td>
<td>[[Reference/en/value:left|left]] [[Reference/en/value:middle|middle]] [[Reference/en/value:right|right]] [[Reference/en/value:bottom|bottom]] [[Reference/en/value:top|top]] [[Reference/en/value:singlesided|singlesided]] [[Reference/en/value:doublesided|doublesided]] </td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[[Reference/en/keyword:scale|scale]]</td>
<td>[[Reference/en/value:dimension|dimension]] </td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[[Reference/en/keyword:nx|nx]]</td>
<td>[[Reference/en/value:number|number]] </td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[[Reference/en/keyword:ny|ny]]</td>
<td>[[Reference/en/value:number|number]] </td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[[Reference/en/keyword:dx|dx]]</td>
<td>[[Reference/en/value:dimension|dimension]] </td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[[Reference/en/keyword:dy|dy]]</td>
<td>[[Reference/en/value:dimension|dimension]] </td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[[Reference/en/keyword:lines|lines]]</td>
<td>[[Reference/en/value:number|number]] </td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[[Reference/en/keyword:columns|columns]]</td>
<td>[[Reference/en/value:number|number]] </td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[[Reference/en/keyword:columndistance|columndistance]]</td>
<td>[[Reference/en/value:dimension|dimension]] </td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[[Reference/en/keyword:grid|grid]]</td>
<td>[[Reference/en/value:yes|yes]] [[Reference/en/value:no|no]] </td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[[Reference/en/keyword:bottomspace|bottomspace]]</td>
<td>[[Reference/en/value:dimension|dimension]] </td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[[Reference/en/keyword:cutspace|cutspace]]</td>
<td>[[Reference/en/value:dimension|dimension]] </td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[[Reference/en/keyword:textdistance|textdistance]]</td>
<td>[[Reference/en/value:dimension|dimension]] </td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[[Reference/en/keyword:textwidth|textwidth]]</td>
<td>[[Reference/en/value:number|number]] </td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[[Reference/en/keyword:textmargin|textmargin]]</td>
<td>[[Reference/en/value:dimension|dimension]] </td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[[Reference/en/keyword:clipoffset|clipoffset]]</td>
<td>[[Reference/en/value:dimension|dimension]] </td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[[Reference/en/keyword:page|page]]</td>
<td>[[Reference/en/value:name|name]] </td>
</tr>
<tr valign="top" class="first">
<td class="cmd">[[Reference/en/keyword:paper|paper]]</td>
<td>[[Reference/en/value:name|name]] </td>
</tr>
</table>


== Description ==
<pre>
Horizontal: (if singleside then outside is at right and inside is at left)
===========
width => width of text area
middle: automatic calculation consider A) params
fit: automatic calculation consider A)+B) params
dimension: cutspace should be 0 and is calculated according to backspace

A) params: (\paperwidth=\backspace+\makeupwidth+\cutspace)
backspace => width of inner margin
cutspace => width of outer margin (if 0 then = backspace!)

B) params:
leftmargin/rightmargin => width of leftmargin/rightmargin area
margin => width of outer margin
leftedge/rightedge => width of leftedge/rightedge area
*distance (like leftmargindistance) => space separates * area from the inner

horoffset => shift material towards outside (not tought width calculation)

Vertical:
=========

Others:
=======

</pre>
== comment ==
<pre>
See [[wiki:Layout]]

--------
What is needed is a picture of a page with each of these layout parameters indicated.
</pre>

You can use the \showframe macro to see the results of your layout. Just put the command before the \starttext and lines will be drawn on your document showing the different areas.




== Example ==

<code source="tex">
%% This is an example for showing the effect of the vertical parameters
%% top, topdistance, bottom, bottomdistance and topspace.
%% Just play around with these parameters.

%% Show the top and the bottom with blue color:
\setupcolors[state=start]
\setupbackgrounds[top,bottom][background=color,backgroundcolor=blue]

\def\MyLength{50pt}

\setuplayout[
header=0pt,footer=0pt,headerdistance=0pt,footerdistance=0pt,
top=\MyLength,topdistance=\MyLength,
bottom=\MyLength,bottomdistance=\MyLength,
topspace=\dimexpr(\topheight + \topdistance),
height=fit]

\starttext
\dorecurse{7}{\input tufte}
\showsetups
\stoptext

</code>


== See also ==
<!-- something like [[cmd:goto|\goto]] -->

[[Category:Reference/en|setuplayout]]
Anonymous user

Navigation menu