[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
texinfo ChangeLog doc/texinfo.txi
From: |
karl |
Subject: |
texinfo ChangeLog doc/texinfo.txi |
Date: |
Mon, 26 Nov 2012 18:52:10 +0000 |
CVSROOT: /sources/texinfo
Module name: texinfo
Changes by: karl <karl> 12/11/26 18:52:10
Modified files:
. : ChangeLog
doc : texinfo.txi
Log message:
spaces ignored after @-command names
CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/texinfo/ChangeLog?cvsroot=texinfo&r1=1.1460&r2=1.1461
http://cvs.savannah.gnu.org/viewcvs/texinfo/doc/texinfo.txi?cvsroot=texinfo&r1=1.495&r2=1.496
Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/texinfo/texinfo/ChangeLog,v
retrieving revision 1.1460
retrieving revision 1.1461
diff -u -b -r1.1460 -r1.1461
--- ChangeLog 26 Nov 2012 18:42:30 -0000 1.1460
+++ ChangeLog 26 Nov 2012 18:52:10 -0000 1.1461
@@ -1,5 +1,8 @@
2012-11-26 Karl Berry <address@hidden>
+ * doc/texinfo.txi (Command Syntax): Explicitly mention
+ whitespace after command names being (usually) ignored.
+
* doc/texinfo.txi (Not Ending a Sentence): Attempt
to document the sentence-ending heuristic more clearly.
Suggestion from Eli Zaretskii in <http://bugs.gnu.org/12973#14>,
Index: doc/texinfo.txi
===================================================================
RCS file: /sources/texinfo/texinfo/doc/texinfo.txi,v
retrieving revision 1.495
retrieving revision 1.496
diff -u -b -r1.495 -r1.496
--- doc/texinfo.txi 26 Nov 2012 18:42:30 -0000 1.495
+++ doc/texinfo.txi 26 Nov 2012 18:52:10 -0000 1.496
@@ -1,5 +1,5 @@
\input texinfo.tex @c -*-texinfo-*-
address@hidden $Id: texinfo.txi,v 1.495 2012/11/26 18:42:30 karl Exp $
address@hidden $Id: texinfo.txi,v 1.496 2012/11/26 18:52:10 karl Exp $
@c Ordinarily, Texinfo files have the extension .texi. But texinfo.texi
@c clashes with texinfo.tex on 8.3 filesystems, so we use texinfo.txi.
@@ -21013,26 +21013,26 @@
@cindex Syntax, of @@-commands
@cindex Command syntax
-The character @samp{@@} is used to start special Texinfo commands.
-(It has the same meaning that @samp{\} has in plain @TeX{}.) Texinfo
-has four types of @@-command:
+The character @samp{@@} is used to start all Texinfo commands. (It
+has the same meaning that @samp{\} has in plain @TeX{}.) Texinfo has
+four types of @@-command:
@table @asis
@item 1. Non-alphabetic commands.
These commands consist of an @@ followed by a punctuation mark or
-other character that is not part of the alphabet. Non-alphabetic
+other character that is not part of the Latin alphabet. Non-alphabetic
commands are almost always part of the text within a paragraph. The
non-alphabetic commands include @code{@@@@}, @code{@@@{}, @code{@@@}},
@code{@@.}, @code{@@@kbd{SPACE}}, most of the accent commands, and
many more.
@item 2. Alphabetic commands that do not require arguments.
-These commands start with @@ followed by a word followed by left- and
-right-hand braces. These commands insert special symbols in the
-document; they do not require arguments. For example,
+These commands start with @@ followed by a word followed by a
+left and right- brace. These commands insert special symbols in
+the document; they do not take arguments. Some examples:
@code{@@address@hidden@}} @result{} @address@hidden, @code{@@address@hidden@}}
address@hidden @address@hidden, @code{@@address@hidden@}} @result{}
address@hidden',
-and @code{@@address@hidden@}} @result{} @address@hidden
address@hidden @address@hidden, @code{@@address@hidden@}} @result{}
address@hidden', and
address@hidden@@address@hidden@}} @result{} @address@hidden
@item 3. Alphabetic commands that require arguments within braces.
These commands start with @@ followed by a letter or a word, followed by an
@@ -21048,27 +21048,31 @@
the command name by a space. Braces are not used.
@end table
+Whitespace following an @@-command name are optional and (usually)
+ignored if present. The exceptions are contexts whee whitespace is
+significant, e.g., an @code{@@example} environment.
+
@cindex Braces and argument syntax
Thus, the alphabetic commands fall into classes that have
different argument syntaxes. You cannot tell to which class a command
belongs by the appearance of its name, but you can tell by the
command's meaning: if the command stands for a glyph, it is in
class 2 and does not require an argument; if it makes sense to use the
-command together with other text as part of a paragraph, the command
+command among other text as part of a paragraph, the command
is in class 3 and must be followed by an argument in braces;
otherwise, it is in class 4 and uses the rest of the line as its
argument.
-The purpose of having a different syntax for commands of classes 3 and
-4 is to make Texinfo files easier to read, and also to help the GNU
-Emacs paragraph and filling commands work properly. There is only one
-exception to this rule: the command @code{@@refill}, which is always
-used at the end of a paragraph immediately following the final period
-or other punctuation character. @code{@@refill} takes no argument and
-does @emph{not} require braces. @code{@@refill} never confuses the
-Emacs paragraph commands because it cannot appear at the beginning of
-a line. It is also no longer needed, since all formatters now refill
-paragraphs automatically.
+The purpose of having a different syntax for commands of classes 3
address@hidden is to make Texinfo files easier to read, and also to help
+the GNU Emacs paragraph and filling commands work properly. There is
+only one exception to this rule: the command @code{@@refill}, which is
+always used at the end of a paragraph immediately following the final
+period or other punctuation character. @code{@@refill} takes no
+argument and does @emph{not} require braces. @code{@@refill} never
+confuses the Emacs paragraph commands because it cannot appear at the
+beginning of a line. It is also no longer needed, since all
+formatters now refill paragraphs automatically.
@node Command Contexts
@@ -21667,7 +21671,7 @@
or other version control systems, which expand it into a string such
as:
@example
-$Id: texinfo.txi,v 1.495 2012/11/26 18:42:30 karl Exp $
+$Id: texinfo.txi,v 1.496 2012/11/26 18:52:10 karl Exp $
@end example
(This is useful in all sources that use version control, not just manuals.)
You may wish to include the @samp{$Id:} comment in the @code{@@copying}