[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
branch master updated: * doc/texinfo.texi (Texinfo Preamble): Rename to
From: |
Gavin D. Smith |
Subject: |
branch master updated: * doc/texinfo.texi (Texinfo Preamble): Rename to "Preamble" and edit. |
Date: |
Wed, 20 Jul 2022 19:31:35 -0400 |
This is an automated email from the git hooks/post-receive script.
gavin pushed a commit to branch master
in repository texinfo.
The following commit(s) were added to refs/heads/master by this push:
new d6bab35876 * doc/texinfo.texi (Texinfo Preamble): Rename to "Preamble"
and edit.
d6bab35876 is described below
commit d6bab35876071ac58e398596bd80d68acadf84ba
Author: Gavin Smith <gavinsmith0123@gmail.com>
AuthorDate: Thu Jul 21 00:31:10 2022 +0100
* doc/texinfo.texi (Texinfo Preamble): Rename to "Preamble" and edit.
---
ChangeLog | 4 ++++
doc/texinfo.texi | 69 ++++++++++++++++++++++++++++++--------------------------
2 files changed, 41 insertions(+), 32 deletions(-)
diff --git a/ChangeLog b/ChangeLog
index 8fd0c2f988..0601c6cdd7 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,7 @@
+2022-07-20 Gavin Smith <gavinsmith0123@gmail.com>
+
+ * doc/texinfo.texi (Texinfo Preamble): Rename to "Preamble" and edit.
+
2022-07-20 Gavin Smith <gavinsmith0123@gmail.com>
* doc/texinfo.texi
diff --git a/doc/texinfo.texi b/doc/texinfo.texi
index 711e7baecb..23020e9218 100644
--- a/doc/texinfo.texi
+++ b/doc/texinfo.texi
@@ -172,7 +172,7 @@ Texinfo File Header
* First Line:: The first line of a Texinfo file.
* @code{@@setfilename}:: Give the name of the output file.
* @code{@@settitle}:: Create a title for the printed work.
-* Texinfo Preamble:: Start of the Texinfo file up to first content.
+* Preamble:: Start of the Texinfo file up to first content.
* Start and End of Header:: Formatting a region in Emacs requires this.
Document Permissions
@@ -1627,7 +1627,7 @@ at the beginning of output files, or the language used in
file headers.
* First Line:: The first line of a Texinfo file.
* @code{@@setfilename}:: Give the name of the output file.
* @code{@@settitle}:: Create a title for the printed work.
-* Texinfo Preamble:: Start of the Texinfo file up to first content.
+* Preamble:: Start of the Texinfo file up to first content.
* Start and End of Header:: Formatting a region in Emacs requires this.
@end menu
@@ -1782,48 +1782,53 @@ generally appears as a @code{@@subtitle} so it would be
omitted from the
-@node Texinfo Preamble
-@subsection Texinfo Preamble
+@node Preamble
+@subsection Preamble
@cindex Preamble
@cindex Texinfo Preamble
-The @dfn{Texinfo preamble} corresponds to the beginning of the Texinfo file
-up to the first content directly output. It typically includes the
+The @dfn{preamble} starts at the beginning of the Texinfo file and continues
+until the first directly output material. It typically includes the
file header (@pxref{Texinfo File Header}), the @code{@@copying} block
-specifying the document permissions (@xref{@code{@@copying}}) and the
-@code{@@titlepage} (@pxref{Titlepage & Copyright Page}) specification.
-
-Commands that affects document formatting as a whole but do not produce
-output, or do not produce output straight away, such as @code{@@settitle}
-(@pxref{@code{@@settitle}}), @code{@@documentlanguage},
-(@pxref{@code{@@documentlanguage}}), commands setting the headings,
-setting information on indentation, on hyphenation or on table of contents
-(@pxref{Contents}) do not stop the the preamble. The preamble can also contain
+specifying the document permissions (@pxref{@code{@@copying}}) and the
+@code{@@titlepage} specification (@pxref{Titlepage & Copyright Page}).
+
+The preamble may contain commands that affect document formatting
+as a whole but which do not produce output, or do not produce output
+straight away, such as @code{@@settitle} (@pxref{@code{@@settitle}}),
+@code{@@documentlanguage}, (@pxref{@code{@@documentlanguage}}),
+commands setting the headings, controlling indentation or hyphenation,
+or the table of contents (@pxref{Contents}).
+
+@ignore
+The preamble can also contain
raw formatter commands (@pxref{Raw Formatter Commands}), but it is not checked
that the content of these commands is actually preamble material and not
regular output.
+@end ignore
Any text that starts a paragraph, @@-commands that are formatted
-as quotations, tables, lists and so on, @code{@@node} (@pxref{Nodes})
+as quotations, tables, lists and so on, and @code{@@node} (@pxref{Nodes})
and chapter structuring commands (@pxref{Chapter Structuring}) end the
preamble.
-How the preamble affects the formatting depends on the output format. In
-plaintext, it has no effect, it is simply output at the beginning of the
-document, for example a @code{@@contents} in the preamble is substituted by
-the table of contents (@pxref{Contents}). For @LaTeX{} output, the preamble
-is important as the @code{\begin@{document@}} line is output at the end
-of the preamble.
-
-In HTML and Info the preamble is not treated especially in the output. But
-it is also used to determine which information is set for some header
formatting.
-Commands that affect header formatting are set to the information current at
-the very end of the preamble. This concerns for example commands specifying
-the indentation or the language (@pxref{@code{@@documentlanguage}}).
-
-For example, for the following document, the HTML and Info copying comments
are formatted
-with @code{@@documentlanguage} set to @samp{pt}, as it is the last
@code{@@documentlanguage}
-before the end of the preamble.
+The concept of the preamble is significant for @LaTeX{} output, as the
+@code{\begin@{document@}} line is output at the end of the preamble.
+
+In plaintext, the preamble is simply output as usual at the beginning of the
+document; for example, a @code{@@contents} in the preamble is output as
+the table of contents (@pxref{Contents}).
+
+There is not much special treatment of the preamble for HTML and Info
+output either. However, some settings current at the very end of
+the preamble may be used for the document as a whole, regardless of
+what follows. This may apply to commands specifying the indentation,
+or the language (@pxref{@code{@@documentlanguage}}).
+
+For example, for the following document, the HTML and Info copying
+comments are formatted with @code{@@documentlanguage} set to @samp{pt},
+as it is the last @code{@@documentlanguage} before the end of the
+preamble.
@example
@group
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- branch master updated: * doc/texinfo.texi (Texinfo Preamble): Rename to "Preamble" and edit.,
Gavin D. Smith <=