This is supercite.info, produced by makeinfo version 4.6 from
supercite.texi.

START-INFO-DIR-ENTRY
* Supercite::           Fancy citations and attributions for replies for
   			mail and news reading systems.
END-INFO-DIR-ENTRY
   This document describes the Supercite Version 3.1 package for citing
and attributing the replies for various GNU Emacs mail and news reading
subsystems.

   Copyright (C) 1993 Barry A. Warsaw

   Permission is granted to make and distribute verbatim copies of this
manual provided the copyright notice and this permission notice are
preserved on all copies.


File: supercite.info,  Node: Top,  Next: Introduction,  Prev: (dir),  Up: (dir)

   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.

* Menu:

* Introduction::
* Citations::
* 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::
* Version 3 Changes::
* Thanks and History::
* The Supercite Mailing List::

* Concept Index::
* Command Index::
* Key Index::
* Variable Index::


File: supercite.info,  Node: Introduction,  Next: Usage Overview,  Prev: Top,  Up: Top

Introduction
************

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
("MUAs") and news user agents ("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 `S',
lowercase `upercite'.  There are a few alternate spellings out there
and I won't be terribly offended if you use them.  People often ask
though...

* Menu:

* Usage Overview::
* What Supercite Does Not Do::
* What Supercite Does::

   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:

Emacsen:
     	GNU Emacs 18.57 through 18.59, all current FSF Emacs 19,
     all current Lucid Emacs 19, and Epoch 4.

MUAs:
     	VM 4.37 and beyond (including VM version 5), RMAIL, MH-E 3.7 and
     beyond, PCMAIL.

NUAs:
     	RNEWS, GNUS 3.12 and beyond, GNEWS.

   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.  *Note Getting Connected::, for more details.


File: supercite.info,  Node: Usage Overview,  Next: What Supercite Does Not Do,  Prev: Introduction,  Up: Introduction

Usage Overview
==============

Typical usage is as follows. You want to reply or followup to a message
in your MUA. You will probably hit `r' (i.e., "reply") or `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 "yank" the original
message into the reply buffer, typically with a key stroke such as `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 "attributes"
this text to its author.  This is called "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.


File: supercite.info,  Node: What Supercite Does Not Do,  Next: What Supercite Does,  Prev: Usage Overview,  Up: Introduction

What Supercite Doesn't Do
=========================

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
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.
*Note Reply Buffer Initialization::.

   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
`mail-header-separator' which separates mail headers from message
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. *Note Hints to MUA Authors::, for more
details.


File: supercite.info,  Node: What Supercite Does,  Next: Citations,  Prev: What Supercite Does Not Do,  Up: Introduction

What Supercite Does
===================

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
`sc-cite-original' has been added.  When `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.  *Note Hints to MUA
Authors::.

   The first thing Supercite does, via `sc-cite-original', is to parse
through the original message's mail headers.  It saves this data in an
"information association list", or "info alist".  The information in
this list is used in a number of places throughout Supercite.  *Note
Information Keys and the Info Alist::.

   After the mail header info is extracted, the headers are optionally
removed ("nuked") from the reply.  Supercite then writes a "reference
header" into the buffer.  This reference header is a string carrying
details about the citation it is about to perform.

   Next, Supercite visits each line in the reply, transforming the line
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
have access to Supercite's post-yank formatting and reciting commands as
you subsequently edit your reply.  You can tell that Supercite has been
installed into the reply buffer because that buffer's modeline will
display the minor mode string `SC'.

   When the original message is cited by `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
as `filladapt' or `gin-mode'.  These packages can recognize Supercited
text and will fill them appropriately.  Emacs' built-in filling
routines, e.g. `fill-paragraph', do not recognize cited text and will
not re-fill them properly because it cannot guess the `fill-prefix'
being used.  *Note 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
beautifications on the cited original text, maintaining consistent and
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.  *Note Getting Connected::,
for more details.


File: supercite.info,  Node: Citations,  Next: Citation Elements,  Prev: What Supercite Does,  Up: Top

Citations
*********

A "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 "nested citations" is an
anonymous form of citation; in other words, an indication is made that
the cited line was written by someone _other_ that the current message
author (i.e., other than you, the person composing the reply), but no
reference is made as to the identity of the original author.  This
style should look familiar since its use on the net is widespread.
Here's an example of what a message buffer would look like using nested
citations after multiple replies:

     >> John originally wrote this
     >> and this as well
     > Jane said that John didn't know
     > what he was talking about
     And that's what I think too.

* Menu:

* Citation Elements::
* Recognizing Citations::

   Note that multiple inclusions of the original messages result in a
nesting of the ``>'' characters.  This can sometimes be quite confusing
when many levels of citations are included since it may be difficult or
impossible to figure out who actually participated in the thread, and
multiple nesting of ``>'' characters can sometimes make the message
very difficult for the eye to scan.

   In "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:

     John> John originally wrote this
     John> and this as well
     Jane> Jane said that John didn't know
     Jane> what he was talking about
     And that's what I think too.

   Notice here that my inclusion of Jane's inclusion of John's original
message did not result in a line cited with `Jane>John>'.

   Supercite supports both styles of citation, and the variable
`sc-nested-citation-p' controls which style it will use when citing
previously uncited text. When this variable is `nil' (the default),
non-nested citations are used.  When non-`nil', nested citations are
used.


File: supercite.info,  Node: Citation Elements,  Next: Recognizing Citations,  Prev: Citations,  Up: Citations

Citation Elements
=================

"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:

  1. The "citation leader".  The citation leader is contained in the
     variable `sc-citation-leader', and has the default value of a
     string containing four spaces.

  2. The "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.  *Note Selecting an Attribution::, for more details.

  3. The "citation delimiter".  This string, contained in the variable
     `sc-citation-delimiter' visually separates the citation from the
     text of the line.  This variable has a default value of `">"' and
     for best results, the string should consist of only a single
     character.

  4. The "citation separator".  The citation separator is contained in
     the variable `sc-citation-separator', and has the default value of
     a string containing a single space.

   For example, suppose you were using the default values for the above
variables, and Supercite provided the attribution string `Jane'.  In
this case, the composed, non-nested citation string used might be
something like `"    Jane> "'.  This citation string will be inserted
in front of 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.


File: supercite.info,  Node: Recognizing Citations,  Next: Getting Connected,  Prev: Citation Elements,  Up: Citations

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
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.

   The variable `sc-citation-leader-regexp' describes how citation
leaders can look, by default it matches any number of spaces or tabs.
Note that since the lisp function `looking-at' is used to do the
matching, if you change this variable it need not start with a leading
`"^"'.

   Similarly, the variables `sc-citation-delimiter-regexp' and
`sc-citation-separator-regexp' respectively describe how citation
delimiters and separators can look.  They follow the same rule as
`sc-citation-leader-regexp' above.

   When Supercite composes a citation string, it provides the
attribution automatically.  The analogous variable which handles
recognition of the attribution part of citation strings is
`sc-citation-root-regexp'.  This variable describes the attribution
root for both nested and non-nested citations.  By default it can match
zero-to-many alphanumeric characters (also ".", "-", and "_").  But in
some situations, Supercite has to determine whether it is looking at a
nested or non-nested citation.  Thus the variable
`sc-citation-nonnested-root-regexp' is used to describe only non-nested
citation roots.  It is important to remember that if you change
`sc-citation-root-regexp' you should always also change
`sc-citation-nonnested-root-regexp'.

   Nemacs users: For best results, try setting
`sc-citation-root-regexp' to:

     "\\([-._a-zA-Z0-9]\\|\\cc\\|\\cC\\|\\ch\\|\\cH\\|\\ck\\|\\cK\\|\\ca\\|\\cg\\|\\cr\\|\\cu\\)*"

   Mule users: For best results, try setting `sc-citation-root-regexp'
to:

     "\\([-._a-zA-Z0-9]\\|\\cj\\)*"


File: supercite.info,  Node: Information Keys and the Info Alist,  Next: Reference Headers,  Prev: Miscellaneous Commands,  Up: Top

Information Keys and the Info Alist
***********************************

"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 "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 `sc-mail-field' function.  Thus, if the following fields were
present in the original article:

     Date: 08 April 1991, 17:32:09 EST
     Subject: Better get out your asbestos suit

then, the following lisp constructs return:

     (sc-mail-field "date")
     ==> "08 April 1991, 17:32:09 EST"
     
     (sc-mail-field "subject")
     ==> "Better get out your asbestos suit"

   Since the argument to `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, `sc-mail-field' will return the value of the
variable `sc-mumble'.

   Supercite always places all mail fields found in the yanked original
article into the info alist.  If possible, Supercite will also places
the following keys into the info alist:

`"sc-attribution"'
     the selected attribution string.

`"sc-citation"'
     the non-nested citation string.

`"sc-from-address"'
     email address extracted from the `From:' field.

`"sc-reply-address"'
     email address extracted from the `Reply-To:' field.

`"sc-sender-address"'
     email address extracted from the `Sender:' field.

`"sc-emailname"'
     email terminus extracted from the `From:' field.

`"sc-initials"'
     the author's initials.

`"sc-author"'
     the author's full name.

`"sc-firstname"'
     the author's first name.

`"sc-lastname"'
     the author's last name.

`"sc-middlename-1"'
     the author's first middle name.

   If the author's name has more than one middle name, they will appear
as info keys with the appropriate index (e.g., `"sc-middlename-2"',
...).  *Note Selecting an Attribution::.


File: supercite.info,  Node: Reference Headers,  Next: The Built-in Header Rewrite Functions,  Prev: Information Keys and the Info Alist,  Up: Top

Reference Headers
*****************

Supercite will insert an informative "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
the original author in non-nested citations.  Whereas the citation
string usually only contains a portion of the original author's name,
the reference header can contain such information as the author's full
name, email address, the original article's subject, etc.  In fact any
information contained in the info alist can be inserted into a reference
header.

* Menu:

* The Built-in Header Rewrite Functions::
* Electric References::

   There are a number of built-in "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
`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 "electric references".  *Note
Electric References::.

   When Supercite is initially run on a reply buffer (via
`sc-cite-original'), it will automatically call one of these functions.
The one it uses is defined in the variable `sc-preferred-header-style'.
The value of this variable is an integer which is an index into the
`sc-rewrite-header-list', beginning at zero.


File: supercite.info,  Node: The Built-in Header Rewrite Functions,  Next: Electric References,  Prev: Reference Headers,  Up: Reference Headers

The Built-in Header Rewrite Functions
=====================================

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 INFOKEY indicates that the corresponding value of the
info key from the info alist will be inserted there.  (*Note
Information Keys and the Info Alist::.).  For example, in
`sc-header-on-said' below, DATE and FROM correspond to the values of the
`Date:' and `From:' mail headers respectively.

   Also, the string `">>>>>"' below is really the value of the variable
`sc-reference-tag-string'.  This variable is used in all built-in
header rewrite functions, and you can customize its value to change the
tag string globally.

   Finally, the references headers actually written may omit certain
parts of the header if the info key associated with INFOKEY is not
present in the info alist.  In fact, for all built-in headers, if the
`From:' field is not present in the mail headers, the entire reference
header will be omitted (but this usually signals a serious problem
either in your MUA or in Supercite's installation).

`sc-no-header'
     This function produces no header. It should be used instead of
     `nil' to produce a blank header.  This header can possibly contain
     a blank line after the `mail-header-separator' line.

`sc-no-blank-line-or-header'
     This function is similar to `sc-no-header' except that any blank
     line after the `mail-header-separator' line will be removed.

`sc-header-on-said'
     `>>>>> On DATE, FROM said:'

`sc-header-inarticle-writes'
     `>>>>> In article MESSAGE-ID, FROM writes:'

`sc-header-regarding-adds'
     `>>>>> Regarding SUBJECT; FROM adds:'

`sc-header-attributed-writes'
     `>>>>> "SC-ATTRIBUTION" == SC-AUTHOR <SC-REPLY-ADDRESS> writes:'

`sc-header-author-writes'
     `>>>>> SC-AUTHOR writes:'

`sc-header-verbose'
     `>>>>> On DATE,'
     `>>>>> SC-AUTHOR'
     `>>>>> from the organization of ORGANIZATION'
     `>>>>> who can be reached at: SC-REPLY-ADDRESS'
     `>>>>> (whose comments are cited below with: "SC-CITE")'
     `>>>>> had this to say in article MESSAGE-ID'
     `>>>>> in newsgroups NEWSGROUPS'
     `>>>>> concerning the subject of SUBJECT'
     `>>>>> see REFERENCES for more details'


File: supercite.info,  Node: Electric References,  Next: Hints to MUA Authors,  Prev: The Built-in Header Rewrite Functions,  Up: Reference Headers

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
`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 "electric reference" mode which you can drop into
to give you this functionality.

   If the variable `sc-electric-references-p' is non-`nil', Supercite
will bring up an electric reference mode buffer and place you into a
recursive edit.  The electric reference buffer is read-only, so you
cannot directly modify the reference text until you exit electric
references and insert the text into the reply buffer.  But you can cycle
through all the reference header rewrite functions in your
`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
reference buffer and the header index and function name will appear in
the echo area.

   The following commands are available while in electric reference mode
(shown here with their default key bindings):

`sc-eref-next' (`n')
     Displays the next reference header in the electric reference
     buffer. If the variable `sc-electric-circular-p' is non-`nil',
     invoking `sc-eref-next' while viewing the last reference header in
     the list will wrap around to the first header.

`sc-eref-prev' (`p')
     Displays the previous reference header in the electric reference
     buffer.  If the variable `sc-electric-circular-p' is non-`nil',
     invoking `sc-eref-prev' will wrap around to the last header.

`sc-eref-goto' (`g')
     Goes to a specified reference header.  The index (into the
     `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.

`sc-eref-jump' (`j')
     Display the preferred reference header, i.e., the one indexed by
     the current value of `sc-preferred-header-style'.

`sc-eref-setn' (`s')
     Set the preferred reference header (i.e.,
     `sc-preferred-header-style') to the currently displayed header.

`sc-eref-exit' (<LFD>, <RET>, and <ESC C-c>)
     Exit from electric reference mode and insert the current header
     into the reply buffer.

`sc-eref-abort' (`q', `x')
     Exit from electric reference mode without inserting the current
     header.

Supercite will execute the hook `sc-electric-mode-hook' before entering
electric reference mode.


File: supercite.info,  Node: Getting Connected,  Next: Emacs 19 MUAs,  Prev: Recognizing Citations,  Up: Top

Getting Connected
*****************

Hitting `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
variable.  The name of this variable has been agreed to in advance as
part of the "citation interface specification".  By default this hook
variable has a `nil' value, which the MUA recognizes to mean, "use your
default citation function".  When you add Supercite's citation function
to the hook, thereby giving the variable a non-`nil' value, it tells
the MUA to run the hook via `run-hooks' instead of using the default
citation.

* 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::

   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 :-).  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.

   To learn exactly how to connect Supercite to the software systems you
are using, read the appropriate following sections.  For details on the
interface specifications, or if you are writing or maintaining an MUA,
*note Hints to MUA Authors::.

   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 "autoload" for Supercite.  To do the latter, put the
following in your `.emacs' file:

     (autoload 'sc-cite-original     "supercite" "Supercite 3.1" t)
     (autoload 'sc-submit-bug-report "supercite" "Supercite 3.1" t)

   The function `sc-cite-original' is the top-level Supercite function
designed to be run from the citation hook.  It expects `point' and
`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 _never_ touches any text outside this region.  Note further
that for Emacs 19, the region need not be active for `sc-cite-original'
to do its job.  *Note Hints to MUA Authors::.

   The other step in the getting connected process is to make sure your
MUA calls `sc-cite-original' at the right time.  As mentioned above,
some MUAs handle this differently.  Read the sections that follow
pertaining to the MUAs you are using.

   One final note.  After Supercite is loaded into your Emacs session,
it runs the hook `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.
In that case, you can use the `sc-pre-hook' variable, but this will get
executed every time `sc-cite-original' is called.  *Note Reply Buffer
Initialization::.


File: supercite.info,  Node: Emacs 19 MUAs,  Next: Emacs 18 MUAs,  Prev: Getting Connected,  Up: Getting Connected

GNUS, RMAIL, or RNEWS with any Emacs 19
=======================================

These MUAs, distributed with both FSF and Lucid GNU Emacs 19, use Emacs'
built-in yanking facility, which provides the citing hook variable
`mail-citation-hook'.  By default, this hook's value is `nil', but by
adding the following to your `.emacs' file, you can tell these MUAs to
use Supercite to perform the citing of the original message:

     (add-hook 'mail-citation-hook 'sc-cite-original)

   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:

     (setq news-reply-header-hook nil)

   Note that the `mail-citation-hook' interface described above was not
supported in FSF Emacs 19 until version 19.16 and in Lucid Emacs 19
until version 19.8.  If you are running an earlier version of one of
these Emacsen, you will need to either upgrade to the latest version, or
use the unsupported "overloading" feature provided with Supercite.
*Note Overloading for Non-conforming MUAs::.


File: supercite.info,  Node: Emacs 18 MUAs,  Next: MH-E with any Emacsen,  Prev: Emacs 19 MUAs,  Up: Getting Connected

GNUS, RMAIL, PCMAIL, RNEWS with Emacs 18 or Epoch 4
===================================================

These MUAs use Emacs' built-in yanking and citing routines, contained in
the `sendmail.el' 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 *note Overloading for Non-conforming MUAs::.
Then follow the directions for using these MUAs under Emacs 19.  *Note
Emacs 19 MUAs::.

   Note that those instructions will tell you to use the function
`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 `setq', or you can use the
`add-hook' function that is provided in the `sc-unsupp.el' file of
unsupported Supercite hacks and ideas.  Or you can upgrade to some
Emacs 19 variant!  :-)

   To use `setq' instead of `add-hook', you would, for example, change
this:

     (add-hook 'mail-citation-hook 'sc-cite-original)

   to:

     (setq mail-citation-hook 'sc-cite-original)

   Note the lack of a single quote on the first argument to `setq'.


File: supercite.info,  Node: MH-E with any Emacsen,  Next: VM with any Emacsen,  Prev: Emacs 18 MUAs,  Up: Getting Connected

MH-E with any Emacsen
=====================

MH-E 4.x conforms to the `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 `.emacs' file to connect
Supercite and MH-E 4.x:

     (add-hook 'mail-citation-hook 'sc-cite-original)

   Note that if you are using Emacs 18 or Epoch 4, you will not have the
`add-hook' function.  *Note Emacs 18 MUAs::, for details on how to
proceed without `add-hook'.

   MH-E version 3.x uses a slightly different interface than other MUAs.
MH-E provides a hook variable `mh-yank-hooks', but it doesn't act like
a hook, and doing an `add-hook' will not work.

   To connect Supercite to MH-E 3.x, you should instead add the
following to your `.emacs' file:

     (add-hook 'mh-yank-hooks 'sc-cite-original)

   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
`mh-yank-from-start-of-msg'.  By default, this variable has the value
`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 `t'.  This
lisp, in your `.emacs' file will do the trick:

     (setq mh-yank-from-start-of-msg t)

   Note that versions of MH-E before 3.7 did not provide the
`mh-yank-hooks' variable.  Your only option is to upgrade to MH-E
version 3.7 or later.


File: supercite.info,  Node: VM with any Emacsen,  Next: GNEWS with any Emacsen,  Prev: MH-E with any Emacsen,  Up: Getting Connected

VM with any Emacsen
===================

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 `.emacs' to connect Supercite with VM:

     (add-hook 'mail-yank-hooks 'sc-cite-original)

   Note that if you are using Emacs 18 or Epoch 4, you will not have the
`add-hook' function.  *Note Emacs 18 MUAs::, for details on how to
proceed without `add-hook'.

   Since version 5.34, VM has supported the newer `mail-citation-hook'
interface, but `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:

     (add-hook 'mail-citation-hook 'sc-cite-original)


File: supercite.info,  Node: GNEWS with any Emacsen,  Next: Overloading for Non-conforming MUAs,  Prev: VM with any Emacsen,  Up: Getting Connected

GNEWS with any Emacsen
======================

As far as I know, no version of GNEWS supports the citation interface
required by Supercite.  To connect Supercite with GNEWS, please first
*note Overloading for Non-conforming MUAs::.

   After you have followed the directions in that section.  You should
add the following lisp code to your `.emacs' file:

     (add-hook 'mail-citation-hook 'sc-cite-original)

   Note that if you are using Emacs 18 or Epoch 4, you will not have the
`add-hook' function.  *Note Emacs 18 MUAs::, for details on how to
proceed without `add-hook'.


File: supercite.info,  Node: Overloading for Non-conforming MUAs,  Next: Replying and Yanking,  Prev: GNEWS with any Emacsen,  Up: Getting Connected

Overloading for Non-conforming MUAs
===================================

As mentioned elsewhere, some MUAs do not provide the necessary hooks to
connect with Supercite.  Supercite version 3.1 provides an unsupported
mechanism, called "overloading" which redefines certain key functions
in the MUA, so that it will call the `mail-citation-hook' variable
instead of the MUA's default hard-coded citing routines.  Since most
newer versions of the known MUAs support the `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.  *Note Emacs 19 MUAs::.

   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 _not_ perform any
overloading if it finds the variable `hyperb:version' is `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, `mail-citation-hook' savvy version.  The function in
`sc-oloads.el' that does this is `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, `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.

   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
`.emacs' file, to make sure the `sc-oloads.el' file gets loaded at the
right time:

     (autoload 'sc-perform-overloads "sc-oloads" "Supercite 3.1" t)

   Then you must make sure that the function `sc-perform-overloads'
gets run at the right time.  For GNUS, put this in your `.emacs' file:

     (setq news-reply-mode-hook 'sc-perform-overloads)
     (setq mail-setup-hook 'sc-perform-overloads)

   If you are using RNEWS, put this in your `.emacs' file:

     (setq news-reply-mode-hook 'sc-perform-overloads)

   If you are using RMAIL or PCMAIL, put this in your `.emacs' file:

     (setq mail-setup-hook 'sc-perform-overloads)

   If you are using GNEWS, put this in your `.emacs' file:

     (setq news-reply-mode-hook 'sc-perform-overloads)
     (setq gnews-ready-hook 'sc-perform-overloads)

   Now go back and follow the directions for getting the Emacs 19 MUAs
connected to Supercite.  Be sure to *note Emacs 18 MUAs:: on substitutes
for Emacs 19's `add-hook' function.


File: supercite.info,  Node: Replying and Yanking,  Next: Reply Buffer Initialization,  Prev: Overloading for Non-conforming MUAs,  Up: Top

Replying and Yanking
********************

This chapter explains what happens when you reply and yank an original
message from an MUA.

* Menu:

* Reply Buffer Initialization::
* Filling Cited Text::


File: supercite.info,  Node: Reply Buffer Initialization,  Next: Filling Cited Text,  Prev: Replying and Yanking,  Up: Replying and Yanking

Reply Buffer Initialization
===========================

Executing `sc-cite-original' performs the following steps as it
initializes the reply buffer:

  1. _Runs `sc-pre-hook'._ This hook variable is run before
     `sc-cite-original' does any other 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).

  2. _Inserts Supercite's keymap._ Supercite provides a number of
     commands for performing post-yank modifications to the reply
     buffer.  These commands are installed on Supercite's top-level
     keymap.  Since Supercite has to interface with a wide variety of
     MUAs, it does not install all of its commands directly into the
     reply buffer's keymap.  Instead, it puts its commands on a keymap
     prefix, then installs this prefix onto the buffer's keymap.  What
     this means is that you typically have to type more characters to
     invoke a Supercite command, but Supercite's keybindings can be
     made much more consistent across MUAs.

     You can control what key Supercite uses as its keymap prefix by
     changing the variable `sc-mode-map-prefix'.  By default, this
     variable is set to `C-c C-p'; a finger twister perhaps, but
     unfortunately the best default due to the scarcity of available
     keybindings in many MUAs.

  3. _Turns on Supercite minor mode._ The modeline of the reply buffer
     should indicate that Supercite is active in that buffer by
     displaying the string `SC'.

  4. _Sets the "Undo Boundary"._ Supercite sets an undo boundary before
     it begins to modify the original yanked text.  This allows you to
     easily undo Supercite's changes to affect alternative citing
     styles.

  5. _Processes the mail headers._ 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, such
     useful information as the author's name and email address are
     extracted.  If the variable `sc-mail-warn-if-non-rfc822-p' is
     non-`nil', then Supercite will warn you if it finds a mail header
     that does not conform to RFC822.  This is rare and indicates a
     problem either with your MUA or the original author's MUA, or some
     MTA (mail transport agent) along the way.

     Once the info keys have been extracted from the mail headers, the
     headers are nuked from the reply buffer.  You can control exactly
     which headers are removed or kept, but by default, all headers are
     removed.

     There are two variables which control mail header nuking.  The
     variable `sc-nuke-mail-headers' controls the overall behavior of
     the header nuking routines.  By setting this variable to `'all',
     you automatically nuke all mail headers.  Likewise, setting this
     variable to `'none' inhibits nuking of any mail headers.  In
     between these extremes, you can tell Supercite to nuke only a
     specified list of mail headers by setting this variable to
     `'specified', or to keep only a specified list of headers by
     setting it to `'keep'.

     If `sc-nuke-mail-headers' is set to `'specified' or `'keep', then
     the variable `sc-nuke-mail-header-list' is consulted for the list
     of headers to nuke or keep.  This variable contains a list of
     regular expressions.  If the mail header line matches a regular
     expression in this list, the header will be nuked or kept.  The
     line is matched against the regexp using `looking-at' rooted at
     the beginning of the line.

     If the variable `sc-blank-lines-after-headers' is non-`nil', it
     contains the number of blank lines remaining in the buffer after
     mail headers are nuked.  By default, only one blank line is left
     in the buffer.

  6. _Selects the attribution and citation strings._ Once the mail
     headers have been processed, Supercite selects a attribution
     string and a citation string which it will use to cite the
     original message.  *Note Selecting an Attribution::, for details.

  7. _Cites the message body._ After the selection of the attribution
     and citation strings, Supercite cites the original message by
     inserting the citation string prefix in front of every uncited
     line.  You may not want Supercite to automatically cite very long
     messages however.  For example, some email could contain a smaller
     header section followed by a huge uuencoded message.  It wouldn't
     make sense to cite the uuencoded message part when responding to
     the original author's short preface.  For this reason, Supercite
     provides a variable which limits the automatic citation of long
     messages to a certain maximum number of lines.  The variable is
     called `sc-cite-region-limit'.  If this variable contains an
     integer, messages with more lines that this will not be cited at
     all, and a warning message will be displayed.  Supercite has
     performed everything necessary, though, for you to manually cite
     only the small portion of the original message that you want to
     use.

     If `sc-cite-region-limit' contains a non-`nil' value, the original
     message will always be cited, regardless of its size.  If the
     variable contains the value `nil', the region will never be cited
     automatically.  Use this if you always want to be able to edit and
     cite the message manually.

     The variable `sc-cite-blank-lines-p' controls whether blank lines
     in the original message should be cited or not.  If this variable
     is non-`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
     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.
     *Note Configuring the Citation Engine::, for details.

  8. _Runs `sc-post-hook'._ This variable is very similar to
     `sc-pre-hook', except that it runs after `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 `sc-pre-hook'.


File: supercite.info,  Node: Filling Cited Text,  Next: Selecting an Attribution,  Prev: Reply Buffer Initialization,  Up: Replying and Yanking

Filling Cited Text
==================

Supercite will automatically fill newly cited text from the original
message unless the variable `sc-auto-fill-region-p' has a `nil' value.
Supercite will also re-fill paragraphs when you manually cite or
re-cite text.

   However, during normal editing, Supercite itself cannot be used to
fill paragraphs.  This is a change from version 2.  There are other
add-on lisp packages which do filling much better than Supercite ever
did.  The two best known are "filladapt" and "gin-mode".  Both work well
with Supercite and both are available at the normal Emacs Lisp archive
sites.  "gin-mode" works pretty well out of the box, but if you use
"filladapt", you may want to run the function `sc-setup-filladapt' from
your `sc-load-hook'.  This simply makes "filladapt" a little more
Supercite savvy than its default setup.

   Also, Supercite will collapse leading whitespace between the citation
string and the text on a line when the variable `sc-fixup-whitespace-p'
is non-`nil'.  The default value for this variable is `nil'.

   Its important to understand that Supercite's automatic filling
(during the initial citation of the reply) is very fragile.  That is
because figuring out the `fill-prefix' for a particular paragraph is a
really hard thing to do automatically.  This is especially the case when
the original message contains code or some other text where leading
whitespace is important to preserve.  For this reason, many Supercite
users typically run with `sc-auto-fill-region-p' (and possibly also
`sc-fixup-whitespace-p') set to `nil'.  They then manually fill each
cited paragraph in the reply buffer.

   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 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.  *Note Variable Toggling Shortcuts::.

   If you find that Supercite's automatic filling is just too fragile
for your tastes, you might consider one of these alternate approaches.
Also, to make life easier, a shortcut function to toggle the state of
both of these variables is provided on the key binding `C-c C-p C-p'
(with the default value of `sc-mode-map-prefix'; *note Post-yank
Formatting Commands::).

   You will noticed that the minor mode string will show the state of
these variables as qualifier characters. When both variables are `nil',
the Supercite minor mode string will display `SC'.  When just
`sc-auto-fill-region-p' is non-`nil', the string will display `SC:f',
and when just `sc-fixup-whitespace-p' is non-`nil', the string will
display `SC:w'.  When both variables are non-`nil', the string will
display `SC:fw'.  Note that the qualifiers chosen are mnemonics for the
default bindings of the toggling function for each respective variable.
*Note Variable Toggling Shortcuts::.

   Why are these variables not set to `nil' by default?  It is because
many users won't manually fill paragraphs that are Supercited, and there
have been widespread complaints on the net about mail and news messages
containing lines greater than about 72 characters.  So the default is to
fill cited text.


File: supercite.info,  Node: Selecting an Attribution,  Next: Attribution Preferences,  Prev: Filling Cited Text,  Up: Top

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
scans the various mail headers present in the original article and uses
a number of heuristics to extract strings which it puts into the
"attribution association list" or "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.

* Menu:

* Attribution Preferences::
* Anonymous Attributions::
* Author Names::


File: supercite.info,  Node: Attribution Preferences,  Next: Anonymous Attributions,  Prev: Selecting an Attribution,  Up: Selecting an Attribution

Attribution Preferences
=======================

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 `sc-preferred-attribution-list' controls this; it contains
keys which are matched against the attribution alist in the given order.
The first value of a key that produces a non-`nil', non-empty string
match is used as the attribution string, and if no keys match, a
secondary mechanism is used to generate the attribution.  *Note
Anonymous Attributions::.

   The following preferences are always available in the attribution
alist (barring error):

`"emailname"'
     the author's email terminus.

`"initials"'
     the author's initials.

`"firstname"'
     the author's first name.

`"lastname"'
     the author's last name.

`"middlename-1"'
     the author's first middle name.

`"sc-lastchoice"'
     the last attribution string you have selected. This is useful when
     you recite paragraphs in the reply.

`"sc-consult"'
     consults the customizable list `sc-attrib-selection-list' which can
     be used to select special attributions based on the value of any
     info key.  See below for details.

`"x-attribution"'
     the original author's suggestion for attribution string choice.
     See below for details.

   Middle name indexes can be any positive integer greater than zero,
though it is unlikely that many authors will have more than one middle
name, if that many.

   At this point, let me digress into a discussion of etiquette.  It is
my belief that while the style of the citations is a reflection of the
personal tastes of the replier (i.e., you), the attribution selection is
ultimately the personal choice of the original author.  In a sense it is
his or her "net nickname", and therefore the author should have some
say in the selection of attribution string.  Imagine how you would feel
if someone gave you a nickname that you didn't like?

   For this reason, Supercite recognizes a special mail header,
`X-Attribution:', which if present, tells Supercite the attribution
string preferred by the original author.  It is the value of this header
that is associated with the `"x-attribution"' key in the attribution
alist.  Currently, you can override the preference of this key by
changing `sc-preferred-attribution-list', but that isn't polite, and in
the future Supercite may hard-code this.  For now, it is suggested that
if you change the order of the keys in this list, that
`"x-attribution"' always be first, or possible second behind only
`"sc-lastchoice"'.  This latter is the default.

   The value `"sc-consult"' in `sc-preferred-attribution-list' has a
special meaning during attribution selection.  When Supercite
encounters this preference, it begins processing a customizable list of
attributions, contained in the variable `sc-attrib-selection-list'.
Each element in this list contains lists of the following form:

     (INFOKEY ((REGEXP . ATTRIBUTION)
              (REGEXP . ATTRIBUTION)
              (...)))

where INFOKEY is a key for `sc-mail-field' and REGEXP is a regular
expression to match against the INFOKEY's value. If REGEXP matches the
INFOKEY's value, the ATTRIBUTION is used as the attribution string.
Actually, ATTRIBUTION can be a string or a list; if it is a list, it is
`eval'uated and the return value (which must be a string), is used as
the attribution.

   This can be very useful for when you are replying to net
acquaintances who do not use the `X-Attribution:' mail header.  You may
know what nickname they would prefer to use, and you can set up this
list to match against a specific mail field, e.g., `From:', allowing you
to cite your friend's message with the appropriate attribution.


File: supercite.info,  Node: Anonymous Attributions,  Next: Author Names,  Prev: Attribution Preferences,  Up: Selecting an Attribution

Anonymous Attributions
======================

When the author's name cannot be found in the `From:' mail header, a
fallback author name and attribution string must be supplied.  The
fallback author name is contained in the variable
`sc-default-author-name' and the fallback attribution string is
contained in the variable `sc-default-attribution'.  Default values for
these variables are `"Anonymous"' and `"Anon"', respectively. Note that
in most circumstances, getting the default author name or attribution
is a sign that something is set up incorrectly.

   Also, if the preferred attribution, which you specified in your
`sc-preferred-attribution-alist' variable cannot be found, a secondary
method can be employed to find a valid attribution string. The variable
`sc-use-only-preference-p' controls what happens in this case.  If the
variable's value is non-`nil', then `sc-default-author-name' and
`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-`nil', non-empty string becomes the attribution:

  1. Use the last selected attribution, if there is one.

  2. Use the value of the `"x-attribution"' key.

  3. Use the author's first name.

  4. Use the author's last name.

  5. Use the author's initials.

  6. Find the first non-`nil', non-empty attribution string in the
     attribution alist.

  7. `sc-default-attribution' is used.

   Once the attribution string has been automatically selected, a
number of things can happen. If the variable `sc-confirm-always-p' is
non-`nil', you are queried for confirmation of the chosen 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 enter becomes the value associated with the `"sc-lastchoice"' key
in the attribution alist.

   Once an attribution string has been selected, Supercite will force
the string to lower case if the variable `sc-downcase-p' is non-`nil'.

   Two hook variables provide even greater control of the attribution
selection process.  The hook `sc-attribs-preselect-hook' is run before
any attribution is selected.  Likewise, the hook
`sc-attribs-postselect-hook' is run after the attribution is selected
(and the corresponding citation string is built), but before these
values are committed for use by Supercite.  During the post-selection
hook, the local variables `attribution' and `citation' are bound to the
appropriate strings.  By changing these 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 `"initials"' but the author only has one
name.


File: supercite.info,  Node: Author Names,  Next: Configuring the Citation Engine,  Prev: Anonymous Attributions,  Up: Selecting an Attribution

Author Names
============

Supercite employs a number of heuristics to decipher the author's name
based on value of the `From:' mail field of the original message.
Supercite can recognize almost all of the common `From:' field formats
in use.  If you encounter a `From:' field that Supercite cannot parse,
please report this bug.  *Note The Supercite Mailing List::.

   There are a number of Supercite variables that control how author
names are extracted from the `From:' header.  Some headers may contain a
descriptive title as in:

     From: computer!speedy!doe (John Xavier-Doe -- Decent Hacker)

   Supercite knows which part of the `From:' header is email address
and which part is author name, but in this case the string `"Decent
Hacker"' is not part of the author's name.  You can tell Supercite to
ignore the title, while still recognizing hyphenated names through the
use of a regular expression in the variable `sc-titlecue-regexp'.  This
variable has the default value of `"\\\\s +-+\\\\s +"'.  Any text after
this regexp is encountered is ignored as noise.

   Some `From:' headers may contain extra titles in the name fields not
separated by a title cue, but which are nonetheless not part of the
author's name proper.  Examples include the titles "Dr.", "Mr.", "Ms.",
"Jr.", "Sr.", and "III" (e.g., Thurston Howe, the Third).  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 `sc-name-filter-alist' 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:

     (REGEXP . POSITION)

where REGEXP is a regular expression that is matched (using
`string-match') against each element of the `From:' field's author
name.  POSITION is a position indicator, starting at zero.  Thus to
strip out all titles of "Dr.", "Mr.", etc. from the name,
`sc-name-filter-alist' would have an entry such as:

     ("^\\(Mr\\|Mrs\\|Ms\\|Dr\\)[.]?$" . 0)

which only removes them if they appear as the first word in the name.
The position indicator is an integer, or one of the two special symbols
`last' or `any'.  `last' always matches against the last word in the
name field, while `any' matches against every word in the name field.


File: supercite.info,  Node: Configuring the Citation Engine,  Next: Using Regi,  Prev: Author Names,  Up: Top

Configuring the Citation Engine
*******************************

At the heart of Supercite is a regular expression interpreting engine
called "Regi".  Regi operates by interpreting a data structure called a
Regi-frame (or just "frame"), which is a list of Regi-entries (or just
"entry").  Each entry contains a predicate, typically a regular
expression, which is matched against a line of text in the current
buffer.  If the predicate matches true, an associated expression is
`eval'uated.  In this way, an entire region of text can be transformed
in an _awk_-like manner.  Regi is used throughout Supercite, from mail
header information extraction, to header nuking, to citing text.

* Menu:

* Using Regi::
* Frames You Can Customize::

   While the details of Regi are discussed below (*note Using Regi::),
only those who wish to customize certain aspects of Supercite need
concern themselves with it.  It is important to understand though, that
any conceivable citation style that can be described by a regular
expression can be recognized by Supercite.  This leads to some
interesting applications.  For example, if you regularly recieve email
from a co-worker that uses an uncommon citation style (say one that
employs a `|' or `}' character at the front of the line), it is
possible for Supercite to recognize this and _coerce_ the citation to
your preferred style, for consistency.  In theory, it is possible for
Supercite to recognize such things as uuencoded messages or C code and
cite or fill those differently than normal text.  None of this is
currently part of Supercite, but contributions are welcome!


File: supercite.info,  Node: Using Regi,  Next: Frames You Can Customize,  Prev: Configuring the Citation Engine,  Up: Configuring the Citation Engine

Using Regi
==========

Regi works by interpreting frames with the function `regi-interpret'.
A frame is a list of arbitrary size where each element is a entry of
the following form:

     (PRED FUNC [NEGATE-P [CASE-FOLD-SEARCH]])

   Regi starts with the first entry in a frame, evaluating the PRED of
that entry against the beginning of the line that `point' is on.  If
the PRED evaluates to true (or false if the optional NEGATE-P is
non-`nil'), then the FUNC for that entry is `eval'uated.  How
processing continues is determined by the return value for FUNC, and is
described below.  If PRED was false the next entry in the frame is
checked until all entries have been matched against the current line.
If no entry matches, `point' is moved forward one line and the frame is
reset to the first entry.

   PRED can be a string, a variable, a list or one of the following
symbols: `t', `begin', `end', or `every'.  If PRED is a string, or a
variable or list that `eval'uates to a string, it is interpreted as a
regular expression.  This regexp is matched against the current line,
from the beginning, using `looking-at'.  This match folds case if the
optional CASE-FOLD-SEARCH is non-`nil'.  If PRED is not a string, or
does not `eval'uate to a string, it is interpreted as a binary value
(`nil' or non-`nil').

   The four special symbol values for PRED are recognized:

`t'
     Always produces a true outcome.

`begin'
     Always executed before the frame is interpreted. This can be used
     to initialize some global variables for example.

`end'
     Always executed after frame interpreting is completed. This can be
     used to perform any necessary post-processing.

`every'
     Executes whenever the frame is reset, usually after the entire
     frame has been matched against the current line.

   Note that NEGATE-P and CASE-FOLD-SEARCH are ignored if PRED is one
of these special symbols.  Only the first occurance of each symbol in a
frame is used; any duplicates are ignored.  Also note that for
performance reasons, the entries associated with these symbols are
removed from the frame during the main interpreting loop.

   Your FUNC can return certain values which control continued Regi
processing.  By default, if your FUNC returns `nil' (as it should be
careful to do explicitly), Regi will reset the frame to the first
entry, and advance `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:

the symbol `continue'
     This tells Regi to continue processing entries after a match,
     instead of reseting the frame and moving `point'. In this way,
     lines of text can have multiple matches, but you have to be
     careful to avoid entering infinite loops.

the symbol `abort'
     This tells Regi to terminate frame processing. However, any `end'
     entry is still processed.

the list `(frame . NEWFRAME)'
     This tells Regi to substitute NEWFRAME as the frame it is
     interpreting.  In other words, your FUNC can modify the Regi frame
     on the fly.  NEWFRAME can be a variable containing a frame, or it
     can be the frame in-lined.

the list `(step . STEP)'
     Tells Regi to move STEP number of lines forward as it continues
     processing. By default, Regi moves forward one line.  STEP can be
     zero or negative of course, but watch out for infinite loops.

   During execution of your FUNC, the following variables will be
temporarily bound to some useful information:

`curline'
     The current line in the buffer that Regi is `looking-at', as a
     string.

`curframe'
     The current frame being interpreted.

`curentry'
     The current frame entry being interpreted.


File: supercite.info,  Node: Frames You Can Customize,  Next: Post-yank Formatting Commands,  Prev: Using Regi,  Up: Configuring the Citation Engine

Frames You Can Customize
========================

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, except
through abstract interfaces such as `sc-nuke-mail-header', et al.

   However, the citation frames Supercite uses provide a lot of
customizing power and are thus available to you to change to suit your
needs.  The workhorse of citation is the frame contained in the variable
`sc-default-cite-frame'.  This frame recognizes many situations, such
as blank lines, which it interprets as paragraph separators.  It also
recognizes previously cited nested and non-nested citations in the
original message.  By default it will coerce non-nested citations into
your preferred citation style, and it will add a level of citation to
nested citations.  It will also simply cite uncited lines in your
preferred style.

   In a similar vein, there are default frames for "unciting" and
"reciting", contained in the variables `sc-default-uncite-frame' and
`sc-default-recite-frame' respectively.

   As mentioned earlier (*note Recognizing Citations::), citations are
recognized through the values of the regular expressions
`sc-citation-root-regexp', et al.  To recognize odd styles, you could
modify these variables, or you could modify the default citing frame.
Alternatively, you could set up association lists of frames for
recognizing specific alternative forms.

   For each of the actions - citing, unciting, and reciting - an alist
is consulted to find the frame to use (`sc-cite-frame-alist',
`sc-uncite-frame-alist', and `sc-recite-frame-alist' respectively).
These frames can contain alists of the form:

     ((INFOKEY (REGEXP . FRAME) (REGEXP . FRAME) ...)
      (INFOKEY (REGEXP . FRAME) (REGEXP . FRAME) ...)
      (...))

   Where INFOKEY is a key suitable for `sc-mail-field', REGEXP is a
regular expression which is `string-match''d against the value of the
`sc-mail-field' key, and FRAME is the frame to use if a match occurred.
FRAME can be a variable 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.


File: supercite.info,  Node: Post-yank Formatting Commands,  Next: Citing Commands,  Prev: Frames You Can Customize,  Up: Top

Post-yank Formatting Commands
*****************************

Once the original message has been yanked into the reply buffer, and
`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
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
variable `sc-mode-map-prefix'.  By default, the `sc-mode-map-prefix' is
`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.

* Menu:

* Citing Commands::
* Insertion Commands::
* Variable Toggling Shortcuts::
* Mail Field Commands::
* Miscellaneous Commands::


File: supercite.info,  Node: Citing Commands,  Next: Insertion Commands,  Prev: Post-yank Formatting Commands,  Up: Post-yank Formatting Commands

Commands to Manually Cite, Recite, and Uncite
=============================================

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
paragraph to use a nickname, or manually cite a message when setting
`sc-cite-region-limit' to `nil'.  The following commands perform these
functions on the region of text between `point' and `mark'.  Each of
them sets the "undo boundary" before modifying the region so that the
command can be undone in the standard Emacs way.

   A quick note about Emacs 19.  Unlike in Emacs 18, the region
delimited by `point' and `mark' can have two states.  It can be
"active" or "inactive".  Although the FSF 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:

`sc-cite-region' (`C-c C-p c')
     This command cites each line in the region of text by interpreting
     the selected frame from `sc-cite-frame-alist', or the default
     citing frame `sc-default-cite-frame'.  It runs the hook
     `sc-pre-cite-hook' before interpreting the frame.  With an optional
     universal argument (`C-u'), it temporarily sets
     `sc-confirm-always-p' to `t' so you can confirm the attribution
     string for a single manual citing.  *Note Configuring the Citation
     Engine::.

`sc-uncite-region' (`C-c C-p u')
     This command removes any citation strings from the beginning of
     each cited line in the region by interpreting the selected frame
     from `sc-uncite-frame-alist', or the default unciting frame
     `sc-default-uncite-frame'.  It runs the hook `sc-pre-uncite-hook'
     before interpreting the frame.  *Note Configuring the Citation
     Engine::.

`sc-recite-region' (`C-c C-p r')
     This command recites each line the region by interpreting the
     selected frame from `sc-recite-frame-alist', or the default
     reciting frame `sc-default-recite-frame'. It runs the hook
     `sc-pre-recite-hook' before interpreting the frame.  *Note
     Configuring the Citation Engine::.

     Supercite will always ask you to confirm the attribution when
     reciting a region, regardless of the value of
     `sc-confirm-always-p'.


File: supercite.info,  Node: Insertion Commands,  Next: Variable Toggling Shortcuts,  Prev: Citing Commands,  Up: Post-yank Formatting Commands

Insertion Commands
==================

These two functions insert various strings into the reply buffer.

`sc-insert-reference' (`C-c C-p w')
     Inserts a reference header into the reply buffer at `point'.  With
     no arguments, the header indexed by `sc-preferred-header-style' is
     inserted. An optional numeric argument is the index into
     `sc-rewrite-header-list' indicating which reference header to
     write.

     With just the universal argument (`C-u'), electric reference mode
     is entered, regardless of the value of `sc-electric-references-p'.

`sc-insert-citation' (`C-c C-p i')
     Inserts the current citation string at the beginning of the line
     that `point' is on.  If the line is already cited, Supercite will
     issue an error and will not cite the line.


File: supercite.info,  Node: Variable Toggling Shortcuts,  Next: Mail Field Commands,  Prev: Insertion Commands,  Up: Post-yank Formatting Commands

Variable Toggling Shortcuts
===========================

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
cleanup, but only temporarily.  These toggling shortcut commands make
this easy to do.

   Like Supercite commands in general, the toggling commands are placed
on a keymap prefix within the greater Supercite keymap.  For the default
value of `sc-mode-map-prefix', this will be `C-c C-p C-t'.

   The following commands toggle the value of certain Supercite
variables which take only a binary value:

`C-c C-p C-t b'
     Toggles the variable `sc-mail-nuke-blank-lines-p'.

`C-c C-p C-t c'
     Toggles the variable `sc-confirm-always-p'.

`C-c C-p C-t d'
     Toggles the variable `sc-downcase-p'.

`C-c C-p C-t e'
     Toggles the variable `sc-electric-references-p'.

`C-c C-p C-t f'
     Toggles the variable `sc-auto-fill-region-p'.

`C-c C-p C-t o'
     Toggles the variable `sc-electric-circular-p'.

`C-c C-p C-t s'
     Toggles the variable `sc-nested-citation-p'.

`C-c C-p C-t u'
     Toggles the variable `sc-use-only-preferences-p'.

`C-c C-p C-t w'
     Toggles the variable `sc-fixup-whitespace-p'.

   The following commands let you set the value of multi-value
variables, in the same way that Emacs' `set-variable' does:

`C-c C-p C-t a'
     Sets the value of the variable `sc-preferred-attribution-list'.

`C-c C-p C-t l'
     Sets the value of the variable `sc-cite-region-limit'.

`C-c C-p C-t n'
     Sets the value of the variable `sc-mail-nuke-mail-headers'.

`C-c C-p C-t N'
     Sets the value of the variable `sc-mail-header-nuke-list'.

`C-c C-p C-t p'
     Sets the value of the variable `sc-preferred-header-style'.

   One special command is provided to toggle both
`sc-auto-fill-region-p' and `sc-fixup-whitespace-p' together.  This is
because you typically want to run Supercite with either variable as
`nil' or non-`nil'.  The command to toggle these variables together is
bound on `C-c C-p C-p'.

   Finally, the command `C-c C-p C-t h' (also `C-c C-p C-t ?') brings
up a Help message on the toggling keymap.


File: supercite.info,  Node: Mail Field Commands,  Next: Miscellaneous Commands,  Prev: Variable Toggling Shortcuts,  Up: Post-yank Formatting Commands

Mail Field Commands
===================

These commands allow you to view, modify, add, and delete various bits
of information from the info alist.  *Note Information Keys and the
Info Alist::.

`sc-mail-field-query' (`C-c C-p f')
     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 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 running the command with no arguments.

     If you want to modify the value of a key, Supercite will first
     prompt 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
     <RET>, the key's value is changed.  For those of you running Emacs
     19, 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.

     If you choose to add a new key-value pair, Supercite firsts
     prompts you for the key to add.  Note that completion is turned on
     for this prompt, but you can type any key name here, even one that
     does not yet exist.  After entering the key, Supercite prompts you
     for the key's value.  It is not an error to enter a key that
     already exists, but the new value will override any old value.  It
     will not replace it though; if you subsequently delete the
     key-value pair, the old value will reappear.

`sc-mail-process-headers' (`C-c C-p g')
     This command lets you re-initialize Supercite's info alist from
     any set of mail headers in the region between `point' and `mark'.
     This function is especially useful for replying to digest messages
     where 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.


File: supercite.info,  Node: Miscellaneous Commands,  Next: Information Keys and the Info Alist,  Prev: Mail Field Commands,  Up: Post-yank Formatting Commands

Miscellaneous Commands
======================

`sc-open-line' (`C-c C-p o')
     Similar to Emacs' standard `open-line' commands, but inserts the
     citation string in front of the new line.  As with `open-line', an
     optional numeric argument inserts that many new lines.

`sc-describe' (`C-c C-p h' and `C-c C-p ?')
     This function has been obsoleted by the TeXinfo manual you are now
     reading. It is still provided for compatibility, but it will
     eventually go away.

`sc-version' (`C-c C-p v')
     Echos the version of Supercite you are using.  With the optional
     universal argument (`C-u'), this command inserts the version
     information into the current buffer.

`sc-submit-bug-report' (`C-c C-p C-b')
     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 `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.


File: supercite.info,  Node: Hints to MUA Authors,  Next: Version 3 Changes,  Prev: Electric References,  Up: Top

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
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
a mail message to the Supercite mailing list:

     	Martin> Each news/mail-reader should provide a form of
     	Martin> mail-yank-original that
     
     	Martin> 1: inserts the original message incl. header into the
     	Martin>    reply buffer; no indentation/prefixing is done, the header
     	Martin>    tends to be a "full blown" version rather than to be
     	Martin>    stripped down.
     
     	Martin> 2: `point' is at the start of the header, `mark' at the
     	Martin>    end of the message body.
     
     	Martin> 3: (run-hooks 'mail-yank-hooks)
     
     	Martin> [Supercite] should be run as such a hook and merely
     	Martin> rewrite the message.  This way it isn't anymore
     	Martin> [Supercite]'s job to gather the original from obscure
     	Martin> sources. [...]

   This specification was adopted, but with the recent release of FSF
GNU Emacs 19, it has undergone a slight modification.  Instead of the
variable `mail-yank-hooks', the new preferred hook variable that the
MUA should provide is `mail-citation-hook'.  `mail-yank-hooks' can be
provided for backward compatibility, but `mail-citation-hook' should
always take precedence.  Richard Stallman (of the FSF) suggests that
the MUAs should `defvar' `mail-citation-hook' to `nil' and perform some
default citing when that is the case.  Take a look at Emacs 19's
`sendmail.el' file, specifically the `mail-yank-original' defun for
details.

   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
setting up a reply or forward buffer, your MUA should follow these
steps:

  1. 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, 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 `mail-header-separator' line and
     one copy below, however there will probably be more headers below
     this line.

  2. Set `point' to the beginning of the line containing the first mail
     header in the body of the reply. Set `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 *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.

  3. Run the hook `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 `defvar' `mail-citation-hook' to `nil', and in your yanking
     function, check its value.  If it finds `mail-citation-hook' to be
     `nil', it should perform some default citing behavior.  User who
     want to connect to Supercite then need only add `sc-cite-original'
     to this list of hooks using `add-hook'.

   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."


File: supercite.info,  Node: Version 3 Changes,  Next: Thanks and History,  Prev: Hints to MUA Authors,  Up: Top

Version 3 Changes
*****************

With version 3, Supercite has undergone an almost complete rewrite, and
has hopefully benefitted 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.

  1. Supercite proper now comes in a single 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 `reporter.el' and `regi.el'.
     Finally, the TeXinfo manual comes in its own file as well.  In
     particular, the file `sc.el' from the version 2 distribution is
     obsolete, as is the file `sc-elec.el'.

  2. `sc-spacify-name-chars' is gone in version 3.

  3. `sc-nickname-alist' is gone in version 3.  The
     `sc-attrib-selection-list' is a more general construct supporting
     the same basic feature.

  4. The version 2 variable `sc-preferred-attribution' has been changed
     to `sc-preferred-attribution-list', and has been expanded upon to
     allow you to specify an ordered list of preferred attributions.

  5. `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.

  6. 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.

  7. The variable `sc-all-but-cite-p' has been replaced by
     `sc-cite-region-limit'.

  8. Keymap hacking in the reply buffer has been greatly simplified,
     with, I believe, little reduction in functionality.

  9. Hacking of the reply buffer's docstring has been completely
     eliminated.


File: supercite.info,  Node: Thanks and History,  Next: The Supercite Mailing List,  Prev: Version 3 Changes,  Up: Top

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
non-nested citations and implemented some rough code to provide this
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.

   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 support is greatly appreciated.  I wish to thank everyone on
the Supercite mailing list, especially the brave alpha testers, who
helped considerably in testing out the concepts and implementation of
Supercite version 3.  Special thanks go out to the MUA and Emacs
authors Kyle Jones, Stephen Gildea, Richard Stallman, and Jamie
Zawinski for coming to a quick agreement on the new
`mail-citation-hook' interface, and for adding the magic lisp to their
code to support this.

   All who have helped and contributed have been greatly appreciated.


File: supercite.info,  Node: The Supercite Mailing List,  Next: Concept Index,  Prev: Thanks and History,  Up: Top

The Supercite Mailing List
**************************

Supercite is currently an orphan, and the mailing list has been
decommissioned (see the message from the author below).  The XEmacs
package version of Supercite is maintained by the XEmacs Development
Team, and you may contact them by filing a bug report with `M-x
report-emacs-bug', or by mailing to the XEmacs Developers' mailing list,
`xemacs-beta@xemacs.org'.

   The Supercite mailing list has been replaced with an autoresponder;
the message it returns follows.

     From: The Python Replybot <replybot@python.org>
     Subject: Supercite
     
     On 01-Nov-1999 I decommissioned the supercite@python.org mailing list.
     I no longer have time to support or develop Supercite, so it is best
     that any further discussion of the package occur on the related GNU
     Emacs newsgroups and/or mailing lists.  The Supercite archives will be
     retained for posterity.  You can find them at
     
         http://www.python.org/pipermail/supercite
     
     I thank everyone who's helped me improve Supercite over the years, and
     given me very valuable feedback, bug fixes, suggestions, code
     contributions, etc.
     
     Recently, I made available my last snapshot of an alpha version of
     Supercite 4.0.  This is essentially what I use every day, and it shows
     the direction I was taking the development when my other duties and
     interests forced me to stop working on the code.  It would be cool if
     someone else was fired up enough to adopt Supercite.  You can grab the
     4.0 alpha snapshot by visiting
     
         http://www.python.org/~bwarsaw/betas/
     
     If you would like to adopt Supercite, please contact me first at
     supercite-help@python.org.  Please do not send me other questions
     about Supercite -- I will probably ignore them.
     
     -Barry

   If you would like to take over maintenance of the Supercite package,
but are worried about infrastructure issues (like CVS repository,
mailing lists, FTP distribution, a home page, and so on), one obvious
approach would be to create a Supercite project at SourceForge
(`http://www.sourceforge.net/').  However, another approach would be to
use the XEmacs facilities, since we already maintain a Supercite
package.  Contact the XEmacs Development Team for information.


File: supercite.info,  Node: Concept Index,  Next: Command Index,  Prev: The Supercite Mailing List,  Up: Top

Concept Index
*************

* Menu:

* .emacs file <1>:                       MH-E with any Emacsen.
* .emacs file <2>:                       Getting Connected.
* .emacs file <3>:                       Emacs 19 MUAs.
* .emacs file <4>:                       Emacs 18 MUAs.
* .emacs file <5>:                       Overloading for Non-conforming MUAs.
* .emacs file:                           VM with any Emacsen.
* add-hook substitute:                   Emacs 18 MUAs.
* attribute, attributing:                Usage Overview.
* attribution info field (sc-):          Information Keys and the Info Alist.
* attribution list:                      Selecting an Attribution.
* attribution string:                    Citation Elements.
* author info field (sc-):               Information Keys and the Info Alist.
* author names:                          Author Names.
* autoload:                              Getting Connected.
* citation:                              Citations.
* citation delimiter:                    Citation Elements.
* citation info field (sc-):             Information Keys and the Info Alist.
* citation interface specification:      Getting Connected.
* citation leader:                       Citation Elements.
* citation separator:                    Citation Elements.
* citation string:                       Citation Elements.
* cite, citing:                          Usage Overview.
* electric references:                   Electric References.
* emailname info field (sc-):            Information Keys and the Info Alist.
* entries (Regi):                        Configuring the Citation Engine.
* filladapt <1>:                         Filling Cited Text.
* filladapt:                             What Supercite Does.
* filling paragraphs:                    Filling Cited Text.
* firstname info field (sc-):            Information Keys and the Info Alist.
* frames (Regi):                         Configuring the Citation Engine.
* from-address info field (sc-):         Information Keys and the Info Alist.
* gin-mode <1>:                          What Supercite Does.
* gin-mode:                              Filling Cited Text.
* header rewrite functions:              Reference Headers.
* header rewrite functions, built-in:    The Built-in Header Rewrite Functions.
* Hyperbole:                             Overloading for Non-conforming MUAs.
* Info Alist:                            Information Keys and the Info Alist.
* info alist:                            What Supercite Does.
* information extracted from mail fields: Information Keys and the Info Alist.
* information keys:                      Information Keys and the Info Alist.
* initials info field (sc-):             Information Keys and the Info Alist.
* keymap prefix:                         Reply Buffer Initialization.
* lastname info field (sc-):             Information Keys and the Info Alist.
* mail-citation-hook:                    MH-E with any Emacsen.
* mailing list address:                  The Supercite Mailing List.
* mark:                                  Getting Connected.
* middlename-1 info field (sc-):         Information Keys and the Info Alist.
* modeline <1>:                          What Supercite Does.
* modeline:                              Reply Buffer Initialization.
* MUA:                                   Introduction.
* nested citations:                      Citations.
* non-nested citations:                  Citations.
* NUA:                                   Introduction.
* nuking mail headers:                   What Supercite Does.
* overloading <1>:                       Overloading for Non-conforming MUAs.
* overloading:                           Emacs 18 MUAs.
* point:                                 Getting Connected.
* reciting:                              Frames You Can Customize.
* reference header:                      What Supercite Does.
* reference headers:                     Reference Headers.
* Regi:                                  Configuring the Citation Engine.
* regi.el file:                          Version 3 Changes.
* reply-address info field (sc-):        Information Keys and the Info Alist.
* reporter.el file:                      Version 3 Changes.
* sc-attribution info field:             Information Keys and the Info Alist.
* sc-author info field:                  Information Keys and the Info Alist.
* sc-citation info field:                Information Keys and the Info Alist.
* sc-elec.el from version 2:             Version 3 Changes.
* sc-emailname info field:               Information Keys and the Info Alist.
* sc-firstname info field:               Information Keys and the Info Alist.
* sc-from-address info field:            Information Keys and the Info Alist.
* sc-initials info field:                Information Keys and the Info Alist.
* sc-lastname info field:                Information Keys and the Info Alist.
* sc-middlename-1 info field:            Information Keys and the Info Alist.
* sc-oloads.el:                          Overloading for Non-conforming MUAs.
* sc-reply-address info field:           Information Keys and the Info Alist.
* sc-sender-address info field:          Information Keys and the Info Alist.
* sc-unsupp.el file <1>:                 Emacs 18 MUAs.
* sc-unsupp.el file:                     Version 3 Changes.
* sc.el from version 2:                  Version 3 Changes.
* sender-address info field (sc-):       Information Keys and the Info Alist.
* sendmail.el:                           Hints to MUA Authors.
* sendmail.el file:                      Emacs 18 MUAs.
* setq as a substitute for add-hook:     Emacs 18 MUAs.
* supercite mailing list address:        The Supercite Mailing List.
* supercite.el file:                     Version 3 Changes.
* toggling variables:                    Variable Toggling Shortcuts.
* unciting:                              Frames You Can Customize.
* undo boundary:                         Reply Buffer Initialization.
* yank:                                  Usage Overview.


File: supercite.info,  Node: Command Index,  Next: Key Index,  Prev: Concept Index,  Up: Top

Command Index
*************

Since all supercite commands are prepended with the string "`sc-'",
each appears under its `sc-'COMMAND name and its COMMAND name.

* Menu:

* add-hook <1>:                          MH-E with any Emacsen.
* add-hook:                              Emacs 18 MUAs.
* cite-original (sc-) <1>:               Reply Buffer Initialization.
* cite-original (sc-):                   Getting Connected.
* cite-region (sc-):                     Citing Commands.
* defvar:                                Hints to MUA Authors.
* describe (sc-):                        Miscellaneous Commands.
* eref-abort (sc-):                      Electric References.
* eref-exit (sc-):                       Electric References.
* eref-goto (sc-):                       Electric References.
* eref-jump (sc-):                       Electric References.
* eref-next (sc-):                       Electric References.
* eref-prev (sc-):                       Electric References.
* eref-setn (sc-):                       Electric References.
* eval:                                  Using Regi.
* fill-paragraph:                        What Supercite Does.
* header-attributed-writes (sc-):        The Built-in Header Rewrite Functions.
* header-author-writes (sc-):            The Built-in Header Rewrite Functions.
* header-inarticle-writes (sc-):         The Built-in Header Rewrite Functions.
* header-on-said (sc-):                  The Built-in Header Rewrite Functions.
* header-regarding-adds (sc-):           The Built-in Header Rewrite Functions.
* header-verbose (sc-):                  The Built-in Header Rewrite Functions.
* insert-citation (sc-):                 Insertion Commands.
* insert-reference (sc-):                Insertion Commands.
* looking-at:                            Using Regi.
* mail-field (sc-) <1>:                  Attribution Preferences.
* mail-field (sc-):                      Information Keys and the Info Alist.
* mail-field-query (sc-):                Mail Field Commands.
* mail-process-headers (sc-):            Mail Field Commands.
* mail-yank-original:                    Hints to MUA Authors.
* no-blank-line-or-header (sc-):         The Built-in Header Rewrite Functions.
* no-header (sc-):                       The Built-in Header Rewrite Functions.
* open-line:                             Miscellaneous Commands.
* open-line (sc-):                       Miscellaneous Commands.
* perform-overloads (sc-):               GNEWS with any Emacsen.
* recite-region (sc-):                   Citing Commands.
* regi-interpret:                        Using Regi.
* sc-cite-original <1>:                  Getting Connected.
* sc-cite-original <2>:                  Reply Buffer Initialization.
* sc-cite-original:                      What Supercite Does.
* sc-cite-region:                        Citing Commands.
* sc-describe:                           Miscellaneous Commands.
* sc-eref-abort:                         Electric References.
* sc-eref-exit:                          Electric References.
* sc-eref-goto:                          Electric References.
* sc-eref-jump:                          Electric References.
* sc-eref-next:                          Electric References.
* sc-eref-prev:                          Electric References.
* sc-eref-setn:                          Electric References.
* sc-header-attributed-writes:           The Built-in Header Rewrite Functions.
* sc-header-author-writes:               The Built-in Header Rewrite Functions.
* sc-header-inarticle-writes:            The Built-in Header Rewrite Functions.
* sc-header-on-said:                     The Built-in Header Rewrite Functions.
* sc-header-regarding-adds:              The Built-in Header Rewrite Functions.
* sc-header-verbose:                     The Built-in Header Rewrite Functions.
* sc-insert-citation:                    Insertion Commands.
* sc-insert-reference:                   Insertion Commands.
* sc-mail-field <1>:                     Attribution Preferences.
* sc-mail-field:                         Information Keys and the Info Alist.
* sc-mail-field-query:                   Mail Field Commands.
* sc-mail-process-headers:               Mail Field Commands.
* sc-no-blank-line-or-header:            The Built-in Header Rewrite Functions.
* sc-no-header:                          The Built-in Header Rewrite Functions.
* sc-open-line:                          Miscellaneous Commands.
* sc-perform-overloads <1>:              GNEWS with any Emacsen.
* sc-perform-overloads:                  Overloading for Non-conforming MUAs.
* sc-recite-region:                      Citing Commands.
* sc-setup-filladapt:                    Filling Cited Text.
* sc-submit-bug-report <1>:              Getting Connected.
* sc-submit-bug-report:                  Miscellaneous Commands.
* sc-uncite-region:                      Citing Commands.
* sc-version:                            Miscellaneous Commands.
* set-variable:                          Variable Toggling Shortcuts.
* setq:                                  Emacs 18 MUAs.
* setup-filladapt (sc-):                 Filling Cited Text.
* string-match:                          Frames You Can Customize.
* submit-bug-report (sc-) <1>:           Getting Connected.
* submit-bug-report (sc-):               Miscellaneous Commands.
* uncite-region (sc-):                   Citing Commands.
* version (sc-):                         Miscellaneous Commands.


File: supercite.info,  Node: Key Index,  Next: Variable Index,  Prev: Command Index,  Up: Top

Key Index
*********

* Menu:

* C-c C-p <1>:                           Reply Buffer Initialization.
* C-c C-p:                               Post-yank Formatting Commands.
* C-c C-p ?:                             Miscellaneous Commands.
* C-c C-p c:                             Citing Commands.
* C-c C-p C-b:                           Miscellaneous Commands.
* C-c C-p C-p <1>:                       Variable Toggling Shortcuts.
* C-c C-p C-p:                           Filling Cited Text.
* C-c C-p C-t:                           Variable Toggling Shortcuts.
* C-c C-p f:                             Mail Field Commands.
* C-c C-p g:                             Mail Field Commands.
* C-c C-p h:                             Miscellaneous Commands.
* C-c C-p i:                             Insertion Commands.
* C-c C-p o:                             Miscellaneous Commands.
* C-c C-p r:                             Citing Commands.
* C-c C-p u:                             Citing Commands.
* C-c C-p v:                             Miscellaneous Commands.
* C-c C-p w:                             Insertion Commands.
* C-c C-y:                               Usage Overview.
* C-u:                                   Citing Commands.
* f:                                     Usage Overview.
* g:                                     Electric References.
* j:                                     Electric References.
* LFD:                                   Electric References.
* n:                                     Electric References.
* p:                                     Electric References.
* q:                                     Electric References.
* r:                                     Usage Overview.
* RET:                                   Electric References.
* s:                                     Electric References.
* x:                                     Electric References.


File: supercite.info,  Node: Variable Index,  Prev: Key Index,  Up: Top

Variable Index
**************

Since all supercite variables are prepended with the string "`sc-'",
each appears under its `sc-'VARIABLE name and its VARIABLE name.

* Menu:

* attrib-selection-list:                 Version 3 Changes.
* attrib-selection-list (sc-):           Attribution Preferences.
* attribs-postselect-hook (sc-):         Anonymous Attributions.
* attribs-preselect-hook (sc-):          Anonymous Attributions.
* auto-fill-region-p (sc-):              Filling Cited Text.
* blank-lines-after-headers (sc-):       Reply Buffer Initialization.
* citation-delimiter (sc-):              Citation Elements.
* citation-delimiter-regexp (sc-):       Recognizing Citations.
* citation-leader (sc-):                 Citation Elements.
* citation-leader-regexp (sc-):          Recognizing Citations.
* citation-nonnested-root-regexp (sc-):  Recognizing Citations.
* citation-root-regexp (sc-):            Recognizing Citations.
* citation-separator (sc-):              Citation Elements.
* citation-separator-regexp (sc-):       Recognizing Citations.
* cite-blank-lines-p (sc-):              Reply Buffer Initialization.
* cite-region-limit:                     Version 3 Changes.
* cite-region-limit (sc-)b:              Reply Buffer Initialization.
* confirm-always-p:                      Citing Commands.
* confirm-always-p (sc-) <1>:            Anonymous Attributions.
* confirm-always-p (sc-) <2>:            Citing Commands.
* confirm-always-p (sc-):                Reply Buffer Initialization.
* default-attribution (sc-):             Anonymous Attributions.
* default-author-name (sc-):             Anonymous Attributions.
* downcase-p (sc-):                      Anonymous Attributions.
* electric-circular-p (sc-):             Electric References.
* electric-mode-hook (sc-):              Electric References.
* electric-references-p (sc-):           Electric References.
* fill-prefix <1>:                       Filling Cited Text.
* fill-prefix:                           What Supercite Does.
* fixup-whitespace-p (sc-):              Filling Cited Text.
* gnews-ready-hook:                      GNEWS with any Emacsen.
* hyperb:version:                        Overloading for Non-conforming MUAs.
* load-hook (sc-) <1>:                   Filling Cited Text.
* load-hook (sc-):                       Getting Connected.
* mail-citation-hook <1>:                VM with any Emacsen.
* mail-citation-hook <2>:                Hints to MUA Authors.
* mail-citation-hook <3>:                Overloading for Non-conforming MUAs.
* mail-citation-hook <4>:                Emacs 18 MUAs.
* mail-citation-hook:                    Emacs 19 MUAs.
* mail-header-separator:                 What Supercite Does Not Do.
* mail-warn-if-non-rfc822-p (sc-):       Reply Buffer Initialization.
* mail-yank-hooks <1>:                   Hints to MUA Authors.
* mail-yank-hooks:                       VM with any Emacsen.
* mh-yank-from-start-of-msg:             MH-E with any Emacsen.
* mh-yank-hooks:                         MH-E with any Emacsen.
* mode-map-prefix (sc-) <1>:             Reply Buffer Initialization.
* mode-map-prefix (sc-):                 Post-yank Formatting Commands.
* mumble (sc-):                          Information Keys and the Info Alist.
* name-filter-alist (sc-):               Author Names.
* nested-citation-p (sc-):               Citations.
* news-reply-mode-hook <1>:              GNEWS with any Emacsen.
* news-reply-mode-hook:                  Overloading for Non-conforming MUAs.
* nuke-mail-header-list (sc-):           Reply Buffer Initialization.
* nuke-mail-headers (sc-):               Reply Buffer Initialization.
* post-hook (sc-):                       Reply Buffer Initialization.
* pre-cite-hook (sc-):                   Citing Commands.
* pre-hook (sc-) <1>:                    Getting Connected.
* pre-hook (sc-):                        Reply Buffer Initialization.
* preferred-attribution-list (sc-):      Selecting an Attribution.
* preferred-header-style (sc-) <1>:      Reference Headers.
* preferred-header-style (sc-):          Insertion Commands.
* reference-tag-string (sc-):            The Built-in Header Rewrite Functions.
* rewrite-header-list (sc-):             Reference Headers.
* sc-attrib-selection-list <1>:          Version 3 Changes.
* sc-attrib-selection-list:              Attribution Preferences.
* sc-attribs-postselect-hook:            Anonymous Attributions.
* sc-attribs-preselect-hook:             Anonymous Attributions.
* sc-auto-fill-region-p:                 Filling Cited Text.
* sc-blank-lines-after-headers:          Reply Buffer Initialization.
* sc-citation-delimiter:                 Citation Elements.
* sc-citation-delimiter-regexp:          Recognizing Citations.
* sc-citation-leader:                    Citation Elements.
* sc-citation-leader-regexp:             Recognizing Citations.
* sc-citation-nonnested-root-regexp:     Recognizing Citations.
* sc-citation-root-regexp:               Recognizing Citations.
* sc-citation-separator:                 Citation Elements.
* sc-citation-separator-regexp:          Recognizing Citations.
* sc-cite-blank-lines-p:                 Reply Buffer Initialization.
* sc-cite-frame-alist:                   Frames You Can Customize.
* sc-cite-region-limit <1>:              Citing Commands.
* sc-cite-region-limit <2>:              Reply Buffer Initialization.
* sc-cite-region-limit:                  Version 3 Changes.
* sc-confirm-always-p <1>:               Citing Commands.
* sc-confirm-always-p <2>:               Anonymous Attributions.
* sc-confirm-always-p <3>:               Reply Buffer Initialization.
* sc-confirm-always-p:                   Citing Commands.
* sc-default-attribution:                Anonymous Attributions.
* sc-default-author-name:                Anonymous Attributions.
* sc-default-cite-frame:                 Frames You Can Customize.
* sc-default-recite-frame:               Frames You Can Customize.
* sc-default-uncite-frame:               Frames You Can Customize.
* sc-downcase-p:                         Anonymous Attributions.
* sc-electric-circular-p:                Electric References.
* sc-electric-mode-hook:                 Electric References.
* sc-electric-references-p:              Electric References.
* sc-fixup-whitespace-p:                 Filling Cited Text.
* sc-load-hook <1>:                      Getting Connected.
* sc-load-hook:                          Filling Cited Text.
* sc-mail-field:                         Frames You Can Customize.
* sc-mail-warn-if-non-rfc822-p:          Reply Buffer Initialization.
* sc-mode-map-prefix <1>:                Reply Buffer Initialization.
* sc-mode-map-prefix:                    Post-yank Formatting Commands.
* sc-mumble:                             Information Keys and the Info Alist.
* sc-name-filter-alist:                  Author Names.
* sc-nested-citation-p:                  Citations.
* sc-nuke-mail-header:                   Frames You Can Customize.
* sc-nuke-mail-header-list:              Reply Buffer Initialization.
* sc-nuke-mail-headers:                  Reply Buffer Initialization.
* sc-post-hook:                          Reply Buffer Initialization.
* sc-pre-cite-hook:                      Citing Commands.
* sc-pre-hook <1>:                       Reply Buffer Initialization.
* sc-pre-hook:                           Getting Connected.
* sc-preferred-attribution-list:         Selecting an Attribution.
* sc-preferred-header-style <1>:         Reference Headers.
* sc-preferred-header-style:             Insertion Commands.
* sc-recite-frame-alist:                 Frames You Can Customize.
* sc-reference-tag-string:               The Built-in Header Rewrite Functions.
* sc-rewrite-header-list:                Reference Headers.
* sc-titlecue-regexp:                    Author Names.
* sc-uncite-frame-alist:                 Frames You Can Customize.
* sc-use-only-preference-p:              Anonymous Attributions.
* titlecue-regexp (sc-):                 Author Names.
* use-only-preference-p (sc-):           Anonymous Attributions.



Tag Table:
Node: Top591
Node: Introduction1303
Node: Usage Overview3284
Node: What Supercite Does Not Do4450
Node: What Supercite Does5586
Node: Citations8422
Node: Citation Elements10720
Node: Recognizing Citations12607
Node: Information Keys and the Info Alist14661
Node: Reference Headers17261
Node: The Built-in Header Rewrite Functions18835
Node: Electric References21290
Node: Getting Connected24174
Node: Emacs 19 MUAs27700
Node: Emacs 18 MUAs28939
Node: MH-E with any Emacsen30299
Node: VM with any Emacsen32068
Node: GNEWS with any Emacsen33140
Node: Overloading for Non-conforming MUAs33871
Node: Replying and Yanking37129
Node: Reply Buffer Initialization37473
Node: Filling Cited Text44363
Node: Selecting an Attribution47840
Node: Attribution Preferences48706
Node: Anonymous Attributions52626
Node: Author Names55671
Node: Configuring the Citation Engine58163
Node: Using Regi59896
Node: Frames You Can Customize63773
Node: Post-yank Formatting Commands66305
Node: Citing Commands67459
Node: Insertion Commands70188
Node: Variable Toggling Shortcuts71132
Node: Mail Field Commands73495
Node: Miscellaneous Commands75871
Node: Hints to MUA Authors77147
Node: Version 3 Changes81203
Node: Thanks and History83909
Node: The Supercite Mailing List85514
Node: Concept Index87978
Node: Command Index94148
Node: Key Index99708
Node: Variable Index101711

End Tag Table
