### <a name="Documentation of the TWiki Imple"></a> Documentation of the TWiki Implementation (version TWiki-4.1.2, Sat, 03 Mar 2007, build 13046)
-- [(1)](#login) Wiki Username vs. Login Username
-- [(2)](#access) TWiki Access Control
-- [(3)](#templates) Wiki Templates
-- [(4)](#variables) Wiki Variables
-- [(5)](#notification) Notification of Changes by Email
-- [(6)](#category) TWiki Category Table
-- [(7)](#implementation) Implementation Notes
-- [(8)](#installation) Installation Notes
-- [(9)](#upgrade) Upgrading Earlier Versions of TWiki
+- [(1)](#implementation) Implementation Notes
+- [(2)](#installation) Installation Notes
+- [(3)](#upgrade) Upgrading Earlier Versions of TWiki
+- [(4)](#authentication) TWiki Authentication
+- [(5)](#login) Wiki Username vs. Login Username
+- [(6)](#access) TWiki Access Control
+- [(7)](#templates) Wiki Templates
+- [(8)](#variables) Wiki Variables
+- [(9)](#notification) Notification of Changes by Email
+- [(10)](#category) TWiki Category Table
+- [(11)](#administration) TWiki Administration
Related Topics: [[TWikiWeb]], [[TWikiHistory]], [[TWikiPlannedFeatures]], [[TWikiEnhancementRequests]].
-<a name="login"> </a>
+<a name="implementation"> </a>
----
-**(1) Wiki Username vs. Login Username**
+**(1) Implementation Notes**
-<a name="control"> </a>
+<a name="installation"> </a>
----
-**(2) TWiki Access Control**
+**(2) Installation Notes**
-<a name="templates"> </a>
+<a name="upgrade"> </a>
----
-**(3) Wiki Templates**
+**(3) Upgrading Earlier Versions of TWiki**
-<a name="variables"> </a>
+<a name="authentication"> </a>
----
-**(4) Wiki Variables**
+**(4) TWiki Authentication**
-<a name="notification"> </a>
+<a name="login"> </a>
----
-**(5) Notification of Changes by Email**
+**(5) Wiki Username vs. Login Username**
-<a name="category"> </a>
+<a name="control"> </a>
----
-**(6) TWiki Category Table**
+**(6) TWiki Access Control**
-<a name="implementation"> </a>
+<a name="templates"> </a>
----
-**(7) Implementation Notes**
+**(7) Wiki Templates**
-<a name="installation"> </a>
+<a name="variables"> </a>
----
-**(8) Installation Notes**
+**(8) Wiki Variables**
-<a name="upgrade"> </a>
+<a name="notification"> </a>
+
+----
+
+**(9) Notification of Changes by Email**
+
+<a name="category"> </a>
+
+----
+
+**(10) TWiki Category Table**
+
+<a name="administration"> </a>
----
-**(9) Upgrading Earlier Versions of TWiki**
+**(11) TWiki Administration**
- Point your browser at <http://your.domain.com/twiki/bin/view> and start TWiki-ing away!
- Note in case the cgi scripts are **_not_** running as user `nobody`: The `*,v` RCS repository files delivered with the installation package are locked by user `nobody` . In case the user is different (e.g. `www-data` ), it is not possible to check in files, this has the effect that the topic version number does not increase when saving a topic. In this case you need to unlock all repository files and lock them as user `www-data` (check the rcs man pages), or simply delete all the repository files. A simple way to switch the locker of the RCS files is to use sed: <br />`for f in *,v; do sed 's/nobody/www-data/' $f > x; mv x $f; done`
- Security issue: Directories `twiki/data` , `twiki/templates` and all its subdirectories should be set so that they are **not** visible as a URL. (Alternatively, move the directries to a place where they are not visible, and change the variables in `twiki/bin/wikicfg.pm` accordingly)
-- Enable email notification of topic changes, [(4)](TWikiDocumentation#notification) has more.
+- Enable email notification of topic changes, [Notification of Changes](TWikiDocumentation#notification) has more.
- Add the [PoweredByTWikiLogo](http://TWiki.SourceForge.net/cgi-bin/view/Main/PoweredByTWikiLogo) if TWiki is installed on a public web server.
- Optional: You can add new rendering rules or new %VARIABLES%. To insure an easy upgrade of TWiki it is recommended to do this customization in `twiki/bin/wikicfg.pm` , not `twiki/bin/wiki.pm` .
- Customize the WEBTOPICLIST variable to contain the web specific links you prefer.
- Optional: Set the WEBCOPYRIGHT variable to have a web-specific copyright text (at the bottom of each topic).
- If needed, create customized templates in the new templates directory. (Non existing templates are inherited from `twiki/templates` )
- - If you want to use a category table, copy the three files `twikicatitems.tmpl` , `twikicatedit.tmpl` and `twikicatview.tmpl` from the `twiki/templates/Know` directory to the new templates directory, and customize it. More on that in [(5)](TWikiDocumentation#category) TWiki Category Table.
+ - If you want to use a category table, copy the three files `twikicatitems.tmpl` , `twikicatedit.tmpl` and `twikicatview.tmpl` from the `twiki/templates/Know` directory to the new templates directory, and customize it. More on that in [TWiki Category Table](TWikiDocumentation#category).
- In case you want usage statistics for this web: Copy file `WebStatistics.txt` from the `twiki/data/Main` directory to the new data directory. Edit topic WebStatistics in the new web and delete old usage entries.
Here are contents of directories showing file permissions. Please note that this is for debugging reasons only and does not exactly reflect the distribution:
-rwxrwxr-x 1 twiki twiki 14543 Jul 20 18:46 upload
-rwxrwxr-x 1 twiki twiki 4755 May 22 18:11 view
-rwxrwxr-x 1 twiki twiki 1689 Jun 20 20:10 viewfile
- -rw-rw-r-- 1 twiki twiki 40103 Aug 18 13:00 wiki.pm
- -rw-rw-r-- 1 twiki twiki 11521 Aug 19 18:38 wikicfg.pm
- -rw-rw-r-- 1 twiki twiki 13969 Aug 19 00:30 wikisearch.pm
+ -rw-rw-r-- 1 twiki twiki 34123 Nov 1 15:43 wiki.pm
+ -rw-rw-r-- 1 twiki twiki 7234 Oct 23 00:34 wikiaccess.pm
+ -rw-rw-r-- 1 twiki twiki 11719 Oct 28 21:58 wikicfg.pm
+ -rw-rw-r-- 1 twiki twiki 6441 Nov 1 23:13 wikiprefs.pm
+ -rw-rw-r-- 1 twiki twiki 13160 Oct 27 14:53 wikisearch.pm
+ -rw-rw-r-- 1 twiki twiki 10540 Oct 28 21:43 wikistore.pm
Directory `twiki/templates/` :
-rw-rw-r-- 1 twiki twiki 907 Jul 20 16:01 notwiki.tmpl
-rw-rw-r-- 1 twiki twiki 341 Mar 8 11:39 noweb.tmpl
-rw-rw-r-- 1 twiki twiki 1000 Mar 8 11:40 oops.tmpl
+ -rw-rw-r-- 1 twiki twiki 1043 Oct 23 19:17 oopsaccesschange.tmpl
+ -rw-rw-r-- 1 twiki twiki 1036 Oct 23 19:17 oopsaccessview.tmpl
-rw-rw-r-- 1 twiki twiki 914 Mar 8 11:40 oopsdel.tmpl
-rw-rw-r-- 1 twiki twiki 1423 May 29 01:23 oopslocked.tmpl
-rw-rw-r-- 1 twiki twiki 1067 Mar 8 11:41 oopsregexist.tmpl
-rw-rw-r-- 1 twiki twiki 152 Mar 9 1999 xls.gif
-rw-rw-r-- 1 twiki twiki 144 Mar 9 1999 zip.gif
--- [[PeterThoeny]] - 23 Sep 2000 <br />
+-- [[PeterThoeny]] - 02 Nov 2000 <br />
**_Platform_**
-TWiki is written in PERL 5, but it uses also many shell command. The current implementation runs only on a Unix machine. RCS for revision control must be installed on the system.
+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.
**_Directories_**
<th bgcolor="#99CCCC"><strong> Used for: </strong></th>
</tr>
<tr>
- <td> twiki/bin </td>
+ <td><code>twiki/bin</code></td>
<td> TWiki PERL scripts </td>
</tr>
<tr>
- <td> twiki/pub </td>
+ <td><code>twiki/pub</code></td>
<td> Public files ([[Main/FileAttachments]], images) </td>
</tr>
<tr>
- <td> twiki/data </td>
+ <td><code>twiki/data</code></td>
<td> source text </td>
</tr>
<tr>
- <td> twiki/templates </td>
+ <td><code>twiki/templates</code></td>
<td> HTML templates, used by TWiki scripts </td>
</tr>
</table>
<th bgcolor="#99CCCC"><strong> Used for: </strong></th>
</tr>
<tr>
- <td> .htaccess.txt </td>
+ <td><code>.htaccess.txt</code></td>
<td> Authentication. Rename to .htaccess and customize if used </td>
</tr>
<tr>
- <td> attach </td>
+ <td><code>attach</code></td>
<td> Script that shows the attach file page ([[Main/FileAttachment]]) </td>
</tr>
<tr>
- <td> delete </td>
+ <td><code>delete</code></td>
<td> (not used yet) </td>
</tr>
<tr>
- <td> edit </td>
+ <td><code>edit</code></td>
<td> Script to edit a topic </td>
</tr>
<tr>
- <td> geturl </td>
+ <td><code>geturl</code></td>
<td> Script to fetch URL data </td>
</tr>
<tr>
- <td> mailnotify </td>
+ <td><code>mailnotify</code></td>
<td> Script called by cron job to notify users of changes </td>
</tr>
<tr>
- <td> oops </td>
+ <td><code>oops</code></td>
<td> Script that shows a OK or oops dialog </td>
</tr>
<tr>
- <td> preview </td>
+ <td><code>preview</code></td>
<td> Script to preview topic after edit </td>
</tr>
<tr>
- <td> rdiff </td>
+ <td><code>rdiff</code></td>
<td> Script to see differences of topics </td>
</tr>
<tr>
- <td> register </td>
+ <td><code>register</code></td>
<td> Script to register new users </td>
</tr>
<tr>
- <td> save </td>
+ <td><code>save</code></td>
<td> Script that saves a topic, called by preview </td>
</tr>
<tr>
- <td> search </td>
+ <td><code>search</code></td>
<td> Script that displays search results </td>
</tr>
<tr>
- <td> statistics </td>
+ <td><code>statistics</code></td>
<td> Script to create statistics topic </td>
</tr>
<tr>
- <td> testenv </td>
+ <td><code>testenv</code></td>
<td> Script to test CGI environment variables </td>
</tr>
<tr>
- <td> upload </td>
+ <td><code>upload</code></td>
<td> Script that does file upload ([[Main/FileAttachment]]) </td>
</tr>
<tr>
- <td> view </td>
+ <td><code>view</code></td>
<td> Script to view a topic ( <strong>the</strong> script ) </td>
</tr>
<tr>
- <td> viewfile </td>
+ <td><code>viewfile</code></td>
<td> Script to view an file attachment </td>
</tr>
<tr>
- <td> wiki.pm </td>
+ <td><code>wiki.pm</code></td>
<td> main TWiki library </td>
</tr>
<tr>
- <td> wikicfg.pm </td>
+ <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> wikisearch.pm </td>
+ <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>
--- [[PeterThoeny]] - 19 Aug 2000 <br />
+-- [[PeterThoeny]] - 02 Nov 2000 <br />
git://git.openafs.org / openafs-wiki.git / commitdiff