From 3b5aaf37e3f8deed80216e5efb1ea60b784339ff Mon Sep 17 00:00:00 2001 From: MikeMannix Date: Wed, 29 Aug 2001 00:47:55 +0000 Subject: none --- TWiki/TWikiImplementationNotes.mdwn | 92 ++++++++++++++++++++++++++++++------- 1 file changed, 76 insertions(+), 16 deletions(-) diff --git a/TWiki/TWikiImplementationNotes.mdwn b/TWiki/TWikiImplementationNotes.mdwn index c6f34cd7..c1b1a64f 100644 --- a/TWiki/TWikiImplementationNotes.mdwn +++ b/TWiki/TWikiImplementationNotes.mdwn @@ -1,16 +1,18 @@ +%TOC% %STARTINCLUDE% + ## TWiki Implementation Notes -### Platform +### Platforms and System Requirements -TWiki is written in Perl 5 and also uses 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. +TWiki is written in **Perl 5** and also uses 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. [ **_MM: Locate elsewhere and/or include one-liner and link for RCS..._** ] - - + + @@ -26,7 +28,7 @@ TWiki is written in Perl 5 and also uses some shell commands. The current implem - + @@ -43,42 +45,76 @@ TWiki is written in Perl 5 and also uses some shell commands. The current implem + + + + +
Required Environment by Platform
Package(s):Unix:Packages:Linux/Unix: Windows:
Optional Perl modules Net::SMTP (or sendmail) Net::SMTPNet::SMTP
RCS Apache Apache, IIS
OS versionsLinux, Unix...every last Win?!
### Directory Structure +You can easily rename the root TWiki directory - **twiki** - to whatever you like by changing a configuration file value. For the simplest installation and future upgrades, you should leave the subdirectory structure exactly as is: + + + + + + + - + + + + + + + - + + - + + - + + - + + +
Directory:Files: Used for:
twiki list Start-up info
twiki/bin TWiki Perl scripts list Perl scripts
twiki/lib list Configuration file & main library
twiki/lib/TWiki TWiki Perl modules list Perl modules
twiki/lib/TWiki/Plugins Plugins modules list TWiki Plugins? Perl modules
twiki/pub Public files (File Attachments?, images), plus RCS histories list Public support files (ex: File Attachments?, images) and RCS histories)
twiki/data source (topic) text, including RCS histories list Topic text (page content) and RCS histories;
twiki/templates list HTML templates, used by TWiki scripts
-#### Files in twiki/bin +**_Note: about the additional directories in data, elsewhere_** + + + +#### Files in `twiki` + +**_to follow_** + + + +#### Files in `twiki/bin` @@ -159,7 +195,9 @@ TWiki is written in Perl 5 and also uses some shell commands. The current implem
-#### Files in twiki/lib + + +#### Files in `twiki/lib` @@ -172,11 +210,13 @@ TWiki is written in Perl 5 and also uses some shell commands. The current implem - +
TWiki.cfg For initialization and configuration, used by TWiki.pm For configuration, used by TWiki.pm
-#### Files in twiki/lib/TWiki + + +#### Files in `twiki/lib/TWiki` @@ -217,7 +257,9 @@ TWiki is written in Perl 5 and also uses some shell commands. The current implem
-#### Files in twiki/lib/TWiki/Plugins + + +#### Files in `twiki/lib/TWiki/Plugins` @@ -238,4 +280,22 @@ TWiki is written in Perl 5 and also uses some shell commands. The current implem
--- [[Main/MikeMannix]] - 26 Aug 2001 + + +#### Files in `twiki/pub` + +**_to follow_** + + + +#### Files in `twiki/data` + +**_to follow_** + + + +#### Files in `twiki/templates` + +**_to follow_** + +-- [[MikeMannix]] - 28 Aug 2001 -- cgit v1.2.3