\input texinfo @comment -*-texinfo-*-
@comment 3.48
@comment %**start of header (This is for running Texinfo on a region.)
-@setfilename ../../info/sc
+@setfilename ../../info/sc.info
@settitle Supercite User's Manual
+@documentencoding UTF-8
@iftex
@finalout
@end iftex
This document describes Supercite, an Emacs package for citing and
attributing replies to mail and news messages.
-Copyright @copyright{} 1993, 2001--2013 Free Software Foundation, Inc.
+Copyright @copyright{} 1993, 2001--2014 Free Software Foundation, Inc.
@quotation
Permission is granted to copy, distribute and/or modify this document
under the terms of the GNU Free Documentation License, Version 1.3 or
any later version published by the Free Software Foundation; with no
-Invariant Sections, with the Front-Cover texts being ``A GNU Manual'',
+Invariant Sections, with the Front-Cover Texts being ``A GNU Manual'',
and with the Back-Cover Texts as in (a) below. A copy of the license
is included in the section entitled ``GNU Free Documentation License''.
be able to yank (and cite) only a portion of the original message.
Since Supercite only modifies the text it finds in the reply buffer as
set up by the MUA, it is the MUA's responsibility to do partial yanking.
-@xref{Reply Buffer Initialization}.@refill
+@xref{Reply Buffer Initialization}.
@vindex mail-header-separator
Another potentially useful thing would be for Supercite to set up the
bodies cannot be modified by Supercite. Supercite, in fact, doesn't
know anything about the meaning of these headers, and never ventures
outside the designated region. @xref{Hints to MUA Authors}, for more
-details.@refill
+details.
@node What Supercite Does
@section What Supercite Does
@code{sc-cite-original} has been added. When @code{sc-cite-original} is
executed, the original message must be set up in a very specific way,
but this is handled automatically by the MUA@. @xref{Hints to MUA
-Authors}.@refill
+Authors}.
@cindex info alist
The first thing Supercite does, via @code{sc-cite-original}, is to parse
through the original message's mail headers. It saves this data in an
@dfn{information association list}, or @dfn{info alist}. The information
in this list is used in a number of places throughout Supercite.
-@xref{Information Keys and the Info Alist}.@refill
+@xref{Information Keys and the Info Alist}.
@cindex nuking mail headers
@cindex reference header
filling routines, e.g., @code{fill-paragraph}, do not recognize cited
text and will not re-fill them properly because it cannot guess the
@code{fill-prefix} being used.
-@xref{Post-yank Formatting Commands}, for details.@refill
+@xref{Post-yank Formatting Commands}, for details.
As mentioned above, Supercite provides commands to recite or uncite
regions of text in the reply buffer, and commands to perform other
as possible to allow for a wide range of personalized citation styles,
but it is also immediately useful with the default configuration, once
it has been properly connected to your MUA@. @xref{Getting Connected},
-for more details.@refill
+for more details.
@node Citations
@chapter Citations
The @dfn{attribution string}. This element is supplied automatically by
Supercite, based on your preferences and the original message's mail
headers, though you may be asked to confirm Supercite's choice.
-@xref{Selecting an Attribution}, for more details.@refill
+@xref{Selecting an Attribution}, for more details.
@cindex citation delimiter
@vindex sc-citation-delimiter
something like
@code{@asis{" Jane> "}}.
This citation string will be inserted in front of
-every line in the original message that is not already cited.@refill
+every line in the original message that is not already cited.
Nested citations, being simpler than non-nested citations, are composed
of the same elements, sans the attribution string. Supercite is smart
@code{sc-citation-nonnested-root-regexp} is used to describe only
non-nested citation roots. It is important to remember that if you
change @code{sc-citation-root-regexp} you should always also change
-@code{sc-citation-nonnested-root-regexp}.@refill
+@code{sc-citation-nonnested-root-regexp}.
@node Information Keys and the Info Alist
@chapter Information Keys and the Info Alist
the trailing colon. Info keys are always case insensitive (as are
mail headers), and the value for a corresponding key can be retrieved
from the alist with the @code{sc-mail-field} function. Thus, if the
-following fields were present in the original article:@refill
+following fields were present in the original article:
@example
Date:@: 08 April 1991, 17:32:09 EST
If the author's name has more than one middle name, they will appear as
info keys with the appropriate index (e.g., @code{"sc-middlename-2"},
-@dots{}). @xref{Selecting an Attribution}.@refill
+@dots{}). @xref{Selecting an Attribution}.
@node Reference Headers
@chapter Reference Headers
of the info key from the info alist will be inserted there.
(@pxref{Information Keys and the Info Alist}). For example, in @code{sc-header-on-said}
below, @var{date} and @var{from} correspond to the values of the
-@samp{Date:@:} and @samp{From:@:} mail headers respectively.@refill
+@samp{Date:@:} and @samp{From:@:} mail headers respectively.
@vindex sc-reference-tag-string
@vindex reference-tag-string (sc-)
Displays the next reference header in the electric reference buffer. If
the variable @code{sc-electric-circular-p} is non-@code{nil}, invoking
@code{sc-eref-next} while viewing the last reference header in the list
-will wrap around to the first header.@refill
+will wrap around to the first header.
@item @code{sc-eref-prev} (@kbd{p})
@findex sc-eref-prev
@kindex p
Displays the previous reference header in the electric reference buffer.
If the variable @code{sc-electric-circular-p} is non-@code{nil},
-invoking @code{sc-eref-prev} will wrap around to the last header.@refill
+invoking @code{sc-eref-prev} will wrap around to the last header.
@item @code{sc-eref-goto} (@kbd{g})
@findex sc-eref-goto
Goes to a specified reference header. The index (into the
@code{sc-rewrite-header-list}) can be specified as a numeric argument to
the command. Otherwise, Supercite will query you for the index in the
-minibuffer.@refill
+minibuffer.
@item @code{sc-eref-jump} (@kbd{j})
@findex sc-eref-jump
@findex eref-setn (sc-)
@kindex s
Set the preferred reference header (i.e.,
-@code{sc-preferred-header-style}) to the currently displayed header.@refill
+@code{sc-preferred-header-style}) to the currently displayed header.
@item @code{sc-eref-exit} (@kbd{C-j}, @key{RET}, and @key{ESC C-c})
@kindex RET
@findex sc-eref-exit
@findex eref-exit (sc-)
Exit from electric reference mode and insert the current header into the
-reply buffer.@refill
+reply buffer.
@item @code{sc-eref-abort} (@kbd{q}, @kbd{x})
@findex sc-eref-abort
``use your default citation function.'' When you add Supercite's
citation function to the hook, thereby giving the variable a
non-@code{nil} value, it tells the MUA to run the hook via
-@code{run-hooks} instead of using the default citation.@refill
+@code{run-hooks} instead of using the default citation.
Early in Supercite's development, the Supercite author, a few MUA
authors, and some early Supercite users got together and agreed upon a
region. Note that Supercite @emph{never} touches any text outside this
region. Note further that the region need not be active
for @code{sc-cite-original} to do its job.
-@xref{Hints to MUA Authors}.@refill
+@xref{Hints to MUA Authors}.
The other step in the getting connected process is to make sure your
MUA calls @code{sc-cite-original} at the right time. As mentioned
your Emacs maintainer has put Supercite into your dumped Emacs image.
In that case, you can use the @code{sc-pre-hook} variable, but this will
get executed every time @code{sc-cite-original} is called. @xref{Reply
-Buffer Initialization}.@refill
+Buffer Initialization}.
@node Replying and Yanking
@chapter Replying and Yanking
work. You could conceivably use this hook to set certain Supercite
variables based on the reply buffer's mode or name (i.e., to do
something different based on whether you are replying or following up to
-an article).@refill
+an article).
@item
@emph{Inserts Supercite's keymap.}
Supercite to anticipate every style in existence, and you probably
wouldn't encounter them all anyway. But you can configure Supercite to
recognize those styles you see often.
-@xref{Configuring the Citation Engine}, for details.@refill
+@xref{Configuring the Citation Engine}, for details.
@item
@emph{Runs @code{sc-post-hook}.}
This variable is very similar to @code{sc-pre-hook}, except that it runs
after @code{sc-cite-original} is finished. This hook is provided mostly
for completeness and backward compatibility. Perhaps it could be used to
-reset certain variables set in @code{sc-pre-hook}.@refill
+reset certain variables set in @code{sc-pre-hook}.
@end enumerate
@node Filling Cited Text
Also, Supercite will collapse leading whitespace between the citation
string and the text on a line when the variable
@code{sc-fixup-whitespace-p} is non-@code{nil}. The default value for
-this variable is @code{nil}.@refill
+this variable is @code{nil}.
@vindex fill-prefix
Its important to understand that Supercite's automatic filling (during
will use Emacs's undo feature to undo back before the citation was
applied to the original message. Then I'll toggle the variables and
manually cite those paragraphs that I don't want to fill or collapse
-whitespace on. @xref{Variable Toggling Shortcuts}.@refill
+whitespace on. @xref{Variable Toggling Shortcuts}.
@kindex C-c C-p C-p
If you find that Supercite's automatic filling is just too fragile for
Also, to make life easier, a shortcut function to toggle the state of
both of these variables is provided on the key binding
@kbd{C-c C-p C-p} (with the default value of @code{sc-mode-map-prefix};
-@pxref{Post-yank Formatting Commands}).@refill
+@pxref{Post-yank Formatting Commands}).
You will noticed that the minor mode string will
show the state of these variables as qualifier characters. When both
display @samp{SC:fw}. Note that the qualifiers chosen are mnemonics for
the default bindings of the toggling function for each respective
variable.
-@xref{Variable Toggling Shortcuts}.@refill
+@xref{Variable Toggling Shortcuts}.
Why are these variables not set to @code{nil} by default? It is because
many users won't manually fill paragraphs that are Supercited, and there
@item "sc-lastchoice"
the last attribution string you have selected. This is useful when you
-recite paragraphs in the reply.@refill
+recite paragraphs in the reply.
@item "sc-consult"
@vindex sc-attrib-selection-list
@item "x-attribution"
the original author's suggestion for attribution string choice. See below
-for details.@refill
+for details.
@end table
Middle name indexes can be any positive integer greater than zero,
@code{sc-default-author-name} and @code{sc-default-attribution} are
used, otherwise, the following steps are taken to find a valid
attribution string, and the first step to return a non-@code{nil},
-non-empty string becomes the attribution:@refill
+non-empty string becomes the attribution:
@enumerate
@item
citation strings used by Supercite. One possible use of this would be
to override any automatically derived attribution string when it is only
one character long; e.g., you prefer to use @code{"initials"} but the
-author only has one name.@refill
+author only has one name.
@node Author Names
@section Author Names
@code{looking-at}. This match folds case if the optional
@var{case-fold-search} is non-@code{nil}. If @var{pred} is not a
string, or does not @code{eval}uate to a string, it is interpreted as a
-binary value (@code{nil} or non-@code{nil}).@refill
+binary value (@code{nil} or non-@code{nil}).
The four special symbol values for @var{pred} are recognized:
should be careful to do explicitly), Regi will reset the frame to the
first entry, and advance @samp{point} to the beginning of the next line.
If a list is returned from your function, it can contain any combination
-of the following elements:@refill
+of the following elements:
@table @asis
@item the symbol @code{continue}
This tells Regi to substitute @var{newframe} as the frame it is
interpreting. In other words, your @var{func} can modify the Regi frame
on the fly. @var{newframe} can be a variable containing a frame, or it
-can be the frame in-lined.@refill
+can be the frame in-lined.
@item the list @code{(step . @var{step})}
Tells Regi to move @var{step} number of lines forward as it continues
processing. By default, Regi moves forward one line. @var{step} can be
-zero or negative of course, but watch out for infinite loops.@refill
+zero or negative of course, but watch out for infinite loops.
@end table
During execution of your @var{func}, the following variables will be
-temporarily bound to some useful information:@refill
+temporarily bound to some useful information:
@table @code
@item curline
In a similar vein, there are default frames for @dfn{unciting} and
@dfn{reciting}, contained in the variables
@code{sc-default-uncite-frame} and @code{sc-default-recite-frame}
-respectively.@refill
+respectively.
As mentioned earlier (@pxref{Recognizing Citations}), citations are
recognized through the values of the regular expressions
@var{regexp} is a regular expression which is @code{string-match}'d
against the value of the @code{sc-mail-field} key, and @var{frame} is
the frame to use if a match occurred. @var{frame} can be a variable
-containing a frame or a frame in-lined.@refill
+containing a frame or a frame in-lined.
When Supercite is about to cite, uncite, or recite a region, it consults
the appropriate alist and attempts to find a frame to use. If one
@code{sc-mode-map-prefix} is @kbd{C-c C-p}; granted, not a great choice,
but unfortunately the best general solution so far. In the rest of this
chapter, we'll assume you've installed Supercite's keymap on the default
-prefix.@refill
+prefix.
@menu
* Citing Commands::
perform these functions on the region of text between @samp{point} and
@samp{mark}. Each of them sets the @dfn{undo boundary} before modifying
the region so that the command can be undone in the standard Emacs
-way.@refill
+way.
Here is the list of Supercite citing commands:
universal argument (@kbd{C-u}), it temporarily sets
@code{sc-confirm-always-p} to @code{t} so you can confirm the
attribution string for a single manual citing.
-@xref{Configuring the Citation Engine}.@refill
+@xref{Configuring the Citation Engine}.
@findex sc-uncite-region
@findex uncite-region (sc-)
@code{sc-uncite-frame-alist}, or the default unciting frame
@code{sc-default-uncite-frame}. It runs the hook
@code{sc-pre-uncite-hook} before interpreting the frame.
-@xref{Configuring the Citation Engine}.@refill
+@xref{Configuring the Citation Engine}.
@findex sc-recite-region
@findex recite-region (sc-)
frame from @code{sc-recite-frame-alist}, or the default reciting frame
@code{sc-default-recite-frame}. It runs the hook
@code{sc-pre-recite-hook} before interpreting the frame.
-@xref{Configuring the Citation Engine}.@refill
+@xref{Configuring the Citation Engine}.
@vindex sc-confirm-always-p
@vindex confirm-always-p (sc-)
no arguments, the header indexed by @code{sc-preferred-header-style} is
inserted. An optional numeric argument is the index into
@code{sc-rewrite-header-list} indicating which reference header to
-write.@refill
+write.
With just the universal argument (@kbd{C-u}), electric reference mode is
entered, regardless of the value of @code{sc-electric-references-p}.
Like Supercite commands in general, the toggling commands are placed on
a keymap prefix within the greater Supercite keymap. For the default
value of @code{sc-mode-map-prefix}, this will be
-@kbd{C-c C-p C-t}.@refill
+@kbd{C-c C-p C-t}.
The following commands toggle the value of certain Supercite variables
which take only a binary value:
@code{sc-auto-fill-region-p} and @code{sc-fixup-whitespace-p} together.
This is because you typically want to run Supercite with either variable
as @code{nil} or non-@code{nil}. The command to toggle these variables
-together is bound on @kbd{C-c C-p C-p}.@refill
+together is bound on @kbd{C-c C-p C-p}.
Finally, the command @kbd{C-c C-p C-t h} (also @kbd{C-c C-p C-t ?})
brings up a Help message on the toggling keymap.
These commands allow you to view, modify, add, and delete various bits
of information from the info alist.
-@xref{Information Keys and the Info Alist}.@refill
+@xref{Information Keys and the Info Alist}.
@table @asis
@kindex C-c C-p f
Supercite will initially set up its information for the digest
originator, but you want to cite each component article with the real
message author. Note that unless an error during processing occurs, any
-old information is lost.@refill
+old information is lost.
@end table
@node Miscellaneous Commands
@item @code{sc-open-line} (@kbd{C-c C-p o})
Similar to Emacs's standard @code{open-line} commands, but inserts the
citation string in front of the new line. As with @code{open-line},
-an optional numeric argument inserts that many new lines.@refill
+an optional numeric argument inserts that many new lines.
@end table
@node Hints to MUA Authors
@code{mail-yank-hooks}, the hook variable that the MUA should provide is
@code{mail-citation-hook}. Richard Stallman suggests that the MUAs
should @code{defvar} @code{mail-citation-hook} to @code{nil} and perform
-some default citing when that is the case.@refill
+some default citing when that is the case.
If you are writing a new MUA package, or maintaining an existing MUA
package, you should make it conform to this interface so that your users
you should place all the original headers into the body of the reply.
This means that many of the mail headers will be duplicated, one copy
above the @code{mail-header-separator} line and one copy below, however
-there will probably be more headers below this line.@refill
+there will probably be more headers below this line.
@item
Set @samp{point} to the beginning of the line containing the first mail
text Supercite is to modify and that the mail headers are within this
region. Supercite will not venture outside the region for any reason,
and anything within the region is fair game, so don't put anything that
-@strong{must} remain unchanged inside the region.@refill
+@strong{must} remain unchanged inside the region.
@item
Run the hook @code{mail-citation-hook}. You will probably want to
@code{mail-citation-hook} to be @code{nil}, it should perform some
default citing behavior. User who want to connect to Supercite then
need only add @code{sc-cite-original} to this list of hooks using
-@code{add-hook}.@refill
+@code{add-hook}.
@end enumerate
If you do all this your MUA will join the ranks of those that conform to