summaryrefslogtreecommitdiff
path: root/TWiki/TWikiSiteTools.mdwn
diff options
context:
space:
mode:
Diffstat (limited to 'TWiki/TWikiSiteTools.mdwn')
-rw-r--r--TWiki/TWikiSiteTools.mdwn38
1 files changed, 15 insertions, 23 deletions
diff --git a/TWiki/TWikiSiteTools.mdwn b/TWiki/TWikiSiteTools.mdwn
index 5ba3c46d..0fee1bdc 100644
--- a/TWiki/TWikiSiteTools.mdwn
+++ b/TWiki/TWikiSiteTools.mdwn
@@ -6,27 +6,23 @@ _Utilities for searching, navigation, and monitoring site activity_
## <a name="Overview"> Overview </a>
-[[TWikiSiteTools]] include utilities for navigating, searching and keeping up with site activity. Preferences can be configured by web or site-wide. You are currently in the **%TWIKIWEB%** web.
+[[TWikiSiteTools]] include utilities for navigating, searching and keeping up with site activity. Preferences can be configured by web or site-wide. You are currently in the **%TWIKIWEB%** web. In particular, TWiki provides two highly configurable, automated site monitoring tools, **WebNotify**, to email alerts when topics are edited, and **WebStats**, to generate detailed activity reports.
-## <a name="Monitoring_Topic_Changes"> Monitoring Topic Changes </a>
-
-TWiki provides two highly configurable, automated site monitoring tools, **WebNotify**, to email alerts when topics are edited, and **WebStats**, to generate detailed activity reports.
-
-### <a name="WebNotify_Recent_Changes_Alert"> WebNotify Recent Changes Alert </a>
+## <a name="WebNotify_Recent_Changes_Alert"> WebNotify Recent Changes Alert </a>
Each TWiki web has an automatic email alert service that sends a list of recent changes on a preset schedule, like once a day. Users can subscribe and unsubscribe using %NOTIFYTOPIC% in each web.
-#### <a name="Setting_Up_WebNotify"> Setting Up WebNotify </a>
+### <a name="How_It_Works"> How It Works </a>
The Perl script `mailnotify` is called by a deamon in regular intervals. The script sends an automated email to subscribed users if topics were changed in a web within last interval.
-##### <a name="Configuring_Outgoing_Mail"> Configuring Outgoing Mail </a>
+### <a name="Configuring_Outgoing_Mail"> Configuring Outgoing Mail </a>
%WIKITOOLNAME% will use the `Net::SMTP` module in case it is installed on your system. You need to specify the `SMTPMAILHOST` variable in [[TWikiPreferences]].
You can use an external mail program like `sendmail` in case the `Net::SMTP` module is not installed. In this case specify the `$mailProgram` in `twiki/bin/TWiki.cfg`.
-##### <a name="Setting_the_Automatic_Email_Sche"> Setting the Automatic Email Schedule </a>
+### <a name="Setting_the_Automatic_Email_Sche"> Setting the Automatic Email Schedule </a>
**For Unix platforms:** Edit the `cron` table so that `mailnotify` is called in an interval of your choice. Please consult `man crontab` of how to modify the table that schedules program execution at certain intervals. Example:
@@ -39,13 +35,11 @@ The above line will call mailnotify at 15 minutes and 45 minutes past every hour
**On Windows NT/2000:** You can use a scheduled task if you have administrative privileges. **_Note:_** AT on an NT machine is pretty limited. Microsoft lists several third-party [replacements](http://www.microsoft.com/ntserver/partners/findoffering/serversolutions/Maintnce.asp#cron) (as of 2001-11-20, none of them free).
-### <a name="WebChanges"> </a> [[WebChanges]]
+## <a name="WebChanges"> WebChanges </a>
To check for the most recently edited topics while on-site, use the [[WebChanges]] link, usually located on the upper toolbar. It lists the _\__ most recently modified, newest first, along with the first couple of lines of the page content.
-#### <a name="How_does_it_work_"> How does it work? </a>
-
-## <a name="WebStatistics_Site_Usage_Log"> </a> [[WebStatistics]] Site Usage Log
+## <a name="WebStatistics_Site_Usage_Log"> WebStatistics Site Usage Log </a>
You can generate a listing manually, or on an automated schedule, of visits to individual pages, on a per web basis. Compiled as a running total on a monthly basis. Includes totals for Topic Views, Topic Saves, Attachment Uploads, Most Popular Topics with number of views, and Top Contributors showing total of saves and attachment uploads. Previous months are saved.
@@ -67,16 +61,14 @@ You can generate a listing manually, or on an automated schedule, of visits to i
## <a name="WebSearch"> WebSearch </a>
-An extremely fast and flexible search facility.
-
-See also: [[TWikiVariables]]
-
-----
-
-## <a name="Docs_Comments_for_this_page"> Docs Comments for this page </a>
+[[WebSearch]] is an extremely fast and flexible search facility, part of the core TWiki feature set. Options include:
-* What about [[WebChanges]]: why isn't that covered here?
+* topic title or full-text search
+* regular expressions
+* search within web or site-wide
+* index-style A-Z alphabetical listing sorted topic title
+* many more
-* Need more details on [[WebNotify]]: How does it work? Exactly what data is emailed, in what format?
+See also: [[TWikiVariables]] for including hard-coded searches in text.
--- [[PeterThoeny]] - 16 Mar 2001 -- [[Main/MikeMannix]] - 23 Nov 2001
+-- [[Main/MikeMannix]] - 30 Nov 2001