-**_Platform_**
+<div>
+ <ul>
+ <li><a href="#TWiki Implementation Notes"> TWiki Implementation Notes</a><ul>
+ <li><a href="#Platforms and System Requirement"> Platforms and System Requirements </a></li>
+ <li><a href="#Directory Structure"> Directory Structure</a><ul>
+ <li><a href="#Files in twiki"> Files in <code>twiki</code></a></li>
+ <li><a href="#Files in twiki/bin"> Files in <code>twiki/bin</code></a></li>
+ <li><a href="#Files in twiki/lib"> Files in <code>twiki/lib</code></a></li>
+ <li><a href="#Files in twiki/lib/TWiki"> Files in <code>twiki/lib/TWiki</code></a></li>
+ <li><a href="#Files in twiki/lib/TWiki/Plugins"> Files in <code>twiki/lib/TWiki/Plugins</code></a></li>
+ <li><a href="#Files in twiki/pub"> Files in <code>twiki/pub</code></a></li>
+ <li><a href="#Files in twiki/data"> Files in <code>twiki/data</code></a></li>
+ <li><a href="#Files in twiki/templates"> Files in <code>twiki/templates</code></a></li>
+ </ul>
+ </li>
+ </ul>
+ </li>
+ </ul>
+</div>
-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.
+## <a name="TWiki Implementation Notes"></a> TWiki Implementation Notes
-**_Directories_**
+### <a name="Platforms and System Requirement"></a> Platforms and System Requirements
+
+TWiki is written in **Perl 5** and also uses some **shell commands**. The current implementation runs best on a Unix machine, but it is also possible on Microsoft Windows. **RCS** (for revision control) must be installed on the system. [ **_MM: Locate elsewhere and/or include one-liner and link for RCS..._** ]
+
+<table border="1" cellpadding="0" cellspacing="0">
+ <tr>
+ <th bgcolor="#99CCCC" colspan="3"><strong> Required 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>
+ </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> </td>
+ <td><code>MIME::Base64</code>, Digest::SHA1 (for password generation) </td>
+ </tr>
+ <tr>
+ <td> Optional Perl modules </td>
+ <td><code>Net::SMTP</code> (or sendmail) </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>
+ </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>
+ </tr>
+ <tr>
+ <td> Web server </td>
+ <td align="center"> Apache </td>
+ <td align="center"> Apache, IIS </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>
+</table>
+
+### <a name="Directory Structure"></a> Directory Structure
+
+You can easily rename the root TWiki directory - <code>**twiki**</code> - 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:
<table border="1" cellpadding="0" cellspacing="0">
<tr>
<th bgcolor="#99CCCC"><strong> Directory: </strong></th>
+ <th bgcolor="#99CCCC"><strong> Files: </strong></th>
<th bgcolor="#99CCCC"><strong> Used for: </strong></th>
</tr>
<tr>
- <td><code>twiki/bin</code></td>
- <td> TWiki PERL scripts </td>
+ <td><code><b>twiki</b></code></td>
+ <td align="center">[[Main/WebHome#TWikiFiles]]</td>
+ <td> Start-up info </td>
+ </tr>
+ <tr>
+ <td><code><b>twiki/bin</b></code></td>
+ <td align="center">[[Main/WebHome#BinFiles]]</td>
+ <td> Perl scripts </td>
</tr>
<tr>
- <td><code>twiki/pub</code></td>
- <td> Public files ([[Main/FileAttachments]], images) </td>
+ <td><code><b>twiki/lib</b></code></td>
+ <td align="center">[[Main/WebHome#LibFiles]]</td>
+ <td> Configuration file & main library </td>
</tr>
<tr>
- <td><code>twiki/data</code></td>
- <td> source text </td>
+ <td><code><b>twiki/lib/TWiki</b></code></td>
+ <td align="center">[[Main/WebHome#LibTWiki]]</td>
+ <td> Perl modules </td>
</tr>
<tr>
- <td><code>twiki/templates</code></td>
+ <td><code><b>twiki/lib/TWiki/Plugins</b></code></td>
+ <td align="center">[[Main/WebHome#libtwikiplugins]]</td>
+ <td>[[Main/TWikiPlugins]] Perl modules </td>
+ </tr>
+ <tr>
+ <td><code><b>twiki/pub</b></code></td>
+ <td align="center">[[Main/WebHome#PubFiles]]</td>
+ <td> Public support files (ex: [[Main/FileAttachments]], images) and RCS histories) </td>
+ </tr>
+ <tr>
+ <td><code><b>twiki/data</b></code></td>
+ <td align="center">[[Main/WebHome#DataFiles]]</td>
+ <td> Topic text (page content) and RCS histories; </td>
+ </tr>
+ <tr>
+ <td><code><b>twiki/templates</b></code></td>
+ <td align="center">[[Main/WebHome#TemplatesFiles]]</td>
<td> HTML templates, used by TWiki scripts </td>
</tr>
</table>
-**_Files in twiki/bin_**
+**_Note: about the additional directories in data, elsewhere_**
+
+<a name="TWikiFiles"></a>
+
+#### <a name="Files in twiki"></a> Files in `twiki`
+
+**_to follow_**
+
+<a name="BinFiles"></a>
+
+#### <a name="Files in twiki/bin"></a> Files in `twiki/bin`
<table border="1" cellpadding="0" cellspacing="0">
<tr>
<th bgcolor="#99CCCC"><strong> Used for: </strong></th>
</tr>
<tr>
- <td><code>.htaccess.txt</code></td>
+ <td><code><b>.htaccess.txt</b></code></td>
<td> Authentication. Rename to .htaccess and customize if used </td>
</tr>
<tr>
- <td><code>attach</code></td>
+ <td><code><b>attach</b></code></td>
<td> Script that shows the attach file page ([[Main/FileAttachment]]) </td>
</tr>
<tr>
- <td><code>delete</code></td>
+ <td><code><b>delete</b></code></td>
<td> (not used yet) </td>
</tr>
<tr>
- <td><code>edit</code></td>
+ <td><code><b>edit</b></code></td>
<td> Script to edit a topic </td>
</tr>
<tr>
- <td><code>geturl</code></td>
+ <td><code><b>geturl</b></code></td>
<td> Script to fetch URL data </td>
</tr>
<tr>
- <td><code>mailnotify</code></td>
+ <td><code><b>mailnotify</b></code></td>
<td> Script called by cron job to notify users of changes </td>
</tr>
<tr>
- <td><code>oops</code></td>
- <td> Script that shows a OK or oops dialog </td>
+ <td><code><b>oops</b></code></td>
+ <td> Script that shows an OK or oops dialog </td>
</tr>
<tr>
- <td><code>preview</code></td>
+ <td><code><b>preview</b></code></td>
<td> Script to preview topic after edit </td>
</tr>
<tr>
- <td><code>rdiff</code></td>
+ <td><code><b>rdiff</b></code></td>
<td> Script to see differences of topics </td>
</tr>
<tr>
- <td><code>register</code></td>
+ <td><code><b>rename</b></code></td>
+ <td> Script to rename/move topics and move attachments </td>
+ </tr>
+ <tr>
+ <td><code><b>register</b></code></td>
<td> Script to register new users </td>
</tr>
<tr>
- <td><code>save</code></td>
+ <td><code><b>save</b></code></td>
<td> Script that saves a topic, called by preview </td>
</tr>
<tr>
- <td><code>search</code></td>
+ <td><code><b>search</b></code></td>
<td> Script that displays search results </td>
</tr>
<tr>
- <td><code>statistics</code></td>
+ <td><code><b>statistics</b></code></td>
<td> Script to create statistics topic </td>
</tr>
<tr>
- <td><code>testenv</code></td>
+ <td><code><b>testenv</b></code></td>
<td> Script to test CGI environment variables </td>
</tr>
<tr>
- <td><code>upload</code></td>
+ <td><code><b>upload</b></code></td>
<td> Script that does file upload ([[Main/FileAttachment]]) </td>
</tr>
<tr>
- <td><code>view</code></td>
+ <td><code><b>view</b></code></td>
<td> Script to view a topic ( <strong>the</strong> script ) </td>
</tr>
<tr>
- <td><code>viewfile</code></td>
+ <td><code><b>viewfile</b></code></td>
<td> Script to view an file attachment </td>
</tr>
+</table>
+
+<a name="LibFiles"></a>
+
+#### <a name="Files in twiki/lib"></a> Files in `twiki/lib`
+
+<table border="1" cellpadding="0" cellspacing="0">
<tr>
- <td><code>wiki.pm</code></td>
- <td> main TWiki library </td>
+ <th bgcolor="#99CCCC"><strong> File: </strong></th>
+ <th bgcolor="#99CCCC"><strong> Used for: </strong></th>
+ </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 configuration, used by <code><b>TWiki.pm</b></code></td>
+ </tr>
+</table>
+
+<a name="LibTWiki"></a>
+
+#### <a name="Files in twiki/lib/TWiki"></a> Files in `twiki/lib/TWiki`
+
+<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>Attach.pm</b></code></td>
+ <td> Attachment handling </td>
+ </tr>
+ <tr>
+ <td><code><b>Meta.pm</b></code></td>
+ <td> Meta data in topics </td>
+ </tr>
+ <tr>
+ <td><code><b>Net.pm</b></code></td>
+ <td> SMTP mail handling </td>
</tr>
<tr>
- <td><code>wikiaccess.pm</code></td>
- <td> access control </td>
+ <td><code><b>Plugins.pm</b></code></td>
+ <td> Plugin handling </td>
</tr>
<tr>
- <td><code>wikicfg.pm</code></td>
- <td> for initialization and configuration, used by wiki.pm </td>
+ <td><code><b>Prefs.pm</b></code></td>
+ <td> Preferences handling </td>
</tr>
<tr>
- <td><code>wikiprefs.pm</code></td>
- <td> preferences handling </td>
+ <td><code><b>Search.pm</b></code></td>
+ <td> Search engine, used by wiki.pm </td>
</tr>
<tr>
- <td><code>wikisearch.pm</code></td>
- <td> search engine, used by wiki.pm </td>
+ <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="LibTWikiPlugins"></a>
+
+#### <a name="Files in twiki/lib/TWiki/Plugins"></a> Files in `twiki/lib/TWiki/Plugins`
+
+<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>wikistore.pm</code></td>
- <td> back-end storage, <code>*.txt</code> text file and <code>*.txt,v</code> RCS repository file handling </td>
+ <td><code><b>EmptyPlugin.pm</b></code></td>
+ <td> Empty plugin, use to create your own </td>
+ </tr>
+ <tr>
+ <td><code><b>InterwikiPlugin.pm</b></code></td>
+ <td> Refer to external Wikis and other Web sites </td>
</tr>
</table>
--- [[PeterThoeny]] - 02 Nov 2000 <br />
+<a name="PubFiles"></a>
+
+#### <a name="Files in twiki/pub"></a> Files in `twiki/pub`
+
+**_to follow_**
+
+<a name="DataFiles"></a>
+
+#### <a name="Files in twiki/data"></a> Files in `twiki/data`
+
+**_to follow_**
+
+<a name="TemplatesFiles"></a>
+
+#### <a name="Files in twiki/templates"></a> Files in `twiki/templates`
+
+**_to follow_**
+
+-- [[MikeMannix]] - 28 Aug 2001
git://git.openafs.org / openafs-wiki.git / blobdiff