[TWiki-Dev] [SVN] CrawfordCurrie r15505 - twiki/branches/TWikiRelease04x02/twikiplugins/MailerContrib/data/TWiki

[<de...@de...>]

Author: CrawfordCurrie
Date: 2007-11-06 11:17:35 -0600 (Tue, 06 Nov 2007)
New Revision: 15505

Modified:
   twiki/branches/TWikiRelease04x02/twikiplugins/MailerContrib/data/TWiki/MailerContrib.txt
Log:
Item4934: removed POD from the doc (makes it too hard to read)

Modified: twiki/branches/TWikiRelease04x02/twikiplugins/MailerContrib/data/TWiki/MailerContrib.txt
===================================================================
--- twiki/branches/TWikiRelease04x02/twikiplugins/MailerContrib/data/TWiki/MailerContrib.txt	2007-11-06 17:16:23 UTC (rev 15504)
+++ twiki/branches/TWikiRelease04x02/twikiplugins/MailerContrib/data/TWiki/MailerContrib.txt	2007-11-06 17:17:35 UTC (rev 15505)
@@ -23,7 +23,7 @@
 %TOC%
 
 ---+ <code>tools/mailnotify</code>
-The central component of MailerContrib is a script, =tools/mailnotify=, that generates and sends out the emails based on analysis of
+The central component of !MailerContrib is a script, =tools/mailnotify=, that generates and sends out the emails based on analysis of
    1 users' subcriptions listed in the <nop>%NOTIFYTOPIC%  topic in each web, and
    1  changes within the respective webs.
 This script is designed to be run from =cron= (or an equivalent off-line job scheduler), or from the command-line. 
@@ -103,8 +103,7 @@
 In addition, the %<nop>STARTPUBLISH% and %<nop>STOPPUBLISH% markers used by TWiki:Plugins.PublishContrib to delimit the text to be published are respected in news mode.
 
 ---+ <code>TWiki/Contrib/MailerContrib</code> code library
-The second part of the module is a code library that provides the services for other applications to modify the subscription topics through a clean, well documented API. This allows (for example) plugin developers to add (for example) a "Register me for this newsletter" button to their pages. The main interface is the =Web<nop>Notify= package described below.
-%$POD%
+The second part of the module is a code library that provides the services for other applications to modify the subscription topics through a clean, well documented API. This allows (for example) plugin developers to add (for example) a "Register me for this newsletter" button to their pages. Developers should refer to the POD documentation for the !WebNotify class as their starting point.
 
 ---+ Installation Instructions
 %$INSTALL_INSTRUCTIONS%
@@ -113,18 +112,18 @@
    * You can change the regular expression that matches email addresses in <nop>%NOTIFYTOPIC% using the ={MailerContrib}{EmailFilterIn} setting in =configure=. This allows you to limit the domains to which emails can be sent, or even block email addresses altogether.
 
 ---++ Setting up your cron job(s)
-You need to set up a =cron= (or equivalent) job to run =tools/mailnotify=.
+You need to set up a =cron= (or equivalent) job to run the =tools/mailnotify= perl script.
 
-Usage: <code>perl -I &lt;bin&gt; mailnotify [-q] [-news] [ <i>web1 web2 ... webN</i> ]</code>
-&lt;bin&gt; is the path to the TWiki bin directory, so that the script can find the rest of TWiki.
+The script is used as follows: <code>perl -I _bin_ mailnotify [-q] [-news] [ <i>web1 web2 ... webN</i> ]</code>
+| _bin_ | path to the TWiki bin directory, so that the script can find the rest of TWiki. |
 | =-q= | Don't print progress information |
 | =-news= | Run in news mode (process !NewsNotify instead of <nop>%NOTIFYTOPIC%) |
-| <code><i>web1 web2 ... webN</i></code> | List of webs to process, separated by spaces or commas. Default is to process all legal TWiki webs. Wildcards (*) are supported. |
+| <code><i>web1 web2 ... webN</i></code> | List of webs to process, separated by spaces or commas. The default is to process all webs. Wildcards (*) are supported. |
 For example, assuming TWiki was installed at =/usr/local/twiki=, this cron entry:
 <verbatim>
 0 0 * * * cd /usr/local/twiki && perl -I bin tools/mailnotify -q Public Private
 </verbatim>
-will generate change notifications for the =Public= and =Private= webs every night at midnight.
+will generate change notifications for the =Public= and =Private= webs every night at midnight. (Google for =crontab= for more information on what all the =0 0 * * *= fields mean)
 <verbatim>
 0 0 * * * cd /usr/local/twiki && perl -I bin tools/mailnotify -q -Sandbox
 </verbatim>