**_Platform_**

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.

**_Directories_**

<table border="1" cellpadding="1" cellspacing="0">
  <tr>
    <th bgcolor="#99CCCC"><strong>Directory:</strong></th>
    <th bgcolor="#99CCCC"><strong>Used for:</strong></th>
  </tr>
  <tr>
    <td><code>twiki/bin</code></td>
    <td> TWiki Perl scripts </td>
  </tr>
  <tr>
    <td><code>twiki/pub</code></td>
    <td> Public files (<span style="background:"><font color="">File Attachments</font></span><a href="http://LOCATION/FileAttachments">?</a>, images) </td>
  </tr>
  <tr>
    <td><code>twiki/data</code></td>
    <td> source text </td>
  </tr>
  <tr>
    <td><code>twiki/templates</code></td>
    <td> HTML templates, used by TWiki scripts </td>
  </tr>
</table>

**_Files in twiki/bin_**

<table border="1" cellpadding="1" cellspacing="0">
  <tr>
    <th bgcolor="#99CCCC"><strong>File:</strong></th>
    <th bgcolor="#99CCCC"><strong>Used for:</strong></th>
  </tr>
  <tr>
    <td><code>.htaccess.txt</code></td>
    <td> Authentication. Rename to .htaccess and customize if used </td>
  </tr>
  <tr>
    <td><code>attach</code></td>
    <td> Script that shows the attach file page (<span style="background:"><font color="">File Attachment</font></span><a href="http://LOCATION/FileAttachment">?</a>) </td>
  </tr>
  <tr>
    <td><code>delete</code></td>
    <td> (not used yet) </td>
  </tr>
  <tr>
    <td><code>edit</code></td>
    <td> Script to edit a topic </td>
  </tr>
  <tr>
    <td><code>geturl</code></td>
    <td> Script to fetch URL data </td>
  </tr>
  <tr>
    <td><code>mailnotify</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 an OK or oops dialog </td>
  </tr>
  <tr>
    <td><code>preview</code></td>
    <td> Script to preview topic after edit </td>
  </tr>
  <tr>
    <td><code>rdiff</code></td>
    <td> Script to see differences of topics </td>
  </tr>
  <tr>
    <td><code>register</code></td>
    <td> Script to register new users </td>
  </tr>
  <tr>
    <td><code>save</code></td>
    <td> Script that saves a topic, called by preview </td>
  </tr>
  <tr>
    <td><code>search</code></td>
    <td> Script that displays search results </td>
  </tr>
  <tr>
    <td><code>statistics</code></td>
    <td> Script to create statistics topic </td>
  </tr>
  <tr>
    <td><code>testenv</code></td>
    <td> Script to test CGI environment variables </td>
  </tr>
  <tr>
    <td><code>upload</code></td>
    <td> Script that does file upload (<span style="background:"><font color="">File Attachment</font></span><a href="http://LOCATION/FileAttachment">?</a>) </td>
  </tr>
  <tr>
    <td><code>view</code></td>
    <td> Script to view a topic ( <strong>the</strong> script ) </td>
  </tr>
  <tr>
    <td><code>viewfile</code></td>
    <td> Script to view an file attachment </td>
  </tr>
  <tr>
    <td><code>wiki.pm</code></td>
    <td> main TWiki library </td>
  </tr>
  <tr>
    <td><code>wikiaccess.pm</code></td>
    <td> access control </td>
  </tr>
  <tr>
    <td><code>wikicfg.pm</code></td>
    <td> for initialization and configuration, used by wiki.pm </td>
  </tr>
  <tr>
    <td><code>wikiprefs.pm</code></td>
    <td> preferences handling </td>
  </tr>
  <tr>
    <td><code>wikisearch.pm</code></td>
    <td> search engine, used by wiki.pm </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>
  </tr>
</table>

-- [[Main/PeterThoeny]] - 02 Nov 2000 <br />