Site ToolsUtilities for searching, navigation, and monitoring site activity Site Tools include utilities for navigating, searching and keeping up with site activity. In particular, you have two highly configurable, automated site monitoring tools, WebNotify, to e-mail alerts when topics are edited, and WebStatistics, to generate detailed activity reports.On this page:
WebNotify - recent changes alertAbout the Web changes notification serviceEach Foswiki web has an automatic e-mail notification service that sends you an e-mail with links to all of the topics modified since the last alert. Users subscribe to email notifications using their WikiName or an alternative email address, and can specify the webs/topics they wish to track. Whole groups of users can also be subscribed for notification. The general format of a subscription is: three spaces* subscriber [ : topics ]
Where subscriber can be a WikiName, an email address, or a group name. If subscriber contains any characters that are not legal in an email address, then it must be enclosed in 'single' or "double" quotes. Note: The guest user WikiGuest does not have an email address mapped to it, and will never receive email regardless of the configuraion of that user.
topics is an optional space-separated list of topics:
* daisy.cutter@flowers.comSubscribe Daisy to all changes to topics that start with Web .
* daisy.cutter@flowers.com : Web*Subscribe Daisy to changes to topics starting with Petal , and their immediate children, WeedKillers and children to a depth of 3, and all topics that match start with Pretty and end with Flowers e.g. PrettyPinkFlowers .
* DaisyCutter: Petal* (1) WeedKillers (3) Pretty*FlowersSubscribe StarTrekFan to changes to all topics that start with Star except those that end in Wars , sInTheirEyes or shipTroopers .
* StarTrekFan: Star* - *Wars - *sInTheirEyes - *shipTroopersSubscribe Daisy to the full content of NewsLetter whenever it has changed.
* daisy@flowers.com: NewsLetter?Subscribe buttercup to NewsLetter and its immediate children, even if it hasn't changed.
* buttercup@flowers.com: NewsLetter! (1)Subscribe GardenGroup (which includes Petunia) to all changed topics under AllNewsLetters to a depth of 3. Then unsubscribe Petunia from the ManureNewsLetter , which she would normally get as a member of GardenGroup:
* GardenGroup: AllNewsLetters? (3) * petunia@flowers.com: - ManureNewsLetterSubscribe IT:admins (a non-Foswiki group defined by an alternate user mapping) to all changes to Web* topics.
* 'IT:admins' : Web*A user may be listed many times in the WebNotify topic. Where a user has several lines in WebNotify that all match the same topic, they will only be notified about changes in that topic once (though they will still receive individual mails for news topics). If a group is listed for notification, the group will be recursively expanded to the email addresses of all members. Warning: Because an email address is not linked to a user name, there is no way for Foswiki to check access controls for subscribers identified by email addresses. A subscriber identified by an email address alone will only be sent change notifications if the topic they are subscribed to is readable by guest users. You can limit which email addresses can be used in WebNotify, or even block use of emails altogther, using the Tip: List names in alphabetical order to make it easier to find the names.Note for System Administrators: Notification is supported by an add-on to the Foswiki kernel called the MailerContrib. See the MailerContrib topic for details of how to set up this service. Note: If you prefer a news feed, point your reader to WebRss (for RSS 1.0 feeds) or WebAtom (for ATOM 1.0 feeds). Learn more at WebRssBase and WebAtomBase, respectively. Related topics: Main.WikiUsers, UserRegistration WebSearch - search the siteWebSearch is a flexible search facility, part of the core feature set. WebSearchAdvanced offers more options, including:
WebChanges - what's newTo check for the most recently edited topics while on-site, use the WebChanges link, usually located in the toolbar. It lists the most recently modified topics, newest first, along with the first couple of lines of the page content. This is simply a presetSEARCH . The number of topics listed by the limit parameter.:
%SEARCH{ "1" web="%BASEWEB%" type="query" nosearch="on" order="modified" reverse="on" limit="50" }% WebRss and WebAtom - news feeds on recent changesYou can point your news reader at WebRss and WebAtom to find out what is new in a web. WebRssBase and WebAtomBase have the details. Like WebChanges, this is based on a%SEARCH{}% .
WebIndex - list of topicsWebIndex lists all web topics in alphabetical order, with the first couple of lines of text. This is simply a presetSEARCH :
%SEARCH{"1" scope="topic" type="query" nosearch="on" }% WebStatistics - site statisticsSee SiteToolStatistics for detailed configuration and customization information.IntroductionStatistics of visits to pages in a web can be generated manually or automatically, on a per-web basis. Statistics are compiled as a running total for each month.They include 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. Statistics from previous months are saved, and a new row is written to the table at the beginning of each month.
Manually running statisticsThe following form can be used to run statistics and create the WebStatistics topics for selected or all webs. Note: The current user - WikiGuest must have access rights to read/write the WebStatistics topics, and if missing, must have authority to create the WebStatistics in the selected webs.Log FilesFoswiki generates an event log which is used by the statistics script
Configuring outgoing mailOutgoing mail is required for UserRegistration and for recent changes alert. The preferred place to configure e-mail is in the configure "Mail and Proxies" tab tool (LocalSite.cfg ). The configure tool fully documents these setting.
The notify e-mail uses the default changes.tmpl template, or a skin if activated by a preference setting.
mailnotify also relies on a hidden file in each data/Web directory: .changes and a file with the Web name (one per web) in the working/work_areas/MailerContrib/ directory. Make sure both are writable by your web server process. .changes contains a list of changes; The file in the working/work_areas/MailerContrib/ directorycontains a timestamp of the last time notification was done for the web.Both files are automatically created as needed.
Legacy and current configurationCaution: Older versions of Foswiki, and especially TWiki migrations might configure e-mail in the preference settings topic.Make sure you delete that setting if you are using a SitePreferences topic from a previous release of Foswiki.
Setting the automatic e-mail scheduleFor Unix platforms: Edit thecron table so that mailnotify is called in an interval of your choice. Please consult man crontab for how to modify the table that schedules program execution at certain intervals. Example:
% crontab -e 0 1 * * * (cd /path/to/bin; ./mailnotify -q)The above line will run mailnotify nightly at 01:00. 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: You can use a scheduled task if you have administrative privileges.
Site Permissions
Help with crontabThe crontab command is used to schedule commands to be executed periodically.
Related Topics: AdminDocumentationCategory, AdminToolsCategory <-- --> |