@comment %**start of header (This is for running Texinfo on a region.)
@setfilename ../../info/sc
@settitle Supercite User's Manual
+@documentencoding UTF-8
@iftex
@finalout
@end iftex
This document describes Supercite, an Emacs package for citing and
attributing replies to mail and news messages.
-Copyright @copyright{} 1993, 2001-2011 Free Software Foundation, Inc.
+Copyright @copyright{} 1993, 2001--2014 Free Software Foundation, Inc.
@quotation
Permission is granted to copy, distribute and/or modify this document
is included in the section entitled ``GNU Free Documentation License''.
(a) The FSF's Back-Cover Text is: ``You have the freedom to copy and
-modify this GNU manual. Buying copies from the FSF supports it in
-developing GNU and promoting software freedom.''
+modify this GNU manual.''
@end quotation
@end copying
@contents
@ifnottex
-@node Top, Introduction, (dir), (dir)
+@node Top
@top Supercite
-@comment node-name, next, previous, up
-@insertcopying
+@insertcopying
The manual is divided
into the following chapters.
@menu
* Introduction::
* Citations::
+* Information Keys and the Info Alist::
+* Reference Headers::
* Getting Connected::
* Replying and Yanking::
* Selecting an Attribution::
* Configuring the Citation Engine::
* Post-yank Formatting Commands::
-* Information Keys and the Info Alist::
-* Reference Headers::
* Hints to MUA Authors::
* Thanks and History::
@end ifnottex
-@node Introduction, Usage Overview, Top, Top
+@node Introduction
@chapter Introduction
-Supercite is a GNU Emacs package written entirely in Emacs Lisp. It
+@cindex MUA
+@cindex NUA
+Supercite is a GNU Emacs package written entirely in Emacs Lisp. It
interfaces to most of the commonly used Emacs mail user agents
(@dfn{MUAs}) and news user agents (@dfn{NUAs}), and provides
sophisticated facilities for the citing and attributing of message
-replies. Supercite has a very specific and limited role in the process
-of composing replies to both USENET network news and electronic mail.
+replies. Supercite has a very specific and limited role in the
+process of composing replies to both USENET network news and
+electronic mail.
The preferred way to spell Supercite is with a capital @samp{S},
lowercase @samp{upercite}.
-@ifinfo
@menu
* Usage Overview::
* What Supercite Does Not Do::
* What Supercite Does::
@end menu
-@end ifinfo
-@cindex MUA
-@cindex NUA
+@c FIXME: move it above the menu? --xfq
Supercite is only useful in conjunction with MUAs and NUAs such as VM,
Gnus, RMAIL, MH-E, etc. Supercite is typically called by the MUA after a
reply buffer has been setup. Thereafter, Supercite's many commands and
sent. Supercite is re-initialized in each new reply buffer.
-@node Usage Overview, What Supercite Does Not Do, Introduction, Introduction
+@node Usage Overview
+@section Usage Overview
@kindex r
@kindex f
@kindex C-c C-y
@cindex yank
@cindex cite, citing
@cindex attribute, attributing
-@section Usage Overview
-Typical usage is as follows. You want to reply or followup to a message
-in your MUA. You will probably hit @kbd{r} (i.e., ``reply'') or @kbd{f}
-(i.e., ``forward'') to begin composing the reply. In response, the MUA
-will create a reply buffer and initialize the outgoing mail headers
-appropriately. The body of the reply will usually be empty at this
-point. You now decide that you would like to include part of the
-original message in your reply. To do this, you @dfn{yank} the original
-message into the reply buffer, typically with a key stroke such as
-@kbd{C-c C-y}. This sequence will invoke an MUA-specific function which
-fills the body of the reply with the original message and then
-@dfn{attributes} this text to its author. This is called @dfn{citing}
-and its effect is to prefix every line from the original message with a
-special text tag. Most MUAs provide some default style of citing; by
-using Supercite you gain a wider flexibility in the look and style of
-citations. Supercite's only job is to cite the original message.
-
-@node What Supercite Does Not Do, What Supercite Does, Usage Overview, Introduction
+Typical usage is as follows. You want to reply or followup to a
+message in your MUA@. You will probably hit @kbd{r} (i.e., ``reply'')
+or @kbd{f} (i.e., ``forward'') to begin composing the reply. In
+response, the MUA will create a reply buffer and initialize the
+outgoing mail headers appropriately. The body of the reply will
+usually be empty at this point. You now decide that you would like to
+include part of the original message in your reply. To do this, you
+@dfn{yank} the original message into the reply buffer, typically with
+a key stroke such as @kbd{C-c C-y}. This sequence will invoke an
+MUA-specific function which fills the body of the reply with the
+original message and then @dfn{attributes} this text to its author.
+This is called @dfn{citing} and its effect is to prefix every line
+from the original message with a special text tag. Most MUAs provide
+some default style of citing; by using Supercite you gain a wider
+flexibility in the look and style of citations. Supercite's only job
+is to cite the original message.
+
+@node What Supercite Does Not Do
@section What Supercite Doesn't Do
Because of this clear division of labor, there are useful features which
be able to yank (and cite) only a portion of the original message.
Since Supercite only modifies the text it finds in the reply buffer as
set up by the MUA, it is the MUA's responsibility to do partial yanking.
-@xref{Reply Buffer Initialization}.@refill
+@xref{Reply Buffer Initialization}.
@vindex mail-header-separator
Another potentially useful thing would be for Supercite to set up the
bodies cannot be modified by Supercite. Supercite, in fact, doesn't
know anything about the meaning of these headers, and never ventures
outside the designated region. @xref{Hints to MUA Authors}, for more
-details.@refill
+details.
-@node What Supercite Does, Citations, What Supercite Does Not Do, Introduction
-@findex sc-cite-original
+@node What Supercite Does
@section What Supercite Does
+@findex sc-cite-original
Supercite is invoked for the first time on a reply buffer via your MUA's
reply or forward command. This command will actually perform citations
by calling a hook variable to which Supercite's top-level function
@code{sc-cite-original} has been added. When @code{sc-cite-original} is
executed, the original message must be set up in a very specific way,
-but this is handled automatically by the MUA. @xref{Hints to MUA
-Authors}.@refill
+but this is handled automatically by the MUA@. @xref{Hints to MUA
+Authors}.
@cindex info alist
The first thing Supercite does, via @code{sc-cite-original}, is to parse
through the original message's mail headers. It saves this data in an
@dfn{information association list}, or @dfn{info alist}. The information
in this list is used in a number of places throughout Supercite.
-@xref{Information Keys and the Info Alist}.@refill
+@xref{Information Keys and the Info Alist}.
@cindex nuking mail headers
@cindex reference header
@cindex modeline
Next, Supercite visits each line in the reply, transforming the line
-according to a customizable ``script.'' Lines which were not previously
+according to a customizable ``script''. Lines which were not previously
cited in the original message are given a citation, while already cited
lines remain untouched, or are coerced to your preferred style.
Finally, Supercite installs a keymap into the reply buffer so that you
(optionally) be filled by Supercite. However, if you manually edit the
cited text and want to re-fill it, you must use an add-on package such
as @cite{filladapt} or @cite{gin-mode}. These packages can recognize
-Supercited text and will fill them appropriately. Emacs' built-in
-filling routines, e.g@. @code{fill-paragraph}, do not recognize cited
+Supercited text and will fill them appropriately. Emacs's built-in
+filling routines, e.g., @code{fill-paragraph}, do not recognize cited
text and will not re-fill them properly because it cannot guess the
@code{fill-prefix} being used.
-@xref{Post-yank Formatting Commands}, for details.@refill
+@xref{Post-yank Formatting Commands}, for details.
As mentioned above, Supercite provides commands to recite or uncite
regions of text in the reply buffer, and commands to perform other
informative citations throughout. Supercite tries to be as configurable
as possible to allow for a wide range of personalized citation styles,
but it is also immediately useful with the default configuration, once
-it has been properly connected to your MUA. @xref{Getting Connected},
-for more details.@refill
+it has been properly connected to your MUA@. @xref{Getting Connected},
+for more details.
-@node Citations, Citation Elements, What Supercite Does, Top
+@node Citations
+@chapter Citations
@cindex nested citations
@cindex citation
-@chapter Citations
-A @dfn{citation} is the acknowledgement of the original author of a mail
+A @dfn{citation} is the acknowledgment of the original author of a mail
message in the body of the reply. There are two basic citation styles
which Supercite supports. The first, called @dfn{nested citations} is
an anonymous form of citation; in other words, an indication is made
And that's what I think too.
@end example
-@ifinfo
@menu
* Citation Elements::
* Recognizing Citations::
@end menu
-@end ifinfo
Note that multiple inclusions of the original messages result in a
nesting of the @samp{@code{>}} characters. This can sometimes be quite
@cindex non-nested citations
In @dfn{non-nested citations}, each cited line begins with an
-informative string attributing that line to the original author. Only
-the first level of attribution will be shown; subsequent citations don't
-nest the citation strings. The above dialog might look like this when
-non-nested citations are used:
+informative string attributing that line to the original author. Only
+the first level of attribution will be shown; subsequent citations
+don't nest the citation strings. The above dialog might look like
+this when non-nested citations are used:
@example
John> John originally wrote this
@vindex sc-nested-citation-p
@vindex nested-citation-p (sc-)
Supercite supports both styles of citation, and the variable
-@code{sc-nested-citation-p} controls which style it will use when citing
-previously uncited text. When this variable is @code{nil} (the default),
-non-nested citations are used. When non-@code{nil}, nested citations
-are used.
+@code{sc-nested-citation-p} controls which style it will use when
+citing previously uncited text. When this variable is @code{nil} (the
+default), non-nested citations are used. When non-@code{nil}, nested
+citations are used.
-@node Citation Elements, Recognizing Citations, Citations, Citations
-@cindex citation string
+@node Citation Elements
@section Citation Elements
+@cindex citation string
-@dfn{Citation strings} are composed of one or more elements. Non-nested
-citations are composed of four elements, three of which are directly
-user definable. The elements are concatenated together, in this order:
+@dfn{Citation strings} are composed of one or more elements.
+Non-nested citations are composed of four elements, three of which are
+directly user definable. The elements are concatenated together, in
+this order:
@cindex citation leader
@vindex citation-leader (sc-)
The @dfn{attribution string}. This element is supplied automatically by
Supercite, based on your preferences and the original message's mail
headers, though you may be asked to confirm Supercite's choice.
-@xref{Selecting an Attribution}, for more details.@refill
+@xref{Selecting an Attribution}, for more details.
@cindex citation delimiter
@vindex sc-citation-delimiter
something like
@code{@asis{" Jane> "}}.
This citation string will be inserted in front of
-every line in the original message that is not already cited.@refill
+every line in the original message that is not already cited.
Nested citations, being simpler than non-nested citations, are composed
of the same elements, sans the attribution string. Supercite is smart
enough to not put additional spaces between citation delimiters for
multi-level nested citations.
-@node Recognizing Citations, Getting Connected, Citation Elements, Citations
+@node Recognizing Citations
@section Recognizing Citations
Supercite also recognizes citations in the original article, and can
-transform these already cited lines in a number of ways. This is how
+transform these already cited lines in a number of ways. This is how
Supercite suppresses the multiple citing of non-nested citations.
-Recognition of cited lines is controlled by variables analogous to those
-that make up the citation string as mentioned previously.
+Recognition of cited lines is controlled by variables analogous to
+those that make up the citation string as mentioned previously.
@vindex sc-citation-leader-regexp
@vindex citation-leader-regexp (sc-)
@code{sc-citation-nonnested-root-regexp} is used to describe only
non-nested citation roots. It is important to remember that if you
change @code{sc-citation-root-regexp} you should always also change
-@code{sc-citation-nonnested-root-regexp}.@refill
+@code{sc-citation-nonnested-root-regexp}.
-@node Information Keys and the Info Alist, Reference Headers, Miscellaneous Commands, Top
+@node Information Keys and the Info Alist
+@chapter Information Keys and the Info Alist
@cindex information keys
@cindex Info Alist
@cindex information extracted from mail fields
@findex sc-mail-field
@findex mail-field (sc-)
-@chapter Information Keys and the Info Alist
@dfn{Mail header information keys} are nuggets of information that
Supercite extracts from the various mail headers of the original
-message, placed in the reply buffer by the MUA. Information is kept in
-the @dfn{Info Alist} as key-value pairs, and can be retrieved for use in
-various places within Supercite, such as in header rewrite functions and
-attribution selection. Other bits of data, composed and created by
-Supercite, are also kept as key-value pairs in this alist. In the case
-of mail fields, the key is the name of the field, omitting the trailing
-colon. Info keys are always case insensitive (as are mail headers), and
-the value for a corresponding key can be retrieved from the alist with
-the @code{sc-mail-field} function. Thus, if the following fields were
-present in the original article:@refill
+message, placed in the reply buffer by the MUA@. Information is kept
+in the @dfn{Info Alist} as key-value pairs, and can be retrieved for
+use in various places within Supercite, such as in header rewrite
+functions and attribution selection. Other bits of data, composed and
+created by Supercite, are also kept as key-value pairs in this alist.
+In the case of mail fields, the key is the name of the field, omitting
+the trailing colon. Info keys are always case insensitive (as are
+mail headers), and the value for a corresponding key can be retrieved
+from the alist with the @code{sc-mail-field} function. Thus, if the
+following fields were present in the original article:
@example
Date:@: 08 April 1991, 17:32:09 EST
Since the argument to @code{sc-mail-field} can be any string, it is
possible that the mail field will not be present on the info alist
(possibly because the mail header was not present in the original
-message). In this case, @code{sc-mail-field} will return the value of
+message). In this case, @code{sc-mail-field} will return the value of
the variable @code{sc-mumble}.
Supercite always places all mail fields found in the yanked original
If the author's name has more than one middle name, they will appear as
info keys with the appropriate index (e.g., @code{"sc-middlename-2"},
-@dots{}). @xref{Selecting an Attribution}.@refill
+@dots{}). @xref{Selecting an Attribution}.
-@node Reference Headers, The Built-in Header Rewrite Functions, Information Keys and the Info Alist, Top
-@cindex reference headers
+@node Reference Headers
@chapter Reference Headers
+@cindex reference headers
Supercite will insert an informative @dfn{reference header} at the
beginning of the cited body of text, which display more detail about the
information contained in the info alist can be inserted into a reference
header.
-@ifinfo
@menu
* The Built-in Header Rewrite Functions::
* Electric References::
@end menu
-@end ifinfo
@cindex header rewrite functions
@vindex sc-rewrite-header-list
@vindex rewrite-header-list (sc-)
There are a number of built-in @dfn{header rewrite functions} supplied
-by Supercite, but you can write your own custom header rewrite functions
-(perhaps using the built-in ones as examples). The variable
+by Supercite, but you can write your own custom header rewrite
+functions (perhaps using the built-in ones as examples). The variable
@code{sc-rewrite-header-list} contains the list of such header rewrite
functions. This list is consulted both when inserting the initial
reference header, and when displaying @dfn{electric references}.
@vindex preferred-header-style (sc-)
When Supercite is initially run on a reply buffer (via
@code{sc-cite-original}), it will automatically call one of these
-functions. The one it uses is defined in the variable
+functions. The one it uses is defined in the variable
@code{sc-preferred-header-style}. The value of this variable is an
integer which is an index into the @code{sc-rewrite-header-list},
beginning at zero.
-@node The Built-in Header Rewrite Functions, Electric References, Reference Headers, Reference Headers
-@cindex header rewrite functions, built-in
+@node The Built-in Header Rewrite Functions
@section The Built-in Header Rewrite Functions
+@cindex header rewrite functions, built-in
Below are examples of the various built-in header rewrite functions.
-Please note the following:@: first, the text which appears in the
+Please note the following: first, the text which appears in the
examples below as @var{infokey} indicates that the corresponding value
of the info key from the info alist will be inserted there.
(@pxref{Information Keys and the Info Alist}). For example, in @code{sc-header-on-said}
below, @var{date} and @var{from} correspond to the values of the
-@samp{Date:@:} and @samp{From:@:} mail headers respectively.@refill
+@samp{Date:@:} and @samp{From:@:} mail headers respectively.
@vindex sc-reference-tag-string
@vindex reference-tag-string (sc-)
@findex sc-no-header
@findex no-header (sc-)
@item sc-no-header
-This function produces no header. It should be used instead of
-@code{nil} to produce a blank header. This header can possibly contain
-a blank line after the @code{mail-header-separator} line.
+This function produces no header. It should be used instead of
+@code{nil} to produce a blank header. This header can possibly
+contain a blank line after the @code{mail-header-separator} line.
@item sc-no-blank-line-or-header
@findex sc-no-blank-line-or-header
@code{>>>>> see @var{references} for more details}
@end table
-@node Electric References, Hints to MUA Authors, The Built-in Header Rewrite Functions, Reference Headers
-@cindex electric references
+@node Electric References
@section Electric References
+@cindex electric references
By default, when Supercite cites the original message for the first
time, it just goes ahead and inserts the reference header indexed by
@code{sc-preferred-header-style}. However, you may want to select
-different reference headers based on the type of reply or forwarding you
-are doing. You may also want to preview the reference header before
-deciding whether to insert it into the reply buffer or not. Supercite
-provides an optional @dfn{electric reference} mode which you can drop
-into to give you this functionality.
+different reference headers based on the type of reply or forwarding
+you are doing. You may also want to preview the reference header
+before deciding whether to insert it into the reply buffer or
+not. Supercite provides an optional @dfn{electric reference} mode
+which you can drop into to give you this functionality.
@vindex sc-electric-references-p
@vindex electric-references-p (sc-)
@code{sc-rewrite-header-list}.
You can also set a new preferred header style, jump to any header, or
-jump to the preferred header. The header will be shown in the electric
+jump to the preferred header. The header will be shown in the electric
reference buffer and the header index and function name will appear in
the echo area.
@kindex n
@vindex sc-electric-circular-p
@vindex electric-circular-p (sc-)
-Displays the next reference header in the electric reference buffer. If
+Displays the next reference header in the electric reference buffer. If
the variable @code{sc-electric-circular-p} is non-@code{nil}, invoking
@code{sc-eref-next} while viewing the last reference header in the list
-will wrap around to the first header.@refill
+will wrap around to the first header.
@item @code{sc-eref-prev} (@kbd{p})
@findex sc-eref-prev
@kindex p
Displays the previous reference header in the electric reference buffer.
If the variable @code{sc-electric-circular-p} is non-@code{nil},
-invoking @code{sc-eref-prev} will wrap around to the last header.@refill
+invoking @code{sc-eref-prev} will wrap around to the last header.
@item @code{sc-eref-goto} (@kbd{g})
@findex sc-eref-goto
Goes to a specified reference header. The index (into the
@code{sc-rewrite-header-list}) can be specified as a numeric argument to
the command. Otherwise, Supercite will query you for the index in the
-minibuffer.@refill
+minibuffer.
@item @code{sc-eref-jump} (@kbd{j})
@findex sc-eref-jump
@findex eref-setn (sc-)
@kindex s
Set the preferred reference header (i.e.,
-@code{sc-preferred-header-style}) to the currently displayed header.@refill
+@code{sc-preferred-header-style}) to the currently displayed header.
@item @code{sc-eref-exit} (@kbd{C-j}, @key{RET}, and @key{ESC C-c})
@kindex RET
@findex sc-eref-exit
@findex eref-exit (sc-)
Exit from electric reference mode and insert the current header into the
-reply buffer.@refill
+reply buffer.
@item @code{sc-eref-abort} (@kbd{q}, @kbd{x})
@findex sc-eref-abort
Supercite will execute the hook @code{sc-electric-mode-hook} before
entering electric reference mode.
-@node Getting Connected, Replying and Yanking, Recognizing Citations, Top
-@cindex citation interface specification
+@node Getting Connected
@chapter Getting Connected
-
+@cindex citation interface specification
@vindex mail-citation-hook
@cindex .emacs file
``use your default citation function.'' When you add Supercite's
citation function to the hook, thereby giving the variable a
non-@code{nil} value, it tells the MUA to run the hook via
-@code{run-hooks} instead of using the default citation.@refill
+@code{run-hooks} instead of using the default citation.
Early in Supercite's development, the Supercite author, a few MUA
authors, and some early Supercite users got together and agreed upon a
region. Note that Supercite @emph{never} touches any text outside this
region. Note further that the region need not be active
for @code{sc-cite-original} to do its job.
-@xref{Hints to MUA Authors}.@refill
+@xref{Hints to MUA Authors}.
The other step in the getting connected process is to make sure your
MUA calls @code{sc-cite-original} at the right time. As mentioned
One final note. After Supercite is loaded into your Emacs session, it
runs the hook @code{sc-load-hook}. You can put any customizations into
this hook since it is only run once. This will not work, however, if
-your Emacs maintainer has put Supercite into your dumped Emacs' image.
+your Emacs maintainer has put Supercite into your dumped Emacs image.
In that case, you can use the @code{sc-pre-hook} variable, but this will
get executed every time @code{sc-cite-original} is called. @xref{Reply
-Buffer Initialization}.@refill
+Buffer Initialization}.
-@node Replying and Yanking, Reply Buffer Initialization, Getting Connected, Top
+@node Replying and Yanking
@chapter Replying and Yanking
-@ifinfo
This chapter explains what happens when you reply and yank an original
message from an MUA.
* Reply Buffer Initialization::
* Filling Cited Text::
@end menu
-@end ifinfo
-@node Reply Buffer Initialization, Filling Cited Text, Replying and Yanking, Replying and Yanking
+
+@node Reply Buffer Initialization
+@section Reply Buffer Initialization
@findex sc-cite-original
@findex cite-original (sc-)
-@section Reply Buffer Initialization
Executing @code{sc-cite-original} performs the following steps as it
initializes the reply buffer:
work. You could conceivably use this hook to set certain Supercite
variables based on the reply buffer's mode or name (i.e., to do
something different based on whether you are replying or following up to
-an article).@refill
+an article).
@item
@emph{Inserts Supercite's keymap.}
@vindex mail-warn-if-non-rfc822-p (sc-)
All previously retrieved info key-value pairs are deleted from the info
alist, then the mail headers in the body of the yanked message are
-scanned. Info key-value pairs are created for each header found. Also,
+scanned. Info key-value pairs are created for each header found. Also,
such useful information as the author's name and email address are
extracted. If the variable @code{sc-mail-warn-if-non-rfc822-p} is
non-@code{nil}, then Supercite will warn you if it finds a mail header
non-@code{nil}, blank lines will be cited just like non-blank lines.
Otherwise, blank lines will be treated as paragraph separators.
-Citing of the original message is highly configurable. Supercite's
+Citing of the original message is highly configurable. Supercite's
default setup does a pretty good job of citing many common forms of
previously cited messages. But there are as many citation styles out
there as people on the net, or just about! It would be impossible for
Supercite to anticipate every style in existence, and you probably
wouldn't encounter them all anyway. But you can configure Supercite to
recognize those styles you see often.
-@xref{Configuring the Citation Engine}, for details.@refill
+@xref{Configuring the Citation Engine}, for details.
@item
@emph{Runs @code{sc-post-hook}.}
@vindex sc-post-hook
@vindex post-hook (sc-)
This variable is very similar to @code{sc-pre-hook}, except that it runs
-after @code{sc-cite-original} is finished. This hook is provided mostly
-for completeness and backward compatibility. Perhaps it could be used to
-reset certain variables set in @code{sc-pre-hook}.@refill
+after @code{sc-cite-original} is finished. This hook is provided mostly
+for completeness and backward compatibility. Perhaps it could be used to
+reset certain variables set in @code{sc-pre-hook}.
@end enumerate
-@node Filling Cited Text, Selecting an Attribution, Reply Buffer Initialization, Replying and Yanking
+@node Filling Cited Text
+@section Filling Cited Text
@cindex filling paragraphs
@vindex sc-auto-fill-region-p
@vindex auto-fill-region-p (sc-)
@findex setup-filladapt (sc-)
@vindex sc-load-hook
@vindex load-hook (sc-)
-@section Filling Cited Text
Supercite will automatically fill newly cited text from the original
message unless the variable @code{sc-auto-fill-region-p} has a
Also, Supercite will collapse leading whitespace between the citation
string and the text on a line when the variable
@code{sc-fixup-whitespace-p} is non-@code{nil}. The default value for
-this variable is @code{nil}.@refill
+this variable is @code{nil}.
@vindex fill-prefix
Its important to understand that Supercite's automatic filling (during
I usually run with both these variables containing their default values.
When Supercite's automatic filling breaks on a particular message, I
-will use Emacs' undo feature to undo back before the citation was
+will use Emacs's undo feature to undo back before the citation was
applied to the original message. Then I'll toggle the variables and
manually cite those paragraphs that I don't want to fill or collapse
-whitespace on. @xref{Variable Toggling Shortcuts}.@refill
+whitespace on. @xref{Variable Toggling Shortcuts}.
@kindex C-c C-p C-p
If you find that Supercite's automatic filling is just too fragile for
Also, to make life easier, a shortcut function to toggle the state of
both of these variables is provided on the key binding
@kbd{C-c C-p C-p} (with the default value of @code{sc-mode-map-prefix};
-@pxref{Post-yank Formatting Commands}).@refill
+@pxref{Post-yank Formatting Commands}).
You will noticed that the minor mode string will
-show the state of these variables as qualifier characters. When both
+show the state of these variables as qualifier characters. When both
variables are @code{nil}, the Supercite minor mode string will display
@samp{SC}. When just @code{sc-auto-fill-region-p} is non-@code{nil}, the
string will display @samp{SC:f}, and when just
display @samp{SC:fw}. Note that the qualifiers chosen are mnemonics for
the default bindings of the toggling function for each respective
variable.
-@xref{Variable Toggling Shortcuts}.@refill
+@xref{Variable Toggling Shortcuts}.
Why are these variables not set to @code{nil} by default? It is because
many users won't manually fill paragraphs that are Supercited, and there
containing lines greater than about 72 characters. So the default is to
fill cited text.
-@node Selecting an Attribution, Attribution Preferences, Filling Cited Text, Top
+@node Selecting an Attribution
+@chapter Selecting an Attribution
@cindex attribution list
@vindex sc-preferred-attribution-list
@vindex preferred-attribution-list (sc-)
-@chapter Selecting an Attribution
As you know, the attribution string is the part of the author's name
-that will be used to composed a non-nested citation string. Supercite
+that will be used to composed a non-nested citation string. Supercite
scans the various mail headers present in the original article and uses
a number of heuristics to extract strings which it puts into the
-@dfn{attribution association list} or @dfn{attribution alist}. This is
-analogous, but different than, the info alist previously mentioned. Each
+@dfn{attribution association list} or @dfn{attribution alist}. This is
+analogous, but different than, the info alist previously mentioned. Each
element in the attribution alist is a key-value pair containing such
information as the author's first name, middle names, and last name, the
author's initials, and the author's email terminus.
-@ifinfo
@menu
* Attribution Preferences::
* Anonymous Attributions::
* Author Names::
@end menu
-@end ifinfo
-@node Attribution Preferences, Anonymous Attributions, Selecting an Attribution, Selecting an Attribution
+@node Attribution Preferences
@section Attribution Preferences
When you cite an original message, you can tell Supercite which part of
the author's first middle name.
@item "sc-lastchoice"
-the last attribution string you have selected. This is useful when you
-recite paragraphs in the reply.@refill
+the last attribution string you have selected. This is useful when you
+recite paragraphs in the reply.
@item "sc-consult"
@vindex sc-attrib-selection-list
key. See below for details.
@item "x-attribution"
-the original author's suggestion for attribution string choice. See below
-for details.@refill
+the original author's suggestion for attribution string choice. See below
+for details.
@end table
Middle name indexes can be any positive integer greater than zero,
@example
@group
-(@var{infokey} ((@var{regexp} @. @var{attribution})
- (@var{regexp} @. @var{attribution})
+(@var{infokey} ((@var{regexp} . @var{attribution})
+ (@var{regexp} . @var{attribution})
(@dots{})))
@end group
@end example
@findex sc-mail-field
@findex mail-field (sc-)
where @var{infokey} is a key for @code{sc-mail-field} and @var{regexp}
-is a regular expression to match against the @var{infokey}'s value. If
+is a regular expression to match against the @var{infokey}'s value. If
@var{regexp} matches the @var{infokey}'s value, the @var{attribution} is
used as the attribution string. Actually, @var{attribution} can be a
string or a list; if it is a list, it is @code{eval}uated and the return
match against a specific mail field, e.g., @samp{From:@:}, allowing you
to cite your friend's message with the appropriate attribution.
-@node Anonymous Attributions, Author Names, Attribution Preferences, Selecting an Attribution
+@node Anonymous Attributions
+@section Anonymous Attributions
@vindex sc-default-author-name
@vindex default-author-name (sc-)
@vindex sc-default-attribution
@vindex default-attribution (sc-)
-@section Anonymous Attributions
When the author's name cannot be found in the @samp{From:@:} mail
header, a fallback author name and attribution string must be supplied.
@code{sc-default-author-name} and the fallback attribution string is
contained in the variable @code{sc-default-attribution}. Default values
for these variables are @code{"Anonymous"} and @code{"Anon"},
-respectively. Note that in most circumstances, getting the default
+respectively. Note that in most circumstances, getting the default
author name or attribution is a sign that something is set up
incorrectly.
@vindex use-only-preference-p (sc-)
Also, if the preferred attribution, which you specified in your
@code{sc-preferred-attribution-list} variable cannot be found, a
-secondary method can be employed to find a valid attribution string. The
+secondary method can be employed to find a valid attribution string. The
variable @code{sc-use-only-preference-p} controls what happens in this
case. If the variable's value is non-@code{nil}, then
@code{sc-default-author-name} and @code{sc-default-attribution} are
used, otherwise, the following steps are taken to find a valid
attribution string, and the first step to return a non-@code{nil},
-non-empty string becomes the attribution:@refill
+non-empty string becomes the attribution:
@enumerate
@item
@vindex sc-confirm-always-p
@vindex confirm-always-p (sc-)
Once the attribution string has been automatically selected, a number of
-things can happen. If the variable @code{sc-confirm-always-p} is
+things can happen. If the variable @code{sc-confirm-always-p} is
non-@code{nil}, you are queried for confirmation of the chosen
-attribution string. The possible values for completion are those strings
+attribution string. The possible values for completion are those strings
in the attribution alist, however you are not limited to these choices.
-You can type any arbitrary string at the confirmation prompt. The string
+You can type any arbitrary string at the confirmation prompt. The string
you enter becomes the value associated with the @code{"sc-lastchoice"}
key in the attribution alist.
variables in your hook functions, you change the attribution and
citation strings used by Supercite. One possible use of this would be
to override any automatically derived attribution string when it is only
-one character long; e.g. you prefer to use @code{"initials"} but the
-author only has one name.@refill
+one character long; e.g., you prefer to use @code{"initials"} but the
+author only has one name.
-@node Author Names, Configuring the Citation Engine, Anonymous Attributions, Selecting an Attribution
-@cindex author names
+@node Author Names
@section Author Names
+@cindex author names
Supercite employs a number of heuristics to decipher the author's name
based on value of the @samp{From:@:} mail field of the original message.
Also, some companies prepend or append the name of the division,
organization, or project on the author's name. All of these titles are
noise which should be ignored. The variable @code{sc-name-filter-alist}
-is used for this purpose. As implied by its name, this variable is an
+is used for this purpose. As implied by its name, this variable is an
association list, where each element is a cons cell of the form:
@example
-(@var{regexp} @. @var{position})
+(@var{regexp} . @var{position})
@end example
@noindent
where @var{regexp} is a regular expression that is matched (using
@code{string-match}) against each element of the @samp{From:@:} field's
author name. @var{position} is a position indicator, starting at zero.
-Thus to strip out all titles of ``Dr.'', ``Mr.'', etc. from the name,
+Thus to strip out all titles of ``Dr.'', ``Mr.'', etc. from the name,
@code{sc-name-filter-alist} would have an entry such as:
@example
-("^\\(Mr\\|Mrs\\|Ms\\|Dr\\)[.]?$" @. 0)
+("^\\(Mr\\|Mrs\\|Ms\\|Dr\\)[.]?$" . 0)
@end example
@noindent
word in the name field, while @code{any} matches against every word in
the name field.
-@node Configuring the Citation Engine, Using Regi, Author Names, Top
+@node Configuring the Citation Engine
+@chapter Configuring the Citation Engine
@cindex Regi
@cindex frames (Regi)
@cindex entries (Regi)
-@chapter Configuring the Citation Engine
At the heart of Supercite is a regular expression interpreting engine
called @dfn{Regi}. Regi operates by interpreting a data structure
throughout Supercite, from mail header information extraction, to header
nuking, to citing text.
-@ifinfo
@menu
* Using Regi::
* Frames You Can Customize::
@end menu
-@end ifinfo
While the details of Regi are discussed below (@pxref{Using Regi}), only
those who wish to customize certain aspects of Supercite need concern
cite or fill those differently than normal text. None of this is
currently part of Supercite, but contributions are welcome!
-@node Using Regi, Frames You Can Customize, Configuring the Citation Engine, Configuring the Citation Engine
+@node Using Regi
+@section Using Regi
@findex regi-interpret
@findex eval
@findex looking-at
-@section Using Regi
Regi works by interpreting frames with the function
@code{regi-interpret}. A frame is a list of arbitrary size where each
@code{looking-at}. This match folds case if the optional
@var{case-fold-search} is non-@code{nil}. If @var{pred} is not a
string, or does not @code{eval}uate to a string, it is interpreted as a
-binary value (@code{nil} or non-@code{nil}).@refill
+binary value (@code{nil} or non-@code{nil}).
The four special symbol values for @var{pred} are recognized:
@item t
Always produces a true outcome.
@item begin
-Always executed before the frame is interpreted. This can be used to
+Always executed before the frame is interpreted. This can be used to
initialize some global variables for example.
@item end
-Always executed after frame interpreting is completed. This can be used
+Always executed after frame interpreting is completed. This can be used
to perform any necessary post-processing.
@item every
Executes whenever the frame is reset, usually after the entire frame has
should be careful to do explicitly), Regi will reset the frame to the
first entry, and advance @samp{point} to the beginning of the next line.
If a list is returned from your function, it can contain any combination
-of the following elements:@refill
+of the following elements:
@table @asis
@item the symbol @code{continue}
This tells Regi to continue processing entries after a match, instead of
-resetting the frame and moving @samp{point}. In this way, lines of text
+resetting the frame and moving @samp{point}. In this way, lines of text
can have multiple matches, but you have to be careful to avoid entering
infinite loops.
@item the symbol @code{abort}
-This tells Regi to terminate frame processing. However, any @code{end}
+This tells Regi to terminate frame processing. However, any @code{end}
entry is still processed.
@item the list @code{(frame . @var{newframe})}
This tells Regi to substitute @var{newframe} as the frame it is
interpreting. In other words, your @var{func} can modify the Regi frame
on the fly. @var{newframe} can be a variable containing a frame, or it
-can be the frame in-lined.@refill
+can be the frame in-lined.
@item the list @code{(step . @var{step})}
Tells Regi to move @var{step} number of lines forward as it continues
-processing. By default, Regi moves forward one line. @var{step} can be
-zero or negative of course, but watch out for infinite loops.@refill
+processing. By default, Regi moves forward one line. @var{step} can be
+zero or negative of course, but watch out for infinite loops.
@end table
During execution of your @var{func}, the following variables will be
-temporarily bound to some useful information:@refill
+temporarily bound to some useful information:
@table @code
@item curline
The current frame entry being interpreted.
@end table
-@node Frames You Can Customize, Post-yank Formatting Commands, Using Regi, Configuring the Citation Engine
-@vindex sc-nuke-mail-header
+@node Frames You Can Customize
@section Frames You Can Customize
+@vindex sc-nuke-mail-header
As mentioned earlier, Supercite uses various frames to perform
certain jobs such as mail header information extraction and mail header
In a similar vein, there are default frames for @dfn{unciting} and
@dfn{reciting}, contained in the variables
@code{sc-default-uncite-frame} and @code{sc-default-recite-frame}
-respectively.@refill
+respectively.
As mentioned earlier (@pxref{Recognizing Citations}), citations are
recognized through the values of the regular expressions
@vindex sc-cite-frame-alist
@vindex sc-uncite-frame-alist
@vindex sc-recite-frame-alist
-For each of the actions -- citing, unciting, and reciting -- an alist is
+For each of the actions---citing, unciting, and reciting---an alist is
consulted to find the frame to use (@code{sc-cite-frame-alist},
@code{sc-uncite-frame-alist}, and @code{sc-recite-frame-alist}
respectively). These frames can contain alists of the form:
@example
-((@var{infokey} (@var{regexp} @. @var{frame}) (@var{regexp} @. @var{frame}) @dots{})
- (@var{infokey} (@var{regexp} @. @var{frame}) (@var{regexp} @. @var{frame}) @dots{})
+((@var{infokey} (@var{regexp} . @var{frame}) (@var{regexp} . @var{frame}) @dots{})
+ (@var{infokey} (@var{regexp} . @var{frame}) (@var{regexp} . @var{frame}) @dots{})
(@dots{}))
@end example
@var{regexp} is a regular expression which is @code{string-match}'d
against the value of the @code{sc-mail-field} key, and @var{frame} is
the frame to use if a match occurred. @var{frame} can be a variable
-containing a frame or a frame in-lined.@refill
+containing a frame or a frame in-lined.
When Supercite is about to cite, uncite, or recite a region, it consults
the appropriate alist and attempts to find a frame to use. If one
is not found from the alist, then the appropriate default frame is used.
-@node Post-yank Formatting Commands, Citing Commands, Frames You Can Customize, Top
+@node Post-yank Formatting Commands
+@chapter Post-yank Formatting Commands
@vindex sc-mode-map-prefix
@vindex mode-map-prefix (sc-)
@kindex C-c C-p
-@chapter Post-yank Formatting Commands
Once the original message has been yanked into the reply buffer, and
@code{sc-cite-original} has had a chance to do its thing, a number of
-useful Supercite commands will be available to you. Since there is wide
+useful Supercite commands will be available to you. Since there is wide
variety in the keymaps that MUAs set up in their reply buffers, it is
next to impossible for Supercite to properly sprinkle its commands into
the existing keymap. For this reason Supercite places its commands on a
separate keymap, putting this keymap onto a prefix key in the reply
-buffer. You can customize the prefix key Supercite uses by changing the
+buffer. You can customize the prefix key Supercite uses by changing the
variable @code{sc-mode-map-prefix}. By default, the
@code{sc-mode-map-prefix} is @kbd{C-c C-p}; granted, not a great choice,
but unfortunately the best general solution so far. In the rest of this
chapter, we'll assume you've installed Supercite's keymap on the default
-prefix.@refill
+prefix.
-@ifinfo
@menu
* Citing Commands::
* Insertion Commands::
* Mail Field Commands::
* Miscellaneous Commands::
@end menu
-@end ifinfo
-@node Citing Commands, Insertion Commands, Post-yank Formatting Commands, Post-yank Formatting Commands
-@vindex sc-cite-region-limit
+@node Citing Commands
@section Commands to Manually Cite, Recite, and Uncite
+@vindex sc-cite-region-limit
Probably the three most common post-yank formatting operations that you
will perform will be the manual citing, reciting, and unciting of
-regions of text in the reply buffer. Often you may want to recite a
+regions of text in the reply buffer. Often you may want to recite a
paragraph to use a nickname, or manually cite a message when setting
@code{sc-cite-region-limit} to @code{nil}. The following commands
perform these functions on the region of text between @samp{point} and
@samp{mark}. Each of them sets the @dfn{undo boundary} before modifying
the region so that the command can be undone in the standard Emacs
-way.@refill
+way.
Here is the list of Supercite citing commands:
universal argument (@kbd{C-u}), it temporarily sets
@code{sc-confirm-always-p} to @code{t} so you can confirm the
attribution string for a single manual citing.
-@xref{Configuring the Citation Engine}.@refill
+@xref{Configuring the Citation Engine}.
@findex sc-uncite-region
@findex uncite-region (sc-)
@code{sc-uncite-frame-alist}, or the default unciting frame
@code{sc-default-uncite-frame}. It runs the hook
@code{sc-pre-uncite-hook} before interpreting the frame.
-@xref{Configuring the Citation Engine}.@refill
+@xref{Configuring the Citation Engine}.
@findex sc-recite-region
@findex recite-region (sc-)
@item @code{sc-recite-region} (@kbd{C-c C-p r})
This command recites each line the region by interpreting the selected
frame from @code{sc-recite-frame-alist}, or the default reciting frame
-@code{sc-default-recite-frame}. It runs the hook
+@code{sc-default-recite-frame}. It runs the hook
@code{sc-pre-recite-hook} before interpreting the frame.
-@xref{Configuring the Citation Engine}.@refill
+@xref{Configuring the Citation Engine}.
@vindex sc-confirm-always-p
@vindex confirm-always-p (sc-)
region, regardless of the value of @code{sc-confirm-always-p}.
@end table
-@node Insertion Commands, Variable Toggling Shortcuts, Citing Commands, Post-yank Formatting Commands
+@node Insertion Commands
@section Insertion Commands
These two functions insert various strings into the reply buffer.
@vindex preferred-header-style (sc-)
Inserts a reference header into the reply buffer at @samp{point}. With
no arguments, the header indexed by @code{sc-preferred-header-style} is
-inserted. An optional numeric argument is the index into
+inserted. An optional numeric argument is the index into
@code{sc-rewrite-header-list} indicating which reference header to
-write.@refill
+write.
With just the universal argument (@kbd{C-u}), electric reference mode is
entered, regardless of the value of @code{sc-electric-references-p}.
an error and will not cite the line.
@end table
-@node Variable Toggling Shortcuts, Mail Field Commands, Insertion Commands, Post-yank Formatting Commands
-@cindex toggling variables
+@node Variable Toggling Shortcuts
@section Variable Toggling Shortcuts
+@cindex toggling variables
Supercite defines a number of commands that make it easier for you to
toggle and set various Supercite variables as you are editing the reply
Like Supercite commands in general, the toggling commands are placed on
a keymap prefix within the greater Supercite keymap. For the default
value of @code{sc-mode-map-prefix}, this will be
-@kbd{C-c C-p C-t}.@refill
+@kbd{C-c C-p C-t}.
The following commands toggle the value of certain Supercite variables
which take only a binary value:
@findex set-variable
The following commands let you set the value of multi-value variables,
-in the same way that Emacs' @code{set-variable} does:
+in the same way that Emacs's @code{set-variable} does:
@table @kbd
@item C-c C-p C-t a
@code{sc-auto-fill-region-p} and @code{sc-fixup-whitespace-p} together.
This is because you typically want to run Supercite with either variable
as @code{nil} or non-@code{nil}. The command to toggle these variables
-together is bound on @kbd{C-c C-p C-p}.@refill
+together is bound on @kbd{C-c C-p C-p}.
Finally, the command @kbd{C-c C-p C-t h} (also @kbd{C-c C-p C-t ?})
brings up a Help message on the toggling keymap.
-@node Mail Field Commands, Miscellaneous Commands, Variable Toggling Shortcuts, Post-yank Formatting Commands
+@node Mail Field Commands
@section Mail Field Commands
These commands allow you to view, modify, add, and delete various bits
of information from the info alist.
-@xref{Information Keys and the Info Alist}.@refill
+@xref{Information Keys and the Info Alist}.
@table @asis
@kindex C-c C-p f
key-value pairs. With no argument, you are prompted (with completion)
for a info key. The value associated with that key is displayed in the
minibuffer. With an argument, this command will first ask if you want
-to view, modify, add, or delete an info key. Viewing is identical to
+to view, modify, add, or delete an info key. Viewing is identical to
running the command with no arguments.
If you want to modify the value of a key, Supercite will first prompt
Supercite will initially set up its information for the digest
originator, but you want to cite each component article with the real
message author. Note that unless an error during processing occurs, any
-old information is lost.@refill
+old information is lost.
@end table
-@node Miscellaneous Commands, Information Keys and the Info Alist, Mail Field Commands, Post-yank Formatting Commands
+@node Miscellaneous Commands
@section Miscellaneous Commands
@table @asis
@findex open-line
@kindex C-c C-p o
@item @code{sc-open-line} (@kbd{C-c C-p o})
-Similar to Emacs' standard @code{open-line} commands, but inserts the
+Similar to Emacs's standard @code{open-line} commands, but inserts the
citation string in front of the new line. As with @code{open-line},
-an optional numeric argument inserts that many new lines.@refill
+an optional numeric argument inserts that many new lines.
@end table
-@node Hints to MUA Authors, Thanks and History, Electric References, Top
+@node Hints to MUA Authors
@chapter Hints to MUA Authors
In June of 1989, some discussion was held between the various MUA
-authors, the Supercite author, and other Supercite users. These
+authors, the Supercite author, and other Supercite users. These
discussions centered around the need for a standard interface between
MUAs and Supercite (or any future Supercite-like packages). This
interface was formally proposed by Martin Neitzel on Fri, 23 Jun 89, in
@code{mail-yank-hooks}, the hook variable that the MUA should provide is
@code{mail-citation-hook}. Richard Stallman suggests that the MUAs
should @code{defvar} @code{mail-citation-hook} to @code{nil} and perform
-some default citing when that is the case.@refill
+some default citing when that is the case.
If you are writing a new MUA package, or maintaining an existing MUA
package, you should make it conform to this interface so that your users
-will be able to link Supercite easily and seamlessly. To do this, when
+will be able to link Supercite easily and seamlessly. To do this, when
setting up a reply or forward buffer, your MUA should follow these
steps:
@enumerate
@item
Insert the original message, including the mail headers into the reply
-buffer. At this point you should not modify the raw text in any way
-(except for any necessary decoding, e.g. of quoted-printable text), and
+buffer. At this point you should not modify the raw text in any way
+(except for any necessary decoding, e.g., of quoted-printable text), and
you should place all the original headers into the body of the reply.
This means that many of the mail headers will be duplicated, one copy
above the @code{mail-header-separator} line and one copy below, however
-there will probably be more headers below this line.@refill
+there will probably be more headers below this line.
@item
Set @samp{point} to the beginning of the line containing the first mail
-header in the body of the reply. Set @samp{mark} at the end of the
+header in the body of the reply. Set @samp{mark} at the end of the
message text. It is very important that the region be set around the
text Supercite is to modify and that the mail headers are within this
region. Supercite will not venture outside the region for any reason,
and anything within the region is fair game, so don't put anything that
-@strong{must} remain unchanged inside the region.@refill
+@strong{must} remain unchanged inside the region.
@item
-Run the hook @code{mail-citation-hook}. You will probably want to
+Run the hook @code{mail-citation-hook}. You will probably want to
provide some kind of default citation functions in cases where the user
does not have Supercite installed. By default, your MUA should
@code{defvar} @code{mail-citation-hook} to @code{nil}, and in your
@code{mail-citation-hook} to be @code{nil}, it should perform some
default citing behavior. User who want to connect to Supercite then
need only add @code{sc-cite-original} to this list of hooks using
-@code{add-hook}.@refill
+@code{add-hook}.
@end enumerate
If you do all this your MUA will join the ranks of those that conform to
this interface ``out of the box.''
-@node Thanks and History, GNU Free Documentation License, Hints to MUA Authors, Top
+@node Thanks and History
@chapter Thanks and History
The Supercite package was derived from its predecessor Superyank 1.11
which was inspired by various bits of code and ideas from Martin Neitzel
-and Ashwin Ram. They were the folks who came up with the idea of
+and Ashwin Ram. They were the folks who came up with the idea of
non-nested citations and implemented some rough code to provide this
-style. Superyank and Supercite version 2 evolved to the point where much
+style. Superyank and Supercite version 2 evolved to the point where much
of the attribution selection mechanism was automatic, and features have
been continuously added through the comments and suggestions of the
Supercite mailing list participants.
With version 3, Supercite underwent an almost complete rewrite,
-benefitting in a number of ways, including vast improvements in the
+benefiting in a number of ways, including vast improvements in the
speed of performance, a big reduction in size of the code and in the use
of Emacs resources, and a much cleaner and flexible internal
architecture. Most of this work was internal and not of very great
Supercite was written by Barry Warsaw.
-@node GNU Free Documentation License, Concept Index, Thanks and History, Top
+@node GNU Free Documentation License
@appendix GNU Free Documentation License
@include doclicense.texi
-@node Concept Index, Command Index, GNU Free Documentation License, Top
+@node Concept Index
@unnumbered Concept Index
@printindex cp
-@node Command Index, Key Index, Concept Index, Top
+@node Command Index
@unnumbered Command Index
-@ifinfo
-@end ifinfo
Since all supercite commands are prepended with the string
``@code{sc-}'', each appears under its @code{sc-}@var{command} name and
its @var{command} name.
@end iftex
@printindex fn
-@node Key Index, Variable Index, Command Index, Top
+@node Key Index
@unnumbered Key Index
@printindex ky
-@node Variable Index, , Key Index, Top
+@node Variable Index
@unnumbered Variable Index
-@ifinfo
-@end ifinfo
Since all supercite variables are prepended with the string
``@code{sc-}'', each appears under its @code{sc-}@var{variable} name and
its @var{variable} name.
HCoop / bpt / emacs.git / blobdiff