[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
branch master updated: * doc/texinfo.texi (Info Format Specification): C
From: |
Gavin D. Smith |
Subject: |
branch master updated: * doc/texinfo.texi (Info Format Specification): Comment out part about * at the beginning of a line. Move definition of <separator> and <del> out of appendix introduction. |
Date: |
Mon, 15 Aug 2022 09:39:53 -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 0607f4c9b0 * doc/texinfo.texi (Info Format Specification): Comment out
part about * at the beginning of a line. Move definition of <separator> and
<del> out of appendix introduction.
0607f4c9b0 is described below
commit 0607f4c9b0b8697680a1cf6f644e063b8f7a8156
Author: Gavin Smith <gavinsmith0123@gmail.com>
AuthorDate: Mon Aug 15 14:39:28 2022 +0100
* doc/texinfo.texi (Info Format Specification): Comment out
part about * at the beginning of a line. Move definition
of <separator> and <del> out of appendix introduction.
---
ChangeLog | 6 ++++++
doc/texinfo.texi | 41 ++++++++++++++++++++++-------------------
2 files changed, 28 insertions(+), 19 deletions(-)
diff --git a/ChangeLog b/ChangeLog
index dadb17e21d..2408568d13 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2022-08-15 Gavin Smith <gavinsmith0123@gmail.com>
+
+ * doc/texinfo.texi (Info Format Specification): Comment out
+ part about * at the beginning of a line. Move definition
+ of <separator> and <del> out of appendix introduction.
+
2022-08-15 Gavin Smith <gavinsmith0123@gmail.com>
* doc/texinfo.texi (Info Format Regular Nodes): Define
diff --git a/doc/texinfo.texi b/doc/texinfo.texi
index 3f7dedb65d..b0e8554583 100644
--- a/doc/texinfo.texi
+++ b/doc/texinfo.texi
@@ -23639,29 +23639,18 @@ for the language of the description itself. Other
characters are
literal. The formal constructs used are typical: @code{<...>}
indicates a metavariable name, @samp{=} means definition, @samp{*}
repetition, @samp{?} optional, @samp{()} grouping, @samp{|}
-alternation, @samp{#} comment. Exception: @samp{*} at the beginning
-of a line is literal.
+alternation, and @samp{#} comment.
+@c Exception: @samp{*} at the beginning of a line is literal.
+@c (Is it really worth stating this?)
In general, programs that read Info files should try to be
case-insensitive to keywords that occur in the file (for example,
@samp{Tag Table} and @samp{Tag table} should be equivalent) in order to
support Info-generating programs that use different capitalization.
-The sections in an Info file (such as nodes or tag tables) are separated
-with a sequence:
-
-@example
-(^L)?^_(^L)?^J
-@end example
-
-@noindent
-That is, a @samp{CTRL-_} character followed by a newline, with optional
-formfeed characters. We refer to such sequences as @t{<separator>}.
-
We specify literal parentheses (those that are part of the Info
format) with @t{<lparen>} and @t{<rparen>}, meaning the single
-characters @samp{(} and @samp{)} respectively. We specify the
-@samp{CTRL-?} character (character number 127) @t{<del>}. Finally,
+characters @samp{(} and @samp{)} respectively. Finally,
the two-character sequence @samp{^@var{x}} means the single
character @samp{CTRL-@var{x}}, for any @var{x}.
@@ -23669,7 +23658,7 @@ This format definition was written some 25 years after
the Info format
was first devised. So in the event of conflicts between this
definition and actual practice, practice wins. It also assumes some
general knowledge of Texinfo; it is meant to be a guide for
-implementors rather than a rigid technical standard. We often refer
+implementors rather than a rigid technical standard. We may refer
back to other parts of this manual for examples and definitions,
rather than redundantly spelling out every detail.
@@ -23730,6 +23719,18 @@ The subfiles in a split manual have the following
syntax:
Note that the tag table is not optional for split files, as it is used
with the indirect table to deduce which subfile a particular node is in.
+Several of the sections in an Info file (such as nodes or tag tables) begin
+with a sequence:
+
+@example
+ <separator> = (^L)?^_(^L)?^J
+@end example
+
+@noindent
+That is, a @samp{CTRL-_} character followed by a newline, with optional
+formfeed characters.
+
+
@node Info Format Preamble
@section Info Format: Preamble
@@ -23903,6 +23904,7 @@ following format:
@example
<id> = (<lparen><infofile><rparen>)?<node-spec>?
<node-spec> = <nodename> | <del><nodename><del>
+ <del> = ^?
@end example
This @t{<node>} defines @t{<id1>} in file @t{<fn>}, which is typically
@@ -23926,8 +23928,9 @@ Node names containing periods, commas, colons or
parentheses
(including @@-commands which produce any of these) can confuse
Info readers.
If it is necessary to refer to a node whose name contains any of
-these, the @t{<nodename>} should be surrounded by a pair of @t{<del>}
-characters. There is support in @command{makeinfo} for adding these
+these, the @t{<nodename>} should be surrounded by a pair of @kbd{DEL}
+characters (@samp{CTRL-?}, character number 127). There is support
+in @command{makeinfo} for adding these
characters (@pxref{INFO_SPECIAL_CHARS_QUOTE}). Note that not all Info
readers recognize this syntax. @xref{Node Line Requirements}.
@@ -24041,7 +24044,7 @@ single line. The @t{<entry text>} is the index term.
Even though @t{<entry text>} is followed by a colon, it may itself
contain colons, so Info readers should try to include as much of the
line as possible in the @t{<entry text>}. (However, @t{<entry text>}
-may not contain the @t{<del>} characters that may occur in @t{<node-spec>}.)
+may not contain the @kbd{DEL} characters that may occur in @t{<node-spec>}.)
@t{<lineno>} is an unsigned integer, given relative to the start
of the @t{<entry node>}. An optional line break may occur before
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- branch master updated: * doc/texinfo.texi (Info Format Specification): Comment out part about * at the beginning of a line. Move definition of <separator> and <del> out of appendix introduction.,
Gavin D. Smith <=