[PDF] The graphbox Package graphbox is an extension for

View - Download The graphbox Package

Previous PDF

Next PDF

ThegraphboxPackage

Niklas Beisert

Institut fur Theoretische Physik

Eidgenossische Technische Hochschule Zurich

Wolfgang-Pauli-Strasse 27, 8093 Zurich, Switzerland nbeisert@itp.phys.ethz.ch

17 January 2018,v1.1

Abstract

graphboxis an extension for the LATEX2"packagegraphicxto facilitate the placement of graphics relative to the current position using additional optional arguments[...] of\includegraphics. For example, changing the vertical alignment is convenient for using graphics as elements of (mathematical) formulae. Options for shifting, smashing and hiding the graphics are mainly intended for designing presentations using, e.g., the beamerframework.

Contents

1 Introduction

1

1.1 Vertical Alignment

2

1.2 Graphics Placement

3

1.3 Hiding Graphics

4

2 Usage4

2.1 Extensions

4

2.2 Package Options

6

3 Information

6

3.1 Copyright

6

3.2 Files and Installation

6

3.3 Interaction with CTAN Packages

7

3.4 Revision History

7

A Sample File

7

B Implementation

9

1 Introduction

Changing the placement of graphics using\includegraphicsof thegraphicxpackage is tedious. The command allows to scale and even rotate a gure by the optional arguments [...]of\includegraphics, namelyscale(xscale,yscale) androtate. However, it lacks options to change the vertical alignment, shift the graphics or modify the containing TEX box. In order to position the graphics according to one's needs, one would normally use the standard boxing tools of L ATEX such as\makebox,\parbox,\raiseboxor theminipage 1 andpictureenvironments. While practically anything can be achieved by a combination of these tools, it has several disadvantages: use of complex commands for standard situations; several boxing commands need to be combined to achieve the desired eect; leads to several levels of nesting around the actual\includegraphicscommand; readability of the LATEX construction is low (what is going on?); adjusting the placement is tedious; the higher-level boxing commands of LATEX require to specify the box width; however, the actual dimensions of the graphics are typically not known (or they change as the graphics is modied); furthermore the same number needs to be used in several places; guessing the width of the required boxes may lead to extra space around the graphics or warning messages about an overfull box; Therefore it would be desirable to specify the placement along with other options in the [...]argument of\includegraphics. This may be helpful in the following situations: presentations where several gure need to be placed across the frames without dis- turbing the ow of the text; similarly, in the composition of posters; when graphics are used as elements of (mathematical) formulae one might prefer a central vertical alignment over the default baseline alignment of\includegraphics. The following discusses these situations in more detail.

1.1 Vertical Alignment

Suppose you want to show graphics les

1of dierent height next to each other (potentially

accompanied by some text). A plain inclusion via\includegraphicswill produce the output: some text This is because\includegraphicsputs the graphics into a box whose baseline is the lower bound of the box: @@@@@some text Instead, a central alignment of the graphics is desirable in many situations: some text1 a diagonal cross will serve as the sample gure in this documentation. 2

This can be achieved by code such as:

\qquad \qquad \mbox{some text} However, if the width of the graphics is not as evident (e.g. when no width is specied or the graphics is scaled), the resulting output may easily look like: 2 @@@@@some text The present extensiongraphboxadds the optionalignto\includegraphicsto simplify the declaration: \includegraphics[align=c,width=1cm]{...} \qquad \includegraphics[align=c,width=2cm]{...} \qquad \mbox{some text}

1.2 Graphics Placement

A related issue is the ne-tuning of graphics placement: In L

ATEX this can be achieved by

the commands\raisebox(vertically) and\hspace(horizontally). Furthermore, one might want to place the graphics into some free space relative to the present position. This is commonly needed in designing presentations or posters, where the ow of the text and the graphics is often ne-tuned. For example, one may ignore the vertical height of the graphics using\smash. Or one might place the graphics at the present horizontal position without allocating space by\makebox[0pt],\llapor\rlap. Each of these elementary operations can be handled well, but their combination can become very involved: For example, this may be used to produce the output:

A B CD 1 2 3

E 4 5 6

F 7 8 9

@@@@@Here, the graphics was put next to a table. The small box represents the anchor of the graphics. It occupies no space which allows to centre the table irrespectively of the size of the graphics. Unfortunately, the command is not easily readable. Thegraphboxextension abbreviates the declaration and make it much more accessible: Boxes were added to display the size of the bounding boxes. 3

1.3 Hiding Graphics

Sometimes one might wish to hide a graphics while reserving the space it would occupy. 3For example, this feature is needed in presentations where the frames are successively uncovered. In thisbeamerclass the uncovering of frames is conveniently achieved by the command \pause. Unfortunately, the eect of\pauseon graphics is that they are either displayed or taken out of the text ow. This has the eect that the formatting can change drastically when graphics elements are uncovered:beforeafter !before afterThegraphboxextension adds the optionhideto\includegraphicsto hide the corre- sponding graphics while reserving the space it would otherwise occupy: ! @@@@Moreover, in conjunction with thebeamerclass, the denition of the\includegraphics command is altered such that it uses the same amount of space in all visibility modes (specied through the\pausemechanism and the<...>extension). Visibility is handled by automatically setting thehideoption:beforeafter !before after2 Usage

To usegraphboxsimply add the command

\usepackage{graphbox} to the preamble of your L ATEX document. If not yet present, the packagegraphicxwill automatically be loaded.

2.1 Extensions

The package mainly extends the functionality of the\includegraphicscommand of the graphicxpackage by allowing several additional optional arguments[...]as follows: hide[=bool] hides the graphics (unlessbool=false) but reserves the space it would have occupied. align[=valign] adjusts the vertical alignment of the graphics wherevalignis one of the following: b:baseline aligned to b ottomof graphics; default behaviour whenalignis not specied;3 In thegraphicxpackage a similar eect achieved by the optiondraft. However, here the graphics are replaced by a box containing the le name. 4 c:cen treof curren tline aligned to cen treof graphics; 4 default behaviour when no parameter is given; t:top of curren tline aligned to top of graph ics;5 l:baseline aligned to b ottomof graphics; same as b; m:baseline aligned to cen treof graphics; u:baseline aligned to top of grap hics. vsmash[=vpos] reduces the height of the bounding box to zero (equivalent to\smash); places the graphics according tovposwhich can take the following values: b:p ositionstop of graphics b elowtop of curren tline; c:p ositionscen treof graphics at cen treof curr entline; default behaviour when no parameter is given; t:p ositionsb ottomof graphics at baseline; l:p ositionstop of graphics at baseline; m:p ositionscen treof graphics at baseline; u:p ositionsb ottomof graphics at baseline; sam eas t; n:no v erticalsmashing. Note that the parametervposhas the opposite eect of the parametervalignofalign. hsmash[=hpos] reduces the width of the bounding box to zero (equivalent to\makebox[0pt]); places the graphics according tohposwhich can take the following values r:p ositionsgraphics righ tof curren tp osition; c:p ositionscen treof the graphics at curren tp osition;default b ehaviourwhen no parameter is given; l:p ositionsgraphics left of curren tp osition; n:no horizon talsmashing; default b ehaviourwhen hsmashis not specied. smash[=vpos hpos] combination ofvsmash=vposandhsmash=hpos; default behaviour iscc. vshift=len shifts the graphics up bylen. hshift=len shifts the graphics to the right bylen; has no eect unlesshsmashis activated. tmargin=len adds a top margin of heightlen; has no eect whenvsmashis activated. bmargin=len adds a bottom margin of heightlenbelow the baseline; has no eect whenvsmashis activated.4

The centre of the line appears to be (18/31)ex above the baseline which is at the centre of a capital

letter for the default font.

5The top of the line is dened as (36/31)ex above the baseline which is the height of a capital letter for

the default font. 5 vmargin=len adds a bottom and top margin of heightlen; has no eect whenvsmashis activated. lmargin=len adds a left margin of widthlen; has no eect whenhsmashis activated. rmargin=len adds a right margin of widthlen; has no eect whenhsmashis activated. hmargin=len adds a left and right margin of widthlen; has no eect whenhsmashis activated. margin=len adds an overall margin of lengthlenaround the graphics; has no eect whensmashis activated. In specifying lengths in the above arguments, there are two additional dimensions\gwidth and\gheightrepresenting the actual width and height of the included graphics. For ex- ample, one can add a horizontal margin of 10% of the size of the graphics by specifying hmargin=0.1\gwidth.

2.2 Package Options

The package provides one option:

nobeamer do not override the overlay processing of thebeamerclass for\includegraphics; as usual, graphics will occupy no space when covered.

3 Information

3.1 Copyright

Copyright

c

2013{2018 Niklas Beisert

This work may be distributed and/or modied under the conditions of the L

ATEX Project

Public License, either version 1.3 of this license or (at your option) any later version. The latest version of this license is inhttp://www.latex-project.org/lppl.txtand version

1.3 or later is part of all distributions of L

ATEX version 2005/12/01 or later.

This work has the LPPL maintenance status `maintained'. The Current Maintainer of this work is Niklas Beisert. This work consists of the lesREADME.txt,graphbox.insandgraphbox.dtxas well as the derived lesgraphbox.sty,gboxsamp.texwithgboxsamp.mpsandgraphbox.pdf.

3.2 Files and Installation

The package consists of the les

README.txtreadme le

graphbox.insinstallation le graphbox.dtxsource le graphbox.stypackage le gboxsamp.texsample le gboxsamp.mpssample gure graphbox.pdfmanual 6 The distribution consists of the lesREADME.txt,graphbox.insandgraphbox.dtx. Run (pdf)LATEX ongraphbox.dtxto compile the manualgraphbox.pdf(this le). Run LATEX ongraphbox.insto create the packagegraphbox.styand the sample consisting ofgboxsamp.texandgboxsamp.mps. Copy the legraphbox.styto an ap- propriate directory of your L ATEX distribution, e.g.texmf-root/tex/latex/graphbox.

3.3 Interaction with CTAN Packages

Thegraphboxpackage extends the packagegraphicx. It also changes some functionality of the classbeamerif present: Compatibility with thegraphicxpackage has been tested with v1.0f (1999/02/16) and v1.0g (2014/04/25). The changes of functionality are described in section1.3 . Compatibility with the beamerclass has been tested with v3.33 (2013/12/25).

3.4 Revision History

v1.1:2018/01/17 hooked deeper into\includegraphicschain manual rearranged minor internal changes v1.0:2014/08/31 added further placement options manual and installation package added rst version published on CTAN v0.8:2014/08/25 basic functionality

A Sample File

In this section we provide a L

ATEX example how to use some of thegraphboxextensions to graphicx. Preamble:

1\documentclass[12pt]{article}

2

3\usepackage[margin=2cm]{geometry}

4\usepackage{graphicx}

5\usepackage{graphbox}

The macro\sample{options}prints a block demonstrating the ow of text testing the new \includegraphicsargumentsoptions: 7 options:options

XXXXXX XXXXXX

XXXXXX XXXXXX

XXXXXX

@@@XXXXXX

XXXXXX XXXXXX

XXXXXX XXXXXXThe box indicates the resulting bounding box of the\includegraphicscommand. It is dened as follows:quotesdbs_dbs29.pdfusesText_35

[PDF] figure cote a cote latex

[PDF] légende image latex

[PDF] apprendre 20 pages en 1 jour

[PDF] apprendre 40 pages en 1 jour

[PDF] apprendre 100 pages en 2 jours

[PDF] comment apprendre par coeur rapidement

[PDF] apprendre 50 pages en un jour

[PDF] méthodologie de recherche définition

[PDF] définition de la méthodologie

[PDF] proverbe qui cherche trouve

[PDF] citation trouver

[PDF] qui cherche trouve citation

[PDF] on ne trouve que ce que lon cherche

[PDF] cherche des proverbes

[PDF] citation pourquoi chercher ailleurs