From a35b1b4a6e28bc0c41f41518744a6f2336ed9b9e Mon Sep 17 00:00:00 2001
From: MikeMannix <MikeMannix>
Date: Sat, 1 Sep 2001 07:20:29 +0000
Subject: none

---
 TWiki/TWikiImplementationNotes.mdwn | 105 ++++++++++++++++++++++++++----------
 1 file changed, 77 insertions(+), 28 deletions(-)

(limited to 'TWiki/TWikiImplementationNotes.mdwn')

diff --git a/TWiki/TWikiImplementationNotes.mdwn b/TWiki/TWikiImplementationNotes.mdwn
index 26cfb71e..cade6357 100644
--- a/TWiki/TWikiImplementationNotes.mdwn
+++ b/TWiki/TWikiImplementationNotes.mdwn
@@ -1,57 +1,106 @@
 %TOC% %STARTINCLUDE%
 
-## <a name="TWiki_Software_Environment"> TWiki Software Environment </a>
+## <a name="TWiki_Operating_Environment"> TWiki Operating Environment </a>
 
-### <a name="System_Requirements"> System Requirements </a>
+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.
 
-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.
+### <a name="Server_Side_Requirements"> Server-Side Requirements </a>
+
+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.
 
 <table border="1" cellpadding="1" cellspacing="0">
   <tr>
-    <th bgcolor="#99CCCC" colspan="3"><strong>Required Environment by Platform</strong></th>
+    <th bgcolor="#99CCCC" colspan="3"><strong>Required Server Environment by Platform</strong></th>
   </tr>
   <tr>
-    <th bgcolor="#99CCCC"><strong>Packages:</strong></th>
-    <th bgcolor="#99CCCC"><strong>Linux/Unix:</strong></th>
-    <th bgcolor="#99CCCC"><strong>Windows:</strong></th>
+    <th bgcolor="#99CCCC"><strong>Resource</strong></th>
+    <th bgcolor="#99CCCC"><strong>Unix</strong></th>
+    <th bgcolor="#99CCCC"><strong>Windows</strong></th>
   </tr>
   <tr>
     <td> Perl </td>
-    <td align="center"> 5.x </td>
-    <td align="center"> 5.x </td>
-  </tr>
-  <tr>
-    <td> Non-standard Perl modules </td>
-    <td align="center"> ??? </td>
-    <td><code>MIME::Base64</code>, Digest::SHA1 (for password generation) </td>
+    <td align="center" colspan="2"> 5.005_03 or higher </td>
   </tr>
   <tr>
-    <td> Optional Perl modules </td>
-    <td><code>Net::SMTP</code> (or sendmail) </td>
+    <td> Non standard Perl modules </td>
+    <td align="center"><code>Net::SMTP</code> (or <code>sendmail</code>) </td>
     <td align="center"><code>Net::SMTP</code></td>
   </tr>
   <tr>
     <td> RCS </td>
-    <td align="center"> 5.7 </td>
-    <td align="center"> 5.7 (including <code>diff</code></td>
+    <td align="center" colspan="2"> 5.7 or higher </td>
   </tr>
   <tr>
     <td> Other external programs </td>
-    <td align="center"><code>ls</code>, <code>fgrep</code>, <code>egrep</code></td>
-    <td align="center"><code>ls</code>, <code>fgrep</code>, <code>egrep</code></td>
+    <td align="center" colspan="2"><code>ls, fgrep, egrep</code></td>
   </tr>
   <tr>
     <td> Web server </td>
-    <td align="center"> Apache </td>
-    <td align="center"> Apache, IIS </td>
+    <td align="center" colspan="2"> Apache and others (support for cgi, authentication, extended path) <strong>*</strong></td>
   </tr>
   <tr>
     <td><em>OS versions</em></td>
     <td align="center"><strong><em>Linux, Unix...</em></strong></td>
     <td align="center"><strong><em>every last Win?!</em></strong></td>
   </tr>
+  <tr>
+    <td> Required disk space </td>
+    <td>   </td>
+    <td>   </td>
+  </tr>
+</table>
+
+**_ISP INSTALLATION REQUIREMENTS: SSI, RCS local or sysadmin, same for perl modules for plugins, cron, basic authentication,..._**
+
+## <a name="Client_Side_Requirements"> Client-Side Requirements </a>
+
+The basic TWiki engine and templates have a low requirement on the browser:
+
+<table border="1" cellpadding="1" cellspacing="0">
+  <tr>
+    <th align="center" bgcolor="#99CCCC" colspan="3"><strong>Recommend PC Requirement</strong></th>
+  </tr>
+  <tr>
+    <th bgcolor="#99CCCC"><strong>Component</strong></th>
+    <th bgcolor="#99CCCC"><strong>Min/Rec</strong></th>
+  </tr>
+</table>
+
+<table border="1" cellpadding="1" cellspacing="0">
+  <tr>
+    <th align="center" bgcolor="#99CCCC" colspan="2"><strong>Browser Requirements</strong></th>
+  </tr>
+  <tr>
+    <th bgcolor="#99CCCC"><strong>Resource</strong></th>
+    <th bgcolor="#99CCCC"><strong>Details</strong></th>
+  </tr>
+  <tr>
+    <td> HTML 3.2 browser </td>
+    <td>   </td>
+  </tr>
+  <tr>
+    <td><span style="background:"><font color="">Java Script</font></span><a href="http://LOCATION/JavaScript">?</a> 1.? </td>
+    <td> Optional: JS degrades gracefully </td>
+  </tr>
+  <tr>
+    <td> Cookies </td>
+    <td> Not used </td>
+  </tr>
+  <tr>
+    <td> CSS1/2 </td>
+    <td> ???? </td>
+  </tr>
 </table>
 
+* TWiki generates XHTML 1.0 code as long as it is compatible with HTML 3.2.
+
+**_WHAT ABOUT WEB STANDARDS PROJECT - CSS CONTROL_**
+
+### <a name="Known_Issues"> Known Issues </a>
+
+* Some [[TWikiSkins]] may require more, like cookies and [[JavaScript]]
+* At present, contributed Plugins are not checked against compatibility standards, and may require anything imaginable: browser-specific functions, Java, cookies, CSS, etc.
+
 ### <a name="TWiki_Directory_Structure"> TWiki Directory Structure </a>
 
 You can easily rename the root TWiki directory - <code>**twiki**</code> - to whatever you like by changing it in the <code>**twiki.cfg**</code> configuration file. However, to keep the current installation and future upgrades simple, you should leave the subdirectory structure intact:
@@ -1406,11 +1455,11 @@ A rundown of the individual files in the current %VERSION% distribution, organiz
     <td> xxxx </td>
   </tr>
   <tr>
-    <td><code><b>TWiki/RenameTopic.txt</b></code></td>
+    <td><code><b>TWiki/ManagingTopics.txt</b></code></td>
     <td> xxxx </td>
   </tr>
   <tr>
-    <td><code><b>TWiki/RenameTopic.txt,v</b></code></td>
+    <td><code><b>TWiki/ManagingTopics.txt,v</b></code></td>
     <td> xxxx </td>
   </tr>
   <tr>
@@ -1478,11 +1527,11 @@ A rundown of the individual files in the current %VERSION% distribution, organiz
     <td> xxxx </td>
   </tr>
   <tr>
-    <td><code><b>TWiki/TWikiAdministration.txt</b></code></td>
+    <td><code><b>TWiki/ManagingWebs.txt</b></code></td>
     <td> xxxx </td>
   </tr>
   <tr>
-    <td><code><b>TWiki/TWikiAdministration.txt,v</b></code></td>
+    <td><code><b>TWiki/ManagingWebs.txt,v</b></code></td>
     <td> xxxx </td>
   </tr>
   <tr>
@@ -1574,11 +1623,11 @@ A rundown of the individual files in the current %VERSION% distribution, organiz
     <td> xxxx </td>
   </tr>
   <tr>
-    <td><code><b>TWiki/TWikiNotificationOfChanges.txt</b></code></td>
+    <td><code><b>TWiki/WebNotification.txt</b></code></td>
     <td> xxxx </td>
   </tr>
   <tr>
-    <td><code><b>TWiki/TWikiNotificationOfChanges.txt,v</b></code></td>
+    <td><code><b>TWiki/WebNotification.txt,v</b></code></td>
     <td> xxxx </td>
   </tr>
   <tr>
-- 
cgit v1.2.3