-## <a name="TWiki Implementation Notes"></a> TWiki Implementation Notes
+<div>
+ <ul>
+ <li><a href="#TWiki System Requirements"> TWiki System Requirements</a><ul>
+ <li><a href="#Server Requirements"> Server Requirements</a></li>
+ <li><a href="#Client Requirements"> Client Requirements</a></li>
+ <li><a href="#Known Issues"> Known Issues</a></li>
+ </ul>
+ </li>
+ </ul>
+</div>
-### <a name="Platform"></a> Platform
+# <a name="TWiki System Requirements"></a> TWiki System Requirements
-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.
+_Server and client requirements for TWiki 01-Feb-2003_
-### <a name="Directory Structure"></a> Directory Structure
+Low client and server requirements are core features that keep TWiki widely deployable, particularly across a range of browser platforms and versions.
-<table border="1" cellpadding="0" cellspacing="0">
- <tr>
- <th bgcolor="#99CCCC"><strong> Directory: </strong></th>
- <th bgcolor="#99CCCC"><strong> Used for: </strong></th>
- </tr>
- <tr>
- <td><code><b>twiki/bin</b></code></td>
- <td> TWiki Perl scripts </td>
- </tr>
- <tr>
- <td><code><b>twiki/bin/TWiki</b></code></td>
- <td> TWiki Perl modules </td>
- </tr>
- <tr>
- <td><code><b>twiki/bin/TWiki/Plugins</b></code></td>
- <td> Plugins modules </td>
- </tr>
- <tr>
- <td><code><b>twiki/pub</b></code></td>
- <td> Public files ([[Main/FileAttachments]], images) </td>
- </tr>
- <tr>
- <td><code><b>twiki/data</b></code></td>
- <td> source text </td>
- </tr>
- <tr>
- <td><code><b>twiki/templates</b></code></td>
- <td> HTML templates, used by TWiki scripts </td>
- </tr>
-</table>
+## <a name="Server Requirements"></a> Server Requirements
-**_Note:_** You could move the <code>**twiki/bin/TWiki**</code> library directory (including <code>**Plugins**</code> ) to <code>**twiki/lib/TWiki**</code>; the scripts look for a <code>**"."**</code> and <code>**"../lib"**</code> relative library path.
-
-#### <a name="Files in twiki/bin"></a> Files in twiki/bin
+TWiki is written in Perl 5, uses a number of shell commands, and requires [RCS (Revision Control System)](http://www.gnu.org/software/rcs/rcs.html), 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.
<table border="1" cellpadding="0" cellspacing="0">
<tr>
- <th bgcolor="#99CCCC"><strong> File: </strong></th>
- <th bgcolor="#99CCCC"><strong> Used for: </strong></th>
- </tr>
- <tr>
- <td><code><b>.htaccess.txt</b></code></td>
- <td> Authentication. Rename to .htaccess and customize if used </td>
- </tr>
- <tr>
- <td><code><b>attach</b></code></td>
- <td> Script that shows the attach file page ([[Main/FileAttachment]]) </td>
- </tr>
- <tr>
- <td><code><b>delete</b></code></td>
- <td> (not used yet) </td>
- </tr>
- <tr>
- <td><code><b>edit</b></code></td>
- <td> Script to edit a topic </td>
- </tr>
- <tr>
- <td><code><b>geturl</b></code></td>
- <td> Script to fetch URL data </td>
- </tr>
- <tr>
- <td><code><b>mailnotify</b></code></td>
- <td> Script called by cron job to notify users of changes </td>
- </tr>
- <tr>
- <td><code><b>oops</b></code></td>
- <td> Script that shows an OK or oops dialog </td>
- </tr>
- <tr>
- <td><code><b>preview</b></code></td>
- <td> Script to preview topic after edit </td>
- </tr>
- <tr>
- <td><code><b>rdiff</b></code></td>
- <td> Script to see differences of topics </td>
+ <th bgcolor="#99CCCC"><strong> Resource </strong></th>
+ <th bgcolor="#99CCCC"><strong> Required Server Environment * </strong></th>
</tr>
<tr>
- <td><code><b>register</b></code></td>
- <td> Script to register new users </td>
+ <td> Perl </td>
+ <td> 5.005_03 or higher (5.6.1 recommended, 5.8.0 <strong>not</strong> recommended yet, see TWiki:Codev.IssuesWithPerl5dot8) </td>
</tr>
<tr>
- <td><code><b>save</b></code></td>
- <td> Script that saves a topic, called by preview </td>
+ <td> Non-standard Perl modules </td>
+ <td> %BULLET% Unix: <code>Net::SMTP</code> (or <code>sendmail</code>) %BB% Windows: <code>Net::SMTP</code>, <code>MIME::Base64</code>, <code>Digest::SHA1</code></td>
</tr>
<tr>
- <td><code><b>search</b></code></td>
- <td> Script that displays search results </td>
+ <td> RCS </td>
+ <td> 5.7 or higher (including GNU <code>diff</code>) %BR% Optional, but the all-Perl RCS replacement is not currently recommended for live sites - see TWiki:Codev.RcsLite </td>
</tr>
<tr>
- <td><code><b>statistics</b></code></td>
- <td> Script to create statistics topic </td>
+ <td> GNU <code>diff</code></td>
+ <td> GNU <code>diff</code> 2.7 or higher is required when not using the all-Perl RcsLite. %BR% Install on PATH if not included with RCS (check version with <code>diff -v</code>) %BR% Must be the version used by RCS, to avoid problems with binary attachments - RCS may have hard-coded path to <code>diff</code></td>
</tr>
<tr>
- <td><code><b>testenv</b></code></td>
- <td> Script to test CGI environment variables </td>
+ <td> Other external programs </td>
+ <td><code>fgrep, egrep</code></td>
</tr>
<tr>
- <td><code><b>upload</b></code></td>
- <td> Script that does file upload ([[Main/FileAttachment]]) </td>
+ <td> Cron/scheduler </td>
+ <td> %BULLET% Unix: <code>cron</code> %BB% Windows: <code>cron</code> equivalents </td>
</tr>
<tr>
- <td><code><b>view</b></code></td>
- <td> Script to view a topic ( <strong>the</strong> script ) </td>
- </tr>
- <tr>
- <td><code><b>viewfile</b></code></td>
- <td> Script to view an file attachment </td>
- </tr>
- <tr>
- <td><code><b>TWiki.pm</b></code></td>
- <td> Main TWiki library </td>
- </tr>
- <tr>
- <td><code><b>TWiki.cfg</b></code></td>
- <td> For initialization and configuration, used by <code><b>TWiki.pm</b></code></td>
+ <td> Web server </td>
+ <td> Apache 1.3 is well supported; Apache 2.0 is <strong>not</strong> recommended yet (see TWiki:Codev.IssuesWithApache2dot0). %BR% For other servers, CGI support, authentication, extended path info required; also, the <code>register</code> script is likely to need significant changes </td>
</tr>
</table>
-#### <a name="Files in twiki/bin/TWiki"></a> Files in twiki/bin/TWiki
+%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, MacOS X, Apache `mod_perl`, web hosts, etc._
-<table border="1" cellpadding="0" cellspacing="0">
- <tr>
- <th bgcolor="#99CCCC"><strong> File: </strong></th>
- <th bgcolor="#99CCCC"><strong> Used for: </strong></th>
- </tr>
- <tr>
- <td><code><b>Access.pm</b></code></td>
- <td> Access control </td>
- </tr>
- <tr>
- <td><code><b>Net.pm</b></code></td>
- <td> SMTP mail handling </td>
- </tr>
- <tr>
- <td><code><b>Plugins.pm</b></code></td>
- <td> Plugin handling </td>
- </tr>
- <tr>
- <td><code><b>Prefs.pm</b></code></td>
- <td> Preferences handling </td>
- </tr>
- <tr>
- <td><code><b>Search.pm</b></code></td>
- <td> Search engine, used by wiki.pm </td>
- </tr>
- <tr>
- <td><code><b>Store.pm</b></code></td>
- <td> Back-end storage, <code>*.txt</code> text file and <code>*.txt,v</code> RCS repository file handling </td>
- </tr>
-</table>
+<a name="ClientRequirements"></a>
-#### <a name="Files in twiki/bin/TWiki/Plugins"></a> Files in twiki/bin/TWiki/Plugins
+## <a name="Client Requirements"></a> Client Requirements
-<table border="1" cellpadding="0" cellspacing="0">
- <tr>
- <th bgcolor="#99CCCC"><strong> File: </strong></th>
- <th bgcolor="#99CCCC"><strong> Used for: </strong></th>
- </tr>
- <tr>
- <td><code><b>DefaultPlugin.pm</b></code></td>
- <td> Default plugin </td>
- </tr>
- <tr>
- <td><code><b>EmptyPlugin.pm</b></code></td>
- <td> Empty plugin, use to create your own </td>
- </tr>
-</table>
+The TWiki [[standard installation|Main/TWikiInstallationGuide]] has extremely low browser requirements:
+
+- HTML 3.2 compliant
+- generates XHTML 1.0 pages that are compatible with HTML 3.2
+- minimal use of 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.
+
+## <a name="Known Issues"></a> 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.
--- [[PeterThoeny]] - 03 Mar 2001 <br />
+-- TWiki:Main.MikeMannix - 12 Jan 2002 %BR% -- TWiki:Main.PeterThoeny - 16 Dec 2003
git://git.openafs.org / openafs-wiki.git / blobdiff