Bug 4771 - website improvement: database of detailed rule descriptions
Summary: website improvement: database of detailed rule descriptions
Alias: None
Product: Spamassassin
Classification: Unclassified
Component: Building & Packaging (show other bugs)
Version: unspecified
Hardware: Other other
: P5 enhancement
Target Milestone: 3.1.8
Assignee: SpamAssassin Developer Mailing List
: 5213 (view as bug list)
Depends on:
Reported: 2006-01-26 00:23 UTC by Justin Mason
Modified: 2006-12-04 11:17 UTC (History)
1 user (show)

Attachment Type Modified Status Actions Submitter/CLA Status

Note You need to log in before you can comment on or make changes to this bug.
Description Justin Mason 2006-01-26 00:23:39 UTC
It'd be nice to have a way for users/admins/interested parties to have an easy
way to look up a human-readable description of rules, based on the rule name;
something like:


  A sending IP address is listed in the NJABL [link] blocklist as a member of an
ISP's dynamic IP address pool.  Normally these addresses should not deliver mail
directly to other ISPs.  (Click [here] for more info on dynamic IP pools.)

An easy way to implement this would be simply to use a prefix on
wiki.apache.org/spamassassin, e.g. have the above as


Moin has good support for templates; for example, see
http://moinmoin.wikiwikiweb.de/MoinMoinPatch and the way it creates subpages for
patches using a standardized patch-page template.

Doing a lookup of that would be pretty trivial; a CGI that simply redirects to

I wouldn't expect all the rules to be given description pages, but some could do
with them, and we don't have a lot of info there right now.
Comment 1 Justin Mason 2006-04-01 23:25:38 UTC
here's a template for those pages:
http://wiki.apache.org/spamassassin/RuleDescriptionTemplate -- and a demo list
page: http://wiki.apache.org/spamassassin/RulesList .
Comment 2 Theo Van Dinter 2006-11-29 16:32:30 UTC
*** Bug 5213 has been marked as a duplicate of this bug. ***
Comment 3 Justin Mason 2006-12-04 11:17:22 UTC
ok, this has been implemented on the site as of today; go forth and wikify,
anyone who fancies documenting some of the more confusing rules ;)