[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[6599] update documentation for @setfilename
|
From: |
Gavin D. Smith |
|
Subject: |
[6599] update documentation for @setfilename |
|
Date: |
Sat, 05 Sep 2015 20:59:43 +0000 |
Revision: 6599
http://svn.sv.gnu.org/viewvc/?view=rev&root=texinfo&revision=6599
Author: gavin
Date: 2015-09-05 20:59:43 +0000 (Sat, 05 Sep 2015)
Log Message:
-----------
update documentation for @setfilename
Modified Paths:
--------------
trunk/ChangeLog
trunk/NEWS
trunk/doc/texinfo.texi
Modified: trunk/ChangeLog
===================================================================
--- trunk/ChangeLog 2015-09-05 20:08:37 UTC (rev 6598)
+++ trunk/ChangeLog 2015-09-05 20:59:43 UTC (rev 6599)
@@ -1,5 +1,17 @@
2015-09-05 Gavin Smith <address@hidden>
+ * doc/texinfo.texi (Info Formatting, Comments, Minimum)
+ (Sample Beginning, Texinfo File Header, Start of Header)
+ (Writing a Menu, @var, @documentlanguage, documentencoding)
+ (Sample Include File, Format with texi2dvi)
+ (Formatting Partial Documents, Requirements Summary)
+ (Preparing for TeX, A4 Paper, Command List)
+ (Short Sample Texinfo File, GNU Sample Texts)
+ (@setfilename),
+ * NEWS: @setfilename is now no longer required.
+
+2015-09-05 Gavin Smith <address@hidden>
+
* doc/texinfo.tex (\requireauxfile): New macro.
(\refx, \Efloat): Use it.
(\fixbackslash): Read texinfo.cnf here if it exists.
Modified: trunk/NEWS
===================================================================
--- trunk/NEWS 2015-09-05 20:08:37 UTC (rev 6598)
+++ trunk/NEWS 2015-09-05 20:59:43 UTC (rev 6599)
@@ -28,6 +28,8 @@
"@validatemenus off" near the start of a Texinfo file,
makeinfo will, where needed, create a menu for nodes lacking one
given explicitly.
+ . An @setfilename line is no longer required at the start of a
+ Texinfo file.
* texinfo.tex:
. A few characters (like \ and -) are now ignored in index entries for
Modified: trunk/doc/texinfo.texi
===================================================================
--- trunk/doc/texinfo.texi 2015-09-05 20:08:37 UTC (rev 6598)
+++ trunk/doc/texinfo.texi 2015-09-05 20:59:43 UTC (rev 6599)
@@ -6,9 +6,6 @@
@c header' node for more info.
@c %**start of header
address@hidden makeinfo and texinfo.tex ignore all text before @setfilename.
address@hidden texinfo.info
-
@c Automake automatically updates version.texi to @set VERSION and
@c @set UPDATED to appropriate values.
@include version.texi
@@ -1486,9 +1483,8 @@
Often, you can write the @code{@@comment} or @code{@@c} in the middle
of a line, and only the text that follows after the @code{@@comment}
or @code{@@c} command does not appear; but some commands, such as
address@hidden@@settitle} and @code{@@setfilename}, work on a whole line. You
-cannot use @code{@@comment} or @code{@@c} within a line beginning with
-such a command.
address@hidden@@settitle}, work on a whole line. You cannot use
@code{@@comment}
+or @code{@@c} within a line beginning with such a command.
@findex DEL @r{(comment character)}
@cindex Catcode for comments in @TeX{}
@@ -1531,7 +1527,6 @@
@example
@group
\input texinfo
-@@setfilename @var{info-file-name}
@@settitle @var{name-of-manual}
@end group
@end example
@@ -1556,11 +1551,6 @@
backslash, @samp{\}; this is correct for @TeX{}.)
@item
-The @code{@@setfilename} line provides a name for the Info file and
-tells @TeX{} to open auxiliary files. @strong{All text before
address@hidden@@setfilename} is ignored!}
-
address@hidden
The @code{@@settitle} line specifies a title for the page headers (or
footers) of the printed manual, and the default title and document
description for the @samp{<head>} in address@hidden Strictly speaking,
@@ -1576,7 +1566,7 @@
Furthermore, you will usually provide a Texinfo file with a title page,
indices, and the like, all of which are explained in this manual. But
-the minimum, which can be useful for short documents, is just the three
+the minimum, which can be useful for short documents, is just the two
lines at the beginning and the one line at the end.
@@ -1607,7 +1597,6 @@
@group
\input texinfo @@c -*-texinfo-*-
@@c %**start of header
-@@setfilename sample.info
@@settitle Sample Manual 1.0
@@c %**end of header
@end group
@@ -1617,10 +1606,9 @@
start-of-header and end-of-header lines at the beginning of a Texinfo
file. In the first line, @samp{-*-texinfo-*-} causes Emacs to switch
into Texinfo mode when you edit the file.
-The @code{@@c ...header} lines above which surround the
address@hidden@@setfilename} and @code{@@settitle} lines allow you to process,
-within Emacs, just part of the Texinfo source. (@xref{Start of
-Header}.)
+The @code{@@c ...header} lines above which surround the
address@hidden@@settitle} line allow you to process, within Emacs, just part of
+the Texinfo source. (@xref{Start of Header}.)
@subheading Summary Description and Copyright
@@ -1826,7 +1814,6 @@
@example
\input texinfo @@c -*-texinfo-*-
@@c %**start of header
-@@setfilename @var{infoname}.info
@@settitle @var{name-of-manual} @var{version}
@@c %**end of header
@@ -1896,16 +1883,13 @@
@cindex Header for Texinfo files
@cindex Texinfo file header
-Texinfo files start with at least three lines that provide Texinfo
-translators with necessary information. These are the @code{\input
-texinfo} line, the @code{@@settitle} line, and the
address@hidden@@setfilename} line.
+Texinfo files start with at least two lines. These are the
address@hidden texinfo} line and the @code{@@settitle} line.
Also, if you want to format just part of the Texinfo file in Emacs,
-you must write the @code{@@settitle} and @code{@@setfilename} lines
-between start-of-header and end-of-header lines. These start- and
-end-of-header lines are optional, but they do no harm, so you might as
-well always include them.
+you must write the @code{@@settitle} line between start-of-header and
+end-of-header lines. These start- and end-of-header lines are optional,
+but they do no harm, so you might as well always include them.
Any command that affects document formatting as a whole makes sense to
include in the header. @code{@@synindex} (@address@hidden@@synindex}}),
@@ -1918,13 +1902,12 @@
@group
\input texinfo @@c -*-texinfo-*-
@@c %**start of header
-@@setfilename sample.info
@@settitle Sample Manual 1.0
@@c %**end of header
@end group
@end example
-(@xref{GNU Sample Texts}, for complete sample texts.)
+(@xref{GNU Sample Texts} for complete sample texts.)
@menu
* First Line:: The first line of a Texinfo file.
@@ -1980,11 +1963,10 @@
@end example
Write the start-of-header line on the second line of a Texinfo file.
-Follow the start-of-header line with @code{@@setfilename} and
address@hidden@@settitle} lines and, optionally, with other commands that
-globally affect the document formatting, such as @code{@@synindex} or
address@hidden@@footnotestyle}; and then by an end-of-header line (@pxref{End of
-Header}).
+Follow the start-of-header line with an @code{@@settitle} line and,
+optionally, with other commands that globally affect the document
+formatting, such as @code{@@synindex} or @code{@@footnotestyle}; and
+then by an end-of-header line (@pxref{End of Header}).
The start- and end-of-header lines allow you to format only part of a
Texinfo file for Info or printing. @address@hidden commands}.
@@ -2054,13 +2036,6 @@
when generating HTML, for example), or add a dot followed by the
extension (@samp{.html} for HTML) if the given name has no extension.
address@hidden texinfo.cnf
-The @code{@@setfilename} line produces no output when you typeset a
-manual with @TeX{}, but it is nevertheless essential: it opens the
-index and other auxiliary files used by Texinfo, and also reads
address@hidden if that file is present on your system
-(@pxref{Preparing for @TeX{}}).
-
If there is no @code{@@setfilename} line, @code{makeinfo} uses the
input file name to determine the output name: first, any of the
extensions @code{.texi}, @code{.tex}, @code{.txi} or @code{.texinfo}
@@ -3912,8 +3887,7 @@
@command{makeinfo} can automatically generate menus in nodes for Info
and HTML output, based on the chapter structure of the document. To
specify that you want it to do this, place the line
address@hidden@@validatemenus off} near the beginning of the document, after
address@hidden@@setfilename}.
address@hidden@@validatemenus off} near the beginning of the document.
In Info, a user selects a node with the @kbd{m} (@code{Info-menu})
command. The menu entry name is what the user types after the @kbd{m}
@@ -6536,7 +6510,6 @@
@example
@group
\input texinfo
-@@@@setfilename @@address@hidden@}
@@@@settitle @@address@hidden@}
@end group
@end example
@@ -6547,7 +6520,6 @@
@example
@group
\input texinfo
-@@setfilename @var{info-file-name}
@@settitle @var{name-of-manual}
@end group
@end example
@@ -12916,8 +12888,7 @@
@cindex Document language, declaring
The @code{@@documentlanguage} command declares the current document
-locale. Write it on a line by itself, near the beginning of the file,
-but after @code{@@setfilename} (@address@hidden@@setfilename}}):
+locale. Write it on a line by itself, near the beginning of the file.
@example
@@documentlanguage @address@hidden
@@ -12997,8 +12968,7 @@
The @code{@@documentencoding} command declares the input document
encoding, and can also affect the encoding of the output. Write it on
a line by itself, with a valid encoding specification following, near
-the beginning of the file but after @code{@@setfilename}
-(@address@hidden@@setfilename}}):
+the beginning of the file.
@example
@@documentencoding @var{enc}
@@ -14901,7 +14871,6 @@
@group
\input texinfo @@c -*-texinfo-*-
@c %**start of header
-@@setfilename include-example.info
@@settitle Include Example
@c %**end of header
@end group
@@ -15080,8 +15049,8 @@
@opindex address@hidden, for @command{texi2dvi}}
One useful option to @code{texi2dvi} is @address@hidden
-This inserts @var{cmd} on a line by itself after the
address@hidden@@setfilename} in a temporary copy of the input file before
+This inserts @var{cmd} on a line by itself, after a
address@hidden@@setfilename} line in a temporary copy of the input file, before
running @TeX{}. With this, you can specify different printing
formats, such as @code{@@smallbook} (@address@hidden@@smallbook}}),
@code{@@afourpaper} (@pxref{A4 Paper}), or @code{@@pagesizes}
@@ -15266,15 +15235,13 @@
case, the usual auxiliary files that @TeX{} creates and warnings
@TeX{} gives about undefined cross references are just nuisances. You
can avoid them with the @code{@@novalidate} command, which you must
-give @emph{before} the @code{@@setfilename} command
-(@address@hidden@@setfilename}}).
+give @emph{before} any sectioning or cross-reference commands.
Thus, the beginning of your file would look approximately like this:
@example
\input texinfo
@@novalidate
-@@setfilename myfile.info
@dots{}
@end example
@@ -15574,16 +15541,15 @@
@cindex Formatting requirements
Every Texinfo file that is to be input to @TeX{} must begin with a
address@hidden command, and must contain a @code{@@setfilename} command:
address@hidden command:
@example
\input texinfo
-@@setfilename @address@hidden
@end example
@noindent
-The first command instructs @TeX{} to load the macros it needs to
-process a Texinfo file and the second command opens auxiliary files.
+This instructs @TeX{} to load the macros it needs to process a Texinfo
+file.
Every Texinfo file must end with a line that terminates @TeX{}'s
processing and forces out unfinished pages:
@@ -15592,7 +15558,7 @@
@@bye
@end example
-Strictly speaking, these lines are all a Texinfo file needs to be
+Strictly speaking, these two lines are all a Texinfo file needs to be
processed successfully by @TeX{}.
Usually, however, the beginning includes a @code{@@settitle} command
@@ -15670,9 +15636,8 @@
@pindex texinfo.cnf @r{installation}
@cindex Customizing of @TeX{} for Texinfo
@cindex Site-wide Texinfo configuration file
-Optionally, you may create a file @file{texinfo.cnf} for site
-configuration. This file is read by @TeX{} when the
address@hidden@@setfilename} command is executed
(@address@hidden@@setfilename}}).
+Optionally, you may create a file @file{texinfo.cnf} for site configuration.
+This file is read by @TeX{} at the beginning of a Texinfo file.
You can put any commands you like there, according to local site-wide
conventions. They will be read by @TeX{} when processing any Texinfo
document. For example, if @file{texinfo.cnf} contains the line
@@ -15861,7 +15826,6 @@
@group
\input texinfo @@c -*-texinfo-*-
@@c %**start of header
-@@setfilename texinfo
@@settitle Texinfo
@@afourpaper
@@c %**end of header
@@ -20434,8 +20398,8 @@
@item @@novalidate
Suppress validation of node references and omit creation of auxiliary
-files with @TeX{}. Use before @code{@@setfilename}. @xref{Pointer
-Validation}.
+files with @TeX{}. Use before any sectioning or cross-reference
+commands. @xref{Pointer Validation}.
@item @@address@hidden@}
@itemx @@address@hidden@}
@@ -20595,9 +20559,8 @@
@code{@@contents} command is at the end. @xref{Contents}.
@item @@setfilename @var{info-file-name}
-Provide a name to be used for the output files. This command is essential
-for @TeX{} formatting as well, even though it produces no output of
-its own. @address@hidden@@setfilename}}.
+Provide a name to be used for the output files. This command is ignored
+for @TeX{} formatting. @address@hidden@@setfilename}}.
@item @@setshortcontentsaftertitlepage
Place the short table of contents after the @samp{@@end titlepage}
@@ -21413,7 +21376,6 @@
@example
\input texinfo @@c -*-texinfo-*-
@@c %**start of header
-@@setfilename sample.info
@@settitle Sample Manual 1.0
@@c %**end of header
@@ -21587,7 +21549,6 @@
\input texinfo @c -*-texinfo-*-
@comment address@hidden
@comment %**start of header
address@hidden sample.info
@include version.texi
@settitle GNU Sample @value{VERSION}
@syncodeindex pg cp
@@ -22412,11 +22373,8 @@
M-x makeinfo-buffer
@end example
-For @TeX{} or the Info formatting commands to work, the file @emph{must}
-include a line that has @code{@@setfilename} in its header.
address@hidden an Info File} for details about Info formatting.
address@hidden an Info File}, for details about Info formatting.
-
@node Printing
@comment node-name, next, previous, up
@section Printing
| [Prev in Thread] |
Current Thread |
[Next in Thread] |
- [6599] update documentation for @setfilename,
Gavin D. Smith <=