The geometry package
Hideo Umeki
https://github.com/davidcarlisle/geometry 2020/01/02 v5.9
Abstract
This package provides a flexible and easy interface to page dimensions. You can change the page layout with intuitive parameters. For instance, if you want to set a margin to 2cm from each edge of the paper, you can type just\usepackage[margin=2cm]{geometry}. The page layout can be changed in the middle of the document with\newgeometrycommand.
1 Preface to version 5
• Changing page layout mid-document.
The new commands\newgeometry{· · ·}and\restoregeometryallow users to change page dimen- sions in the middle of the document. \newgeometry is almost similar to \geometryexcept that
\newgeometry disables all the options specified in the preamble and skips the papersize-related options: landscape,portraitand paper size options (such aspapersize,paper=a4paperand so forth).
• A new set of options to specify the layout area.
The options specified for the area, in which the page dimensions are calculated, are added: layout, layoutsize, layoutwidth, layoutheightand so forth. These options would help to print the specified layout to a different sized paper. For example, witha4paperand layout=a5paper, thegeometry package uses ‘A5’ layout to calculate margins with the paper size still ‘A4’.
• A new driver optionxetex.
The new driver optionxetex is added. The driver auto-detection routine has been revised so as to avoid an error with undefined control sequences. Note that ‘geometry.cfg’ in TEX Live, which disables the auto-detection routine and setspdftex, is no longer necessary and has no problem even though it still exists. To setxetexis strongly recommended with X E LATEX.
• New paper size presets for JIS B-series and ISO C-series.
The papersize presetsb0jto b6jfor JIS (Japanese Industrial Standards) B-series andc0paperto c6paperfor ISO C-series (v5.4∼) are added.
• Changing default for underspecified margin.
In the previous version, if only one margin was specified,bottom=1cm for example, thengeometry set the other margin with the margin ratio (1:1 by default for the vertical dimensions) and got top=1cm in this case. The version 5 sets the text-body size with the default scale (= 0.7) and determine the unspecified margin. (See Section6.5)
• The optionshowframe and showcropworks on every page.
With showframe option, the page frames are shown on every page. In addition, a new option showcropprints crop marks at each corner of layout area on every page. Note that the marks would be invisible without specifying the layout size smaller than paper size. Version 5.4 introduced a new\shipoutoverloading process usingatbegshipackage, so theatbegshipackage is required when showframe or showcrop option is specified.
• Loading geometry.cfg precedes processing class options.
The previous version loaded geometry.cfg after processing the document class options. Now that the config file is loaded before processing the class options, you can change the behavior specified ingeometry.cfgby adding options into \documentclassas well as\usepackageand\geometry.
• Deleted options: compat2 and twosideshift. The version 5 has no longer compatibility with the previous ones. compat2andtwosideshiftare gone for simplicity.
2 Introduction
To set dimensions for page layout in LATEX is not straightforward. You need to adjust several LATEX native dimensions to place a text area where you want. If you want to center the text area in the paper you use, for example, you have to specify native dimensions as follows:
\usepackage{calc}
\setlength\textwidth{7in}
\setlength\textheight{10in}
\setlength\oddsidemargin{(\paperwidth-\textwidth)/2 - 1in}
\setlength\topmargin{(\paperheight-\textheight
-\headheight-\headsep-\footskip)/2 - 1in}.
Without packagecalc, the above example would need more tedious settings. Package geometry provides an easy way to set page layout parameters. In this case, what you have to do is just
\usepackage[text={7in,10in},centering]{geometry}.
Besides centering problem, setting margins from each edge of the paper is also troublesome. Butgeometry also make it easy. If you want to set each margin to 1.5in, you can type
\usepackage[margin=1.5in]{geometry}
Thus, the geometry package has an auto-completion mechanism, in which unspecified dimensions are automatically determined. The geometry package will be also useful when you have to set page layout obeying the following strict instructions: for example,
The total allowable width of the text area is 6.5 inches wide by 8.75 inches high. The top margin on each page should be 1.2 inches from the top edge of the page. The left margin should be0.9inch from the left edge. The footer with page number should be at the bottom of the text area.
In this case, usinggeometry you can type
\usepackage[total={6.5in,8.75in},
top=1.2in, left=0.9in, includefoot]{geometry}.
Setting a text area on the paper in document preparation system has some analogy to placing a window on the background in the window system. The name ‘geometry’ comes from the -geometry option used for specifying a size and location of a window in X Window System.
3 Page geometry
Figure1 shows the page layout dimensions defined in thegeometrypackage. The page layout contains a total body (printable area) and margins. The total body consists of abody(text area) with an optional header, footerand marginal notes (marginpar). There are four margins: left, right,topandbottom. For twosided documents, horizontal margins should be called innerandouter.
paper : total bodyandmargins
total body : body(text area) (optionalhead,foot andmarginpar) margins : left(inner),right(outer),topandbottom
Each margin is measured from the corresponding edge of a paper. For example, left margin (inner margin) means a horizontal distance between the left (inner) edge of the paper and that of the total body. Therefore the left and top margins defined in geometry are different from the native dimensions
\leftmargin and \topmargin. The size of a body (text area) can be modified by \textwidth and
\textheight. The dimensions for paper, total body and margins have the following relations.
paperwidth = left+width+right (1)
paperheight = top+height+bottom (2)
paper
total body
height
width
paperwidth paperheight
top
bottom left
(inner)
right (outer)
?
? 6
6 -
-
textheight
? 6
head
headheight headsep
footskip HH
body
-
?
?
textwidth foot
marginal note
-
marginparsep
marginparwidth
Figure 1: Dimension names used in thegeometrypackage. width=textwidthandheight= textheightby default. left,right,topandbottomare margins. If margins on verso pages are swapped bytwoside option, margins specified byleftandrightoptions are used for the inside and outside margins respectively. innerandouterare aliases ofleft andrightrespectively.
(a)default
paper
6 textheight
? head
body
foot
?
? 6
6 top
bottom
(b)includeheadandincludefoot paper
6 textheight
? head
body
total body
foot
?
? 6
6 top
bottom
Figure 2: includeheadandincludefootinclude the head and foot respectively intototal body. (a) height=textheight(default). (b)height=textheight+headheight+headsep+ footskipifincludeheadandincludefoot. If the top and bottom margins are specified, includeheadandincludefootresult in shortertextheight.
The total bodywidthandheightwould be defined:
width := textwidth (+marginparsep+marginparwidth) (3) height := textheight (+headheight+headsep+footskip) (4) In Equation (3)width:=textwidthby default, whilemarginparsepandmarginparwidthare included in widthifincludempoption is settrue. In Equation (4),height:=textheightby default. Ifincludehead is set totrue,headheightandheadsepare considered as a part ofheight. In the same way,includefoot takes footskipinto height. Figure2shows how these options work in the vertical direction.
Thus, the page layout consists of three parts (lengths) in each direction: one body and two margins. If the two of them are explicitly specified, the other length is obvious and no need to be specified. Figure3 shows a simple model of page dimensions. When a length Lis given and is partitioned into the bodyb, the margins aand c, it’s obvious that
L=a+b+c (5)
The specification with two of the three (a,b and c) fixed explicitly is solvable. If two or more are left unspecified or ‘underspecified’, Equation (5) cannot be solved without any other relation between them.
If all of them are specified, then it needs to check whether or not they satisfy Equation (5), that is too much specification or ‘overspecified’.
a b c
L
-
Figure 3: A simple model of page dimensions.
Thegeometry package has auto-completion mechanism that saves the trouble of specifying the page layout dimensions. For example, you can set
\usepackage[width=14cm, left=3cm]{geometry}
on A4 paper. In this case you don’t have to set the right margin The details of auto-completion will be described in Section6.5.
4 User interface
4.1 Commands
Thegeometry package provides the following commands:
• \geometry{hoptionsi}
• \newgeometry{hoptionsi}and\restoregeometry
• \savegeometry{hnamei}and\loadgeometry{hnamei}
\geometry{hoptionsi} changes the page layout according to the options specified in the argument.
This command, if any, should be placed only in the preamble (before \begin{document}).
Thegeometry package may be used as part of a class or another package you use in your document.
The command\geometrycan overwrite some of the settings in the preamble. Multiple use of\geometry is allowed and then processed with the options concatenated. If geometry is not yet loaded, you can use only\usepackage[hoptionsi]{geometry}instead of \geometry.
\newgeometry{hoptionsi}changes the page layout mid-document. \newgeometryis almost similar to
\geometryexcept that\newgeometrydisables all the options specified by \usepackageand\geometry in the preamble and skips papersize-related options. \restoregeometryrestores the page layout specified in the preamble. This command has no arguments. See Section 7for details.
\savegeometry{hnamei} saves the page dimensions as hnamei where you put this command.
\loadgeometry{hnamei}loads the page dimensions saved ashnamei. See Section7for details.
4.2 Optional argument
Thegeometrypackage adoptskeyvalinterface ‘hkeyi=hvaluei’ for the optional argument to\usepackage,
\geometryand\newgeometry.
The argument includes a list of comma-separatedkeyvaloptions and has basic rules as follows:
• Multiple lines are allowed, while blank lines are not.
• Any spaces between words are ignored.
• Options are basically order-independent. (There are some exceptions. See Section6.2for details.) For example,
\usepackage[ a5paper , hmargin = { 3cm, .8in } , height
= 10in ]{geometry}
is equivalent to
\usepackage[height=10in,a5paper,hmargin={3cm,0.8in}]{geometry}
Some options are allowed to have sub-list, e.g. {3cm,0.8in}. Note that the order of values in the sub-list is significant. The above setting is also equivalent to the followings:
\usepackage{geometry}
\geometry{height=10in,a5paper,hmargin={3cm,0.8in}}
or
\usepackage[a5paper]{geometry}
\geometry{hmargin={3cm,0.8in},height=8in}
\geometry{height=10in}.
Thus, multiple use of \geometryjust appends options.
geometrysupports packagecalc1. For example,
\usepackage{calc}
\usepackage[textheight=20\baselineskip+10pt]{geometry}
4.3 Option types
geometry options are categorized into four types:
1. Boolean type
takes a boolean value (true orfalse). If no value,true is set by default.
hkeyi=true false.
hkeyiwith no value is equivalent tohkeyi=true.
Examples: verbose=true,includehead,twoside=false.
Paper name is the exception. The preferred paper name should be set with no values. Whatever value is given, it is ignored. For instance,a4paper=XXXis equivalent toa4paper.
2. Single-valued type takes a mandatory value.
hkeyi=hvaluei.
Examples: width=7in,left=1.25in,footskip=1cm, height=.86\paperheight.
3. Double-valued type
takes a pair of comma-separated values in braces. The two values can be shortened to one value if they are identical.
hkeyi={hvalue1i,hvalue2i}.
hkeyi=hvalueiis equivalent to hkeyi={hvaluei,hvaluei}.
Examples: hmargin={1.5in,1in},scale=0.8,body={7in,10in}.
4. Triple-valued type
takes three mandatory, comma-separated values in braces.
hkeyi={hvalue1i,hvalue2i,hvalue3i}
Each value must be a dimension or null. When you give an empty value or ‘*’, it means null and leaves the appropriate value to the auto-completion mechanism. You need to specify at least one dimension, typically two dimensions. You can set nulls for all the values, but it makes no sense.
Examples:
hdivide={2cm,*,1cm},vdivide={3cm,19cm, },divide={1in,*,1in}.
5 Option details
This section describes all options available in geometry. Options with a dagger † are not available as arguments of \newgeometry(See Section7).
1CTAN:macros/latex/required/tools
5.1 Paper size
The options below set paper/media size and orientation.
†paper papername
specifies the paper size by name. paper=hpaper-namei. For convenience, you can specify the paper name withoutpaper=. For example,a4paperis equivalent topaper=a4paper.
†a0paper, a1paper, a2paper, a3paper, a4paper, a5paper, a6paper, b0paper, b1paper, b2paper, b3paper, b4paper, b5paper, b6paper, c0paper, c1paper, c2paper, c3paper, c4paper, c5paper, c6paper, b0j, b1j, b2j, b3j, b4j, b5j, b6j,
ansiapaper, ansibpaper, ansicpaper, ansidpaper, ansiepaper, letterpaper, executivepaper, legalpaper
specifies paper name. The value part is ignored even if any. For example, the followings have the same effect: a5paper,a5paper=true,a5paper=falseand so forth.
a[0-6]paper,b[0-6]paper andc[0-6]paperare ISO A, B and C series of paper sizes respectively. The JIS (Japanese Industrial Standards) A-series is identical to the ISO A-series, but the JIS B-series is different from the ISO B-series. b[0-6]jshould be used for the JIS B-series.
†screen a special paper size with (W,H) = (225mm,180mm). For presentation with PC and video projector, “screen,centering” with ‘slide’ documentclass would be useful.
†paperwidth width of the paper. paperwidth=hlengthi.
†paperheight height of the paper. paperheight=hlengthi.
†papersize width and height of the paper. papersize={hwidthi,hheighti}or papersize=hlengthi.
†landscape switches the paper orientation to landscape mode.
†portrait switches the paper orientation to portrait mode. This is equivalent tolandscape=false.
The options for paper names (e.g.,a4paper) and orientation (portraitand landscape) can be set as document class options. For example, you can set\documentclass[a4paper,landscape]{article}, then a4paperand landscapeare processed in geometry as well. This is also the case for twoside and twocolumn(see also Section5.5).
5.2 Layout size
You can specify the layout area with options described in this section regardless of the paper size. The options would help to print the specified layout to a different sized paper. For example, with a4paper and layout=a5paper, the package uses ‘A5’ layout to calculate margins on ’A4’ paper. The layout size defaults to the same as the paper. The options for the layout size are available in\newgeometry, so that you can change the layout size in the middle of the document. The paper size itself can’t be changed though. Figure4shows what the difference betweenlayoutandpaperis.
layout specifies the layout size by paper name. layout=hpaper-namei. All the paper names defined ingeometry are available. See Section5.1for details.
layoutwidth width of the layout. layoutwidth=hlengthi.
layoutheight height of the layout. layoutheight=hlengthi.
layoutsize width and height of the layout. layoutsize={hwidthi,hheighti}or layoutsize=hlengthi.
layouthoffset specifies the horizontal offset from the left edge of the paper. layouthoffset=hlengthi.
layoutvoffset specifies the vertical offset from the top edge of the paper. layoutvoffset=hlengthi.
layoutoffset specifies both horizontal and vertical offsets. layoutoffset={hhoffseti,hvoffseti}or layoutsize=hlengthi.
5.3 Body size
The options specifying the size of total bodyare described in this section.
hscale ratio of width of total bodyto\paperwidth. hscale=hh-scalei, e.g.,hscale=0.8is equivalent towidth=0.8\paperwidth. (0.7by default)
paper layout foot
body head layoutwidth
-
6
layoutheight
?
paper layout foot
body head layouthoffset
- AA
layoutvoffset
? 6
Figure 4: The dimensions related to the layout size. Note that the layout size defaults to the same size as the paper, so you don’t have to specify layout-related options explicitly in most cases.
vscale ratio of height of total bodyto\paperheight, e.g.,vscale=hv-scalei. (0.7by default) vscale=0.9is equivalent to height=0.9\paperheight.
scale ratio of total bodyto the paper. scale={hh-scalei,hv-scalei}orscale=hscalei. (0.7by default)
width totalwidth
width of total body. width=hlengthior totalwidth=hlengthi. This dimension defaults to textwidth, but ifincludempis set totrue,width≥textwidthbecausewidthincludes the width of the marginal notes. Iftextwidthandwidthare specified at the same time, textwidthtakes priority overwidth.
height totalheight
height of total body, excluding header and footer by default. Ifincludeheador
includefootis set,heightincludes the head or foot of the page as well astextheight.
height=hlengthiortotalheight=hlengthi. If bothtextheightandheight are specified,heightwill be ignored.
total width and height of total body.
total={hwidthi,hheighti}ortotal=hlengthi.
textwidth specifies\textwidth, the width of body(the text area). textwidth=hlengthi.
textheight specifies\textheight, the height of body(the text area). textheight=hlengthi.
text body specifies both\textwidth and\textheightof the body of page.
body={hwidthi,hheighti}ortext=hlengthi.
lines enables users to specify\textheightby the number of lines. lines=hintegeri.
includehead includes the head of the page,\headheight and\headsep, intototal body. It is set to falseby default. It is opposite toignorehead. See Figure2and Figure5.
includefoot includes the foot of the page,\footskip, into total body. It is opposite toignorefoot.
It isfalseby default. See Figure2and Figure 5.
includeheadfoot
sets bothincludehead andincludefoottotrue, which is opposite to ignoreheadfoot. See Figure2 and Figure5.
includemp includes the margin notes,\marginparwidthand\marginparsep, intobodywhen calculating horizontal calculation.
includeall sets bothincludeheadfootandincludemptotrue. See Figure5.
ignorehead disregards the head of the page,headheightandheadsep, in determining vertical layout, but does not change those lengths. It is equivalent toincludehead=false. It is set totrueby default. See alsoincludehead.
ignorefoot disregards the foot of page,footskip, in determining vertical layout, but does not change that length. This option defaults totrue. See alsoincludefoot.
ignoreheadfoot
sets bothignorehead andignorefootto true. See alsoincludeheadfoot.
(a)includeheadfoot total body
textwidth
headheight headsep
textheight
footskip head
body
foot
(b)includeall total body head
body marginal
note
foot textwidth
marginparwidth marginparsep (c) includefoot
total body
textheight
footskip body
foot textwidth
(d)includefoot,includemp total body
body marginal
note
foot textwidth
marginparwidth marginparsep
Figure 5: Sample layouts for total body with different switches. (a) includeheadfoot, (b) includeall, (c) includefoot and (d) includefoot,includemp. If reversemp is set to true, the location of the marginal notes are swapped on every page. Option twoside swaps both margins and marginal notes on verso pages. Note that the marginal note, if any, is printed despiteignoremporincludemp=falseand overrun the page in some cases.
ignoremp disregards the marginal notes in determining the horizontal margins (defaults totrue).
If marginal notes overrun the page, the warning message will be displayed when verbose=true. See alsoincludempand Figure5.
ignoreall sets bothignoreheadfootandignoremptotrue. See alsoincludeall.
heightrounded
This option rounds\textheightton-times (n: an integer) of \baselineskipplus
\topskipto avoid “underfull vbox” in some cases. For example, if \textheightis 486pt with\baselineskip12pt and \topskip10pt, then
(39×12pt + 10pt =) 478pt<486pt<490pt (= 40×12pt + 10pt),
as a result\textheight is rounded to 490pt. heightrounded=falseby default.
Figure5 illustrates various layouts with different layout modes. The dimensions for a header and a footer can be controlled bynoheadornofootmode, which sets each length to 0pt directly. On the other hand, options with the prefixignoredonot change the corresponding native dimensions.
The following options can specify body and margins simultaneously with three comma-separated values in braces.
hdivide horizontal partitions (left,width,right). hdivide={hleft margini,hwidthi,hright
margini}. Note that you should not specify all of the three parameters. The best way of using this option is to specify two of three and leave the rest with null(nothing) or ‘*’.
For example, when you sethdivide={2cm,15cm, }, the margin from the right-side edge of page will be determined calculatingpaperwidth-2cm-15cm.
vdivide vertical partitions (top,height,bottom). vdivide={htop margini,hheighti,hbottom margini}.
divide divide={A,B,C}is interpreted ashdivide={A,B,C}andvdivide={A,B,C}.
5.4 Margin size
The options specifying the size of the margins are listed below.
left lmargin inner
left margin (for oneside) or inner margin (for twoside) of total body. In other words, the distance between the left (inner) edge of the paper and that of total body.
left=hlengthi. innerhas no special meaning, just an alias of leftandlmargin.
right rmargin outer
right or outer margin of total body. right=hlengthi.
top tmargin top margin of the page. top=hlengthi. Note this option has nothing to do with the native dimension\topmargin.
bottom bmargin
bottom margin of the page. bottom=hlengthi.
hmargin left and right margin. hmargin={hleft margini,hright margini}or hmargin=hlengthi.
vmargin top and bottom margin. vmargin={htop margini,hbottom margini}or vmargin=hlengthi.
margin margin={A,B}is equivalent tohmargin={A,B}and vmargin={A,B}. margin=Ais automatically expanded tohmargin=Aandvmargin=A.
hmarginratio horizontal margin ratio ofleft(inner) toright(outer). The value ofhratioishould be specified with colon-separated two values. Each value should be a positive integer less than 100 to prevent arithmetic overflow, e.g.,2:3instead of1:1.5. The default ratio is 1:1for oneside, 2:3for twoside.
vmarginratio vertical margin ratio oftoptobottom. The default ratio is2:3.
marginratio ratio
horizontal and vertical margin ratios. marginratio={hhorizontal ratioi,hvertical ratioi}
ormarginratio=hratioi.
hcentering sets auto-centering horizontally and is equivalent tohmarginratio=1:1. It is set to trueby default for oneside. See alsohmarginratio.
vcentering sets auto-centering vertically and is equivalent tovmarginratio=1:1. The default is false. See alsovmarginratio.
centering sets auto-centering and is equivalent tomarginratio=1:1. See alsomarginratio. The default isfalse. See also marginratio.
twoside switches on twoside mode with left and right margins swapped on verso pages. The option sets\@twosideand\@mparswitchswitches. See alsoasymmetric.
asymmetric implements a twosided layout in which margins are not swapped on alternate pages (by setting\oddsidemarginto\evensidemargin + bindingoffset) and in which the marginal notes stay always on the same side. This option can be used as an alternative to the twoside option. See alsotwoside.
bindingoffset
removes a specified space from the lefthand-side of the page for oneside or the inner-side for twoside. bindingoffset=hlengthi. This is useful if pages are bound by a press binding (glued, stitched, stapled . . . ). See Figure6.
hdivide See description in Section5.3.
vdivide See description in Section5.3.
divide See description in Section5.3.
5.5 Native dimensions
The options below overwrite LATEX native dimensions and switches for page layout (See the right-hand side in Figure1).
a)every page for oneside or odd pages for twoside
paper total body
- left
(inner)
- right
(outer)
- bindingoffset
b)even (back) pages for twoside
paper total body
- outer
(right)
- inner (left)
bindingoffset
Figure 6: The optionbindingoffsetadds the specified length to the inner margin. Note that twosideoption swaps the horizontal margins and the marginal notes together with bindingoffseton even pages (seeb)), butasymmetricoption suppresses the swap of the margins and marginal notes (butbindingoffsetis still swapped).
headheight head
modifies\headheight, height of header. headheight=hlengthiorhead=hlengthi.
headsep modifies\headsep, separation between header and text (body). headsep=hlengthi.
footskip foot
modifies\footskip, distance separation between baseline of last line of text and baseline of footer. footskip=hlengthior foot=hlengthi.
nohead eliminates spaces for the head of the page, which is equivalent to both
\headheight=0ptand\headsep=0pt.
nofoot eliminates spaces for the foot of the page, which is equivalent to\footskip=0pt.
noheadfoot equivalent tonoheadandnofoot, which means that\headheight,\headsepand
\footskipare all set to0pt.
footnotesep changes the dimension\skip\footins, separation between the bottom of text body and the top of footnote text.
marginparwidth marginpar
modifies\marginparwidth, width of the marginal notes. marginparwidth=hlengthi.
marginparsep modifies\marginparsep, separation between body and marginal notes.
marginparsep=hlengthi.
nomarginpar shrinks spaces for marginal notes to 0pt, which is equivalent to\marginparwidth=0pt and\marginparsep=0pt.
columnsep modifies\columnsep, the separation between two columns intwocolumnmode.
hoffset modifies\hoffset. hoffset=hlengthi.
voffset modifies\voffset. voffset=hlengthi.
offset horizontal and vertical offset.
offset={hhoffseti,hvoffseti}or offset=hlengthi.
twocolumn setstwocolumnmode with\@twocolumntrue. twocolumn=falsedenotes onecolumn mode with\@twocolumnfalse. Instead oftwocolumn=false, you can specifyonecolumn (which defaults totrue)
onecolumn works astwocolumn=false. On the other hand,onecolumn=falseis equivalent to twocolumn.
twoside sets both\@twosidetrueand\@mparswitchtrue. See Section5.4.
textwidth sets\textwidth directly. See Section5.3.
textheight sets\textheightdirectly. See Section5.3.
reversemp reversemarginpar
makes the marginal notes appear in the left (inner) margin with\@reversemargintrue.
The option doesn’t changeincludempmode. It’s setfalseby default.
5.6 Drivers
The package supports drivers dvips, dvipdfm, pdftex, luatex, xetex and vtex. You can also set dvipdfmfordvipdfmxandxdvipdfmxThe optionsdvipdfmxandxdvipdfmxare also supported as aliases for the dvipdfm option. pdftex forpdflatex, and vtex for VTEX environment. The driver options are exclusive. The driver can be set by eitherdriver=hdriver nameior any of the drivers directly likepdftex.
By default, geometry guesses the driver appropriate to the system in use. Therefore, you don’t have to set a driver in most cases. However, if you want to use dvipdfm, you should specify it explicitly.
†driver specifies the driver withdriver=hdriver namei. dvips,dvipdfm,pdftex,luatex,vtex, xetex,auto andnoneare available as a driver name. The names except forauto and nonecan be specified directly with the name withoutdriver=. driver=automakes the auto-detection work whatever the previous setting is. driver=none disables the
auto-detection and sets no driver, which may be useful when you want to let other package work out the driver setting. For example, if you want to usecroppackage with geometry, you should call \usepackage[driver=none]{geometry}before thecrop package.
†dvips writes the paper size in dvi output with the\specialmacro. If you usedvipsas a DVI-to-PS driver, for example, to print a document with
\geometry{a3paper,landscape}on A3 paper in landscape orientation, you don’t need options “-t a3 -t landscape” todvips.
†dvipdfm works likedvipsexcept for landscape correction. You can set this option when using dvipdfmxandxdvipdfmx to process the dvi output.
†pdftex sets\pdfpagewidthand\pdfpageheightinternally.
†luatex sets\pagewidth and\pageheightinternally.
†xetex is the same aspdftexexcept for ignoring\pdf{h,v}originundefined in X E LATEX. This option is introduced in the version 5. Note that ‘geometry.cfg’ in TEX Live, which disables the auto-detection routine and setspdftex, is no longer necessary, but has no problem even though it’s left undeleted. Instead ofxetex, you can specifydvipdfmwith X E LATEX if you want to use specials of dvipdfm X E TEX supports.
†vtex sets dimensions\mediawidthand\mediaheightfor VTEX. When this driver is selected (explicitly or automatically),geometry will auto-detect which output mode (DVI, PDF or PS) is selected in VTEX, and do proper settings for it.
If explicit driver setting is mismatched with the typesetting program in use, the default driver dvips would be selected.
5.7 Other options
The other useful options are described here.
†verbose displays the parameter results on the terminal. verbose=false(default) still puts them into the log file.
†reset sets back the layout dimensions and switches to the settings beforegeometry is loaded.
Options given ingeometry.cfgare also cleared. Note that this cannot resetpassand magwithtruedimen. reset=falsehas no effect and cannot cancel the previous reset(=true) if any. For example, when you go
\documentclass[landscape]{article}
\usepackage[twoside,reset,left=2cm]{geometry}
with\ExecuteOptions{scale=0.9}ingeometry.cfg, then as a result,landscapeand left=2cmremain effective, andscale=0.9andtwosideare ineffective.
†mag sets magnification value (\mag) and automatically modifies\hoffsetand\voffset according to the magnification. mag=hvaluei. Note that hvalueishould be an integer value with 1000 as a normal size. For example,mag=1414witha4paperprovides an enlarged print fitting ina3paper, which is 1.414 (=√
2) times larger thana4paper. Font enlargement needs extra disk space. Note that setting magshould precede any other settings with ‘true’ dimensions, such as 1.5truein,2truecm and so on.
See alsotruedimenoption.
†truedimen changes all internal explicit dimension values intotrue dimensions, e.g.,1inis changed to1truein. Typically this option will be used together withmagoption. Note that this is ineffective against externally specified dimensions. For example, when you set
“mag=1440, margin=10pt, truedimen”, margins are not ‘true’ but magnified. If you want to set exact margins, you should set like “mag=1440, margin=10truept, truedimen” instead.
†pass disables all of the geometry options and calculations exceptverboseandshowframe. It is order-independent and can be used for checking out the page layout of the
documentclass, other packages and manual settings withoutgeometry.
†showframe shows visible frames for the text area and page, and the lines for the head and foot on the first page.
†showcrop prints crop marks at each corner of user-specified layout area.
6 Processing options
6.1 Order of loading
If there’sgeometry.cfgsomewhere TEX can find it,geometryloads it first. For example, ingeometry.cfg you may write \ExecuteOptions{a4paper}, which specifies A4 paper as the default paper. Basically you can use all the options defined in geometrywith\ExecuteOptions{}.
The order of loading in the preamble of your document is as follows:
1. geometry.cfgif it exists.
2. Options specified with\documentclass[hoptionsi]{...}.
3. Options specified with\usepackage[hoptionsi]{geometry}
4. Options specified with\geometry{hoptionsi}, which can be called multiple times. (reset option will cancel the specified options ever given in\usepackage{geometry}or\geometry.)
6.2 Order of options
The specification of geometryoptions is order-independent, and overwrites the previous one for the same setting. For example,
[left=2cm, right=3cm]is equivalent to[right=3cm, left=2cm].
The options called multiple times overwrite the previous settings. For example, [verbose=true, verbose=false]results inverbose=false.
[hmargin={3cm,2cm}, left=1cm]is the same ashmargin={1cm,2cm}, where the left (or inner) margin is overwritten byleft=1cm.
reset and magare exceptions. The reset option removes all the geometry options (except pass) before it. If you set
\documentclass[landscape]{article}
\usepackage[margin=1cm,twoside]{geometry}
\geometry{a5paper, reset, left=2cm}
thenmargin=1cm,twosideanda5paperare removed, and is eventually equivalent to
\documentclass[landscape]{article}
\usepackage[left=2cm]{geometry}
The mag option should be set in advance of any other settings with ‘true’ length, such as left=1.5truecm, width=5truein and so on. The \mag primitive can be set before this package is called.
6.3 Priority
There are several ways to set dimensions of the body: scale, total, text and lines. The geometry package gives higher priority to the more concrete specification. Here is the priority rule for body.
priority: low −→ high
hscale vscale scale
<
width height total
<
textwidth textheight text
<lines.
For example,
\usepackage[hscale=0.8, textwidth=7in, width=18cm]{geometry}
is the same as\usepackage[textwidth=7in]{geometry}. Another example:
\usepackage[lines=30, scale=0.8, text=7in]{geometry}
results in[lines=30, textwidth=7in].
6.4 Defaults
This section sums up the default settings for the auto-completion described later.
The default vertical margin ratio is 2/3, namely,
top:bottom= 2 : 3 default. (6)
As for the horizontal margin ratio, the default value depends on whether the document is onesided or twosided,
left(inner) :right(outer) =
1 : 1 default for oneside,
2 : 3 default for twoside. (7)
Obviously the default horizontal margin ratio for oneside is ‘centering’.
Thegeometry package has the following default setting foronesided documents:
• scale=0.7(bodyis 0.7×paper)
• marginratio={1:1, 2:3}(1:1 for horizontal and 2:3 for vertical margins)
• ignoreall(the header, footer, marginal notes are excluded when calculating the size of body.) Fortwosided document withtwosideoption, the default setting is the same asonesided except that the horizontal margin ratio is set to 2:3as well.
Additional options overwrite the previous specified dimensions.
6.5 Auto-completion
Figure7shows schematically how many specification patterns exist and how to solve the ambiguity of the specifications. Each axis shows the numbers of lengths explicitly specified for body and margins. S(m,b) presents the specification with a set of numbers (margin,body) = (m, b).
For example, the specificationwidth=14cm, left=3cmis categorized intoS(1,1), which is an adequate specification. If you addright=4cm, it would be inS(2,1)and overspecified. If onlywidth=14cmis given, it’s in S(0,1), underspecified.
The geometry package has the auto-completion mechanism, in which if the layout parameters are underspecified or overspecified,geometryworks out the ambiguity using the defaults and other relations.
Here are the specifications and the completion rules.
S(0,0) Nothing is specified. Thegeometry package setsbodywith the defaultscale(= 0.7).
For example,widthis set to be0.7×layoutwidth. Note that by default
layoutwidthandlayoutheightwill be equal to\paperwidth and\paperheight respectively. ThusS(0,0)goes toS(0,1). SeeS(0,1).
0 body
1
0
S(0,0) usescale
B B
S(0,1) usemarginratio
margin 1
usescale
ifratio specified
S(1,1) B B P P
S(1,0)
solvable
2
S(2,0) solvable
forgetbody S(2,1) P
P
BB
Figure 7: SpecificationsS(0,0)toS(2,1)and the completion rules (arrows). Column and row numbers denote the number of explicitly specified lengths for margin and body respectively. S(m,b)denote a specification with a set of the numbers (margin,body) = (m, b).
S(0,1) Onlybodyis specified, such aswidth=7in,lines=20,body={20cm,24cm},scale=0.9 and so forth. Thengeometrysets margins with the margin ratio. If the margin ratio is not specified, the default is used. The default vertical margin ratio is defined as
top:bottom= 2 : 3 default. (8) As for the horizontal margin ratio, the default value depends on whether the
document is onesided or twosided,
left(inner) :right(outer) =
1 : 1 default for oneside,
2 : 3 default for twoside. (9) For example, ifheight=22cmis specified on A4 paper,geometry calculatestopmargin as follows:
top = (layoutheight−height)×2/5
= (29.7−22)×2/5 = 3.08(cm) (10)
Thustopmargin and bodyheighthave been determined, the specification for the vertical goes toS(1,1)and all the parameters can be solved.
S(1,0) Only one margin is specified, such asbottom=2cm,left=1in,top=3cm, and so forth.
• If the margin ratio is not specified,geometry setsbodywith the default scale(= 0.7). For example, iftop=2.4cmis specified,geometry sets
height=0.7×layoutheight (=0.7\paperheightby default), thenS(1,0)goes toS(1,1), in whichbottomis calculated with
layoutheight−(height+top) and results in 6.51cm on A4 paper if the layout size is equal to the paper size.
• If the margin ratio is specified, such ashmarginratio={1:2},vratio={3:4}
and so forth,geometry sets the other margin with the specified margin ratio. For example, if a set of options “top=2.4cm,vratio={3:4}” is specified,geometry setsbottomto be3.2cm calculating
bottom=top/3×4 = 3.2cm ThusS(1,0)goes to S(2,0).
Note that the version 4 or earlier used to set the other margin with the margin ratio.
In the version 5, therefore, with the same specification, the result will be different from the one in the version 4. For example, if onlytop=2.4cmis specified, you got bottom=2.4cmin the version 4 or earlier, but you will getbottom=6.51cmin the version 5.
S(2,1) Thebodyand twomargins are all specified, such asvdivide={1in,8in,1.5in},
“left=3cm,width=13cm,right=4cm” and so forth. Sincegeometry basically gives priority tomarginsif dimensions are overspecified,geometry forgets and resetsbody.
For example, if you specify
\usepackage[a4paper,left=3cm,width=13cm,right=4cm]{geometry},
widthis reset to be 14cm because the width of a A4 paper is 21cm long.
7 Changing layout mid-document
The version 5 provides the new commands \newgeometry{· · ·} and \restoregeometry, which allow you to change page dimensions in the middle of the document. Unlike \geometry in the preamble,
\newgeometry is available only after \begin{document}, resets all the options ever specified except for the papersize-related options: landscape, portrait, and paper size options (such as papersize, paper=a4paperand so forth), which can’t be changed with\newgeometry.
The command \restoregeometry restores the page layout specified in the preamble (before
\begin{document}) with the options to\usepackage{geometry}and\geometry.
Note that both\newgeometry and\restoregeometryinsert\clearpagewhere they are called.
Below is an example of changing layout mid-document. The layout L1 specified withhmargin=3cm (leftandrightmargins are3cmlong) is changed to L2 withleft=3cm,right=1cmandbottom=0.1cm.
The layout L1 is restored with \restoregeometry.
\usepackage[hmargin=3cm]{geometry}
\begin{document}
Layout L1
\newgeometry{left=3cm,right=1cm,bottom=0.1cm}
Layout L2 (new)
\restoregeometry
Layout L1 (restored)
\newgeometry{margin=1cm,includefoot}
Layout L3 (new)
\end{document}
(saved) head
body
foot
L1
r r r
\newgeometry head
body
foot L2 (new)
r r r
\restoregeometry head
body
foot
L1 (restored) r r r
\newgeometry
body
foot L3 (new)
A set of commands\savegeometry{hnamei}and\loadgeometry{hnamei}is handy if you want to reuse more different layouts in your document. For example,
\usepackage[hmargin=3cm]{geometry}
\begin{document}
L1
\newgeometry{left=3cm,right=1cm,bottom=0.1cm}
\savegeometry{L2}
L2 (new, saved)
\restoregeometry L1 (restored)
\newgeometry{margin=1cm,includefoot}
L3 (new)
\loadgeometry{L2}
L2 (loaded)
\end{document}
8 Examples
1. A onesided page layout with the text area centered in the paper. The examples below have the same result because the horizontal margin ratio is set1:1for oneside by default.
• centering
• marginratio=1:1
• vcentering
2. A twosided page layout with the inside offset for binding set to1cm.
• twoside, bindingoffset=1cm
In this case,textwidthis shorter than that of the default twosided document by 0.7×1cm(=0.7cm) because the default width ofbodyis set withscale=0.7, which meanswidth=0.7×layoutwidth (=0.7\paperwidthby default).
3. A layout with the left, right, and top margin 3cm, 2cmand2.5in respectively, with textheight of 40 lines, and with the head and foot of the page included intotal body. The two examples below have the same result.
• left=3cm, right=2cm, lines=40, top=2.5in, includeheadfoot
• hmargin={3cm,2cm}, tmargin=2.5in, lines=40, includeheadfoot
4. A layout with the height of total body10in, the bottom margin2cm, and the default width. The top margin will be calculated automatically. Each solution below results in the same page layout.
• vdivide={*, 10in, 2cm}
• bmargin=2cm, height=10in
• bottom=2cm, textheight=10in
Note that dimensions for head and foot are excluded from height of total body. An additional includefoot makes \footskip included in totalheight. Therefore, in the two cases below, textheight in the former layout is shorter than the latter (with 10in exactly) by \footskip.
In other words,height=textheight +footskipwhenincludefoot=truein this case.
• bmargin=2cm, height=10in, includefoot
• bottom=2cm, textheight=10in, includefoot
5. A layout withtextwidth and textheight 90% of the paper and with body centered. Each solution below results in the same page layout as long aslayoutwidthandlayoutheightare not modified from the default.
• scale=0.9, centering
• text={.9\paperwidth,.9\paperheight}, ratio=1:1
• width=.9\paperwidth, vmargin=.05\paperheight, marginratio=1:1
• hdivide={*,0.9\paperwidth,*}, vdivide={*,0.9\paperheight,*}(as for onesided docu- ments)
• margin={0.05\paperwidth,0.05\paperheight}
You can addheightroundedto avoid an “underfull vbox warning” like Underfull \vbox (badness 10000) has occurred while \output is active.
See Section5.3for the detailed description aboutheightrounded.
6. A layout with the width of marginal notes set to3cmand included in the width of total body. The following examples are the same.
• marginparwidth=3cm, includemp
• marginpar=3cm, ignoremp=false
7. A layout wherebodyoccupies the whole paper with A5 paper in landscape. The following examples are the same.
• a5paper, landscape, scale=1.0
• landscape=TRUE, paper=a5paper, margin=0pt
8. A screen size layout appropriate for presentation with PC and video projector.
\documentclass{slide}
\usepackage[screen,margin=0.8in]{geometry}
...
\begin{slide}
...
\end{slide}
9. A layout with fonts and spaces both enlarged from A4 to A3. In the case below, the resulting paper size is A3.
• a4paper, mag=1414.
If you want to have a layout with two times bigger fonts, but without changing paper size, you can type
• letterpaper, mag=2000, truedimen.
You can adddvipsoption, that is useful to preview it with proper paper size bydvioutor xdvi.
10. Changing the layout of the first page and leaving the others as default before loadinggeometry. Use passoption,\newgeometryand\restoregeometry.
\documentclass{book}
\usepackage[pass]{geometry}
% ’pass’ disregards the package layout,
% so the original ’book’ layout is memorized here.
\begin{document}
\newgeometry{margin=1cm}% changes the first page dimensions.
Page 1
\restoregeometry % restores the original ’book’ layout.
Page 2 and more
\end{document}
11. A complex page layout.
\usepackage[a5paper, landscape, twocolumn, twoside,
left=2cm, hmarginratio=2:1, includemp, marginparwidth=43pt,
bottom=1cm, foot=.7cm, includefoot, textheight=11cm, heightrounded, columnsep=1cm, dvips, verbose]{geometry}
Try typesetting it and checking out the result yourself. :-)
9 Known problems
• Withmag6= 1000 and truedimen, paperwidth and paperheight shown in verbose mode are dif- ferent from the real size of the resulted PDF. The PDF itself is correct anyway.
• Withmag6= 1000,notruedimenandhyperref,hyperrefshould be loaded beforegeometry. Otherwise the resulted PDF size will become wrong.
• Withcroppackage andmag6= 1000,centeroption of cropdoesn’t work well.
10 Acknowledgments
The author appreciates helpful suggestions and comments from many people including (in alphabetical order of family name): Jean-Bernard Addor, Frank Bennett, Alexis Dimitriadis, Friedrich Flender, Adrian Heathcote, Stephan Hennig, Morten Høgholm, Jonathan Kew, James Kilfiger, Yusuke Kuroki, Jean- Marc Lasgouttes, Wlodzimierz Macewicz, Frank Mittelbach, Eckhard Neber, Rolf Niepraschk, Hans Fr. Nordhaug, Heiko Oberdiek, Keith Reckdahl, Peter Riocreux, Will Robertson, Pablo Rodriguez, Nico Schl¨oemer, Perry C. Stearns, Frank Stengel, Plamen Tanovski, Petr Uher, Piet van Oostrum, Vladimir Volovich, Michael Vulis.
11 Implementation
1h∗packagei
This package requires the following packages: keyval,ifvtex.
2\RequirePackage{keyval}%
3\RequirePackage{ifvtex}%
Internal switches are declared here.
4\newif\ifGm@verbose
5\newif\ifGm@landscape
6\newif\ifGm@swap@papersize
7\newif\ifGm@includehead
8\newif\ifGm@includefoot
9\newif\ifGm@includemp
10\newif\ifGm@hbody
11\newif\ifGm@vbody
12\newif\ifGm@heightrounded
13\newif\ifGm@showframe
14\newif\ifGm@showcrop
15\newif\ifGm@pass
16\newif\ifGm@resetpaper
17\newif\ifGm@layout
18\newif\ifGm@newgm
\Gm@cnth
\Gm@cntv
The counters for horizontal and vertical partitioning patterns.
19\newcount\Gm@cnth
20\newcount\Gm@cntv
\c@Gm@tempcnt The counter is used to set number withcalc.
21\newcount\c@Gm@tempcnt
\Gm@bindingoffset The binding offset for the inner margin.
22\newdimen\Gm@bindingoffset
\Gm@wd@mp
\Gm@odd@mp
\Gm@even@mp
Correction lengths for\textwidth, \oddsidemarginand\evensidemarginin includempmode.
23\newdimen\Gm@wd@mp
24\newdimen\Gm@odd@mp
25\newdimen\Gm@even@mp
\Gm@layoutwidth
\Gm@layoutheight
\Gm@layouthoffset
\Gm@layoutvoffset
The dimensions for the layout area.
26\newdimen\Gm@layoutwidth
27\newdimen\Gm@layoutheight
28\newdimen\Gm@layouthoffset
29\newdimen\Gm@layoutvoffset
\Gm@dimlist The token in which LATEX native dimensions can be stored.
30\newtoks\Gm@dimlist
\Gm@warning The macro to print warning messages.
31\def\Gm@warning#1{\PackageWarningNoLine{geometry}{#1}}%
\ifGm@preamble The macro executes the option given as an argument only if it’s specified in the preamble, as the options of\usepackage and/or the argument of\geometry. Otherwise, the macro would print the warning message and ignores the option setting.
32\def\ifGm@preamble#1{%
33 \ifGm@newgm
34 \Gm@warning{‘#1’: not available in ‘\string\newgeometry’; skipped}%
35 \else
36 \expandafter\@firstofone
37 \fi}%
\Gm@Dhratio
\Gm@Dhratiotwo
\Gm@Dvratio
The default values for the horizontal and verticalmarginalratioare defined. \Gm@Dhratiotwodenotes the default value of horizontal marginratio for twoside page layout with left and right margins swapped on verso pages, which is set bytwoside.
38\def\Gm@Dhratio{1:1}% = left:right default for oneside
39\def\Gm@Dhratiotwo{2:3}% = inner:outer default for twoside.
40\def\Gm@Dvratio{2:3}% = top:bottom default
\Gm@Dhscale
\Gm@Dvscale
The default values for the horizontal and verticalscale are defined with 0.7.
41\def\Gm@Dhscale{0.7}%
42\def\Gm@Dvscale{0.7}%
\Gm@dvips
\Gm@dvipdfm
\Gm@pdftex
\Gm@luatex
\Gm@xetex
\Gm@vtex
The driver names.
43\def\Gm@dvips{dvips}%
44\def\Gm@dvipdfm{dvipdfm}%
45\def\Gm@pdftex{pdftex}%
46\def\Gm@luatex{luatex}%
47\def\Gm@xetex{xetex}%
48\def\Gm@vtex{vtex}%
\Gm@true
\Gm@false
The macros fortrueandfalse.
49\def\Gm@true{true}%
50\def\Gm@false{false}%
\Gm@orgpw
\Gm@orgph
These macros keep original paper (media) size intact.
51\edef\Gm@orgpw{\the\paperwidth}%
52\edef\Gm@orgph{\the\paperheight}%
\Gm@savelength The macro saves the specified length to\Gm@restore.
53\def\Gm@savelength#1{%
54 \g@addto@macro\Gm@restore{\expandafter\noexpand\expandafter\csname
55 #1\endcsname\expandafter=\expandafter\the\csname #1\endcsname\relax}}%
\Gm@saveboolean The macro saves the specified boolean to\Gm@restore.
56\def\Gm@saveboolean#1{%
57 \csname if#1\endcsname
58 \g@addto@macro\Gm@restore{\expandafter\noexpand\csname #1true\endcsname}%
59 \else
60 \g@addto@macro\Gm@restore{\expandafter\noexpand\csname #1false\endcsname}%
61 \fi}%
\Gm@restore The initialization for\Gm@restore.
62\def\Gm@restore{}%
\Gm@save The definition of the macro saving the real lengths LATEX options.
63\def\Gm@save{%
64 \Gm@savelength{paperwidth}%
65 \Gm@savelength{paperheight}%
66 \Gm@savelength{textwidth}%
67 \Gm@savelength{textheight}%
68 \Gm@savelength{evensidemargin}%
69 \Gm@savelength{oddsidemargin}%
70 \Gm@savelength{topmargin}%
71 \Gm@savelength{headheight}%
72 \Gm@savelength{headsep}%
73 \Gm@savelength{topskip}%
74 \Gm@savelength{footskip}%
75 \Gm@savelength{baselineskip}%
76 \Gm@savelength{marginparwidth}%
77 \Gm@savelength{marginparsep}%
78 \Gm@savelength{columnsep}%
79 \Gm@savelength{hoffset}%
80 \Gm@savelength{voffset}
81 \Gm@savelength{Gm@layoutwidth}%
82 \Gm@savelength{Gm@layoutheight}%
83 \Gm@savelength{Gm@layouthoffset}%
84 \Gm@savelength{Gm@layoutvoffset}%
85 \Gm@saveboolean{@twocolumn}%
86 \Gm@saveboolean{@twoside}%
87 \Gm@saveboolean{@mparswitch}%
88 \Gm@saveboolean{@reversemargin}}%
\Gm@initnewgm The macro initializes the parameters for layout in\newgeometry.
89\def\Gm@initnewgm{%
90 \Gm@passfalse
91 \Gm@swap@papersizefalse
92 \Gm@dimlist={}
93 \Gm@hbodyfalse
94 \Gm@vbodyfalse
95 \Gm@heightroundedfalse
96 \Gm@includeheadfalse
97 \Gm@includefootfalse
98 \Gm@includempfalse
99 \let\Gm@width\@undefined
100 \let\Gm@height\@undefined
101 \let\Gm@textwidth\@undefined
102 \let\Gm@textheight\@undefined
103 \let\Gm@lines\@undefined
104 \let\Gm@hscale\@undefined
105 \let\Gm@vscale\@undefined
106 \let\Gm@hmarginratio\@undefined
107 \let\Gm@vmarginratio\@undefined
108 \let\Gm@lmargin\@undefined
109 \let\Gm@rmargin\@undefined
110 \let\Gm@tmargin\@undefined
111 \let\Gm@bmargin\@undefined
112 \Gm@layoutfalse
113 \Gm@layouthoffset\z@
114 \Gm@layoutvoffset\z@
115 \Gm@bindingoffset\z@}%
\Gm@initall This initialization is called as soon as the package is load It’s also called as soon asreset option is specified.
116\def\Gm@initall{%
117 \let\Gm@driver\@empty
118 \let\Gm@truedimen\@empty
119 \let\Gm@paper\@undefined
120 \Gm@resetpaperfalse
121 \Gm@landscapefalse
122 \Gm@verbosefalse
123 \Gm@showframefalse
124 \Gm@showcropfalse
125 \Gm@newgmfalse
126 \Gm@initnewgm}%
\Gm@setdriver The macro sets the specified driver.
127\def\Gm@setdriver#1{%
128 \expandafter\let\expandafter\Gm@driver\csname Gm@#1\endcsname}%
\Gm@unsetdriver The macro unsets the specified driver if it has been set.
129\def\Gm@unsetdriver#1{%
130 \expandafter\ifx\csname Gm@#1\endcsname\Gm@driver\let\Gm@driver\@empty\fi}%
\Gm@setbool
\Gm@setboolrev
The macros for boolean option processing.
131\def\Gm@setbool{\@dblarg\Gm@@setbool}%
132\def\Gm@setboolrev{\@dblarg\Gm@@setboolrev}%
133\def\Gm@@setbool[#1]#2#3{\Gm@doif{#1}{#3}{\csname Gm@#2\Gm@bool\endcsname}}%
134\def\Gm@@setboolrev[#1]#2#3{\Gm@doifelse{#1}{#3}%
135 {\csname Gm@#2\Gm@false\endcsname}{\csname Gm@#2\Gm@true\endcsname}}%
\Gm@doif
\Gm@doifelse
\Gm@doifexcutes the third argument #3 using a boolean value#2 of a option #1. \Gm@doifelse executes the third argument#3if a boolean option#1with its value#2 true, and executes the fourth argument#4iffalse.
136\def\Gm@doif#1#2#3{%
137 \lowercase{\def\Gm@bool{#2}}%
138 \ifx\Gm@bool\@empty
139 \let\Gm@bool\Gm@true
140 \fi
141 \ifx\Gm@bool\Gm@true
142 \else
143 \ifx\Gm@bool\Gm@false
144 \else
145 \let\Gm@bool\relax
146 \fi
147 \fi
148 \ifx\Gm@bool\relax
149 \Gm@warning{‘#1’ should be set to ‘true’ or ‘false’}%
150 \else
151 #3
152 \fi}%
153\def\Gm@doifelse#1#2#3#4{%
154 \Gm@doif{#1}{#2}{\ifx\Gm@bool\Gm@true #3\else #4\fi}}%
\Gm@reverse The macro reverses a bool value.
155\def\Gm@reverse#1{%
156 \csname ifGm@#1\endcsname
157 \csname Gm@#1false\endcsname\else\csname Gm@#1true\endcsname\fi}%
\Gm@defbylen
\Gm@defbycnt
Macros\Gm@defbylen and \Gm@defbycntcan be used to define \Gm@xxxxvariables by length and counter respectively withcalcpackage.
158\def\Gm@defbylen#1#2{%
159 \begingroup\setlength\@tempdima{#2}%
160 \expandafter\xdef\csname Gm@#1\endcsname{\the\@tempdima}\endgroup}%
161\def\Gm@defbycnt#1#2{%
162 \begingroup\setcounter{Gm@tempcnt}{#2}%
163 \expandafter\xdef\csname Gm@#1\endcsname{\the\value{Gm@tempcnt}}\endgroup}%
\Gm@set@ratio The macro parses the value of options specifying marginal ratios, which is used in\Gm@setbyratio macro.
164\def\Gm@sep@ratio#1:#2{\@tempcnta=#1\@tempcntb=#2}%
\Gm@setbyratio The macro determines the dimension specified by #4calculating #3×a/b, where aand b are given by\Gm@mratiowith a:b value. If#1in brackets isb,aand bare swapped. The second argument withhor vdenoting horizontal or vertical is not used in this macro.
165\def\Gm@setbyratio[#1]#2#3#4{% determine #4 by ratio
166 \expandafter\Gm@sep@ratio\Gm@mratio\relax
167 \if#1b
168 \edef\@@tempa{\the\@tempcnta}%
169 \@tempcnta=\@tempcntb
170 \@tempcntb=\@@tempa\relax
171 \fi
172 \expandafter\setlength\expandafter\@tempdimb\expandafter
173 {\csname Gm@#3\endcsname}%
174 \ifnum\@tempcntb>\z@
175 \multiply\@tempdimb\@tempcnta
176 \divide\@tempdimb\@tempcntb
177 \fi
178 \expandafter\edef\csname Gm@#4\endcsname{\the\@tempdimb}}%
\Gm@detiv This macro determines the fourth length(#4) from#1(layoutwidthor layoutheight),#2and #3. It is used in\Gm@detall macro.
179\def\Gm@detiv#1#2#3#4{% determine #4.
180 \expandafter\setlength\expandafter\@tempdima\expandafter
181 {\csname Gm@layout#1\endcsname}%
182 \expandafter\setlength\expandafter\@tempdimb\expandafter
183 {\csname Gm@#2\endcsname}%
184 \addtolength\@tempdima{-\@tempdimb}%
185 \expandafter\setlength\expandafter\@tempdimb\expandafter
186 {\csname Gm@#3\endcsname}%
187 \addtolength\@tempdima{-\@tempdimb}%
188 \ifdim\@tempdima<\z@
189 \Gm@warning{‘#4’ results in NEGATIVE (\the\@tempdima).%
190 ^^J\@spaces ‘#2’ or ‘#3’ should be shortened in length}%
191 \fi
192 \expandafter\edef\csname Gm@#4\endcsname{\the\@tempdima}}%
\Gm@detiiandiii This macro determines#2 and #3 from #1 with the first argument (#1) can bewidth or height, which is expanded into dimensions of paper and total body. It is used in\Gm@detallmacro.
193\def\Gm@detiiandiii#1#2#3{% determine #2 and #3.
194 \expandafter\setlength\expandafter\@tempdima\expandafter
195 {\csname Gm@layout#1\endcsname}%
196 \expandafter\setlength\expandafter\@tempdimb\expandafter
197 {\csname Gm@#1\endcsname}%
198 \addtolength\@tempdima{-\@tempdimb}%
199 \ifdim\@tempdima<\z@
200 \Gm@warning{‘#2’ and ‘#3’ result in NEGATIVE (\the\@tempdima).%
201 ^^J\@spaces ‘#1’ should be shortened in length}%
202 \fi
203 \ifx\Gm@mratio\@undefined
204 \expandafter\Gm@sep@ratio\Gm@Dmratio\relax
205 \else
206 \expandafter\Gm@sep@ratio\Gm@mratio\relax
207 \ifnum\@tempcntb>\z@\else
208 \Gm@warning{margin ratio a:b should be non-zero; default used}%
209 \expandafter\Gm@sep@ratio\Gm@Dmratio\relax
210 \fi
211 \fi
212 \@tempdimb=\@tempdima
213 \advance\@tempcntb\@tempcnta
214 \divide\@tempdima\@tempcntb
215 \multiply\@tempdima\@tempcnta
216 \advance\@tempdimb-\@tempdima
217 \expandafter\edef\csname Gm@#2\endcsname{\the\@tempdima}%
218 \expandafter\edef\csname Gm@#3\endcsname{\the\@tempdimb}}%
\Gm@detall This macro determines partition of each direction. The first argument (#1) should be h or v, the second (#2)widthor height, the third (#3)lmarginortop, and the last (#4)rmarginor bottom.
219\def\Gm@detall#1#2#3#4{%
220 \@tempcnta\z@
221 \if#1h
222 \let\Gm@mratio\Gm@hmarginratio
223 \edef\Gm@Dmratio{\if@twoside\Gm@Dhratiotwo\else\Gm@Dhratio\fi}%
224 \else
225 \let\Gm@mratio\Gm@vmarginratio
226 \edef\Gm@Dmratio{\Gm@Dvratio}%
227 \fi
\@tempcntais treated as a three-digit binary value with top, middle and bottom denotedleft(top), width(height) andright(bottom) margins user specified respectively.
228 \if#1h
229 \ifx\Gm@lmargin\@undefined\else\advance\@tempcnta4\relax\fi
230 \ifGm@hbody\advance\@tempcnta2\relax\fi
231 \ifx\Gm@rmargin\@undefined\else\advance\@tempcnta1\relax\fi
232 \Gm@cnth\@tempcnta
233 \else
234 \ifx\Gm@tmargin\@undefined\else\advance\@tempcnta4\relax\fi
235 \ifGm@vbody\advance\@tempcnta2\relax\fi
236 \ifx\Gm@bmargin\@undefined\else\advance\@tempcnta1\relax\fi
237 \Gm@cntv\@tempcnta
238 \fi
Case the value is000(=0) with nothing fixed (default):
239 \ifcase\@tempcnta
240 \if#1h
241 \Gm@defbylen{width}{\Gm@Dhscale\Gm@layoutwidth}%
242 \else
243 \Gm@defbylen{height}{\Gm@Dvscale\Gm@layoutheight}%
244 \fi
245 \Gm@detiiandiii{#2}{#3}{#4}%
Case001(=1) withright(bottom) fixed:
246 \or
247 \ifx\Gm@mratio\@undefined
248 \if#1h
249 \Gm@defbylen{width}{\Gm@Dhscale\Gm@layoutwidth}%
250 \else
251 \Gm@defbylen{height}{\Gm@Dvscale\Gm@layoutheight}%
252 \fi
253 \setlength\@tempdimc{\@nameuse{Gm@#4}}%
254 \Gm@detiiandiii{#2}{#3}{#4}%
255 \expandafter\let\csname Gm@#2\endcsname\@undefined
256 \Gm@defbylen{#4}{\@tempdimc}%
257 \else
258 \Gm@setbyratio[f]{#1}{#4}{#3}%
259 \fi
260 \Gm@detiv{#2}{#3}{#4}{#2}%
Case010(=2) withwidth(height) fixed:
261 \or\Gm@detiiandiii{#2}{#3}{#4}%
Case011(=3) with bothwidth(height) andright(bottom) fixed:
262 \or\Gm@detiv{#2}{#2}{#4}{#3}%
Case100(=4) withleft(top) fixed:
263 \or
264 \ifx\Gm@mratio\@undefined
265 \if#1h
266 \Gm@defbylen{width}{\Gm@Dhscale\Gm@layoutwidth}%
267 \else
268 \Gm@defbylen{height}{\Gm@Dvscale\Gm@layoutheight}%
269 \fi
270 \setlength\@tempdimc{\@nameuse{Gm@#3}}%
271 \Gm@detiiandiii{#2}{#4}{#3}%
272 \expandafter\let\csname Gm@#2\endcsname\@undefined
273 \Gm@defbylen{#3}{\@tempdimc}%
274 \else
275 \Gm@setbyratio[b]{#1}{#3}{#4}%
276 \fi
277 \Gm@detiv{#2}{#3}{#4}{#2}%
Case101(=5) with bothleft(top) andright(bottom) fixed:
278 \or\Gm@detiv{#2}{#3}{#4}{#2}%
Case110(=6) with bothleft(top) andwidth(height) fixed:
279 \or\Gm@detiv{#2}{#2}{#3}{#4}%
Case111(=7) with all fixed though it is over-specified:
280 \or\Gm@warning{Over-specification in ‘#1’-direction.%
281 ^^J\@spaces ‘#2’ (\@nameuse{Gm@#2}) is ignored}%
282 \Gm@detiv{#2}{#3}{#4}{#2}%
283 \else\fi}%
\Gm@clean The macro for setting unspecified dimensions to be\@undefined. This is used by\geometrymacro.
284\def\Gm@clean{%
285 \ifnum\Gm@cnth<4\let\Gm@lmargin\@undefined\fi
286 \ifodd\Gm@cnth\else\let\Gm@rmargin\@undefined\fi
287 \ifnum\Gm@cntv<4\let\Gm@tmargin\@undefined\fi
288 \ifodd\Gm@cntv\else\let\Gm@bmargin\@undefined\fi
289 \ifGm@hbody\else
290 \let\Gm@hscale\@undefined
291 \let\Gm@width\@undefined
292 \let\Gm@textwidth\@undefined
293 \fi
294 \ifGm@vbody\else
295 \let\Gm@vscale\@undefined
296 \let\Gm@height\@undefined
297 \let\Gm@textheight\@undefined
298 \fi
299 }%
\Gm@parse@divide The macro parses (h,v)divideoptions.
300\def\Gm@parse@divide#1#2#3#4{%
301 \def\Gm@star{*}%
302 \@tempcnta\z@
303 \@for\Gm@tmp:=#1\do{%
304 \expandafter\KV@@sp@def\expandafter\Gm@frag\expandafter{\Gm@tmp}%
305 \edef\Gm@value{\Gm@frag}%
306 \ifcase\@tempcnta\relax\edef\Gm@key{#2}%
307 \or\edef\Gm@key{#3}%
308 \else\edef\Gm@key{#4}%
309 \fi
310 \@nameuse{Gm@set\Gm@key false}%
311 \ifx\empty\Gm@value\else
312 \ifx\Gm@star\Gm@value\else
313 \setkeys{Gm}{\Gm@key=\Gm@value}%
314 \fi\fi
315 \advance\@tempcnta\@ne}%
316 \let\Gm@star\relax}%
\Gm@branch The macro splits a value into the same two values.
317\def\Gm@branch#1#2#3{%
318 \@tempcnta\z@
319 \@for\Gm@tmp:=#1\do{%
320 \KV@@sp@def\Gm@frag{\Gm@tmp}%
321 \edef\Gm@value{\Gm@frag}%
322 \ifcase\@tempcnta\relax% cnta == 0
323 \setkeys{Gm}{#2=\Gm@value}%
324 \or% cnta == 1
325 \setkeys{Gm}{#3=\Gm@value}%
326 \else\fi
327 \advance\@tempcnta\@ne}%
328 \ifnum\@tempcnta=\@ne
329 \setkeys{Gm}{#3=\Gm@value}%
330 \fi}%
\Gm@magtooffset This macro is used to adjust offsets by\mag.
331\def\Gm@magtooffset{%
332 \@tempdima=\mag\Gm@truedimen sp%
333 \@tempdimb=1\Gm@truedimen in%
334 \divide\@tempdimb\@tempdima
335 \multiply\@tempdimb\@m
336 \addtolength{\hoffset}{1\Gm@truedimen in}%
337 \addtolength{\voffset}{1\Gm@truedimen in}%
338 \addtolength{\hoffset}{-\the\@tempdimb}%
339 \addtolength{\voffset}{-\the\@tempdimb}}%
\Gm@setlength This macro stores LATEX native dimensions, which are stored and set afterwards.
340\def\Gm@setlength#1#2{%
341 \let\Gm@len=\relax\let\Gm@td=\relax
342 \edef\addtolist{\noexpand\Gm@dimlist=%
343 {\the\Gm@dimlist \Gm@len{#1}{#2}}}\addtolist}%
\Gm@expandlengths This macro processes\Gm@dimlist.
344\def\Gm@expandlengths{%
345 \def\Gm@td{\Gm@truedimen}%
346 \def\Gm@len##1##2{\setlength{##1}{##2}}%
347 \the\Gm@dimlist}%
