none
[openafs-wiki.git] / TWiki / TWikiSystemRequirements.mdwn
1 ## <a name="TWiki Implementation Notes"></a> TWiki Implementation Notes
2
3 ### <a name="Platform"></a> Platform
4
5 TWiki is written in Perl 5 and uses also 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.
6
7 ### <a name="Directory Structure"></a> Directory Structure
8
9 <table border="1" cellpadding="0" cellspacing="0">
10   <tr>
11     <th bgcolor="#99CCCC"><strong> Directory: </strong></th>
12     <th bgcolor="#99CCCC"><strong> Used for: </strong></th>
13   </tr>
14   <tr>
15     <td><code><b>twiki/bin</b></code></td>
16     <td> TWiki Perl scripts </td>
17   </tr>
18   <tr>
19     <td><code><b>twiki/bin/TWiki</b></code></td>
20     <td> TWiki Perl modules </td>
21   </tr>
22   <tr>
23     <td><code><b>twiki/bin/TWiki/Plugins</b></code></td>
24     <td> Plugins modules </td>
25   </tr>
26   <tr>
27     <td><code><b>twiki/pub</b></code></td>
28     <td> Public files ([[Main/FileAttachments]], images) </td>
29   </tr>
30   <tr>
31     <td><code><b>twiki/data</b></code></td>
32     <td> source text </td>
33   </tr>
34   <tr>
35     <td><code><b>twiki/templates</b></code></td>
36     <td> HTML templates, used by TWiki scripts </td>
37   </tr>
38 </table>
39
40 **_Note:_** You could move the <code>**twiki/bin/TWiki**</code> library directory (including <code>**Plugins**</code> ) to <code>**twiki/lib/TWiki**</code>; the scripts look for a <code>**"."**</code> and <code>**"../lib"**</code> relative library path.
41
42 #### <a name="Files in twiki/bin"></a> Files in twiki/bin
43
44 <table border="1" cellpadding="0" cellspacing="0">
45   <tr>
46     <th bgcolor="#99CCCC"><strong> File: </strong></th>
47     <th bgcolor="#99CCCC"><strong> Used for: </strong></th>
48   </tr>
49   <tr>
50     <td><code><b>.htaccess.txt</b></code></td>
51     <td> Authentication. Rename to .htaccess and customize if used </td>
52   </tr>
53   <tr>
54     <td><code><b>attach</b></code></td>
55     <td> Script that shows the attach file page ([[Main/FileAttachment]]) </td>
56   </tr>
57   <tr>
58     <td><code><b>delete</b></code></td>
59     <td> (not used yet) </td>
60   </tr>
61   <tr>
62     <td><code><b>edit</b></code></td>
63     <td> Script to edit a topic </td>
64   </tr>
65   <tr>
66     <td><code><b>geturl</b></code></td>
67     <td> Script to fetch URL data </td>
68   </tr>
69   <tr>
70     <td><code><b>mailnotify</b></code></td>
71     <td> Script called by cron job to notify users of changes </td>
72   </tr>
73   <tr>
74     <td><code><b>oops</b></code></td>
75     <td> Script that shows an OK or oops dialog </td>
76   </tr>
77   <tr>
78     <td><code><b>preview</b></code></td>
79     <td> Script to preview topic after edit </td>
80   </tr>
81   <tr>
82     <td><code><b>rdiff</b></code></td>
83     <td> Script to see differences of topics </td>
84   </tr>
85   <tr>
86     <td><code><b>register</b></code></td>
87     <td> Script to register new users </td>
88   </tr>
89   <tr>
90     <td><code><b>save</b></code></td>
91     <td> Script that saves a topic, called by preview </td>
92   </tr>
93   <tr>
94     <td><code><b>search</b></code></td>
95     <td> Script that displays search results </td>
96   </tr>
97   <tr>
98     <td><code><b>statistics</b></code></td>
99     <td> Script to create statistics topic </td>
100   </tr>
101   <tr>
102     <td><code><b>testenv</b></code></td>
103     <td> Script to test CGI environment variables </td>
104   </tr>
105   <tr>
106     <td><code><b>upload</b></code></td>
107     <td> Script that does file upload ([[Main/FileAttachment]]) </td>
108   </tr>
109   <tr>
110     <td><code><b>view</b></code></td>
111     <td> Script to view a topic ( <strong>the</strong> script ) </td>
112   </tr>
113   <tr>
114     <td><code><b>viewfile</b></code></td>
115     <td> Script to view an file attachment </td>
116   </tr>
117   <tr>
118     <td><code><b>TWiki.pm</b></code></td>
119     <td> Main TWiki library </td>
120   </tr>
121   <tr>
122     <td><code><b>TWiki.cfg</b></code></td>
123     <td> For initialization and configuration, used by <code><b>TWiki.pm</b></code></td>
124   </tr>
125 </table>
126
127 #### <a name="Files in twiki/bin/TWiki"></a> Files in twiki/bin/TWiki
128
129 <table border="1" cellpadding="0" cellspacing="0">
130   <tr>
131     <th bgcolor="#99CCCC"><strong> File: </strong></th>
132     <th bgcolor="#99CCCC"><strong> Used for: </strong></th>
133   </tr>
134   <tr>
135     <td><code><b>Access.pm</b></code></td>
136     <td> Access control </td>
137   </tr>
138   <tr>
139     <td><code><b>Net.pm</b></code></td>
140     <td> SMTP mail handling </td>
141   </tr>
142   <tr>
143     <td><code><b>Plugins.pm</b></code></td>
144     <td> Plugin handling </td>
145   </tr>
146   <tr>
147     <td><code><b>Prefs.pm</b></code></td>
148     <td> Preferences handling </td>
149   </tr>
150   <tr>
151     <td><code><b>Search.pm</b></code></td>
152     <td> Search engine, used by wiki.pm </td>
153   </tr>
154   <tr>
155     <td><code><b>Store.pm</b></code></td>
156     <td> Back-end storage, <code>*.txt</code> text file and <code>*.txt,v</code> RCS repository file handling </td>
157   </tr>
158 </table>
159
160 #### <a name="Files in twiki/bin/TWiki/Plugins"></a> Files in twiki/bin/TWiki/Plugins
161
162 <table border="1" cellpadding="0" cellspacing="0">
163   <tr>
164     <th bgcolor="#99CCCC"><strong> File: </strong></th>
165     <th bgcolor="#99CCCC"><strong> Used for: </strong></th>
166   </tr>
167   <tr>
168     <td><code><b>DefaultPlugin.pm</b></code></td>
169     <td> Default plugin </td>
170   </tr>
171   <tr>
172     <td><code><b>EmptyPlugin.pm</b></code></td>
173     <td> Empty plugin, use to create your own </td>
174   </tr>
175 </table>
176
177 -- [[PeterThoeny]] - 03 Mar 2001 <br />