none
[openafs-wiki.git] / TWiki / TWikiSystemRequirements.mdwn
1 <div>
2   <ul>
3     <li><a href="#TWiki Operating Environment"> TWiki Operating Environment</a><ul>
4         <li><a href="#Overview"> Overview</a></li>
5         <li><a href="#Server-Side Requirements"> Server-Side Requirements</a></li>
6         <li><a href="#Client-Side Requirements"> Client-Side Requirements</a><ul>
7             <li><a href="#Known Issues"> Known Issues</a></li>
8           </ul>
9         </li>
10         <li><a href="#TWiki File System"> TWiki File System</a><ul>
11             <li><a href="#File Descriptions"> File Descriptions</a><ul>
12                 <li><a href="#Files in twiki"> Files in <code>twiki</code></a></li>
13                 <li><a href="#Files in twiki/bin"> Files in <code>twiki/bin</code></a></li>
14                 <li><a href="#Files under twiki/lib"> Files under <code>twiki/lib</code></a></li>
15                 <li><a href="#Files under twiki/pub"> Files under <code>twiki/pub</code></a></li>
16                 <li><a href="#Files under twiki/data"> Files under <code>twiki/data</code></a></li>
17                 <li><a href="#Files in twiki/templates"> Files in <code>twiki/templates</code></a></li>
18               </ul>
19             </li>
20           </ul>
21         </li>
22       </ul>
23     </li>
24   </ul>
25 </div>
26
27 # <a name="TWiki Operating Environment"></a> TWiki Operating Environment
28
29 _Server and client system requirements, file system structure_
30
31 ## <a name="Overview"></a> Overview
32
33 Maintaining minimum client and server requirements is necessary to keep TWiki deployment as broad as possible.
34
35 ## <a name="Server-Side Requirements"></a> Server-Side Requirements
36
37 TWiki is written in Perl 5 and uses a number of shell commands. It requires GNU RCS (Revision Control System) to be installed on the same system. TWiki is developed in a standard Linux/Apache environment. It can also work with Microsoft Windows and other platforms.
38
39 <table border="1" cellpadding="0" cellspacing="0">
40   <tr>
41     <th bgcolor="#99CCCC" colspan="3"><strong> Required Server Environment </strong></th>
42   </tr>
43   <tr>
44     <th bgcolor="#99CCCC"><strong> Resource </strong></th>
45     <th bgcolor="#99CCCC"><strong> Unix </strong></th>
46     <th bgcolor="#99CCCC"><strong> Windows </strong></th>
47   </tr>
48   <tr>
49     <td> Perl </td>
50     <td align="center" colspan="2"> 5.005_03 or higher </td>
51   </tr>
52   <tr>
53     <td> Non standard Perl modules </td>
54     <td align="center"><code>Net::SMTP</code> (or <code>sendmail</code>) </td>
55     <td align="right"><code>Net::SMTP</code>, <code>MIME::Base64</code>, <code>Digest::SHA1</code></td>
56   </tr>
57   <tr>
58     <td> RCS </td>
59     <td align="center" colspan="2"> 5.7 or higher </td>
60   </tr>
61   <tr>
62     <td> Other external programs </td>
63     <td align="center" colspan="2"><code>ls, fgrep, egrep</code></td>
64   </tr>
65   <tr>
66     <td> Web server </td>
67     <td align="center" colspan="2"> Apache; others (with support for CGI, authentication, extended path) <strong>*</strong></td>
68   </tr>
69 </table>
70
71 Current documentation covers Linux only. Compiling a basic [TWikiOnWindows](http://twiki.org/cgi-bin/view/Codev/TWikiOnWindows) installation guide is an ongoing effort.
72
73 ## <a name="Client-Side Requirements"></a> Client-Side Requirements
74
75 The TWiki standard installation has extremely low browser requirements:
76
77 - HTML 3.2 compliant
78 - minimal use of JavaScript in the user interface (degrades gracefully)
79 - no cookies
80 - no CSS
81
82 TWiki generates XHTML 1.0 code as long as it is compatible with HTML 3.2.
83
84 ### <a name="Known Issues"></a> Known Issues
85
86 - The new [[TWikiPlugins]] feature currently does not have any compatibility guidelines for developers. Plugins can require just about anything: browser-specific functions, stylesheets (CSS), Java, cookies, etc.
87
88 ## <a name="TWiki File System"></a> TWiki File System
89
90 You can rename the root TWiki directory - `twiki` - to whatever you like by changing it in the `twiki.cfg` configuration file. However, to keep the current installation and future upgrades simple, you should leave the subdirectory structure intact:
91
92 <table border="1" cellpadding="0" cellspacing="0">
93   <tr>
94     <th bgcolor="#99CCCC"><strong> Directory: </strong></th>
95     <th bgcolor="#99CCCC"><strong> Files: </strong></th>
96     <th bgcolor="#99CCCC"><strong> Used for: </strong></th>
97   </tr>
98   <tr>
99     <td><code>twiki</code></td>
100     <td align="center">[[Main/WebHome#TWikiFiles]]</td>
101     <td> Start-up info </td>
102   </tr>
103   <tr>
104     <td><code>twiki/bin</code></td>
105     <td align="center">[[Main/WebHome#BinFiles]]</td>
106     <td> Perl scripts </td>
107   </tr>
108   <tr>
109     <td><code>twiki/lib</code></td>
110     <td align="center">[[Main/WebHome#LibFiles]]</td>
111     <td> Configuration file, main library, Perl system modules, Plugins </td>
112   </tr>
113   <tr>
114     <td><code>twiki/pub</code></td>
115     <td align="center">[[Main/WebHome#PubFiles]]</td>
116     <td> Public support files (ex: [[Main/FileAttachments]], images) and RCS histories) </td>
117   </tr>
118   <tr>
119     <td><code>twiki/data</code></td>
120     <td align="center">[[Main/WebHome#DataFiles]]</td>
121     <td> Topic text (page content) and RCS histories; </td>
122   </tr>
123   <tr>
124     <td><code>twiki/templates</code></td>
125     <td align="center">[[Main/WebHome#TemplatesFiles]]</td>
126     <td> HTML templates, used by TWiki scripts </td>
127   </tr>
128 </table>
129
130 ### <a name="File Descriptions"></a> File Descriptions
131
132 A rundown of the individual files in the current %VERSION% distribution, organized by TWiki root directories. All listings are complete unless otherwise noted.
133
134 <a name="TWikiFiles"></a>
135
136 #### <a name="Files in twiki"></a> Files in `twiki`
137
138 Introductory and installation files.
139
140 <table border="1" cellpadding="0" cellspacing="0">
141   <tr>
142     <th bgcolor="#99CCCC"><strong> File: </strong></th>
143     <th bgcolor="#99CCCC"><strong> Used for: </strong></th>
144   </tr>
145   <tr>
146     <td><code>index.html</code></td>
147     <td> A page with a link to first launch TWiki after install </td>
148   </tr>
149   <tr>
150     <td><code>license.txt</code></td>
151     <td> GNU General Public License and TWiki-specific info </td>
152   </tr>
153   <tr>
154     <td><code>readme.txt</code></td>
155     <td> General TWiki start-up info with relevant URLs. </td>
156   </tr>
157   <tr>
158     <td><code>TWikiDocumentation.html</code></td>
159     <td> All documentation packaged as a single page </td>
160   </tr>
161   <tr>
162     <td><code>TWikiHistory.html</code></td>
163     <td> TWiki development timeline </td>
164   </tr>
165 </table>
166
167 <a name="BinFiles"></a>
168
169 #### <a name="Files in twiki/bin"></a> Files in `twiki/bin`
170
171 All Perl CGI scripts.
172
173 <table border="1" cellpadding="0" cellspacing="0">
174   <tr>
175     <th bgcolor="#99CCCC"><strong> File: </strong></th>
176     <th bgcolor="#99CCCC"><strong> Used for: </strong></th>
177   </tr>
178   <tr>
179     <td><code>.htaccess.txt</code></td>
180     <td> Authentication. Rename to .htaccess and customize if used </td>
181   </tr>
182   <tr>
183     <td><code>attach</code></td>
184     <td> Script that shows the attach file page ([[Main/FileAttachment]]) </td>
185   </tr>
186   <tr>
187     <td><code>delete</code></td>
188     <td> (not used yet) </td>
189   </tr>
190   <tr>
191     <td><code>edit</code></td>
192     <td> Script to edit a topic </td>
193   </tr>
194   <tr>
195     <td><code>geturl</code></td>
196     <td> Script to fetch URL data </td>
197   </tr>
198   <tr>
199     <td><code>mailnotify</code></td>
200     <td> Script called by cron job to notify users of changes </td>
201   </tr>
202   <tr>
203     <td><code>oops</code></td>
204     <td> Script that shows an OK or oops dialog </td>
205   </tr>
206   <tr>
207     <td><code>preview</code></td>
208     <td> Script to preview topic after edit </td>
209   </tr>
210   <tr>
211     <td><code>rdiff</code></td>
212     <td> Script to see differences of topics </td>
213   </tr>
214   <tr>
215     <td><code>rename</code></td>
216     <td> Script to rename/move topics and move attachments </td>
217   </tr>
218   <tr>
219     <td><code>register</code></td>
220     <td> Script to register new users </td>
221   </tr>
222   <tr>
223     <td><code>save</code></td>
224     <td> Script that saves a topic, called by preview </td>
225   </tr>
226   <tr>
227     <td><code>search</code></td>
228     <td> Script that displays search results </td>
229   </tr>
230   <tr>
231     <td><code>statistics</code></td>
232     <td> Script to create statistics topic </td>
233   </tr>
234   <tr>
235     <td><code>testenv</code></td>
236     <td> Script to test CGI environment variables </td>
237   </tr>
238   <tr>
239     <td><code>upload</code></td>
240     <td> Script that does file upload ([[Main/FileAttachment]]) </td>
241   </tr>
242   <tr>
243     <td><code>view</code></td>
244     <td> Script to view a topic ( <strong>the</strong> script ) </td>
245   </tr>
246   <tr>
247     <td><code>viewfile</code></td>
248     <td> Script to view an file attachment </td>
249   </tr>
250 </table>
251
252 <a name="LibFiles"></a>
253
254 #### <a name="Files under twiki/lib"></a> Files under `twiki/lib`
255
256 The new `lib/TWiki/Plugins` directories contain core configuration, libraries and function modules, and Plugins.
257
258 <table border="1" cellpadding="0" cellspacing="0">
259   <tr>
260     <th bgcolor="#99CCCC"><strong> File: </strong></th>
261     <th bgcolor="#99CCCC"><strong> Used for: </strong></th>
262   </tr>
263   <tr>
264     <td><code>TWiki.pm</code></td>
265     <td> Main TWiki library </td>
266   </tr>
267   <tr>
268     <td><code>TWiki.cfg</code></td>
269     <td> For configuration, used by <code>TWiki.pm</code></td>
270   </tr>
271   <tr>
272     <td><code>TWiki/Access.pm</code></td>
273     <td> Access control </td>
274   </tr>
275   <tr>
276     <td><code>TWiki/Attach.pm</code></td>
277     <td> Attachment handling </td>
278   </tr>
279   <tr>
280     <td><code>TWiki/Form.pm</code></td>
281     <td> Form handling </td>
282   </tr>
283   <tr>
284     <td><code>TWiki/Meta.pm</code></td>
285     <td> Meta data in topics </td>
286   </tr>
287   <tr>
288     <td><code>TWiki/Net.pm</code></td>
289     <td> SMTP mail handling </td>
290   </tr>
291   <tr>
292     <td><code>TWiki/Plugins.pm</code></td>
293     <td> Plugin handling </td>
294   </tr>
295   <tr>
296     <td><code>TWiki/Prefs.pm</code></td>
297     <td> Preferences handling </td>
298   </tr>
299   <tr>
300     <td><code>TWiki/Search.pm</code></td>
301     <td> Search engine, used by wiki.pm </td>
302   </tr>
303   <tr>
304     <td><code>TWiki/Store.pm</code></td>
305     <td> Back-end storage, <code>*.txt</code> text file and <code>*.txt,v</code> RCS repository file handling </td>
306   </tr>
307   <tr>
308     <td><code>TWiki/Plugins/DefaultPlugin.pm</code></td>
309     <td> Default plugin </td>
310   </tr>
311   <tr>
312     <td><code>TWiki/Plugins/EmptyPlugin.pm</code></td>
313     <td> Empty plugin, use to create your own </td>
314   </tr>
315   <tr>
316     <td><code>TWiki/Plugins/InterwikiPlugin.pm</code></td>
317     <td> Refer to external Wikis and other Web sites </td>
318   </tr>
319 </table>
320
321 <a name="PubFiles"></a>
322
323 #### <a name="Files under twiki/pub"></a> Files under `twiki/pub`
324
325 **_attachments like images..._**
326
327 <table border="1" cellpadding="0" cellspacing="0">
328   <tr>
329     <th bgcolor="#99CCCC"><strong> File: </strong></th>
330     <th bgcolor="#99CCCC"><strong> Used for: </strong></th>
331   </tr>
332   <tr>
333     <td><code>favicon.ico</code></td>
334     <td> xxxx </td>
335   </tr>
336   <tr>
337     <td><code>twikilogo.gif</code></td>
338     <td> xxxx </td>
339   </tr>
340   <tr>
341     <td><code>twikilogo1.gif</code></td>
342     <td> xxxx </td>
343   </tr>
344   <tr>
345     <td><code>twikilogo2.gif</code></td>
346     <td> xxxx </td>
347   </tr>
348   <tr>
349     <td><code>twikilogo3.gif</code></td>
350     <td> xxxx </td>
351   </tr>
352   <tr>
353     <td><code>twikilogo4.gif</code></td>
354     <td> xxxx </td>
355   </tr>
356   <tr>
357     <td><code>wikiHome.gif</code></td>
358     <td> xxxx </td>
359   </tr>
360   <tr>
361     <td><code>icn/_filetypes.txt</code></td>
362     <td> xxxx </td>
363   </tr>
364   <tr>
365     <td><code>icn/bat.gif</code></td>
366     <td> xxxx </td>
367   </tr>
368   <tr>
369     <td><code>icn/bmp.gif</code></td>
370     <td> xxxx </td>
371   </tr>
372   <tr>
373     <td><code>icn/c.gif</code></td>
374     <td> xxxx </td>
375   </tr>
376   <tr>
377     <td><code>icn/dll.gif</code></td>
378     <td> xxxx </td>
379   </tr>
380   <tr>
381     <td><code>icn/doc.gif</code></td>
382     <td> xxxx </td>
383   </tr>
384   <tr>
385     <td><code>icn/else.gif</code></td>
386     <td> xxxx </td>
387   </tr>
388   <tr>
389     <td><code>icn/exe.gif</code></td>
390     <td> xxxx </td>
391   </tr>
392   <tr>
393     <td><code>icn/fon.gif</code></td>
394     <td> xxxx </td>
395   </tr>
396   <tr>
397     <td><code>icn/h.gif</code></td>
398     <td> xxxx </td>
399   </tr>
400   <tr>
401     <td><code>icn/hlp.gif</code></td>
402     <td> xxxx </td>
403   </tr>
404   <tr>
405     <td><code>icn/html.gif</code></td>
406     <td> xxxx </td>
407   </tr>
408   <tr>
409     <td><code>icn/java.gif</code></td>
410     <td> xxxx </td>
411   </tr>
412   <tr>
413     <td><code>icn/mov.gif</code></td>
414     <td> xxxx </td>
415   </tr>
416   <tr>
417     <td><code>icn/pdf.gif</code></td>
418     <td> xxxx </td>
419   </tr>
420   <tr>
421     <td><code>icn/pl.gif</code></td>
422     <td> xxxx </td>
423   </tr>
424   <tr>
425     <td><code>icn/ppt.gif</code></td>
426     <td> xxxx </td>
427   </tr>
428   <tr>
429     <td><code>icn/ps.gif</code></td>
430     <td> xxxx </td>
431   </tr>
432   <tr>
433     <td><code>icn/py.gif</code></td>
434     <td> xxxx </td>
435   </tr>
436   <tr>
437     <td><code>icn/ram.gif</code></td>
438     <td> xxxx </td>
439   </tr>
440   <tr>
441     <td><code>icn/reg.gif</code></td>
442     <td> xxxx </td>
443   </tr>
444   <tr>
445     <td><code>icn/sh.gif</code></td>
446     <td> xxxx </td>
447   </tr>
448   <tr>
449     <td><code>icn/sniff.gif</code></td>
450     <td> xxxx </td>
451   </tr>
452   <tr>
453     <td><code>icn/ttf.gif</code></td>
454     <td> xxxx </td>
455   </tr>
456   <tr>
457     <td><code>icn/txt.gif</code></td>
458     <td> xxxx </td>
459   </tr>
460   <tr>
461     <td><code>icn/wav.gif</code></td>
462     <td> xxxx </td>
463   </tr>
464   <tr>
465     <td><code>icn/wri.gif</code></td>
466     <td> xxxx </td>
467   </tr>
468   <tr>
469     <td><code>icn/xls.gif</code></td>
470     <td> xxxx </td>
471   </tr>
472   <tr>
473     <td><code>icn/zip.gif</code></td>
474     <td> xxxx </td>
475   </tr>
476   <tr>
477     <td><code>Know/IncorrectDllVersionW32PTH10DLL/W32PTH10.DLL</code></td>
478     <td> xxxx </td>
479   </tr>
480   <tr>
481     <td><code>TWiki/FileAttachment/Sample.txt</code></td>
482     <td> xxxx </td>
483   </tr>
484   <tr>
485     <td><code>TWiki/FileAttachment/Smile.gif</code></td>
486     <td> xxxx </td>
487   </tr>
488   <tr>
489     <td><code>TWiki/PreviewBackground/blankltgraybg.gif</code></td>
490     <td> xxxx </td>
491   </tr>
492   <tr>
493     <td><code>TWiki/PreviewBackground/blankwhitebg.gif</code></td>
494     <td> xxxx </td>
495   </tr>
496   <tr>
497     <td><code>TWiki/PreviewBackground/previewbg.gif</code></td>
498     <td> xxxx </td>
499   </tr>
500   <tr>
501     <td><code>TWiki/WabiSabi/wabisabi.gif</code></td>
502     <td> xxxx </td>
503   </tr>
504 </table>
505
506 <a name="DataFiles"></a>
507
508 #### <a name="Files under twiki/data"></a> Files under `twiki/data`
509
510 The `data` directory stores TWiki page data as individual text files. Each active web has its own subdirectory. The TWiki distribution package includes four start-up webs, with a number of pages of documentation and demo content. _This is a representative partial file listing..._
511
512 <table border="1" cellpadding="0" cellspacing="0">
513   <tr>
514     <th bgcolor="#99CCCC"><strong> File: </strong></th>
515     <th bgcolor="#99CCCC"><strong> Used for: </strong></th>
516   </tr>
517   <tr>
518     <td><code>.htpasswd</code></td>
519     <td> xxxx </td>
520   </tr>
521   <tr>
522     <td><code>debug.txt</code></td>
523     <td> xxxx </td>
524   </tr>
525   <tr>
526     <td><code>mime.types</code></td>
527     <td> xxxx </td>
528   </tr>
529   <tr>
530     <td><code>warning.txt</code></td>
531     <td> xxxx </td>
532   </tr>
533   <tr>
534     <td colspan="2"> _default directory can be copied to empty directory when creating new Webs </td>
535   </tr>
536   <tr>
537     <td><code>_default/.changes</code></td>
538     <td> Record of topic changes recorded here </td>
539   </tr>
540   <tr>
541     <td><code>_default/WebChanges.txt</code></td>
542     <td> Display most recent changes </td>
543   </tr>
544   <tr>
545     <td><code>_default/WebChanges.txt,v</code></td>
546     <td> History </td>
547   </tr>
548   <tr>
549     <td><code>_default/WebHome.txt</code></td>
550     <td> xxxx </td>
551   </tr>
552   <tr>
553     <td><code>_default/WebHome.txt,v</code></td>
554     <td> xxxx </td>
555   </tr>
556   <tr>
557     <td><code>_default/WebIndex.txt</code></td>
558     <td> xxxx </td>
559   </tr>
560   <tr>
561     <td><code>_default/WebIndex.txt,v</code></td>
562     <td> xxxx </td>
563   </tr>
564   <tr>
565     <td><code>_default/WebNotify.txt</code></td>
566     <td> xxxx </td>
567   </tr>
568   <tr>
569     <td><code>_default/WebNotify.txt,v</code></td>
570     <td> xxxx </td>
571   </tr>
572   <tr>
573     <td><code>_default/WebPreferences.txt</code></td>
574     <td> xxxx </td>
575   </tr>
576   <tr>
577     <td><code>_default/WebPreferences.txt,v</code></td>
578     <td> xxxx </td>
579   </tr>
580   <tr>
581     <td><code>_default/WebSearch.txt</code></td>
582     <td> xxxx </td>
583   </tr>
584   <tr>
585     <td><code>_default/WebSearch.txt,v</code></td>
586     <td> xxxx </td>
587   </tr>
588   <tr>
589     <td><code>_default/WebStatistics.txt</code></td>
590     <td> xxxx </td>
591   </tr>
592   <tr>
593     <td><code>_default/WebStatistics.txt,v</code></td>
594     <td> xxxx </td>
595   </tr>
596   <tr>
597     <th align="center" bgcolor="#99CCCC"><strong> ... </strong></th>
598     <th align="center" bgcolor="#99CCCC"><strong> ... </strong></th>
599   </tr>
600   <tr>
601     <td><code>Know/TopicClassification.txt</code></td>
602     <td> xxxx </td>
603   </tr>
604   <tr>
605     <td><code>Know/TopicClassification.txt,v</code></td>
606     <td> xxxx </td>
607   </tr>
608   <tr>
609     <td><code>Know/TWikiCategory.txt</code></td>
610     <td> xxxx </td>
611   </tr>
612   <tr>
613     <td><code>Know/TWikiCategory.txt,v</code></td>
614     <td> xxxx </td>
615   </tr>
616   <tr>
617     <td><code>Know/UseCategory.txt</code></td>
618     <td> xxxx </td>
619   </tr>
620   <tr>
621     <td><code>Know/UseCategory.txt,v</code></td>
622     <td> xxxx </td>
623   </tr>
624   <tr>
625     <td><code>Know/WebChanges.txt</code></td>
626     <td> xxxx </td>
627   </tr>
628   <tr>
629     <td><code>Know/WebChanges.txt,v</code></td>
630     <td> xxxx </td>
631   </tr>
632   <tr>
633     <td><code>Know/WebForm.txt</code></td>
634     <td> xxxx </td>
635   </tr>
636   <tr>
637     <td><code>Know/WebForm.txt,v</code></td>
638     <td> xxxx </td>
639   </tr>
640   <tr>
641     <th align="center" bgcolor="#99CCCC"><strong> ... </strong></th>
642     <th align="center" bgcolor="#99CCCC"><strong> ... </strong></th>
643   </tr>
644   <tr>
645     <td><code>Main/OfficeLocations.txt</code></td>
646     <td> xxxx </td>
647   </tr>
648   <tr>
649     <td><code>Main/OfficeLocations.txt,v</code></td>
650     <td> xxxx </td>
651   </tr>
652   <tr>
653     <td><code>Main/PeterThoeny.txt</code></td>
654     <td> xxxx </td>
655   </tr>
656   <tr>
657     <td><code>Main/PeterThoeny.txt,v</code></td>
658     <td> xxxx </td>
659   </tr>
660   <tr>
661     <td><code>Main/SanJoseOffice.txt</code></td>
662     <td> xxxx </td>
663   </tr>
664   <tr>
665     <td><code>Main/SanJoseOffice.txt,v</code></td>
666     <td> xxxx </td>
667   </tr>
668   <tr>
669     <th align="center" bgcolor="#99CCCC"><strong> ... </strong></th>
670     <th align="center" bgcolor="#99CCCC"><strong> ... </strong></th>
671   </tr>
672   <tr>
673     <td><code>Main/TWikiGuest.txt</code></td>
674     <td> xxxx </td>
675   </tr>
676   <tr>
677     <td><code>Main/TWikiGuest.txt,v</code></td>
678     <td> xxxx </td>
679   </tr>
680   <tr>
681     <td><code>Main/TWikiUsers.txt</code></td>
682     <td> xxxx </td>
683   </tr>
684   <tr>
685     <td><code>Main/TWikiUsers.txt,v</code></td>
686     <td> xxxx </td>
687   </tr>
688   <tr>
689     <th align="center" bgcolor="#99CCCC"><strong> ... </strong></th>
690     <th align="center" bgcolor="#99CCCC"><strong> ... </strong></th>
691   </tr>
692   <tr>
693     <td><code>Test/TestTopic1.txt</code></td>
694     <td> xxxx </td>
695   </tr>
696   <tr>
697     <td><code>Test/TestTopic1.txt,v</code></td>
698     <td> xxxx </td>
699   </tr>
700   <tr>
701     <td><code>Test/WebHome.txt</code></td>
702     <td> xxxx </td>
703   </tr>
704   <tr>
705     <td><code>Test/WebHome.txt,v</code></td>
706     <td> xxxx </td>
707   </tr>
708   <tr>
709     <th align="center" bgcolor="#99CCCC"><strong> ... </strong></th>
710     <th align="center" bgcolor="#99CCCC"><strong> ... </strong></th>
711   </tr>
712   <tr>
713     <td><code>Trash/WebHome.txt</code></td>
714     <td> xxxx </td>
715   </tr>
716   <tr>
717     <td><code>Trash/WebHome.txt,v</code></td>
718     <td> xxxx </td>
719   </tr>
720   <tr>
721     <th align="center" bgcolor="#99CCCC"><strong> ... </strong></th>
722     <th align="center" bgcolor="#99CCCC"><strong> ... </strong></th>
723   </tr>
724   <tr>
725     <td><code>TWiki/DeleteTopic.txt</code></td>
726     <td> xxxx </td>
727   </tr>
728   <tr>
729     <td><code>TWiki/DeleteTopic.txt,v</code></td>
730     <td> xxxx </td>
731   </tr>
732   <tr>
733     <td><code>TWiki/DontNotify.txt</code></td>
734     <td> xxxx </td>
735   </tr>
736   <tr>
737     <td><code>TWiki/DontNotify.txt,v</code></td>
738     <td> xxxx </td>
739   </tr>
740   <tr>
741     <th align="center" bgcolor="#99CCCC"><strong> ... </strong></th>
742     <th align="center" bgcolor="#99CCCC"><strong> ... </strong></th>
743   </tr>
744 </table>
745
746 <a name="TemplatesFiles"></a>
747
748 #### <a name="Files in twiki/templates"></a> Files in `twiki/templates`
749
750 _Used to flexibly control appearance of rendered pages..._
751
752 <table border="1" cellpadding="0" cellspacing="0">
753   <tr>
754     <th bgcolor="#99CCCC"><strong> File: </strong></th>
755     <th bgcolor="#99CCCC"><strong> Used for: </strong></th>
756   </tr>
757   <tr>
758     <td><code>oopsbadpwformat.tmpl</code></td>
759     <td> xxxx </td>
760   </tr>
761   <tr>
762     <td><code>attachagain.tmpl</code></td>
763     <td> xxxx </td>
764   </tr>
765   <tr>
766     <td><code>attachnew.tmpl</code></td>
767     <td> xxxx </td>
768   </tr>
769   <tr>
770     <td><code>changeform.tmpl</code></td>
771     <td> xxxx </td>
772   </tr>
773   <tr>
774     <td><code>changes.tmpl</code></td>
775     <td> xxxx </td>
776   </tr>
777   <tr>
778     <td><code>edit.iejs.tmpl</code></td>
779     <td> xxxx </td>
780   </tr>
781   <tr>
782     <td><code>edit.tmpl</code></td>
783     <td> xxxx </td>
784   </tr>
785   <tr>
786     <td><code>mailnotify.tmpl</code></td>
787     <td> xxxx </td>
788   </tr>
789   <tr>
790     <td><code>moveattachment.tmpl</code></td>
791     <td> xxxx </td>
792   </tr>
793   <tr>
794     <td><code>oopsaccesschange.tmpl</code></td>
795     <td> xxxx </td>
796   </tr>
797   <tr>
798     <td><code>oopsaccessgroup.tmpl</code></td>
799     <td> xxxx </td>
800   </tr>
801   <tr>
802     <td><code>oopsaccessrename.tmpl</code></td>
803     <td> xxxx </td>
804   </tr>
805   <tr>
806     <td><code>oopsaccessview.tmpl</code></td>
807     <td> xxxx </td>
808   </tr>
809   <tr>
810     <td><code>oopsauth.tmpl</code></td>
811     <td> xxxx </td>
812   </tr>
813   <tr>
814     <td><code>attach.tmpl</code></td>
815     <td> xxxx </td>
816   </tr>
817   <tr>
818     <td><code>oopschangepasswd.tmpl</code></td>
819     <td> xxxx </td>
820   </tr>
821   <tr>
822     <td><code>oopsempty.tmpl</code></td>
823     <td> xxxx </td>
824   </tr>
825   <tr>
826     <td><code>oopslocked.tmpl</code></td>
827     <td> xxxx </td>
828   </tr>
829   <tr>
830     <td><code>oopslockedrename.tmpl</code></td>
831     <td> xxxx </td>
832   </tr>
833   <tr>
834     <td><code>oopsmissing.tmpl</code></td>
835     <td> xxxx </td>
836   </tr>
837   <tr>
838     <td><code>oopsmoveerr.tmpl</code></td>
839     <td> xxxx </td>
840   </tr>
841   <tr>
842     <td><code>oopsnoformdef.tmpl</code></td>
843     <td> xxxx </td>
844   </tr>
845   <tr>
846     <td><code>oopsnotwikiuser.tmpl</code></td>
847     <td> xxxx </td>
848   </tr>
849   <tr>
850     <td><code>oopsnoweb.tmpl</code></td>
851     <td> xxxx </td>
852   </tr>
853   <tr>
854     <td><code>oopspreview.tmpl</code></td>
855     <td> xxxx </td>
856   </tr>
857   <tr>
858     <td><code>oopsregexist.tmpl</code></td>
859     <td> xxxx </td>
860   </tr>
861   <tr>
862     <td><code>oopsregpasswd.tmpl</code></td>
863     <td> xxxx </td>
864   </tr>
865   <tr>
866     <td><code>oopsregrequ.tmpl</code></td>
867     <td> xxxx </td>
868   </tr>
869   <tr>
870     <td><code>oopsregthanks.tmpl</code></td>
871     <td> xxxx </td>
872   </tr>
873   <tr>
874     <td><code>oopsregwiki.tmpl</code></td>
875     <td> xxxx </td>
876   </tr>
877   <tr>
878     <td><code>oopsrenameerr.tmpl</code></td>
879     <td> xxxx </td>
880   </tr>
881   <tr>
882     <td><code>oopsresetpasswd.tmpl</code></td>
883     <td> xxxx </td>
884   </tr>
885   <tr>
886     <td><code>oopsrev.tmpl</code></td>
887     <td> xxxx </td>
888   </tr>
889   <tr>
890     <td><code>oopssave.tmpl</code></td>
891     <td> xxxx </td>
892   </tr>
893   <tr>
894     <td><code>oopssaveerr.tmpl</code></td>
895     <td> xxxx </td>
896   </tr>
897   <tr>
898     <td><code>oopssendmailerr.tmpl</code></td>
899     <td> xxxx </td>
900   </tr>
901   <tr>
902     <td><code>oopstopicexists.tmpl</code></td>
903     <td> xxxx </td>
904   </tr>
905   <tr>
906     <td><code>oopsupload.tmpl</code></td>
907     <td> xxxx </td>
908   </tr>
909   <tr>
910     <td><code>oopswrongpassword.tmpl</code></td>
911     <td> xxxx </td>
912   </tr>
913   <tr>
914     <td><code>preview.tmpl</code></td>
915     <td> xxxx </td>
916   </tr>
917   <tr>
918     <td><code>rdiff.tmpl</code></td>
919     <td> xxxx </td>
920   </tr>
921   <tr>
922     <td><code>register.tmpl</code></td>
923     <td> xxxx </td>
924   </tr>
925   <tr>
926     <td><code>registernotify.tmpl</code></td>
927     <td> xxxx </td>
928   </tr>
929   <tr>
930     <td><code>rename.tmpl</code></td>
931     <td> Doing a new topic rename, user chooses web &amp; topic </td>
932   </tr>
933   <tr>
934     <td><code>renamebase.tmpl</code></td>
935     <td> Used by other rename templates </td>
936   </tr>
937   <tr>
938     <td><code>renameconfirm.tmpl</code></td>
939     <td> Confirming a pre-specified rename e.g. when undoing a rename </td>
940   </tr>
941   <tr>
942     <td><code>renamerefs.tmpl</code></td>
943     <td> Rename done, still some references to change (topcis were previously locked) </td>
944   </tr>
945   <tr>
946     <td><code>search.tmpl</code></td>
947     <td> xxxx </td>
948   </tr>
949   <tr>
950     <td><code>searchbookview.tmpl</code></td>
951     <td> xxxx </td>
952   </tr>
953   <tr>
954     <td><code>searchmeta.tmpl</code></td>
955     <td> xxxx </td>
956   </tr>
957   <tr>
958     <td><code>searchrenameview.tmpl</code></td>
959     <td> Used by <code>rename</code> to list references to topic being renamed </td>
960   </tr>
961   <tr>
962     <td><code>twiki.tmpl</code></td>
963     <td> xxxx </td>
964   </tr>
965   <tr>
966     <td><code>view.plain.tmpl</code></td>
967     <td> xxxx </td>
968   </tr>
969   <tr>
970     <td><code>view.print.tmpl</code></td>
971     <td> xxxx </td>
972   </tr>
973   <tr>
974     <td><code>view.tmpl</code></td>
975     <td> xxxx </td>
976   </tr>
977 </table>
978
979 -- [[MikeMannix]] - 29 Aug 2001