head	1.37;
access;
symbols;
locks; strict;
comment	@# @;


1.37
date	2008.01.22.03.21.29;	author TWikiContributor;	state Exp;
branches;
next	1.36;

1.36
date	2007.02.05.00.18.43;	author TWikiContributor;	state Exp;
branches;
next	1.35;

1.35
date	2007.01.16.04.12.04;	author TWikiContributor;	state Exp;
branches;
next	1.34;

1.34
date	2006.06.25.16.26.27;	author TWikiContributor;	state Exp;
branches;
next	1.33;

1.33
date	2006.04.01.05.55.16;	author TWikiContributor;	state Exp;
branches;
next	1.32;

1.32
date	2006.02.01.12.01.19;	author TWikiContributor;	state Exp;
branches;
next	1.31;

1.31
date	2004.08.16.05.00.53;	author PeterThoeny;	state Exp;
branches;
next	1.30;

1.30
date	2004.08.15.10.03.45;	author PeterThoeny;	state Exp;
branches;
next	1.29;

1.29
date	2003.12.16.08.38.48;	author PeterThoeny;	state Exp;
branches;
next	1.28;

1.28
date	2003.02.02.01.26.29;	author PeterThoeny;	state Exp;
branches;
next	1.27;

1.27
date	2003.01.30.08.59.38;	author PeterThoeny;	state Exp;
branches;
next	1.26;

1.26
date	2003.01.25.07.17.55;	author PeterThoeny;	state Exp;
branches;
next	1.25;

1.25
date	2003.01.16.07.23.00;	author PeterThoeny;	state Exp;
branches;
next	1.24;

1.24
date	2002.01.13.00.31.41;	author MikeMannix;	state Exp;
branches;
next	1.23;

1.23
date	2002.01.09.04.17.33;	author MikeMannix;	state Exp;
branches;
next	1.22;

1.22
date	2001.09.15.08.27.33;	author MikeMannix;	state Exp;
branches;
next	1.21;

1.21
date	2001.09.12.07.33.18;	author MikeMannix;	state Exp;
branches;
next	1.20;

1.20
date	2001.09.09.23.18.12;	author MikeMannix;	state Exp;
branches;
next	1.19;

1.19
date	2001.09.08.22.22.29;	author MikeMannix;	state Exp;
branches;
next	1.18;

1.18
date	2001.09.08.05.18.59;	author MikeMannix;	state Exp;
branches;
next	1.17;

1.17
date	2001.09.07.15.42.16;	author JohnTalintyre;	state Exp;
branches;
next	1.16;

1.16
date	2001.09.07.10.01.36;	author MikeMannix;	state Exp;
branches;
next	1.15;

1.15
date	2001.09.05.16.08.47;	author JohnTalintyre;	state Exp;
branches;
next	1.14;

1.14
date	2001.09.05.11.01.11;	author MikeMannix;	state Exp;
branches;
next	1.13;

1.13
date	2001.09.04.01.04.17;	author MikeMannix;	state Exp;
branches;
next	1.12;

1.12
date	2001.09.01.07.20.29;	author MikeMannix;	state Exp;
branches;
next	1.11;

1.11
date	2001.09.01.04.47.30;	author MikeMannix;	state Exp;
branches;
next	1.10;

1.10
date	2001.08.31.12.03.51;	author MikeMannix;	state Exp;
branches;
next	1.9;

1.9
date	2001.08.30.00.04.57;	author MikeMannix;	state Exp;
branches;
next	1.8;

1.8
date	2001.08.29.00.47.55;	author MikeMannix;	state Exp;
branches;
next	1.7;

1.7
date	2001.08.28.08.19.39;	author JohnTalintyre;	state Exp;
branches;
next	1.6;

1.6
date	2001.08.27.06.42.08;	author MikeMannix;	state Exp;
branches;
next	1.5;

1.5
date	2001.03.04.18.56.08;	author PeterThoeny;	state Exp;
branches;
next	1.4;

1.4
date	2000.12.10.22.24.27;	author PeterThoeny;	state Exp;
branches;
next	1.3;

1.3
date	2000.11.02.08.20.55;	author PeterThoeny;	state Exp;
branches;
next	1.2;

1.2
date	2000.08.19.09.36.14;	author PeterThoeny;	state Exp;
branches;
next	1.1;

1.1
date	2000.04.22.00.59.49;	author PeterThoeny;	state Exp;
branches;
next	;


desc
@none
@


1.37
log
@buildrelease
@
text
@%META:TOPICINFO{author="TWikiContributor" date="1178317477" format="1.1" version="37"}%
%STARTINCLUDE%
---+ TWiki System Requirements

_Server and client requirements_

Low client and server base requirements are core features that keep TWiki widely deployable, particularly across a range of browser platforms and versions.  Many [[TWiki:Plugins.PluginPackage][Plugins]] and [[TWiki:Plugins.ContribPackage][contrib modules]] exist which enhance and expand TWiki's capabilities; they may have additional requirements.

%TOC%

---++ Server Requirements

TWiki is written in Perl 5, uses a number of shell commands, and requires [[http://www.gnu.org/software/rcs/rcs.html][RCS (Revision Control System)]], a GNU Free Software package. TWiki is developed in a basic Linux/Apache environment. It also works with Microsoft Windows, and should have no problem on any other platform that meets the requirements.

| *Resource* | *Required Server Environment *<nop>* |
| Perl | 5.6.1 or higher (5.8.4 or higher is recommended) |
| RCS | 5.7 or higher (including GNU =diff=) %BR% Optional, TWiki includes a pure perl implementation of RCS that can be used instead (although it's slower) |
| GNU =diff= | GNU =diff= 2.7 or higher is required when not using the all-Perl <nop>RcsLite.  %BR% Install on PATH if not included with RCS (check version with =diff -v=)  %BR% Must be the version used by RCS, to avoid problems with binary attachments - RCS may have hard-coded path to =diff= |
| GNU =patch= | For upgrades only: GNU =patch= is required when using the TWiki:Codev.UpgradeTWiki script |
| GNU =fgrep=, =egrep= | Modify command line parameters in configure if you use non-GNU grep programs |
| Cron/scheduler | %BULLET% Unix: =cron= %BB% Windows: =cron= equivalents <!-- SMELL: Macintosh version? --> |
| Web server | Apache is well supported; see TWiki:TWiki.InstallingTWiki#OtherWebServers for other servers |

---+++ Required CPAN Modules
The following Perl modules are used by TWiki:
| *Module* | *Preferred version* |
| Algorithm::Diff (included) | |
| CGI::Carp | >=1.26 |
| Config | >=0 |
| Cwd | >=3.05 | 
| Data::Dumper | >=2.121 |
| Error (included) | |
| File::Copy | >=2.06 |
| File::Find | >=1.05 |
| File::Spec | >=3.05 |
| File::Temp | (included with perl 5.6 and later) |
| !FileHandle | >=2.01 |
| IO::File | >=1.10 |
| Text::Diff (included) | |
| Time::Local | >=1.11 |

---+++ Optional CPAN Modules
The following Perl modules may be used by TWiki:
| *Module* | *Preferred version* | *Description* |
| CGI::Cookie | >=1.24 | Used for session support |
| CGI::Session | >=3.95 | Used for session support |
| Digest::base | | |
| Digest::SHA1 | | |
| Jcode | | Used for <nop>I18N support with perl 5.6 |
| Locale::Maketext::Lexicon | >=0 | Used for <nop>I18N support |
| Net::SMTP | >=2.29 | Used for sending mail |
| Unicode::Map | | Used for <nop>I18N support with perl 5.6 |
| Unicode::Map8 | | Used for <nop>I18N support with perl 5.6 |
| Unicode::MapUTF8 | | Used for <nop>I18N support with perl 5.6 |
| Unicode::String | | Used for <nop>I18N support with perl 5.6 |
| URI | | Used for configure |

Most of them will probably already be available in your installation. You can check version numbers with the =configure= script, or if you're still trying to get to that point, check from the command line like this:
<verbatim>
perl -e 'use FileHandle; print $FileHandle::VERSION."\n"'
</verbatim>
<!--
SMELL: perhaps put download link to TWiki:Plugins.CpanContrib? (which 
also includes prebuilt versions of all of the CPAN modules used by 
all of the plugins checked into SVN)
-->

#ClientRequirements
---++ Client Requirements

The TWiki [[TWikiInstallationGuide][standard installation]] has relatively low browser requirements:

   * HTML 3.2 compliant
   * Cookies, if persistent sessions are required

CSS and Javascript are used in most skins, although there is a low-fat skin (Classic skin) available that minimises these requirements. Some skins will require more recent releases of browsers. The default skin (Pattern) is tested on IE 6, Safari, and Mozilla 5.0 based browsers (such as Firefox).
<!--
SMELL: what are some actual known good version number requirements for these browsers (eg, FireFox 1.0, or 1.0.3, or 1.0.7, or ???), etc.
-->

You can easily select a balance of browser capability versus look and feel. Try the installed skins at %SYSTEMWEB%.TWikiSkinBrowser and more at TWiki:Plugins.SkinPackage.

---++ Important note about TWiki Plugins

   * Plugins can require just about anything -  browser-specific functions, stylesheets (CSS), Java applets, cookies, specific Perl modules,... - check the individual Plugin specs.

__Related Topics:__ AdminDocumentationCategory
@


1.36
log
@buildrelease
@
text
@d1 1
a1 2
%META:TOPICINFO{author="TWikiContributor" date="1158017064" format="1.0" version="36"}%
%TOC%
d3 1
a3 1
---# TWiki System Requirements
d9 2
d16 1
a16 1
| Perl | 5.005_03 or higher (5.8.4 or higher is recommended) |
d81 1
a81 1
You can easily select a balance of browser capability versus look and feel. Try the installed skins at %TWIKIWEB%.TWikiSkinBrowser and more at TWiki:Plugins.SkinPackage.
a85 1
      * __%T% Note:__ Plugins included in the TWiki distribution do not add requirements, except for the CommentPlugin which requires Perl 5.6.1.
@


1.35
log
@buildrelease
@
text
@d1 1
a1 1
%META:TOPICINFO{author="TWikiContributor" date="1158017064" format="1.0" version="35"}%
d48 2
a49 2
| Jcode | | Used for I18N support with perl 5.6 |
| Locale::Maketext::Lexicon | >=0 | Used for I18N support |
d51 4
a54 4
| Unicode::Map | | Used for I18N support with perl 5.6 |
| Unicode::Map8 | | Used for I18N support with perl 5.6 |
| Unicode::MapUTF8 | | Used for I18N support with perl 5.6 |
| Unicode::String | | Used for I18N support with perl 5.6 |
@


1.34
log
@buildrelease
@
text
@d1 1
a1 1
%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="34"}%
d19 1
a19 1
| Other external programs | =fgrep, egrep= |
@


1.33
log
@buildrelease
@
text
@d1 1
a1 1
%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="33"}%
d35 1
@


1.32
log
@buildrelease
@
text
@d1 1
a1 1
%META:TOPICINFO{author="TWikiContributor" date="1111929255" format="1.0" version="32"}%
d18 1
d71 2
a72 2
	* HTML 3.2 compliant
	* Cookies, if persistent sessions are required
d83 2
a84 2
	* Plugins can require just about anything -  browser-specific functions, stylesheets (CSS), Java applets, cookies, specific Perl modules,... - check the individual Plugin specs.
		* __%T% Note:__ Plugins included in the TWiki distribution do not add requirements, except for the CommentPlugin which requires Perl 5.6.1.
@


1.31
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1092632453" format="1.0" version="1.31"}%
d6 1
a6 1
_Server and client requirements for TWiki 01-Sep-2004_
d8 1
a8 1
Low client and server requirements are core features that keep TWiki widely deployable, particularly across a range of browser platforms and versions.
d15 2
a16 3
| Perl | 5.005_03 or higher (5.6.1 recommended, 5.8.x does work in most cases, but see TWiki:Codev.IssuesWithPerl5dot8) |
| Non-standard Perl modules | %BULLET% Unix: =Net::SMTP= (or =sendmail=) %BB% Windows: =Net::SMTP=, =MIME::Base64=, =Digest::SHA1= %BB% Internationalisation: =Unicode::MapUTF8= &nbsp; <font size="-1">(only for non-ISO-8859-1 sites using TWiki:Codev.EncodeURLsWithUTF8 with Perl 5.6 or lower)</font> |
| RCS | 5.7 or higher (including GNU =diff=) %BR% Optional, but the all-Perl RCS replacement is not currently recommended for live sites - see TWiki:Codev.RcsLite |
d19 2
a20 2
| Cron/scheduler | %BULLET% Unix: =cron= %BB% Windows: =cron= equivalents |
| Web server | Apache 1.3 is well supported; Apache 2.0 is *not* recommended yet (see TWiki:Codev.IssuesWithApache2dot0). %BR% For other servers, CGI support, authentication, extended path info required; also, the =register= script is likely to need significant changes |
d22 42
a63 1
%X% *** _Current documentation mainly covers Linux and Apache installations. See WindowsInstallCookbook for a Windows installation guide.  See TWiki:Codev.TWikiOn for help with installation on various platforms including Unix, <nop>MacOS X, Apache =mod_perl=, web hosts, etc._
d68 1
a68 1
The TWiki [[TWikiInstallationGuide][standard installation]] has extremely low browser requirements:
d71 1
a71 4
	* generates XHTML 1.0 pages that are compatible with HTML 3.2
	* minimal use of <nop>JavaScript in the user interface (degrades gracefully)
	* no cookies
	* no CSS (if the ClassicSkin is used)
d73 4
a76 1
You can easily add functionality, by customizing TWikiTemplates, for one, while tailoring the browser requirements to your situation. 
d78 1
a78 1
---++ Known Issues
d80 1
a80 2
	* The TWikiPlugins feature currently does not have compatibility guidelines for developers. Plugins can require just about anything -  browser-specific functions, stylesheets (CSS), Java applets, cookies, specific Perl modules,... - check the individual Plugin specs.
		* %H% Plugins included in the TWiki distribution do not add requirements.
d82 2
a83 2
-- TWiki:Main.MikeMannix - 12 Jan 2002 %BR%
-- TWiki:Main.PeterThoeny - 15 Aug 2004
d85 1
a85 1
%META:TOPICMOVED{by="PeterThoeny" date="1042701667" from="TWiki.TWikiImplementationNotes" to="TWiki.TWikiSystemRequirements"}%
@


1.30
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1092564225" format="1.0" version="1.30"}%
d6 1
a6 1
_Server and client requirements for TWiki 01-Feb-2003_
d34 1
a34 1
	* no CSS
@


1.29
log
@none
@
text
@d1 45
a45 44
%META:TOPICINFO{author="PeterThoeny" date="1071563928" format="1.0" version="1.29"}%
%TOC%
%STARTINCLUDE%
---# TWiki System Requirements

_Server and client requirements for TWiki 01-Feb-2003_

Low client and server requirements are core features that keep TWiki widely deployable, particularly across a range of browser platforms and versions.

---++ Server Requirements

TWiki is written in Perl 5, uses a number of shell commands, and requires [[http://www.gnu.org/software/rcs/rcs.html][RCS (Revision Control System)]], a GNU Free Software package. TWiki is developed in a basic Linux/Apache environment. It also works with Microsoft Windows, and should have no problem on any other platform that meets the requirements.

| *Resource* | *Required Server Environment *<nop>* |
| Perl | 5.005_03 or higher (5.6.1 recommended, 5.8.0 *not* recommended yet, see TWiki:Codev.IssuesWithPerl5dot8) |
| Non-standard Perl modules | %BULLET% Unix: =Net::SMTP= (or =sendmail=) %BB% Windows: =Net::SMTP=, =MIME::Base64=, =Digest::SHA1= |
| RCS | 5.7 or higher (including GNU =diff=) %BR% Optional, but the all-Perl RCS replacement is not currently recommended for live sites - see TWiki:Codev.RcsLite |
| GNU =diff= | GNU =diff= 2.7 or higher is required when not using the all-Perl <nop>RcsLite.  %BR% Install on PATH if not included with RCS (check version with =diff -v=)  %BR% Must be the version used by RCS, to avoid problems with binary attachments - RCS may have hard-coded path to =diff= |
| Other external programs | =fgrep, egrep= |
| Cron/scheduler | %BULLET% Unix: =cron= %BB% Windows: =cron= equivalents |
| Web server | Apache 1.3 is well supported; Apache 2.0 is *not* recommended yet (see TWiki:Codev.IssuesWithApache2dot0). %BR% For other servers, CGI support, authentication, extended path info required; also, the =register= script is likely to need significant changes |

%X% *** _Current documentation mainly covers Linux and Apache installations. See WindowsInstallCookbook for a Windows installation guide.  See TWiki:Codev.TWikiOn for help with installation on various platforms including Unix, <nop>MacOS X, Apache =mod_perl=, web hosts, etc._

#ClientRequirements
---++ Client Requirements

The TWiki [[TWikiInstallationGuide][standard installation]] has extremely low browser requirements:

	* HTML 3.2 compliant
	* generates XHTML 1.0 pages that are compatible with HTML 3.2
	* minimal use of <nop>JavaScript in the user interface (degrades gracefully)
	* no cookies
	* no CSS

You can easily add functionality, by customizing TWikiTemplates, for one, while tailoring the browser requirements to your situation. 

---++ Known Issues

	* The TWikiPlugins feature currently does not have compatibility guidelines for developers. Plugins can require just about anything -  browser-specific functions, stylesheets (CSS), Java applets, cookies, specific Perl modules,... - check the individual Plugin specs.
		* %H% Plugins included in the TWiki distribution do not add requirements.

-- TWiki:Main.MikeMannix - 12 Jan 2002 %BR%
-- TWiki:Main.PeterThoeny - 16 Dec 2003
@


1.28
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1044149189" format="1.0" version="1.28"}%
d14 8
a21 9
| *Required Server Environment* |||
| *Resource* | *Unix* | *Windows** |
| Perl |  5.005_03 or higher (5.6.1 recommended, <br /> 5.8.0 *not* recommended yet, see TWiki:Codev.UsingPerl58OnRedHat8)  ||
| Non-standard Perl modules |  =Net::SMTP= (or =sendmail=)  |  =Net::SMTP=, =MIME::Base64=, =Digest::SHA1=  |
| RCS |  5.7 or higher (including GNU =diff=) %BR% Optional, but the all-Perl RCS replacement is not currently recommended for live sites - see TWiki:Codev.RcsLite.  ||
| GNU =diff= |  GNU =diff= 2.7 or higher is required when not using the all-Perl <nop>RcsLite.  %BR% Install on PATH if not included with RCS (check version with =diff -v=)  ||
| Other external programs |  =ls, fgrep, egrep=  ||
| Cron/scheduler |  =cron=  | =cron= equivalents |
| Web server |  Apache 1.3 is well supported; Apache 2.0 is *not* recommended yet (see TWiki:Support.FailedAuthenticationWithApache2OnWinNT). %BR% For other servers, CGI support, authentication, extended path required  ||
d42 3
a44 2
 
-- MikeMannix - 12 Jan 2002
@


1.27
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1043917178" format="1.0" version="1.27"}%
d6 1
a6 1
_Server and client requirements for TWiki 01-Feb-2003 (pending release)_
@


1.26
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1043479075" format="1.0" version="1.26"}%
d24 1
a24 1
%X% *** _Current documentation mainly covers Linux and Apache installations. See TWiki:Codev.WindowsInstallCookbook for a Windows installation guide.  See TWiki:Codev.TWikiOn for help with installation on various platforms including Unix, <nop>MacOS X, Apache =mod_perl=, web hosts, etc._
@


1.25
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="PeterThoeny" date="1042701780" format="1.0" version="1.25"}%
d16 1
a16 1
| Perl |  5.005_03 or higher (5.6.1 recommended)  ||
d18 2
a19 2
| RCS |  5.7 or higher (including GNU =diff=) %BR% Optional, but the all-Perl replacement is not currently recommended for live sites - see TWiki:Codev/RcsLite.  ||
| GNU =diff= |  GNU =diff= 2.7 or higher is required when TWiki's uses RCS binaries.  %BR% Install on PATH if not included with RCS (check version with =diff -v=)  ||
d22 1
a22 1
| Web server |  Apache is well supported; for other servers, CGI support, authentication, extended path required  ||
d24 1
a24 1
%X% *** _Current documentation mainly covers Linux and Apache installations. See WindowsInstallCookbook for a Windows installation guide._
d41 1
a41 1
	* The new TWikiPlugins feature currently does not have compatibility guidelines for developers. Plugins can require just about anything -  browser-specific functions, stylesheets (CSS), Java applets, cookies, specific Perl modules,... - check the individual Plugin specs.
@


1.24
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="1010881901" format="1.0" version="1.24"}%
d6 1
a6 1
_Server and client requirements for TWiki 01-Dec-2001_
d16 1
a16 1
| Perl |  5.005_03 or higher  ||
d18 2
a19 1
| RCS |  5.7 or higher  ||
d21 2
a22 1
| Web server |  Apache; others (with CGI support, authentication, extended path) ||
d24 1
a24 1
%X% *** _Current documentation covers Linux/Apache only. See TWiki:Codev/TWikiOnWindows for work-to-date on a Windows installation guide._
d44 2
a45 1
-- MikeMannix - 12 Jan 2002
@


1.23
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="1010549853" format="1.0" version="1.23"}%
d6 1
a6 1
_Server and client system requirements for TWiki 01-Dec-2001_
d8 1
a8 3
---++ Overview

Maintaining minimum client and server requirements is necessary to keep TWiki deployment as broad as possible.
d12 1
a12 1
TWiki is written in Perl 5, uses a number of shell commands, and requires [[http://www.gnu.org/software/rcs/rcs.html][RCS (Revision Control System)]], a GNU Free Software package. TWiki is developed in a basic Linux/Apache environment. It also works with Microsoft Windows, and should have no problem on any other platform that meets the requirements:
d15 1
a15 1
| *Resource* | *Unix* | *Windows* |
d17 1
a17 1
| Non standard Perl modules |  =Net::SMTP= (or =sendmail=)  |  =Net::SMTP=, =MIME::Base64=, =Digest::SHA1=  |
d20 1
a20 1
| Web server |  Apache; others (with support for CGI, authentication, extended path) ***  ||
d22 1
a22 1
Current documentation covers Linux only. A [[http://twiki.org/cgi-bin/view/Codev/TWikiOnWindows][TWikiOnWindows]] installation guide is next. 
d24 1
d35 1
a35 1
You can easily add capabilities, through customizing the templates, for one, while tailoring the browser requirements to your situation. 
d39 4
a42 3
	* The new TWikiPlugins feature currently does not have compatibility guidelines for developers. Plugins can require just about anything: browser-specific functions, stylesheets (CSS), DHTML, Java applets, cookies.

-- MikeMannix - 08 Jan 2002
@


1.22
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="1000544189" format="1.0" version="1.22"}%
d6 1
a6 1
_Server and client system requirements for TWiki 01-Sep-2001_
d42 1
a42 1
-- MikeMannix - 15 Sep 2001 <br />
@


1.21
log
@none
@
text
@d1 1
a1 3
%META:TOPICINFO{author="PeterThoeny" date="1000450173" format="1.0" version="1.21"}%
%INCLUDE{"UtilTempDocNote"}%

d6 1
a6 1
_Server and client system requirements of TWiki 01-Sep-2001_
d10 1
a10 1
Maintaining minimum client and server requirements is necessary to keep TWiki deployment as broad as possible. 
d12 1
a12 1
---++ Server-Side Requirements
d14 1
a14 1
TWiki is written in Perl 5 and uses a number of shell commands. It requires GNU RCS (Revision Control System) to be installed on the same system. TWiki is developed in a standard Linux/Apache environment. It can also work with Microsoft Windows and other platforms.
d24 1
a24 1
Current documentation covers Linux only. Compiling a basic [[http://twiki.org/cgi-bin/view/Codev/TWikiOnWindows][TWikiOnWindows]] installation guide is an ongoing effort. 
d26 1
a26 1
---++ Client-Side Requirements
d28 1
a28 1
The TWiki standard installation has extremely low browser requirements:
d31 1
d36 1
a36 1
TWiki generates XHTML 1.0 code as long as it is compatible with HTML 3.2.
d40 1
a40 1
	* The new TWikiPlugins feature currently does not have any compatibility guidelines for developers. Plugins can require just about anything: browser-specific functions, stylesheets (CSS), Java, cookies, etc.
d42 1
a42 1
-- MikeMannix - 29 Aug 2001 
@


1.20
log
@none
@
text
@d1 3
a3 1
%META:TOPICINFO{author="MikeMannix" date="1000077544" format="1.0" version="1.20"}%
d21 1
a21 1
| Non standard Perl modules |  =Net::SMTP= (or =sendmail=)  |  =Net::SMTP=, =MIME::Base64=,  =Digest::SHA1= |
@


1.19
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="999987801" format="1.0" version="1.19"}%
d4 1
a4 1
---# TWiki Requirements
d6 1
a6 1
_Server and client system requirements; file system structure_
@


1.18
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="999927128" format="1.0" version="1.18"}%
d4 1
a4 1
---# TWiki Application Environment
d37 1
a37 1
---+++ Known Issues
a39 188

---++ TWiki File System

You can 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:

| *Directory:*		  | *Files:*		 | *Used for:* |
| =twiki=			  |  [[#TWikiFiles][list]]  | Start-up info |
| =twiki/bin=		 |  [[#BinFiles][list]]  | Perl scripts  |
| =twiki/lib=		 |  [[#LibFiles][list]]  | Configuration file, main library, Perl system modules, Plugins |
| =twiki/pub=		 |  [[#PubFiles][list]]  | Public support files (ex: FileAttachments, images) and RCS histories) |
| =twiki/data=		|  [[#DataFiles][list]]  | Topic text (page content) and RCS histories; |
| =twiki/templates= |  [[#TemplatesFiles][list]]  | HTML templates, used by TWiki scripts |

---+++ File Descriptions

A rundown of the individual files included in the current 01-Sep-2001 distribution, organized by TWiki root directories.

#TWikiFiles
---++++ Files in <code>twiki</code>

Application info and the current reference documentation. _Full file list:_

| *File:*		 | *Used for:* |
| =index.html= | A page with a link to first launch TWiki after install |
| =license.txt=		  | GNU General Public License and TWiki-specific info |
| =readme.txt=		  | General TWiki start-up info with relevant URLs |
| =TWikiDocumentation.html=			 | All documentation packaged as a single page |
| =TWikiHistory.html=		  | TWiki development timeline |

#BinFiles
---++++ Files in <code>twiki/bin</code>

Perl CGI scripts. _Full file list:_

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

#LibFiles
---++++ Files under <code>twiki/lib</code>

The new =lib/TWiki/Plugins= directories contain configuration, library and function files, and [[TWikiDocumentation#TWiki_Plugins][TWikiPlugins]]. _Full file list:_

| *File:*			  | *Used for:* |
| =TWiki.pm=		| Main TWiki library |
| =TWiki.cfg=	  | For configuration, used by =TWiki.pm= |
| =TWiki/Access.pm=	| Access control |
| =TWiki/Attach.pm=	| Attachment handling |
| =TWiki/Form.pm=	  | Form handling |
| =TWiki/Meta.pm=	  | Meta data in topics |
| =TWiki/Net.pm=		| SMTP mail handling |
| =TWiki/Plugins.pm=  | Plugin handling |
| =TWiki/Prefs.pm=	 | Preferences handling |
| =TWiki/Search.pm=	| Search engine, used by wiki.pm |
| =TWiki/Store.pm=	 | Back-end storage, =*.txt= text file and =*.txt,v= RCS repository file handling |
| =TWiki/Plugins/DefaultPlugin.pm= | Handles some legacy rules |
| =TWiki/Plugins/EmptyPlugin.pm=	| Empty plugin, use to create your own |
| =TWiki/Plugins/InterwikiPlugin.pm= | Use aliases as links for predefined URLs |

#PubFiles
---++++ Files under <code>twiki/pub</code>

The =pub= directory stores data-related files, including images used by TWiki and FileAttachments. Attachments are stored in sub-directories created with the related topic name. _Partial file list:_

| *File:*			| *Used for:* |
| =favicon.ico= | ICO file |
| =twikilogo.gif= | GIF file |
| =twikilogo1.gif= | GIF file |
| =twikilogo2.gif= | GIF file |
| =twikilogo3.gif= | GIF file |
| =twikilogo4.gif= | GIF file |
| =wikiHome.gif= | GIF file |
| =icn/_filetypes.txt= | GIF file |
| =icn/bat.gif= | GIF file |
| =icn/bmp.gif= | GIF file |
|  *...*  |  *...*  |
| =TWiki/FileAttachment/Sample.txt= | TEXT file |
| =TWiki/FileAttachment/Smile.gif= | GIF file |
| =TWiki/PreviewBackground/blankltgraybg.gif= | GIF file |
| =TWiki/PreviewBackground/blankwhitebg.gif= | GIF file |
| =TWiki/PreviewBackground/previewbg.gif= | GIF file |
| =TWiki/WabiSabi/wabisabi.gif= | GIF file |

#DataFiles
---++++ Files under <code>twiki/data</code>

TWiki page data stored as individual text files. Each active web has its own subdirectory. The TWiki distribution includes four start-up webs - =Main=, =TWiki=, =Know=, =Test= - with documentation and demo content, and a =_default= directory containing all topics required to start a new web. _Partial file list:_ 

| *File:*			| *Used for:* |
| =.htpasswd= | Basic Authentication (htaccess) password file |
| =debug.txt= | Program messages useful for debugging |
| =mime.types= | Recognized file formats |
| =warning.txt= | Diagnostic messages for identifying problems |
| _default directory can be copied to empty directory when creating new Webs ||
| =_default/.changes= | Web-level record of topic changes |
| =_default/WebChanges.txt= | Display most recent topic changes in web|
| =_default/WebChanges.txt,v= | Revisions history (RCS) |
| =_default/WebHome.txt= | Default web home page |
| =_default/WebHome.txt,v= | Revisions history (RCS) |
| =_default/WebIndex.txt= | Lists all topics in a web|
| =_default/WebIndex.txt,v= | Revisions history (RCS) |
| =_default/WebNotify.txt= | Subscribe/unsubscribe to web changes email alert |
| =_default/WebNotify.txt,v= | Revisions history (RCS) |
| =_default/WebPreferences.txt= | Web-level preference settings |
| =_default/WebPreferences.txt,v= | Revisions history (RCS) |
| =_default/WebSearch.txt= | Web-level search options |
| =_default/WebSearch.txt,v= | Revisions history (RCS) |
| =_default/WebStatistics.txt= | Generates web usage statistics |
| =_default/WebStatistics.txt,v= | Revisions history (RCS) |
|  *...*  |  *...*  |

#TemplatesFiles
---++++ Files in <code>twiki/templates</code>

Templates used to control appearance of all rendered pages. _Full file list:_

| *File:*			| *Used for:* |
| =oopsbadpwformat.tmpl= | Error message |
| =attachagain.tmpl= | Control screen |
| =attachnew.tmpl= | Control screen |
| =changeform.tmpl= | Control screen |
| =changes.tmpl= | Displays WebChanges list of recently changed topics |
| =edit.iejs.tmpl= | xxxx |
| =edit.tmpl= | Main edit window |
| =mailnotify.tmpl= | xxxx |
| =moveattachment.tmpl= | Control screen |
| =oopsaccesschange.tmpl= | Error message |
| =oopsaccessgroup.tmpl= | Error message |
| =oopsaccessrename.tmpl= | Error message |
| =oopsaccessview.tmpl= | Error message |
| =oopsauth.tmpl= | Error message |
| =attach.tmpl= | Error message |
| =oopschangepasswd.tmpl= | Error message |
| =oopsempty.tmpl= | Error message |
| =oopslocked.tmpl= | Error message |
| =oopslockedrename.tmpl= | Error message |
| =oopsmissing.tmpl= | Error message |
| =oopsmoveerr.tmpl= | Error message |
| =oopsnoformdef.tmpl= | Error message |
| =oopsnotwikiuser.tmpl= | Error message |
| =oopsnoweb.tmpl= | Error message |
| =oopspreview.tmpl= | Error message |
| =oopsregexist.tmpl= | Error message |
| =oopsregpasswd.tmpl= | Error message |
| =oopsregrequ.tmpl= | Error message |
| =oopsregthanks.tmpl= | Error message |
| =oopsregwiki.tmpl= | Error message |
| =oopsrenameerr.tmpl= | Error message |
| =oopsresetpasswd.tmpl= | Error message |
| =oopsrev.tmpl= | Error message |
| =oopssave.tmpl= | Error message |
| =oopssaveerr.tmpl= | Error message |
| =oopssendmailerr.tmpl= | Error message |
| =oopstopicexists.tmpl= | Error message |
| =oopsupload.tmpl= | Error message |
| =oopswrongpassword.tmpl= | Error message |
| =preview.tmpl= | Preview Changes screen |
| =rdiff.tmpl= | Displays text changes before &amp; after (Diffs) |
| =register.tmpl= | Registration page |
| =registernotify.tmpl= | xxxx |
| =rename.tmpl= | Doing a new topic rename, user chooses web &amp; topic |
| =renamebase.tmpl= | Used by other rename templates |
| =renameconfirm.tmpl= | Confirms a pre-specified rename, ex: undoing a rename |
| =renamerefs.tmpl= | Rename done, but some references not changed (topics were  locked) |
| =search.tmpl= | xxxx |
| =searchbookview.tmpl= | Search results with full topic content |
| =searchmeta.tmpl= | xxxx |
| =searchrenameview.tmpl= | Used by =rename= to list references to topic being renamed |
| =twiki.tmpl= | Base template definitions used by other templates |
| =view.plain.tmpl= | Alternate topic header/footer view |
| =view.print.tmpl= | Alternate topic header/footer view |
| =view.tmpl= | Main topic view |
@


1.17
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="JohnTalintyre" date="999877336" format="1.0" version="1.17"}%
d4 1
a4 1
---# TWiki Operating Environment
d6 1
a6 1
_Server and client system requirements, file system structure_
d55 1
a55 1
A rundown of the individual files in the current %VERSION% distribution, organized by TWiki root directories. All listings are complete unless otherwise noted.
d60 1
a60 1
Introductory and installation files.
d65 1
a65 1
| =readme.txt=		  | General TWiki start-up info with relevant URLs. |
d72 1
a72 1
All Perl CGI scripts.
d97 1
a97 1
The new =lib/TWiki/Plugins= directories contain core configuration, libraries and function modules, and Plugins.
d111 1
a111 1
| =TWiki/Plugins/DefaultPlugin.pm= | Default plugin |
d113 1
a113 1
| =TWiki/Plugins/InterwikiPlugin.pm= | Refer to external Wikis and other Web sites |
d118 1
a118 1
__attachments like images...__
d121 17
a137 43
| =favicon.ico= | xxxx |
| =twikilogo.gif= | xxxx |
| =twikilogo1.gif= | xxxx |
| =twikilogo2.gif= | xxxx |
| =twikilogo3.gif= | xxxx |
| =twikilogo4.gif= | xxxx |
| =wikiHome.gif= | xxxx |
| =icn/_filetypes.txt= | xxxx |
| =icn/bat.gif= | xxxx |
| =icn/bmp.gif= | xxxx |
| =icn/c.gif= | xxxx |
| =icn/dll.gif= | xxxx |
| =icn/doc.gif= | xxxx |
| =icn/else.gif= | xxxx |
| =icn/exe.gif= | xxxx |
| =icn/fon.gif= | xxxx |
| =icn/h.gif= | xxxx |
| =icn/hlp.gif= | xxxx |
| =icn/html.gif= | xxxx |
| =icn/java.gif= | xxxx |
| =icn/mov.gif= | xxxx |
| =icn/pdf.gif= | xxxx |
| =icn/pl.gif= | xxxx |
| =icn/ppt.gif= | xxxx |
| =icn/ps.gif= | xxxx |
| =icn/py.gif= | xxxx |
| =icn/ram.gif= | xxxx |
| =icn/reg.gif= | xxxx |
| =icn/sh.gif= | xxxx |
| =icn/sniff.gif= | xxxx |
| =icn/ttf.gif= | xxxx |
| =icn/txt.gif= | xxxx |
| =icn/wav.gif= | xxxx |
| =icn/wri.gif= | xxxx |
| =icn/xls.gif= | xxxx |
| =icn/zip.gif= | xxxx |
| =Know/IncorrectDllVersionW32PTH10DLL/W32PTH10.DLL= | xxxx |
| =TWiki/FileAttachment/Sample.txt= | xxxx |
| =TWiki/FileAttachment/Smile.gif= | xxxx |
| =TWiki/PreviewBackground/blankltgraybg.gif= | xxxx |
| =TWiki/PreviewBackground/blankwhitebg.gif= | xxxx |
| =TWiki/PreviewBackground/previewbg.gif= | xxxx |
| =TWiki/WabiSabi/wabisabi.gif= | xxxx |
d142 1
a142 1
The =data= directory stores TWiki page data as individual text files. Each active web has its own subdirectory. The TWiki distribution package includes four start-up webs, with a number of pages of documentation and demo content. _This is a representative partial file listing..._
d145 4
a148 4
| =.htpasswd= | xxxx |
| =debug.txt= | xxxx |
| =mime.types= | xxxx |
| =warning.txt= | xxxx |
d150 15
a164 51
| =_default/.changes= | Record of topic changes recorded here |
| =_default/WebChanges.txt= | Display most recent changes |
| =_default/WebChanges.txt,v= | History |
| =_default/WebHome.txt= | xxxx |
| =_default/WebHome.txt,v= | xxxx |
| =_default/WebIndex.txt= | xxxx |
| =_default/WebIndex.txt,v= | xxxx |
| =_default/WebNotify.txt= | xxxx |
| =_default/WebNotify.txt,v= | xxxx |
| =_default/WebPreferences.txt= | xxxx |
| =_default/WebPreferences.txt,v= | xxxx |
| =_default/WebSearch.txt= | xxxx |
| =_default/WebSearch.txt,v= | xxxx |
| =_default/WebStatistics.txt= | xxxx |
| =_default/WebStatistics.txt,v= | xxxx |
|  *...*  |  *...*  |
| =Know/TopicClassification.txt= | xxxx |
| =Know/TopicClassification.txt,v= | xxxx |
| =Know/TWikiCategory.txt= | xxxx |
| =Know/TWikiCategory.txt,v= | xxxx |
| =Know/UseCategory.txt= | xxxx |
| =Know/UseCategory.txt,v= | xxxx |
| =Know/WebChanges.txt= | xxxx |
| =Know/WebChanges.txt,v= | xxxx |
| =Know/WebForm.txt= | xxxx |
| =Know/WebForm.txt,v= | xxxx |
|  *...*  |  *...*  |
| =Main/OfficeLocations.txt= | xxxx |
| =Main/OfficeLocations.txt,v= | xxxx |
| =Main/PeterThoeny.txt= | xxxx |
| =Main/PeterThoeny.txt,v= | xxxx |
| =Main/SanJoseOffice.txt= | xxxx |
| =Main/SanJoseOffice.txt,v= | xxxx |
|  *...*  |  *...*  |
| =Main/TWikiGuest.txt= | xxxx |
| =Main/TWikiGuest.txt,v= | xxxx |
| =Main/TWikiUsers.txt= | xxxx |
| =Main/TWikiUsers.txt,v= | xxxx |
|  *...*  |  *...*  |
| =Test/TestTopic1.txt= | xxxx |
| =Test/TestTopic1.txt,v= | xxxx |
| =Test/WebHome.txt= | xxxx |
| =Test/WebHome.txt,v= | xxxx |
|  *...*  |  *...*  |
| =Trash/WebHome.txt= | xxxx |
| =Trash/WebHome.txt,v= | xxxx |
|  *...*  |  *...*  |
| =TWiki/DeleteTopic.txt= | xxxx |
| =TWiki/DeleteTopic.txt,v= | xxxx |
| =TWiki/DontNotify.txt= | xxxx |
| =TWiki/DontNotify.txt,v= | xxxx |
d170 1
a170 1
_Used to flexibly control appearance of rendered pages..._
d173 5
a177 5
| =oopsbadpwformat.tmpl= | xxxx |
| =attachagain.tmpl= | xxxx |
| =attachnew.tmpl= | xxxx |
| =changeform.tmpl= | xxxx |
| =changes.tmpl= | xxxx |
d179 1
a179 1
| =edit.tmpl= | xxxx |
d181 34
a214 34
| =moveattachment.tmpl= | xxxx |
| =oopsaccesschange.tmpl= | xxxx |
| =oopsaccessgroup.tmpl= | xxxx |
| =oopsaccessrename.tmpl= | xxxx |
| =oopsaccessview.tmpl= | xxxx |
| =oopsauth.tmpl= | xxxx |
| =attach.tmpl= | xxxx |
| =oopschangepasswd.tmpl= | xxxx |
| =oopsempty.tmpl= | xxxx |
| =oopslocked.tmpl= | xxxx |
| =oopslockedrename.tmpl= | xxxx |
| =oopsmissing.tmpl= | xxxx |
| =oopsmoveerr.tmpl= | xxxx |
| =oopsnoformdef.tmpl= | xxxx |
| =oopsnotwikiuser.tmpl= | xxxx |
| =oopsnoweb.tmpl= | xxxx |
| =oopspreview.tmpl= | xxxx |
| =oopsregexist.tmpl= | xxxx |
| =oopsregpasswd.tmpl= | xxxx |
| =oopsregrequ.tmpl= | xxxx |
| =oopsregthanks.tmpl= | xxxx |
| =oopsregwiki.tmpl= | xxxx |
| =oopsrenameerr.tmpl= | xxxx |
| =oopsresetpasswd.tmpl= | xxxx |
| =oopsrev.tmpl= | xxxx |
| =oopssave.tmpl= | xxxx |
| =oopssaveerr.tmpl= | xxxx |
| =oopssendmailerr.tmpl= | xxxx |
| =oopstopicexists.tmpl= | xxxx |
| =oopsupload.tmpl= | xxxx |
| =oopswrongpassword.tmpl= | xxxx |
| =preview.tmpl= | xxxx |
| =rdiff.tmpl= | xxxx |
| =register.tmpl= | xxxx |
d216 1
a216 1
| =rename.tmpl= | Doing a new topic rename, user chooses web & topic |
d218 2
a219 2
| =renameconfirm.tmpl= | Confirming a pre-specified rename e.g. when undoing a rename |
| =renamerefs.tmpl= | Rename done, still some references to change (topcis were previously locked) |
d221 1
a221 1
| =searchbookview.tmpl= | xxxx |
d224 4
a227 4
| =twiki.tmpl= | xxxx |
| =view.plain.tmpl= | xxxx |
| =view.print.tmpl= | xxxx |
| =view.tmpl= | xxxx |
@


1.16
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="999856896" format="1.0" version="1.16"}%
d104 1
d175 4
a178 3
| =_default/.changes= | xxxx |
| =_default/WebChanges.txt= | xxxx |
| =_default/WebChanges.txt,v= | xxxx |
d278 4
a281 4
| =rename.tmpl= | xxxx |
| =renamebase.tmpl= | xxxx |
| =renameconfirm.tmpl= | xxxx |
| =renamerefs.tmpl= | xxxx |
d285 1
a285 1
| =searchrenameview.tmpl= | xxxx |
@


1.15
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="JohnTalintyre" date="999706127" format="1.0" version="1.15"}%
d4 1
a4 1
---## TWiki Operating Environment
d8 1
a8 1
---+++ Overview
d12 1
a12 1
---+++ Server-Side Requirements
d26 1
a26 1
---+++ Client-Side Requirements
d37 1
a37 1
---++++ Known Issues
d41 1
a41 1
---+++ TWiki File System
d53 1
a53 1
---++++ File Descriptions
d58 1
a58 1
---+++++ Files in <code>twiki</code>
d70 1
a70 1
---+++++ Files in <code>twiki/bin</code>
d95 1
a95 1
---+++++ Files under <code>twiki/lib</code>
d115 1
a115 1
---+++++ Files under <code>twiki/pub</code>
d165 1
a165 1
---+++++ Files under <code>twiki/data</code>
a226 1

d228 1
a228 1
---+++++ Files in <code>twiki/templates</code>
@


1.14
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="999687993" format="1.0" version="1.14"}%
d19 1
a19 1
| Non standard Perl modules |  =Net::SMTP= (or =sendmail=)  |  =Net::SMTP=  | 
@


1.13
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="999566131" format="1.0" version="1.13"}%
d6 1
a6 1
Server and client system requirements, file system structure
d10 1
a10 1
Low requirements on client-side and server-side environment, to keep TWiki deployment as broad as possible is a key element of the __TWikiMission__. Strict W3C and ECMA standards compliance is also a mandate. These requirements are amended from time to time as technology progresses.
d14 1
a14 1
TWiki is written in *Perl 5* and uses a number of *shell commands*. It requires that *GNU RCS* (Revision Control System) be installed on the same system. Current development is on Linux. the recommended platform, but it can also work with Microsoft Windows and other OS.
d16 1
a16 1
| *Required Server Environment by Platform* |||
d22 1
a22 3
| Web server |  Apache and others (support for cgi, authentication, extended path) ***  ||
| _OS versions_ |  __Linux, Unix...__  |  __every last Win?!__  |
| Required disk space | | |
d24 1
a24 1
__ISP INSTALLATION REQUIREMENTS: SSI, RCS local or sysadmin, same for perl modules for plugins, cron, basic authentication,...__
d26 1
a26 1
---++ Client-Side Requirements
d28 1
a28 1
The basic TWiki engine and templates have a low requirement on the browser:
d30 4
a33 2
|  *Recommend PC Requirement*  |||
| *Component* | *Min/Rec* |
d35 1
a35 6
|  *Browser Requirements*  ||
| *Resource* | *Details* |
| HTML 3.2 browser | |
| <nop>JavaScript 1.? | Optional: JS degrades gracefully |
| Cookies | Not used |
| CSS1/2 | ???? |
d37 1
a37 1
	* TWiki generates XHTML 1.0 code as long as it is compatible with HTML 3.2.
d39 1
a39 6
__WHAT ABOUT WEB STANDARDS BROWSER COMPATIBILITY MOVEMENT & CSS CONTROL__

---+++ Known Issues

	* Some <nop>TWikiSkins may require more, like cookies and <nop>JavaScript
	* At present, contributed Plugins are not checked against compatibility standards, and may require anything imaginable: browser-specific functions, Java, cookies, CSS, etc.
d43 1
a43 1
You can 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:
d46 6
a51 6
| ==twiki==			  |  [[#TWikiFiles][list]]  | Start-up info |
| ==twiki/bin==		 |  [[#BinFiles][list]]  | Perl scripts  |
| ==twiki/lib==		 |  [[#LibFiles][list]]  | Configuration file, main library, Perl system modules, Plugins |
| ==twiki/pub==		 |  [[#PubFiles][list]]  | Public support files (ex: FileAttachments, images) and RCS histories) |
| ==twiki/data==		|  [[#DataFiles][list]]  | Topic text (page content) and RCS histories; |
| ==twiki/templates== |  [[#TemplatesFiles][list]]  | HTML templates, used by TWiki scripts |
d53 1
a53 1
---+++ File Descriptions
d55 1
a55 1
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. All listings are complete unless otherwise noted.
d58 1
a58 1
---++++ Files in <code>twiki</code>
d63 5
a67 5
| ==index.html== | A page with a link to first launch TWiki after install |
| ==license.txt==		  | GNU General Public License and TWiki-specific info |
| ==readme.txt==		  | General TWiki start-up info with relevant URLs. |
| ==TWikiDocumentation.html==			 | All documentation packaged as a single page |
| ==TWikiHistory.html==		  | TWiki development timeline |
d70 1
a70 1
---++++ Files in <code>twiki/bin</code>
d75 18
a92 18
| ==.htaccess.txt== | Authentication. Rename to .htaccess and customize if used |
| ==attach==		  | Script that shows the attach file page (FileAttachment) |
| ==delete==		  | (not used yet) |
| ==edit==			 | Script to edit a topic |
| ==geturl==		  | Script to fetch URL data |
| ==mailnotify==	 | Script called by cron job to notify users of changes |
| ==oops==			 | Script that shows an OK or oops dialog |
| ==preview==		 | Script to preview topic after edit |
| ==rdiff==			| Script to see differences of topics |
| ==rename==		  | Script to rename/move topics and move attachments |
| ==register==		| Script to register new users |
| ==save==			 | Script that saves a topic, called by preview |
| ==search==		  | Script that displays search results |
| ==statistics==	 | Script to create statistics topic |
| ==testenv==		 | Script to test CGI environment variables |
| ==upload==		  | Script that does file upload (FileAttachment) |
| ==view==			 | Script to view a topic ( *the* script ) |
| ==viewfile==		| Script to view an file attachment |
d95 1
a95 1
---++++ Files under <code>twiki/lib</code>
d97 1
a97 1
The new ==lib/TWiki/Plugins== directories contain core configuration, libraries and function modules, and Plugins.
d100 13
a112 13
| ==TWiki.pm==		| Main TWiki library |
| ==TWiki.cfg==	  | For configuration, used by ==TWiki.pm== |
| ==TWiki/Access.pm==	| Access control |
| ==TWiki/Attach.pm==	| Attachment handling |
| ==TWiki/Meta.pm==	  | Meta data in topics |
| ==TWiki/Net.pm==		| SMTP mail handling |
| ==TWiki/Plugins.pm==  | Plugin handling |
| ==TWiki/Prefs.pm==	 | Preferences handling |
| ==TWiki/Search.pm==	| Search engine, used by wiki.pm |
| ==TWiki/Store.pm==	 | Back-end storage, =*.txt= text file and =*.txt,v= RCS repository file handling |
| ==TWiki/Plugins/DefaultPlugin.pm== | Default plugin |
| ==TWiki/Plugins/EmptyPlugin.pm==	| Empty plugin, use to create your own |
| ==TWiki/Plugins/InterwikiPlugin.pm== | Refer to external Wikis and other Web sites |
d115 1
a115 1
---++++ Files under <code>twiki/pub</code>
d120 43
a162 43
| ==favicon.ico== | xxxx |
| ==twikilogo.gif== | xxxx |
| ==twikilogo1.gif== | xxxx |
| ==twikilogo2.gif== | xxxx |
| ==twikilogo3.gif== | xxxx |
| ==twikilogo4.gif== | xxxx |
| ==wikiHome.gif== | xxxx |
| ==icn/_filetypes.txt== | xxxx |
| ==icn/bat.gif== | xxxx |
| ==icn/bmp.gif== | xxxx |
| ==icn/c.gif== | xxxx |
| ==icn/dll.gif== | xxxx |
| ==icn/doc.gif== | xxxx |
| ==icn/else.gif== | xxxx |
| ==icn/exe.gif== | xxxx |
| ==icn/fon.gif== | xxxx |
| ==icn/h.gif== | xxxx |
| ==icn/hlp.gif== | xxxx |
| ==icn/html.gif== | xxxx |
| ==icn/java.gif== | xxxx |
| ==icn/mov.gif== | xxxx |
| ==icn/pdf.gif== | xxxx |
| ==icn/pl.gif== | xxxx |
| ==icn/ppt.gif== | xxxx |
| ==icn/ps.gif== | xxxx |
| ==icn/py.gif== | xxxx |
| ==icn/ram.gif== | xxxx |
| ==icn/reg.gif== | xxxx |
| ==icn/sh.gif== | xxxx |
| ==icn/sniff.gif== | xxxx |
| ==icn/ttf.gif== | xxxx |
| ==icn/txt.gif== | xxxx |
| ==icn/wav.gif== | xxxx |
| ==icn/wri.gif== | xxxx |
| ==icn/xls.gif== | xxxx |
| ==icn/zip.gif== | xxxx |
| ==Know/IncorrectDllVersionW32PTH10DLL/W32PTH10.DLL== | xxxx |
| ==TWiki/FileAttachment/Sample.txt== | xxxx |
| ==TWiki/FileAttachment/Smile.gif== | xxxx |
| ==TWiki/PreviewBackground/blankltgraybg.gif== | xxxx |
| ==TWiki/PreviewBackground/blankwhitebg.gif== | xxxx |
| ==TWiki/PreviewBackground/previewbg.gif== | xxxx |
| ==TWiki/WabiSabi/wabisabi.gif== | xxxx |
d165 1
a165 1
---++++ Files under <code>twiki/data</code>
d167 1
a167 1
The ==data== directory stores the content of TWiki pages as individual text files. Each active web has its own subdirectory. The TWiki distribution package includes four start-up webs, and quite a number of pages with documentation and demo content. _This is a representative partial file listing..._
d170 57
a226 73
| ==.htpasswd== | xxxx |
| ==debug.txt== | xxxx |
| ==mime.types== | xxxx |
| ==warning.txt== | xxxx |
| ==_default/.changes== | xxxx |
| ==_default/WebChanges.txt== | xxxx |
| ==_default/WebChanges.txt,v== | xxxx |
| ==_default/WebHome.txt== | xxxx |
| ==_default/WebHome.txt,v== | xxxx |
| ==_default/WebIndex.txt== | xxxx |
| ==_default/WebIndex.txt,v== | xxxx |
| ==_default/WebNotify.txt== | xxxx |
| ==_default/WebNotify.txt,v== | xxxx |
| ==_default/WebPreferences.txt== | xxxx |
| ==_default/WebPreferences.txt,v== | xxxx |
| ==_default/WebSearch.txt== | xxxx |
| ==_default/WebSearch.txt,v== | xxxx |
| ==_default/WebStatistics.txt== | xxxx |
| ==_default/WebStatistics.txt,v== | xxxx |
|  ...  |  ...  |
| ==Know/TopicClassification.txt== | xxxx |
| ==Know/TopicClassification.txt,v== | xxxx |
| ==Know/TWikiCategory.txt== | xxxx |
| ==Know/TWikiCategory.txt,v== | xxxx |
| ==Know/UseCategory.txt== | xxxx |
| ==Know/UseCategory.txt,v== | xxxx |
| ==Know/WebChanges.txt== | xxxx |
| ==Know/WebChanges.txt,v== | xxxx |
| ==Know/WebForm.txt== | xxxx |
| ==Know/WebForm.txt,v== | xxxx |
|  ...  |  ...  |
| ==Main/NicholasLee.txt== | xxxx |
| ==Main/NicholasLee.txt,v== | xxxx |
| ==Main/NobodyGroup.txt== | xxxx |
| ==Main/NobodyGroup.txt,v== | xxxx |
| ==Main/OfficeLocations.txt== | xxxx |
| ==Main/OfficeLocations.txt,v== | xxxx |
| ==Main/PeterThoeny.txt== | xxxx |
| ==Main/PeterThoeny.txt,v== | xxxx |
| ==Main/SanJoseOffice.txt== | xxxx |
| ==Main/SanJoseOffice.txt,v== | xxxx |
|  ...  |  ...  |
| ==Main/TWikiGroups.txt== | xxxx |
| ==Main/TWikiGroups.txt,v== | xxxx |
| ==Main/TWikiGuest.txt== | xxxx |
| ==Main/TWikiGuest.txt,v== | xxxx |
| ==Main/TWikiUsers.txt== | xxxx |
| ==Main/TWikiUsers.txt,v== | xxxx |
| ==Main/TWikiVariables.txt== | xxxx |
| ==Main/TWikiVariables.txt,v== | xxxx |
|  ...  |  ...  |
| ==Test/TestTopic1.txt== | xxxx |
| ==Test/TestTopic1.txt,v== | xxxx |
| ==Test/WebChanges.txt== | xxxx |
| ==Test/WebChanges.txt,v== | xxxx |
| ==Test/WebHome.txt== | xxxx |
| ==Test/WebHome.txt,v== | xxxx |
|  ...  |  ...  |
| ==Trash/.changes== | xxxx |
| ==Trash/WebChanges.txt== | xxxx |
| ==Trash/WebChanges.txt,v== | xxxx |
| ==Trash/WebHome.txt== | xxxx |
| ==Trash/WebHome.txt,v== | xxxx |
|  ...  |  ...  |
| ==TWiki/AlWilliams.txt== | xxxx |
| ==TWiki/AlWilliams.txt,v== | xxxx |
| ==TWiki/AndreaSterbini.txt== | xxxx |
| ==TWiki/AndreaSterbini.txt,v== | xxxx |
|  ...  |  ...  |
| ==TWiki/DeleteTopic.txt== | xxxx |
| ==TWiki/DeleteTopic.txt,v== | xxxx |
| ==TWiki/DontNotify.txt== | xxxx |
| ==TWiki/DontNotify.txt,v== | xxxx |
d229 1
a229 1
---++++ Files in <code>twiki/templates</code>
d231 1
a231 1
__Used to flexibly control appearance of rendered pages...__
d234 55
a288 55
| ==oopsbadpwformat.tmpl== | xxxx |
| ==attachagain.tmpl== | xxxx |
| ==attachnew.tmpl== | xxxx |
| ==changeform.tmpl== | xxxx |
| ==changes.tmpl== | xxxx |
| ==edit.iejs.tmpl== | xxxx |
| ==edit.tmpl== | xxxx |
| ==mailnotify.tmpl== | xxxx |
| ==moveattachment.tmpl== | xxxx |
| ==oopsaccesschange.tmpl== | xxxx |
| ==oopsaccessgroup.tmpl== | xxxx |
| ==oopsaccessrename.tmpl== | xxxx |
| ==oopsaccessview.tmpl== | xxxx |
| ==oopsauth.tmpl== | xxxx |
| ==attach.tmpl== | xxxx |
| ==oopschangepasswd.tmpl== | xxxx |
| ==oopsempty.tmpl== | xxxx |
| ==oopslocked.tmpl== | xxxx |
| ==oopslockedrename.tmpl== | xxxx |
| ==oopsmissing.tmpl== | xxxx |
| ==oopsmoveerr.tmpl== | xxxx |
| ==oopsnoformdef.tmpl== | xxxx |
| ==oopsnotwikiuser.tmpl== | xxxx |
| ==oopsnoweb.tmpl== | xxxx |
| ==oopspreview.tmpl== | xxxx |
| ==oopsregexist.tmpl== | xxxx |
| ==oopsregpasswd.tmpl== | xxxx |
| ==oopsregrequ.tmpl== | xxxx |
| ==oopsregthanks.tmpl== | xxxx |
| ==oopsregwiki.tmpl== | xxxx |
| ==oopsrenameerr.tmpl== | xxxx |
| ==oopsresetpasswd.tmpl== | xxxx |
| ==oopsrev.tmpl== | xxxx |
| ==oopssave.tmpl== | xxxx |
| ==oopssaveerr.tmpl== | xxxx |
| ==oopssendmailerr.tmpl== | xxxx |
| ==oopstopicexists.tmpl== | xxxx |
| ==oopsupload.tmpl== | xxxx |
| ==oopswrongpassword.tmpl== | xxxx |
| ==preview.tmpl== | xxxx |
| ==rdiff.tmpl== | xxxx |
| ==register.tmpl== | xxxx |
| ==registernotify.tmpl== | xxxx |
| ==rename.tmpl== | xxxx |
| ==renamebase.tmpl== | xxxx |
| ==renameconfirm.tmpl== | xxxx |
| ==renamerefs.tmpl== | xxxx |
| ==search.tmpl== | xxxx |
| ==searchbookview.tmpl== | xxxx |
| ==searchmeta.tmpl== | xxxx |
| ==searchrenameview.tmpl== | xxxx |
| ==twiki.tmpl== | xxxx |
| ==view.plain.tmpl== | xxxx |
| ==view.print.tmpl== | xxxx |
| ==view.tmpl== | xxxx |
@


1.12
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="999336394" format="1.0" version="1.12"}%
d6 5
a10 1
Low requirements on client-side and server-side environment, to keep TWiki deployment as broad as possible is a key element of the TWikiMission. Strict W3C and ECMA standards compliance is also a mandate. These requirements are amended from time to time as technology progresses.
d38 1
a38 1
| JavaScript 1.? | Optional: JS degrades gracefully |
d44 1
a44 1
__WHAT ABOUT WEB STANDARDS PROJECT - CSS CONTROL__
d48 1
a48 1
	* Some TWikiSkins may require more, like cookies and JavaScript
d51 1
a51 1
---+++ TWiki Directory Structure
d53 1
a53 1
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:
d58 1
a58 3
| ==twiki/lib==		 |  [[#LibFiles][list]]  | Configuration file &amp; main library |
| ==twiki/lib/TWiki== |  [[#LibFiles][list]]  | Perl modules |
| ==twiki/lib/TWiki/Plugins== |  [[#LibFiles][list]]  | TWikiPlugins Perl modules |
d65 1
a65 1
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.
d70 2
d73 2
a74 2
| ==index.html== | A page with a link to first launch TWiki after install. |
| ==license.txt==		  | Gnu General Public License and TWiki-specific info. |
d76 2
a77 2
| ==TWikiDocumentation.html==			 | All documentation packaged as a single page. |
| ==TWikiHistory.html==		  | TWiki development timeline. |
d82 2
d107 2
d127 2
d175 3
a177 1
---++++ Files under <code>twiki/data</code> 
d199 1
a199 30
| ==Know/.changes== | xxxx |
| ==Know/.mailnotify== | xxxx |
| ==Know/IncorrectDllVersionW32PTH10DLL.txt== | xxxx |
| ==Know/IncorrectDllVersionW32PTH10DLL.txt,v== | xxxx |
| ==Know/NoDisclosure.txt== | xxxx |
| ==Know/NoDisclosure.txt,v== | xxxx |
| ==Know/OperatingSystem.txt== | xxxx |
| ==Know/OperatingSystem.txt,v== | xxxx |
| ==Know/OsHPUX.txt== | xxxx |
| ==Know/OsHPUX.txt,v== | xxxx |
| ==Know/OsLinux.txt== | xxxx |
| ==Know/OsLinux.txt,v== | xxxx |
| ==Know/OsMacOS.txt== | xxxx |
| ==Know/OsMacOS.txt,v== | xxxx |
| ==Know/OsSolaris.txt== | xxxx |
| ==Know/OsSolaris.txt,v== | xxxx |
| ==Know/OsSunOS.txt== | xxxx |
| ==Know/OsSunOS.txt,v== | xxxx |
| ==Know/OsVersion.txt== | xxxx |
| ==Know/OsVersion.txt,v== | xxxx |
| ==Know/OsWin.txt== | xxxx |
| ==Know/OsWin.txt,v== | xxxx |
| ==Know/PublicFAQ.txt== | xxxx |
| ==Know/PublicFAQ.txt,v== | xxxx |
| ==Know/PublicSupported.txt== | xxxx |
| ==Know/PublicSupported.txt,v== | xxxx |
| ==Know/ReadmeFirst.txt== | xxxx |
| ==Know/ReadmeFirst.txt,v== | xxxx |
| ==Know/SunOS.txt== | xxxx |
| ==Know/SunOS.txt,v== | xxxx |
d210 1
a210 26
| ==Know/WebHome.txt== | xxxx |
| ==Know/WebHome.txt,v== | xxxx |
| ==Know/WebIndex.txt== | xxxx |
| ==Know/WebIndex.txt,v== | xxxx |
| ==Know/WebNotify.txt== | xxxx |
| ==Know/WebNotify.txt,v== | xxxx |
| ==Know/WebPreferences.txt== | xxxx |
| ==Know/WebPreferences.txt,v== | xxxx |
| ==Know/WebSearch.txt== | xxxx |
| ==Know/WebSearch.txt,v== | xxxx |
| ==Know/WebStatistics.txt== | xxxx |
| ==Know/WebStatistics.txt,v== | xxxx |
| ==Know/WebTopicEditTemplate.txt== | xxxx |
| ==Know/WebTopicEditTemplate.txt,v== | xxxx |
| ==Know/WinDoze95Crash.txt== | xxxx |
| ==Know/WinDoze95Crash.txt,v== | xxxx |
| ==Main/TWikiAdminGroup.txt,v== | xxxx |
| ==Main/.mailnotify== | xxxx |
| ==Main/FileAttachment.txt== | xxxx |
| ==Main/FileAttachment.txt,v== | xxxx |
| ==Main/JohnTalintyre.txt== | xxxx |
| ==Main/JohnTalintyre.txt,v== | xxxx |
| ==Main/KevinKinnell.txt== | xxxx |
| ==Main/KevinKinnell.txt,v== | xxxx |
| ==Main/LondonOffice.txt== | xxxx |
| ==Main/LondonOffice.txt,v== | xxxx |
d221 1
a221 4
| ==Main/TokyoOffice.txt== | xxxx |
| ==Main/TokyoOffice.txt,v== | xxxx |
| ==Main/TWikiAdminGroup.txt== | xxxx |
| ==Main/.changes== | xxxx |
d230 1
a230 16
| ==Main/WebChanges.txt== | xxxx |
| ==Main/WebChanges.txt,v== | xxxx |
| ==Main/WebHome.txt== | xxxx |
| ==Main/WebHome.txt,v== | xxxx |
| ==Main/WebIndex.txt== | xxxx |
| ==Main/WebIndex.txt,v== | xxxx |
| ==Main/WebNotify.txt== | xxxx |
| ==Main/WebNotify.txt,v== | xxxx |
| ==Main/WebPreferences.txt== | xxxx |
| ==Main/WebPreferences.txt,v== | xxxx |
| ==Main/WebSearch.txt== | xxxx |
| ==Main/WebSearch.txt,v== | xxxx |
| ==Main/WebStatistics.txt== | xxxx |
| ==Main/WebStatistics.txt,v== | xxxx |
| ==Test/.changes== | xxxx |
| ==Test/.mailnotify== | xxxx |
d237 1
a237 10
| ==Test/WebIndex.txt== | xxxx |
| ==Test/WebIndex.txt,v== | xxxx |
| ==Test/WebNotify.txt== | xxxx |
| ==Test/WebNotify.txt,v== | xxxx |
| ==Test/WebPreferences.txt== | xxxx |
| ==Test/WebPreferences.txt,v== | xxxx |
| ==Test/WebSearch.txt== | xxxx |
| ==Test/WebSearch.txt,v== | xxxx |
| ==Test/WebStatistics.txt== | xxxx |
| ==Test/WebStatistics.txt,v== | xxxx |
d243 1
a243 12
| ==Trash/WebIndex.txt== | xxxx |
| ==Trash/WebIndex.txt,v== | xxxx |
| ==Trash/WebNotify.txt== | xxxx |
| ==Trash/WebNotify.txt,v== | xxxx |
| ==Trash/WebPreferences.txt== | xxxx |
| ==Trash/WebPreferences.txt,v== | xxxx |
| ==Trash/WebSearch.txt== | xxxx |
| ==Trash/WebSearch.txt,v== | xxxx |
| ==Trash/WebStatistics.txt== | xxxx |
| ==Trash/WebStatistics.txt,v== | xxxx |
| ==TWiki/.changes== | xxxx |
| ==TWiki/.mailnotify== | xxxx |
d248 1
a248 16
| ==TWiki/BillClinton.txt== | xxxx |
| ==TWiki/BillClinton.txt,v== | xxxx |
| ==TWiki/BookView.txt== | xxxx |
| ==TWiki/BookView.txt,v== | xxxx |
| ==TWiki/BumpyWord.txt== | xxxx |
| ==TWiki/BumpyWord.txt,v== | xxxx |
| ==TWiki/ChristopheVermeulen.txt== | xxxx |
| ==TWiki/ChristopheVermeulen.txt,v== | xxxx |
| ==TWiki/CrisBailiff.txt== | xxxx |
| ==TWiki/CrisBailiff.txt,v== | xxxx |
| ==TWiki/DavidWarman.txt== | xxxx |
| ==TWiki/DavidWarman.txt,v== | xxxx |
| ==TWiki/DefaultPlugin.txt== | xxxx |
| ==TWiki/DefaultPlugin.txt,v== | xxxx |
| ==TWiki/DeleteOrRenameATopic.txt== | xxxx |
| ==TWiki/DeleteOrRenameATopic.txt,v== | xxxx |
a252 169
| ==TWiki/EditDoesNotIncreaseTheRevision.txt== | xxxx |
| ==TWiki/EditDoesNotIncreaseTheRevision.txt,v== | xxxx |
| ==TWiki/EmptyPlugin.txt== | xxxx |
| ==TWiki/EmptyPlugin.txt,v== | xxxx |
| ==TWiki/ExampleTopicTemplate.txt== | xxxx |
| ==TWiki/ExampleTopicTemplate.txt,v== | xxxx |
| ==TWiki/FileAttachment.txt== | xxxx |
| ==TWiki/FileAttachment.txt,v== | xxxx |
| ==TWiki/GnuGeneralPublicLicense.txt== | xxxx |
| ==TWiki/GnuGeneralPublicLicense.txt,v== | xxxx |
| ==TWiki/GoodStyle.txt== | xxxx |
| ==TWiki/GoodStyle.txt,v== | xxxx |
| ==TWiki/HaroldGottschalk.txt== | xxxx |
| ==TWiki/HaroldGottschalk.txt,v== | xxxx |
| ==TWiki/Hey.txt== | xxxx |
| ==TWiki/Hey.txt,v== | xxxx |
| ==TWiki/IncludeTopicsAndWebPages.txt== | xxxx |
| ==TWiki/IncludeTopicsAndWebPages.txt,v== | xxxx |
| ==TWiki/InterwikiPlugin.txt== | xxxx |
| ==TWiki/InterwikiPlugin.txt,v== | xxxx |
| ==TWiki/InterWikis.txt== | xxxx |
| ==TWiki/InterWikis.txt,v== | xxxx |
| ==TWiki/JaneDoeTestCreateForm.txt== | xxxx |
| ==TWiki/JaneDoeTestCreateForm.txt,v== | xxxx |
| ==TWiki/JaneDoeTestEditForm.txt== | xxxx |
| ==TWiki/JaneDoeTestEditForm.txt,v== | xxxx |
| ==TWiki/JohnAltstadt.txt== | xxxx |
| ==TWiki/JohnAltstadt.txt,v== | xxxx |
| ==TWiki/JohnTalintyre.txt== | xxxx |
| ==TWiki/JohnTalintyre.txt,v== | xxxx |
| ==TWiki/KevinKinnell.txt== | xxxx |
| ==TWiki/KevinKinnell.txt,v== | xxxx |
| ==TWiki/ManpreetSingh.txt== | xxxx |
| ==TWiki/ManpreetSingh.txt,v== | xxxx |
| ==TWiki/MetaDataDefinition.txt== | xxxx |
| ==TWiki/MetaDataDefinition.txt,v== | xxxx |
| ==TWiki/MoveTopic.txt== | xxxx |
| ==TWiki/MoveTopic.txt,v== | xxxx |
| ==TWiki/MoveWeb.txt== | xxxx |
| ==TWiki/MoveWeb.txt,v== | xxxx |
| ==TWiki/NicholasLee.txt== | xxxx |
| ==TWiki/NicholasLee.txt,v== | xxxx |
| ==TWiki/PeterFokkinga.txt== | xxxx |
| ==TWiki/PeterFokkinga.txt,v== | xxxx |
| ==TWiki/PeterThoeny.txt== | xxxx |
| ==TWiki/PeterThoeny.txt,v== | xxxx |
| ==TWiki/PreviewBackground.txt== | xxxx |
| ==TWiki/PreviewBackground.txt,v== | xxxx |
| ==TWiki/RandyKramer.txt== | xxxx |
| ==TWiki/RandyKramer.txt,v== | xxxx |
| ==TWiki/RegularExpression.txt== | xxxx |
| ==TWiki/RegularExpression.txt,v== | xxxx |
| ==TWiki/ManagingTopics.txt== | xxxx |
| ==TWiki/ManagingTopics.txt,v== | xxxx |
| ==TWiki/SearchDoesNotWork.txt== | xxxx |
| ==TWiki/SearchDoesNotWork.txt,v== | xxxx |
| ==TWiki/SimultaneousEdits.txt== | xxxx |
| ==TWiki/SimultaneousEdits.txt,v== | xxxx |
| ==TWiki/StandardColors.txt== | xxxx |
| ==TWiki/StandardColors.txt,v== | xxxx |
| ==TWiki/StanleyKnutson.txt== | xxxx |
| ==TWiki/StanleyKnutson.txt,v== | xxxx |
| ==TWiki/SvenDowideit.txt== | xxxx |
| ==TWiki/SvenDowideit.txt,v== | xxxx |
| ==TWiki/TextFormattingFAQ.txt== | xxxx |
| ==TWiki/TextFormattingFAQ.txt,v== | xxxx |
| ==TWiki/TextFormattingRules.txt== | xxxx |
| ==TWiki/TextFormattingRules.txt,v== | xxxx |
| ==TWiki/TWikiAccessControl.txt== | xxxx |
| ==TWiki/TWikiAccessControl.txt,v== | xxxx |
| ==TWiki/ManagingWebs.txt== | xxxx |
| ==TWiki/ManagingWebs.txt,v== | xxxx |
| ==TWiki/TWikiUserAuthentication.txt== | xxxx |
| ==TWiki/TWikiUserAuthentication.txt,v== | xxxx |
| ==TWiki/TWikiCategoryTable.txt== | xxxx |
| ==TWiki/TWikiCategoryTable.txt,v== | xxxx |
| ==TWiki/TWikiContributor.txt== | xxxx |
| ==TWiki/TWikiContributor.txt,v== | xxxx |
| ==TWiki/TWikiDocumentation.txt== | xxxx |
| ==TWiki/TWikiDocumentation.txt,v== | xxxx |
| ==TWiki/TWikiDownload.txt== | xxxx |
| ==TWiki/TWikiDownload.txt,v== | xxxx |
| ==TWiki/TWikiEnhancementRequests.txt== | xxxx |
| ==TWiki/TWikiEnhancementRequests.txt,v== | xxxx |
| ==TWiki/TWikiFAQ.txt== | xxxx |
| ==TWiki/TWikiFAQ.txt,v== | xxxx |
| ==TWiki/TWikiFormTemplate.txt== | xxxx |
| ==TWiki/TWikiFormTemplate.txt,v== | xxxx |
| ==TWiki/TWikiHistory.txt== | xxxx |
| ==TWiki/TWikiHistory.txt,v== | xxxx |
| ==TWiki/TWikiImplementationNotes.txt== | xxxx |
| ==TWiki/TWikiImplementationNotes.txt,v== | xxxx |
| ==TWiki/TWikiInstallationGuide.txt== | xxxx |
| ==TWiki/TWikiInstallationGuide.txt,v== | xxxx |
| ==TWiki/WebNotification.txt== | xxxx |
| ==TWiki/WebNotification.txt,v== | xxxx |
| ==TWiki/TWikiPlannedFeatures.txt== | xxxx |
| ==TWiki/TWikiPlannedFeatures.txt,v== | xxxx |
| ==TWiki/TWikiPlugins.txt== | xxxx |
| ==TWiki/TWikiPlugins.txt,v== | xxxx |
| ==TWiki/TWikiPreferences.txt== | xxxx |
| ==TWiki/TWikiPreferences.txt,v== | xxxx |
| ==TWiki/TWikiRegistration.txt== | xxxx |
| ==TWiki/TWikiRegistration.txt,v== | xxxx |
| ==TWiki/TWikiRegistrationPub.txt== | xxxx |
| ==TWiki/TWikiRegistrationPub.txt,v== | xxxx |
| ==TWiki/TWikiSkins.txt== | xxxx |
| ==TWiki/TWikiSkins.txt,v== | xxxx |
| ==TWiki/TWikiTemplates.txt== | xxxx |
| ==TWiki/TWikiTemplates.txt,v== | xxxx |
| ==TWiki/TWikiTutorial.txt== | xxxx |
| ==TWiki/TWikiTutorial.txt,v== | xxxx |
| ==TWiki/TWikiTutorialKK.txt== | xxxx |
| ==TWiki/TWikiUpgradeGuide.txt== | xxxx |
| ==TWiki/TWikiUpgradeGuide.txt,v== | xxxx |
| ==TWiki/TWikiUpgradeTo01May2000.txt== | xxxx |
| ==TWiki/TWikiUpgradeTo01May2000.txt,v== | xxxx |
| ==TWiki/TWikiUsernameVsLoginUsername.txt== | xxxx |
| ==TWiki/TWikiUsernameVsLoginUsername.txt,v== | xxxx |
| ==TWiki/TWikiVariables.txt== | xxxx |
| ==TWiki/TWikiVariables.txt,v== | xxxx |
| ==TWiki/TWikiWeb.txt== | xxxx |
| ==TWiki/TWikiWeb.txt,v== | xxxx |
| ==TWiki/TWikiWebsTable.txt== | xxxx |
| ==TWiki/TWikiWebsTable.txt,v== | xxxx |
| ==TWiki/UnlockTopic.txt== | xxxx |
| ==TWiki/UnlockTopic.txt,v== | xxxx |
| ==TWiki/WabiSabi.txt== | xxxx |
| ==TWiki/WabiSabi.txt,v== | xxxx |
| ==TWiki/WebChanges.txt== | xxxx |
| ==TWiki/WebChanges.txt,v== | xxxx |
| ==TWiki/WebHome.txt== | xxxx |
| ==TWiki/WebHome.txt,v== | xxxx |
| ==TWiki/WebIndex.txt== | xxxx |
| ==TWiki/WebIndex.txt,v== | xxxx |
| ==TWiki/WebNotify.txt== | xxxx |
| ==TWiki/WebNotify.txt,v== | xxxx |
| ==TWiki/WebPreferences.txt== | xxxx |
| ==TWiki/WebPreferences.txt,v== | xxxx |
| ==TWiki/WebSearch.txt== | xxxx |
| ==TWiki/WebSearch.txt,v== | xxxx |
| ==TWiki/WebStatistics.txt== | xxxx |
| ==TWiki/WebStatistics.txt,v== | xxxx |
| ==TWiki/WebTopicEditTemplate.txt== | xxxx |
| ==TWiki/WebTopicEditTemplate.txt,v== | xxxx |
| ==TWiki/WebTopicNonWikiTemplate.txt== | xxxx |
| ==TWiki/WebTopicNonWikiTemplate.txt,v== | xxxx |
| ==TWiki/WebTopicViewTemplate.txt== | xxxx |
| ==TWiki/WebTopicViewTemplate.txt,v== | xxxx |
| ==TWiki/WelcomeGuest.txt== | xxxx |
| ==TWiki/WelcomeGuest.txt,v== | xxxx |
| ==TWiki/WhatIsWikiWiki.txt== | xxxx |
| ==TWiki/WhatIsWikiWiki.txt,v== | xxxx |
| ==TWiki/WikiCulture.txt== | xxxx |
| ==TWiki/WikiCulture.txt,v== | xxxx |
| ==TWiki/WikiName.txt== | xxxx |
| ==TWiki/WikiName.txt,v== | xxxx |
| ==TWiki/WikiNotation.txt== | xxxx |
| ==TWiki/WikiNotation.txt,v== | xxxx |
| ==TWiki/WikiReferences.txt== | xxxx |
| ==TWiki/WikiReferences.txt,v== | xxxx |
| ==TWiki/WikiSyntax.txt== | xxxx |
| ==TWiki/WikiSyntax.txt,v== | xxxx |
| ==TWiki/WikiTopic.txt== | xxxx |
| ==TWiki/WikiTopic.txt,v== | xxxx |
| ==TWiki/WikiWikiClones.txt== | xxxx |
| ==TWiki/WikiWikiClones.txt,v== | xxxx |
| ==TWiki/WikiWord.txt== | xxxx |
| ==TWiki/WikiWord.txt,v== | xxxx |
d256 2
@


1.11
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="999320061" format="1.0" version="1.11"}%
d4 1
a4 1
---## TWiki Software Environment
d6 1
a6 1
---+++ System Requirements
d8 1
a8 1
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. 
d10 9
a18 8
| *Required Environment by Platform* |||
| *Packages:* | *Linux/Unix:* | *Windows:* |
| Perl		 |	5.x	|	5.x  |
| Non-standard Perl modules |  ???  | =MIME::Base64=, Digest::SHA1 (for password generation) |
| Optional Perl modules | =Net::SMTP= (or sendmail) |  =Net::SMTP=  | 
| RCS		  |	5.7	|	5.7 (including =diff=  |
| Other external programs |	=ls=, =fgrep=, =egrep=  |  =ls=, =fgrep=, =egrep=  |
| Web server  |	Apache  |	Apache, IIS	|
d20 26
d400 2
a401 2
| ==TWiki/RenameTopic.txt== | xxxx |
| ==TWiki/RenameTopic.txt,v== | xxxx |
d418 2
a419 2
| ==TWiki/TWikiAdministration.txt== | xxxx |
| ==TWiki/TWikiAdministration.txt,v== | xxxx |
d442 2
a443 2
| ==TWiki/TWikiNotificationOfChanges.txt== | xxxx |
| ==TWiki/TWikiNotificationOfChanges.txt,v== | xxxx |
@


1.10
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="999259487" format="1.0" version="1.10"}%
d393 2
a394 2
| ==TWiki/TWikiAuthentication.txt== | xxxx |
| ==TWiki/TWikiAuthentication.txt,v== | xxxx |
d413 2
a414 2
| ==TWiki/TWikiInstallationNotes.txt== | xxxx |
| ==TWiki/TWikiInstallationNotes.txt,v== | xxxx |
d434 2
a435 2
| ==TWiki/TWikiUpgradeNotes.txt== | xxxx |
| ==TWiki/TWikiUpgradeNotes.txt,v== | xxxx |
@


1.9
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="999132184" format="1.0" version="1.9"}%
d4 1
a4 1
---## TWiki Implementation Notes
d6 1
a6 1
---+++ Platforms and System Requirements 
d8 1
a8 1
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...__ ]
d20 1
a20 1
---+++ Directory Structure
d22 1
a22 1
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:
d28 2
a29 2
| ==twiki/lib/TWiki== |  [[#LibTWiki][list]]  | Perl modules |
| ==twiki/lib/TWiki/Plugins== |  [[#libtwikiplugins][list]]  | TWikiPlugins Perl modules |
d34 3
a36 1
__Note: about the additional directories in data, elsewhere__
d72 1
a72 1
---++++ Files in <code>twiki/lib</code>
d77 11
a87 21

#LibTWiki
---++++ Files in <code>twiki/lib/TWiki</code>

| *File:*			| *Used for:* |
| ==Access.pm==	| Access control |
| ==Attach.pm==	| Attachment handling |
| ==Meta.pm==	  | Meta data in topics |
| ==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 |

#LibTWikiPlugins
---++++ Files in <code>twiki/lib/TWiki/Plugins</code>

| *File:*				  | *Used for:* |
| ==DefaultPlugin.pm== | Default plugin |
| ==EmptyPlugin.pm==	| Empty plugin, use to create your own |
| ==InterwikiPlugin.pm== | Refer to external Wikis and other Web sites |
d90 1
a90 1
---++++ Files in <code>twiki/pub</code>
a92 1

d138 1
a138 1
---++++ Files in <code>twiki/data</code>
@


1.8
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="999047223" format="1.0" version="1.8"}%
d13 1
a13 1
| Non-standard Perl modules | | =MIME::Base64=, Digest::SHA1 (for password generation) |
d22 1
a22 1
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:
d39 6
a44 1
__to follow__
d100 45
a144 1
__to follow__
d149 350
a498 1
__to follow__
d503 56
a558 1
__to follow__
d560 1
a560 1
-- MikeMannix - 28 Aug 2001 
@


1.7
log
@none
@
text
@d1 3
a3 1
%META:TOPICINFO{author="JohnTalintyre" date="998986839" format="1.0" version="1.7"}%
d6 1
a6 1
---+++ Platform
d8 1
a8 1
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.
d11 1
a11 1
| *Package(s):* | *Unix:* | *Windows:* |
d14 1
a14 1
| Optional Perl modules | =Net::SMTP= (or sendmail) | =Net::SMTP= | 
d18 1
d22 1
a22 7
| *Directory:*		  | *Used for:* |
| ==twiki/bin==		 | TWiki Perl scripts |
| ==twiki/lib/TWiki== | TWiki Perl modules |
| ==twiki/lib/TWiki/Plugins== | Plugins modules |
| ==twiki/pub==		 | Public files (FileAttachments, images), plus RCS histories |
| ==twiki/data==		| source (topic) text, including RCS histories |
| ==twiki/templates== | HTML templates, used by TWiki scripts |
d24 11
d36 7
a42 1
---++++ Files in twiki/bin
d64 2
a65 1
---++++ Files in twiki/lib
d69 1
a69 1
| ==TWiki.cfg==	  | For initialization and configuration, used by ==TWiki.pm== |
d71 2
a72 1
---++++ Files in twiki/lib/TWiki
d84 2
a85 1
---++++ Files in twiki/lib/TWiki/Plugins
d92 16
a107 1
-- Main.MikeMannix - 26 Aug 2001 
@


1.6
log
@none
@
text
@d1 1
a1 1
%META:TOPICINFO{author="MikeMannix" date="998895765" format="1.0" version="1.6"}%
d11 1
a11 1
| Non-standard Perl modules | | |
d13 3
a15 3
| RCS		  |	5.7	|	5.7	|
| Other external programs |	ls, fgrep, egrep  |  ?  |
| Web server  |	Apache  |	?	 |
d23 2
a24 2
| ==twiki/pub==		 | Public files (FileAttachments, images) |
| ==twiki/data==		| source text |
d40 1
d60 2
d73 1
@


1.5
log
@none
@
text
@d1 1
d6 10
a15 1
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.
d21 2
a22 2
| ==twiki/bin/TWiki== | TWiki Perl modules |
| ==twiki/bin/TWiki/Plugins== | Plugins modules |
a26 1
__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.
d48 4
d55 1
a55 1
---++++ Files in twiki/bin/TWiki
d65 1
a65 1
---++++ Files in twiki/bin/TWiki/Plugins
d71 1
a71 1
-- Main.PeterThoeny - 03 Mar 2001 <br>
@


1.4
log
@none
@
text
@d1 1
a1 1
__Platform__
d3 1
a3 1
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.
d5 1
a5 1
__Directories__
d7 1
a7 5
| *Directory:*		| *Used for:* |
| =twiki/bin=		 | TWiki Perl scripts |
| =twiki/pub=		 | Public files (FileAttachments, images) |
| =twiki/data=		| source text |
| =twiki/templates= | HTML templates, used by TWiki scripts |
d9 11
a19 1
__Files in twiki/bin__
d22 35
a56 23
| =.htaccess.txt= | Authentication. Rename to .htaccess and customize if used |
| =attach=		  | Script that shows the attach file page (FileAttachment) |
| =delete=		  | (not used yet) |
| =edit=			 | Script to edit a topic |
| =geturl=		  | Script to fetch URL data |
| =mailnotify=	 | Script called by cron job to notify users of changes |
| =oops=			 | Script that shows an OK or oops dialog |
| =preview=		 | Script to preview topic after edit |
| =rdiff=			| Script to see differences of topics |
| =register=		| Script to register new users |
| =save=			 | Script that saves a topic, called by preview |
| =search=		  | Script that displays search results |
| =statistics=	 | Script to create statistics topic |
| =testenv=		 | Script to test CGI environment variables |
| =upload=		  | Script that does file upload (FileAttachment) |
| =view=			 | Script to view a topic ( *the* script ) |
| =viewfile=		| Script to view an file attachment |
| =wiki.pm=		 | main TWiki library |
| =wikiaccess.pm= | access control |
| =wikicfg.pm=	 | for initialization and configuration, used by wiki.pm |
| =wikiprefs.pm=  | preferences handling |
| =wikisearch.pm= | search engine, used by wiki.pm |
| =wikistore.pm=  | back-end storage, =*.txt= text file and =*.txt,v= RCS repository file handling |
d58 1
a58 1
-- Main.PeterThoeny - 02 Nov 2000 <br>
@


1.3
log
@none
@
text
@d3 1
a3 1
TWiki is written in PERL 5, but it uses also many shell command. The current implementation runs best on a Unix machine; also possible on Windows. RCS for revision control must be installed on the system.
d8 1
a8 1
| =twiki/bin=		 | TWiki PERL scripts |
d22 1
a22 1
| =oops=			 | Script that shows a OK or oops dialog |
@


1.2
log
@none
@
text
@d3 1
a3 1
TWiki is written in PERL 5, but it uses also many shell command. The current implementation runs only on a Unix machine. RCS for revision control must be installed on the system.
d7 5
a11 5
| *Directory:*	 | *Used for:* |
| twiki/bin		 | TWiki PERL scripts |
| twiki/pub		 | Public files (FileAttachments, images) |
| twiki/data		| source text |
| twiki/templates | HTML templates, used by TWiki scripts |
d16 23
a38 20
| .htaccess.txt | Authentication. Rename to .htaccess and customize if used |
| attach		  | Script that shows the attach file page (FileAttachment) |
| delete		  | (not used yet) |
| edit			 | Script to edit a topic |
| geturl		  | Script to fetch URL data |
| mailnotify	 | Script called by cron job to notify users of changes |
| oops			 | Script that shows a OK or oops dialog |
| preview		 | Script to preview topic after edit |
| rdiff			| Script to see differences of topics |
| register		| Script to register new users |
| save			 | Script that saves a topic, called by preview |
| search		  | Script that displays search results |
| statistics	 | Script to create statistics topic |
| testenv		 | Script to test CGI environment variables |
| upload		  | Script that does file upload (FileAttachment) |
| view			 | Script to view a topic ( *the* script ) |
| viewfile		| Script to view an file attachment |
| wiki.pm		 | main TWiki library |
| wikicfg.pm	 | for initialization and configuration, used by wiki.pm |
| wikisearch.pm | search engine, used by wiki.pm |
d40 1
a40 1
-- Main.PeterThoeny - 19 Aug 2000 <br>
@


1.1
log
@none
@
text
@a17 1
| changes		 | Script that shows recent changes |
d37 1
a37 1
-- Main.PeterThoeny - 21 Apr 2000 <br>
@
