Debian Codegraph @

texmf-dist/doc/latex/miniplot/miniplot.tex

raw
1
2
3
4 \documentclass[12pt,a4paper]{article}
5
6 % needed packages
7 \usepackage{calc}
8 \usepackage{ifthen}
9 \usepackage{graphics}
10 \usepackage{epsfig}
11 \usepackage{miniplot}
12
13 % supplementary packages
14 \usepackage{wrapfig}
15 \usepackage{subfigure}
16 \usepackage{rotfloat}
17
18 %\usepackage{showkeys}
19 \usepackage{flafter}
20
21 % personal adjustments
22 \newcommand{\comm}[1]{\texttt{#1}}
23 \renewcommand{\floatpagefraction}{0.8} % default = 0.5, see "The LaTeX Companion, page 142
24 \setcounter{plotFigures}{1}
25
26
27 \begin{document}
28
29 %\pagestyle{myheadings}
30 %\markright{Section \thesection}
31
32 \title{MiniPlot -- A Package For Easy Figure Arrangements\footnote{Version 0.3}}
33 \author{Tobias Wahl\footnote{I'd like to thank all the people helping me in \comm{comp.text.tex}
34 for answering my dull questions.}}
35 \date{1st July 2001}
36 \maketitle
37
38
39 \begin{abstract}
40 MiniPlot is a package to help \LaTeX's user to typeset eps figures
41 using an easy-to-use command-interface.
42
43 Figures can easily be arranged as one-figure-only or as a collection of
44 figure in columns and rows which can contain itself sub-figures in
45 columns and rows. Also wrapped and sideways figures are supported.
46
47 This package provides commands to display a framebox instead of
48 the figure as the graphics package does already but additionally
49 it writes useful information such as the label and scaling factor
50 into these boxes. The content of these boxes can be customized.
51 \end{abstract}
52
53 \tableofcontents
54
55
56 %=================================================================
57 \section{Motivation}
58
59 This section is to show what MiniPlot is about. MiniPlot is a
60 strong tool for plotting multiple figures and sub-figure as the
61 following figures show. It's easy to use interface allows easy and
62 fast access to professional looking figure presentation.
63
64
65 \begin{arrangedFigure}{2}{2}{arrangedO521}{left sub-figure}
66 \subFig[]{figures/1}%
67 \subFig[]{figures/2}%
68 \subFig[This is a very long sub-sub-caption]{figures/3}%
69 \subFig[]{figures/4}%
70 \newSubFig{arrangedO522}{right sub-figure}
71 \subFig[]{figures/1}%
72 \subFig[]{figures/2}%
73 \subFig[]{figures/3}%
74 \subFig[]{figures/4}%
75 \setlength{\subFigureAboveCaptionSpace}{7mm}
76 \end{arrangedFigure}
77 \setlength{\subFigureAboveCaptionSpace}{0mm}
78
79
80 \begin{arrangedFigure}{1}{4}{arrangedO1521}{top sub-figure}
81 \subFig[]{figures/1}%
82 \subFig[]{figures/2}%
83 \subFig[]{figures/3}%
84 \subFig[]{figures/4}%
85 \newSubFig{arrangedO1522}{bottom sub-figure}
86 \subFig[]{figures/1}%
87 \subFig[]{figures/2}%
88 \subFig[]{figures/3}%
89 \subFig[]{figures/4}%
90 \end{arrangedFigure}
91
92
93 \begin{arrangedFigure}{2}{3}{arrangedO31}{top left}
94 \subFig{figures/1}%
95 \subFig{figures/2}%
96 \subFig{figures/3}%
97 \subFig{figures/4}%
98 \subFig{figures/1}%
99 \subFig{figures/2}%
100 \newSubFig{arrangedO32}{top right}
101 \subFig{figures/1}%
102 \subFig{figures/2}%
103 \subFig{figures/3}%
104 \subFig{figures/4}%
105 \subFig{figures/1}%
106 \subFig{figures/2}%
107 \newSubFig{arrangedO33}{bottom}
108 \subFig{figures/1}%
109 \subFig{figures/2}%
110 \subFig{figures/3}%
111 \subFig{figures/4}%
112 \subFig{figures/1}%
113 \subFig{figures/2}%
114 \end{arrangedFigure}
115
116
117
118 \clearpage
119
120 %=================================================================
121
122
123
124 %----------------------------------------------------------------
125 \section{Loading the packages}
126
127 In order to run MiniPlot the following lines are needed in the \LaTeX
128 file
129
130
131 \begin{verbatim}
132 % needed packages
133 \usepackage{calc}
134 \usepackage{ifthen}
135 \usepackage{graphics}
136 \usepackage{epsfig}
137 \usepackage{miniplot}
138
139 % supplementary packages
140 \usepackage{wrapfig}
141 \usepackage{subfigure}
142 \usepackage{rotfloat}
143
144 % personal adjustments
145 %\setcounter{plotFigures}{0}
146 \renewcommand{\floatpagefraction}{0.8}
147 \end{verbatim}
148
149 The wrapfigure package is only needed when one uses the wrapfigure
150 features of MiniPlot. The subfigure package is certainly something
151 one might include since this gives access to the \comm{arrangedFigure}
152 environment, the most powerful feature of this package.
153 Rotfloat, and rotating which is loaded by rotfloat, is needed when one
154 likes to use the side-way-figure capabilities of MiniPlot.
155 I recommend to install all packages.
156
157 Putting the line \comm{setcounter\{plotFigures\}\{0\}} is not necessary but is
158 recomended for editing a document with loads of figures or when one likes
159 to obtain the label of figures for refences. Enable this line when you learned
160 how to deal with this package.
161
162 The last line is very much my own personal style and not needed for using
163 MiniPlot.
164
165
166
167 %----------------------------------------------------------------
168 \section{Including single figures}
169
170 The problem is how to arrange your eps figures efficiently in you
171 document. The answer is given by MiniPlot. This section is
172 included to provide an overview over the capabilities of MiniPlot.
173
174 We start with a simple implementation of a single eps figure as
175 shown in Figure \ref{fig:singleSimple}, the simple implementation
176 is given by
177
178 \begin{verbatim} \includeEps{figures/1}{Simple figure included
179 with scaling factor equals one.}{singleSimple}{1} \end{verbatim}
180
181 \includeEps{figures/1}{Simple figure included with scaling factor
182 equals one.}{singleSimple}{1}
183
184 Note that the label is given without \comm{fig:}. The general
185 parameters are
186
187 \begin{verbatim}
188 \includeEps[htpb]{path}{label}{caption}{scaling factor}
189 \end{verbatim}
190
191 Now imagine one has one type of figure which occurs very often in
192 the document. Then the user could use the following command
193
194 \begin{verbatim} \includeStandardGraph[htpb]{path}{label}{caption}
195 \end{verbatim}
196
197 where the standard scaling factor can be set generally for all
198 the figures included by this command. The default is
199
200 \begin{verbatim} \renewcommand{\standardGraphScale}{1}
201 \end{verbatim}
202
203 \includeStandardGraph{figures/1}{Simple figure included with
204 scaling factor calculated to scale figure to meet specified
205 width.}{singleStandard}
206
207 However, by default this value is not used but the figure is
208 scaled to achieve the width equal to the length of the following
209 variable.
210
211 \begin{verbatim} \setlength{\myStandardFigureWidth}{\linewidth}
212 \end{verbatim}
213
214 If the figures are scaled to the width above or if a standard
215 scaling factor is assumed depends on the following counter
216
217 \begin{verbatim} \setcounter{scaleToStandardFigureWidth}{1}
218 \end{verbatim}
219
220 Set \comm{1} to to scale to standard-figure-width or \comm{0} to
221 use standard-graph-scale.
222
223 Additionally one can set if each figure is to be scaled
224 individually or if the scaling factor is to be calculated at the
225 first time the include-standard-graph command is stated
226
227 \begin{verbatim} \setcounter{scaleFigureIndividual}{1}
228 \end{verbatim}
229
230 Set \comm{1} to to scale individually or \comm{0} to use scaling
231 factor calculated when inserting the first standard-graph.
232
233 When we now include a figure using the command for standard
234 figures
235
236 \begin{verbatim} \includeStandardGraph{figures/1}{Simple figure
237 included with scaling factor calculated to scale figure to meet
238 specified width.}{singleStandard}
239 \end{verbatim}
240
241 we obtain a figure scaled to the specified width in Figure
242 \ref{fig:singleStandard}.
243
244 To show the use of the counter \comm{plotFigures} we set
245
246 \begin{verbatim}
247 \setcounter{plotFigures}{0}
248
249 \includeStandardGraph{figures/1}{Simple figure included with
250 scaling factor calculated to scale figure to meet specified
251 width.}{singleStandard2}
252
253 \setcounter{plotFigures}{1}
254 \end{verbatim}
255
256 to obtain Figure \ref{fig:singleStandard2}. We can see that the
257 scaling factor is no more equals one. Other usefull information
258 is given by the label.
259
260 \setcounter{plotFigures}{0}
261 \includeStandardGraph{figures/1}{Simple figure included with
262 scaling factor calculated to scale figure to meet specified
263 width.}{singleStandard2}
264 \setcounter{plotFigures}{1}
265
266 Of course, there is also a side-ways version of a figure, see
267 Figure \ref{fig:singleStandard3}. This figure is implemented using
268 the include-standard-side-ways-graph command.
269
270 \begin{verbatim}
271 \setcounter{plotFigures}{0}
272
273 \includeStandardSideWaysGraph{figures/1}{Simple figure included with
274 scaling factor calculated to scale figure to meet specified in width
275 in side-ways-mode.}{singleStandard3}
276
277 \setcounter{plotFigures}{1}
278 \end{verbatim}
279
280 \setcounter{plotFigures}{0}
281 \includeStandardSideWaysGraph{figures/1}{Simple figure included with
282 scaling factor calculated to scale figure to meet specified
283 width in side-ways-mode.}{singleStandard3}
284 \setcounter{plotFigures}{1}
285
286 Note that the width of the side-ways-figure is now determined by
287
288 \begin{verbatim}
289 \setlength{\myStandardSideWaysFigureWidth}{\textheight}
290 \end{verbatim}
291
292 Note that there is also an include-side-ways-eps command where
293 you have to set a scaling factor.
294
295 The user can customize the width of the caption relative to the figure's width
296 simply by changing the folowing length.
297
298 \begin{verbatim}
299 \setlength{\captionWidthPenalty}{0mm}
300 \end{verbatim}
301
302 Setting this length has only an effect to the figures which are introduced as a single
303 figure
304
305 \begin{itemize}
306 \item \verb+\includeEps+
307 \item \verb+\includeEpsNow+
308 \item \verb+\includeSideWaysEps+
309 \item \verb+\includeSideWaysEpsNow+
310 \item \verb+\includeStandardGraph+
311 \item \verb+\includeStandardGraphNow+
312 \item \verb+\includeStandardSideWaysGraph+
313 \item \verb+\includeStandardSideWaysGraphNow+
314 \end{itemize}
315
316 It has no effect to the wrapped figure environments and the arranged figure environments.
317
318 Normally the captions of the listed figure commands and environments have the
319 width of the figure. In case the figure's width is smaller than a specified value
320 then it will be set to the defined caption minimum width
321
322 \begin{verbatim}
323 \setlength{\minimumCaptionWidth}{\linewidth * 4 / 6}
324 \setlength{\minimumSideWaysCaptionWidth}{\textheight * 4 / 6}
325 \end{verbatim}
326
327
328
329 \clearpage
330
331
332
333
334
335
336
337
338 %----------------------------------------------------------------
339 \section{Including arranged sub-figures and sub-sub-figures}
340
341
342 The content of this subsection is the generation of figures which can
343 consist of several columns and rows of figures with their own caption
344 (Figure ...), I will call these figures sub-figures.
345
346 Inside these sub-figures can now be arranged several columns and rows of
347 sub-sub-figures. These are placed using the subfigure package.
348
349 A simple example might be given by Figure \ref{fig:arranged11} to \ref{fig:arranged12}
350
351 \begin{verbatim}
352 \begin{arrangedFigure}{2}{2}{arranged11}{This is the left
353 sub-figure of an arranged figure.}
354 \subFig{figures/1}%
355 \subFig{figures/2}%
356 \subFig{figures/3}%
357 \subFig{figures/4}%
358 \newSubFig{arranged12}{This is the right sub-figure of an
359 arranged figure.}
360 \subFig{figures/1}%
361 \subFig{figures/2}%
362 \subFig{figures/3}%
363 \subFig{figures/4}%
364 \end{arrangedFigure}
365 \end{verbatim}
366
367 \begin{arrangedFigure}{2}{2}{arranged11}{This is the left sub-figure of an arranged figure.}
368 \subFig{figures/1}%
369 \subFig{figures/2}%
370 \subFig{figures/3}%
371 \subFig{figures/4}%
372 \newSubFig{arranged12}{This is the right sub-figure of an arranged figure.}
373 \subFig{figures/1}%
374 \subFig{figures/2}%
375 \subFig{figures/3}%
376 \subFig{figures/4}%
377 \end{arrangedFigure}
378
379 The first parameter to the \comm{arrangedFigure} environment is the number of
380 columns of sub-figures, the second one specifies the number of columns of
381 sub-sub-figures. The next parameters is the label and then the caption to the immediate
382 following sub-figures.
383
384 The command \comm{subFig} should actually be called \comm{subSubFig} since it inserts the
385 sub-sub-figure specified by the path of the figure to be included. \emph{It is important to
386 enter the \%-signs after the \comm{subFig} command in order to avoid introducing
387 undesired horizontal spaces between the sub-sub-figures.}
388
389 The command \comm{newSubFig} opens the next que to fill up a sub-figure with sub-sub-figures.
390 The parameter is the label and the caption for the immediately following sub-figure.
391
392 Another example could be given by Figure \ref{fig:arranged2}
393
394 \begin{verbatim}
395 \begin{arrangedFigure}{1}{4}{arranged2}{This is the
396 only sub-figure of an arranged figure.}
397 \subFig[]{figures/1}%
398 \subFig[]{figures/2}%
399 \subFig[]{figures/3}%
400 \subFig[]{figures/4}%
401 \end{arrangedFigure}
402 \end{verbatim}
403
404
405 \begin{arrangedFigure}{1}{4}{arranged2}{This is the only sub-figure of an arranged figure.}
406 \subFig[]{figures/1}%
407 \subFig[]{figures/2}%
408 \subFig[]{figures/3}%
409 \subFig[]{figures/4}%
410 \end{arrangedFigure}
411
412 Note that the number of columns of sub-figures changed to one and that we arrange four
413 sub-sub-figures in the width of one sub-figure column.
414
415 Additionally, the \comm{subFig} command got now an empty optional command leading to the indexing
416 of the sub-sub-figures from a to d. This behavior is identically with the one of the
417 subfigure package\footnote{The only exception is that if one enters \comm{[noParMiniPlot]} it would be
418 as if no optional parameter is given. This shouldn't be a major problem since there might be little
419 desire to have a caption like \comm{(a)noParMiniPlot} .}.
420
421 To complete a list of examples a last one is given by Figure \ref{fig:arranged31} to
422 \ref{fig:arranged33}
423
424
425
426 \begin{verbatim}
427 \renewcommand{\subfigbottomskip}{0pt}%
428 \renewcommand{\subfigcapskip}{0pt}%
429 \renewcommand{\subcapsize}{\scriptsize}%
430
431 \begin{arrangedFigure}{2}{4}{arranged31}{top left}
432 \subFig[]{figures/1}%
433 \subFig[]{figures/2}%
434 \subFig[]{figures/3}%
435 \subFig[]{figures/4}%
436 \subFig[]{figures/1}%
437 \subFig[]{figures/2}%
438 \newSubFig{arranged32}{top right}%
439 \subFig[]{figures/1}%
440 \subFig[]{figures/2}%
441 \subFig[]{figures/3}%
442 \subFig[]{figures/4}%
443 \subFig[]{figures/1}%
444 \subFig[]{figures/2}%
445 \newSubFig{arranged33}{bottom}%
446 \subFig[]{figures/1}%
447 \subFig[]{figures/2}%
448 \subFig[]{figures/3}%
449 \subFig[]{figures/4}%
450 \subFig[]{figures/1}%
451 \subFig[]{figures/2}%
452 \subFig[]{figures/3}%
453 \subFig[]{figures/4}%
454 \end{arrangedFigure}
455
456 \renewcommand{\subfigbottomskip}{10pt}%
457 \renewcommand{\subfigcapskip}{10pt}%
458 \renewcommand{\subcapsize}{\footnotesize}%
459 \end{verbatim}
460
461 The redefinition of commands introduced by the subfigure package makes the figure
462 look nicer but are not necessary to run the code. After the redefinition they are reset to
463 their default values.
464
465 In this figure we have an odd ratio of sub-figures to sub-figure-columns
466 and we see that the remaining sub-figure \ref{fig:arranged33} is shifted
467 to the right.
468
469 The same happens to the sub-sub-figures included in the bottom row of
470 sub-figures \ref{fig:arranged31} and \ref{fig:arranged32}.
471
472
473 \renewcommand{\subfigbottomskip}{0pt}%
474 \renewcommand{\subfigcapskip}{0pt}%
475 \renewcommand{\subcapsize}{\scriptsize}%
476
477 \begin{arrangedFigure}{2}{4}{arranged31}{top left}
478 \subFig[]{figures/1}%
479 \subFig[]{figures/2}%
480 \subFig[]{figures/3}%
481 \subFig[]{figures/4}%
482 \subFig[]{figures/1}%
483 \subFig[]{figures/2}%
484 \newSubFig{arranged32}{top right}
485 \subFig[]{figures/1}%
486 \subFig[]{figures/2}%
487 \subFig[]{figures/3}%
488 \subFig[]{figures/4}%
489 \subFig[]{figures/1}%
490 \subFig[]{figures/2}%
491 \newSubFig{arranged33}{bottom}
492 \subFig[]{figures/1}%
493 \subFig[]{figures/2}%
494 \subFig[]{figures/3}%
495 \subFig[]{figures/4}%
496 \subFig[]{figures/1}%
497 \subFig[]{figures/2}%
498 \subFig[]{figures/3}%
499 \subFig[]{figures/4}%
500 \end{arrangedFigure}
501
502 \renewcommand{\subfigbottomskip}{10pt}%
503 \renewcommand{\subfigcapskip}{10pt}%
504 \renewcommand{\subcapsize}{\footnotesize}%
505
506
507 The reader certainly notices that it takes longer to load the page when a lot
508 of sub-sub-figures are arranged, Figure \ref{fig:arranged41} to \ref{fig:arranged42}.
509 This is an important reason to set the counter \comm{plotFigures} to zero to save
510 time when browsing through a document on the computer.
511
512 As another example an arranged-side-ways-figure is shown, Figure \ref{fig:arranged41}.
513
514 \begin{verbatim}
515 \setcounter{plotFigures}{0}
516
517 \begin{arrangedSideWaysFigure}{2}{2}{arranged41}{left sub-figure}
518 \subFig[]{figures/1}%
519 \subFig[]{figures/2}%
520 \subFig[]{figures/3}%
521 \subFig[]{figures/4}%
522 \newSubFig{arranged42}{right sub-figure}
523 \subFig[]{figures/1}%
524 \subFig[]{figures/2}%
525 \subFig[]{figures/3}%
526 \subFig[]{figures/4}%
527 \end{arrangedSideWaysFigure}
528
529 \setcounter{plotFigures}{1}
530 \end{verbatim}
531
532
533
534 \setcounter{plotFigures}{0}
535 \begin{arrangedSideWaysFigure}{2}{2}{arranged41}{left sub-figure}
536 \subFig[]{figures/1}%
537 \subFig[]{figures/2}%
538 \subFig[]{figures/3}%
539 \subFig[]{figures/4}%
540 \newSubFig{arranged42}{right sub-figure}
541 \subFig[]{figures/1}%
542 \subFig[]{figures/2}%
543 \subFig[]{figures/3}%
544 \subFig[]{figures/4}%
545 \end{arrangedSideWaysFigure}
546 \setcounter{plotFigures}{1}
547
548
549 That this page loads faster is not the only difference one can notice. The label for
550 reference is now added below the caption in order to be easier accessible. A disadvantage
551 is that an extra space might be included and that might influence the document layout. In order to
552 compensate for that effect the following length has been introduced
553
554 \begin{verbatim}
555 \setlength{\labelPenalty}{-1.5mm}
556 \end{verbatim}
557
558 which is valid if the following command is design to produce a single line in small font.
559
560 \begin{verbatim}
561 \newcommand{\printLabel}[1]{\centerline{\small{\emph{Label}: \texttt{fig:#1}}}}
562 \end{verbatim}
563
564 If one redefines \verb+\printLabel+ one has to figure out what value might be appropriate
565 for \verb+\labelPenalty+.
566
567 Furthermore, only the most basic information is included in the frameboxes. This is
568 because the arranged sub-sub-figures can become quiet small. First the basic filename
569 without path is contained. In the next row the scaling factor is shown, than the suffix
570 to the label shown below the sub-fig caption is included.
571
572 So far referencing to sub-sub-figures does not work but as soon as someone tells me how
573 to extract \comm{a} fromm \comm{(a)}, which comes from the \verb+\thesubfigure+ command, I
574 would like to implement that. :)
575
576
577 \clearpage
578
579
580
581
582
583
584
585
586 %----------------------------------------------------------------
587 \section{Including wrapped figures}
588
589
590 The use of the include-Eps-Wrap command is similar to the
591 include-Eps command. By writing
592
593 \setWrapFigOverhang[2cm]
594 \includeEpsWrap[20]{l}{figures/wrapMe}{Example of an wrapped figure}{wrappedFigure1}{1}
595 \setWrapFigOverhang
596
597 \begin{verbatim}
598 \setWrapFigOverhang[2cm]
599 \includeEpsWrap[20]{l}{figures/wrapMe}{Example of an
600 wrapped figure}{wrappedFigure1}{1}
601 \setWrapFigOverhang
602 \end{verbatim}
603
604 we obtain Figure \ref{fig:wrappedFigure1}.
605
606 The general form is given by
607
608 \begin{verbatim}
609 \includeEpsWrap[lines]{side}{path}
610 {caption}{label}{scaling factor}
611 \end{verbatim}
612
613 where \comm{lines} stands for the number of narrow lines and \comm{side} stands
614 for left (\comm{l}) or right (\comm{r}) as specified in the documentation of the
615 wrapfig package.
616
617 The command \verb+setWrapFigOverhang+ sets the wrap figures overhang to the given optinal
618 parameter. Calling this command without a parameter resets the overhang to its default value
619
620 \begin{verbatim}
621 \setlength{\wrapFigOverhangDefault}{0mm}
622 \end{verbatim}
623
624 Of course, if the counter \comm{plotFigures} equals 0 then this figure is
625 replaced by a framebox containing some useful information:
626
627 \begin{verbatim}
628 \setcounter{plotFigures}{0}
629 \includeEpsWrap[20]{l}{figures/wrapMe}
630 {Example of an wrapped figure}
631 {wrappedFigure2}{1}
632 \setcounter{plotFigures}{1}
633 \end{verbatim}
634
635 The counter \comm{plotFigures} is inteded to be \comm{0} in
636 draft mode to improve browsing speed through the document and
637 to provide information for referencing. However, when a figure
638 is to be implemented the first time one likes to see the result.
639 This can be done without changing the counter \comm{plotFigures}.
640 Simply one can add the term \comm{Now} to any command provided
641 to include figures. Therefore the following command would show the
642 figure and not the framebox:
643 %
644 \begin{arrangedWrapFigure}[15]{l}{3cm}{1}{2}{arranged511w}{top sub-figure}
645 \subFig[]{figures/1}%
646 \subFig[]{figures/2}%
647 \subFig[]{figures/3}%
648 \subFig[]{figures/4}%
649 \newSubFig{arranged512w}{bottom sub-figure}
650 \subFig[]{figures/1}%
651 \subFig[]{figures/2}%
652 \subFig[]{figures/3}%
653 \subFig[]{figures/4}%
654 \end{arrangedWrapFigure}
655
656 \begin{verbatim}
657 \setcounter{plotFigures}{0}
658 \includeEpsWrapNow{l}{figures/wrapMe}
659 {Example of an wrapped figure}
660 {wrappedFigure3}{1}
661 \setcounter{plotFigures}{1}
662 \end{verbatim}
663
664 To customize the figure there is the width which is added to the wrapped figure
665 in oder to have some space between figure and text
666
667 \begin{verbatim}
668 \setlength{\extraWrapWidth}{2mm}
669 \end{verbatim}
670
671 The space above the wrapped figure is set to be
672
673 \begin{verbatim}
674 \setlength{\aboveWrapFigureSpace}{0mm}
675 \end{verbatim}
676
677 The space below the wrapped figure can be set, obviously, by setting
678 the number of \comm{linnes} in the optional parameter.
679
680
681
682
683
684
685
686
687 %----------------------------------------------------------------
688 \section{Including wrapped-arranged figures}
689
690
691 To include arranged figures in an wrapped figure environment one has to use the
692 following environment, \comm{arrangedWrapFigure}
693
694 \begin{verbatim}
695 \begin{arrangedWrapFigure}[15]{l}{3cm}{1}{2}
696 {arranged511w}{top sub-figure}
697 \subFig[]{figures/1}%
698 \subFig[]{figures/2}%
699 \subFig[]{figures/3}%
700 \subFig[]{figures/4}%
701 \newSubFig{arranged512w}{bottom sub-figure}
702 \subFig[]{figures/1}%
703 \subFig[]{figures/2}%
704 \subFig[]{figures/3}%
705 \subFig[]{figures/4}%
706 \end{arrangedWrapFigure}
707 \end{verbatim}
708
709 The general form is given by
710
711 \begin{verbatim}
712 \begin{arrangedWrapFigure}[lines]{position}{width}
713 {sub-columns}{sub-sub-columns}
714 {label}{caption}
715 \end{arrangedWrapFigure}
716 \end{verbatim}
717
718
719
720
721
722
723
724
725
726 \clearpage
727
728
729
730
731
732
733
734
735
736 %----------------------------------------------------------------
737 \section{Customizing arranged figures}
738
739 As for the single figures the widths of the arranged-figure and
740 arranged-side-ways-figure environments are given by
741
742 \begin{verbatim}
743 \setlength{\myStandardFigureWidth}{\linewidth}
744 \setlength{\myStandardSideWaysFigureWidth}{\textheight}
745 \end{verbatim}
746
747 For cutomizing purposes one should know that the space between
748 each sub-figure is specified by
749
750 \begin{verbatim}
751 \setlength{\interSubFigSpace}{8mm}
752 \end{verbatim}
753
754 whereas the space between each sub-sub-figure is specified by
755
756 \begin{verbatim}
757 \setlength{\interSubSubFigSpace}{2.5mm}
758 \end{verbatim}
759
760 The horizontal positioning of the numbers of sub-sub-figures,
761 \emph{(a)-(..)}, can be changed by changing the following length
762 which default value is
763
764 \begin{verbatim}
765 \setlength{\subCaptionPenalty}{0mm}
766 \end{verbatim}
767
768 This has only an effect if the \comm{subFig} command is issued with
769 an empty optional parameter. Otherwise the subfigure package's default
770 value will be assumed: \verb+\renewcommand{\subfigcapmargin}{10pt}+.
771
772 If a sub-sub-caption is given as in the following example
773
774 \begin{verbatim}
775 \begin{arrangedFigure}{2}{2}{arranged511}{left sub-figure}
776 \subFig[]{figures/1}%
777 \subFig[]{figures/2}%
778 \subFig[This is a very long sub-sub-caption]{figures/3}%
779 \subFig[]{figures/4}%
780 \newSubFig{arranged512}{right sub-figure}
781 \subFig[]{figures/1}%
782 \subFig[]{figures/2}%
783 \subFig[]{figures/3}%
784 \subFig[]{figures/4}%
785 \end{arrangedFigure}
786 \end{verbatim}
787
788 \begin{arrangedFigure}{2}{2}{arranged511}{left sub-figure}
789 \subFig[]{figures/1}%
790 \subFig[]{figures/2}%
791 \subFig[This is a very long sub-sub-caption]{figures/3}%
792 \subFig[]{figures/4}%
793 \newSubFig{arranged512}{right sub-figure}
794 \subFig[]{figures/1}%
795 \subFig[]{figures/2}%
796 \subFig[]{figures/3}%
797 \subFig[]{figures/4}%
798 \newSubFig{arranged521}{left sub-figure}
799 \subFig[]{figures/1}%
800 \subFig[]{figures/2}%
801 \subFig[This is a very long sub-sub-caption]{figures/3}%
802 \subFig[]{figures/4}%
803 \newSubFig{arranged522}{right sub-figure}
804 \subFig[]{figures/1}%
805 \subFig[]{figures/2}%
806 \subFig[]{figures/3}%
807 \subFig[]{figures/4}%
808 \setlength{\subFigureAboveCaptionSpace}{7mm}
809 \end{arrangedFigure}
810 \setlength{\subFigureAboveCaptionSpace}{0mm}
811
812
813 then the following length can be set in order to compensate for the extra space
814
815 \begin{verbatim}
816 \begin{arrangedFigure}{2}{2}{arranged51}{left sub-figure}
817 \subFig[]{figures/1}%
818 \subFig[]{figures/2}%
819 \subFig[This is a very long sub-sub-caption]{figures/3}%
820 \subFig[]{figures/4}%
821 \newSubFig{arranged52}{right sub-figure}
822 \subFig[]{figures/1}%
823 \subFig[]{figures/2}%
824 \subFig[]{figures/3}%
825 \subFig[]{figures/4}%
826 \setlength{\subFigureAboveCaptionSpace}{7mm} % watch this
827 \end{arrangedFigure}
828 \setlength{\subFigureAboveCaptionSpace}{0mm} % watch this
829 \end{verbatim}
830
831
832 with a resulting Figure \ref{fig:arranged521} and \ref{fig:arranged522}.
833
834 If the figure looks like Figure \ref{fig:arranged5311} and \ref{fig:arranged5312}
835 then one could set
836
837 \begin{verbatim}
838 \begin{arrangedFigure}{2}{2}{arranged531}{left sub-figure}
839 \subFig[]{figures/1}%
840 \subFig[This is a very long sub-sub-caption]{figures/2}%
841 \subFig[]{figures/3}%
842 \subFig[]{figures/4}%
843 \newSubFig{arranged532}{right sub-figure}
844 \setlength{\horizontalSubSubFigSpace}{4mm} % watch this
845 \subFig[]{figures/1}%
846 \subFig[]{figures/2}%
847 \setlength{\horizontalSubSubFigSpace}{-1mm} % watch this
848 \subFig[]{figures/3}%
849 \subFig[]{figures/4}%
850 \end{arrangedFigure}
851 \end{verbatim}
852
853 to achieve Figure \ref{fig:arranged531} and \ref{fig:arranged532}.
854
855
856
857 \begin{arrangedFigure}{2}{2}{arranged5311}{left sub-figure}
858 \subFig[]{figures/1}%
859 \subFig[This is a very long sub-sub-caption]{figures/2}%
860 \subFig[]{figures/3}%
861 \subFig[]{figures/4}%
862 \newSubFig{arranged5312}{right sub-figure}
863 \subFig[]{figures/1}%
864 \subFig[]{figures/2}%
865 \subFig[]{figures/3}%
866 \subFig[]{figures/4}%
867 \newSubFig{arranged531}{left sub-figure}
868 \subFig[]{figures/1}%
869 \subFig[This is a very long sub-sub-caption]{figures/2}%
870 \subFig[]{figures/3}%
871 \subFig[]{figures/4}%
872 \newSubFig{arranged532}{right sub-figure}
873 \setlength{\horizontalSubSubFigSpace}{4mm}
874 \subFig[]{figures/1}%
875 \subFig[]{figures/2}%
876 \setlength{\horizontalSubSubFigSpace}{-1mm}
877 \subFig[]{figures/3}%
878 \subFig[]{figures/4}%
879 \end{arrangedFigure}
880
881
882
883 Another parameter for modifying the look is given by
884
885 \begin{verbatim}
886 \setlength{\subFigureBelowCaptionSpace}{5mm}
887 \end{verbatim}
888
889 which sets the space below the main sub-figure caption and the next
890 main sub-figure below it.
891
892 After all, it might be difficult to reset every variable on its
893 own and to remenber their default values. Therefore, the
894 command \comm{resetMiniPlot} has been introduced. This
895 sets variables and commands to their default values. Note
896 that the counter \comm{plotFigures} is not reset. A listing
897 of the definition is given below.
898
899
900 \begin{verbatim}
901 \newcommand{\resetMiniPlot}%
902 {%
903 \setcounter{printCaption}{1}%
904 \setcounter{scaleToStandardFigureWidth}{1}%
905 \setcounter{isFirstStandardFigure}{1}%
906 \setcounter{scaleFigureIndividual}{1}%
907 \setlength{\extraWrapWidth}{2mm}%
908 \setlength{\aboveWrapFigureSpace}{0mm}%
909 \setlength{\frameBoxPenalty}{2.4mm}%
910 \setlength{\myStandardFigureWidth}{\linewidth}%
911 \setlength{\myStandardSideWaysFigureWidth}{\textheight}%
912 \setlength{\subFigPenalty}{0mm}%
913 \setlength{\subSubFigPenalty}{0.001mm}%
914 \setlength{\interSubFigSpace}{8mm}%
915 \setlength{\interSubSubFigSpace}{2.5mm}%
916 \setlength{\subFigureAboveCaptionSpaceDefaultOffset}{0mm}%
917 \setlength{\subFigureAboveCaptionSpaceDefault}{0mm}%
918 \setlength{\subFigureAboveCaptionSpace}
919 {\subFigureAboveCaptionSpaceDefault
920 + \subFigureAboveCaptionSpaceDefaultOffset}%
921 \setlength{\horizontalSubSubFigSpace}{0mm}%
922 \setlength{\subFigureBelowCaptionSpace}{3mm}%
923 \setlength{\subCaptionPenalty}{0mm}%
924 \setlength{\minimumCaptionWidth}{\linewidth * 4 / 6}%
925 \setlength{\minimumSideWaysCaptionWidth}{\textheight * 4 / 6}%
926 \renewcommand{\standardGraphScale}{1}%
927 \renewcommand{\isFirstSubFig}{false}%
928 }%
929 \end{verbatim}
930
931 With this one could define a function to set one's own default values, e.g.
932
933 \begin{verbatim}
934 \necommand{\myResetMiniPlot}%
935 {%
936 \resetMiniPlot%
937 %
938 % personal settings:
939 \setlength{\myStandardFigureWidth}{\linewidth - 20mm}%
940 }
941 \end{verbatim}
942
943 \clearpage
944
945
946
947
948
949
950 %----------------------------------------------------------------
951 \section{Debugging arranged figures}
952
953 Normally it shouldn't be necessary to do any debugging but in case there is
954 I'd like to mention some tweaks here.
955
956 If unluky one might find something as shown in Figure \ref{fig:arranged51d} and
957 \ref{fig:arranged52d}.
958
959 \setlength{\subSubFigPenalty}{-1mm}
960
961 \begin{verbatim}
962 \begin{arrangedFigure}{2}{2}{arranged51d}{left sub-figure}
963 \subFig[]{figures/1}%
964 \subFig[]{figures/2}%
965 \subFig[]{figures/3}%
966 \subFig[]{figures/4}%
967 \newSubFig{arranged52d}{right sub-figure}
968 \subFig[]{figures/1}%
969 \subFig[]{figures/2}%
970 \subFig[]{figures/3}%
971 \subFig[]{figures/4}%
972 \end{arrangedFigure}
973 \end{verbatim}
974
975 \begin{arrangedFigure}{2}{2}{arranged51d}{left sub-figure}
976 \subFig[]{figures/1}%
977 \subFig[]{figures/2}%
978 \subFig[]{figures/3}%
979 \subFig[]{figures/4}%
980 \newSubFig{arranged52d}{right sub-figure}
981 \subFig[]{figures/1}%
982 \subFig[]{figures/2}%
983 \subFig[]{figures/3}%
984 \subFig[]{figures/4}%
985 \end{arrangedFigure}
986
987 From the coding shown above one would expect to yield two columns of sub-figures and
988 inside those again two columns of sub-sub-figures. However, Figure
989 \ref{fig:arranged51} to \ref{fig:arranged51} have only one column of
990 sub-sub-figures. This is because the sub-sub-figures plus the space
991 between them is too wide to fit into the width of the minipage environment
992 they are in. So, the figures are shifted down. This effect can be removed
993 by changing the following length which default value is
994
995 \begin{verbatim}
996 \setlength{\subSubFigPenalty}{0.001mm}
997 \end{verbatim}
998
999 \setlength{\subSubFigPenalty}{0.001mm}
1000
1001 Theoretical this value should be zero but due to numerical inaccuracies the
1002 sub-sub-figures have to be made a little bit narrower. The above length is to
1003 compensate for the numerical error.
1004
1005 By increasing the above length one can yield a satisfactory figure layout as
1006 can be seen in Figure \ref{fig:arranged51dd} and \ref{fig:arranged52dd}.
1007
1008 \begin{arrangedFigure}{2}{2}{arranged51dd}{left sub-figure}
1009 \subFig[]{figures/1}%
1010 \subFig[]{figures/2}%
1011 \subFig[]{figures/3}%
1012 \subFig[]{figures/4}%
1013 \newSubFig{arranged52dd}{right sub-figure}
1014 \subFig[]{figures/1}%
1015 \subFig[]{figures/2}%
1016 \subFig[]{figures/3}%
1017 \subFig[]{figures/4}%
1018 \end{arrangedFigure}
1019
1020
1021 Another case which is unlikely but not impossible to occur is that one has
1022 the displacment of the sub-sub-figures as described above but
1023 only when \comm{plotFigures} is equals zeros. That means the actual figures
1024 are alright but the frameboxes are shifted down. Then it is that
1025 the following length needs to be increased from its default value
1026
1027 \begin{verbatim}
1028 \setlength{\frameBoxPenalty}{2.4mm}
1029 \end{verbatim}
1030
1031 The reason is that the framebox is drawn around the actual size of the
1032 eps-figure, this space needs to be substracted again in order to obtain the
1033 actual figure size.
1034
1035
1036 \clearpage
1037
1038
1039
1040
1041
1042
1043
1044 %----------------------------------------------------------------
1045 \section{Customizing content of substituted framed boxes}
1046
1047 If the counter \comm{plotFigures} is set to be equals \comm{0} then a framed
1048 box with some information is shown. The commands to show information, however can
1049 be redefined in order to be more customizable for the user.
1050
1051 Three commands are used to disply the content for the different environments:
1052
1053 \begin{itemize}
1054 \item \verb+\epsContent[placement]{path}{caption}{label}{scaling}+\par\verb+{figure width}{figure height}+
1055 \item \verb+\arrangedFigContent[sub-sub-caption]{path}{figure width}+\par\verb+{figure height}+
1056 \item \verb+\wrappedEpsContent[lines]{position}{path}{caption}+\par\verb+{label}{scaling}{figure width}{figure height}+
1057 \end{itemize}
1058
1059 The first command prints the content to the single eps figures. First the \verb+\frameBoxPenaly+ is substracted
1060 from the figures height and width. Then a picture environment is created within a \comm{framebox}. The information
1061 is contained within a table. More information could be added or the whole structure completely renewed.
1062
1063 \begin{itemize}
1064 \item file name with path and extension
1065 \item scaling factor for this eps figure
1066 \item label of that figure
1067 \item position in terms of \comm{htbp}
1068 \end{itemize}
1069
1070 \begin{verbatim}
1071 \newcommand{\epsContent}[7][htpb]%
1072 {%
1073 \setlength{\figWidth}{#6 - \frameBoxPenalty}%
1074 \setlength{\figHeight}{#7 - \frameBoxPenalty}%
1075 %
1076 \setlength{\figTabWidth}{\figWidth - 31mm}%
1077 \setlength{\figTabMiddle}{\figHeight / 2}%
1078 %
1079 \centerline{\framebox{%
1080 %
1081 \setlength{\unitlength}{1sp}%%
1082 \begin{picture}(\number\figWidth,\number\figHeight)%%
1083 \put(655360,\number\figTabMiddle)%%
1084 {%
1085 \begin{tabular}{lp{\the\figTabWidth}}%
1086 \emph{Source:} & #2.eps \\%%
1087 \emph{Scaling:} & #5 \\%%
1088 \emph{Label:} & \labelPrefix#4 \\%%
1089 \emph{Position:} & #1%%
1090 \end{tabular}%
1091 }%
1092 \end{picture}%%
1093 }}%
1094 }%
1095 \end{verbatim}
1096
1097 The second command is to include the content for arranged figures. The structure is
1098 the same as in the above command. Because there is less space for arranged figures the
1099 content had to be shortend. The filename is shown without path and extension. Furthermore,
1100 there is nor description what the information is. Therefore this is listed here
1101
1102 \begin{itemize}
1103 \item base name of file without path and extension
1104 \item scaling factor for this eps figure
1105 \item suffix to be attached to the base label of that figure to refence this sub-sub-figure
1106 \end{itemize}
1107
1108 \begin{verbatim}
1109 \newcommand{\arrangedFigContent}[4][noParMiniPlot]%
1110 {%
1111 \setlength{\figWidth}{#3 - \frameBoxPenalty}%
1112 \setlength{\figHeight}{#4 - \frameBoxPenalty}%
1113 %
1114 \setlength{\figTabMiddle}{\figHeight / 2}%
1115 %
1116 \framebox{%
1117 \setlength{\unitlength}{1sp}%
1118 \tiny%
1119 \begin{picture}(\number\figWidth,\number\figHeight)%
1120 \put(0,\number\figTabMiddle)%%
1121 {%
1122 \begin{tabular}{p{\the\figWidth}}%
1123 \extractminiplotpath{#2} \\%%
1124 \subFigScale \\%%
1125 \subLabelSuffix%%
1126 \end{tabular}%
1127 }%
1128 \end{picture}%
1129 }%
1130 }%
1131 \end{verbatim}
1132
1133 The third and last command to determine the content of substituted figures is the one which can
1134 be seen in single-eps wrapped figures. Since I expect a wrapped figure rather high than wide I
1135 rotate the shown information by \comm{90} degrees. The information is
1136
1137 \begin{itemize}
1138 \item base name of file without path but with extension
1139 \item scaling factor for this eps figure
1140 \item label to this figure
1141 \end{itemize}
1142
1143 \begin{verbatim}
1144 \newcommand{\wrappedEpsContent}[8][noPar]%
1145 {%
1146 \setlength{\figWidth}{#7 - \frameBoxPenalty}%
1147 \setlength{\figHeight}{#8 - \frameBoxPenalty}%
1148 %
1149 \setlength{\figTabMiddle}{\figWidth / 2 - 6.6mm}%
1150 %
1151 \centerline{\framebox{%
1152 %
1153 \setlength{\unitlength}{1sp}%%
1154 \begin{picture}(\number\figWidth,\number\figHeight)%%
1155 \scriptsize%
1156 \put(\number\figTabMiddle,65536)%%
1157 {%
1158 \rotatebox{90}{%
1159 \begin{tabular}{p{\the\figHeight}}%
1160 \extractminiplotpath{#3}.eps \\%%
1161 #6 (scale) \\%%
1162 \labelPrefix#5 \\%%
1163 \end{tabular}%
1164 }%
1165 }%
1166 \end{picture}%%
1167 }}%
1168 }%
1169 \end{verbatim}
1170
1171
1172
1173
1174
1175
1176
1177 %----------------------------------------------------------------
1178 \section{Referencing to figures}
1179
1180 When passing on a lebal to a MiniPlot-function or environment it is not
1181 necessary to write \comm{fig:} or something else. When citing the reference,
1182 however, one needs to write that prefix. The prefix is defined by
1183
1184 \begin{verbatim}
1185 \newcommand{\labelPrefix}{fig:}
1186 \end{verbatim}
1187
1188 Suppose the label given to a figure is \comm{arranged51dd} then the actual label
1189 assign is \comm{fig:arranged51dd} and that is what needs to be referenced to
1190
1191 \begin{verbatim}
1192 ... see Figure \ref{fig:arranged51dd} ...
1193 \end{verbatim}
1194
1195 ... see Figure \ref{fig:arranged51dd}...\smallskip
1196
1197 Referencing to sub-sub-figures is implemented. The subfigures are labeled by, first the
1198 label prefix, second the base label given by the user and third the position in that specific
1199 sub-figure given by \comm{-a}, \comm{-b}, ... .
1200
1201 \begin{verbatim}
1202 \label{\labelPrefix\myLabel-\alph{subfigure}}
1203 \end{verbatim}
1204
1205 The reference can be called by simply typing
1206
1207 \begin{verbatim}
1208 ... see Figure \ref{fig:arranged51dd-c} ...
1209 \end{verbatim}
1210
1211 ... see Figure \ref{fig:arranged51dd-c}...\smallskip
1212
1213 The format of the above reference can be changed by redefining the subfigure-packages definition.
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223 %----------------------------------------------------------------
1224 \section{Recommendations for working with MiniPlot}
1225
1226 The only recommendation there is is only to set
1227
1228 \begin{verbatim}
1229 \usepackage{miniplot}
1230 \setcounter{plotFigures}{0}
1231 \end{verbatim}
1232
1233 This will display only the frameboxes of the figures and this will
1234 increase browsing speed through the document significantly.
1235
1236 When implementing a figure for the first time one should use the
1237 \comm{\~Now}-version of the implementation command, for example
1238
1239 \begin{verbatim}
1240 \includeEpsNow{...
1241 \end{verbatim}
1242
1243 After the figure is set and everything works fine one should remove the
1244 \comm{Now} to end up with
1245
1246 \begin{verbatim}
1247 \includeEps{...
1248 \end{verbatim}
1249
1250 When the whole document is finished one simply sets
1251
1252 \begin{verbatim}
1253 \setcounter{plotFigures}{1}
1254 \end{verbatim}
1255
1256 and all the figures will be shown.
1257
1258 Another subject regarding the subfig package is that I would suggest to use
1259 the following settings when implementing loads of figures in an arranged figure
1260 environment like Figure \ref{fig:arranged31} to \ref{fig:arranged33}.
1261
1262 \begin{verbatim}
1263 \renewcommand{\subfigbottomskip}{0pt}%
1264 \renewcommand{\subfigcapskip}{0pt}%
1265 \renewcommand{\subcapsize}{\scriptsize}%
1266 \end{verbatim}
1267
1268 These settings are not used in this manual.
1269
1270
1271
1272
1273
1274
1275
1276 %----------------------------------------------------------------
1277 \section{The code}
1278
1279 I'd like to excuse that the code is not pasted in and not explained as
1280 proper package writers tend to do. I just hope that the comments in
1281 \comm{miniplot.sty} might give some clue when trying to understand
1282 pieces of it.
1283
1284
1285
1286
1287 %----------------------------------------------------------------
1288 \section{Restrictions when using MiniPlot}
1289
1290 One restriction is that the underscore \_ is not desired in the
1291 labels of the figures.
1292
1293 This is due to to the fact that MiniPlot displays
1294 the labels and needs to find a proper way of doing this. This is done by the following
1295 command.
1296
1297 \begin{verbatim}
1298 \newcommand{\printLabel}[1]{\centerline{
1299 \small{\emph{Label}: $\mathtt{fig:#1}$}}}
1300 \end{verbatim}
1301
1302
1303 In mathmode the underscore has a different function and is not displayed as an underscore.
1304 I could imagine there is a solution like using the \verb+\let+ command
1305 but this goes beyond my \LaTeX \hspace{0mm} capabilities.
1306
1307 Another restriction is that the path to an arranged figure cannot contain the \verb+\+-sign.
1308 This might not be a major restriction. If it is let me know.
1309
1310 Finally, when including a \verb+\subFig[sub-sub-caption]{...+ the sub-sub-caption cannot
1311 be equals \comm{noParMiniPlot}. This shouldn't be too much of a problem.
1312
1313 The number of sub-sub-figures per sub-figure is restriced by the subfigure package to maximum
1314 26 sub-sub-figures. If one needs to have more sub-sub-figures one can redefine
1315
1316 \begin{verbatim}
1317 \def\thesubfigure{(\arabic{subfigure})}
1318 \renewcommand{\subLabelSuffix}{-\arabic{subfigure}}
1319 \end{verbatim}
1320
1321 Then the sub-sub-figure caption and the sub-label is no more \comm{(a)}, \comm{(b)}, ... but \comm{(1)}, \comm{(2)}, ... .
1322 This allows for more than 26 sub-sub-figures. If one doesn't like the arabic numbering maybe
1323 someone can come up with an algorithm which counts up to \comm{(z)} and then starts with \comm{(aa)} and so on.
1324
1325
1326
1327 %----------------------------------------------------------------
1328 \section{Known bugs}
1329
1330 There is actually just one real bug known. That is that an overhang for an
1331 wrapped-arranged-figure cannot be applied properly.
1332
1333 Generally bugs can please be reported to \emph{[email protected]} or
1334 \emph{tobias\[email protected]}.
1335
1336 One thing is that one gets a lot of warnings about overfull hboxes. I am
1337 personally not really bothered but if somebody might come up with an idea
1338 I would be happy to implement it.
1339
1340 There are just few awkward things about the code and maybe somebody has an idea
1341 how solve things. One thing is that in the following
1342 function the first line seemed\footnote{I have to note that this behavior happened at one point and
1343 does not occur annymore. So that \comm{subFigureAboveCaptionSpaceDefaultOffset}
1344 is set to zero. However, I decided to leave this in the code in case it might
1345 occur again??} to introduce a vertical length even if one
1346 simply writes \comm{vspace\{0pt\}\%}. Due to this strange behavior I had to
1347 introduce the length \comm{subFigureAboveCaptionSpaceDefaultOffset} equals
1348 3mm.
1349
1350
1351 \begin{verbatim}
1352 \newcommand{\newSubFig}[3][\subFigureAboveCaptionSpaceDefault]%
1353 {%
1354 \vspace{\subFigureAboveCaptionSpace}%
1355 \ifthenelse{\value{plotFigures}>0}%
1356 {\caption{\myCaptionText}}%
1357 {\caption{\myCaptionText\printLabel{\myLabel}}}%
1358 \label{\myLabel}%
1359 \end{minipage}%
1360 \renewcommand{\myCaptionText}{#3}%
1361 \renewcommand{\myLabel}{#2}%
1362 \vspace{\subFigureBelowCaptionSpace}%
1363 \hspace{\interSubFigSpace}%
1364 \begin{minipage}{\myStandardSubFigureWidth}%
1365 \aboveCaptionSpace{#1}%
1366 }%
1367 \end{verbatim}
1368
1369 Furthermore, in the above command the following command is called
1370
1371 \begin{verbatim}
1372 \newcommand{\aboveCaptionSpace}[1]{\setlength{\subFigureAboveCaptionSpace}
1373 {#1 + \subFigureAboveCaptionSpaceDefaultOffset}}
1374 \end{verbatim}
1375
1376 For some strange reason the length \comm{subFigureAboveCaptionSpace} does not
1377 keep its value. Maybe I need to have a look at this again.
1378
1379 The command \comm{aboveCaptionSpace} was initially thought to be used instead of setting the
1380 length \comm{subFigureAboveCaptionSpace} directly.
1381
1382 In the \verb+\subFig+ command above it was thought to be a replacement of
1383
1384 \begin{verbatim}
1385 .
1386 \setlength{\subFigureAboveCaptionSpace}{2.5mm}
1387 \newSubFig{arranged553}{bottom}
1388 \setlength{\subFigureAboveCaptionSpace}{0mm}
1389 .
1390 \end{verbatim}
1391
1392 by typing
1393
1394 \begin{verbatim}
1395 .
1396 \newSubFig[2.5mm]{arranged553}{bottom}
1397 .
1398 \end{verbatim}
1399
1400 However, maybe it will work one time. Until then one shouldn't use this
1401 optional parameter.
1402
1403
1404 \clearpage
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414 %----------------------------------------------------------------
1415 \section{Recources}
1416
1417 One can obtain this and the required package from the following ftp-sites
1418
1419 \begin{itemize}
1420 \item ftp://ftp.dante.de/tex-archive/macros/latex/contrib/supported/miniplot
1421 \item ftp://ftp.dante.de/tex-archive/macros/latex/contrib/supported/subfigure
1422 \item ftp://ftp.dante.de/tex-archive/macros/latex/contrib/other/misc/wrapfig.sty
1423 \item ftp://ftp.dante.de/tex-archive/macros/latex/contrib/supported/rotating
1424 \item ftp://ftp.dante.de/tex-archive/macros/latex/contrib/supported/rotfloat
1425 \end{itemize}
1426
1427 or if only the basic sty-files are needed one can obtain them from
1428
1429 \begin{itemize}
1430 \item ftp://[email protected]
1431 \end{itemize}
1432
1433 The required username and password is \comm{miniplot}.
1434
1435
1436
1437
1438
1439
1440
1441 %----------------------------------------------------------------
1442 \section{List of variables, commands and environments}
1443
1444
1445 Note that only those variables, commands and environments are cited which
1446 are useful for the user.
1447
1448
1449 \bigskip\bigskip
1450
1451 \underline{Counters:}
1452
1453 \begin{verbatim}
1454 \setcounter{scaleToStandardFigureWidth}{1}
1455 \setcounter{isFirstStandardFigure}{1}
1456 \setcounter{scaleFigureIndividual}{1}
1457 \setcounter{plotFigures}{1}
1458 \end{verbatim}
1459
1460
1461
1462 \bigskip\bigskip
1463
1464 \underline{Lengths:}
1465
1466 \begin{verbatim}
1467 \setlength{\myStandardFigureWidth}{\linewidth}
1468 \setlength{\myStandardSideWaysFigureWidth}{\textheight}
1469
1470 \setlength{\captionWidthPenalty}{0mm}
1471 \setlength{\minimumCaptionWidth}{\linewidth * 4 / 6}
1472 \setlength{\minimumSideWaysCaptionWidth}{\textheight * 4 / 6}
1473
1474 \setlength{\aboveWrapFigureSpace}{0mm}
1475
1476 \setlength{\interSubFigSpace}{8mm}
1477 \setlength{\interSubSubFigSpace}{2.5mm}
1478
1479 \setlength{\horizontalSubSubFigSpace}{-1mm}
1480 \setlength{\subFigureAboveCaptionSpaceDefault}{0mm}
1481 \setlength{\subFigureAboveCaptionSpace}{0mm}
1482 \setlength{\subFigureBelowCaptionSpace}{5mm}
1483
1484 \setlength{\subFigPenalty}{0mm}
1485 \setlength{\subSubFigPenalty}{0.001mm}
1486 \setlength{\subCaptionPenalty}{0mm}
1487 \setlength{\frameBoxPenalty}{2.4mm}
1488 \setlength{\labelPenalty}{-1.5mm}
1489 \end{verbatim}
1490
1491
1492
1493 \bigskip\bigskip
1494
1495 \underline{Commands:}
1496
1497 \begin{verbatim}
1498 \newcommand{\labelPrefix}{fig:}
1499 \newcommand{\subLabelSuffix}{-\alph{subfigure}}
1500
1501 \newcommand{\isFirstSubFig}{false}
1502 \newcommand{\standardGraphScale}{1}
1503
1504 \includeEps[htpb]{path}{caption}{label}{scaling}
1505 \includeEpsNow[htpb]{path}{caption}{label}{scaling}
1506 \includeSideWaysEps[htpb]{path}{caption}{label}{scaling}
1507 \includeSideWaysEpsNow[htpb]{path}{caption}{label}{scaling}
1508
1509 \includeStandardGraph[htpb]{path}{caption}{label}
1510 \includeStandardGraphNow[htpb]{path}{caption}{label}
1511 \includeStandardSideWaysGraph[htpb]{path}{caption}{label}
1512 \includeStandardSideWaysGraphNow[htpb]{path}{caption}{label}
1513
1514 \includeEpsWrap[narrow lines]{position}{path}{caption}{label}{scaling}
1515 \includeEpsWrapNow[narrow lines]{position}{path}{caption}{label}{scaling}
1516
1517 \epsContent[placement]{path}{caption}{label}{scaling}{figure width}
1518 {figure height}
1519 \arrangedFigContent[sub-sub-caption]{path}{figure width}{figure height}
1520 \wrappedEpsContent[lines]{position}{path}{caption}{label}{scaling}
1521 {figure width}{figure height}
1522
1523 \newcommand{\printLabel}[1]{\centerline{
1524 \small{\emph{Label}: $\mathtt{fig:#1}$}}}
1525 \newSubFig[\subFigureAboveCaptionSpace]{label}{caption}
1526 \subFig[sub-sub-caption]{path}%
1527
1528 \resetMiniPlot
1529
1530 \epsContent[placement]{path}{caption}{label}{scaling}{figure width}
1531 {figure height}
1532 \arrangedFigContent[sub-sub-caption]{path}{figure width}{figure height}
1533 \wrappedEpsContent[lines]{position}{path}{caption}{label}{scaling}
1534 {figure width}{figure height}
1535 \end{verbatim}
1536
1537
1538 \bigskip\bigskip
1539
1540 \underline{Environments:}
1541
1542 \begin{verbatim}
1543 arrangedFigure[htpb]{sub-fig columns}{sub-sub-fig columns}{label}{caption}
1544 arrangedFigureNow[htpb]{sub-fig columns}{sub-sub-fig columns}{label}{caption}
1545
1546 arrangedSideWaysFigure[htpb]{sub-fig columns}{sub-sub-fig columns}
1547 {label}{caption}
1548 arrangedSideWaysFigureNow[htpb]{sub-fig columns}{sub-sub-fig columns}
1549 {label}{caption}
1550 \end{verbatim}
1551
1552
1553 \end{document}