From 53e5f2d9b3bb36acf89d049d626698d747c68686 Mon Sep 17 00:00:00 2001 From: MikeMannix Date: Fri, 31 Aug 2001 12:03:51 +0000 Subject: none --- TWiki/TWikiImplementationNotes.mdwn | 67 ++++++++++++------------------------- 1 file changed, 22 insertions(+), 45 deletions(-) (limited to 'TWiki') diff --git a/TWiki/TWikiImplementationNotes.mdwn b/TWiki/TWikiImplementationNotes.mdwn index adbb8425..11c4b307 100644 --- a/TWiki/TWikiImplementationNotes.mdwn +++ b/TWiki/TWikiImplementationNotes.mdwn @@ -1,10 +1,10 @@ %TOC% %STARTINCLUDE% -## TWiki Implementation Notes +## TWiki Software Environment -### Platforms and System Requirements +### 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. [ **_MM: Locate elsewhere and/or include one-liner and link for RCS..._** ] +TWiki is written in **Perl 5** and also uses some **shell commands**. It also requires that **GNU RCS** (Revision Control System) is installed on the same system. The current implementation runs best on a Linux machine, but it can also run with Microsoft Windows. @@ -52,9 +52,9 @@ TWiki is written in **Perl 5** and also uses some **shell commands**. The curren
-### Directory Structure +### TWiki Directory Structure -You can easily rename the root TWiki directory - **twiki** - to whatever you like by changing it in the **twiki.cfg** configuration file. However, to keep the current installation and future upgrades simple, you should leave the subdirectory structure - the folder names and locations - exactly as is: +You can easily rename the root TWiki directory - **twiki** - to whatever you like by changing it in the **twiki.cfg** configuration file. However, to keep the current installation and future upgrades simple, you should leave the subdirectory structure intact: @@ -104,7 +104,9 @@ You can easily rename the root TWiki directory - **twiki** - to wha
-**_Note: about the additional directories in data, elsewhere_** +### File Descriptions + +A rundown of the individual files in the current %VERSION% distribution, organized by TWiki root directories. Note that there may be minor differences in the start-up **data** files. @@ -222,7 +224,7 @@ You can easily rename the root TWiki directory - **twiki** - to wha -#### Files in `twiki/lib` +#### Files under `twiki/lib` @@ -237,86 +239,61 @@ You can easily rename the root TWiki directory - **twiki** - to wha -
TWiki.cfg For configuration, used by TWiki.pm
- - - -#### Files in `twiki/lib/TWiki` - - - - - - - + - + - + - + - + - + - + - + -
File:Used for:
Access.pmTWiki/Access.pm Access control
Attach.pmTWiki/Attach.pm Attachment handling
Meta.pmTWiki/Meta.pm Meta data in topics
Net.pmTWiki/Net.pm SMTP mail handling
Plugins.pmTWiki/Plugins.pm Plugin handling
Prefs.pmTWiki/Prefs.pm Preferences handling
Search.pmTWiki/Search.pm Search engine, used by wiki.pm
Store.pmTWiki/Store.pm Back-end storage, *.txt text file and *.txt,v RCS repository file handling
- - - -#### Files in `twiki/lib/TWiki/Plugins` - - - - - - - + - + - +
File:Used for:
DefaultPlugin.pmTWiki/Plugins/DefaultPlugin.pm Default plugin
EmptyPlugin.pmTWiki/Plugins/EmptyPlugin.pm Empty plugin, use to create your own
InterwikiPlugin.pmTWiki/Plugins/InterwikiPlugin.pm Refer to external Wikis and other Web sites
-#### Files in `twiki/pub` +#### Files under `twiki/pub` -
File: Used for:
- - @@ -493,7 +470,7 @@ You can easily rename the root TWiki directory - **twiki** - to wha -#### Files in `twiki/data` +#### Files under `twiki/data`
favicon.ico xxxx
-- cgit v1.2.3