Re: registry doc patch

[Katsumi Yamaoka <yamaoka@jpl.org>]

[-- Attachment #1: Type: text/plain, Size: 751 bytes --]

>>>>> Ted Zlatanov wrote:
> Please let me know if you have corrections or it needs more detail
> anywhere.

Thank you for uploading the Gnus Registry manual.  It will be
very useful for those who want to start using the registry (I'm
not an exception ;-).  When having been translating the manual
into Japanese[1], I found some oddities there.

The menu entry had better be put in the `Top' node, too.

Conventionally `t' and `nil' are quoted with @code{} at least in
the Gnus manual (even though they aren't so in a doc string).

Some Lisp symbols used in values of the gnus-registry- variables
aren't quoted.  Or they are quoted as if they are in Lisp forms.

A patch is attached below.

Regards,

[1] http://cvs.m17n.org/viewcvs/root/gnus-doc-ja/


[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #2: Type: text/x-patch, Size: 3662 bytes --]

--- gnus.texi~	2008-09-16 21:41:21 +0000
+++ gnus.texi	2008-09-18 23:17:52 +0000
@@ -827,6 +827,7 @@
 * Fuzzy Matching::              What's the big fuzz?
 * Thwarting Email Spam::        Simple ways to avoid unsolicited commercial email.
 * Spam Package::                A package for filtering and processing spam.
+* The Gnus Registry::           A package for tracking messages by Message-ID.
 * Other modes::                 Interaction with other modes.
 * Various Various::             Things that are really various.
 
@@ -26606,13 +26607,13 @@
 
 @defvar gnus-registry-use-long-group-names
 Whether the registry will use long group names.  It's recommended to
-set this to t, although everything works if you don't.  Future
+set this to @code{t}, although everything works if you don't.  Future
 functionality will require it.
 @end defvar
 
 @defvar gnus-registry-max-entries
-The number (an integer or nil for unlimited) of entries the registry
-will keep.
+The number (an integer or @code{nil} for unlimited) of entries the
+registry will keep.
 @end defvar
 
 @defvar gnus-registry-cache-file
@@ -26627,7 +26628,7 @@
 Every message has a Message-ID, which is unique, and the registry
 remembers it.  When the message is moved or copied, the registry will
 notice this and offer the new group as a choice to the splitting
-strategy.  
+strategy.
 
 When a followup is made, usually it mentions the original message's
 Message-ID in the headers.  The registry knows this and uses that
@@ -26651,17 +26652,17 @@
 
 @defvar gnus-registry-track-extra
 This is a list of symbols, so it's best to change it from the
-Customize interface.  By default it's nil, but you may want to track
-subject and sender as well when splitting by parent.  It may work
-for you.  It can be annoying if your mail flow is large and people
-don't stick to the same groups.
+Customize interface.  By default it's @code{nil}, but you may want to
+track @code{subject} and @code{sender} as well when splitting by parent.
+It may work for you.  It can be annoying if your mail flow is large and
+people don't stick to the same groups.
 @end defvar
 
 @defvar gnus-registry-split-strategy
 This is a symbol, so it's best to change it from the Customize
-interface.  By default it's nil, but you may want to set it to
-@code{'majority} or @code{'first} to split by sender or subject based
-on the majority of matches or on the first found.
+interface.  By default it's @code{nil}, but you may want to set it to
+@code{majority} or @code{first} to split by sender or subject based on
+the majority of matches or on the first found.
 @end defvar
 
 @node Store custom flags and keywords
@@ -26678,9 +26679,10 @@
 it or evaluate the specific macros you'll need, but you probably don't
 want to bother).  Use the Customize interface to modify the list.
 
-By default this list has the Important, Work, Personal, To-Do, and
-Later marks.  They all have keyboard shortcuts like @kbd{M M i} for
-Important, using the first letter.
+By default this list has the @code{Important}, @code{Work},
+@code{Personal}, @code{To-Do}, and @code{Later} marks.  They all have
+keyboard shortcuts like @kbd{M M i} for Important, using the first
+letter.
 @end defvar
 
 @defun gnus-registry-mark-article
@@ -26712,7 +26714,7 @@
 If any extra entries are precious, their presence will make the
 registry keep the whole entry forever, even if there are no groups for
 the Message-ID and if the size limit of the registry is reached.  By
-default this is just @code{'(marks)} so the custom registry marks are
+default this is just @code{(marks)} so the custom registry marks are
 precious.
 @end defvar