TWiki.TWikiSiteTools (r1.7 vs. r1.8)
Diffs

 <<O>>  Difference Topic TWikiSiteTools (r1.8 - 25 Apr 2004 - PeterThoeny)
Changed:
<
<
META TOPICINFO PeterThoeny date="1043912580" format="1.0" version="1.7"
>
>
META TOPICINFO PeterThoeny date="1082851827" format="1.0" version="1.8"

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/log202403.txt
  • Each access gets logged as:
    | <time> | <wikiusername> | <action> | <web>.<topic> | <extra info> | <IP address> |
  • Example log entry:
    | 28 Mar 2024 - 18:17 | 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

Topic: TWikiSiteTools . { View | Diffs | r1.8 | > | r1.7 | > | r1.6 | More }

Revision r1.7 - 30 Jan 2003 - 07:43 - PeterThoeny
Revision r1.8 - 25 Apr 2004 - 00:10 - PeterThoeny