summaryrefslogtreecommitdiff
path: root/macros/latex/contrib/swfigure/swfigure-examples.tex
diff options
context:
space:
mode:
authorNorbert Preining <norbert@preining.info>2020-10-19 03:01:17 +0000
committerNorbert Preining <norbert@preining.info>2020-10-19 03:01:17 +0000
commit3fdf82ec77f470d0bf97c17c3085ef2fd58ea65f (patch)
treeb5a02fdc2b644489adba7459ebbf1d5d2f2739f5 /macros/latex/contrib/swfigure/swfigure-examples.tex
parent94b94cfd7a578d12bd5335c40e5f43400140c3f4 (diff)
CTAN sync 202010190301
Diffstat (limited to 'macros/latex/contrib/swfigure/swfigure-examples.tex')
-rw-r--r--macros/latex/contrib/swfigure/swfigure-examples.tex37
1 files changed, 20 insertions, 17 deletions
diff --git a/macros/latex/contrib/swfigure/swfigure-examples.tex b/macros/latex/contrib/swfigure/swfigure-examples.tex
index b16d24431c..b37eea4bc9 100644
--- a/macros/latex/contrib/swfigure/swfigure-examples.tex
+++ b/macros/latex/contrib/swfigure/swfigure-examples.tex
@@ -8,7 +8,7 @@
\providecommand*\diff{\mathop{}\!\mathrm{d}}
\providecommand\cs{}
- \renewcommand\cs[1]{\normalfont{\texttt{\char92#1}}}
+ \renewcommand\cs[1]{{\normalfont{\texttt{\char92#1}}}}
\providecommand\meta{}
\renewcommand\meta[1]{{\normalfont\textlangle\textit{#1}\textrangle}}
\providecommand\marg{}
@@ -60,10 +60,10 @@
\counterwithout{section}{chapter}
-\begin{document}
+\begin{document}\frenchspacing
\GetFileInfo{swfigure.sty}
\title{The \pack{swfigure} package --- Usage examples}
-\author{Claudio Beccari\thanks{Email: \texttt{claudio dot beccari at gmail dot com}}}
+\author{Claudio Beccari\qquad\texttt{\texttt{claudio dot beccari at gmail dot com}}}
\date{Version \fileversion~---~ Last revised \filedate}
\maketitle
@@ -83,25 +83,25 @@ As far as we can say, we know that Preview.app on Macs does not use any gap. Oku
If the \pack{hyperref} package is used the option \texttt{pdfpagelayout=TwoColumnRight} may be specified; some PDF viewers understand this setting, but not necessarily the spread view lacks the gap between the facing pages.
It is possible to see a spread wide figure in the next two pages; a fake figure is displayed and you see that the crossing of the diagonal and medial lines takes
-\DFimage[SW]{SWfakeimage}{A spread wide fake image}[fig:SWfake]%
+\DFimage[SW]{SWfakeimage}{A spread wide fake image}[fig:SWfake]
place exactly on the spine. It was composed with the following command:
-\begin{flushleft}\setfontsize{9.85}\ttfamily\obeylines
+\begin{ttsyntax}\setfontsize{9.85}%
... takes
-\cs{DFimage}Oarg{SW}\Marg{SWfakeimage}\Marg{A Spread Wide fake image}\Oarg{fig:SWfake}%
+\cs{DFimage}\Oarg{SW}\Marg{SWfakeimage}\Marg{A Spread Wide fake image}\Oarg{fig:SWfake}\%
place ...
-\end{flushleft}
+\end{ttsyntax}
-Other examples are shown in the following pages; the filling text is a generic text, not actually a non sense fake Latin wording such as that provided by the \pack{lipsum} package, but it is taken form package \pack{kantlipsum} where sentences appear as plain English, although we doubt that Emmanuel Kant wrote those very texts.
+Other examples are shown in the following pages; the filling text is a generic text, not actually a non sense fake Latin wording such as that provided by the \pack{lipsum} package, but it is taken form package \pack{kantlipsum} where sentences appear as plain English; those sentences appear as translations of Immanuel Kant's philosophic theories, although we doubt that he wrote those very texts.
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
\section{The user macro}
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
The only user macro defined by this package has the following syntax:
-\begin{ttsyntax}
+\begin{ttsyntax}\setfontsize{9.5}%
\cs{DFimage}\oarg{display mode}\marg{image file name}\oarg{lof entry}\%
-\qquad\marg{caption}\oarg{label}\parg{height correction}\aarg{line correction}
+\qquad\marg{caption}\oarg{label}\parg{height correction}\aarg{line correction}|\meta{width test}|
\end{ttsyntax}
The arguments are described in detail in the twin document \file{swfigure.pdf}. We shortly repeat their meanings.
\begin{description}[noitemsep]
@@ -118,16 +118,17 @@ The arguments are described in detail in the twin document \file{swfigure.pdf}.
%
\item[\meta{height correction}] is an optional argument with a preset value of 0.8, it reduces the image height by that value, in order to assure that the figure has enough space for the image and its caption; if captions are not “narrative” (too many sentences) the value of 0.8 should be suited in most cases; the user, while revising the document drafts might decide to use a different value, of course always not greater than~1. This correction may be used with some display modes that concern only one page, not a full spread.
%
-\item[\meta{line correction}] This optional integer number may correct the number of lines of the indention of the wrapping text around a tall and slim figure.
+\item[\meta{line correction}] This optional integer number may correct the number of lines of the indentation of the wrapping text around a tall and slim figure.
%
+\item[\meta{width test}] is an optional fractional number smaller than~0.5 (default \texttt{0.25}) used to check that in Vertical Slim mode the width of the scaled image does not get too small so as to leave sufficient space for e decently typeset caption; the zero value implies no test. See in page~\pageref{fig:VSSmessage} the message that is output if this width becomes too small.
\end{description}
We stress the first optional argument meaning, whose default value is \texttt{SW}. It specifies the \meta{display mode}.
\begin{description}[noitemsep]
%
-\item[\texttt{SW}] is the acronym that specifies the \meta{display mode} for a Spread Wide figure; it consists into a full spread, without any text, and with its caption typeset in the external margin of the odd numbered page in a vertical fashion. Since this display mode needs to start on an even page, the user should carefully find the proper place where to insert the user macro \cs{DGimage} (named as “steering” macro, since it decides which large figure style to use), because it starts a new page and possibly inserts a blank page if the new one is odd numbered.
+\item[\texttt{SW}] is the acronym that specifies the \meta{display mode} for a Spread Wide figure; it consists into a full spread, without any text, and with its caption typeset in the external margin of the odd numbered page typeset in vertical mode. Since this display mode needs to start on an even page, the user should carefully find the proper place where to insert the user macro \cs{DFimage} (named as “steering” macro, since it decides which large figure style to use), because it starts a new page and possibly inserts a blank page if the new one is odd numbered. The steering macro can be also inserted within a paragraph\footnote{remeber to leave a space before \cs{DFimage} and no space after the last argument.}, and after its complete expansion restores the vertical mode; nevertheless, even so, it may insert a blank page if the next page is odd numbered.
%
-\item[\texttt{HS}] refers to a Horizontal Slim image, that requires a spread wide display mode, such that the first of the facing pages is an even numbered one, and with some text beneath both half images; since the caption is under the right half, the space occupied by this part of the image is higher than that in the facing page, it is necessary to equalise these vertical spaces, and the specific code takes care of this constraint. Also in this case the user should carefully chose the place where to insert the steering macro.
+\item[\texttt{HS}] refers to a Horizontal Slim image, that requires a spread wide display mode, such that the first of the facing pages is an even numbered one, and with some text beneath both half images; since the caption is below the right half, the space occupied by this part of the image would be higher than that in the facing page, it is necessary to equalise these vertical spaces, and the specific code takes care of this constraint. Also in this case the user should carefully chose the place where to insert the steering macro.
%
\item[\texttt{VS}] This case refers to a Vertical Slim image. This situation requires a really slim image, so that if its “height over width” ratio (its aspect ratio) is smaller than~2, the macro does not insert anything, except a message in its place, that informs the user about the cause of this refusal and suggests other display modes. The procedure is based on the use of the \pack{wrapfig} functionalities; this package has several limitations that the user should check in its documentation. Nevertheless, if there is enough “normal” text available to wrap the figure, the result is quite good. There are two parameters to fine tune the wrapped image with its caption: the \meta{height correction} and the \meta{line correction}.
%
@@ -147,7 +148,11 @@ practical reason is a representation of, as far as I know, the things
in themselves; as I have shown elsewhere, the phenomena should only be
used as a canon for our understanding. The paralogisms of practical
reason are what first give rise to the architectonic of practical
-reason. As will easily be shown in the next section, reason would
+reason.
+
+\DFimage[HS]{HSfakeimage}{A Horizontal Slim fake image}[fig:HSfake]
+
+As will easily be shown in the next section, reason would
thereby be made to contradict, in view of these considerations, the
Ideal of practical reason, yet the manifold depends on the phenomena.
Necessity depends on, when thus treated as the practical employment of
@@ -156,8 +161,6 @@ Human reason depends on our sense perceptions, by means of analytic
unity. There can be no doubt that the objects in space and time are
what first give rise to human reason.
-\DFimage[HS]{HSfakeimage}{A Horizontal Slim fake image}[fig:HSfake]
-
Let us suppose that the noumena have nothing to do
with necessity, since knowledge of the Categories is a
posteriori. Hume tells us that the transcendental unity of
@@ -275,7 +278,6 @@ absolved.
\DFimage[RF]{RFfakeimage}{A large Rotated Figure fake image}[fig:RFfake]
-\DFimage[VS]{VSSfake}{A tall very slim image}[fig:VSSfale](0.65)<2>
As any dedicated reader can clearly see, the Ideal of
practical reason is a representation of, as far as I know, the things
in themselves; as I have shown elsewhere, the phenomena should only be
@@ -338,6 +340,7 @@ This could not be passed over in a complete system of transcendental
philosophy, but in a merely critical essay the simple mention of the
fact may suffice.
+\DFimage[VS]{VSSfake}{A tall very slim image}[fig:VSSfake](0.65)<2>\label{fig:VSSmessage}
Therefore, we can deduce that the objects in space and
time (and I assert, however, that this is the case) have lying before
them the objects in space and time. Because of our necessary ignorance