[latexrefman-commits] [SCM] latexrefman updated: r994 - trunk
Vincent Belaiche
INVALID.NOREPLY at gnu.org.ua
Sun Aug 22 23:49:38 CEST 2021
Author: vincentb1
Date: 2021-08-22 21:49:38 +0000 (Sun, 22 Aug 2021)
New Revision: 994
Modified:
trunk/ChangeLog
trunk/latex2e.texi
trunk/writing.html
Log:
[en] Fixes some references, and many minor clarifications.
* latex2e.texi (array): Add reference to ``Modes'' where
applicable, and change erroneous reference to ``Modes'' into
``Math styles''. Remove ``(package)'' from @PkdIndex argument, the
macro already adds this. @file -> @pacakge.
(\line): Remove extra indexing of ``pict2e'' as a package.
(\linethickness): Add reference to ``\oval'', as ovals are not
ellipse and you have to read the \oval node to know this.
(\thicklines): Fix reference ``picture'' -> ``\qbezier''.
(\oval): @dfn{...}-ize the term oval. ``boxes'' -> ``frames''.
(\shortstack): Fix the example which did not compile, and make it
complete. Clarify \makebox is used. Clarify baseline skip and not
just height can be controlled in some ways.
(makeindex): Clarify index of makeindex by mentionning
``program''. @var{attributes} -> @var{attribute}s. ``output file''
-> ``output index file''. ``starting with a'' -> ``starting with
letter a'', otherwise it sounds strange because ``a'' is an
article in English, as in ``*a* pear''. @uref{...}-ize the xindy
URL.
* writing.html (Document structure): Add item ``Check
references''.
Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog 2021-08-21 15:28:07 UTC (rev 993)
+++ trunk/ChangeLog 2021-08-22 21:49:38 UTC (rev 994)
@@ -1,3 +1,42 @@
+2021-08-22 Vincent Bela\"iche <vincentb1 at users.sourceforge.net>
+
+ * writing.html (Document structure): Add item ``Check
+ references''.
+
+ * latex2e.texi (array): Add reference to ``Modes'' where
+ applicable, and change erroneous reference to ``Modes'' into
+ ``Math styles''. Remove ``(package)'' from @PkdIndex argument, the
+ macro already adds this. @file -> @pacakge.
+ (\line): Remove extra indexing of ``pict2e'' as a package.
+ (\linethickness): Add reference to ``\oval'', as ovals are not
+ ellipse and you have to read the \oval node to know this.
+ (\thicklines): Fix reference ``picture'' -> ``\qbezier''.
+ (\oval): @dfn{...}-ize the term oval. ``boxes'' -> ``frames''.
+ (\shortstack): Fix the example which did not compile, and make it
+ complete. Clarify \makebox is used. Clarify baseline skip and not
+ just height can be controlled in some ways.
+ (makeindex): Clarify index of makeindex by mentionning
+ ``program''. @var{attributes} -> @var{attribute}s. ``output file''
+ -> ``output index file''. ``starting with a'' -> ``starting with
+ letter a'', otherwise it sounds strange because ``a'' is an
+ article in English, as in ``*a* pear''. @uref{...}-ize the xindy
+ URL.
+
+2021-08-21 Vincent Bela\"iche <vincentb1 at users.sourceforge.net>
+
+ * writing.html (Document structure): new section.
+
+2021-08-19 Vincent Bela\"iche <vincentb1 at users.sourceforge.net>
+
+ * latex2e.texi: in all document uniformize @code{...} or
+ @file{...} for package names to @code{...}.
+
+2021-08-19 Vincent Bela\"iche <vincentb1 at users.sourceforge.net>
+
+ * latex2e.texi (\caption): Clarify ``vertical'' blank. Use @pxref
+ where applicable. ``moving text'' -> ``moving argument''.
+ (\index): Mention that " also needs escaping.
+
2021-08-17 Vincent Bela\"iche <vincentb1 at users.sourceforge.net>
* writing.html (Coding conventions): Mention to use @PkgIndex
Modified: trunk/latex2e.texi
===================================================================
--- trunk/latex2e.texi 2021-08-21 15:28:07 UTC (rev 993)
+++ trunk/latex2e.texi 2021-08-22 21:49:38 UTC (rev 994)
@@ -4763,10 +4763,10 @@
@end example
Produce a mathematical array. This environment can only be used in math
-mode, and normally appears within a displayed mathematics environment
-such as @code{equation} (@pxref{equation}). Inside of each row the
-column entries are separated by an ampersand, (@code{&}). Rows are
-terminated with double-backslashes (@pxref{\\}).
+mode (@pxref{Modes}), and normally appears within a displayed
+mathematics environment such as @code{equation} (@pxref{equation}).
+Inside of each row the column entries are separated by an ampersand,
+(@code{&}). Rows are terminated with double-backslashes (@pxref{\\}).
This example shows a three by three array.
@@ -4793,7 +4793,7 @@
There are two ways that @code{array} diverges from @code{tabular}. The
first is that @code{array} entries are typeset in math mode, in
-textstyle (@pxref{Modes}) except if the @var{cols} definition specifies
+textstyle (@pxref{Math styles}) except if the @var{cols} definition specifies
the column with @code{p@{...@}}, which causes the entry to be typeset in
text mode. The second is that, instead of @code{tabular}'s parameter
@code{\tabcolsep}, @LaTeX{}'s intercolumn space in an @code{array} is
@@ -4827,9 +4827,9 @@
\end@{equation@}
@end example
- at PkgIndex{array (package)}
+ at PkgIndex{array}
@PkgIndex{dcolumn}
-There are many packages concerning arrays. The @file{array} package has
+There are many packages concerning arrays. The @package{array} package has
many useful extensions, including more column types. The @package{dcolumn}
package adds a column type to center on a decimal point. For both see
the documentation on CTAN.
@@ -6813,7 +6813,6 @@
If @var{travel} is negative then you get @code{LaTeX Error: Bad \line or
\vector argument.}
- at cindex @package{pict2e} package
@cindex graphics packages
@PkgIndex{pict2e}
@PkgIndex{TikZ}
@@ -6849,7 +6848,7 @@
picture to be @var{dim}, which must be a positive length
(@pxref{Lengths}). It differs from @code{\thinlines} and
@code{\thicklines} in that it does not affect the thickness of slanted
-lines, circles, or ovals.
+lines, circles, or ovals (@pxref{\oval}).
@node \thinlines
@@ -6871,7 +6870,7 @@
Declaration to set the thickness of subsequent lines, circles, and ovals
in a picture environment to be 0.8 at dmn{pt}. See also
@ref{\linethickness} and @ref{\thinlines}. This command is illustrated
-in the Trapezoidal Rule example of @ref{picture}.
+in the Trapezoidal Rule example of @ref{\qbezier}.
@node \circle
@@ -6912,9 +6911,10 @@
\oval(@var{width}, at var{height})[@var{portion}]
@end example
-Produce a rectangle with rounded corners. The optional argument
- at var{portion} allows you to produce only half or a quarter of the oval.
-For half an oval take @var{portion} to be one of these.
+Produce a rectangle with rounded corners, hereinafter referred to as an
+ at dfn{oval}. The optional argument @var{portion} allows you to produce
+only half or a quarter of the oval. For half an oval take @var{portion}
+to be one of these.
@table @code
@item t
@@ -6943,7 +6943,7 @@
These shapes are not ellipses. They are rectangles whose corners are
made with quarter circles. These circles have a maximum radius of
20 at dmn{pt} (@pxref{\circle} for the sizes). Thus large ovals are just
-boxes with a small amount of corner rounding.
+frames with a small amount of corner rounding.
@node \shortstack
@@ -6959,19 +6959,23 @@
Produce a vertical stack of objects.
-This labels the @math{y} axis.
+This labels the @math{y} axis by writing the word @samp{@math{y}} above
+the word @samp{axis}.
@example
-\put(0,0)@{\vector(1,0)@{4@}@} % x axis
-\put(0,0)@{\vector(0,1)@{2@}@} % y
-\put(-0.25,2)@{\makebox[0][r]@{\shortstack[r]@{$y$\\ axis@}@}@}
+\setlength@{\unitlength@}@{1cm@}
+\begin@{picture@}(5,2.5)(-0.75,0)
+ \put(0,0)@{\vector(1,0)@{4@}@} % x axis
+ \put(0,0)@{\vector(0,1)@{2@}@} % y
+ \put(-0.2,2)@{\makebox(0,0)[r]@{\shortstack[r]@{$y$\\ axis@}@}@}
+\end@{picture@}
@end example
@noindent
For a short stack, the reference point is the lower left of the stack.
-In the above example the @ref{\mbox & \makebox} puts the stack flush
-right in a zero width box so in total the short stack sits slightly to
-the left of the @math{y}@tie{}axis.
+In the above example the @code{\makebox} (@pxref{\mbox & \makebox}) puts
+the stack flush right in a zero width box so in total the short stack
+sits slightly to the left of the @math{y}@tie{}axis.
The valid positions are:
@@ -6987,11 +6991,13 @@
@findex \\ @r{(for @code{\shortstack} objects)}
Separate objects into lines with @code{\\}. These stacks are short in
that, unlike in a @code{tabular} or @code{array} environment, here the
-rows are not spaced out to be of even heights. Thus, in
+rows are not spaced out to be of even baseline skips. Thus, in
@code{\shortstack@{X\\o\\o\\X@}} the first and last rows are taller than
-the middle two. You can adjust row heights either by putting in the
-usual interline spacing with @code{\shortstack@{X\\ \strut o\\o\\X@}},
-or by hand, via an explicit zero-width box @code{\shortstack@{X \\
+the middle two, and therefore the baseline skip between the two middle
+rows is smaller than that between the third and last row. You can
+adjust row heights and depths either by putting in the usual interline
+spacing with @code{\shortstack@{X\\ \strut o\\o\\X@}} (@pxref{\strut}),
+or explicitly, via an zero-width box @code{\shortstack@{X \\
\rule@{0pt@}@{12pt@} o\\o\\X@}} or by using @code{\\}'s optional
argument @code{\shortstack@{X\\[2pt] o\\o\\X@}}.
@@ -20009,7 +20015,7 @@
@subsection @command{makeindex}
@cindex index, processing
- at findex makeindex
+ at findex makeindex, @r{program}
@cindex @command{makeindex} program
@cindex @file{.ind} file
@cindex @file{.idx} file
@@ -20059,7 +20065,7 @@
A style file consists of a list of pairs: @var{specifier} and
@var{attribute}. These can appear in the file in any order. All of the
- at var{attributes} are strings, except where noted. Strings are
+ at var{attribute}s are strings, except where noted. Strings are
surrounded with double quotes, @code{"}, and the maximum length of a
string is 144 characters. The @code{\n} is for a newline and @code{\t}
is for a tab. Backslashes are escaped with another backslash,
@@ -20069,21 +20075,21 @@
@ftable @code
@anchor{makeindex preamble}
@item preamble
-Preamble of the output file. Defines the context in which the index is
+Preamble of the output index file. Defines the context in which the index is
formatted. Default: @code{"\\begin@{theindex@}\n"}.
@anchor{makeindex postamble}
@item postamble
-Postamble of the output file. Default: @code{"\n\n\\end@{theindex@}\n"}.
+Postamble of the output index file. Default: @code{"\n\n\\end@{theindex@}\n"}.
@anchor{makeindex group skip}
@item group_skip
@findex \indexspace
Traditionally index items are broken into groups, typically a group for
-entries starting with @samp{a}, etc. This specifier gives what is
-inserted when a new group begins. Default: @code{"\n\n \\indexspace\n"}
-(@code{\indexspace} is a command inserting a rubber length, by default
- at code{10pt plus5pt minus3pt}).
+entries starting with letter @samp{a}, etc. This specifier gives what
+is inserted when a new group begins. Default: @code{"\n\n
+\\indexspace\n"} (@code{\indexspace} is a command inserting a rubber
+length, by default @code{10pt plus5pt minus3pt}).
@anchor{makeindex letheadflag}
@item lethead_flag
@@ -20197,7 +20203,7 @@
@findex xindy @r{program}
There are a number of other programs that do the job
@command{makeindex} does. One is @command{xindy}
-(https://ctan.org/pkg/xindy), which does internationalization and can
+(@uref{https://ctan.org/pkg/xindy}), which does internationalization and can
process indexes for documents marked up using @LaTeX{} and a number of
other languages. It is written in Lisp, highly configurable, both in
markup terms and in terms of the collating order of the text, as
Modified: trunk/writing.html
===================================================================
--- trunk/writing.html 2021-08-21 15:28:07 UTC (rev 993)
+++ trunk/writing.html 2021-08-22 21:49:38 UTC (rev 994)
@@ -304,7 +304,10 @@
you do this, it becomes more difficult for the translators to track down what content change has happened. Do this
sort of evolution as two separate changes. If you don't have SVN access to the latexrefman repo, you can create a
local SVN or GIT repo, make the sequence of changes there, and then send the corresponding patch files. Or otherwise
- make the changes as two separate contribution, and wait for the repo update between both.
+ make the changes as two separate contribution, and wait for the repo update between both.
+ <li><span class="listitem">Check references</span>Last, but not least, whenever you move some material from one node
+ to another, please check whether any reference to the former node has, or not, to be changed to a reference to the
+ latter.</li>
</ul>.
<hr/>
More information about the latexrefman-commits
mailing list.