From 910296e37dbc57d56e48a93e88697596175c3aae Mon Sep 17 00:00:00 2001 From: =?utf8?q?Andr=C3=A9=20Wobst?= Date: Mon, 31 Mar 2003 08:09:46 +0000 Subject: [PATCH] corrections from Michael Schindler git-svn-id: https://pyx.svn.sourceforge.net/svnroot/pyx/trunk/pyx@838 069f4177-920e-0410-937b-c2a4a81bcd90 --- manual/box.tex | 18 +++++++++--------- manual/text.tex | 42 ++++++++++++++++++++++-------------------- 2 files changed, 31 insertions(+), 29 deletions(-) diff --git a/manual/box.tex b/manual/box.tex index fc520257..df8413f4 100644 --- a/manual/box.tex +++ b/manual/box.tex @@ -1,20 +1,20 @@ \chapter{Module box: convex box handling} \label{module:box} -This module has a quite internal character, but might still be usefull +This module has a quite internal character, but might still be useful from the users point of view. It might also get further enhanced to -cover a broader range of standard problems in arranging content. +cover a broader range of standard arranging problems. In the context of this module a box is a convex polygon having -optionally a center coordinate, which play an important role for the +optionally a center coordinate, which plays an important role for the box alignment. The center might not at all be central, but it should -be within the box. The convexity is postulated in order to keep the +be within the box. The convexity is necessary in order to keep the problems to be solved by this module quite a bit easier and unambiguous. Directions (for the alignment etc.) are usually provided as pairs (dx, dy) within this module. It is required, that at least one of -these two numbers is unequal zero. No further assumptions are taken. +these two numbers is unequal to zero. No further assumptions are taken. \section{polygon} @@ -73,7 +73,7 @@ alignment of the boxes \verb|boxes| using the parameters \verb|a|, \verb|dx|, and \verb|dy| as in the \verb|circlealign| method. For the length of the alignment vector its largest value is taken for all cases. -\item[\texttt{linealignequal(boxes, a, dx, dy}:] as above, but +\item[\texttt{linealignequal(boxes, a, dx, dy)}:] as above, but performing a line alignment \item[\texttt{tile(boxes, a, dx, dy)}:] tiles the boxes \verb|boxes| with a distance \verb|a| between the boxes (additional the maximal box @@ -84,15 +84,15 @@ account) \section{regtangular boxes} For easier creation of rectangular boxes, the module provides the -specialized class \verb|rect|. Its constructor takes at first four +specialized class \verb|rect|. Its constructor first takes four parameters, namely the x, y position and the box width and height. -Addtionally, for the definition of the position of the center, two +Additionally, for the definition of the position of the center, two keyword arguments are available. The parameter \verb|relcenter| takes a tuple containing a relative x, y position of the center (they are relative to the box extent, thus values between \verb|0| and \verb|1| should be used). The parameter \verb|abscenter| takes a tuple containing the x and y position of the center. This values are -meassured with respect to the lower left corner of the box. By +measured with respect to the lower left corner of the box. By default, the center of the rectangular box is set to this lower left corner. diff --git a/manual/text.tex b/manual/text.tex index d8b2f2e3..bf2665c6 100644 --- a/manual/text.tex +++ b/manual/text.tex @@ -8,7 +8,7 @@ technique of \TeX/\LaTeX{} into \PyX. The basic procedure is: \begin{itemize} \item start \TeX/\LaTeX{} as soon as text creation is requested \item create boxes containing the requested text on the fly -\item immediately analyze the \TeX/\LaTeX{} output for errors etc. +\item immediately analyse the \TeX/\LaTeX{} output for errors etc. \item boxes are written into the dvi output \item box extents are immediately available (they are contained in the \TeX/\LaTeX{} output) @@ -26,14 +26,14 @@ following table: \begin{tabularx}{\linewidth}{l>{\raggedright\arraybackslash}X} keyword&description\\ \hline -\texttt{mode}&\texttt{tex} (default) or \texttt{latex}\\ -\texttt{lfs}&Specifies a latex font size file to be used with \TeX. Those files with the suffix \texttt{.lfs} are created by \texttt{createlfs.tex}. Possible values are listed when a requested name couldn't be found.\\ +\texttt{mode}&\texttt{"tex"} (default) or \texttt{"latex"}\\ +\texttt{lfs}&Specifies a latex font size file to be used with \TeX. Those files (with the suffix \texttt{.lfs}) can be created by \texttt{createlfs.tex}. Possible values are listed when a requested name could not be found.\\ \texttt{docclass}&\LaTeX{} document class; default is \texttt{"article"}\\ \texttt{docopt}&specifies options for the document class; default is \texttt{None}\\ -\texttt{usefiles}$^1$&filenames to be as jobname files for \TeX/\LaTeX{}; default: \texttt{None}\\ +\texttt{usefiles}$^1$&filenames to be as jobname files for \TeX/\LaTeX{}; default: \texttt{None}; example: \texttt{("spam.aux", "eggs.log")}\\ \texttt{waitfortex}&wait this number of seconds for a \TeX/\LaTeX{} response; default \texttt{5}\\ -\texttt{texdebug}&\TeX/\LaTeX{} debug messages; default \texttt{0}\\ -\texttt{dvidebug}&dvi debug messages (like \texttt{dvitype}); default \texttt{0}\\ +\texttt{texdebug}&\TeX/\LaTeX{} debug messages (boolean); default \texttt{0}\\ +\texttt{dvidebug}&dvi debug messages like \texttt{dvitype} (boolean); default \texttt{0}\\ \texttt{texmessagestart}$^{1,2}$&parsers for the \TeX/\LaTeX{} start message; default: \texttt{texmessage.start}\\ \texttt{texmessagedocclass}$^{1,2}$&parsers for \LaTeX{}s \texttt{\textbackslash{}documentclass} statement; default: \texttt{texmessage.load}\\ \texttt{texmessagebegindoc}$^{1,2}$&parsers for \LaTeX{}s \texttt{\textbackslash{}begin\{document\}} statement; default: \texttt{(texmessage.load, texmessage.noaux)}\\ @@ -58,22 +58,23 @@ important for the \verb|defaulttextunner|. The \verb|set| method fails, when a modification can't be applied anymore (e.g. \TeX/\LaTeX{} was already started). -Secondly there is a \verb|preamble| method. It takes a \TeX/\LaTeX{} +Secondly there is a \verb|preamble| method, which can be called before +the \verb|text| method only (see below). It takes a \TeX/\LaTeX{} expression and optionally one or several \TeX/\LaTeX{} message -parsers. The preamlbe expressions should be used to perform global +parsers. The preamble expressions should be used to perform global settings, but should not create any \TeX/\LaTeX{} dvi output. In \LaTeX, the preamble expressions are inserted before the \verb|\begin{document}| statement. -Last but first, there is a \verb|text| method. The first two +Last, but first, there is a \verb|text| method. The first two parameters are the x, y position of the output to be generated. The third parameter is a \TeX/\LaTeX{} expression and further parameters are attributes for this command. Those attributes might be \TeX/\LaTeX{} settings as described below, \TeX/\LaTeX{} message -parsers as described below as well, \PyX{} transformations (like -rotations), and \PyX{} fill styles (like colors). The \verb|text| -method returns a box (see chapter~\ref{module:box}), which can be inserted -into a canvas instance by its \verb|insert| method to get the text. +parsers as described below as well, \PyX{} transformations, and \PyX{} +fill styles (like colors). The \verb|text| method returns a box (see +chapter~\ref{module:box}), which can be inserted into a canvas +instance by its \verb|insert| method to get the text. \section{\TeX/\LaTeX{} settings} @@ -81,10 +82,11 @@ into a canvas instance by its \verb|insert| method to get the text. \raggedright \item[Horizontal alignment:] \verb|halign.left| (default), \verb|halign.center|, \verb|halign.right|, \verb|halign(x)| (\verb|x| -is a value between \verb|0| and \verb|1|) +is a value between \verb|0| and \verb|1| standing for left and right, +respectively) \item[Vertical box:] Usually, \TeX/\LaTeX{} expressions are handled in -horizontal mode (its called LR-mode in \TeX/\LaTeX; everything goes -into a single line). You may use \verb|vbox(x)|, where \verb|x| is the +horizontal mode (so-called LR-mode in \TeX/\LaTeX; everything goes +into a single line). You may use \verb|parbox(x)|, where \verb|x| is the width of the text, to switch to a multiline mode (its called vertical mode in \TeX/\LaTeX). \begin{figure} @@ -104,7 +106,7 @@ example have an effect), \verb|vshift.middlezero=vshift.char(0.5)| (shifts down by halve of the height of a \verb|0|), \verb|vshift.topzero=vshift.char(1)| (shifts down by the height of the a -\verb|0|), vshift.mathaxis (shifts down by the height of the +\verb|0|), \verb|vshift.mathaxis| (shifts down by the height of the mathematical axis) \item[Mathmode:] \verb|mathmode| switches the mathmode of \TeX/\LaTeX \item[Font size:] \verb|size.tiny|, \verb|size.scriptsize|, @@ -116,8 +118,8 @@ mathematical axis) \section{\TeX/\LaTeX{} message parsers} Message parsers are used to scan the output of \TeX/\LaTeX. The output -is analyzed by a sequence of message parsers. Each of them do analyze -the output and remove those parts of the output, they feal responsible +is analysed by a sequence of message parsers. Each of them analyses +the output and remove those parts of the output, it feels responsible for. If there is nothing left in the end, the message got validated, otherwise an exception is raised reporting the problem. @@ -131,7 +133,7 @@ parser name&purpose\\ \end{tabular} \medskip -More specialized message parsers should become available as required. +More specialised message parsers should become available as required. Please feal free to contribute (e.g. with ideas/problems; code is desired as well, of course). There are further message parsers for \PyX{}s internal use, but we skip them here as they are not -- 2.11.4.GIT