[latexrefman-commits] [SCM] latexrefman updated: r956 - trunk
Vincent Belaiche
INVALID.NOREPLY at gnu.org.ua
Thu Aug 12 13:34:54 CEST 2021
Author: vincentb1
Date: 2021-08-12 11:34:54 +0000 (Thu, 12 Aug 2021)
New Revision: 956
Modified:
trunk/ChangeLog
trunk/latex2e.texi
Log:
[en] slurp some stuff from French version to ``Command line input'', and more.
* latex2e.texi (Command line input): Add more text from the French
version to be translated.
(\day & \month & \year): wording + refer to Command line input.
(\bigskip & \medskip & \smallskip): wording.
(\mbox & \makebox): add TODO after discussion with Karl.
(\fbox & \framebox): ``lines'' -> ``rules''. Remove word
``split''. ``height'' -> ``total height''. Suppress spurious space
in example.
(\@@dottedtocline): Ref to \contentsline + wording.
(\addcontentsline): Add some refs, notably about root-name + some
clarification & wording.
(\contentsline): base file -> root file. tocloft & hyperref to
Index + clarification about the hyperref addition error.
(\numberline): Minor fix.
(Command line input): Slurp the text from the French version.
Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog 2021-08-11 14:29:13 UTC (rev 955)
+++ trunk/ChangeLog 2021-08-12 11:34:54 UTC (rev 956)
@@ -1,3 +1,21 @@
+2021-08-12 Vincent Bela\"iche <vincentb1 at users.sourceforge.net>
+
+ * latex2e.texi (Command line input): Add more text from the French
+ version to be translated.
+ (\day & \month & \year): wording + refer to Command line input.
+ (\bigskip & \medskip & \smallskip): wording.
+ (\mbox & \makebox): add TODO after discussion with Karl.
+ (\fbox & \framebox): ``lines'' -> ``rules''. Remove word
+ ``split''. ``height'' -> ``total height''. Suppress spurious space
+ in example.
+ (\@@dottedtocline): Ref to \contentsline + wording.
+ (\addcontentsline): Add some refs, notably about root-name + some
+ clarification & wording.
+ (\contentsline): base file -> root file. tocloft & hyperref to
+ Index + clarification about the hyperref addition error.
+ (\numberline): Minor fix.
+ (Command line input): Slurp the text from the French version.
+
2021-08-11 Jim Hefferon <jhefferon at smcvt.edu>
* latex2e.texi (Indexes): Expand section header text.
Modified: trunk/latex2e.texi
===================================================================
--- trunk/latex2e.texi 2021-08-11 14:29:13 UTC (rev 955)
+++ trunk/latex2e.texi 2021-08-12 11:34:54 UTC (rev 956)
@@ -10788,9 +10788,9 @@
@LaTeX{} defines the counter @code{\day} for the day of the month
(nominally with value between 1 and 31), @code{\month} for the month of
-the year (nominally with value between 1 and 12), and year @code{\year}.
-When @TeX{} starts up, they are set from the current values on the
-system. The related command @code{\today} produces a string
+the year (nominally with value between 1 and 12), and @code{\year} for
+the year. When @TeX{} starts up, they are set from the current values
+on the system. The related command @code{\today} produces a string
representing the current day (@pxref{\today}).
They counters are not updated as the job progresses so in principle they
@@ -10805,6 +10805,8 @@
gives no error or warning and results in the output @samp{-2, -4} (the
bogus month value produces no output).
+ at xref{Command line input}, to force the date to a given valye from the
+command line.
@node Lengths
@chapter Lengths
@@ -15673,7 +15675,7 @@
@end ftable
-Because each command is a @code{\vspace}, if you use on in mid-paragraph
+Because each command is a @code{\vspace}, if you use it in mid-paragraph
then it will insert its vertical space between the line in which you use
it and the next line, not necessarily at the place that you use it. So
these are best between paragraphs.
@@ -16084,6 +16086,10 @@
Flush right.
@item s
+ at c xx TODO add a generic node to make clear that some statement may be
+ at c not true for some internationalization or some script. Eg. in Arabic
+ at c script or with microtype package I think that the strech also plays
+ at c on word width
Stretch the interword space in @var{text} across the entire @var{width}.
The @var{text} must contain stretchable space for this to work. For
instance, this could head a press release:
@@ -16140,7 +16146,7 @@
\framebox[@var{width}][@var{position}]@{@var{text}@}
@end example
-Create a box with an enclosing frame, four lines surrounding the space.
+Create a box with an enclosing frame, four rules surrounding the @var{text}.
These commands are the same as @code{\mbox} and @code{\makebox} except
for the frame (@pxref{\mbox & \makebox}). The @code{\fbox} command is
robust, the @code{\framebox} command is fragile (@pxref{\protect}).
@@ -16150,8 +16156,8 @@
@end example
@noindent
- at LaTeX{} puts the text into a box that cannot be split or hyphenated.
-Around that box, separated from it by a small gap, are four lines making
+ at LaTeX{} puts the text into a box, the text cannot be hyphenated.
+Around that box, separated from it by a small gap, are four rules making
a frame.
The first two command invocations, @code{\fbox@{...@}} and
@@ -16166,7 +16172,7 @@
@end example
@noindent
-The @code{\strut} inserts a vertical height of @code{\baselineskip}
+The @code{\strut} ensures a total height of @code{\baselineskip}
(@pxref{\strut}).
These parameters determine the frame layout.
@@ -16177,7 +16183,7 @@
@findex frame, line width
@findex frame rule width
@cindex \fboxrule
-The thickness of the lines around the enclosed box. The default is
+The thickness of the rules around the enclosed box. The default is
0.2 at dmn{pt}. Change it with a command such as
@code{\setlength@{\fboxrule@}@{0.8pt@}} (@pxref{\setlength}).
@@ -16191,7 +16197,7 @@
this will put a frame around the picture with no white border.
@example
-@{\setlength@{\fboxsep@}@{0pt@}
+@{\setlength@{\fboxsep@}@{0pt@}%
\framebox@{%
\includegraphics[width=0.5\textwidth]@{prudence.jpg@}@}@}
@end example
@@ -16215,9 +16221,9 @@
@xref{Colored boxes}, for colors other than black and white.
-The @code{picture} environment has a version of this command where the
-units depend on @code{picture}'s @code{\unitlength} (@pxref{\framebox
-(picture)}).
+The @code{picture} environment has a version of the @code{\framebox}
+command where the units depend on @code{picture}'s @code{\unitlength}
+(@pxref{\framebox (picture)}).
@node \parbox
@@ -19311,19 +19317,19 @@
In this example, @code{\@@dottedcline} appears to have been given only
three arguments. But tracing the internal code shows that it picks up
the final @var{text} and @var{pagenumber} arguments in the synopsis
-from a call to @code{\contentsline}.
+from a call to @code{\contentsline} (@pxref{\contentsline}).
@cindex leaders, dots in table of contents
Between the box for the title text of a section and the right margin
box, these @code{\@@dottedtocline} commands insert @dfn{leaders}, that
is, evenly-spaced dots. The dot-to-dot space is given by the command
- at code{\@@dotsep}. By default it is 4.5 (it is in math units, which
-are @code{1/18}@tie{}em. Change it using @code{\renewcommand}, as
-in @code{\renewcommand@{\@@dotsep@}@{3.5@}}.
+ at code{\@@dotsep}. By default it is 4.5 (it is in math units, aka.@:
+ at code{mu}, which are @code{1/18}@tie{}em. Change it using
+ at code{\renewcommand}, as in @code{\renewcommand@{\@@dotsep@}@{3.5@}}.
-In the default book class, @LaTeX{} does not use dotted leaders for
-the Part and Chapter table entries, and in the default article class
-it does not use dotted leaders for Section entries.
+In the standard @file{book} class, @LaTeX{} does not use dotted leaders
+for the Part and Chapter table entries, and in the standard
+ at file{article} class it does not use dotted leaders for Section entries.
@node \addcontentsline
@@ -19351,22 +19357,24 @@
@noindent
It will appear at the same indentation level as the sections, will be in
boldface, and will be assigned the page number associated with the point
-where it appears in the input file.
+where the command appears in the input file.
The @code{\addcontentsline} command writes information to the file
- at file{@var{root-name}. at var{ext}}. It writes that information as the
-text of the command
+ at file{@var{root-name}. at var{ext}}, where @var{root-name} is the file name
+of the root file (@pxref{Splitting the input}). It writes that
+information as the text of the command
@code{\contentsline@{@var{unit}@}@{@var{text}@}@{@var{num}@}}, where
@code{@var{num}} is the current value of counter @code{@var{unit}}
(@pxref{\contentsline}). The most common case is the table of contents
and there @var{num} is the page number of the first page of @var{unit}.
This command is invoked by the sectioning commands @code{\chapter},
-etc., and also by @code{\caption} inside a float environment. But it is
-also used by authors. For example, an author writing a book whose style
-is to have an unnumbered preface may use the starred @code{\chapter*}.
-But that command leaves out table of contents information, which can be
-entered manually, as here.
+etc. (@pxref{Sectioning}), and also by @code{\caption} inside a float
+environment (@pxref{Floats}). But it is also directly used by authors.
+For example, an author writing a book whose style is to have an
+unnumbered preface may use the starred @code{\chapter*}. But that
+command leaves out table of contents information, which can be entered
+manually, as here.
@example
\chapter*@{Preface@}
@@ -19374,9 +19382,10 @@
@end example
@noindent
-In the @file{.toc} file @LaTeX{} will put the line @code{\contentsline
-@{chapter@}@{\numberline @{@}Preface@}@{3@}}; note that the page number
- at samp{3} is automatically generated by the system, not entered manually.
+In the @file{@var{root-name}.toc} file @LaTeX{} will put the line
+ at code{\contentsline @{chapter@}@{\numberline @{@}Preface@}@{3@}}; note
+that the page number @samp{3} is automatically generated by the system,
+not entered manually.
All of the arguments for @code{\addcontentsline} are required.
@@ -19387,7 +19396,8 @@
tables. The filename extension of the information file.
@item unit
-A string that depends on the value of the @var{ext} argument:
+A string that depends on the value of the @var{ext} argument, typically
+one of:
@table @code
@item toc
@@ -19402,8 +19412,8 @@
@end table
@item text
-The text of the entry. You must @code{\protect} any commands that are
-fragile (@pxref{\protect}).
+The text of the entry. You must @code{\protect} any fragile commands
+(@pxref{\protect}) used in it.
@end table
The @code{\addcontentsline} command has an interaction with
@@ -19413,7 +19423,8 @@
in the table of contents can come out in the wrong order. The solution
is to move @code{\addcontentsline} into the file being included.
-If you use a @var{unit} that @LaTeX{} does not recognize, as here
+If you use a @var{unit} that @LaTeX{} does not recognize, as with the
+typo here
@example
\addcontentsline@{toc@}@{setcion@}@{\protect\textbf@{Appendices@}@}
@@ -19528,7 +19539,7 @@
commands @code{\chapter}, @code{\section}, etc. for the table of
contents, or by the @code{\caption} command inside of a @code{\figure}
or @code{\table} environment (@pxref{figure} and @pxref{table}). Thus,
-where the base file is @file{thesis.tex}, and contains the declaration
+where the root file is @file{thesis.tex}, and contains the declaration
@code{\tableofcontents}, the command @code{\chapter@{Chapter One@}}
produces something like this in the file @file{thesis.toc}.
@@ -19549,15 +19560,18 @@
where @var{filetype} is @code{toc}, @code{lof}, or @code{lot}
(@pxref{\addcontentsline}).
+ at PkgIndex{tocloft}
For manipulating how the @code{\contentline} material is typeset, see
the @file{tocloft} package.
+ at PkgIndex{hyperref}
Note that the @code{hyperref} package changes the definition of
@code{\contentsline} (and @code{\addcontentsline}) to add more
arguments, to make hyperlinks. This is the source of the error
- at code{Argument of \contentsline has an extra @}}. Fix this error by
-deleting the @file{.toc} or @file{.lof} or @file{.lot} file, and running
- at LaTeX{} again.
+ at code{Argument of \contentsline has an extra @}} when one adds/remove
+the use of package @file{hyperref} and a compilation was already run.
+Fix this error by deleting the @file{.toc} or @file{.lof} or @file{.lot}
+file, and running @LaTeX{} again.
@node \nofiles
@@ -19609,7 +19623,7 @@
@code{\contentsline} command to typeset the section number
(@pxref{\contentsline}).
-For example, this line in a @file{.toc} file causes the @code{1} to be
+For example, this line in a @file{.toc} file causes the @code{1.1} to be
typeset flush left.
@example
@@ -19620,16 +19634,17 @@
@code{\@@tempdima}. That length is set by the commands
@code{\l@@section}, @code{\l@@subsection}, etc. Put section numbers
inside a natural-width box with
- at code{\renewcommand@{\numberline@}[1]@{#1~@}}.
+ at code{\renewcommand@{\numberline@}[1]@{#1~@}} before
+ at code{\tableofcontents}.
This command is fragile, so you may need to precede it with
@code{\protect} (@pxref{\protect}). An example is the use of
@code{\protect} in the command
@code{\addcontentsline@{toc@}@{section@}@{\protect\numberline@{@}Summary@}}
-to get the @code{\numberline} into this command in the @file{.toc} file:
- at code{\contentsline @{section@}@{\numberline @{@}Summary@}@{6@}} (the
-page number @samp{6} is automatically added by @LaTeX{};
- at pxref{\addcontentsline}).
+to get the @code{\numberline} into the @code{\contentsline} command in
+the @file{.toc} file: @code{\contentsline @{section@}@{\numberline
+@{@}Summary@}@{6@}} (the page number @samp{6} is automatically added by
+ at LaTeX{}; @pxref{\addcontentsline}).
@node Indexes
@@ -21577,7 +21592,62 @@
but replaced in the PDF by a box with same size and that contains only
the file name, which speeds up compilation time and saves printer ink.
+ at c xx to be translated to English.
+ at ignore
+Un autre exemple classique est de cribler certains chapitres à la
+compilation en les passant à @code{\includeonly} dans la ligne de
+commande. Ainsi, supposons qu'on a un fichier racine @file{livre.tex}
+ainsi formé :
+ at example
+\documentclass@{book@}
+\begin@{document@}
+\frontmatter
+\include@{pref@}
+\mainmatter
+\include@{chap1@}
+\include@{chap2@}
+\appendix
+\include@{append@}
+\backmatter
+\include@{bib@}
+\end@{document@}
+ at end example
+
+En compilant @file{livre.tex} avec la ligne de commande suivante :
+
+ at example
+pdflatex '\includeonly@{chap1@}\input@{livre@}
+ at end example
+
+ at noindent
+seul le chapitre contenu dans @file{chap1.tex} sera produit en
+sortie. @xref{Splitting the input}.
+
+Dans ce dernier exemple, on force la date au 14 juillet 1789 :
+
+ at example
+pdflatex '\day=14 \month=7 \year=1789 \input revolution'
+ at end example
+
+Ainsi, si le fichier @file{revolution.tex} contient ceci :
+
+ at example
+\documentclass[french]@{minimal@}
+\usepackage@{babel@}
+\begin@{document@}
+\today\ c'est la Révolution~!
+\end@{document@}
+ at end example
+
+ at noindent
+alors vous aurez en sortie un truc du genre :
+
+ at example
+14 juillet 1789 c'est la Révolution !
+ at end example
+ at end ignore
+
@node Jobname
@section Jobname
More information about the latexrefman-commits
mailing list.