diff options
Diffstat (limited to 'Master/texmf-dist/source/latex/bosisio/graphfig.dtx')
| -rw-r--r-- | Master/texmf-dist/source/latex/bosisio/graphfig.dtx | 157 |
1 files changed, 82 insertions, 75 deletions
diff --git a/Master/texmf-dist/source/latex/bosisio/graphfig.dtx b/Master/texmf-dist/source/latex/bosisio/graphfig.dtx index 1c0a9836974..b9d7334cf0f 100644 --- a/Master/texmf-dist/source/latex/bosisio/graphfig.dtx +++ b/Master/texmf-dist/source/latex/bosisio/graphfig.dtx @@ -1,19 +1,26 @@ %\iffalse % MetaComment %% %% + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + -%% | Copyright(C) 1997-1999 by Francesco Bosisio | +%% | Copyright(C) 1997-2010 by F. Bosisio | %% | | -%% | This program can be redistributed and/or modified under the | -%% | terms of the LaTeX Project Public License Distributed from | -%% | CTAN archives in directory macros/latex/base/lppl.txt; | -%% | either version 1 of the License, or any later version. | +%% | This program can be redistributed and/or modified under | +%% | the terms of the LaTeX Project Public License, either | +%% | version 1.3 of this license or (at your option) any later | +%% | version. The latest version of this license is in | +%% | http://www.latex-project.org/lppl.txt | +%% | and version 1.3 or later is part of all LaTeX distributions | +%% | version 2005/12/01 or later. | +%% | | +%% | This work has the LPPL maintenance status `maintained'. | +%% | The Current Maintainer of this work is F. Bosisio. | +%% | | +%% | This work consists of files graphfig.dtx and graphfig.html | +%% | and of the derived files graphfig.sty and graphfig.pdf. | %% | | %% | E-mail: fbosisio@bigfoot.com | -%% | Web page: http://www.bigfoot.com/~fbosisio/LaTeX | -%% | CTAN location: macros/latex/contrib/supported/bosisio/ | +%% | CTAN location: macros/latex/contrib/bosisio/ | %% + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + %% -%% %% If you make any improvment, find any bug or have %% any suggestion, please let me know about it. %% @@ -25,10 +32,10 @@ %</package,driver> %<*package> %\fi -\def\fileversion{2.0} -\def\filedate{1997/15/12} -\def\docdate{1997/15/12} -\def\filedescr{Commands to include graphics files (BF)} +\def\fileversion{2.2} +\def\filedate{1997/12/15} +\def\docdate{2005/04/09} +\def\filedescr{Commands to include graphics files (FB)} % %\iffalse % MetaComment %</package> @@ -81,7 +88,7 @@ % % \changes{v0.1}{21 April 1997}{First release} % \changes{v0.2}{5 July 1997}{Added the ``\texttt{clip}'' option to ``\texttt{psfig}''} -% \changes{v0.3}{29 August 1997}{Modified the ``\texttt{@PS@Figure}" command} +% \changes{v0.3}{29 August 1997}{Modified the ``\texttt{@PS@Figure}'' command} % \changes{v1.0}{8 September 1997}{Documentation added} % \changes{v1.1}{19 November 1997}{Improved the ``SubFigure'' command} % \changes{v1.2}{11 December 1997}{Fixed a bug in ``SubFigure'' references} @@ -91,13 +98,13 @@ %\fi % \changes{v2.0}{15 December 1997}{``graphfile'' instead of ``PSFigure/SubFigure''} % \changes{v2.1}{5 March 1999}{Added copyright notice and changed addresses} +% \changes{v2.2}{9 April 2005}{Usage of the double-quote character (") avoided} % % \MakeShortVerb{\|} % % \title{Package \texttt{\FileName}\thanks{This is version \fileversion, % last revised \filedate; documentation date \docdate}} -% \author{F. Bosisio\\\normalsize E-mail: \texttt{fbosisio@bigfoot.com}\\ -% \small Web page: \texttt{http://www.bigfoot.com/$\sim$fbosisio/LaTeX}} +% \author{F. Bosisio\\\normalsize E-mail: \texttt{fbosisio@bigfoot.com}} % \date{\filedate} % \maketitle % @@ -110,38 +117,38 @@ % files in \LaTeX{} simpler. % % \noindent -% It declares the ``|Figure|" environment (capitalized!) and -% the two commands ``|\graphfile|" and ``|\graphfile*|". +% It declares the ``|Figure|'' environment (capitalized!) and +% the two commands ``|\graphfile|'' and ``|\graphfile*|''. % Combining this commands, it it possible to include graphic % files in a \LaTeX{} document very simply. % % \section{Required packages} -% This package uses the ``|\includegraphics*|" command defined in the +% This package uses the ``|\includegraphics*|'' command defined in the % standard |graphics| package. % Moreover, it uses the package |subfigure| when the |subfigure| % option is specified, and the |float| package if the |AllowH| % option is used. % % \section{The options} -% At now, two options are available: ``|subfigure|" and ``|AllowH|". +% At now, two options are available: ``|subfigure|'' and ``|AllowH|''. % % \noindent -% The ``|subfigure|" option allow the use of sub-figures +% The ``|subfigure|'' option allow the use of sub-figures % inside a |Figure| environment, in order to place multiple % pictures in a single \LaTeX{} figure (cfr. the |subfigure| % standard package). % % \noindent -% The ``|AllowH|" option allow the use of the ``|H|" float specifier +% The ``|AllowH|'' option allow the use of the ``|H|'' float specifier % for the |Figure| environment, in order to place the figure exaclty % where the command is placed (cfr. the |float| standard package). % % \section{The \texttt{Figure} environment and its relatives} -% The ``|Figure|" environment (capitalized!) is somewhat different -% from the standard \LaTeX{} ``|figure|" environment: besides an +% The ``|Figure|'' environment (capitalized!) is somewhat different +% from the standard \LaTeX{} ``|figure|'' environment: besides an % optional argument used to specify the placement parameters (which -% now defaults to ``|[htbp]|"), it has a mandatory agrument specifying -% the ``caption" and another optional argument, used as a ``label" for +% now defaults to ``|[htbp]|''), it has a mandatory argument specifying +% the ``caption'' and another optional argument, used as a ``label'' for % cross-referencies: % % \begin{verbatim} @@ -151,11 +158,11 @@ % \end{verbatim} % % \noindent -% The use of the ``|H|" specifier (i.e. ``I want my float here!") is -% possible only if the ``|AllowH|" option has been specified. +% The use of the ``|H|'' specifier (i.e. ``I want my float here!'') is +% possible only if the ``|AllowH|'' option has been specified. % % \subsection{The \texttt{graphfile} command} -% Inside the ``|Figure|" environment, are available the commands: +% Inside the ``|Figure|'' environment, are available the commands: % % \begin{verbatim} % \graphfile[<width>]{<file>}[<sub-caption>] @@ -163,20 +170,20 @@ % \end{verbatim} % % \noindent -% which are a simplified version of the ``|\includegraphics*|" +% which are a simplified version of the ``|\includegraphics*|'' % command (which is automatically included by this package; see the % |graphics| package for reference), since you don't have to worry % about scaling: the mandatory argument is the name of the graphic file to % include, whereas the first optional argument specifies the desired % width (in the non *-form) or heigth (in the *-form) of the figure as -% a fraction of ``|\linewidth|" (e.g. ``|50|" means ``|.50\linewidth|", -% i.e. half a line! ), so no unit of measure (as ``|cm|" or ``|pt|") +% a fraction of ``|\linewidth|'' (e.g. ``|50|'' means ``|.50\linewidth|'', +% i.e. half a line! ), so no unit of measure (as ``|cm|'' or ``|pt|'') % is required. -% Moreover, since the ``*-form" of ``|\includegraphics|" is used, the +% Moreover, since the ``*-form'' of ``|\includegraphics|'' is used, the % regions outside the bounding-box are not drawn. -% Another advantage of the combined use of the ``|Figure|" environment -% and the ``|\graphfile|" commands is that the picture is automatically -% centered horizontally, so no ``|\centering|" or similar declartion +% Another advantage of the combined use of the ``|Figure|'' environment +% and the ``|\graphfile|'' commands is that the picture is automatically +% centered horizontally, so no ``|\centering|'' or similar declartion % is required. % % \begin{verbatim} @@ -188,7 +195,7 @@ % \subsection{Sub-figures} % % If you want to include more than one file in a single figure, -% you need to specify the ``|subfigure|" option, which includes the +% you need to specify the ``|subfigure|'' option, which includes the % |subfigure| package and provides the authomatic placement of a % sub-caption below each picture. % @@ -199,9 +206,9 @@ % \end{verbatim} % % \noindent -% which is a combined version of ``|\subfigure|" and ``|\includegraphics*|" +% which is a combined version of ``|\subfigure|'' and ``|\includegraphics*|'' % (see the |subfigure| and |graphics| packages for reference): -% the last optional argument specify a ``caption" for the sub-figure under +% the last optional argument specify a ``caption'' for the sub-figure under % consideration, while the first two arguments work exactly like as % described above in the case of one only picture (indeed, you can % use the last optional argument even if the |subfigure| option was @@ -209,13 +216,13 @@ % Each individual caption is printed preceded by a bracketed letter, % which is the sub-figure counter and is printed even if no caption is % specified. -% Using only a series of ``|\graphfile[|$\dots$|]{|$\dots$|}[|$\dots$|]|" -% commands inside a ``|Figure|" environment provides an equal spacing +% Using only a series of ``|\graphfile[|$\dots$|]{|$\dots$|}[|$\dots$|]|'' +% commands inside a ``|Figure|'' environment provides an equal spacing % beetween the pictures and around them, without the need for any % extra command. -% Finally, if a ``|<label>|" was specified as the last optional argument -% to the ``|Figure|" environment, you can reference to each individual -% sub-figure by the labels ``|<label>:a|", ``|<label>:b|", and so on, +% Finally, if a ``|<label>|'' was specified as the last optional argument +% to the ``|Figure|'' environment, you can reference to each individual +% sub-figure by the labels ``|<label>:a|'', ``|<label>:b|'', and so on, % without the need for declaring them. % % \begin{verbatim} @@ -258,21 +265,21 @@ % \end{macrocode} % % These redefinitions are needed in order to obtain the right form -% of the references (i.e. like ``Fig. 1a" and not ``Fig. 1(a)") +% of the references (i.e. like ``Fig. 1a'' and not ``Fig. 1(a)'') % \begin{macrocode} \def\thesubfigure{\alph{subfigure}} % \end{macrocode} % -% We use ``|\renewcommand|" instead of ``|\def|" in order to realize +% We use ``|\renewcommand|'' instead of ``|\def|'' in order to realize % possible changes in the |subfigure| package which may eliminate the -% inner command ``|\@thesubfigure|". +% inner command ``|\@thesubfigure|''. % \begin{macrocode} \renewcommand*\@thesubfigure{{\subcaplabelfont(\thesubfigure)}\space} \let\SubGR@PH=\subfigure \else % \end{macrocode} % -% If the ``subfigure" option is not present, we let the internal +% If the ``subfigure'' option is not present, we let the internal % command ``|\SubGR@PH|'' to simply execute its mandatory argument % \begin{macrocode} \newcommand*\SubGR@PH[2][]{#2} @@ -296,7 +303,7 @@ % \end{macro} % % \begin{macro}{\graphfile} -% The command ``|\graphfile"| and its *-version simply calls one +% The command ``|\graphfile''| and its *-version simply calls one % of the forthcoming commands. % \begin{macrocode} \newcommand*\graphfile{\@ifnextchar*{\graphfile@star}{% @@ -304,11 +311,11 @@ } \def\graphfile@star*{\@ifnextchar[{\GraphFile@heigth}{\GraphFile@noSize}} % \end{macrocode} -% These commands, in turns, calls ``|\@GraphFile@Draw|" with suitable -% arguments (i.e. the lengths are turned into fractions of ``|\linewidth|" -% and an exclamation mark ``|!|" is used where the scaling factor has +% These commands, in turns, calls ``|\@GraphFile@Draw|'' with suitable +% arguments (i.e. the lengths are turned into fractions of ``|\linewidth|'' +% and an exclamation mark ``|!|'' is used where the scaling factor has % to be the same as the other direction; furthermore the actual size -% of the graphic image is used [throught the ``|\width|" command] if +% of the graphic image is used [throught the ``|\width|'' command] if % no scaling parameter is given). % \begin{macrocode} %% @@ -344,28 +351,28 @@ \if@FirstPicture% % \end{macrocode} % If it is the first call to this command in the current |Figure| -% environment, we simply store it in ``|\TMP@Graph|". -% We also set ``|@FirstPicture|" to false for the next call. +% environment, we simply store it in ``|\TMP@Graph|''. +% We also set ``|@FirstPicture|'' to false for the next call. % \begin{macrocode} \@FirstPicturefalse% \def\TMP@Graph{\SubGR@PH[#4\SubFig@Label]{\@Graph@Figure{#1}{#2}{#3}}}% \else% \ifx\TMP@Graph\undefined% % \end{macrocode} -% If ``|\TMP@Graph|" is not defined, this is the third call (or more). -% So we invoke the ``|\SubGR@PH|" command (which may be ``|\subfigure|" +% If ``|\TMP@Graph|'' is not defined, this is the third call (or more). +% So we invoke the ``|\SubGR@PH|'' command (which may be ``|\subfigure|'' % or simply its second argument depending on the options) with a -% ``|\@Graph@Figure|" command inside and followed by an ``|\hfill|" +% ``|\@Graph@Figure|'' command inside and followed by an ``|\hfill|'' % command for centering purposes. % \begin{macrocode} \SubGR@PH[#4\SubFig@Label]{\@Graph@Figure{#1}{#2}{#3}}\hspace*{\fill}% \else% % \end{macrocode} -% If we arrive at this point it is the second call to ``|\graphfile|" +% If we arrive at this point it is the second call to ``|\graphfile|'' % inside the current |Figure| environment: before plotting the -% current figure (as above) we must call ``|\TMP@Graph|" to plot +% current figure (as above) we must call ``|\TMP@Graph|'' to plot % the first one (which was only saved). -% We also undefine ``|\TMP@Graph|" for the next time. +% We also undefine ``|\TMP@Graph|'' for the next time. % \begin{macrocode} \hspace*{-4pt}\TMP@Graph\hspace*{\fill}% \let\TMP@Graph\undefined% @@ -377,9 +384,9 @@ % \end{macro} % % \begin{macro}{\FigureDefaultPlacement} -% The ``|\FigureDefaultPlacement|" macro is defined to set the value of +% The ``|\FigureDefaultPlacement|'' macro is defined to set the value of % the ``|\Default@FigurePlacement|'' to its argument. -% Also ``|\Default@FigurePlacement|" is initialized to ``|htbp|". +% Also ``|\Default@FigurePlacement|'' is initialized to ``|htbp|''. % \begin{macrocode} %% \newcommand*\FigureDefaultPlacement[1]{\def\Default@FigurePlacement{#1}} @@ -392,31 +399,31 @@ %% \newenvironment{Figure}[2][\Default@FigurePlacement]{% % \end{macrocode} -% The code for ``|\begin{Figure}|" starts by setting ``|@FirstPicture|" +% The code for ``|\begin{Figure}|'' starts by setting ``|@FirstPicture|'' % to true. % \begin{macrocode} \@FirstPicturetrue% % \end{macrocode} -% Then we start a standard ``|figure|" environment followed by an -% ``|\hfill|" command (for centering purposes). +% Then we start a standard ``|figure|'' environment followed by an +% ``|\hfill|'' command (for centering purposes). % \begin{macrocode} \figure[#1]% \hspace*{\fill}% % \end{macrocode} -% We change the definition of ``|\\|" so that an ``|\hfill|" command +% We change the definition of ``|\\|'' so that an ``|\hfill|'' command % is added at the beginning of next line. % \begin{macrocode} \let\@Figure@CR=\\% \def\\{\par\hspace*{\fill}}% % \end{macrocode} -% If there is the last optional argument, ``|\@Figure@quadra|" is -% invoked, otherwise ``|\MK@Figure@Caption|" is directly defined +% If there is the last optional argument, ``|\@Figure@quadra|'' is +% invoked, otherwise ``|\MK@Figure@Caption|'' is directly defined % to print the specified caption. % \begin{macrocode} \@ifnextchar[{\@Figure@quadra{#2}}{\def\MK@Figure@Caption{\caption{#2}}}% }{% % \end{macrocode} -% The code for ``|\end{Figure}|" starts by checking that ``|\TMP@Graph|" +% The code for ``|\end{Figure}|'' starts by checking that ``|\TMP@Graph|'' % is undefined, otherwise this means that there was one only picture: % in such a case we have to print it out before continuing. % \begin{macrocode} @@ -431,7 +438,7 @@ \global\let\TMP@Graph\undefined% \fi% % \end{macrocode} -% The ``|\MK@Figure@Caption|" prints the previously saved caption. +% The ``|\MK@Figure@Caption|'' prints the previously saved caption. % \begin{macrocode} \MK@Figure@Caption% % \end{macrocode} @@ -442,11 +449,11 @@ \let\\=\@Figure@CR% \let\@Figure@CR\undefined% % \end{macrocode} -% The standard ``|figure|" environment is closed. +% The standard ``|figure|'' environment is closed. % \begin{macrocode} \endfigure% % \end{macrocode} -% The command ``|\thesubfigure|" is redefined so that it correctly +% The command ``|\thesubfigure|'' is redefined so that it correctly % prints the figure number, too. % \begin{macrocode} \def\thesubfigure{\thefigure\alph{subfigure}}% @@ -455,9 +462,9 @@ % \end{environment} % % \begin{macro}{\@Figure@quadra} -% The ``|\MK@Figure@Caption|" is defined to print the specified +% The ``|\MK@Figure@Caption|'' is defined to print the specified % caption with an added label. -% Also ``|\SubFig@Label|" generates a label in the form ``|<label>:a|". +% Also ``|\SubFig@Label|'' generates a label in the form ``|<label>:a|''. % \begin{macrocode} %% \def\@Figure@quadra#1[#2]{% @@ -471,7 +478,7 @@ %<*package> %\fi % -% \CheckSum{181} +% \CheckSum{214} % \Finale % \endinput |