TWiki Implementation Notes

Platform

TWiki is written in Perl 5 and uses also some shell commands. The current implementation runs best on a Unix machine, but it is also possible on Microsoft Windows. RCS (for revision control) must be installed on the system.

Directory Structure

Note: You could move the twiki/bin/TWiki library directory (including Plugins ) to twiki/lib/TWiki; the scripts look for a "." and "../lib" relative library path.

Files in twiki/bin

File:	Used for:
viewfile	Script to view an file attachment
view	Script to view a topic ( the script )
testenv	Script to test CGI environment variables
rdiff	Script to see differences of topics
register	Script to register new users
preview	Script to preview topic after edit
geturl	Script to fetch URL data
edit	Script to edit a topic
statistics	Script to create statistics topic
attach	Script that shows the attach file page (FileAttachment)
oops	Script that shows an OK or oops dialog
save	Script that saves a topic, called by preview
upload	Script that does file upload (FileAttachment)
search	Script that displays search results
mailnotify	Script called by cron job to notify users of changes
TWiki.pm	Main TWiki library
TWiki.cfg	For initialization and configuration, used by TWiki.pm
.htaccess.txt	Authentication. Rename to .htaccess and customize if used
delete	(not used yet)

Files in twiki/bin/TWiki

Files in twiki/bin/TWiki/Plugins

-- PeterThoeny? - 03 Mar 2001