@comment 3.48
@comment %**start of header (This is for running Texinfo on a region.)
@setfilename ../../info/sc
-@settitle Supercite Version 3.1 User's Manual
+@settitle Supercite User's Manual
@iftex
@finalout
@end iftex
@comment %**end of header (This is for running Texinfo on a region.)
@copying
-This document describes the Supercite Version 3.1 package for citing and
-attributing the replies for various GNU Emacs mail and news reading
-subsystems.
+This document describes Supercite, an Emacs package for citing and
+attributing replies to mail and news messages.
Copyright @copyright{} 1993, 2001, 2002, 2003, 2004,
2005, 2006, 2007, 2008 Free Software Foundation, Inc.
@end direntry
@titlepage
-@sp 6
-@center @titlefont{Supercite User's Manual}
-@sp 2
-@center @titlefont{Supercite Version 3.1}
-@sp 4
-@center Manual Revision: 3.48
-@center April 2007
-@sp 5
-@center Barry A@. Warsaw
-@center @t{bwarsaw@@cen.com}
-@center @t{@dots{}!uunet!cen.com!bwarsaw}
+@title Supercite User's Manual
+@subtitle cite and attribute mail and
+@subtitle news, in flexible ways
+
@page
@vskip 0pt plus 1filll
@insertcopying
@node Top, Introduction, (dir), (dir)
@comment node-name, next, previous, up
-This document describes the Supercite Version 3.1 package for citing and
-attributing the replies for various GNU Emacs mail and news reading
-subsystems. The manual is divided into the following chapters.
+This document describes Supercite, an Emacs package for citing and
+attributing replies to mail and news messages. The manual is divided
+into the following chapters.
@menu
* Introduction::
* Information Keys and the Info Alist::
* Reference Headers::
* Hints to MUA Authors::
-* Version 3 Changes::
* Thanks and History::
-* The Supercite Mailing List::
* GNU Free Documentation License::
* Concept Index::
@node Introduction, Usage Overview, Top, Top
-@comment node-name, next, previous, up
@chapter Introduction
-@ifinfo
-@end ifinfo
-Supercite version 3.1 is a GNU Emacs package written entirely in Emacs
-Lisp. It interfaces to most of the commonly used Emacs mail user agents
+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.
The preferred way to spell Supercite is with a capital @samp{S},
-lowercase @samp{upercite}. There are a few alternate spellings out there
-and I won't be terribly offended if you use them. People often ask
-though@dots{}
+lowercase @samp{upercite}.
@ifinfo
@menu
@cindex MUA
@cindex NUA
Supercite is only useful in conjunction with MUAs and NUAs such as VM,
-GNUS, RMAIL, etc@. (hereafter referred to collectively as MUAs).
-Supercite is typically called by the MUA after a reply buffer has been
-setup. Thereafter, Supercite's many commands and formatting styles are
-available in that reply buffer until the reply is sent. Supercite is
-re-initialized in each new reply buffer.
-
-Supercite is currently at major revision 3.1, and is known to work in the
-following environments:
-
-@table @asis
-@item Emacs versions:
- GNU Emacs 18.57 through 18.59, all Emacs 19,
- all current Lucid Emacs, and Epoch 4.@refill
-
-@item MUAs:
- VM 4.37 and beyond (including VM version 5), RMAIL, MH-E 3.7 and
- beyond, PCMAIL.@refill
-
-@item NUAs:
- RNEWS, GNUS 3.12 and beyond, GNEWS.@refill
-
-@end table
-For systems with version numbers, all known subsequent versions also
-work with Supercite. For those systems without version numbers,
-Supercite probably works with any recently released version. Note that
-only some of these systems will work with Supercite ``out of the box.''
-All others must overload interfacing routines to supply the necessary
-glue. @xref{Getting Connected}, for more details.@refill
+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
+formatting styles are available in that reply buffer until the reply is
+sent. Supercite is re-initialized in each new reply buffer.
@node Usage Overview, What Supercite Does Not Do, Introduction, Introduction
-@comment node-name, next, previous, up
@kindex r
@kindex f
@kindex C-c C-y
@cindex yank
@cindex cite, citing
@cindex attribute, attributing
-@comment
@section Usage Overview
-@ifinfo
-@end ifinfo
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
citations. Supercite's only job is to cite the original message.
@node What Supercite Does Not Do, What Supercite Does, Usage Overview, Introduction
-@comment node-name, next, previous, up
@section What Supercite Doesn't Do
-@ifinfo
-@end ifinfo
Because of this clear division of labor, there are useful features which
are the sole responsibility of the MUA, even though it might seem that
Supercite should provide them. For example, many people would like to
@xref{Reply Buffer Initialization}.@refill
@vindex mail-header-separator
-@comment
Another potentially useful thing would be for Supercite to set up the
outgoing mail headers with information it gleans from the reply buffer.
But by previously agreed upon convention, any text above the
details.@refill
@node What Supercite Does, Citations, What Supercite Does Not Do, Introduction
-@comment node-name, next, previous, up
@findex sc-cite-original
@section What Supercite Does
-@ifinfo
-@end ifinfo
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
@cindex gin-mode
@vindex fill-prefix
@findex fill-paragraph
-@comment
When the original message is cited by @code{sc-cite-original}, it will
(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
for more details.@refill
@node Citations, Citation Elements, What Supercite Does, Top
-@comment node-name, next, previous, up
@cindex nested citations
@cindex citation
-@comment
@chapter Citations
-@ifinfo
-@end ifinfo
A @dfn{citation} is the acknowledgement 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
@node Citation Elements, Recognizing Citations, Citations, Citations
-@comment node-name, next, previous, up
@cindex citation string
-@comment
@section Citation Elements
-@ifinfo
-@end ifinfo
@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:
multi-level nested citations.
@node Recognizing Citations, Getting Connected, Citation Elements, Citations
-@comment node-name, next, previous, up
@section Recognizing Citations
-@ifinfo
-@end ifinfo
Supercite also recognizes citations in the original article, and can
transform these already cited lines in a number of ways. This is how
Supercite suppresses the multiple citing of non-nested citations.
@code{sc-citation-nonnested-root-regexp}.@refill
@node Information Keys and the Info Alist, Reference Headers, Miscellaneous Commands, Top
-@comment node-name, next, previous, up
@cindex information keys
@cindex Info Alist
@cindex information extracted from mail fields
@findex sc-mail-field
@findex mail-field (sc-)
-@comment
@chapter Information Keys and the Info Alist
-@ifinfo
-@end ifinfo
@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
@dots{}). @xref{Selecting an Attribution}.@refill
@node Reference Headers, The Built-in Header Rewrite Functions, Information Keys and the Info Alist, Top
-@comment node-name, next, previous, up
@cindex reference headers
@chapter Reference Headers
-@ifinfo
-@end ifinfo
Supercite will insert an informative @dfn{reference header} at the
beginning of the cited body of text, which display more detail about the
original article and provides the mapping between the attribution and
beginning at zero.
@node The Built-in Header Rewrite Functions, Electric References, Reference Headers, Reference Headers
-@comment node-name, next, previous, up
@cindex header rewrite functions, built-in
-@comment
@section The Built-in Header Rewrite Functions
-@ifinfo
-@end ifinfo
Below are examples of the various built-in header rewrite functions.
Please note the following:@: first, the text which appears in the
examples below as @var{infokey} indicates that the corresponding value
@end table
@node Electric References, Hints to MUA Authors, The Built-in Header Rewrite Functions, Reference Headers
-@comment node-name, next, previous, up
@cindex electric references
@section Electric References
-@ifinfo
-@end ifinfo
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
Supercite will execute the hook @code{sc-electric-mode-hook} before
entering electric reference mode.
-@node Getting Connected, Emacs 19 MUAs, Recognizing Citations, Top
-@comment node-name, next, previous, up
+@node Getting Connected, Replying and Yanking, Recognizing Citations, Top
@cindex citation interface specification
@chapter Getting Connected
-@ifinfo
-@end ifinfo
+
+@vindex mail-citation-hook
+@cindex .emacs file
+In most cases, all that is necessary to begin using Supercite is to add
+the following to @file{~.emacs}:
+
+@example
+(add-hook 'mail-citation-hook 'sc-cite-original)
+@end example
+
+@noindent For more details of the process, read on@dots{}
+
Hitting @kbd{C-c C-y} in your MUA's reply buffer yanks and cites the
original message into the reply buffer. In reality, the citation of the
original message is performed via a call through a configurable hook
non-@code{nil} value, it tells the MUA to run the hook via
@code{run-hooks} instead of using the default citation.@refill
-@ifinfo
-@menu
-* Emacs 19 MUAs::
-* Emacs 18 MUAs::
-* MH-E with any Emacsen::
-* VM with any Emacsen::
-* GNEWS with any Emacsen::
-* Overloading for Non-conforming MUAs::
-@end menu
-@end ifinfo
-
Early in Supercite's development, the Supercite author, a few MUA
authors, and some early Supercite users got together and agreed upon a
standard interface between MUAs and citation packages (of which
-Supercite is currently the only known add-on @t{:-)}. With the recent
-release of the Free Software Foundation's GNU Emacs 19, the interface
-has undergone some modification and it is possible that not all MUAs
-support the new interface yet. Some support only the old interface and
-some do not support the interface at all. Still, it is possible for all
-known MUAs to use Supercite, and the following sections will outline the
-procedures you need to follow.
+Supercite is currently the only known add-on @t{:-)}. Supercite can
+probably be used with most Emacs MUAs, with a greater or lesser degree
+of effort.
To learn exactly how to connect Supercite to the software systems you
are using, read the appropriate following sections. For details on the
@findex submit-bug-report (sc-)
The first thing that everyone should do, regardless of the MUA you are
using is to set up Emacs so it will load Supercite at the appropriate
-time. You can either dump Supercite into your Emacs binary (ask your
-local Emacs guru how to do this if you don't know), or you can set up an
-@dfn{autoload} for Supercite. To do the latter, put the following in
-your @file{.emacs} file:
+time. This happens automatically if Supercite is distributed with your
+Emacs version. If not, you can set up an @dfn{autoload} for Supercite.
+
+To do the latter, put the following in your @file{.emacs} file:
@example
-(autoload 'sc-cite-original "supercite" "Supercite 3.1" t)
-(autoload 'sc-submit-bug-report "supercite" "Supercite 3.1" t)
+(autoload 'sc-cite-original "supercite" nil t)
@end example
@cindex point
@samp{point} and @samp{mark} to be set around the region to cite, and it
expects the original article's mail headers to be present within this
region. Note that Supercite @emph{never} touches any text outside this
-region. Note further that for Emacs 19, the region need not be active
+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
get executed every time @code{sc-cite-original} is called. @xref{Reply
Buffer Initialization}.@refill
-@node Emacs 19 MUAs, Emacs 18 MUAs, Getting Connected, Getting Connected
-@comment node-name, next, previous, up
-@vindex mail-citation-hook
-@cindex .emacs file
-@section GNUS, RMAIL, or RNEWS with any Emacs 19
-@ifinfo
-
-@end ifinfo
-These MUAs, distributed with Emacs and with Lucid Emacs, use Emacs's
-built-in yanking facility, which provides the citing hook variable
-@code{mail-citation-hook}. By default, this hook's value is @code{nil},
-but by adding the following to your @file{.emacs} file, you can tell
-these MUAs to use Supercite to perform the citing of the original
-message:
-
-@example
-(add-hook 'mail-citation-hook 'sc-cite-original)
-@end example
-
-GNUS users may also want to add the following bit of lisp as well. This
-prevents GNUS from inserting its default attribution header. Otherwise,
-both GNUS and Supercite will insert an attribution header:
-
-@example
-(setq news-reply-header-hook nil)
-@end example
-
-@node Emacs 18 MUAs, MH-E with any Emacsen, Emacs 19 MUAs, Getting Connected
-@comment node-name, next, previous, up
-@vindex mail-citation-hook
-@cindex .emacs file
-@cindex overloading
-@cindex sendmail.el file
-@section GNUS, RMAIL, PCMAIL, RNEWS with Emacs 18 or Epoch 4
-@ifinfo
-
-@end ifinfo
-These MUAs use Emacs' built-in yanking and citing routines, contained in
-the @file{sendmail.el} file. @file{sendmail.el} for Emacs 18, and its
-derivative Epoch 4, do not know anything about the citation interface
-required by Supercite. To connect Supercite to any of these MUAs under
-Emacs 18 or Epoch 4, you should first
-@pxref{Overloading for Non-conforming MUAs}. Then follow the directions
-for using these MUAs under Emacs 19.
-@xref{Emacs 19 MUAs}.@refill
-
-@cindex add-hook substitute
-@cindex setq as a substitute for add-hook
-@findex setq
-@findex add-hook
-@cindex sc-unsupp.el file
-Note that those instructions will tell you to use the function
-@code{add-hook}. This function is new with Emacs 19 and you will not
-have it by default if you are running Emacs 18 or Epoch 4. You can
-either substitute the appropriate call to @code{setq}, or you can use
-the @code{add-hook} function that is provided in the @file{sc-unsupp.el}
-file of unsupported Supercite hacks and ideas. Or you can upgrade to
-some Emacs 19 variant! @t{:-)}@refill
-
-To use @code{setq} instead of @code{add-hook}, you would, for example,
-change this:
-
-@example
-(add-hook 'mail-citation-hook 'sc-cite-original)
-@end example
-
-to:
-
-@example
-(setq mail-citation-hook 'sc-cite-original)
-@end example
-
-Note the lack of a single quote on the first argument to @code{setq}.
-
-@node MH-E with any Emacsen, VM with any Emacsen, Emacs 18 MUAs, Getting Connected
-@comment node-name, next, previous, up
-@cindex .emacs file
-@vindex mh-yank-hooks
-@findex add-hook
-@cindex mail-citation-hook
-@section MH-E with any Emacsen
-@ifinfo
-
-@end ifinfo
-MH-E 4.x conforms to the @code{mail-citation-hook} interface supported
-by other MUAs. At the time of this writing, MH-E 4.0 has not been
-released, but if you have it, put this in your @file{.emacs} file to
-connect Supercite and MH-E 4.x:
-
-@example
-(add-hook 'mail-citation-hook 'sc-cite-original)
-@end example
-
-Note that if you are using Emacs 18 or Epoch 4, you will not have the
-@code{add-hook} function. @xref{Emacs 18 MUAs}, for details on how to
-proceed without @code{add-hook}.
-
-MH-E version 3.x uses a slightly different interface than other MUAs.
-MH-E provides a hook variable @code{mh-yank-hooks}, but it doesn't act
-like a hook, and doing an @code{add-hook} will not work.
-
-To connect Supercite to MH-E 3.x, you should instead add the following
-to your @code{.emacs} file:
-
-@example
-(add-hook 'mh-yank-hooks 'sc-cite-original)
-@end example
-
-@vindex mh-yank-from-start-of-msg
-You also need to make sure that MH-E includes all the original mail
-headers in the yanked message. The variable that controls this is
-@code{mh-yank-from-start-of-msg}. By default, this variable has the
-value @code{t}, which tells MH-E to include all the mail headers when
-yanking the original message. Before you switched to using Supercite,
-you may have set this variable to other values so as not to include the
-mail headers in the yanked message. Since Supercite requires these
-headers (and cleans them out for you), you need to make sure the value
-is @code{t}. This lisp, in your @file{.emacs} file will do the trick:
-
-@example
-(setq mh-yank-from-start-of-msg t)
-@end example
-
-Note that versions of MH-E before 3.7 did not provide the
-@code{mh-yank-hooks} variable. Your only option is to upgrade to MH-E
-version 3.7 or later.
-
-@node VM with any Emacsen, GNEWS with any Emacsen, MH-E with any Emacsen, Getting Connected
-@comment node-name, next, previous, up
-@cindex .emacs file
-@vindex mail-citation-hook
-@vindex mail-yank-hooks
-@section VM with any Emacsen
-@ifinfo
-
-@end ifinfo
-Since release 4.40, VM has supported the citation interface required by
-Supercite. But since the interface has changed recently the details of
-getting connected differ with the version of VM you are using.
-
-If you are running any release of VM after 4.40, you can add the
-following to your @file{.emacs} to connect Supercite with VM:
-
-@example
-(add-hook 'mail-yank-hooks 'sc-cite-original)
-@end example
-
-Note that if you are using Emacs 18 or Epoch 4, you will not have the
-@code{add-hook} function. @xref{Emacs 18 MUAs}, for details on how to
-proceed without @code{add-hook}.
-
-Since version 5.34, VM has supported the newer @code{mail-citation-hook}
-interface, but @code{mail-yank-hooks} is still being supported for
-backward compatibility. If you are running a newer version of VM and
-you want to maintain consistency with other MUAs, use this bit of code
-instead:
-
-@example
-(add-hook 'mail-citation-hook 'sc-cite-original)
-@end example
-
-@node GNEWS with any Emacsen, Overloading for Non-conforming MUAs, VM with any Emacsen, Getting Connected
-@comment node-name, next, previous, up@cindex .emacs file
-@vindex news-reply-mode-hook
-@findex sc-perform-overloads
-@findex perform-overloads (sc-)
-@vindex gnews-ready-hook
-@section GNEWS with any Emacsen
-@ifinfo
-
-@end ifinfo
-As far as I know, no version of GNEWS supports the citation interface
-required by Supercite. To connect Supercite with GNEWS, please first
-@pxref{Overloading for Non-conforming MUAs}.
-
-After you have followed the directions in that section. You should add
-the following lisp code to your @file{.emacs} file:
-
-@example
-(add-hook 'mail-citation-hook 'sc-cite-original)
-@end example
-
-Note that if you are using Emacs 18 or Epoch 4, you will not have the
-@code{add-hook} function. @xref{Emacs 18 MUAs}, for details on how to
-proceed without @code{add-hook}.
-
-@node Overloading for Non-conforming MUAs, Replying and Yanking, GNEWS with any Emacsen, Getting Connected
-@comment node-name, next, previous, up
-@cindex overloading
-@cindex sc-oloads.el
-@vindex mail-citation-hook
-@findex sc-perform-overloads
-@cindex .emacs file
-@section Overloading for Non-conforming MUAs
-@ifinfo
-
-@end ifinfo
-As mentioned elsewhere, some MUAs do not provide the necessary hooks to
-connect with Supercite. Supercite version 3.1 provides an unsupported
-mechanism, called @dfn{overloading} which redefines certain key
-functions in the MUA, so that it will call the @code{mail-citation-hook}
-variable instead of the MUA's default hard-coded citing routines. Since
-most newer versions of the known MUAs support the
-@code{mail-citation-hook} variable, it is recommended that you upgrade
-if at all possible. But if you can't upgrade, at least you're not out
-of luck! Once you set up overloading properly, you should follow the
-directions for connecting Supercite to the Emacs 19 MUAs.
-@xref{Emacs 19 MUAs}.@refill
-
-@cindex Hyperbole
-@vindex hyperb:version
-Users of Bob Weiner's Hyperbole package take note. Hyperbole provides
-the necessary overloads (and a whole lot more!) and you can potentially
-clobber it if you were to load Supercite's overloading after
-Hyperbole's. For this reason, Supercite will @emph{not} perform any
-overloading if it finds the variable @code{hyperb:version} is
-@code{boundp} (i.e. it exists because Hyperbole has been loaded into
-your Emacs session). If this is the case, Supercite will display a
-warning message in the minibuffer. You should consult the Hyperbole
-manual for further details.
-
-Overloading involves the re-definition of the citing function with the
-new, @code{mail-citation-hook} savvy version. The function in
-@file{sc-oloads.el} that does this is @code{sc-perform-overloads}. This
-function is smart enough to only overload the MUA functions when it is
-absolutely necessary, based on the version numbers it can figure out.
-Also, @code{sc-perform-overloads} will only install the new functions
-once. It is also smart enough to do nothing if the MUA is not yet
-loaded.@refill
-
-The tricky part is finding the right time and place to perform the
-overloading. It must be done after the MUA has been loaded into your
-Emacs session, but before the first time you try to yank in a message.
-Fortunately, this has been figured out for you.
-
-If you must overload, you should put the following lisp code in your
-@file{.emacs} file, to make sure the @file{sc-oloads.el} file gets
-loaded at the right time:
-
-@example
-(autoload 'sc-perform-overloads "sc-oloads" "Supercite 3.1" t)
-@end example
-
-Then you must make sure that the function @code{sc-perform-overloads}
-gets run at the right time. For GNUS, put this in your @file{.emacs}
-file:
-
-@example
-(setq news-reply-mode-hook 'sc-perform-overloads)
-(setq mail-setup-hook 'sc-perform-overloads)
-@end example
-
-If you are using RNEWS, put this in your @file{.emacs} file:
-
-@vindex news-reply-mode-hook
-@example
-(setq news-reply-mode-hook 'sc-perform-overloads)
-@end example
-
-If you are using RMAIL or PCMAIL, put this in your @file{.emacs} file:
-
-@example
-(setq mail-setup-hook 'sc-perform-overloads)
-@end example
-
-If you are using GNEWS, put this in your @file{.emacs} file:
-
-@example
-(setq news-reply-mode-hook 'sc-perform-overloads)
-(setq gnews-ready-hook 'sc-perform-overloads)
-@end example
-
-Now go back and follow the directions for getting the Emacs 19 MUAs
-connected to Supercite. Be sure to @pxref{Emacs 18 MUAs} on substitutes
-for Emacs 19's @code{add-hook} function.@refill
-
-@node Replying and Yanking, Reply Buffer Initialization, Overloading for Non-conforming MUAs, Top
-@comment node-name, next, previous, up
+@node Replying and Yanking, Reply Buffer Initialization, Getting Connected, Top
@chapter Replying and Yanking
@ifinfo
@end menu
@end ifinfo
@node Reply Buffer Initialization, Filling Cited Text, Replying and Yanking, Replying and Yanking
-@comment node-name, next, previous, up
@findex sc-cite-original
@findex cite-original (sc-)
-@comment
@section Reply Buffer Initialization
-@ifinfo
-@end ifinfo
Executing @code{sc-cite-original} performs the following steps as it
initializes the reply buffer:
@end enumerate
@node Filling Cited Text, Selecting an Attribution, Reply Buffer Initialization, Replying and Yanking
-@comment node-name, next, previous, up
@cindex filling paragraphs
@vindex sc-auto-fill-region-p
@vindex auto-fill-region-p (sc-)
@vindex sc-load-hook
@vindex load-hook (sc-)
@section Filling Cited Text
-@ifinfo
-@end ifinfo
Supercite will automatically fill newly cited text from the original
message unless the variable @code{sc-auto-fill-region-p} has a
@code{nil} value. Supercite will also re-fill paragraphs when you
fill cited text.
@node Selecting an Attribution, Attribution Preferences, Filling Cited Text, Top
-@comment node-name, next, previous, up
@cindex attribution list
@vindex sc-preferred-attribution-list
@vindex preferred-attribution-list (sc-)
-@comment
@chapter Selecting an Attribution
-@ifinfo
-@end ifinfo
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
scans the various mail headers present in the original article and uses
@end ifinfo
@node Attribution Preferences, Anonymous Attributions, Selecting an Attribution, Selecting an Attribution
-@comment node-name, next, previous, up
@section Attribution Preferences
-@ifinfo
-@end ifinfo
When you cite an original message, you can tell Supercite which part of
the author's name you would prefer it to use as the attribution. The
variable @code{sc-preferred-attribution-list} controls this; it contains
to cite your friend's message with the appropriate attribution.
@node Anonymous Attributions, Author Names, Attribution Preferences, Selecting an Attribution
-@comment node-name, next, previous, up
@vindex sc-default-author-name
@vindex default-author-name (sc-)
@vindex sc-default-attribution
@vindex default-attribution (sc-)
-@comment
@section Anonymous Attributions
-@ifinfo
-@end ifinfo
When the author's name cannot be found in the @samp{From:@:} mail
header, a fallback author name and attribution string must be supplied.
The fallback author name is contained in the variable
author only has one name.@refill
@node Author Names, Configuring the Citation Engine, Anonymous Attributions, Selecting an Attribution
-@comment node-name, next, previous, up
@cindex author names
@section Author Names
-@ifinfo
-@end ifinfo
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.
Supercite can recognize almost all of the common @samp{From:@:} field
formats in use. If you encounter a @samp{From:@:} field that Supercite
-cannot parse, please report this bug.
-@xref{The Supercite Mailing List}.@refill
+cannot parse, please report this bug using @kbd{M-x report-emacs-bug}.
@vindex sc-titlecue-regexp
@vindex titlecue-regexp (sc-)
the name field.
@node Configuring the Citation Engine, Using Regi, Author Names, Top
-@comment node-name, next, previous, up
@cindex Regi
@cindex frames (Regi)
@cindex entries (Regi)
@chapter Configuring the Citation Engine
-@ifinfo
-@end ifinfo
At the heart of Supercite is a regular expression interpreting engine
called @dfn{Regi}. Regi operates by interpreting a data structure
called a Regi-frame (or just @dfn{frame}), which is a list of
currently part of Supercite, but contributions are welcome!
@node Using Regi, Frames You Can Customize, Configuring the Citation Engine, Configuring the Citation Engine
-@comment node-name, next, previous, up
@findex regi-interpret
@findex eval
@findex looking-at
@section Using Regi
-@ifinfo
-@end ifinfo
Regi works by interpreting frames with the function
@code{regi-interpret}. A frame is a list of arbitrary size where each
element is a entry of the following form:
@end table
@node Frames You Can Customize, Post-yank Formatting Commands, Using Regi, Configuring the Citation Engine
-@comment node-name, next, previous, up
@vindex sc-nuke-mail-header
@section Frames You Can Customize
-@ifinfo
-@end ifinfo
As mentioned earlier, Supercite uses various frames to perform
certain jobs such as mail header information extraction and mail header
nuking. However, these frames are not available for you to customize,
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
-@comment node-name, next, previous, up
@vindex sc-mode-map-prefix
@vindex mode-map-prefix (sc-)
@kindex C-c C-p
@chapter Post-yank Formatting Commands
-@ifinfo
-@end ifinfo
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
@end ifinfo
@node Citing Commands, Insertion Commands, Post-yank Formatting Commands, Post-yank Formatting Commands
-@comment node-name, next, previous, up
@vindex sc-cite-region-limit
@section Commands to Manually Cite, Recite, and Uncite
-@ifinfo
-@end ifinfo
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
the region so that the command can be undone in the standard Emacs
way.@refill
-A quick note about Emacs 19. Unlike in Emacs 18, the region delimited
-by @samp{point} and @samp{mark} can have two states. It can be
-@dfn{active} or @dfn{inactive}. Although Emacs 19 and Lucid Emacs 19
-use different terminology and functions, both employ the same convention
-such that when the region is inactive, commands that modify the region
-should generate an error. The user needs to explicitly activate the
-region before successfully executing the command. All Supercite
-commands conform to this convention.
-
Here is the list of Supercite citing commands:
@table @asis
@vindex confirm-always-p
@kindex C-u
@item @code{sc-cite-region} (@kbd{C-c C-p c})
-@comment
This command cites each line in the region of text by interpreting the
selected frame from @code{sc-cite-frame-alist}, or the default citing
frame @code{sc-default-cite-frame}. It runs the hook
@findex uncite-region (sc-)
@kindex C-c C-p u
@item @code{sc-uncite-region} (@kbd{C-c C-p u})
-@comment
This command removes any citation strings from the beginning of each
cited line in the region by interpreting the selected frame from
@code{sc-uncite-frame-alist}, or the default unciting frame
@findex recite-region (sc-)
@kindex C-c C-p r
@item @code{sc-recite-region} (@kbd{C-c C-p r})
-@comment
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
@end table
@node Insertion Commands, Variable Toggling Shortcuts, Citing Commands, Post-yank Formatting Commands
-@comment node-name, next, previous, up
@section Insertion Commands
-@ifinfo
-@end ifinfo
These two functions insert various strings into the reply buffer.
@table @asis
@findex insert-reference (sc-)
@kindex C-c C-p w
@item @code{sc-insert-reference} (@kbd{C-c C-p w})
-@comment
@vindex sc-preferred-header-style
@vindex preferred-header-style (sc-)
Inserts a reference header into the reply buffer at @samp{point}. With
@findex insert-citation (sc-)
@kindex C-c C-p i
@item @code{sc-insert-citation} (@kbd{C-c C-p i})
-@comment
Inserts the current citation string at the beginning of the line that
@samp{point} is on. If the line is already cited, Supercite will issue
an error and will not cite the line.
@end table
@node Variable Toggling Shortcuts, Mail Field Commands, Insertion Commands, Post-yank Formatting Commands
-@comment node-name, next, previous, up
@cindex toggling variables
@section Variable Toggling Shortcuts
-@ifinfo
-@end ifinfo
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
buffer. For example, you may want to turn off filling or whitespace
@node Mail Field Commands, Miscellaneous Commands, Variable Toggling Shortcuts, Post-yank Formatting Commands
-@comment node-name, next, previous, up
@section Mail Field Commands
-@ifinfo
-@end ifinfo
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
@findex mail-field-query (sc-)
@kindex C-c C-p f
@item @code{sc-mail-field-query} (@kbd{C-c C-p f})
-@comment
Allows you to interactively view, modify, add, and delete info alist
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
you (with completion) for the key of the value you want to change. It
will then put you in the minibuffer with the key's current value so you
can edit the value as you wish. When you hit @key{RET}, the key's value
-is changed. For those of you running Emacs 19, minibuffer history is
-kept for the values.
+is changed. Minibuffer history is kept for the values.
If you choose to delete a key-value pair, Supercite will prompt you (with
completion) for the key to delete.
@findex mail-process-headers (sc-)
@kindex C-c C-p g
@item @code{sc-mail-process-headers} (@kbd{C-c C-p g})
-@comment
This command lets you re-initialize Supercite's info alist from any set
of mail headers in the region between @samp{point} and @samp{mark}.
This function is especially useful for replying to digest messages where
@end table
@node Miscellaneous Commands, Information Keys and the Info Alist, Mail Field Commands, Post-yank Formatting Commands
-@comment node-name, next, previous, up
@section Miscellaneous Commands
-@ifinfo
-@end ifinfo
@table @asis
@findex sc-open-line
@findex open-line (sc-)
@findex open-line
@kindex C-c C-p o
@item @code{sc-open-line} (@kbd{C-c C-p o})
-@comment
Similar to Emacs' 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
-
-@findex sc-describe
-@findex describe (sc-)
-@kindex C-c C-p ?
-@kindex C-c C-p h
-@item @code{sc-describe} (@kbd{C-c C-p h} and @kbd{C-c C-p ?})
-@comment
-This function has been obsoleted by the @TeX{}info manual you are now
-reading. It is still provided for compatibility, but it will eventually
-go away.
-
-@findex sc-version
-@findex version (sc-)
-@kindex C-c C-p v
-@item @code{sc-version} (@kbd{C-c C-p v})
-@comment
-Echos the version of Supercite you are using. With the optional
-universal argument (@kbd{C-u}), this command inserts the version
-information into the current buffer.
-
-@findex sc-submit-bug-report
-@findex submit-bug-report (sc-)
-@kindex C-c C-p C-b
-@item @code{sc-submit-bug-report} (@kbd{C-c C-p C-b})
-@comment
-If you encounter a bug, or wish to suggest an enhancement, use this
-command to set up an outgoing mail buffer, with the proper address to
-the Supercite maintainer automatically inserted in the @samp{To:@:}
-field. This command also inserts information that the Supercite
-maintainer can use to recreate your exact setup, making it easier to
-verify your bug.
@end table
-@node Hints to MUA Authors, Version 3 Changes, Electric References, Top
-@comment node-name, next, previous, up
+@node Hints to MUA Authors, Thanks and History, Electric References, Top
@chapter Hints to MUA Authors
-@ifinfo
-@end ifinfo
In June of 1989, some discussion was held between the various MUA
authors, the Supercite author, and other Supercite users. These
discussions centered around the need for a standard interface between
@cindex sendmail.el
@findex mail-yank-original
@findex defvar
-This specification was adopted, but with the recent release of
-Emacs 19, it has undergone a slight modification. Instead of the
-variable @code{mail-yank-hooks}, the new preferred hook variable that
-the MUA should provide is @code{mail-citation-hook}.
-@code{mail-yank-hooks} can be provided for backward compatibility, but
-@code{mail-citation-hook} should always take precedence. Richard
-Stallman (of the FSF) suggests that the MUAs should @code{defvar}
-@code{mail-citation-hook} to @code{nil} and perform some default citing
-when that is the case. Take a look at Emacs 19's @file{sendmail.el}
-file, specifically the @code{mail-yank-original} defun for
-details.@refill
+This specification was adopted, but underwent a slight modification with
+the release of Emacs 19. Instead of the variable
+@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
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
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. Further note that for
-Emacs 19, the region need not be set active. Supercite will work
-properly when the region is inactive, as should any other like-minded
-package.@refill
+@strong{must} remain unchanged inside the region.@refill
@item
Run the hook @code{mail-citation-hook}. You will probably want to
@code{add-hook}.@refill
@end enumerate
-If you do all this, your users will not need to overload your routines
-to use Supercite, and your MUA will join the ranks of those that conform
-to this interface ``out of the box.''
-
-@node Version 3 Changes, Thanks and History, Hints to MUA Authors, Top
-@comment node-name, next, previous, up
-@chapter Version 3 Changes
-@ifinfo
-
-@end ifinfo
-@cindex sc-unsupp.el file
-With version 3, Supercite has undergone an almost complete rewrite, and
-has hopefully benefited 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. The central construct of the info alist, and its
-role in Supercite has been expanded, and the other central concept, the
-general package Regi, was developed to provide a theoretically unlimited
-flexibility.
-
-But most of this work is internal and not of very great importance to the
-casual user. There have been some changes at the user-visible level,
-but for the most part, the Supercite configuration variables from
-version 2 should still be relevant to version 3. Below, I briefly
-outline those user-visible things that have changed since version 2. For
-details, look to other sections of this manual.
-
-@enumerate
-@item
-@cindex supercite.el file
-@cindex reporter.el file
-@cindex regi.el file
-@cindex sc.el from version 2
-@cindex sc-elec.el from version 2
-Supercite proper now comes in a single file, @file{supercite.el}, which
-contains everything except the unsupported noodlings, overloading (which
-should be more or less obsolete with the release of Emacs 19), and the
-general lisp packages @file{reporter.el} and @file{regi.el}. Finally,
-the @TeX{}info manual comes in its own file as well. In particular, the
-file @file{sc.el} from the version 2 distribution is obsolete, as is the
-file @file{sc-elec.el}.
+If you do all this your MUA will join the ranks of those that conform to
+this interface ``out of the box.''
-@item
-@code{sc-spacify-name-chars} is gone in version 3.
-
-@item
-@vindex sc-attrib-selection-list
-@vindex attrib-selection-list
-@code{sc-nickname-alist} is gone in version 3. The
-@code{sc-attrib-selection-list} is a more general construct supporting
-the same basic feature.
-
-@item
-The version 2 variable @code{sc-preferred-attribution} has been changed
-to @code{sc-preferred-attribution-list}, and has been expanded upon to
-allow you to specify an ordered list of preferred attributions.
-
-@item
-@code{sc-mail-fields-list} has been removed, and header nuking in
-general has been greatly improved, giving you wider flexibility in
-specifying which headers to keep and remove while presenting a
-simplified interface to commonly chosen defaults.
-
-@item
-Post-yank paragraph filling has been completely removed from Supercite,
-other packages just do it better than Supercite ever would. Supercite
-will still fill newly cited paragraphs.
-
-@item
-@vindex sc-cite-region-limit
-@vindex cite-region-limit
-The variable @code{sc-all-but-cite-p} has been replaced by
-@code{sc-cite-region-limit}.
-
-@item
-Keymap hacking in the reply buffer has been greatly simplified, with, I
-believe, little reduction in functionality.
-
-@item
-Hacking of the reply buffer's docstring has been completely eliminated.
-@end enumerate
-
-@node Thanks and History, The Supercite Mailing List, Version 3 Changes, Top
-@comment node-name, next, previous, up
+@node Thanks and History, GNU Free Documentation License, Hints to MUA Authors, Top
@chapter Thanks and History
-@ifinfo
-@end ifinfo
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
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. Supercite version 3 represents a
-nearly complete rewrite with many of the algorithms and coding styles
-being vastly improved. Hopefully Supercite version 3 is faster,
-smaller, and much more flexible than its predecessors.
+Supercite mailing list participants.
+
+With version 3, Supercite underwent an almost complete rewrite,
+benefitting 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
+importance to the casual user. There were some changes at the
+user-visible level, but for the most part, the Supercite configuration
+variables from version 2 should still be relevant to version 3.
+Hopefully Supercite version 3 is faster, smaller, and much more flexible
+than its predecessors.
In the version 2 manual I thanked some specific people for their help in
developing Supercite 2. You folks know who you are and your continued
All who have helped and contributed have been greatly appreciated.
-@node The Supercite Mailing List, GNU Free Documentation License, Thanks and History, Top
-@comment node-name, next, previous, up
-@cindex supercite mailing list address
-@cindex mailing list address
-@chapter The Supercite Mailing List
-@ifinfo
+Supercite was written by Barry Warsaw.
-@end ifinfo
-The author runs a simple mail expanding mailing list for discussion of
-issues related to Supercite. This includes enhancement requests, bug
-reports, general help questions, etc. To subscribe or unsubscribe to
-the mailing list, send a request to the administrative address:
-
-@example
-supercite-request@@python.org
-@end example
-
-Please be sure to include the most reliable and shortest (preferably
-Internet) address back to you. To post articles to the list, send your
-message to this address (you do not need to be a member to post, but be
-sure to indicate this in your article or replies may not be CC'd to
-you):
-
-@example
-supercite@@python.org
-@end example
-
-If you are sending bug reports, they should go to the following address,
-but @emph{please}! use the command @code{sc-submit-bug-report} since it
-will be much easier for me to duplicate your problem if you do so. It
-will set up a mail buffer automatically with this address on the
-@samp{To:@:} line:
-
-@example
-supercite-help@@python.org
-@end example
-
-@node GNU Free Documentation License, Concept Index, The Supercite Mailing List, Top
+@node GNU Free Documentation License, Concept Index, Thanks and History, Top
@appendix GNU Free Documentation License
@include doclicense.texi
@node Concept Index, Command Index, GNU Free Documentation License, Top
-@comment node-name, next, previous, up
@unnumbered Concept Index
@printindex cp
@node Command Index, Key Index, Concept Index, Top
-@comment node-name, next, previous, up
@unnumbered Command Index
@ifinfo
@printindex fn
@node Key Index, Variable Index, Command Index, Top
-@comment node-name, next, previous, up
@unnumbered Key Index
@printindex ky
@node Variable Index, , Key Index, Top
-@comment node-name, next, previous, up
@unnumbered Variable Index
@ifinfo
HCoop / bpt / emacs.git / commitdiff