Welcome, Registration, and other StartingPoints; TWiki history & Wiki style; All the docs...

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

Directory: Used for:
twiki/bin TWiki Perl scripts
twiki/bin/TWiki TWiki Perl modules
twiki/bin/TWiki/Plugins Plugins modules
twiki/pub Public files (FileAttachments, images)
twiki/data source text
twiki/templates HTML templates, used by TWiki scripts

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

Files in twiki/bin/TWiki

File: Used for:
Access.pm Access control
Net.pm SMTP mail handling
Plugins.pm Plugin handling
Prefs.pm Preferences handling
Search.pm Search engine, used by wiki.pm
Store.pm Back-end storage, *.txt text file and *.txt,v RCS repository file handling

Files in twiki/bin/TWiki/Plugins

File: Used for:
DefaultPlugin.pm Default plugin
EmptyPlugin.pm Empty plugin, use to create your own

-- PeterThoeny? - 03 Mar 2001

Go

Navigation

Webs Webs

r36 - 05 Feb 2007 - 00:18:43 - TWikiContributor
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