[Top][All Lists]
[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]
[Emacs-diffs] /srv/bzr/emacs/trunk r108410: * doc/misc/sc.texi: Nuke han
From: |
Glenn Morris |
Subject: |
[Emacs-diffs] /srv/bzr/emacs/trunk r108410: * doc/misc/sc.texi: Nuke hand-written node pointers. |
Date: |
Mon, 28 May 2012 16:28:27 -0700 |
User-agent: |
Bazaar (2.5.0) |
------------------------------------------------------------
revno: 108410
committer: Glenn Morris <address@hidden>
branch nick: trunk
timestamp: Mon 2012-05-28 16:28:27 -0700
message:
* doc/misc/sc.texi: Nuke hand-written node pointers.
Fix top-level menu to match actual node order.
modified:
doc/misc/ChangeLog
doc/misc/sc.texi
=== modified file 'doc/misc/ChangeLog'
--- a/doc/misc/ChangeLog 2012-05-27 02:30:29 +0000
+++ b/doc/misc/ChangeLog 2012-05-28 23:28:27 +0000
@@ -1,3 +1,8 @@
+2012-05-28 Glenn Morris <address@hidden>
+
+ * sc.texi: Nuke hand-written node pointers.
+ Fix top-level menu to match actual node order.
+
2012-05-27 Glenn Morris <address@hidden>
* cl.texi, dired-x.texi: Nuke hand-written node pointers.
=== modified file 'doc/misc/sc.texi'
--- a/doc/misc/sc.texi 2012-02-28 08:17:21 +0000
+++ b/doc/misc/sc.texi 2012-05-28 23:28:27 +0000
@@ -52,9 +52,8 @@
@contents
@ifnottex
address@hidden Top, Introduction, (dir), (dir)
address@hidden Top
@top Supercite
address@hidden node-name, next, previous, up
@insertcopying
@@ -64,13 +63,13 @@
@menu
* Introduction::
* Citations::
+* Information Keys and the Info Alist::
+* Reference Headers::
* Getting Connected::
* Replying and Yanking::
* Selecting an Attribution::
* Configuring the Citation Engine::
* Post-yank Formatting Commands::
-* Information Keys and the Info Alist::
-* Reference Headers::
* Hints to MUA Authors::
* Thanks and History::
@@ -83,7 +82,7 @@
@end ifnottex
address@hidden Introduction, Usage Overview, Top, Top
address@hidden Introduction
@chapter Introduction
Supercite is a GNU Emacs package written entirely in Emacs Lisp. It
@@ -113,14 +112,14 @@
sent. Supercite is re-initialized in each new reply buffer.
address@hidden Usage Overview, What Supercite Does Not Do, Introduction,
Introduction
address@hidden Usage Overview
address@hidden Usage Overview
@kindex r
@kindex f
@kindex C-c C-y
@cindex yank
@cindex cite, citing
@cindex attribute, attributing
address@hidden Usage Overview
Typical usage is as follows. You want to reply or followup to a message
in your MUA. You will probably hit @kbd{r} (i.e., ``reply'') or @kbd{f}
@@ -138,7 +137,7 @@
using Supercite you gain a wider flexibility in the look and style of
citations. Supercite's only job is to cite the original message.
address@hidden What Supercite Does Not Do, What Supercite Does, Usage
Overview, Introduction
address@hidden What Supercite Does Not Do
@section What Supercite Doesn't Do
Because of this clear division of labor, there are useful features which
@@ -159,9 +158,9 @@
outside the designated region. @xref{Hints to MUA Authors}, for more
address@hidden
address@hidden What Supercite Does, Citations, What Supercite Does Not Do,
Introduction
address@hidden sc-cite-original
address@hidden What Supercite Does
@section What Supercite Does
address@hidden sc-cite-original
Supercite is invoked for the first time on a reply buffer via your MUA's
reply or forward command. This command will actually perform citations
@@ -219,10 +218,10 @@
it has been properly connected to your MUA. @xref{Getting Connected},
for more address@hidden
address@hidden Citations, Citation Elements, What Supercite Does, Top
address@hidden Citations
address@hidden Citations
@cindex nested citations
@cindex citation
address@hidden Citations
A @dfn{citation} is the acknowledgement of the original author of a mail
message in the body of the reply. There are two basic citation styles
@@ -284,9 +283,9 @@
are used.
address@hidden Citation Elements, Recognizing Citations, Citations, Citations
address@hidden Citation Elements
address@hidden Citation Elements
@cindex citation string
address@hidden Citation Elements
@dfn{Citation strings} are composed of one or more elements. Non-nested
citations are composed of four elements, three of which are directly
@@ -339,7 +338,7 @@
enough to not put additional spaces between citation delimiters for
multi-level nested citations.
address@hidden Recognizing Citations, Getting Connected, Citation Elements,
Citations
address@hidden Recognizing Citations
@section Recognizing Citations
Supercite also recognizes citations in the original article, and can
@@ -383,13 +382,13 @@
change @code{sc-citation-root-regexp} you should always also change
@address@hidden
address@hidden Information Keys and the Info Alist, Reference Headers,
Miscellaneous Commands, Top
address@hidden Information Keys and the Info Alist
address@hidden Information Keys and the Info Alist
@cindex information keys
@cindex Info Alist
@cindex information extracted from mail fields
@findex sc-mail-field
@findex mail-field (sc-)
address@hidden Information Keys and the Info Alist
@dfn{Mail header information keys} are nuggets of information that
Supercite extracts from the various mail headers of the original
@@ -493,9 +492,9 @@
info keys with the appropriate index (e.g., @code{"sc-middlename-2"},
@dots{}). @xref{Selecting an address@hidden
address@hidden Reference Headers, The Built-in Header Rewrite Functions,
Information Keys and the Info Alist, Top
address@hidden Reference Headers
address@hidden Reference Headers
@cindex reference headers
address@hidden Reference Headers
Supercite will insert an informative @dfn{reference header} at the
beginning of the cited body of text, which display more detail about the
@@ -534,9 +533,9 @@
integer which is an index into the @code{sc-rewrite-header-list},
beginning at zero.
address@hidden The Built-in Header Rewrite Functions, Electric References,
Reference Headers, Reference Headers
address@hidden The Built-in Header Rewrite Functions
address@hidden The Built-in Header Rewrite Functions
@cindex header rewrite functions, built-in
address@hidden 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
@@ -613,9 +612,9 @@
@code{>>>>> see @var{references} for more details}
@end table
address@hidden Electric References, Hints to MUA Authors, The Built-in Header
Rewrite Functions, Reference Headers
address@hidden Electric References
address@hidden Electric References
@cindex electric references
address@hidden 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
@@ -709,10 +708,9 @@
Supercite will execute the hook @code{sc-electric-mode-hook} before
entering electric reference mode.
address@hidden Getting Connected, Replying and Yanking, Recognizing Citations,
Top
address@hidden Getting Connected
address@hidden Getting Connected
@cindex citation interface specification
address@hidden Getting Connected
-
@vindex mail-citation-hook
@cindex .emacs file
@@ -791,7 +789,7 @@
get executed every time @code{sc-cite-original} is called. @xref{Reply
Buffer address@hidden
address@hidden Replying and Yanking, Reply Buffer Initialization, Getting
Connected, Top
address@hidden Replying and Yanking
@chapter Replying and Yanking
@ifinfo
@@ -803,10 +801,10 @@
* Filling Cited Text::
@end menu
@end ifinfo
address@hidden Reply Buffer Initialization, Filling Cited Text, Replying and
Yanking, Replying and Yanking
address@hidden sc-cite-original
address@hidden cite-original (sc-)
address@hidden Reply Buffer Initialization
@section Reply Buffer Initialization
address@hidden sc-cite-original
address@hidden cite-original (sc-)
Executing @code{sc-cite-original} performs the following steps as it
initializes the reply buffer:
@@ -960,7 +958,8 @@
reset certain variables set in @address@hidden
@end enumerate
address@hidden Filling Cited Text, Selecting an Attribution, Reply Buffer
Initialization, Replying and Yanking
address@hidden Filling Cited Text
address@hidden Filling Cited Text
@cindex filling paragraphs
@vindex sc-auto-fill-region-p
@vindex auto-fill-region-p (sc-)
@@ -970,7 +969,6 @@
@findex setup-filladapt (sc-)
@vindex sc-load-hook
@vindex load-hook (sc-)
address@hidden Filling Cited Text
Supercite will automatically fill newly cited text from the original
message unless the variable @code{sc-auto-fill-region-p} has a
@@ -1039,11 +1037,11 @@
containing lines greater than about 72 characters. So the default is to
fill cited text.
address@hidden Selecting an Attribution, Attribution Preferences, Filling
Cited Text, Top
address@hidden Selecting an Attribution
address@hidden Selecting an Attribution
@cindex attribution list
@vindex sc-preferred-attribution-list
@vindex preferred-attribution-list (sc-)
address@hidden 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
@@ -1063,7 +1061,7 @@
@end menu
@end ifinfo
address@hidden Attribution Preferences, Anonymous Attributions, Selecting an
Attribution, Selecting an Attribution
address@hidden Attribution Preferences
@section Attribution Preferences
When you cite an original message, you can tell Supercite which part of
@@ -1165,12 +1163,12 @@
match against a specific mail field, e.g., @samp{From:@:}, allowing you
to cite your friend's message with the appropriate attribution.
address@hidden Anonymous Attributions, Author Names, Attribution Preferences,
Selecting an Attribution
address@hidden Anonymous Attributions
address@hidden Anonymous Attributions
@vindex sc-default-author-name
@vindex default-author-name (sc-)
@vindex sc-default-attribution
@vindex default-attribution (sc-)
address@hidden Anonymous Attributions
When the author's name cannot be found in the @samp{From:@:} mail
header, a fallback author name and attribution string must be supplied.
@@ -1254,9 +1252,9 @@
one character long; e.g. you prefer to use @code{"initials"} but the
author only has one address@hidden
address@hidden Author Names, Configuring the Citation Engine, Anonymous
Attributions, Selecting an Attribution
address@hidden Author Names
address@hidden Author Names
@cindex author names
address@hidden Author Names
Supercite employs a number of heuristics to decipher the author's name
based on value of the @samp{From:@:} mail field of the original message.
@@ -1316,11 +1314,11 @@
word in the name field, while @code{any} matches against every word in
the name field.
address@hidden Configuring the Citation Engine, Using Regi, Author Names, Top
address@hidden Configuring the Citation Engine
address@hidden Configuring the Citation Engine
@cindex Regi
@cindex frames (Regi)
@cindex entries (Regi)
address@hidden Configuring the Citation Engine
At the heart of Supercite is a regular expression interpreting engine
called @dfn{Regi}. Regi operates by interpreting a data structure
@@ -1354,11 +1352,11 @@
cite or fill those differently than normal text. None of this is
currently part of Supercite, but contributions are welcome!
address@hidden Using Regi, Frames You Can Customize, Configuring the Citation
Engine, Configuring the Citation Engine
address@hidden Using Regi
address@hidden Using Regi
@findex regi-interpret
@findex eval
@findex looking-at
address@hidden Using Regi
Regi works by interpreting frames with the function
@code{regi-interpret}. A frame is a list of arbitrary size where each
@@ -1452,9 +1450,9 @@
The current frame entry being interpreted.
@end table
address@hidden Frames You Can Customize, Post-yank Formatting Commands, Using
Regi, Configuring the Citation Engine
address@hidden Frames You Can Customize
address@hidden Frames You Can Customize
@vindex sc-nuke-mail-header
address@hidden Frames You Can Customize
As mentioned earlier, Supercite uses various frames to perform
certain jobs such as mail header information extraction and mail header
@@ -1516,11 +1514,11 @@
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.
address@hidden Post-yank Formatting Commands, Citing Commands, Frames You Can
Customize, Top
address@hidden sc-mode-map-prefix
address@hidden mode-map-prefix (sc-)
address@hidden C-c C-p
address@hidden Post-yank Formatting Commands
@chapter Post-yank Formatting Commands
address@hidden sc-mode-map-prefix
address@hidden mode-map-prefix (sc-)
address@hidden C-c C-p
Once the original message has been yanked into the reply buffer, and
@code{sc-cite-original} has had a chance to do its thing, a number of
@@ -1546,9 +1544,9 @@
@end menu
@end ifinfo
address@hidden Citing Commands, Insertion Commands, Post-yank Formatting
Commands, Post-yank Formatting Commands
address@hidden sc-cite-region-limit
address@hidden Citing Commands
@section Commands to Manually Cite, Recite, and Uncite
address@hidden sc-cite-region-limit
Probably the three most common post-yank formatting operations that you
will perform will be the manual citing, reciting, and unciting of
@@ -1608,7 +1606,7 @@
region, regardless of the value of @code{sc-confirm-always-p}.
@end table
address@hidden Insertion Commands, Variable Toggling Shortcuts, Citing
Commands, Post-yank Formatting Commands
address@hidden Insertion Commands
@section Insertion Commands
These two functions insert various strings into the reply buffer.
@@ -1638,9 +1636,9 @@
an error and will not cite the line.
@end table
address@hidden Variable Toggling Shortcuts, Mail Field Commands, Insertion
Commands, Post-yank Formatting Commands
address@hidden Variable Toggling Shortcuts
address@hidden Variable Toggling Shortcuts
@cindex toggling variables
address@hidden 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
@@ -1718,7 +1716,7 @@
brings up a Help message on the toggling keymap.
address@hidden Mail Field Commands, Miscellaneous Commands, Variable Toggling
Shortcuts, Post-yank Formatting Commands
address@hidden Mail Field Commands
@section Mail Field Commands
These commands allow you to view, modify, add, and delete various bits
@@ -1768,7 +1766,7 @@
old information is address@hidden
@end table
address@hidden Miscellaneous Commands, Information Keys and the Info Alist,
Mail Field Commands, Post-yank Formatting Commands
address@hidden Miscellaneous Commands
@section Miscellaneous Commands
@table @asis
@@ -1782,7 +1780,7 @@
an optional numeric argument inserts that many new address@hidden
@end table
address@hidden Hints to MUA Authors, Thanks and History, Electric References,
Top
address@hidden Hints to MUA Authors
@chapter Hints to MUA Authors
In June of 1989, some discussion was held between the various MUA
@@ -1864,7 +1862,7 @@
If you do all this your MUA will join the ranks of those that conform to
this interface ``out of the box.''
address@hidden Thanks and History, GNU Free Documentation License, Hints to MUA
Authors, Top
address@hidden Thanks and History
@chapter Thanks and History
The Supercite package was derived from its predecessor Superyank 1.11
@@ -1901,15 +1899,15 @@
Supercite was written by Barry Warsaw.
address@hidden GNU Free Documentation License, Concept Index, Thanks and
History, Top
address@hidden GNU Free Documentation License
@appendix GNU Free Documentation License
@include doclicense.texi
address@hidden Concept Index, Command Index, GNU Free Documentation License,
Top
address@hidden Concept Index
@unnumbered Concept Index
@printindex cp
address@hidden Command Index, Key Index, Concept Index, Top
address@hidden Command Index
@unnumbered Command Index
@ifinfo
@@ -1922,11 +1920,11 @@
@end iftex
@printindex fn
address@hidden Key Index, Variable Index, Command Index, Top
address@hidden Key Index
@unnumbered Key Index
@printindex ky
address@hidden Variable Index, , Key Index, Top
address@hidden Variable Index
@unnumbered Variable Index
@ifinfo
[Prev in Thread] |
Current Thread |
[Next in Thread] |
- [Emacs-diffs] /srv/bzr/emacs/trunk r108410: * doc/misc/sc.texi: Nuke hand-written node pointers.,
Glenn Morris <=