1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
|
%TOC% %STARTINCLUDE%
## <a name="TWiki_Implementation_Notes"> TWiki Implementation Notes </a>
### <a name="Platforms_and_System_Requirement"> Platforms and System Requirements </a>
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="1" 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"> Directory Structure </a>
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="1" 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><b>twiki</b></code></td>
<td align="center"> list </td>
<td> Start-up info </td>
</tr>
<tr>
<td><code><b>twiki/bin</b></code></td>
<td align="center"> list </td>
<td> Perl scripts </td>
</tr>
<tr>
<td><code><b>twiki/lib</b></code></td>
<td align="center"> list </td>
<td> Configuration file &amp; main library </td>
</tr>
<tr>
<td><code><b>twiki/lib/TWiki</b></code></td>
<td align="center"> list </td>
<td> Perl modules </td>
</tr>
<tr>
<td><code><b>twiki/lib/TWiki/Plugins</b></code></td>
<td align="center"> list </td>
<td><span style="background:"><font color="">TWiki Plugins</font></span><a href="http://LOCATION/TWikiPlugins">?</a> Perl modules </td>
</tr>
<tr>
<td><code><b>twiki/pub</b></code></td>
<td align="center"> list </td>
<td> Public support files (ex: <span style="background:"><font color="">File Attachments</font></span><a href="http://LOCATION/FileAttachments">?</a>, images) and RCS histories) </td>
</tr>
<tr>
<td><code><b>twiki/data</b></code></td>
<td align="center"> list </td>
<td> Topic text (page content) and RCS histories; </td>
</tr>
<tr>
<td><code><b>twiki/templates</b></code></td>
<td align="center"> list </td>
<td> HTML templates, used by TWiki scripts </td>
</tr>
</table>
**_Note: about the additional directories in data, elsewhere_**
<a name="TWikiFiles"></a>
#### <a name="Files_in_twiki_code_"> Files in `twiki` </a>
**_to follow_**
<a name="BinFiles"></a>
#### <a name="Files_in_twiki_bin_code_"> Files in `twiki/bin` </a>
<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><b>.htaccess.txt</b></code></td>
<td> Authentication. Rename to .htaccess and customize if used </td>
</tr>
<tr>
<td><code><b>attach</b></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><b>delete</b></code></td>
<td> (not used yet) </td>
</tr>
<tr>
<td><code><b>edit</b></code></td>
<td> Script to edit a topic </td>
</tr>
<tr>
<td><code><b>geturl</b></code></td>
<td> Script to fetch URL data </td>
</tr>
<tr>
<td><code><b>mailnotify</b></code></td>
<td> Script called by cron job to notify users of changes </td>
</tr>
<tr>
<td><code><b>oops</b></code></td>
<td> Script that shows an OK or oops dialog </td>
</tr>
<tr>
<td><code><b>preview</b></code></td>
<td> Script to preview topic after edit </td>
</tr>
<tr>
<td><code><b>rdiff</b></code></td>
<td> Script to see differences of topics </td>
</tr>
<tr>
<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><b>save</b></code></td>
<td> Script that saves a topic, called by preview </td>
</tr>
<tr>
<td><code><b>search</b></code></td>
<td> Script that displays search results </td>
</tr>
<tr>
<td><code><b>statistics</b></code></td>
<td> Script to create statistics topic </td>
</tr>
<tr>
<td><code><b>testenv</b></code></td>
<td> Script to test CGI environment variables </td>
</tr>
<tr>
<td><code><b>upload</b></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><b>view</b></code></td>
<td> Script to view a topic ( <strong>the</strong> script ) </td>
</tr>
<tr>
<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_code_"> Files in `twiki/lib` </a>
<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><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_code_"> Files in `twiki/lib/TWiki` </a>
<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><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><b>Plugins.pm</b></code></td>
<td> Plugin handling </td>
</tr>
<tr>
<td><code><b>Prefs.pm</b></code></td>
<td> Preferences handling </td>
</tr>
<tr>
<td><code><b>Search.pm</b></code></td>
<td> Search engine, used by wiki.pm </td>
</tr>
<tr>
<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"> Files in `twiki/lib/TWiki/Plugins` </a>
<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><b>DefaultPlugin.pm</b></code></td>
<td> Default plugin </td>
</tr>
<tr>
<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>
<a name="PubFiles"></a>
#### <a name="Files_in_twiki_pub_code_"> Files in `twiki/pub` </a>
**_to follow_**
<a name="DataFiles"></a>
#### <a name="Files_in_twiki_data_code_"> Files in `twiki/data` </a>
**_to follow_**
<a name="TemplatesFiles"></a>
#### <a name="Files_in_twiki_templates_code_"> Files in `twiki/templates` </a>
**_to follow_**
-- [[MikeMannix]] - 28 Aug 2001
|
