From 35b1a72a76c0f4f8ecf45dd07b520a49060e5d87 Mon Sep 17 00:00:00 2001 From: Peter Thoeny Date: Sun, 4 Mar 2001 18:56:08 +0000 Subject: none --- TWiki/TWikiImplementationNotes.mdwn | 122 +++++++++++++++++++++++++----------- 1 file changed, 84 insertions(+), 38 deletions(-) (limited to 'TWiki') diff --git a/TWiki/TWikiImplementationNotes.mdwn b/TWiki/TWikiImplementationNotes.mdwn index 03668108..d3ab11be 100644 --- a/TWiki/TWikiImplementationNotes.mdwn +++ b/TWiki/TWikiImplementationNotes.mdwn @@ -1,8 +1,10 @@ -**_Platform_** +## TWiki Implementation Notes -TWiki is written in Perl 5, but it uses also many 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. +### Platform -**_Directories_** +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 @@ -10,24 +12,34 @@ TWiki is written in Perl 5, but it uses also many shell commands. The current im - + - + + + + + + + + + - + - +
Used for:
twiki/bintwiki/bin TWiki Perl scripts
twiki/pubtwiki/bin/TWiki TWiki Perl modules
twiki/bin/TWiki/Plugins Plugins modules
twiki/pub Public files (File Attachments?, images)
twiki/datatwiki/data source text
twiki/templatestwiki/templates HTML templates, used by TWiki scripts
-**_Files in twiki/bin_** +**_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 @@ -35,97 +47,131 @@ TWiki is written in Perl 5, but it uses also many shell commands. The current im - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - + + + + + + + +
Used for:
.htaccess.txt.htaccess.txt Authentication. Rename to .htaccess and customize if used
attachattach Script that shows the attach file page (File Attachment?)
deletedelete (not used yet)
editedit Script to edit a topic
geturlgeturl Script to fetch URL data
mailnotifymailnotify Script called by cron job to notify users of changes
oopsoops Script that shows an OK or oops dialog
previewpreview Script to preview topic after edit
rdiffrdiff Script to see differences of topics
registerregister Script to register new users
savesave Script that saves a topic, called by preview
searchsearch Script that displays search results
statisticsstatistics Script to create statistics topic
testenvtestenv Script to test CGI environment variables
uploadupload Script that does file upload (File Attachment?)
viewview Script to view a topic ( the script )
viewfileviewfile Script to view an file attachment
wiki.pm main TWiki library TWiki.pm Main TWiki library
TWiki.cfg For initialization and configuration, used by TWiki.pm
+ +#### Files in twiki/bin/TWiki + + + + + + + + + + + + + + + + + - - + + - - + + - - + + + +
File:Used for:
Access.pm Access control
Net.pm SMTP mail handling
Plugins.pm Plugin handling
wikiaccess.pm access control Prefs.pm Preferences handling
wikicfg.pm for initialization and configuration, used by wiki.pm Search.pm Search engine, used by wiki.pm
wikiprefs.pm preferences handling Store.pm Back-end storage, *.txt text file and *.txt,v RCS repository file handling
+ +#### Files in twiki/bin/TWiki/Plugins + + + + + - - + + - - + +
File:Used for:
wikisearch.pm search engine, used by wiki.pm DefaultPlugin.pm Default plugin
wikistore.pm back-end storage, *.txt text file and *.txt,v RCS repository file handling EmptyPlugin.pm Empty plugin, use to create your own
--- [[Main/PeterThoeny]] - 02 Nov 2000
+-- [[Main/PeterThoeny]] - 03 Mar 2001
-- cgit v1.2.3