[latexrefman-commits] [SCM] latexrefman updated: r989 - trunk
Vincent Belaiche
INVALID.NOREPLY at gnu.org.ua
Tue Aug 17 20:41:31 CEST 2021
Author: vincentb1
Date: 2021-08-17 18:41:31 +0000 (Tue, 17 Aug 2021)
New Revision: 989
Modified:
trunk/ChangeLog
trunk/latex2e.texi
trunk/writing.html
Log:
[en] Restore statement on setspace doing single-line in footnotes, and much more.
* latex2e.texi (Font sizes): typo.
(Low-level font commands): Place @anchor{...} immediately before
@item, see this thread
https://lists.gnu.org/archive/html/help-texinfo/2021-08/msg00000.html
For \linespread reword text about setspace package with a
reference to node ``\baselineskip & \baselinestretch''.
(\baselineskip & \baselinestretch): @dfn{...}-ize word
``leading''. @dmn{...}-ize units. Reword statement about baskine
skip/font size ratio. @noindent after example. Restore statement
about setspace producing single-spaced lines where typically
desirable.
(xr package): Use @PkgIndex. @noindent before or, after
example. @code -> @file.
(\footnote): index strut.
(\ignorespaces & \ignorespacesafterend): blanks, not spaces. And
also says that a box, not only a non-blank stops the
space-ignoring. Typo, add ``\''.
(xspace package): Reword to use ``control sequence'', ``control
word'', ``control symbol'' and add reference to ``Control
sequences'' node. Say to place \xspace at the very end of the
definition. Clarify \xspaceaddexceptions example adds two
exceptions.
(Expressions): Add reference about scaled points.
(\mathstrut): index strut.
(~): @dfn{...}-ize word ``tie''. Add a note that meaning of
``tie'' in typography differs from this TeX-community specific
meaning. Reword what concerns label/number month/day tieing.
(inputenc package): @samp{...}-ize @"{a}. index+anchor for \inputenc macro.
(Indexes): clarify the showidx places the note where \index
is. Comment in example for filename. Reword the enigmatic
``nothing appears''.
(\index): ``\'' -> ``|'' where applicable. ``page entry'' ->
``page number''. ``see'' not ``See'' is the default, same for
``see also''. ``\seename'' is a no-arg macro, ``see'' is a two arg
macro.
(\printindex): Remove one too many @findex. Add @PkgIndex{makeidx}.
(Command line input): Add reference to Jobname node.
(Jobname): index ``root file'', and explain this term and its
relation to job name. ``For example'' -> ``That is'', and reword
``before any output'' to ``before any input file is met''.
* writing.html (Coding conventions): Mention to use @PkgIndex
where applicable.
Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog 2021-08-16 15:29:44 UTC (rev 988)
+++ trunk/ChangeLog 2021-08-17 18:41:31 UTC (rev 989)
@@ -1,3 +1,49 @@
+2021-08-17 Vincent Bela\"iche <vincentb1 at users.sourceforge.net>
+
+ * writing.html (Coding conventions): Mention to use @PkgIndex
+ where applicable.
+
+ * latex2e.texi (Font sizes): typo.
+ (Low-level font commands): Place @anchor{...} immediately before
+ @item, see this thread
+ https://lists.gnu.org/archive/html/help-texinfo/2021-08/msg00000.html
+ For \linespread reword text about setspace package with a
+ reference to node ``\baselineskip & \baselinestretch''.
+ (\baselineskip & \baselinestretch): @dfn{...}-ize word
+ ``leading''. @dmn{...}-ize units. Reword statement about baskine
+ skip/font size ratio. @noindent after example. Restore statement
+ about setspace producing single-spaced lines where typically
+ desirable.
+ (xr package): Use @PkgIndex. @noindent before or, after
+ example. @code -> @file.
+ (\footnote): index strut.
+ (\ignorespaces & \ignorespacesafterend): blanks, not spaces. And
+ also says that a box, not only a non-blank stops the
+ space-ignoring. Typo, add ``\''.
+ (xspace package): Reword to use ``control sequence'', ``control
+ word'', ``control symbol'' and add reference to ``Control
+ sequences'' node. Say to place \xspace at the very end of the
+ definition. Clarify \xspaceaddexceptions example adds two
+ exceptions.
+ (Expressions): Add reference about scaled points.
+ (\mathstrut): index strut.
+ (~): @dfn{...}-ize word ``tie''. Add a note that meaning of
+ ``tie'' in typography differs from this TeX-community specific
+ meaning. Reword what concerns label/number month/day tieing.
+ (inputenc package): @samp{...}-ize @"{a}. index+anchor for \inputenc macro.
+ (Indexes): clarify the showidx places the note where \index
+ is. Comment in example for filename. Reword the enigmatic
+ ``nothing appears''.
+ (\index): ``\'' -> ``|'' where applicable. ``page entry'' ->
+ ``page number''. ``see'' not ``See'' is the default, same for
+ ``see also''. ``\seename'' is a no-arg macro, ``see'' is a two arg
+ macro.
+ (\printindex): Remove one too many @findex. Add @PkgIndex{makeidx}.
+ (Command line input): Add reference to Jobname node.
+ (Jobname): index ``root file'', and explain this term and its
+ relation to job name. ``For example'' -> ``That is'', and reword
+ ``before any output'' to ``before any input file is met''.
+
2021-08-16 Jim Hefferon <jhefferon at smcvt.edu>
* latex2e.texi (\caption): Add section on \caption. Put in
cross-references to figure and table entries.
Modified: trunk/latex2e.texi
===================================================================
--- trunk/latex2e.texi 2021-08-16 15:29:44 UTC (rev 988)
+++ trunk/latex2e.texi 2021-08-17 18:41:31 UTC (rev 989)
@@ -2,7 +2,7 @@
@c $Id$
@comment %**start of header (This is for running Texinfo on a region.)
@setfilename latex2e.info
- at set UPDATED July 2021
+ at set UPDATED August 2021
@include common.texi
@settitle @LaTeX{}2e unofficial reference manual (@value{UPDATED})
@comment %**end of header (This is for running Texinfo on a region.)
@@ -2346,7 +2346,7 @@
change. To work with a too-large formula, often the best option is to
use the @code{displaymath} environment (@pxref{Math formulas}), or
one of the environments from the @file{amsmath} package. For inline
-mathematics, such as in a tableof formulas, an alternative is something
+mathematics, such as in a table of formulas, an alternative is something
like @code{@{\small $mv^2/2$@}}. (Sometimes @code{\scriptsize} and
@code{\scriptstyle} are confused. Both change the font size, but the
latter also changes a number of other aspects of how mathematics is
@@ -2521,10 +2521,10 @@
weight and width are @code{m}, in which case use just one
(@samp{@code{m}}).
+ at anchor{low level font commands fontshape}
@item \fontshape@{@var{shape}@}
@findex \fontshape
@cindex shapes, of fonts
- at anchor{low level font commands fontshape}
Select font shape. Valid shapes are:
@multitable {xx} {Slanted (oblique)xx}
@@ -2562,11 +2562,10 @@
@anchor{low level font commands linespread}
@item \linespread@{@var{factor}@}
@findex \linespread
-Equivalent to
- at code{\renewcommand@{\baselinestretch@}@{@var{factor}@}}, and
-therefore must be followed by @code{\selectfont} to have any effect.
-Best specified in the preamble, or use the @code{setspace} package, as
-just described.
+Equivalent to @code{\renewcommand@{\baselinestretch@}@{@var{factor}@}},
+and therefore must be followed by @code{\selectfont} to have any
+effect. Best specified in the preamble. @xref{\baselineskip &
+\baselinestretch}, for using @file{setspace} package instead.
@anchor{low level font commands selectfont}
@item \selectfont
@@ -3003,7 +3002,7 @@
@cindex double spacing
The @code{\baselineskip} is a rubber length (@pxref{Lengths}). It gives
-the leading, the normal distance between lines in a paragraph, from
+the @dfn{leading}, the normal distance between lines in a paragraph, from
baseline to baseline.
Ordinarily document authors do not directly change @code{\baselineskip}
@@ -3017,9 +3016,9 @@
Usually, a font's size and baseline skip is assigned by the font
designer. These numbers are nominal in the sense that if, for instance,
a font's style file has the command @code{\fontsize@{10pt@}@{12pt@}}
-then that does not mean that the characters in the font are 10pt tall;
+then that does not mean that the characters in the font are 10 at dmn{pt} tall;
for instance, parentheses and accented capitals may be taller. Nor does
-it mean that if the lines are spaced less than 12pt apart then they risk
+it mean that if the lines are spaced less than 12 at dmn{pt} apart then they risk
touching. Rather these numbers are typographic judgements. (Often, the
@code{\baselineskip} is about twenty percent larger than the font size.)
@@ -3056,15 +3055,15 @@
then @TeX{} instead uses @code{\lineskip} as the interline glue. The
second is that @TeX{} doesn't actually use the depth of the previous
line. Instead it uses @code{\prevdepth}, which usually contains that
-depth. But at the beginning of the paragraph (or any vertical list)
-or just after a rule, @code{\prevdepth} has the value -1000pt and this
-special value tells @TeX{} not to insert any interline glue at the
+depth. But at the beginning of the paragraph (or any vertical list) or
+just after a rule, @code{\prevdepth} has the value -1000 at dmn{pt} and
+this special value tells @TeX{} not to insert any interline glue at the
paragraph start.
-In the standard classes @code{\lineskiplimit} is 0pt and
- at code{\lineskip} is 1pt. By the prior paragraph then, the distance
+In the standard classes @code{\lineskiplimit} is 0 at dmn{pt} and
+ at code{\lineskip} is 1 at dmn{pt}. By the prior paragraph then, the distance
between lines can approach zero but if it becomes zero (or less than
-zero) then the lines jump to 1pt apart.
+zero) then the lines jump to 1 at dmn{pt} apart.
Sometimes authors must, for editing purposes, put the document in double
space or one-and-a-half space. The right way to influence the interline
@@ -3078,7 +3077,7 @@
For double spacing, take @var{factor} to be 1.6 and for one-and-a-half
spacing use 1.3. These number are rough: for instance, since the
@code{\baselineskip} is about 1.2 times the font size, multiplying by
-1.6 gives a font size to baseline ratio of about 2. (The
+1.6 gives a baseline skip to font size ratio of about 2. (The
@code{\linespread} command is defined as
@code{\renewcommand@{\baselinestretch@}@{@var{factor}@}} so it won't
take effect until a font setting happens. But that always takes place at
@@ -3093,6 +3092,7 @@
\doublespacing % or \onehalfspacing for 1.5
@end example
+ at noindent
In the preamble these will start the document off with that sizing.
But you can also use these declarations in the document body to change
the spacing from that point forward, and consequently there is
@@ -3102,8 +3102,10 @@
... \end@{doublespace@}}. The package also has commands to do
arbitrary spacing: @code{\setstretch@{@var{factor}@}} and
@code{\begin@{spacing@}@{@var{factor}@} ... \end@{spacing@}}.
+This package also keeps the line spacing single-spaced in places
+where that is typically desirable, such as footnotes and figure
+captions. See the package documentation.
-
@node Floats
@section Floats
@@ -4549,8 +4551,8 @@
@node xr package
@section @code{xr} package
- at findex @code{xr} package
- at findex @code{xr-hyper} package
+ at PkgIndex{xr}
+ at PkgIndex{xr-hyper}
@findex \externaldocument
@cindex cross referencing, across documents
@@ -4561,6 +4563,7 @@
\externaldocument@{@var{document-basename}@}
@end example
+ at noindent
or
@example
@@ -4569,9 +4572,9 @@
@end example
Make cross references to the external document
- at code{@var{document-basename}.tex}.
+ at file{@var{document-basename}.tex}.
-Here is an example. If @code{lectures.tex} has this in the preamble
+Here is an example. If @file{lectures.tex} has this in the preamble
@example
\usepackage@{xr@}
@@ -4580,21 +4583,24 @@
\externaldocument@{answers@}
@end example
+ at noindent
then it can use cross reference labels from the other three documents.
-Suppose that @code{exercises.tex} has an enumerated list containing
+Suppose that @file{exercises.tex} has an enumerated list containing
this,
@example
\item \label@{exer:EulersThm@} What if every vertex has odd degree?
@end example
-and @code{hints.tex} has an enumerated list with this,
+ at noindent
+and @file{hints.tex} has an enumerated list with this,
@example
\item \label@{exer:EulersThm@} Distinguish the case of two vertices.
@end example
-and @code{answers.tex} has an enumerated list with this.
+ at noindent
+and @file{answers.tex} has an enumerated list with this,
@example
\item \label@{ans:EulersThm@} There is no Euler path, except if there
@@ -4602,7 +4608,7 @@
@end example
After compiling the exercises, hints, and answers documents, entering
-this in the body of @code{lectures.tex} will result in the lectures
+this in the body of @file{lectures.tex} will result in the lectures
getting the reference numbers used in the other documents.
@example
@@ -9207,6 +9213,7 @@
@item \footnotesep
@anchor{footnote footnotesep}
+ at cindex strut
The height of the strut placed at the beginning of the footnote
(@pxref{\strut}). By default, this is set to the normal strut for
@code{\footnotesize} fonts (@pxref{Font sizes}), therefore there is no
@@ -10435,12 +10442,12 @@
\ignorespacesafterend
@end example
-Both commands cause @LaTeX{} to ignore spaces (that is, characters of
-category at tie{}10) after the end of the command, up until the first
-non-space character. The first is a command from plain @TeX{}, and the
-second is @LaTeX{}-specific.
+Both commands cause @LaTeX{} to ignore blanks (that is, characters of
+catcode at tie{}10 such as space or tabulation) after the end of the
+command up to the first box or non-blank character. The first is a
+command from plain @TeX{}, and the second is @LaTeX{}-specific.
-The @code{ignorespaces} is often used when defining commands via
+The @code{\ignorespaces} is often used when defining commands via
@code{\newcommand}, or @code{\newenvironment}, or @code{\def}. The
example below illustrates. It allows a user to show the points values
for quiz questions in the margin but it is inconvenient because, as
@@ -10463,7 +10470,7 @@
\makebox[0pt]@{\makebox[10em][l]@{#1~pts@}@}\ignorespaces@}
@end example
-A second example shows spaces being removed from the front of text. The
+A second example shows blanks being removed from the front of text. The
commands below allow a user to uniformly attach a title to names. But,
as given, if a title accidentally starts with a space then
@code{\fullname} will reproduce that.
@@ -10487,7 +10494,7 @@
@code{\begin@{newenvironment@}@{@var{env
name}@}@{... \ignorespaces@}@{...@}}.
-To strip spaces off the end of an environment use
+To strip blanks off the end of an environment use
@code{\ignorespacesafterend}. An example is that this will show a much
larger vertical space between the first and second environments than
between the second and third.
@@ -10526,13 +10533,15 @@
\newcommand@{...@}@{...\xspace@}
@end example
-The @code{\xspace} macro, when used at the end of a command, adds a
-space unless the command is followed by certain punctuation characters.
+The @code{\xspace} macro, when used at the end of a command defintion,
+adds a space unless the command is followed by certain punctuation
+characters.
-After a command name that uses letters (as opposed to single character
-command names using non-letters such as @code{\$}), @TeX{} gobbles white
-space. Thus, in the first sentence below, the output has @samp{Vermont}
-placed snugly against the period, without any intervening space.
+After a command control sequence that is a control word (@pxref{Control
+sequences}, as opposed to control symbols such as @code{\$}), @TeX{}
+gobbles blank characters. Thus, in the first sentence below, the output
+has @samp{Vermont} placed snugly against the period, without any
+intervening space.
@example
\newcommand@{\VT@}@{Vermont@}
@@ -10546,8 +10555,9 @@
@code{\ } for this. @xref{\(SPACE)}.)
The @file{xspace} package provides @code{\xspace}. It is for writing
-commands which are designed to be used mainly in text. It inserts a
-space after that command unless what immediately follows is in a list of
+commands which are designed to be used mainly in text. It must be place
+at the very end of the definition of these commands. It inserts a space
+after that command unless what immediately follows is in a list of
exceptions. In this example, the dummy braces are not needed.
@example
@@ -10559,8 +10569,9 @@
The default exception list contains the characters @code{,.'/?;:!~-)},
the open curly brace and the backslash-space command discussed above,
and the commands @code{\footnote} or @code{\footnotemark}. Add to that
-list as with @code{\xspaceaddexceptions@{\myfni \myfnii@}} and remove
-from that list as with @code{\xspaceremoveexception@{!@}}.
+list as with @code{\xspaceaddexceptions@{\myfni \myfnii@}} which adds
+ at code{\myfni} and at tie{}@code{\myfnii} to the list, and remove from that
+list as with @code{\xspaceremoveexception@{!@}}.
@c David Carlisle https://tex.stackexchange.com/a/86620/339
A comment: many experts prefer not to use @code{\xspace}. Putting it in
@@ -11457,10 +11468,11 @@
@TeX{} will coerce other numerical types in the same way as it does when
doing register assignment. Thus @code{\the\numexpr\dimexpr
1pt\relax\relax} will result in @samp{65536}, which is @code{1pt}
-converted to scaled points (@TeX{}'s internal unit) and then coerced
-into an integer. With a @code{\glueexpr} here, the stretch and shrink
-would be dropped. Going the other way, a @code{\numexpr} inside a
- at code{\dimexpr} or @code{\glueexpr} will need appropriate units, as in
+converted to scaled points (@pxref{units of length sp, at code{sp}},
+ at TeX{}'s internal unit) and then coerced into an integer. With a
+ at code{\glueexpr} here, the stretch and shrink would be dropped. Going
+the other way, a @code{\numexpr} inside a @code{\dimexpr} or
+ at code{\glueexpr} will need appropriate units, as in
@code{\the\dimexpr\numexpr 1 + 2\relax pt\relax}, which produces
@samp{3.0pt}.
@@ -14301,6 +14313,7 @@
@cindex math mode, spacing
@cindex invisible character
@cindex character, invisible
+ at cindex strut, math
Synopsis:
@@ -15485,11 +15498,17 @@
@var{before}~@var{after}
@end example
-The tie character, @code{~}, produces a space between @var{before} and
+The @dfn{tie} character, @code{~}, produces a space between @var{before} and
@var{after} at which the line will not be broken. By default the white
space has length 3.33333 at dmn{pt} plus 1.66666 at dmn{pt} minus
1.11111 at dmn{pt} (@pxref{Lengths}).
+ at c This paragraph is not translated to French, as the French translation
+ at c uses the term ``insécable'', ie. means ``unbreakable''.
+Note that the @samp{tie} word has this meaning in the @TeX{}/Texinfo
+community, this differs from the term tie in ango-saxon typography which
+is some sort of diacrtic symbol in the shape of an arc.
+
Here @LaTeX{} will not break the line between the final two words.
@example
@@ -15511,7 +15530,7 @@
@itemize @bullet
@item
-Between an enumerator and its item, such as in references:
+Between an enumerator label and number, such as in references:
@code{Chapter~12}, or @code{Theorem~\ref@{th:Wilsons@}}, or
@code{Figure~\ref@{fig:KGraph@}}.
@@ -15523,9 +15542,9 @@
@item
Between a number and its unit: @code{$745.7.8$~watts} (the
@file{siunitx} package has a special facility for this) or
- at code{144~eggs}. This includes between a month and a date:
- at code{October~12} or @code{12~Oct}. In general, in any expressions
-where numbers and abbreviations or symbols are separated by a space:
+ at code{144~eggs}. This includes between a month and day number in a date:
+ at code{October~12} or @code{12~Oct}. In general, in any expressions where
+numbers and abbreviations or symbols are separated by a space:
@code{AD~565}, or @code{2:50~pm}, or @code{Boeing~747}, or
@code{268~Plains Road}, or @code{\$$1.4$~billion}. Other common
choices here are a thin space (@pxref{\thinspace & \negthinspace}) and
@@ -18784,7 +18803,7 @@
called the @dfn{encoding}. There are many different encodings. The
simplest is ASCII, which supports 95 printable characters, not enough
for most of the world's languages. For instance, to typeset the
-a-umlaut character @"{a} in an ASCII-encoded @LaTeX{} source file, the
+a-umlaut character @samp{@"{a}} in an ASCII-encoded @LaTeX{} source file, the
sequence @code{\"a} is used. This would make source files for anything
but English hard to read; even for English, often a more extensive
encoding is more convenient.
@@ -18818,6 +18837,8 @@
replace the non-UTF-8 character with its UTF-8 equivalent, or use a
@LaTeX{} equivalent command or character.
+ at findex \inputencoding
+ at anchor{\inputencoding}
In some documents, such as a collection of journal articles from a
variety of authors, changing the encoding in mid-document may be
necessary. Use the command
@@ -19818,7 +19839,7 @@
@cindex multiple indexes
There are many packages in the area of indexing. The @code{showidx}
package causes each index entries to be shown in the margin on the
-page where the entry appears. This can help in preparing the index.
+page where the @code{\index} appears. This can help in preparing the index.
The @code{multind} package, among others, supports multiple indexes.
See also the @TeX{} FAQ entry on this topic,
@url{https://www.texfaq.org/FAQ-multind}, and the CTAN topic,
@@ -19852,6 +19873,8 @@
again with @code{pdflatex test}.
@example
+% file test.tex
+ ...
W~Ackermann (1896--1962).\index@{Ackermann@}
...
Ackermann function\index@{Ackermann!function@}
@@ -19867,7 +19890,8 @@
Three levels deep is as far as you can nest subentries. (If you add
@code{\index@{Ackermann!function!growth rate!comparison@}} then
@command{makeindex} says @samp{Scanning input file test.idx....done (4
-entries accepted, 1 rejected)} and nothing appears in the index).
+entries accepted, 1 rejected)} and the fourth level is silently missing
+from the index.)
If you enter a second @code{\index} with the same
@var{index-entry-string} then you will get a single index entry with two
@@ -19884,14 +19908,14 @@
@example
W~Ackermann (1896--1962).\index@{Ackermann@}
...
-D~Hilbert (1862--1943)\index@{Ackermann!Hilbert\(@}
+D~Hilbert (1862--1943)\index@{Ackermann!Hilbert|(@}
...
-disapproved of his marriage.\index@{Ackermann!Hilbert\)@}
+disapproved of his marriage.\index@{Ackermann!Hilbert|)@}
@end example
@noindent
If the beginning and ending of the page range are equal then the system
-just gives a single page entry, not a range.
+just gives a single page number, not a range.
If you index subentries but not a main entry, as with
@code{\index@{Jones!program@}} and @code{\index@{Jones!results@}}, then
@@ -19905,16 +19929,15 @@
@findex \alsoname
@PkgIndex{babel} @PkgIndex{polyglossia}
-Generate a index entry that says @samp{See} by using a vertical bar
+Generate a index entry that says @samp{see} by using a vertical bar
character: @code{\index@{Ackermann!function|see@{P\'eter's
-function@}@}}. You can instead get @samp{See also} with @code{seealso}.
-(The text @samp{See} is defined by @code{\seename}, and @samp{See also}
+function@}@}}. You can instead get @samp{see also} with @code{seealso}.
+(The text @samp{see} is defined by @code{\seename}, and @samp{see also}
by @code{\alsoname}. You can redefine these either by using an
internationalization package such as @file{babel} or @file{polyglossia},
-or directly as with @code{\renewcommand@{\alsoname@}[1]@{Also see
-#1@}}.)
+or directly as with @code{\renewcommand@{\alsoname@}@{Also see@}}.)
-The @samp{See} feature is part of a more general functionality. After
+The @samp{see} feature is part of a more general functionality. After
the vertical bar you can put the name of a one-input command, as in
@code{\index@{group|textit@}} (note the missing backslash on the
@code{\textit} command) and the system will apply that command to the
@@ -20201,9 +20224,9 @@
\printindex
@end example
- at findex \printindex
Place the index into the output.
+ at PkgIndex{makeidx}
To get an index you must first include
@code{\usepackage@{makeidx@}\makeindex} in the document preamble and
compile the document, then run the system command @command{makeindex},
@@ -21685,8 +21708,8 @@
@noindent
The @code{jobname} option is there because otherwise both files would be
-called @file{main.pdf}, and the second would overwrite the first. (See
-the next section.)
+called @file{main.pdf} and the second would overwrite the
+first. (@pxref{Jobname}.)
In this example we use the command line to select which parts of a
document to include. For a book named @file{mybook.tex} and structured
@@ -21721,6 +21744,8 @@
@cindex jobname
@cindex document root name
@cindex name of document root
+ at cindex root file
+ at cindex file, root
Running @LaTeX{} creates a number of files, including the main PDF (or
DVI) output but also including others. These files are named with the
@@ -21732,13 +21757,14 @@
In general, @LaTeX{} is invoked as @code{@var{latex-engine}
@var{options} @var{argument}}, where @var{latex-engine} is
@command{pdflatex}, @command{lualatex}, etc.@: (@pxref{@TeX{} engines}).
-If @var{argument} does not start with a backslash, as is the case
-above with @code{thesis}, then @TeX{} considers it to be the name of
-the file to input as the main document. The name of that root file,
-without the @file{.tex} extension, is the jobname. If @var{argument}
-does start with a backslash, or if @TeX{} is in interactive mode, then
-it waits for the first @code{\input} command, and the jobname is the
-argument to @code{\input}.
+If @var{argument} does not start with a backslash, as is the case above
+with @code{thesis}, then @TeX{} considers it to be the name of the file
+to input as the main document. This file is referred to as the @dfn{root
+file} (@pxref{Splitting the input}, and at tie{}@ref{\input}). The name of
+that root file, without the @file{.tex} extension if any, is the
+jobname. If @var{argument} does start with a backslash, or if @TeX{} is
+in interactive mode, then it waits for the first @code{\input} command,
+and the jobname is the argument to @code{\input}.
There are two more possibilities for the jobname. It can be directly
specified with the @code{-jobname} option, as in @code{pdflatex
@@ -21747,10 +21773,10 @@
@findex texput at r{, jobname default}
@cindex fallback jobname
The final possibility is @file{texput}, which is the final fallback
-default if no other name is available to @TeX{}. For example, if no
+default if no other name is available to @TeX{}. That is, if no
@code{-jobname} option was specified, and the compilation stops before
-there is any output, then the log file will be named
- at file{texput.log}.
+any input file is met, then the log file will be named
+ at file{texput.log}.
@findex \documentclass at r{, and @code{texput} jobname}
@findex \RequirePackage at r{, and @code{texput} jobname}
Modified: trunk/writing.html
===================================================================
--- trunk/writing.html 2021-08-16 15:29:44 UTC (rev 988)
+++ trunk/writing.html 2021-08-17 18:41:31 UTC (rev 989)
@@ -282,6 +282,8 @@
Put two lines before a new node.
When you are all done writing, use <code>Ctrl-Q</code> to format
blocks of text to a uniform width.</li>
+ <li><span class="listitem">Index</span>
+ Use <code>@PkgIndex{..}</code> to add a package name to the index.
</ul>
More information about the latexrefman-commits
mailing list.