Welcome, Registration, and other StartingPoints; TWiki history & Wiki style; All the docs...
View   r13  >  r12  >  r11  >  r10  >  r9  >  r8  ...
TWikiSiteTools 13 - 15 Nov 2006 - Main.TWikiContributor
Line: 1 to 1
 

TWiki Site Tools

Line: 36 to 36
 To 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 preset SEARCH. The number of topics listed by the limit parameter.:

Changed:
<
<
>
>
 

Changed:
<
<
%SEARCH{ ".*" web="TWiki" regex="on" nosearch="on" order="modified"
reverse="on" limit="50" }%
>
>
%SEARCH{ ".*" web="TWiki" type="regex" nosearch="on" order="modified"
reverse="on" limit="50" }%
 
Line: 46 to 47
 

WebIndex - list of topics

WebIndex lists all web topics in alphabetical order, with the first couple of lines of text. This is simply a preset SEARCH:

Changed:
<
<
>
>
 

Changed:
<
<
%SEARCH{ "\.*" scope="topic" regex="on" nosearch="on" }%
>
>
%SEARCH{ "\.*" scope="topic" type="regex" nosearch="on" }%
 
Line: 66 to 67
 
    • 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 many systems. Example crontab entry:
      0 0 * * * (cd /path/to/twiki/bin; ./statistics >/dev/null 2>&1)
Changed:
<
<
    • 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:
      0 0 * * * (cd /path/to/twiki/bin; ./geturl mydomain.com /urlpath/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/tools/geturl.pl in your cron job and specify the URL of the twiki/bin/statistics script as a parameter. Example:
      0 0 * * * (cd /path/to/twiki/tools; ./geturl.pl mydomain.com /urlpath/to/twiki/bin/statistics >/dev/null 2>&1)
 When running from the command line or a cron job, you can pass parameters to the script like this:
Line: 106 to 107
 
rename move when moving attachment: Attachment filename moved to Newweb.NewTopic
passwd resetpasswd LoginName, WikiName, E-mail address, success code from addUserPassword
passwd changepasswd LoginName, WikiName
Changed:
<
<
save save when replacing existing revision: repRev 3
when user checks the minor changes box: dontNotify
>
>
save save when replacing existing revision: repRev 3
when user checks the minor changes box: dontNotify
when user changes attributes to an exising attachment: filename.ext
save cmd special admin parameter used when saving
 
search search search string
upload upload filename
view view when viewing non-existing topic: (not exist)
when viewing previous topic revision: r3

TWikiSiteTools 12 - 13 Jul 2005 - Main.TWikiContributor
Line: 1 to 1
 

TWiki Site Tools

Line: 68 to 68
 
    • Attention: The script must run as the same user as the CGI scripts are running, which is user nobody on many systems. Example crontab entry:
      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:
      0 0 * * * (cd /path/to/twiki/bin; ./geturl mydomain.com /urlpath/to/twiki/bin/statistics >/dev/null 2>&1)
Added:
>
>
When running from the command line or a cron job, you can pass parameters to the script like this:
./statistics -logdate 200605 -webs TWiki,Sandbox
 

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:
Changed:
<
<
    • Update current month for all webs:
      /twiki/bin/statistics
>
>
    • Update current month for all webs you have access to:
      /twiki/bin/statistics
 
    • Update current month for Main web only:
      /twiki/bin/statistics/Main
Changed:
<
<
    • Update January 2000 for Main web:
      /twiki/bin/statistics/Main?logdate=201911
>
>
    • Update Nov 2019 for Main web:
      /twiki/bin/statistics/Main?logdate=201911
    • Update Nov 2019 for the ProjectX, ProjectY and ProjectZ webs:
      /twiki/bin/statistics?logdate=201911;webs=ProjectX,ProjectY,ProjectZ
 

Log Files


TWikiSiteTools 11 - 13 Jul 2005 - Main.TWikiContributor
Line: 1 to 1
 

TWiki Site Tools


TWikiSiteTools 10 - 13 Jul 2005 - Main.TWikiContributor
Line: 1 to 1
 

TWiki Site Tools

Utilities for searching, navigation, and monitoring site activity

Changed:
<
<
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. 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.
>
>
TWiki Site Tools 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. In particular, TWiki provides two highly configurable, automated site monitoring tools, WebNotify, to e-mail alerts when topics are edited, and WebStatistics, to generate detailed activity reports.
 
Changed:
<
<

WebNotify Recent Changes Alert

>
>

WebNotify - recent changes alert

 
Changed:
<
<
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. The Perl script mailnotify is called by a background process at regular intervals. The script sends an automated email to subscribed users if topics were changed in a web since the script was last run.
>
>
Each TWiki web has an automatic e-mail 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. The Perl script mailnotify is called by a background process at regular intervals. The script sends an automated e-mail to subscribed users if topics were changed in a web since the script was last run.
 

Web Changes Notification Service

Each TWiki 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 using one of these bullet list formats:

three spaces * [ webname . ] wikiName - SMTP mail address
three spaces * [ webName . ] wikiName
three spaces * SMTP mail address
three spaces * SMTP mail address : topics
three spaces * [ webname . ] wikiName : topics

In the above examples, topics is a space-separated list of topic names. The user may further customize the specific content they will receive using the following formats:

  • Specify topics without a Web. prefix
  • Topics must exist in this web.
  • Topics may be specified using * wildcards
  • Each topic may optionally be preceded by a '+' or '-' sign. The '+' sign means "subscribe to this topic" (the same as not putting anything). The '-' sign means "unsubscribe" or "don't send notifications regarding this topic". This allows users to elect to filter out certain topics (and their children, to an arbitrary depth). Topic filters ('-') take precedence over topic includes ('+').
  • Each topic may optionally be followed by an integer in parentheses, indicating the depth of the tree of children below that topic. Changes in all these children will be detected and reported along with changes to the topic itself. Note This uses the TWiki "Topic parent" feature.
  • Each topic may optionally be immediately followed by an exclamation mark ! or a question mark ? with no intervening spaces, indicating that the topic (and children if there is a tree depth specifier as well) should be mailed out as complete topics instead of change summaries. ! causes the topic to be mailed every time even if there have been no changes, ? will mail the topic only if there have been changes to it. This only makes sense for subscriptions.

For example: Subscribe Daisy to all changes to topics in this web.

   * daisy.cutter@flowers.com
Subscribe Daisy to all changes in all webs 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*Flowers
Subscribe StarTrekFan to changes to all topics that start with Star except those that end in Wars, sInTheirEyes or shipTroopers.
   * StarTrekFan: Star* - *Wars - *sInTheirEyes - *shipTroopers
Subscribe 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: - ManureNewsLetter
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 that topic once (though they will still receive individual mails for news topics).

If a TWiki group is listed for notification, the group will be recursively expanded to the e-mail addresses of all members.

TIP 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 TWiki 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.

Changed:
<
<
You can also use %MAINWEB% instead of Main, but this is not necessary even if you have renamed the main web by configuring $mainWebname in TWiki.cfg.
>
>
You can also use %MAINWEB% instead of Main, but this is not necessary even if you have renamed the main web by configuring {MainWebName} in configure.
 
Added:
>
>

WebSearch - search TWiki site

 
Changed:
<
<

Configuring Outgoing Mail

TWiki will use the Net::SMTP module if it is installed on your system. Set this with the SMTPMAILHOST variable in TWikiPreferences.

The notify e-mail uses the default changes.tmpl template, or a skin if activated in the TWikiPreferences.

mailnotify also relies on two hidden files in each TWiki/data/[web] directory: .changes and .mailnotify. Make sure both are writable by your web server process. .changes contains a list of changes; go ahead and make this empty. .mailnotify contains a timestamp of the last time notification was done.

You can use an external mail program, like sendmail, if the Net::SMTP module is not installed. Set the program path in $mailProgram in TWiki.cfg.

>
>
WebSearch is an extremely fast and flexible search facility, part of the core TWiki feature set. WebSearchAdvanced offers more options, including:
  • 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
 
Changed:
<
<
  • HELP Net::SMTP can be easily disabled (ex: if there is an installation error) by setting SMTPMAILHOST in TWikiPreferences to an empty value.
>
>
See also: SearchHelp for help; TWikiVariables and FormattedSearch for including hard-coded searches in text.
 
Changed:
<
<
  • TIP You can set a separate SMTPSENDERHOST variable to define the mail sender host (some SMTP installations require this).
>
>

WebChanges - what's new

 
Changed:
<
<

Setting the Automatic Email Schedule

>
>
To 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.
 
Changed:
<
<
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:
>
>
This is simply a preset SEARCH. The number of topics listed by the limit parameter.:
 

Changed:
<
<
% crontab -e 0 2 * * * (cd /path/to/twiki/bin; ./mailnotify -q)
>
>
%SEARCH{ ".*" web="TWiki" regex="on" nosearch="on" order="modified"
reverse="on" limit="50" }%
 
Changed:
<
<
The above line will run mailnotify nightly at 02:00. The -q switch suppresses all normal output.
>
>
 
Changed:
<
<
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.
>
>

WebIndex - list of topics

 
Changed:
<
<
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. TWiki:Codev/CronTabWin is a free scheduler for Windows.
>
>
WebIndex lists all web topics in alphabetical order, with the first couple of lines of text. This is simply a preset SEARCH:
%SEARCH{ "\.*" scope="topic" regex="on" nosearch="on" }%
 
Changed:
<
<

WebStatistics Site Usage Log

>
>

WebStatistics - site statistics

 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.

Changed:
<
<

Configuring for Automatic Operation

>
>

Configuring for automatic operation

 
  • You can automatically generate usage statistics for all webs. To enable this:
Changed:
<
<
    • Make sure variable $doLogTopicView, $doLogTopicSave and $doLogTopicUpload in TWiki.cfg are set. This will generate log file entries (see below).
>
>
    • Make sure variable {Log}{view}, {Log}{save} and *{Log}{upload} in are set in configure. This will generate log file entries (see below).
 
    • 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.
Changed:
<
<
    • Attention: The script must run as the same user as the CGI scripts are running, which is user nobody on many systems. Example crontab entry:
      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:
      0 0 * * * (cd /path/to/TWiki/bin; ./geturl mydomain.com /urlpath/to/TWiki/bin/statistics >/dev/null 2>&1)
>
>
    • Attention: The script must run as the same user as the CGI scripts are running, which is user nobody on many systems. Example crontab entry:
      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:
      0 0 * * * (cd /path/to/twiki/bin; ./geturl mydomain.com /urlpath/to/twiki/bin/statistics >/dev/null 2>&1)
 
Changed:
<
<

Generating Statistics Manually by URL

>
>

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:
Changed:
<
<
    • Update current month for all webs:
      http://mydomain.com/twiki/bin/statistics
    • Update current month for Main web only:
      http://mydomain.com/twiki/bin/statistics/Main
    • Update January 2000 for Main web:
      http://mydomain.com/twiki/bin/statistics/Main?logdate=200001
>
>
    • Update current month for all webs:
      /twiki/bin/statistics
    • Update current month for Main web only:
      /twiki/bin/statistics/Main
    • Update January 2000 for Main web:
      /twiki/bin/statistics/Main?logdate=201911
 
Changed:
<
<

Log File Details

>
>

Log Files

 
Changed:
<
<
TWiki generates monthly log files which are used by the statistics
  • The log directory is defined by the $logDir variable in TWiki.cfg
>
>
TWiki generates monthly log files which are used by the statistics script
  • The log file is defined by the {LogFileName} setting in configure
 
  • The file name is log<year><month>.txt
Changed:
<
<
  • Example path name: twiki/data/log201911.txt
>
>
  • Example path name: twiki/logs/log201911.txt
 
  • Each access gets logged as:
    | <time> | <wikiusername> | <action> | <web>.<topic> | <extra info> | <IP address> |
  • Example log entry:
Changed:
<
<
| 18 Nov 2019 - 21:51 | Main.TWikiGuest | view | TWiki.WebRss |  | 66.124.232.02 |
  • Actions are logged if enabled in TWiki.cfg by the $doLogTopic<action> flags
>
>
| 18 Nov 2019 - 21:51 | TWikiGuest | view | WebRss |  | 66.124.232.02 |
  • Actions are logged if enabled in configure by the {Log}{action} flags
 
  • Logged actions:
    Script Action name Extra info
    attach attach when viewing attach screen of previous uploaded attachment: filename
    changes changes  
    edit edit when editing non-existing topic: (not exist)
Changed:
<
<
register register E-mail address
save save when replacing existing revision: repRev 1.3
when user checks the minor changes box: dontNotify
search search search string
rdiff rdiff 1.4 1.3
>
>
rdiff rdiff higher and lower revision numbers: 4 3
register regstart WikiUserName, e-Mail address, LoginName: user attempts to register
register register E-mail address: user successfully registers
register bulkregister WikiUserName of new, e-mail address, admin ID
 
rename rename when moving topic: moved to Newweb.NewTopic
rename move when moving attachment: Attachment filename moved to Newweb.NewTopic
Added:
>
>
passwd resetpasswd LoginName, WikiName, E-mail address, success code from addUserPassword
passwd changepasswd LoginName, WikiName
save save when replacing existing revision: repRev 3
when user checks the minor changes box: dontNotify
search search search string
 
upload upload filename
Changed:
<
<
view view when viewing non-existing topic: (not exist)
when viewing previous topic revision: r1.3
>
>
view view when viewing non-existing topic: (not exist)
when viewing previous topic revision: r3
 
Added:
>
>

E-mail

 
Changed:
<
<

WebSearch

>
>

Configuring outgoing mail

 
Changed:
<
<
WebSearch is an extremely fast and flexible search facility, part of the core TWiki feature set. Options include:
  • 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
>
>
Outgoing mail is required for TWikiRegistration and for recent changes alert.
 
Changed:
<
<
See also: TWikiVariables for including hard-coded searches in text.
>
>
TWiki will use the Net::SMTP module if it is installed on your system. Set this with the SMTPMAILHOST variable in TWikiPreferences.
 
Changed:
<
<

WebChanges

>
>
The notify e-mail uses the default changes.tmpl template, or a skin if activated in the TWikiPreferences.
 
Changed:
<
<
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 topics, newest first, along with the first couple of lines of the page content.
>
>
mailnotify also relies on two hidden files in each twiki/data/Web directory: .changes and .mailnotify. Make sure both are writable by your web server process. .changes contains a list of changes; go ahead and make this empty. .mailnotify contains a timestamp of the last time notification was done.
 
Changed:
<
<
This is simply a preset SEARCH. The number of topics listed by the limit parameter.:
%SEARCH{".*" web="TWiki" regex="on" nosearch="on" order="modified" 
reverse="on" limit="50"}%
>
>
You can use an external mail program, such as sendmail, if the Net::SMTP module is not installed. Set the program path in {MailProgram} in configure.
 
Changed:
<
<

WebIndex

>
>
  • HELP Net::SMTP can be easily disabled (if there is an installation error) by setting SMTPMAILHOST in TWikiPreferences to an empty value.
 
Changed:
<
<
WebIndex lists all web topics in alphabetical order, with the first couple of lines of text. This is simply a preset SEARCH:
>
>
  • TIP You can set a separate SMTPSENDERHOST variable to define the mail sender host (some SMTP installations require this).

Setting the automatic e-mail 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:

 

Changed:
<
<
%SEARCH{"\.*" scope="topic" regex="on" nosearch="on"}%
>
>
% crontab -e 0 2 * * * (cd /path/to/twiki/bin; ./mailnotify -q)
 
Changed:
<
<
>
>
The above line will run mailnotify nightly at 02: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. TWiki:Codev/CronTabWin is a free scheduler for Windows.

Site Permissions

  • TWikiAccessControl describes how to restrict read and write access to topics and webs, by users and groups
  • SitePermissions lists the permissions settings of the webs on this TWiki site
 
Changed:
<
<
-- TWiki:Main.MikeMannix - 01 Dec 2001
-- TWiki:Main.PeterThoeny - 28 Aug 2004
>
>
Related Topics: AdminDocumentationCategory, AdminToolsCategory
 

TWikiSiteTools 9 - 28 Aug 2004 - Main.PeterThoeny
Line: 1 to 1
 

TWiki Site Tools

Line: 13 to 13
 
Changed:
<
<
TWiki handles WebNotify entries that include the WikiName of a user or a TWikiGroup and an optional e-mail address. Example entries in WebNotify:
	 * Main.FredBloggs
	 * Main.FredBloggs - secondary@home.com
	 * Main.EngineeringGroup

The first entry is the default form, the notification gets sent to the e-mail address specified in the user's home page. The second entry lists an alternative e-mail address. The third entry specifies a group, the notification gets sent to each member of the group.

>
>

Web Changes Notification Service

Each TWiki 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 using one of these bullet list formats:

three spaces * [ webname . ] wikiName - SMTP mail address
three spaces * [ webName . ] wikiName
three spaces * SMTP mail address
three spaces * SMTP mail address : topics
three spaces * [ webname . ] wikiName : topics

In the above examples, topics is a space-separated list of topic names. The user may further customize the specific content they will receive using the following formats:

  • Specify topics without a Web. prefix
  • Topics must exist in this web.
  • Topics may be specified using * wildcards
  • Each topic may optionally be preceded by a '+' or '-' sign. The '+' sign means "subscribe to this topic" (the same as not putting anything). The '-' sign means "unsubscribe" or "don't send notifications regarding this topic". This allows users to elect to filter out certain topics (and their children, to an arbitrary depth). Topic filters ('-') take precedence over topic includes ('+').
  • Each topic may optionally be followed by an integer in parentheses, indicating the depth of the tree of children below that topic. Changes in all these children will be detected and reported along with changes to the topic itself. Note This uses the TWiki "Topic parent" feature.
  • Each topic may optionally be immediately followed by an exclamation mark ! or a question mark ? with no intervening spaces, indicating that the topic (and children if there is a tree depth specifier as well) should be mailed out as complete topics instead of change summaries. ! causes the topic to be mailed every time even if there have been no changes, ? will mail the topic only if there have been changes to it. This only makes sense for subscriptions.

For example: Subscribe Daisy to all changes to topics in this web.

   * daisy.cutter@flowers.com
Subscribe Daisy to all changes in all webs 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*Flowers
Subscribe StarTrekFan to changes to all topics that start with Star except those that end in Wars, sInTheirEyes or shipTroopers.
   * StarTrekFan: Star* - *Wars - *sInTheirEyes - *shipTroopers
Subscribe 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: - ManureNewsLetter
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 that topic once (though they will still receive individual mails for news topics).

If a TWiki group is listed for notification, the group will be recursively expanded to the e-mail addresses of all members.

TIP 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 TWiki 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.

 You can also use %MAINWEB% instead of Main, but this is not necessary even if you have renamed the main web by configuring $mainWebname in TWiki.cfg.
Line: 135 to 128
 

-- TWiki:Main.MikeMannix - 01 Dec 2001

Changed:
<
<
-- TWiki:Main.PeterThoeny - 24 Apr 2004
>
>
-- TWiki:Main.PeterThoeny - 28 Aug 2004
 

TWikiSiteTools 8 - 25 Apr 2004 - Main.PeterThoeny
Line: 1 to 1
 

TWiki Site Tools

Line: 44 to 44
 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

Changed:
<
<
15,45 * * * * (cd ~twiki/public_html/bin; ./mailnotify -q)
>
>
0 2 * * * (cd /path/to/twiki/bin; ./mailnotify -q)
 
Changed:
<
<
The above line will call mailnotify at 15 minutes and 45 minutes past every hour. The -q switch suppresses all normal output.
>
>
The above line will run mailnotify nightly at 02: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 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

Changed:
<
<
replacements (as of 2001-11-20, none of them free).
>
>
replacements. TWiki:Codev/CronTabWin is a free scheduler for Windows.
 

WebStatistics Site Usage Log

Line: 65 to 64
 

Configuring for Automatic Operation

  • You can automatically generate usage statistics for all webs. To enable this:
Changed:
<
<
    • Make sure variable $doLogTopicView, $doLogTopicSave and $doLogTopicUpload in TWiki.cfg are set. This will generate log entries in file twiki/data/log<date>.txt .
>
>
    • Make sure variable $doLogTopicView, $doLogTopicSave and $doLogTopicUpload in TWiki.cfg are set. This will generate log file entries (see below).
 
    • 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.
Changed:
<
<
    • 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:
      0 0 * * * (cd /path/to/TWiki/bin; ./statistics >/dev/null 2>&1)
>
>
    • Attention: The script must run as the same user as the CGI scripts are running, which is user nobody on many systems. Example crontab entry:
      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:
      0 0 * * * (cd /path/to/TWiki/bin; ./geturl mydomain.com /urlpath/to/TWiki/bin/statistics >/dev/null 2>&1)

Generating Statistics Manually by URL

Line: 78 to 77
 
    • Update current month for Main web only:
      http://mydomain.com/twiki/bin/statistics/Main
    • Update January 2000 for Main web:
      http://mydomain.com/twiki/bin/statistics/Main?logdate=200001
Added:
>
>

Log File Details

TWiki generates monthly log files which are used by the statistics

  • The log directory is defined by the $logDir variable in TWiki.cfg
  • The file name is log<year><month>.txt
  • Example path name: twiki/data/log201911.txt
  • Each access gets logged as:
    | <time> | <wikiusername> | <action> | <web>.<topic> | <extra info> | <IP address> |
  • Example log entry:
    | 18 Nov 2019 - 21:51 | Main.TWikiGuest | view | TWiki.WebRss |  | 66.124.232.02 |
  • Actions are logged if enabled in TWiki.cfg by the $doLogTopic<action> flags
  • Logged actions:
    Script Action name Extra info
    attach attach when viewing attach screen of previous uploaded attachment: filename
    changes changes  
    edit edit when editing non-existing topic: (not exist)
    register register E-mail address
    save save when replacing existing revision: repRev 1.3
    when user checks the minor changes box: dontNotify
    search search search string
    rdiff rdiff 1.4 1.3
    rename rename when moving topic: moved to Newweb.NewTopic
    rename move when moving attachment: Attachment filename moved to Newweb.NewTopic
    upload upload filename
    view view when viewing non-existing topic: (not exist)
    when viewing previous topic revision: r1.3
 

WebSearch

WebSearch is an extremely fast and flexible search facility, part of the core TWiki feature set. Options include:

Line: 109 to 134
 
Changed:
<
<
-- MikeMannix? - 01 Dec 2001
-- PeterThoeny? - 30 Jan 2003
>
>
-- TWiki:Main.MikeMannix - 01 Dec 2001
-- TWiki:Main.PeterThoeny - 24 Apr 2004

TWikiSiteTools 7 - 30 Jan 2003 - Main.PeterThoeny
Line: 1 to 1
 
Changed:
<
<

TWikiSiteTools

>
>

TWiki Site Tools

 Utilities for searching, navigation, and monitoring site activity
Line: 9 to 9
 

WebNotify Recent Changes Alert

Changed:
<
<
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. 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.
>
>
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. The Perl script mailnotify is called by a background process at regular intervals. The script sends an automated email to subscribed users if topics were changed in a web since the script was last run.

TWiki handles WebNotify entries that include the WikiName of a user or a TWikiGroup and an optional e-mail address. Example entries in WebNotify:

	 * Main.FredBloggs
	 * Main.FredBloggs - secondary@home.com
	 * Main.EngineeringGroup

The first entry is the default form, the notification gets sent to the e-mail address specified in the user's home page. The second entry lists an alternative e-mail address. The third entry specifies a group, the notification gets sent to each member of the group.

You can also use %MAINWEB% instead of Main, but this is not necessary even if you have renamed the main web by configuring $mainWebname in TWiki.cfg.

 
Deleted:
<
<
 

Configuring Outgoing Mail

TWiki will use the Net::SMTP module if it is installed on your system. Set this with the SMTPMAILHOST variable in TWikiPreferences.

Added:
>
>
The notify e-mail uses the default changes.tmpl template, or a skin if activated in the TWikiPreferences.

mailnotify also relies on two hidden files in each TWiki/data/[web] directory: .changes and .mailnotify. Make sure both are writable by your web server process. .changes contains a list of changes; go ahead and make this empty. .mailnotify contains a timestamp of the last time notification was done.

 You can use an external mail program, like sendmail, if the Net::SMTP module is not installed. Set the program path in $mailProgram in TWiki.cfg.

  • HELP Net::SMTP can be easily disabled (ex: if there is an installation error) by setting SMTPMAILHOST in TWikiPreferences to an empty value.
Line: 93 to 109
 
Changed:
<
<
-- MikeMannix? - 01 Dec 2001
>
>
-- MikeMannix? - 01 Dec 2001
-- PeterThoeny? - 30 Jan 2003

TWikiSiteTools 6 - 04 May 2002 - Main.MikeMannix
Line: 1 to 1
 

TWikiSiteTools

Utilities for searching, navigation, and monitoring site activity

Deleted:
<
<

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. 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.

WebNotify Recent Changes Alert


TWikiSiteTools 5 - 04 Dec 2001 - Main.MikeMannix
Line: 1 to 1
 

TWikiSiteTools

Line: 17 to 17
 

Configuring Outgoing Mail

Changed:
<
<
TWiki will use the Net::SMTP module in case it is installed on your system. You need to specify the SMTPMAILHOST variable in TWikiPreferences.
>
>
TWiki will use the Net::SMTP module if it is installed on your system. Set this with the SMTPMAILHOST variable in TWikiPreferences.
 
Changed:
<
<
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.
>
>
You can use an external mail program, like sendmail, if the Net::SMTP module is not installed. Set the program path in $mailProgram in TWiki.cfg.

  • HELP Net::SMTP can be easily disabled (ex: if there is an installation error) by setting SMTPMAILHOST in TWikiPreferences to an empty value.

  • TIP You can set a separate SMTPSENDERHOST variable to define the mail sender host (some SMTP installations require this).
 

Setting the Automatic Email Schedule


TWikiSiteTools 4 - 02 Dec 2001 - Main.MikeMannix
Line: 1 to 1
 

TWikiSiteTools

Line: 13 to 13
 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. 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.
Added:
>
>
 

Configuring Outgoing Mail

TWiki will use the Net::SMTP module in case it is installed on your system. You need to specify the SMTPMAILHOST variable in TWikiPreferences.

Line: 36 to 38
 replacements (as of 2001-11-20, none of them free).
Deleted:
<
<

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.

 

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.

Added:
>
>
 

Configuring for Automatic Operation

  • You can automatically generate usage statistics for all webs. To enable this:
Line: 71 to 71
 See also: TWikiVariables for including hard-coded searches in text.
Changed:
<
<
-- MikeMannix? - 30 Nov 2001
>
>

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 topics, newest first, along with the first couple of lines of the page content.

This is simply a preset SEARCH. The number of topics listed by the limit parameter.:

%SEARCH{".*" web="TWiki" regex="on" nosearch="on" order="modified" 
reverse="on" limit="50"}%

WebIndex

WebIndex lists all web topics in alphabetical order, with the first couple of lines of text. This is simply a preset SEARCH:

%SEARCH{"\.*" scope="topic" regex="on" nosearch="on"}%

-- MikeMannix? - 01 Dec 2001


TWikiSiteTools 3 - 01 Dec 2001 - Main.MikeMannix
Line: 1 to 1
 

TWikiSiteTools

Line: 11 to 11
 

WebNotify Recent Changes Alert

Changed:
<
<
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.

How It Works

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.

>
>
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. 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.
 

Configuring Outgoing Mail


TWikiSiteTools 2 - 30 Nov 2001 - Main.MikeMannix
Line: 1 to 1
 

TWikiSiteTools

Line: 7 to 7
 

Overview

Changed:
<
<
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.
>
>
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. 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.
 
Changed:
<
<

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.

WebNotify Recent Changes Alert

>
>

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.
Changed:
<
<

Setting Up WebNotify

>
>

How It Works

 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.
Changed:
<
<
Configuring Outgoing Mail
>
>

Configuring Outgoing Mail

 TWiki 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.

Changed:
<
<
Setting the Automatic Email Schedule
>
>

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:

Line: 44 to 40
 replacements (as of 2001-11-20, none of them free).
Changed:
<
<

WebChanges

>
>

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.
Changed:
<
<

How does it work?

WebStatistics Site Usage Log

>
>

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.
Line: 72 to 66
 

WebSearch

Changed:
<
<
An extremely fast and flexible search facility.

See also: TWikiVariables


Docs Comments for this page

  • What about WebChanges: why isn't that covered here?
>
>
WebSearch is an extremely fast and flexible search facility, part of the core TWiki feature set. Options include:
  • 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
 
Changed:
<
<
  • 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.
 
Changed:
<
<
-- PeterThoeny - 16 Mar 2001 -- MikeMannix? - 23 Nov 2001
>
>
-- MikeMannix? - 30 Nov 2001

TWikiSiteTools 1 - 23 Nov 2001 - Main.MikeMannix
Line: 1 to 1
Added:
>
>

TWikiSiteTools

Utilities for searching, navigation, and monitoring site activity

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.

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.

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.

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.

Configuring Outgoing Mail

TWiki 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.

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 (as of 2001-11-20, none of them free).

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.

How does it work?

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.

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:
      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:
      0 0 * * * (cd /path/to/TWiki/bin; ./geturl mydomain.com /urlpath/to/TWiki/bin/statistics >/dev/null 2>&1)

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:
      http://mydomain.com/twiki/bin/statistics
    • Update current month for Main web only:
      http://mydomain.com/twiki/bin/statistics/Main
    • Update January 2000 for Main web:
      http://mydomain.com/twiki/bin/statistics/Main?logdate=200001

WebSearch

An extremely fast and flexible search facility.

See also: TWikiVariables


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


Revision 13r13 - 15 Nov 2006 - 19:43:52 - TWikiContributor
Revision 12r12 - 13 Jul 2005 - 23:14:56 - TWikiContributor
Revision 11r11 - 13 Jul 2005 - 23:14:56 - TWikiContributor
Revision 10r10 - 13 Jul 2005 - 23:14:56 - TWikiContributor
Revision 9r9 - 28 Aug 2004 - 07:22:32 - PeterThoeny?
Revision 8r8 - 25 Apr 2004 - 00:10:27 - PeterThoeny?
Revision 7r7 - 30 Jan 2003 - 07:43:00 - PeterThoeny?
Revision 6r6 - 04 May 2002 - 16:10:36 - MikeMannix?
Revision 5r5 - 04 Dec 2001 - 07:22:21 - MikeMannix?
Revision 4r4 - 02 Dec 2001 - 10:22:00 - MikeMannix?
Revision 3r3 - 01 Dec 2001 - 10:03:44 - MikeMannix?
Revision 2r2 - 30 Nov 2001 - 09:53:00 - MikeMannix?
Revision 1r1 - 23 Nov 2001 - 11:34:45 - MikeMannix?
This site is powered by the TWiki collaboration platform.
All material on this collaboration platform is the property of the contributing authors.
All material marked as authored by Eben Moglen is available under the license terms CC-BY-SA version 4.
Syndicate this site RSSATOM