texinfo-commits
[Top][All Lists]
Advanced

[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: Sat, 31 Jul 2010 00:56:01 +0000

CVSROOT:        /sources/texinfo
Module name:    texinfo
Changes by:     Karl Berry <karl>       10/07/31 00:56:01

Modified files:
        .              : ChangeLog 
        doc            : texinfo.txi 

Log message:
        mention restricted chars in node/anchor identifiers in Info defn, too

CVSWeb URLs:
http://cvs.savannah.gnu.org/viewcvs/texinfo/ChangeLog?cvsroot=texinfo&r1=1.1084&r2=1.1085
http://cvs.savannah.gnu.org/viewcvs/texinfo/doc/texinfo.txi?cvsroot=texinfo&r1=1.274&r2=1.275

Patches:
Index: ChangeLog
===================================================================
RCS file: /sources/texinfo/texinfo/ChangeLog,v
retrieving revision 1.1084
retrieving revision 1.1085
diff -u -b -r1.1084 -r1.1085
--- ChangeLog   30 Jul 2010 18:47:39 -0000      1.1084
+++ ChangeLog   31 Jul 2010 00:56:01 -0000      1.1085
@@ -1,6 +1,9 @@
 2010-07-30  Karl Berry  <address@hidden>
 
-       * doc/texinfo.txi (Internationalization of strings): edit node.
+       * doc/texinfo.txi (Internationalization of Strings): edit node,
+       including re-capitalization.
+       (Info Format Regular Nodes): mention that periods, etc., cannot be
+       used in Info identifiers.
 
 2010-07-27  Karl Berry  <address@hidden>
 

Index: doc/texinfo.txi
===================================================================
RCS file: /sources/texinfo/texinfo/doc/texinfo.txi,v
retrieving revision 1.274
retrieving revision 1.275
diff -u -b -r1.274 -r1.275
--- doc/texinfo.txi     30 Jul 2010 18:47:40 -0000      1.274
+++ doc/texinfo.txi     31 Jul 2010 00:56:01 -0000      1.275
@@ -1,5 +1,5 @@
 \input texinfo.tex    @c -*-texinfo-*-
address@hidden $Id: texinfo.txi,v 1.274 2010/07/30 18:47:40 karl Exp $
address@hidden $Id: texinfo.txi,v 1.275 2010/07/31 00:56:01 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.
 
@@ -23275,6 +23275,7 @@
 mandatory.  @xref{ref, , @code{@@ref}}.
 
 @item @@refill
address@hidden refill
 This command used to refill and indent the paragraph after all the
 other processing has been done.  It is no longer needed, since all
 formatters now automatically refill as needed, but you may still see
@@ -24228,7 +24229,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.274 2010/07/30 18:47:40 karl Exp $
+$Id: texinfo.txi,v 1.275 2010/07/31 00:56:01 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}
@@ -24307,7 +24308,7 @@
 
 @verbatim
 \input texinfo   @c -*-texinfo-*-
address@hidden $Id: texinfo.txi,v 1.274 2010/07/30 18:47:40 karl Exp $
address@hidden $Id: texinfo.txi,v 1.275 2010/07/31 00:56:01 karl Exp $
 @comment %**start of header
 @setfilename sample.info
 @include version.texi
@@ -25975,7 +25976,7 @@
 (<filename>: <bytepos>)*
 @end example
 
-The number of preamble bytes written to each output file are included
+The number of preamble bytes written to each output file is included
 in the positions.  Neither the preamble nor the size of the top-level
 output file is included.
 
@@ -26030,10 +26031,11 @@
 in the case of split output only.  In this 
 
 Each following line defines an identifier as either an anchor or a
-node.  It is an error to define the same identifier both ways.  For
-example, @samp{Node: Top^?1647} says that the node named @samp{Top}
-starts at byte 1647 while @samp{Ref: Overview-Footnote-1^?30045} says
-that the anchor named @samp{Overview-Footnote-1} starts at byte 30045.
+node, as specific.  It is an error to define the same identifier both
+ways.  For example, @samp{Node: Top^?1647} says that the node named
address@hidden starts at byte 1647 while @samp{Ref:
+Overview-Footnote-1^?30045} says that the anchor named
address@hidden starts at byte 30045.
 
 In the case of nonsplit output, the byte positions simply refer to the
 location in the output file.  In the case of split output, the byte
@@ -26096,15 +26098,19 @@
 present after each colon and comma, but any number of spaces are
 ignored.
 
-This @t{<node>} defines @t{<id1>} in @t{<fn>}, which is typically just
address@hidden or perhaps @samp{manual.info}.  Each of the other
-references @t{<id2>}, @t{<id3>}, and @t{<id4>} must be defined with
-either @samp{Node} or @samp{Ref} in the @t{<tag table>}.
+This @t{<node>} defines @t{<id1>} in file @t{<fn>}, which is typically
+just @samp{manualname} or perhaps @samp{manualname.info}.  Each of the
+other references @t{<id2>}, @t{<id3>}, and @t{<id4>} must be defined
+with either @samp{Node} or @samp{Ref} in the @t{<tag table>}.
 
 Conventionally the nodes are arranged to form a tree, but this is not
 a requirement of the format.  Each pointer can refer to any defined
 identifier.
 
+Identifiers cannot include periods, commas, colons or parentheses
+(including @@-commands which produce any of these); these can confuse 
+Info readers.  @xref{Node Line Requirements}.
+
 The @t{<general text>} of the node can include the special constructs
 described next.
 
@@ -26273,536 +26279,530 @@
 @xref{Cross References}.
 
 
address@hidden
-The simple description in the command summary seems sufficient to me
-these days, so ignore this appendix.  --karl, 13mar04.
-
address@hidden Refilling Paragraphs
address@hidden Refilling Paragraphs
address@hidden Refilling paragraphs
address@hidden Filling paragraphs
address@hidden Paragraphs, filling
address@hidden refill
-
-The @code{@@refill} command refills and, optionally, indents the first
-line of a address@hidden the command should have been
-called the @code{@@refillandindent} command, but @code{@@refill} is
-shorter and the name was chosen before indenting was possible.} The
address@hidden@@refill} command is no longer important, but we describe it here
-because you once needed it.  You will see it in many old Texinfo
address@hidden
-
-Without refilling, paragraphs containing long @@-constructs may look
-bad after formatting because the formatter removes @@-commands and
-shortens some lines more than others.  In the past, neither the
address@hidden command nor the
address@hidden command refilled paragraphs
-automatically.  The @code{@@refill} command had to be written at the
-end of every paragraph to cause these formatters to fill them.  (Both
address@hidden and @code{makeinfo} have always refilled paragraphs
-automatically.)  Now, all the Info formatters automatically fill and
-indent those paragraphs that need to be filled and address@hidden
-
-The @code{@@refill} command causes @code{texinfo-format-region} and
address@hidden to refill a paragraph in the Info file
address@hidden all the other processing has been done.  For this reason,
-you can not use @code{@@refill} with a paragraph containing either
address@hidden@@*} or @code{@@address@hidden @dots{} @}} since the refilling 
action will
-override those two address@hidden
-
-The @code{texinfo-format-region} and @code{texinfo-format-buffer}
-commands now automatically append @code{@@refill} to the end of each
-paragraph that should be filled.  They do not append @code{@@refill} to
-the ends of paragraphs that contain @code{@@*} or 
@address@hidden@@address@hidden @address@hidden
-and therefore do not refill or indent address@hidden
-
address@hidden ignore
address@hidden The simple description in the command summary seems sufficient 
to me
address@hidden these days, so ignore this appendix.  --karl, 13mar04.
address@hidden 
address@hidden @node Refilling Paragraphs
address@hidden @appendix Refilling Paragraphs
address@hidden @cindex Refilling paragraphs
address@hidden @cindex Filling paragraphs
address@hidden @cindex Paragraphs, filling
address@hidden @findex refill
address@hidden 
address@hidden The @code{@@refill} command refills and, optionally, indents the 
first
address@hidden line of a address@hidden the command should have been
address@hidden called the @code{@@refillandindent} command, but @code{@@refill} 
is
address@hidden shorter and the name was chosen before indenting was possible.} 
The
address@hidden @code{@@refill} command is no longer important, but we describe 
it here
address@hidden because you once needed it.  You will see it in many old Texinfo
address@hidden address@hidden
address@hidden 
address@hidden Without refilling, paragraphs containing long @@-constructs may 
look
address@hidden bad after formatting because the formatter removes @@-commands 
and
address@hidden shortens some lines more than others.  In the past, neither the
address@hidden @code{texinfo-format-region} command nor the
address@hidden @code{texinfo-format-buffer} command refilled paragraphs
address@hidden automatically.  The @code{@@refill} command had to be written at 
the
address@hidden end of every paragraph to cause these formatters to fill them.  
(Both
address@hidden @TeX{} and @code{makeinfo} have always refilled paragraphs
address@hidden automatically.)  Now, all the Info formatters automatically fill 
and
address@hidden indent those paragraphs that need to be filled and address@hidden
address@hidden 
address@hidden The @code{@@refill} command causes @code{texinfo-format-region} 
and
address@hidden @code{texinfo-format-buffer} to refill a paragraph in the Info 
file
address@hidden @emph{after} all the other processing has been done.  For this 
reason,
address@hidden you can not use @code{@@refill} with a paragraph containing 
either
address@hidden @code{@@*} or @code{@@address@hidden @dots{} @}} since the 
refilling action will
address@hidden override those two address@hidden
address@hidden 
address@hidden The @code{texinfo-format-region} and @code{texinfo-format-buffer}
address@hidden commands now automatically append @code{@@refill} to the end of 
each
address@hidden paragraph that should be filled.  They do not append 
@code{@@refill} to
address@hidden the ends of paragraphs that contain @code{@@*} or 
@address@hidden@@address@hidden @address@hidden
address@hidden and therefore do not refill or indent address@hidden
 
 
 @c These are no longer ``new'', and the explanations
address@hidden are all given elsewhere anyway, I think.  --karl, 25apr97.
address@hidden So ignore the entire appendix.
address@hidden
address@hidden are all given elsewhere anyway.  So ignore the entire appendix.
address@hidden --karl, 25apr97.
 @c node New Features, Command and Variable Index, Obtaining TeX, Top
 @c appendix Second Edition Features
 
address@hidden
-% Widen the space for the first column so three control-character
-% strings fit in the first column.  Switched back to default .8in
-% value at end of chapter.
-\global\tableindent=1.0in
address@hidden tex
-
-The second edition of the Texinfo manual describes more than 20 new
-Texinfo mode commands and more than 50 previously undocumented Texinfo
-@@-commands.  This edition is more than twice the length of the first
address@hidden
-
-Here is a brief description of the new address@hidden
-
address@hidden menu
-* New Texinfo Mode Commands::   The updating commands are especially useful.
-* New Commands::                Many newly described @@-commands.
address@hidden end menu
-
address@hidden node New Texinfo Mode Commands, New Commands, Obtaining TeX, 
Obtaining TeX
address@hidden appendixsec New Texinfo Mode Commands
-
-Texinfo mode provides commands and features especially designed for
-working with Texinfo files.  More than 20 new commands have been
-added, including commands for automatically creating and updating
-both nodes and menus.  This is a tedious task when done by address@hidden
-
-The keybindings are intended to be somewhat address@hidden
-
address@hidden subheading Update all nodes and menus
-
-The @code{texinfo-master-menu} command is the primary command:
-
address@hidden @kbd
address@hidden C-c C-u m
address@hidden M-x texinfo-master-menu
-Create or update a master menu.
-With @kbd{C-u} as a prefix argument,
-first create or update all nodes
-and regular menus.
address@hidden table
-
address@hidden subheading Update Pointers
-
address@hidden
-Create or update `Next', `Previous', and `Up' node address@hidden
-
address@hidden
address@hidden Nodes and Menus}.
-
address@hidden @kbd
address@hidden C-c C-u C-n
address@hidden M-x texinfo-update-node
-Update a node.
-
address@hidden C-c C-u C-e
address@hidden M-x texinfo-every-node-update
-Update every node in the buffer.
address@hidden table
-
address@hidden subheading Update Menus
-
address@hidden
-Create or update address@hidden
-
address@hidden
address@hidden Nodes and Menus}.
-
address@hidden @kbd
address@hidden C-c C-u C-m
address@hidden M-x texinfo-make-menu
-Make or update a menu.
-
address@hidden C-c C-u C-a
address@hidden M-x texinfo-all-menus-update
-Make or update all the menus in a buffer.
-With @kbd{C-u} as a prefix argument,
-first update all the nodes.
address@hidden table
-
address@hidden subheading Insert Title as Description
-
address@hidden
-Insert a node's chapter or section title in the space for the
-description in a menu entry line; position point so you can edit the
-insert.  (This command works somewhat differently than the other
-insertion commands, which insert only a predefined string.)@refill
-
address@hidden
address@hidden, Inserting Frequently Used Commands}.
-
address@hidden @kbd
address@hidden C-c C-c C-d
-Insert title.
address@hidden table
-
address@hidden subheading Format for Info
-
address@hidden
-Provide keybindings both for the Info formatting commands that are
-written in Emacs Lisp and for @code{makeinfo} that is written in
address@hidden
-
address@hidden
address@hidden Formatting}.
-
address@hidden
-Use the Emacs lisp @address@hidden commands:
-
address@hidden @kbd
address@hidden C-c C-e C-r
-Format the region.
-
address@hidden C-c C-e C-b
-Format the buffer.
address@hidden table
-
address@hidden
-Use @code{makeinfo}:
-
address@hidden @kbd
address@hidden C-c C-m C-r
-Format the region.
-
address@hidden C-c C-m C-b
-Format the buffer.
-
address@hidden C-c C-m C-l
-Recenter the @code{makeinfo} output buffer.
-
address@hidden C-c C-m C-k
-Kill the @code{makeinfo} formatting job.
address@hidden table
-
address@hidden subheading Typeset and Print
-
address@hidden
-Typeset and print Texinfo documents from within Emacs.
-
address@hidden
address@hidden
-
address@hidden @kbd
address@hidden C-c C-t C-b
-Run @code{texi2dvi} on the buffer.
-
address@hidden C-c C-t C-r
-Run @TeX{} on the region.
-
address@hidden C-c C-t C-i
-Run @code{texindex}.
-
address@hidden C-c C-t C-p
-Print the DVI file.
-
address@hidden C-c C-t C-q
-Show the print queue.
-
address@hidden C-c C-t C-d
-Delete a job from the print queue.
-
address@hidden C-c C-t C-k
-Kill the current @TeX{} formatting job.
-
address@hidden C-c C-t C-x
-Quit a currently stopped @TeX{} formatting job.
-
address@hidden C-c C-t C-l
-Recenter the output buffer.
address@hidden table
-
address@hidden subheading Other Updating Commands
-
address@hidden
-The ``other updating commands'' do not have standard keybindings because
-they are used less address@hidden
-
address@hidden
address@hidden Updating Commands}.
-
address@hidden @kbd
address@hidden M-x texinfo-insert-node-lines
-Insert missing @code{@@node} lines using
-section titles as node names.
-
address@hidden M-x texinfo-multiple-files-update
-Update a multi-file document.
-With a numeric prefix, such as @kbd{C-u 8},
-update  @strong{every} pointer and
-menu in @strong{all} the files and
-then insert a master menu.
-
address@hidden M-x texinfo-indent-menu-description
-Indent descriptions in menus.
-
address@hidden M-x texinfo-sequential-node-update
-Insert node pointers in strict sequence.
address@hidden table
-
address@hidden no.de New Commands,  , New Texinfo Mode Commands, Obtaining TeX
address@hidden appendix.sec New Texinfo @@-Commands
-
-The second edition of the Texinfo manual describes more than 50
-commands that were not described in the first edition.  A third or so
-of these commands existed in Texinfo but were not documented in the
-manual; the others are new.  Here is a listing, with brief
-descriptions of them:@refill
-
address@hidden subheading Indexing
-
address@hidden
-Create your own index, and merge address@hidden
-
address@hidden
address@hidden
-
address@hidden @kbd
address@hidden @@defindex @var{index-name}
-Define a new index and its indexing command.
-See also the @code{@@defcodeindex} command.
-
address@hidden written verbosely to avoid overfull hbox
address@hidden @@synindex @var{from-index} @var{into-index}
-Merge the @var{from-index} index into the @var{into-index} index.
-See also the @code{@@syncodeindex} command.
address@hidden table
-
address@hidden subheading Definitions
-
address@hidden
-Describe functions, variables, macros,
-commands, user options, special forms, and other such artifacts in a
-uniform address@hidden
-
address@hidden
address@hidden Commands}.
-
address@hidden @kbd
address@hidden @@deffn @var{category} @var{name} @address@hidden
-Format a description for functions, interactive
-commands, and similar entities.
-
address@hidden @@defvr, @@defop, @dots{}
-15 other related commands.
address@hidden table
-
address@hidden subheading Glyphs
-
address@hidden
-Indicate the results of evaluation, expansion,
-printed output, an error message, equivalence of expressions, and the
-location of address@hidden
-
address@hidden
address@hidden
-
address@hidden @kbd
address@hidden @@address@hidden@}
address@hidden @equiv{}
-Equivalence:
-
address@hidden @@address@hidden@}
address@hidden @error{}
-Error message
-
address@hidden @@address@hidden@}
address@hidden @expansion{}
-Macro expansion
-
address@hidden @@address@hidden@}
address@hidden @point{}
-Position of point
-
address@hidden @@address@hidden@}
address@hidden @print{}
-Printed output
-
address@hidden @@address@hidden@}
address@hidden @result{}
-Result of an expression
address@hidden table
-
address@hidden subheading Page Headings
-
address@hidden
-Customize page headings.
-
address@hidden
address@hidden
-
address@hidden @kbd
address@hidden @@headings @var{on-off-single-double}
-Headings on or off, single, or double-sided.
-
address@hidden @@evenfooting address@hidden @@| address@hidden @@| 
address@hidden
-Footings for even-numbered (left-hand) pages.
-
address@hidden @@evenheading, @@everyheading, @@oddheading, @dots{}
-Five other related commands.
-
address@hidden @@thischapter
-Insert name of chapter and chapter number.
-
address@hidden @@thischaptername, @@thisfile, @@thistitle, @@thispage
-Related commands.
address@hidden table
-
address@hidden subheading Formatting
-
address@hidden
-Format blocks of text.
-
address@hidden
address@hidden and Examples}, address@hidden
address@hidden and Tables, , Making Lists and Tables}.
-
address@hidden @kbd
address@hidden @@cartouche
-Draw rounded box surrounding text (no effect in Info).
-
address@hidden @@enumerate @var{optional-arg}
-Enumerate a list with letters or numbers.
-
address@hidden @@exdent @var{line-of-text}
-Remove indentation.
-
address@hidden @@flushleft
-Left justify.
-
address@hidden @@flushright
-Right justify.
-
address@hidden @@format
-Do not narrow nor change font.
-
address@hidden @@ftable @var{formatting-command}
address@hidden @@vtable @var{formatting-command}
-Two-column table with indexing.
-
address@hidden @@lisp
-For an example of Lisp code.
-
address@hidden @@smallexample
address@hidden @@smalllisp
-Like @@table and @@lisp, but for (originally) @@smallbook.
address@hidden table
-
address@hidden subheading Conditionals
-
address@hidden
-Conditionally format text.
-
address@hidden
address@hidden clear value, , @code{@@set} @code{@@clear} @code{@@address@hidden
-
address@hidden @kbd
address@hidden @@set @var{flag} address@hidden
-Set a flag.  Optionally, set value
-of @var{flag} to @var{string}.
-
address@hidden @@clear @var{flag}
-Clear a flag.
-
address@hidden @@address@hidden@address@hidden
-Replace with value to which @var{flag} is set.
-
address@hidden @@ifset @var{flag}
-Format, if @var{flag} is set.
-
address@hidden @@ifclear @var{flag}
-Ignore, if @var{flag} is set.
address@hidden table
-
address@hidden subheading @@heading series for Titles
-
address@hidden
-Produce unnumbered headings that do not appear in a table of contents.
-
address@hidden
address@hidden
-
address@hidden @kbd
address@hidden @@heading @var{title}
-Unnumbered section-like heading not listed
-in the table of contents of a printed manual.
-
address@hidden @@chapheading, @@majorheading, @@c subheading, @@subsubheading
-Related commands.
address@hidden table
-
address@hidden 1000
address@hidden subheading Font commands
-
address@hidden 1000
address@hidden
address@hidden, and @*
address@hidden
-
address@hidden @kbd
address@hidden @@address@hidden@address@hidden
-Print in roman font.
-
address@hidden @@address@hidden@address@hidden
-Print in @sc{small caps} font.
address@hidden table
-
address@hidden subheading Miscellaneous
-
address@hidden
-See @ref{title subtitle author, , @code{@@title} @code{@@subtitle} and 
@code{@@author} Commands},@*
-see @ref{Customized Highlighting},@*
-see @ref{Overfull hboxes},@*
-see @ref{Footnotes},@*
-see @ref{dmn, , Format a Dimension},@*
-see @ref{Raise/lower sections, , @code{@@raisesections} and 
@code{@@lowersections}},@*
-see @ref{math, , @code{@@math}: Inserting Mathematical address@hidden
-see @ref{minus, , Inserting a Minus Sign},@*
-see @ref{paragraphindent, , Paragraph Indenting},@*
-see @ref{Cross Reference Commands},@*
-see @ref{title subtitle author, , @code{@@title} @code{@@subtitle} and 
@code{@@author}}, address@hidden
-see @ref{Custom Headings, , How to Make Your Own Headings}.
-
address@hidden @kbd
address@hidden @@author @var{author}
-Typeset author's name.
-
address@hidden @item @@definfoenclose @var{new-command}, @var{before}, 
@var{after},
address@hidden Define a highlighting command for Info.  (Info only.)
-
address@hidden @@finalout
-Produce cleaner printed output.
-
address@hidden @@footnotestyle @var{end-or-separate}
-Specify footnote style, either @samp{end} or @samp{separate}.
address@hidden Styles}.
-
address@hidden @@address@hidden@address@hidden
-Format a dimension.
-
address@hidden @@global@@address@hidden@var{existing-cmd}
-Define a highlighting command for @TeX{}. (@TeX{} only.)
-
address@hidden @@lowersections
-Reduce hierarchical level of sectioning commands.
-
address@hidden @@address@hidden@address@hidden
-Format a mathematical expression.
-
address@hidden @@address@hidden@}
-Generate a minus sign.
-
address@hidden @@paragraphindent @var{asis-or-number}
-Specify amount of paragraph indentation.
-
address@hidden @@raisesections
-Raise hierarchical level of sectioning commands.
-
address@hidden @@address@hidden@var{node-name}, @address@hidden@r{]}, 
@address@hidden@r{]}, @address@hidden@r{]}, @address@hidden@address@hidden
-Make a reference.  In the printed manual, the
-reference does not start with the word `see'.
-
address@hidden @@title @var{title}
-Typeset @var{title} in the alternative
-title page format.
-
address@hidden @@subtitle @var{subtitle}
-Typeset @var{subtitle} in the alternative
-title page format.
-
address@hidden @@address@hidden@}
-Insert the current date.
address@hidden table
address@hidden
-% Switch width of first column of tables back to default value
-\global\tableindent=.8in
address@hidden tex
address@hidden ignore
address@hidden @tex
address@hidden % Widen the space for the first column so three 
control-character %
address@hidden strings fit in the first column.  Switched back to default .8in %
address@hidden value at end of chapter.  \global\tableindent=1.0in
address@hidden @end tex
address@hidden 
address@hidden The second edition of the Texinfo manual describes more than 20 
new
address@hidden Texinfo mode commands and more than 50 previously undocumented 
Texinfo
address@hidden @@-commands.  This edition is more than twice the length of the 
first
address@hidden address@hidden
address@hidden 
address@hidden Here is a brief description of the new address@hidden
address@hidden 
address@hidden @c menu
address@hidden * New Texinfo Mode Commands::   The updating commands are 
especially useful.
address@hidden * New Commands::                Many newly described @@-commands.
address@hidden @c end menu
address@hidden 
address@hidden @c node New Texinfo Mode Commands, New Commands, Obtaining TeX, 
Obtaining TeX
address@hidden @c appendixsec New Texinfo Mode Commands
address@hidden 
address@hidden Texinfo mode provides commands and features especially designed 
for
address@hidden working with Texinfo files.  More than 20 new commands have been
address@hidden added, including commands for automatically creating and updating
address@hidden both nodes and menus.  This is a tedious task when done by 
address@hidden
address@hidden 
address@hidden The keybindings are intended to be somewhat address@hidden
address@hidden 
address@hidden @c subheading Update all nodes and menus
address@hidden 
address@hidden The @code{texinfo-master-menu} command is the primary command:
address@hidden 
address@hidden @table @kbd
address@hidden @item C-c C-u m
address@hidden @itemx M-x texinfo-master-menu
address@hidden Create or update a master menu.
address@hidden With @kbd{C-u} as a prefix argument,
address@hidden first create or update all nodes
address@hidden and regular menus.
address@hidden @end table
address@hidden 
address@hidden @c subheading Update Pointers
address@hidden 
address@hidden @noindent
address@hidden Create or update `Next', `Previous', and `Up' node address@hidden
address@hidden 
address@hidden @noindent
address@hidden @xref{Updating Nodes and Menus}.
address@hidden 
address@hidden @table @kbd
address@hidden @item C-c C-u C-n
address@hidden @itemx M-x texinfo-update-node
address@hidden Update a node.
address@hidden 
address@hidden @item C-c C-u C-e
address@hidden @itemx M-x texinfo-every-node-update
address@hidden Update every node in the buffer.
address@hidden @end table
address@hidden 
address@hidden @c subheading Update Menus
address@hidden 
address@hidden @noindent
address@hidden Create or update address@hidden
address@hidden 
address@hidden @noindent
address@hidden @xref{Updating Nodes and Menus}.
address@hidden 
address@hidden @table @kbd
address@hidden @item C-c C-u C-m
address@hidden @itemx M-x texinfo-make-menu
address@hidden Make or update a menu.
address@hidden 
address@hidden @item C-c C-u C-a
address@hidden @itemx M-x texinfo-all-menus-update
address@hidden Make or update all the menus in a buffer.
address@hidden With @kbd{C-u} as a prefix argument,
address@hidden first update all the nodes.
address@hidden @end table
address@hidden 
address@hidden @c subheading Insert Title as Description
address@hidden 
address@hidden @noindent
address@hidden Insert a node's chapter or section title in the space for the
address@hidden description in a menu entry line; position point so you can edit 
the
address@hidden insert.  (This command works somewhat differently than the other
address@hidden insertion commands, which insert only a predefined 
string.)@refill
address@hidden 
address@hidden @noindent
address@hidden @xref{Inserting, Inserting Frequently Used Commands}.
address@hidden 
address@hidden @table @kbd
address@hidden @item C-c C-c C-d
address@hidden Insert title.
address@hidden @end table
address@hidden 
address@hidden @c subheading Format for Info
address@hidden 
address@hidden @noindent
address@hidden Provide keybindings both for the Info formatting commands that 
are
address@hidden written in Emacs Lisp and for @code{makeinfo} that is written in
address@hidden address@hidden
address@hidden 
address@hidden @noindent
address@hidden @xref{Info Formatting}.
address@hidden 
address@hidden @noindent
address@hidden Use the Emacs lisp @address@hidden commands:
address@hidden 
address@hidden @table @kbd
address@hidden @item C-c C-e C-r
address@hidden Format the region.
address@hidden 
address@hidden @item C-c C-e C-b
address@hidden Format the buffer.
address@hidden @end table
address@hidden 
address@hidden @noindent
address@hidden Use @code{makeinfo}:
address@hidden 
address@hidden @table @kbd
address@hidden @item C-c C-m C-r
address@hidden Format the region.
address@hidden 
address@hidden @item C-c C-m C-b
address@hidden Format the buffer.
address@hidden 
address@hidden @item C-c C-m C-l
address@hidden Recenter the @code{makeinfo} output buffer.
address@hidden 
address@hidden @item C-c C-m C-k
address@hidden Kill the @code{makeinfo} formatting job.
address@hidden @end table
address@hidden 
address@hidden @c subheading Typeset and Print
address@hidden 
address@hidden @noindent
address@hidden Typeset and print Texinfo documents from within Emacs.
address@hidden 
address@hidden @noindent
address@hidden @xref{Printing}.
address@hidden 
address@hidden @table @kbd
address@hidden @item C-c C-t C-b
address@hidden Run @code{texi2dvi} on the buffer.
address@hidden 
address@hidden @item C-c C-t C-r
address@hidden Run @TeX{} on the region.
address@hidden 
address@hidden @item C-c C-t C-i
address@hidden Run @code{texindex}.
address@hidden 
address@hidden @item C-c C-t C-p
address@hidden Print the DVI file.
address@hidden 
address@hidden @item C-c C-t C-q
address@hidden Show the print queue.
address@hidden 
address@hidden @item C-c C-t C-d
address@hidden Delete a job from the print queue.
address@hidden 
address@hidden @item C-c C-t C-k
address@hidden Kill the current @TeX{} formatting job.
address@hidden 
address@hidden @item C-c C-t C-x
address@hidden Quit a currently stopped @TeX{} formatting job.
address@hidden 
address@hidden @item C-c C-t C-l
address@hidden Recenter the output buffer.
address@hidden @end table
address@hidden 
address@hidden @c subheading Other Updating Commands
address@hidden 
address@hidden @noindent
address@hidden The ``other updating commands'' do not have standard keybindings 
because
address@hidden they are used less address@hidden
address@hidden 
address@hidden @noindent
address@hidden @xref{Other Updating Commands}.
address@hidden 
address@hidden @table @kbd
address@hidden @item M-x texinfo-insert-node-lines
address@hidden Insert missing @code{@@node} lines using
address@hidden section titles as node names.
address@hidden 
address@hidden @item M-x texinfo-multiple-files-update
address@hidden Update a multi-file document.
address@hidden With a numeric prefix, such as @kbd{C-u 8},
address@hidden update  @strong{every} pointer and
address@hidden menu in @strong{all} the files and
address@hidden then insert a master menu.
address@hidden 
address@hidden @item M-x texinfo-indent-menu-description
address@hidden Indent descriptions in menus.
address@hidden 
address@hidden @item M-x texinfo-sequential-node-update
address@hidden Insert node pointers in strict sequence.
address@hidden @end table
address@hidden 
address@hidden @c no.de New Commands,  , New Texinfo Mode Commands, Obtaining 
TeX
address@hidden @c appendix.sec New Texinfo @@-Commands
address@hidden 
address@hidden The second edition of the Texinfo manual describes more than 50
address@hidden commands that were not described in the first edition.  A third 
or so
address@hidden of these commands existed in Texinfo but were not documented in 
the
address@hidden manual; the others are new.  Here is a listing, with brief
address@hidden descriptions of them:@refill
address@hidden 
address@hidden @c subheading Indexing
address@hidden 
address@hidden @noindent
address@hidden Create your own index, and merge address@hidden
address@hidden 
address@hidden @noindent
address@hidden @xref{Indices}.
address@hidden 
address@hidden @table @kbd
address@hidden @item @@defindex @var{index-name}
address@hidden Define a new index and its indexing command.
address@hidden See also the @code{@@defcodeindex} command.
address@hidden 
address@hidden @c written verbosely to avoid overfull hbox
address@hidden @item @@synindex @var{from-index} @var{into-index}
address@hidden Merge the @var{from-index} index into the @var{into-index} index.
address@hidden See also the @code{@@syncodeindex} command.
address@hidden @end table
address@hidden 
address@hidden @c subheading Definitions
address@hidden 
address@hidden @noindent
address@hidden Describe functions, variables, macros,
address@hidden commands, user options, special forms, and other such artifacts 
in a
address@hidden uniform address@hidden
address@hidden 
address@hidden @noindent
address@hidden @xref{Definition Commands}.
address@hidden 
address@hidden @table @kbd
address@hidden @item @@deffn @var{category} @var{name} @address@hidden
address@hidden Format a description for functions, interactive
address@hidden commands, and similar entities.
address@hidden 
address@hidden @item @@defvr, @@defop, @dots{}
address@hidden 15 other related commands.
address@hidden @end table
address@hidden 
address@hidden @c subheading Glyphs
address@hidden 
address@hidden @noindent
address@hidden Indicate the results of evaluation, expansion,
address@hidden printed output, an error message, equivalence of expressions, 
and the
address@hidden location of address@hidden
address@hidden 
address@hidden @noindent
address@hidden @xref{Glyphs}.
address@hidden 
address@hidden @table @kbd
address@hidden @item @@address@hidden@}
address@hidden @itemx @equiv{}
address@hidden Equivalence:
address@hidden 
address@hidden @item @@address@hidden@}
address@hidden @itemx @error{}
address@hidden Error message
address@hidden 
address@hidden @item @@address@hidden@}
address@hidden @itemx @expansion{}
address@hidden Macro expansion
address@hidden 
address@hidden @item @@address@hidden@}
address@hidden @itemx @point{}
address@hidden Position of point
address@hidden 
address@hidden @item @@address@hidden@}
address@hidden @itemx @print{}
address@hidden Printed output
address@hidden 
address@hidden @item @@address@hidden@}
address@hidden @itemx @result{}
address@hidden Result of an expression
address@hidden @end table
address@hidden 
address@hidden @c subheading Page Headings
address@hidden 
address@hidden @noindent
address@hidden Customize page headings.
address@hidden 
address@hidden @noindent
address@hidden @xref{Headings}.
address@hidden 
address@hidden @table @kbd
address@hidden @item @@headings @var{on-off-single-double}
address@hidden Headings on or off, single, or double-sided.
address@hidden 
address@hidden @item @@evenfooting address@hidden @@| address@hidden @@| 
address@hidden
address@hidden Footings for even-numbered (left-hand) pages.
address@hidden 
address@hidden @item @@evenheading, @@everyheading, @@oddheading, @dots{}
address@hidden Five other related commands.
address@hidden 
address@hidden @item @@thischapter
address@hidden Insert name of chapter and chapter number.
address@hidden 
address@hidden @item @@thischaptername, @@thisfile, @@thistitle, @@thispage
address@hidden Related commands.
address@hidden @end table
address@hidden 
address@hidden @c subheading Formatting
address@hidden 
address@hidden @noindent
address@hidden Format blocks of text.
address@hidden 
address@hidden @noindent
address@hidden @xref{Quotations and Examples}, address@hidden
address@hidden @ref{Lists and Tables, , Making Lists and Tables}.
address@hidden 
address@hidden @table @kbd
address@hidden @item @@cartouche
address@hidden Draw rounded box surrounding text (no effect in Info).
address@hidden 
address@hidden @item @@enumerate @var{optional-arg}
address@hidden Enumerate a list with letters or numbers.
address@hidden 
address@hidden @item @@exdent @var{line-of-text}
address@hidden Remove indentation.
address@hidden 
address@hidden @item @@flushleft
address@hidden Left justify.
address@hidden 
address@hidden @item @@flushright
address@hidden Right justify.
address@hidden 
address@hidden @item @@format
address@hidden Do not narrow nor change font.
address@hidden 
address@hidden @item @@ftable @var{formatting-command}
address@hidden @itemx @@vtable @var{formatting-command}
address@hidden Two-column table with indexing.
address@hidden 
address@hidden @item @@lisp
address@hidden For an example of Lisp code.
address@hidden 
address@hidden @item @@smallexample
address@hidden @itemx @@smalllisp
address@hidden Like @@table and @@lisp, but for (originally) @@smallbook.
address@hidden @end table
address@hidden 
address@hidden @c subheading Conditionals
address@hidden 
address@hidden @noindent
address@hidden Conditionally format text.
address@hidden 
address@hidden @noindent
address@hidden @xref{set clear value, , @code{@@set} @code{@@clear} 
@code{@@address@hidden
address@hidden 
address@hidden @table @kbd
address@hidden @item @@set @var{flag} address@hidden
address@hidden Set a flag.  Optionally, set value
address@hidden of @var{flag} to @var{string}.
address@hidden 
address@hidden @item @@clear @var{flag}
address@hidden Clear a flag.
address@hidden 
address@hidden @item @@address@hidden@address@hidden
address@hidden Replace with value to which @var{flag} is set.
address@hidden 
address@hidden @item @@ifset @var{flag}
address@hidden Format, if @var{flag} is set.
address@hidden 
address@hidden @item @@ifclear @var{flag}
address@hidden Ignore, if @var{flag} is set.
address@hidden @end table
address@hidden 
address@hidden @c subheading @@heading series for Titles
address@hidden 
address@hidden @noindent
address@hidden Produce unnumbered headings that do not appear in a table of 
contents.
address@hidden 
address@hidden @noindent
address@hidden @xref{Structuring}.
address@hidden 
address@hidden @table @kbd
address@hidden @item @@heading @var{title}
address@hidden Unnumbered section-like heading not listed
address@hidden in the table of contents of a printed manual.
address@hidden 
address@hidden @item @@chapheading, @@majorheading, @@c subheading, 
@@subsubheading
address@hidden Related commands.
address@hidden @end table
address@hidden 
address@hidden @need 1000
address@hidden @c subheading Font commands
address@hidden 
address@hidden @need 1000
address@hidden @noindent
address@hidden @xref{Smallcaps}, and @*
address@hidden @ref{Fonts}.
address@hidden 
address@hidden @table @kbd
address@hidden @item @@address@hidden@address@hidden
address@hidden Print in roman font.
address@hidden 
address@hidden @item @@address@hidden@address@hidden
address@hidden Print in @sc{small caps} font.
address@hidden @end table
address@hidden 
address@hidden @c subheading Miscellaneous
address@hidden 
address@hidden @noindent
address@hidden See @ref{title subtitle author, , @code{@@title} 
@code{@@subtitle} and @code{@@author} Commands},@*
address@hidden see @ref{Customized Highlighting},@*
address@hidden see @ref{Overfull hboxes},@*
address@hidden see @ref{Footnotes},@*
address@hidden see @ref{dmn, , Format a Dimension},@*
address@hidden see @ref{Raise/lower sections, , @code{@@raisesections} and 
@code{@@lowersections}},@*
address@hidden see @ref{math, , @code{@@math}: Inserting Mathematical 
address@hidden
address@hidden see @ref{minus, , Inserting a Minus Sign},@*
address@hidden see @ref{paragraphindent, , Paragraph Indenting},@*
address@hidden see @ref{Cross Reference Commands},@*
address@hidden see @ref{title subtitle author, , @code{@@title} 
@code{@@subtitle} and @code{@@author}}, address@hidden
address@hidden see @ref{Custom Headings, , How to Make Your Own Headings}.
address@hidden 
address@hidden @table @kbd
address@hidden @item @@author @var{author}
address@hidden Typeset author's name.
address@hidden 
address@hidden @c @item @@definfoenclose @var{new-command}, @var{before}, 
@var{after},
address@hidden @c Define a highlighting command for Info.  (Info only.)
address@hidden 
address@hidden @item @@finalout
address@hidden Produce cleaner printed output.
address@hidden 
address@hidden @item @@footnotestyle @var{end-or-separate}
address@hidden Specify footnote style, either @samp{end} or @samp{separate}.
address@hidden @xref{Footnote Styles}.
address@hidden 
address@hidden @item @@address@hidden@address@hidden
address@hidden Format a dimension.
address@hidden 
address@hidden @item @@global@@address@hidden@var{existing-cmd}
address@hidden Define a highlighting command for @TeX{}. (@TeX{} only.)
address@hidden 
address@hidden @item @@lowersections
address@hidden Reduce hierarchical level of sectioning commands.
address@hidden 
address@hidden @item @@address@hidden@address@hidden
address@hidden Format a mathematical expression.
address@hidden 
address@hidden @item @@address@hidden@}
address@hidden Generate a minus sign.
address@hidden 
address@hidden @item @@paragraphindent @var{asis-or-number}
address@hidden Specify amount of paragraph indentation.
address@hidden 
address@hidden @item @@raisesections
address@hidden Raise hierarchical level of sectioning commands.
address@hidden 
address@hidden @item @@address@hidden@var{node-name}, @address@hidden@r{]}, 
@address@hidden@r{]}, @address@hidden@r{]}, @address@hidden@address@hidden
address@hidden Make a reference.  In the printed manual, the
address@hidden reference does not start with the word `see'.
address@hidden 
address@hidden @item @@title @var{title}
address@hidden Typeset @var{title} in the alternative
address@hidden title page format.
address@hidden 
address@hidden @item @@subtitle @var{subtitle}
address@hidden Typeset @var{subtitle} in the alternative
address@hidden title page format.
address@hidden 
address@hidden @item @@address@hidden@}
address@hidden Insert the current date.
address@hidden @end table
address@hidden @tex
address@hidden % Switch width of first column of tables back to default value
address@hidden \global\tableindent=.8in
address@hidden @end tex
 
 
 @node GNU Free Documentation License



reply via email to

[Prev in Thread] Current Thread [Next in Thread]