--- /dev/null
+<div>
+ <ul>
+ <li><a href="#TWikiSiteTools"> TWikiSiteTools</a><ul>
+ <li><a href="#Overview"> Overview</a></li>
+ <li><a href="#Monitoring Topic Changes"> Monitoring Topic Changes</a><ul>
+ <li><a href="#WebNotify Recent Changes Alert"> WebNotify Recent Changes Alert</a><ul>
+ <li><a href="#Setting Up _WebNotify"> Setting Up WebNotify</a><ul>
+ <li><a href="#Configuring Outgoing Mail"> Configuring Outgoing Mail</a></li>
+ <li><a href="#Setting the Automatic Email Sche"> Setting the Automatic Email Schedule</a></li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ <li><a href="#WebChanges"> WebChanges</a><ul>
+ <li><a href="#How does it work?"> How does it work?</a></li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ <li><a href="#WebStatistics Site Usage Log"> WebStatistics Site Usage Log</a><ul>
+ <li><a href="#Configuring for Automatic Operat"> Configuring for Automatic Operation</a></li>
+ <li><a href="#Generating Statistics Manually b"> Generating Statistics Manually by URL</a></li>
+ </ul>
+ </li>
+ <li><a href="#WebSearch"> WebSearch</a></li>
+ <li><a href="#Docs Comments for this page"> Docs Comments for this page</a></li>
+ </ul>
+ </li>
+ </ul>
+</div>
+
+# <a name="TWikiSiteTools"></a><a name="_TWikiSiteTools"></a> TWikiSiteTools
+
+_Utilities for searching, navigation, and monitoring site activity_
+
+## <a name="Overview"></a> Overview
+
+[[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 **TWiki** web.
+
+## <a name="Monitoring Topic Changes"></a> Monitoring Topic Changes
+
+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"></a><a name="_WebNotify Recent Changes Alert"></a> WebNotify Recent Changes Alert
+
+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 [[WebNotify]] in each web.
+
+#### <a name="Setting Up _WebNotify"></a> Setting Up WebNotify
+
+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"></a> Configuring Outgoing Mail
+
+%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"></a> Setting the Automatic Email Schedule
+
+**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:
+
+ % crontab -e
+ 15,45 * * * * (cd ~twiki/public_html/bin; ./mailnotify -q)
+
+The above line will call mailnotify at 15 minutes and 45 minutes past every hour. The `-q` switch suppresses all normal output.
+
+**For ISP installations:** Many ISPs don't allow hosted accounts direct cron access, as it's often used for things that can heavily load the server. Workaround scripts are available.
+
+**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]]
+
+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?"></a> How does it work?
+
+## <a name="WebStatistics Site Usage Log"></a> [[WebStatistics]] Site Usage Log
+
+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.
+
+### <a name="Configuring for Automatic Operat"></a> Configuring for Automatic Operation
+
+- You can automatically generate usage statistics for all webs. To enable this:
+ - Make sure variable `$doLogTopicView, $doLogTopicSave and $doLogTopicUpload` in `TWiki.cfg` are set. This will generate log entries in file `twiki/data/log<date>.txt` .
+ - The [[WebStatistics]] topic must be present in all webs where you want to have statistics. You can use the topic in the Main web as a template.
+ - Call the `twiki/bin/statistics` script from a cron job, once a day is recommended. This will update the [[WebStatistics]] topics in all webs.
+ - **_Attention:_** The script must run as the same user as the CGI scripts are running, which is user `nobody` on most systems. Example crontab entry: <br />`0 0 * * * (cd /path/to/TWiki/bin; ./statistics >/dev/null 2>&1)`
+ - There is a workaround in case you can't run the script as user `nobody` : Run the utility `twiki/bin/geturl` in your cron job and specify the URL of the `twiki/bin/statistics` script as a parameter. Example: <br />`0 0 * * * (cd /path/to/TWiki/bin; ./geturl mydomain.com /urlpath/to/TWiki/bin/statistics >/dev/null 2>&1)`
+
+### <a name="Generating Statistics Manually b"></a> Generating Statistics Manually by URL
+
+- The `twiki/bin/statistics` script can also be executed as a CGI script, just enter the URL in your browser. Examples:
+ - Update current month for all webs: <br />`http://mydomain.com/twiki/bin/statistics`
+ - Update current month for Main web only: <br />`http://mydomain.com/twiki/bin/statistics/Main`
+ - Update January 2000 for Main web: <br />`http://mydomain.com/twiki/bin/statistics/Main?logdate=200001`
+
+## <a name="WebSearch"></a><a name="_WebSearch"></a> WebSearch
+
+An extremely fast and flexible search facility.
+
+See also: [[TWikiVariables]]
+
+----
+
+## <a name="Docs Comments for this page"></a> Docs Comments for this page
+
+- What about [[WebChanges]]: why isn't that covered here?
+
+- Need more details on [[WebNotify]]: How does it work? Exactly what data is emailed, in what format?
+
+-- [[PeterThoeny]] - 16 Mar 2001 -- [[MikeMannix]] - 23 Nov 2001
</tr>
</table>
-### <a name="TWiki Quick Start"></a> TWiki Quick Start
-
-- [[WelcomeGuest]]: A fast track intro covering all the basics
-- [[TWikiRegistration]]: Sign up so you can edit pages and select options
-
### <a name="TWiki User's Guide"></a> TWiki User's Guide
-- A set of one-page primers on putting TWiki to work for you <br /> Frequent users should also browse the [[TWiki Reference Manual|Main/WebHome#ReferenceManual]]!
+- **TWiki Quick Start** - the fast track approach
+ - [[WelcomeGuest]]: A fast track intro covering all the basics
+ - [[TWikiRegistration]]: Sign up so you can edit pages and select options
-- - [[TWikiSite]]: Instant overview - first, there was Wiki...
+- **One-Page Primers** cover TWiki basics
+ - [[TWikiSite]]: Instant overview - first, there was Wiki...
- [[WikiSyntax]]: TWiki shorthand basics
- - [[TWikiFAQ]]: The first things people ask about %WIKITOOLNAME%
- - [[TextFormattingFAQ]]: Most-requested facts about posting in TWiki
- [[TWikiTutorial]]: A compact %WIKITOOLNAME% primer
- [[GoodStyle]]: Working tips for an open collaboration environment
- [[TWikiShorthand]]: The complete TWiki text formatting syntax on one page
- [[WebChangesAlert]]: Subscribe to email alerts linking to the latest page changes
- [[TWikiPages]]: Customize, rename, move, or delete TWiki topics
-> _While installing TWiki, it's easy to customize the User's Guide pages to fit the features and access settings of your TWiki site._
+- **TWiki Help FAQs**
+ - [[TWikiFAQ]]: The first things people ask about %WIKITOOLNAME%
+ - [[TextFormattingFAQ]]: Most-requested facts about posting in TWiki
+
+- Frequent users should also browse the [[TWiki Reference Manual|Main/WebHome#ReferenceManual]]!
+- It's easy to customize the User's Guide to reflect the features and settings enabled on your own TWiki site.
<a name="ReferenceManual"></a>
- Documentation for webmasters, system administrators, project managers, team leaders, <br /> all other users of the TWiki advanced online collaboration tool.
-- - [[TWikiHistory]]: The TWiki development timeline
- - [[TWikiDocumentation]]: Complete current reference...
+- - [[TWikiDocumentation]]: Complete current reference...
1. [[System Requirements|Main/TWikiImplementationNotes]]
2. [[Installation Guide|Main/TWikiInstallationGuide]]
3. [[Upgrade Guide|Main/TWikiUpgradeGuide]]
9. [[TWikiForms]]
10. [[TWikiAttachments|Main/FileAttachment]]
11. [[TWikiPlugins]]
- 12. [[Monitoring Activity|Main/MonitoringSiteActivity]]
+ 12. [[TWikiSiteTools]]
13. [[Managing Topics|Main/ManagingTopics]]
- 14. [[Managing Webs|Main/ManagingWebs]]
+ 14. [[Managing Webs|Main/ManagingWebs]]<br />**Appendices**
15. [[A - TWiki File System|Main/AppendixFileSystem]]
16. [[B - TWiki Meta Data|Main/TWikiMetaData]]
17. [[C - Text Formatting Rules|Main/TextFormattingRules]]
+ 18. [[D - TWikiVariables Examples|Main/TWikiVariablesExamples]]
+ 19. [[E - TWiki Development Timeline|Main/TWikiHistory]]
### <a name="TWiki Site Tools"></a> TWiki Site Tools
-Site tools include utilities for navigating and keeping up with site activity on individual TWiki webs. Preferences can also be configured, by web or site-wide. You are currently in the **TWiki** web.
+[[TWikiSiteTools]] include utilities for navigating and keeping up with site activity on individual TWiki webs. Preferences can also be configured, by web or site-wide. You are currently in the **TWiki** web.
<form action="http://www.dementia.org/twiki//search/%WEB%/">
<ul>
- <li>[[Main/WebSearch]]: Full text search of the %WEB% web<br /><input name="search" size="32" type="text" /> <input type="submit" value="Search" /> (extended options in [[Main/WebSearch]]) </li>
- <li>[[Main/WebChanges]]: Display recent input on the %WEB% web </li>
- <li>[[Main/WebIndex]]: List all %WEB% topics in alphabetical order </li>
- <li>[[Main/WebNotify]]: Subscribe to an email alert with the latest %WEB% web changes </li>
- <li>[[Main/WebStatistics]]: View access statistics for the %WEB% web </li>
- <li>[[Main/WebPreferences]]: Preference settings for the %WEB% web </li>
- <li>[[Main/TWikiPreferences]]: %WIKITOOLNAME% site-wide preferences </li>
+ <li>[[Main/WebSearch]]: Full text search of this web<br /><input name="search" size="32" type="text" /> <input type="submit" value="Search" /> (extended options in [[Main/WebSearch]]) </li>
+ <li>[[Main/WebChanges]]: Display recent input on the this web </li>
+ <li>[[Main/WebIndex]]: List all web topics in alphabetical order </li>
+ <li>[[Main/WebNotify]]: Subscribe to an email alert with the latest this web changes </li>
+ <li>[[Main/WebStatistics]]: View access statistics for the this web </li>
</ul>
</form>
-- The %WEB% web is coded light orange for quick identification.
-- The [[TWikiWebsTable]] is a color coded directory of available webs that can be easily included on any page:
+- [[WebPreferences]]: Preference settings for the this web
+- [[TWikiPreferences]]: %WIKITOOLNAME% site-wide preferences
+- The [[TWikiWebsTable]] _(below)_ is a color-coded directory of available webs that can be easily included on any page.
+ - The [[%WEB%|TWiki/WebHome]] web is coded light orange for quick identification.
- TWiki<sup>TM</sup> is a trademark of [[PeterThoeny]]
- TWiki is developed as Free Software under the [[GNU/GPL|Main/GnuGeneralPublicLicense]]
git://git.openafs.org / openafs-wiki.git / commitdiff