From 55f612f03ead76efe6be0e42ca14410f11345c36 Mon Sep 17 00:00:00 2001 From: Glenn Morris Date: Mon, 12 Aug 2013 23:55:21 -0700 Subject: [PATCH] Rename some doc/misc info nodes to avoid chars that can cause Texinfo problems * reftex.texi (LaTeX xr Package, Options - Table of Contents) (Options - Defining Label Environments, Options - Creating Labels) (Options - Referencing Labels, Options - Creating Citations) (Options - Index Support, Options - Viewing Cross-References) (Options - Finding Files, Options - Optimizations) (Options - Fontification, Options - Misc): * cc-mode.texi (Sample Init File): * edt.texi (Init file): * epa.texi (Encrypting/decrypting gpg files): * mairix-el.texi (About, Setting up the mairix interface, Using) (Extending): Rename nodes to avoid characters that can cause Texinfo problems. --- doc/misc/ChangeLog | 15 ++++++ doc/misc/cc-mode.texi | 22 ++++----- doc/misc/edt.texi | 4 +- doc/misc/epa.texi | 8 ++-- doc/misc/mairix-el.texi | 29 ++++++------ doc/misc/reftex.texi | 119 +++++++++++++++++++++++------------------------- 6 files changed, 104 insertions(+), 93 deletions(-) diff --git a/doc/misc/ChangeLog b/doc/misc/ChangeLog index 1ef5730674e..a745b5d547b 100644 --- a/doc/misc/ChangeLog +++ b/doc/misc/ChangeLog @@ -1,3 +1,18 @@ +2013-08-13 Glenn Morris + + * reftex.texi (LaTeX xr Package, Options - Table of Contents) + (Options - Defining Label Environments, Options - Creating Labels) + (Options - Referencing Labels, Options - Creating Citations) + (Options - Index Support, Options - Viewing Cross-References) + (Options - Finding Files, Options - Optimizations) + (Options - Fontification, Options - Misc): + * cc-mode.texi (Sample Init File): + * edt.texi (Init file): + * epa.texi (Encrypting/decrypting gpg files): + * mairix-el.texi (About, Setting up the mairix interface, Using) + (Extending): + Rename nodes to avoid characters that can cause Texinfo problems. + 2013-07-31 Glenn Morris * woman.texi (Top): Avoid mailto: in html output. diff --git a/doc/misc/cc-mode.texi b/doc/misc/cc-mode.texi index 52a0cea53c2..a0e335202e4 100644 --- a/doc/misc/cc-mode.texi +++ b/doc/misc/cc-mode.texi @@ -241,7 +241,7 @@ functions, classes, etc.; there are other packages for that. * Customizing Indentation:: * Custom Macros:: * Odds and Ends:: -* Sample .emacs File:: +* Sample Init File:: * Performance Issues:: * Limitations and Known Bugs:: * FAQ:: @@ -1113,7 +1113,7 @@ valid.}. This function is not bound to a key by default, but it's intended to be used on the @kbd{RET} key. If you like the behavior of @code{newline-and-indent} on @kbd{RET}, you should consider switching to -this function. @xref{Sample .emacs File}. +this function. @xref{Sample Init File}. @item @kbd{M-x c-context-open-line} @findex c-context-open-line @@ -1170,7 +1170,7 @@ and @ref{Indentation Engine Basics}. You can toggle each of these minor modes on and off, and you can configure @ccmode{} so that it starts up with your favorite -combination of them (@pxref{Sample .emacs File}). By default, when +combination of them (@pxref{Sample Init File}). By default, when you initialize a buffer, electric mode and syntactic-indentation mode are enabled but the other two modes are disabled. @@ -2378,7 +2378,7 @@ those set by @code{c-default-style}. @vindex initialization-hook (c-) Hook run only once per Emacs session, when @ccmode{} is initialized. This is a good place to change key bindings (or add new ones) in any -of the @ccmode{} key maps. @xref{Sample .emacs File}. +of the @ccmode{} key maps. @xref{Sample Init File}. @end defvar @defvar c-mode-common-hook @@ -2406,7 +2406,7 @@ overwritten when @ccmode{} gets loaded. Here's a simplified example of what you can add to your @file{.emacs} file to do things whenever any @ccmode{} language is edited. See the Emacs manuals for more information on customizing Emacs via hooks. -@xref{Sample .emacs File}, for a more complete sample @file{.emacs} +@xref{Sample Init File}, for a more complete sample @file{.emacs} file. @example @@ -2685,7 +2685,7 @@ create a new @dfn{style definition}, possibly based on an existing style. To do this, put the new style's settings into a list with the following format; the list can then be passed as an argument to the function @code{c-add-style}. You can see an example of a style -definition in @ref{Sample .emacs File}. +definition in @ref{Sample Init File}. @cindex style definition @c @defvr {List} style definition @@ -2753,7 +2753,7 @@ deprecated and it might be removed from @ccmode{} in a future release. You should use @code{c-set-style} instead. The sample @file{.emacs} file provides a concrete example of how a new -style can be added and automatically set. @xref{Sample .emacs File}. +style can be added and automatically set. @xref{Sample Init File}. @end defun @defvar c-style-alist @@ -6759,7 +6759,7 @@ initialization code. @end defun @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Odds and Ends, Sample .emacs File, Custom Macros, Top +@node Odds and Ends, Sample Init File, Custom Macros, Top @comment node-name, next, previous, up @chapter Odds and Ends @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! @@ -6803,9 +6803,9 @@ anchoring position to indent the line in that case. @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Sample .emacs File, Performance Issues, Odds and Ends, Top +@node Sample Init File, Performance Issues, Odds and Ends, Top @comment node-name, next, previous, up -@appendix Sample .emacs File +@appendix Sample Init File @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! Here's a sample .emacs file fragment that might help you along the way. @@ -6862,7 +6862,7 @@ to change some of the actual values. @end verbatim @comment !!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!!! -@node Performance Issues, Limitations and Known Bugs, Sample .emacs File, Top +@node Performance Issues, Limitations and Known Bugs, Sample Init File, Top @comment node-name, next, previous, up @chapter Performance Issues @cindex performance diff --git a/doc/misc/edt.texi b/doc/misc/edt.texi index 339d59bd123..40aeae836ef 100644 --- a/doc/misc/edt.texi +++ b/doc/misc/edt.texi @@ -789,13 +789,13 @@ so the above directions may need some modification if your site has such special needs. @menu -* edt-user.el:: Creating your own @file{edt-user.el} file. +* Init file:: Creating your own @file{edt-user.el} file. * Words:: Specifying word entities. * Control keys:: Enabling EDT control key sequence bindings. * Scroll margins:: Setting scroll margins. @end menu -@node edt-user.el +@node Init file @section Creating your own @file{edt-user.el} File A sample @file{edt-user.el} file is provided in the Emacs @file{etc/} diff --git a/doc/misc/epa.texi b/doc/misc/epa.texi index e21851ef37a..69f1f0baaee 100644 --- a/doc/misc/epa.texi +++ b/doc/misc/epa.texi @@ -106,7 +106,7 @@ This chapter introduces various commands for typical use cases. * Cryptographic operations on files:: * Dired integration:: * Mail-mode integration:: -* Encrypting/decrypting *.gpg files:: +* Encrypting/decrypting gpg files:: @end menu @node Key management @@ -345,8 +345,8 @@ key in the recipient list, use @samp{encrypt-to} option in @end table -@node Encrypting/decrypting *.gpg files -@section Encrypting/decrypting *.gpg files +@node Encrypting/decrypting gpg files +@section Encrypting/decrypting gpg files By default, every file whose name ends with @samp{.gpg} will be treated as encrypted. That is, when you open such a file, the decrypted text is inserted in the buffer rather than encrypted one. @@ -463,7 +463,7 @@ To set up gpg-agent, follow the instruction in GnuPG manual. To set up elisp passphrase cache, set @code{epa-file-cache-passphrase-for-symmetric-encryption}. -@xref{Encrypting/decrypting *.gpg files}. +@xref{Encrypting/decrypting gpg files}. @node Bug Reports @chapter Bug Reports diff --git a/doc/misc/mairix-el.texi b/doc/misc/mairix-el.texi index ff5b2ca6748..0c71a5f9988 100644 --- a/doc/misc/mairix-el.texi +++ b/doc/misc/mairix-el.texi @@ -55,15 +55,15 @@ database. @end ifnottex @menu -* About mairix and mairix.el:: About the mairix search engine and mairix.el -* Configuring mairix:: How to configure mairix -* Setting up mairix.el:: Set up mairix.el -* Using mairix.el:: List of interactive functions -* Extending mairix.el:: Support your favorite mail reader! +* About:: About the mairix search engine and mairix.el. +* Configuring mairix:: How to configure mairix. +* Setting up the mairix interface:: Set up mairix.el. +* Using:: List of interactive functions +* Extending:: Support your favorite mail reader! * GNU Free Documentation License:: The license for this documentation. @end menu -@node About mairix and mairix.el +@node About @chapter About mairix and mairix.el Mairix is a tool for indexing and searching words in locally stored @@ -98,7 +98,7 @@ Currently, @code{mairix.el} is only tested with mbox output together with RMail, Gnus, or VM as the Emacs mail program. However, it should also work with Maildir or MH, and it should be very easy to integrate other Emacs mail programs into @code{mairix.el} -(@pxref{Extending mairix.el}). +(@pxref{Extending}). If you use Gnus with maildir or MH, you should really use the native Gnus back end @code{nnmairix} instead, since it is more tightly @@ -165,8 +165,8 @@ Now simply call @code{mairix} to create the index for the first time. Note that this may take a few minutes, but every following index will do the updates incrementally and hence is very fast. -@node Setting up mairix.el -@chapter Setting up mairix.el +@node Setting up the mairix interface +@chapter Setting up the mairix interface First, put @code{mairix.el} in your Emacs search path and put @code{(require 'mairix)} into your @file{.emacs} file. Then, use @@ -179,13 +179,12 @@ If you use Gnus with maildir or mh, use the native Gnus back end nnmairix instead. If you use another Emacs mail program which is not yet supported by -mairix.el, it is pretty easy to integrate it. @xref{Extending -mairix.el}, on how to integrate it into mairix.el. +mairix.el, it is pretty easy to integrate it. @xref{Extending}, +on how to integrate it into mairix.el. -Now you should be ready to go. @xref{Using mairix.el}, for the available -commands. +Now you should be ready to go. @xref{Using}, for the available commands. -@node Using mairix.el +@node Using @chapter Using mairix.el There are currently no default key bindings for mairix.el, since those @@ -314,7 +313,7 @@ will still be usable while the update is done. @end table -@node Extending mairix.el +@node Extending @chapter Extending mairix.el Your favorite Emacs mail program is not supported? Shame on me. But diff --git a/doc/misc/reftex.texi b/doc/misc/reftex.texi index 2a7a231aa55..d03fe502257 100644 --- a/doc/misc/reftex.texi +++ b/doc/misc/reftex.texi @@ -154,7 +154,7 @@ Labels and References * Defining Label Environments:: ... and environments it doesn't. * Reference Info:: View the label corresponding to a \ref. * Reference Styles:: Macros to be used instead of \ref. -* xr (LaTeX package):: References to external documents. +* LaTeX xr Package:: References to external documents. Defining Label Environments @@ -197,17 +197,17 @@ AUCTeX Options, Keymaps, Hooks -* Options (Table of Contents):: -* Options (Defining Label Environments):: -* Options (Creating Labels):: -* Options (Referencing Labels):: -* Options (Creating Citations):: -* Options (Index Support):: -* Options (Viewing Cross-References):: -* Options (Finding Files):: -* Options (Optimizations):: -* Options (Fontification):: -* Options (Misc):: +* Options - Table of Contents:: +* Options - Defining Label Environments:: +* Options - Creating Labels:: +* Options - Referencing Labels:: +* Options - Creating Citations:: +* Options - Index Support:: +* Options - Viewing Cross-References:: +* Options - Finding Files:: +* Options - Optimizations:: +* Options - Fontification:: +* Options - Misc:: @end detailmenu @end menu @@ -582,8 +582,8 @@ called. @item mouse-2 @vindex reftex-highlight-selection Clicking with mouse button 2 on a line has the same effect as @key{RET}. -See also variable @code{reftex-highlight-selection}, @ref{Options -(Fontification)}. +See also variable @code{reftex-highlight-selection}, +@ref{Options - Fontification}. @item f @vindex reftex-toc-follow-mode @@ -702,9 +702,8 @@ buffer. @item x Switch to the @file{*toc*} buffer of an external document. When the -current document is using the @code{xr} package (@pxref{xr (LaTeX -package)}), @RefTeX{} will switch to one of the external -documents. +current document is using the @code{xr} package (@pxref{LaTeX xr Package}), +@RefTeX{} will switch to one of the external documents. @tablesubheading{Automatic recentering} @@ -797,7 +796,7 @@ equation counter. * Defining Label Environments:: ... and environments it doesn't. * Reference Info:: View the label corresponding to a \ref. * Reference Styles:: Macros to be used instead of \ref. -* xr (LaTeX package):: References to external documents. +* LaTeX xr Package:: References to external documents. @end menu @node Creating Labels, Referencing Labels, , Labels and References @@ -860,8 +859,8 @@ this label later. @vindex reftex-insert-label-flags If you want to change the way certain labels are created, check out the -variable @code{reftex-insert-label-flags} (@pxref{Options (Creating -Labels)}). +variable @code{reftex-insert-label-flags} (@pxref{Options - Creating +Labels}). If you are using @AUCTeX{} to write your @LaTeX{} documents, you can set it up to delegate the creation of labels to @@ -982,7 +981,7 @@ references all marked labels. @vindex reftex-highlight-selection Clicking with mouse button 2 on a label will accept it like @key{RET} would. See also variable @code{reftex-highlight-selection}, -@ref{Options (Misc)}. +@ref{Options - Misc}. @vindex reftex-multiref-punctuation @item m - + , @@ -1035,7 +1034,7 @@ buffer. @tablesubheading{Controlling what gets displayed} @vindex reftex-label-menu-flags The defaults for the following flags can be configured with the variable -@code{reftex-label-menu-flags} (@pxref{Options (Referencing Labels)}). +@code{reftex-label-menu-flags} (@pxref{Options - Referencing Labels}). @item c Toggle the display of the one-line label definition context in the @@ -1083,8 +1082,7 @@ a menu for that category will be shown. Reference a label from an external document. With the @LaTeX{} package @code{xr} it is possible to reference labels defined in another document. This key will switch to the label menu of an external -document and let you select a label from there (@pxref{xr (LaTeX -package),,xr}). +document and let you select a label from there (@pxref{LaTeX xr Package,,xr}). @end table @@ -1204,8 +1202,8 @@ them (@pxref{Defining Label Environments}). @vindex reftex-label-alist @RefTeX{} can be configured to recognize additional labeled environments and macros. This is done with the variable -@code{reftex-label-alist} (@pxref{Options (Defining Label -Environments)}). If you are not familiar with Lisp, you can use the +@code{reftex-label-alist} (@pxref{Options - Defining Label +Environments}). If you are not familiar with Lisp, you can use the @code{custom} library to configure this rather complex variable. To do this, use @@ -1303,8 +1301,7 @@ a @code{\macro} or after the @code{\begin} statement). @code{t} is @code{nil} means to use the text right after the label definition. @item For more complex ways of getting context, see the variable -@code{reftex-label-alist} (@ref{Options (Defining Label -Environments)}). +@code{reftex-label-alist} (@ref{Options - Defining Label Environments}). @end itemize The following list of strings is used to guess the correct label type @@ -1357,9 +1354,8 @@ Reftex Label Alist: [Hide] Depending on how you would like the label insertion and selection for the new environments to work, you might want to add the letters @samp{a} and @samp{h} to some of the flags in the variables -@code{reftex-insert-label-flags} (@pxref{Options (Creating Labels)}) -and @code{reftex-label-menu-flags} (@pxref{Options (Referencing -Labels)}). +@code{reftex-insert-label-flags} (@pxref{Options - Creating Labels}) +and @code{reftex-label-menu-flags} (@pxref{Options - Referencing Labels}). @node Quick Equation, Figure Wrapper, Theorem and Axiom , Defining Label Environments @@ -1662,7 +1658,7 @@ message. @code{\label} macro. @xref{Viewing Cross-References}, for more information. -@node Reference Styles, xr (LaTeX package), Reference Info, Labels and References +@node Reference Styles, LaTeX xr Package, Reference Info, Labels and References @section Reference Styles In case you defined your own macros for referencing or you are using @@ -1750,7 +1746,7 @@ and @code{reftex-fref-is-default} respectively. While still working, these variables are deprecated now. Instead of setting them, the variable @code{reftex-ref-style-default-list} should be adapted now. -@node xr (LaTeX package), , Reference Styles, Labels and References +@node LaTeX xr Package, , Reference Styles, Labels and References @section @code{xr}: Cross-Document References @cindex @code{xr}, LaTeX package @cindex LaTeX packages, @code{xr} @@ -1884,8 +1880,8 @@ which the selection process was started. @item mouse-2 @vindex reftex-highlight-selection Clicking with mouse button 2 on a citation will accept it like @key{RET} -would. See also variable @code{reftex-highlight-selection}, @ref{Options -(Misc)}. +would. See also variable @code{reftex-highlight-selection}, +@ref{Options - Misc}. @item m Mark the current entry. When one or several entries are marked, @@ -2404,8 +2400,9 @@ Abort the indexing process. The @samp{Find and Index in Document} menu in the phrases buffer also lists a few options for the indexing process. The options have -associated customization variables to set the defaults (@pxref{Options -(Index Support)}). Here is a short explanation of what the options do: +associated customization variables to set the defaults +(@pxref{Options - Index Support}). Here is a short explanation of +what the options do: @table @i @item Match Whole Words @@ -2760,7 +2757,7 @@ variants@footnote{all macros that start with @samp{ref} or end with @samp{ref} or @samp{refrange}} of the @code{\ref} macro are active for cross-reference display. This works also for labels defined in an external document when the current document refers to them through the -@code{xr} interface (@pxref{xr (LaTeX package)}). +@code{xr} interface (@pxref{LaTeX xr Package}). @item @code{\label} @cindex @code{\label} @@ -2906,7 +2903,7 @@ the ones defined in @file{font-lock.el}. Therefore, @RefTeX{} will use faces only when @code{font-lock} is loaded. This seems to be reasonable because people who like faces will very likely have it loaded. If you wish to turn off fontification or change the involved -faces, see @ref{Options (Fontification)}. +faces, see @ref{Options - Fontification}. @node Multifile Documents, Language Support, AUCTeX, Top @section Multifile Documents @@ -3887,20 +3884,20 @@ Lisp (and even if you are) you might find it more comfortable to use reftex-customize} will get you there. @menu -* Options (Table of Contents):: -* Options (Defining Label Environments):: -* Options (Creating Labels):: -* Options (Referencing Labels):: -* Options (Creating Citations):: -* Options (Index Support):: -* Options (Viewing Cross-References):: -* Options (Finding Files):: -* Options (Optimizations):: -* Options (Fontification):: -* Options (Misc):: +* Options - Table of Contents:: +* Options - Defining Label Environments:: +* Options - Creating Labels:: +* Options - Referencing Labels:: +* Options - Creating Citations:: +* Options - Index Support:: +* Options - Viewing Cross-References:: +* Options - Finding Files:: +* Options - Optimizations:: +* Options - Fontification:: +* Options - Misc:: @end menu -@node Options (Table of Contents), Options (Defining Label Environments), , Options +@node Options - Table of Contents, Options - Defining Label Environments, , Options @section Table of Contents @cindex Options, table of contents @cindex Table of contents, options @@ -4024,7 +4021,7 @@ The keymap which is active in the @file{*toc*} buffer. (@pxref{Table of Contents}). @end deffn -@node Options (Defining Label Environments), Options (Creating Labels), Options (Table of Contents), Options +@node Options - Defining Label Environments, Options - Creating Labels, Options - Table of Contents, Options @section Defining Label Environments @cindex Options, defining label environments @cindex Defining label environments, options @@ -4251,7 +4248,7 @@ labels fn:xxx, you may want to set this variable to the value "^fn:$" or non-footnote labels. @end defopt -@node Options (Creating Labels), Options (Referencing Labels), Options (Defining Label Environments), Options +@node Options - Creating Labels, Options - Referencing Labels, Options - Defining Label Environments, Options @section Creating Labels @cindex Options, creating labels @cindex Creating labels, options @@ -4367,7 +4364,7 @@ Character class after abbrev point in word. @end table @end defopt -@node Options (Referencing Labels), Options (Creating Citations), Options (Creating Labels), Options +@node Options - Referencing Labels, Options - Creating Citations, Options - Creating Labels, Options @section Referencing Labels @cindex Options, referencing labels @cindex Referencing labels, options @@ -4489,7 +4486,7 @@ The keymap which is active in the labels selection process (@pxref{Referencing Labels}). @end deffn -@node Options (Creating Citations), Options (Index Support), Options (Referencing Labels), Options +@node Options - Creating Citations, Options - Index Support, Options - Referencing Labels, Options @section Creating Citations @cindex Options, creating citations @cindex Creating citations, options @@ -4668,7 +4665,7 @@ Footer to insert in BibTeX files generated by @end defopt -@node Options (Index Support), Options (Viewing Cross-References), Options (Creating Citations), Options +@node Options - Index Support, Options - Viewing Cross-References, Options - Creating Citations, Options @section Index Support @cindex Options, Index support @cindex Index support, options @@ -4888,7 +4885,7 @@ The keymap which is active in the @file{*Index*} buffer (@pxref{Index Support}). @end deffn -@node Options (Viewing Cross-References), Options (Finding Files), Options (Index Support), Options +@node Options - Viewing Cross-References, Options - Finding Files, Options - Index Support, Options @section Viewing Cross-References @cindex Options, viewing cross-references @cindex Viewing cross-references, options @@ -4947,7 +4944,7 @@ saved along with the parsing information. The cache survives document scans. In order to clear it, use @kbd{M-x reftex-reset-mode}. @end defopt -@node Options (Finding Files), Options (Optimizations), Options (Viewing Cross-References), Options +@node Options - Finding Files, Options - Optimizations, Options - Viewing Cross-References, Options @section Finding Files @cindex Options, Finding Files @cindex Finding files, options @@ -5037,7 +5034,7 @@ non-@code{nil}. @end defopt @page -@node Options (Optimizations), Options (Fontification), Options (Finding Files), Options +@node Options - Optimizations, Options - Fontification, Options - Finding Files, Options @section Optimizations @cindex Options, optimizations @cindex Optimizations, options @@ -5146,7 +5143,7 @@ effect when @code{reftex-use-multiple-selection-buffers} is non-@code{nil}. @end defopt -@node Options (Fontification), Options (Misc), Options (Optimizations), Options +@node Options - Fontification, Options - Misc, Options - Optimizations, Options @section Fontification @cindex Options, fontification @cindex Fontification, options @@ -5244,7 +5241,7 @@ Face name for index names (for multiple indices). Face name for index entries. @end defopt -@node Options (Misc), , Options (Fontification), Options +@node Options - Misc, , Options - Fontification, Options @section Miscellaneous @cindex Options, misc -- 2.11.4.GIT