[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
texinfo ChangeLog doc/texinfo.txi
From: |
Karl Berry |
Subject: |
texinfo ChangeLog doc/texinfo.txi |
Date: |
Tue, 16 Nov 2010 17:49:36 +0000 |
CVSROOT: /sources/texinfo
Module name: texinfo
Changes by: Karl Berry <karl> 10/11/16 17:49:36
Modified files:
. : ChangeLog
doc : texinfo.txi
Log message:
uniqify index entries
CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/texinfo/ChangeLog?cvsroot=texinfo&r1=1.1181&r2=1.1182
http://cvs.savannah.gnu.org/viewcvs/texinfo/doc/texinfo.txi?cvsroot=texinfo&r1=1.352&r2=1.353
Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/texinfo/texinfo/ChangeLog,v
retrieving revision 1.1181
retrieving revision 1.1182
diff -u -b -r1.1181 -r1.1182
--- ChangeLog 15 Nov 2010 19:51:16 -0000 1.1181
+++ ChangeLog 16 Nov 2010 17:49:35 -0000 1.1182
@@ -1,3 +1,7 @@
+2010-11-16 Karl Berry <address@hidden>
+
+ * doc/texinfo.txi: uniqify some index entries.
+
2010-11-15 Karl Berry <address@hidden>
* doc/texinfo.txi (Indexing Commands): recommend unique index
Index: doc/texinfo.txi
===================================================================
RCS file: /sources/texinfo/texinfo/doc/texinfo.txi,v
retrieving revision 1.352
retrieving revision 1.353
diff -u -b -r1.352 -r1.353
--- doc/texinfo.txi 15 Nov 2010 19:51:16 -0000 1.352
+++ doc/texinfo.txi 16 Nov 2010 17:49:36 -0000 1.353
@@ -1,5 +1,5 @@
\input texinfo.tex @c -*-texinfo-*-
address@hidden $Id: texinfo.txi,v 1.352 2010/11/15 19:51:16 karl Exp $
address@hidden $Id: texinfo.txi,v 1.353 2010/11/16 17:49:36 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.
@@ -907,7 +907,7 @@
omitted. Also, standard output is used by default.
@item HTML
address@hidden HTML output
address@hidden HTML output, overview
@cindex W3 consortium
@cindex Mozilla
@cindex Lynx
@@ -10046,14 +10046,15 @@
on, as listed in the previous section.
@cindex Writing index entries
address@hidden Index entry writing
address@hidden Index entries, advice on writing
address@hidden Advice on writing entries
address@hidden Capitalization of index entries
Concept index entries consist of text. The best way to write an index
is to devise entries which are terse yet clear. If you can do this,
-the index usually looks better if the entries are not capitalized, but
-written just as they would appear in the middle of a sentence.
-(Capitalize proper names and acronyms that always call for upper case
-letters.) This is the case convention we use in most GNU manuals'
-indices.
+the index usually looks better if the entries are written just as they
+would appear in the middle of a sentence, that is, capitalizing only
+proper names and acronyms that always call for upper case letters.
+This is the case convention we use in most GNU manuals' indices.
If you don't see how to make an entry terse yet clear, make it longer
and clear---not terse and confusing. If many of the entries are
@@ -10068,6 +10069,7 @@
usually case-sensitive, so likewise use upper and lower case as
required.
address@hidden Unique index entries
It is best, though not required, for index entries to be unique. That
way, people using the printed output or online completion of index
entries don't see undifferentiated lists. Consider this an
@@ -11047,22 +11049,17 @@
@node Dots Bullets
@section Inserting Ellipsis and Bullets
address@hidden Dots, inserting
address@hidden Bullets, inserting
address@hidden Ellipsis, inserting
address@hidden Inserting ellipsis
address@hidden Inserting dots
address@hidden Special typesetting commands
address@hidden Typesetting commands for dots, etc.
address@hidden Typesetting ellipses and bullets
-An @dfn{ellipsis} (a line of dots) is not typeset as a string of
-periods, so a special command is used for ellipsis in Texinfo. The
address@hidden@@bullet} command is special, too. Each of these commands is
-followed by a pair of braces, @address@hidden@}}, without any whitespace
-between the name of the command and the braces. (You need to use braces
-with these commands because you can use them next to other text; without
-the braces, the formatters would be confused. @xref{Command Syntax, ,
-@@-Command Syntax}, for further information.)@refill
+An @dfn{ellipsis} (a line of dots) would be spaced wrong when typeset
+as a string of periods, so a special command is used for ellipsis in
+Texinfo. The @code{@@bullet} command is special, too.
+
+Each of these commands is followed by a pair of braces, @address@hidden@}},
+without any whitespace between the name of the command and the braces.
+(You need to use braces with these commands because you can use them
+next to other text; without the braces, the formatters would be
+confused. @xref{Command Syntax, , @@-Command Syntax}.)
@menu
* dots:: How to insert dots @dots{}
@@ -11072,10 +11069,13 @@
@node dots
@subsection @code{@@address@hidden@} (@dots{}) and @code{@@address@hidden@}
(@enddots{})
+
@findex dots
@findex enddots
@cindex Inserting dots
address@hidden Inserting ellipsis
@cindex Dots, inserting
address@hidden Ellipsis, inserting
Use the @code{@@address@hidden@}} command to generate an ellipsis, which is
three dots in a row, appropriately spaced @dots{} like so. Do
@@ -11098,16 +11098,17 @@
@node bullet
@subsection @code{@@address@hidden@} (@bullet{})
+
@findex bullet
Use the @code{@@address@hidden@}} command to generate a large round dot, or
-the closest possible thing to one. In Info, an asterisk is address@hidden
+the closest possible thing to one. In Info, an asterisk is used.
Here is a bullet: @bullet{}
When you use @code{@@bullet} in @code{@@itemize}, you do not need to
type the braces, because @code{@@itemize} supplies them.
-(@xref{itemize, , @code{@@itemize}}.)@refill
+(@pxref{itemize, , @code{@@itemize}}).
@node TeX and copyright
@@ -11186,8 +11187,8 @@
it. Therefore, in many cases it is preferable to use the word
``Euro''. (In banking circles, the abbreviation for the Euro is EUR.)
address@hidden ISO 8859-15
address@hidden Latin 9
address@hidden ISO 8859-15, and Euro
address@hidden Latin 9, and Euro
In order to get the Euro symbol in encoded Info output, for example,
it is necessary to specify @code{@@documentencoding ISO-8859-15}.
(@xref{documentencoding,,@code{@@documentencoding}}.) The Euro symbol
@@ -11839,7 +11840,8 @@
@section @code{@@*} and @code{@@/}: Generate and Allow Line Breaks
@findex * @r{(force line break)}
@findex / @r{(allow line break)}
address@hidden Line breaks
address@hidden Line breaks, controlling
address@hidden Controlling line breaks
@cindex Breaks in a line
@cindex Force line break
@cindex Allow line break
@@ -16315,7 +16317,7 @@
@item --no-headers
@opindex --no-headers
@cindex Node separators, omitting
address@hidden Generating plain text files
address@hidden Generating plain text files with @option{--no-headers}
@cindex Menus, omitting
Do not include menus or node separator lines in the output.
@@ -16452,7 +16454,7 @@
@opindex --plaintext
@cindex Plain text output
@cindex ASCII text output
address@hidden Generating plain text files
address@hidden Generating plain text files with @option{--plaintext}
@cindex @file{INSTALL} file, generating
@cindex Node separators, omitting
@cindex Menus, omitting
@@ -17826,7 +17828,9 @@
@node Generating HTML
@chapter Generating HTML
address@hidden HTML output
+
address@hidden Generating HTML
address@hidden Outputting HTML
@command{makeinfo} generates Info output by default, but given the
@option{--html} option, it will generate HTML, for web browsers and
@@ -22945,7 +22949,7 @@
(@url{http://www.gnu.org/software/rcs}) version control systems, which
expand it into a string such as:
@example
-$Id: texinfo.txi,v 1.352 2010/11/15 19:51:16 karl Exp $
+$Id: texinfo.txi,v 1.353 2010/11/16 17:49:36 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}
@@ -23024,7 +23028,7 @@
@verbatim
\input texinfo @c -*-texinfo-*-
address@hidden $Id: texinfo.txi,v 1.352 2010/11/15 19:51:16 karl Exp $
address@hidden $Id: texinfo.txi,v 1.353 2010/11/16 17:49:36 karl Exp $
@comment %**start of header
@setfilename sample.info
@include version.texi