none
[openafs-wiki.git] / TWiki / TWikiSystemRequirements.mdwn
index 64d0e6a..3e15e62 100644 (file)
@@ -1,7 +1,11 @@
 <div>
   <ul>
-    <li><a href="#TWiki Software Environment"> TWiki Software Environment</a><ul>
-        <li><a href="#System Requirements"> System Requirements</a></li>
+    <li><a href="#TWiki Operating Environment"> TWiki Operating Environment</a><ul>
+        <li><a href="#Server-Side Requirements"> Server-Side Requirements</a></li>
+      </ul>
+    </li>
+    <li><a href="#Client-Side Requirements"> Client-Side Requirements</a><ul>
+        <li><a href="#Known Issues"> Known Issues</a></li>
         <li><a href="#TWiki Directory Structure"> TWiki Directory Structure</a></li>
         <li><a href="#File Descriptions"> File Descriptions</a><ul>
             <li><a href="#Files in twiki"> Files in <code>twiki</code></a></li>
   </ul>
 </div>
 
-## <a name="TWiki Software Environment"></a> TWiki Software Environment
+## <a name="TWiki Operating Environment"></a> TWiki Operating Environment
+
+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.
 
-### <a name="System Requirements"></a> System Requirements
+### <a name="Server-Side Requirements"></a> Server-Side Requirements
 
-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.
+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="0" 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"></a> Client-Side Requirements
+
+The basic TWiki engine and templates have a low requirement on the browser:
+
+<table border="1" cellpadding="0" 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="0" 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>[[Main/JavaScript]] 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"></a> Known Issues
+
+- 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"></a> TWiki Directory Structure
 
 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:
@@ -1423,11 +1476,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>
@@ -1495,19 +1548,19 @@ 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>
-    <td><code><b>TWiki/TWikiAuthentication.txt</b></code></td>
+    <td><code><b>TWiki/TWikiUserAuthentication.txt</b></code></td>
     <td> xxxx </td>
   </tr>
   <tr>
-    <td><code><b>TWiki/TWikiAuthentication.txt,v</b></code></td>
+    <td><code><b>TWiki/TWikiUserAuthentication.txt,v</b></code></td>
     <td> xxxx </td>
   </tr>
   <tr>
@@ -1583,19 +1636,19 @@ A rundown of the individual files in the current %VERSION% distribution, organiz
     <td> xxxx </td>
   </tr>
   <tr>
-    <td><code><b>TWiki/TWikiInstallationNotes.txt</b></code></td>
+    <td><code><b>TWiki/TWikiInstallationGuide.txt</b></code></td>
     <td> xxxx </td>
   </tr>
   <tr>
-    <td><code><b>TWiki/TWikiInstallationNotes.txt,v</b></code></td>
+    <td><code><b>TWiki/TWikiInstallationGuide.txt,v</b></code></td>
     <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>
@@ -1667,11 +1720,11 @@ A rundown of the individual files in the current %VERSION% distribution, organiz
     <td> xxxx </td>
   </tr>
   <tr>
-    <td><code><b>TWiki/TWikiUpgradeNotes.txt</b></code></td>
+    <td><code><b>TWiki/TWikiUpgradeGuide.txt</b></code></td>
     <td> xxxx </td>
   </tr>
   <tr>
-    <td><code><b>TWiki/TWikiUpgradeNotes.txt,v</b></code></td>
+    <td><code><b>TWiki/TWikiUpgradeGuide.txt,v</b></code></td>
     <td> xxxx </td>
   </tr>
   <tr>