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>
8 <li><a href="#Client-Side Requirements"> Client-Side Requirements</a><ul>
9 <li><a href="#Known Issues"> Known Issues</a></li>
10 <li><a href="#TWiki File System"> TWiki File System</a></li>
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>
25 ## <a name="TWiki Operating Environment"></a> TWiki Operating Environment
27 Server and client system requirements, file system structure
29 ### <a name="Overview"></a> Overview
31 Low requirements on client-side and server-side environment, to keep TWiki deployment as broad as possible is a key element of the **_TWikiMission_**. Strict [[W3C]] and ECMA standards compliance is also a mandate. These requirements are amended from time to time as technology progresses.
33 ### <a name="Server-Side Requirements"></a> Server-Side Requirements
35 TWiki is written in **Perl 5** and uses a number of **shell commands**. It requires that **GNU RCS** (Revision Control System) be installed on the same system. Current development is on Linux. the recommended platform, but it can also work with Microsoft Windows and other OS.
37 <table border="1" cellpadding="0" cellspacing="0">
39 <th bgcolor="#99CCCC" colspan="3"><strong> Required Server Environment by Platform </strong></th>
42 <th bgcolor="#99CCCC"><strong> Resource </strong></th>
43 <th bgcolor="#99CCCC"><strong> Unix </strong></th>
44 <th bgcolor="#99CCCC"><strong> Windows </strong></th>
48 <td align="center" colspan="2"> 5.005_03 or higher </td>
51 <td> Non standard Perl modules </td>
52 <td align="center"><code>Net::SMTP</code> (or <code>sendmail</code>) </td>
53 <td align="center"><code>Net::SMTP</code></td>
57 <td align="center" colspan="2"> 5.7 or higher </td>
60 <td> Other external programs </td>
61 <td align="center" colspan="2"><code>ls, fgrep, egrep</code></td>
65 <td align="center" colspan="2"> Apache and others (support for cgi, authentication, extended path) <strong>*</strong></td>
68 <td><em>OS versions</em></td>
69 <td align="center"><strong><em>Linux, Unix...</em></strong></td>
70 <td align="center"><strong><em>every last Win?!</em></strong></td>
73 <td> Required disk space </td>
79 **_ISP INSTALLATION REQUIREMENTS: SSI, RCS local or sysadmin, same for perl modules for plugins, cron, basic authentication,..._**
81 ## <a name="Client-Side Requirements"></a> Client-Side Requirements
83 The basic TWiki engine and templates have a low requirement on the browser:
85 <table border="1" cellpadding="0" cellspacing="0">
87 <th align="center" bgcolor="#99CCCC" colspan="3"><strong> Recommend PC Requirement </strong></th>
90 <th bgcolor="#99CCCC"><strong> Component </strong></th>
91 <th bgcolor="#99CCCC"><strong> Min/Rec </strong></th>
95 <table border="1" cellpadding="0" cellspacing="0">
97 <th align="center" bgcolor="#99CCCC" colspan="2"><strong> Browser Requirements </strong></th>
100 <th bgcolor="#99CCCC"><strong> Resource </strong></th>
101 <th bgcolor="#99CCCC"><strong> Details </strong></th>
104 <td> HTML 3.2 browser </td>
108 <td> JavaScript 1.? </td>
109 <td> Optional: JS degrades gracefully </td>
121 - TWiki generates XHTML 1.0 code as long as it is compatible with HTML 3.2.
123 **_WHAT ABOUT WEB STANDARDS BROWSER COMPATIBILITY MOVEMENT & CSS CONTROL_**
125 ### <a name="Known Issues"></a> Known Issues
127 - Some TWikiSkins may require more, like cookies and JavaScript
128 - At present, contributed Plugins are not checked against compatibility standards, and may require anything imaginable: browser-specific functions, Java, cookies, CSS, etc.
130 ### <a name="TWiki File System"></a> TWiki File System
132 You can rename the root TWiki directory - <code>**twiki**</code> - to whatever you like by changing it in the <code>**twiki.cfg**</code> configuration file. However, to keep the current installation and future upgrades simple, you should leave the subdirectory structure intact:
134 <table border="1" cellpadding="0" cellspacing="0">
136 <th bgcolor="#99CCCC"><strong> Directory: </strong></th>
137 <th bgcolor="#99CCCC"><strong> Files: </strong></th>
138 <th bgcolor="#99CCCC"><strong> Used for: </strong></th>
141 <td><code><b>twiki</b></code></td>
142 <td align="center">[[Main/WebHome#TWikiFiles]]</td>
143 <td> Start-up info </td>
146 <td><code><b>twiki/bin</b></code></td>
147 <td align="center">[[Main/WebHome#BinFiles]]</td>
148 <td> Perl scripts </td>
151 <td><code><b>twiki/lib</b></code></td>
152 <td align="center">[[Main/WebHome#LibFiles]]</td>
153 <td> Configuration file, main library, Perl system modules, Plugins </td>
156 <td><code><b>twiki/pub</b></code></td>
157 <td align="center">[[Main/WebHome#PubFiles]]</td>
158 <td> Public support files (ex: [[Main/FileAttachments]], images) and RCS histories) </td>
161 <td><code><b>twiki/data</b></code></td>
162 <td align="center">[[Main/WebHome#DataFiles]]</td>
163 <td> Topic text (page content) and RCS histories; </td>
166 <td><code><b>twiki/templates</b></code></td>
167 <td align="center">[[Main/WebHome#TemplatesFiles]]</td>
168 <td> HTML templates, used by TWiki scripts </td>
172 ### <a name="File Descriptions"></a> File Descriptions
174 A rundown of the individual files in the current %VERSION% distribution, organized by TWiki root directories. Note that there may be minor differences in the start-up <code>**data**</code> files. All listings are complete unless otherwise noted.
176 <a name="TWikiFiles"></a>
178 #### <a name="Files in twiki"></a> Files in `twiki`
180 Introductory and installation files.
182 <table border="1" cellpadding="0" cellspacing="0">
184 <th bgcolor="#99CCCC"><strong> File: </strong></th>
185 <th bgcolor="#99CCCC"><strong> Used for: </strong></th>
188 <td><code><b>index.html</b></code></td>
189 <td> A page with a link to first launch TWiki after install </td>
192 <td><code><b>license.txt</b></code></td>
193 <td> GNU General Public License and TWiki-specific info </td>
196 <td><code><b>readme.txt</b></code></td>
197 <td> General TWiki start-up info with relevant URLs. </td>
200 <td><code><b>TWikiDocumentation.html</b></code></td>
201 <td> All documentation packaged as a single page </td>
204 <td><code><b>TWikiHistory.html</b></code></td>
205 <td> TWiki development timeline </td>
209 <a name="BinFiles"></a>
211 #### <a name="Files in twiki/bin"></a> Files in `twiki/bin`
213 All Perl CGI scripts.
215 <table border="1" cellpadding="0" cellspacing="0">
217 <th bgcolor="#99CCCC"><strong> File: </strong></th>
218 <th bgcolor="#99CCCC"><strong> Used for: </strong></th>
221 <td><code><b>.htaccess.txt</b></code></td>
222 <td> Authentication. Rename to .htaccess and customize if used </td>
225 <td><code><b>attach</b></code></td>
226 <td> Script that shows the attach file page ([[Main/FileAttachment]]) </td>
229 <td><code><b>delete</b></code></td>
230 <td> (not used yet) </td>
233 <td><code><b>edit</b></code></td>
234 <td> Script to edit a topic </td>
237 <td><code><b>geturl</b></code></td>
238 <td> Script to fetch URL data </td>
241 <td><code><b>mailnotify</b></code></td>
242 <td> Script called by cron job to notify users of changes </td>
245 <td><code><b>oops</b></code></td>
246 <td> Script that shows an OK or oops dialog </td>
249 <td><code><b>preview</b></code></td>
250 <td> Script to preview topic after edit </td>
253 <td><code><b>rdiff</b></code></td>
254 <td> Script to see differences of topics </td>
257 <td><code><b>rename</b></code></td>
258 <td> Script to rename/move topics and move attachments </td>
261 <td><code><b>register</b></code></td>
262 <td> Script to register new users </td>
265 <td><code><b>save</b></code></td>
266 <td> Script that saves a topic, called by preview </td>
269 <td><code><b>search</b></code></td>
270 <td> Script that displays search results </td>
273 <td><code><b>statistics</b></code></td>
274 <td> Script to create statistics topic </td>
277 <td><code><b>testenv</b></code></td>
278 <td> Script to test CGI environment variables </td>
281 <td><code><b>upload</b></code></td>
282 <td> Script that does file upload ([[Main/FileAttachment]]) </td>
285 <td><code><b>view</b></code></td>
286 <td> Script to view a topic ( <strong>the</strong> script ) </td>
289 <td><code><b>viewfile</b></code></td>
290 <td> Script to view an file attachment </td>
294 <a name="LibFiles"></a>
296 #### <a name="Files under twiki/lib"></a> Files under `twiki/lib`
298 The new <code>**lib/TWiki/Plugins**</code> directories contain core configuration, libraries and function modules, and Plugins.
300 <table border="1" cellpadding="0" cellspacing="0">
302 <th bgcolor="#99CCCC"><strong> File: </strong></th>
303 <th bgcolor="#99CCCC"><strong> Used for: </strong></th>
306 <td><code><b>TWiki.pm</b></code></td>
307 <td> Main TWiki library </td>
310 <td><code><b>TWiki.cfg</b></code></td>
311 <td> For configuration, used by <code><b>TWiki.pm</b></code></td>
314 <td><code><b>TWiki/Access.pm</b></code></td>
315 <td> Access control </td>
318 <td><code><b>TWiki/Attach.pm</b></code></td>
319 <td> Attachment handling </td>
322 <td><code><b>TWiki/Meta.pm</b></code></td>
323 <td> Meta data in topics </td>
326 <td><code><b>TWiki/Net.pm</b></code></td>
327 <td> SMTP mail handling </td>
330 <td><code><b>TWiki/Plugins.pm</b></code></td>
331 <td> Plugin handling </td>
334 <td><code><b>TWiki/Prefs.pm</b></code></td>
335 <td> Preferences handling </td>
338 <td><code><b>TWiki/Search.pm</b></code></td>
339 <td> Search engine, used by wiki.pm </td>
342 <td><code><b>TWiki/Store.pm</b></code></td>
343 <td> Back-end storage, <code>*.txt</code> text file and <code>*.txt,v</code> RCS repository file handling </td>
346 <td><code><b>TWiki/Plugins/DefaultPlugin.pm</b></code></td>
347 <td> Default plugin </td>
350 <td><code><b>TWiki/Plugins/EmptyPlugin.pm</b></code></td>
351 <td> Empty plugin, use to create your own </td>
354 <td><code><b>TWiki/Plugins/InterwikiPlugin.pm</b></code></td>
355 <td> Refer to external Wikis and other Web sites </td>
359 <a name="PubFiles"></a>
361 #### <a name="Files under twiki/pub"></a> Files under `twiki/pub`
363 **_attachments like images..._**
365 <table border="1" cellpadding="0" cellspacing="0">
367 <th bgcolor="#99CCCC"><strong> File: </strong></th>
368 <th bgcolor="#99CCCC"><strong> Used for: </strong></th>
371 <td><code><b>favicon.ico</b></code></td>
375 <td><code><b>twikilogo.gif</b></code></td>
379 <td><code><b>twikilogo1.gif</b></code></td>
383 <td><code><b>twikilogo2.gif</b></code></td>
387 <td><code><b>twikilogo3.gif</b></code></td>
391 <td><code><b>twikilogo4.gif</b></code></td>
395 <td><code><b>wikiHome.gif</b></code></td>
399 <td><code><b>icn/_filetypes.txt</b></code></td>
403 <td><code><b>icn/bat.gif</b></code></td>
407 <td><code><b>icn/bmp.gif</b></code></td>
411 <td><code><b>icn/c.gif</b></code></td>
415 <td><code><b>icn/dll.gif</b></code></td>
419 <td><code><b>icn/doc.gif</b></code></td>
423 <td><code><b>icn/else.gif</b></code></td>
427 <td><code><b>icn/exe.gif</b></code></td>
431 <td><code><b>icn/fon.gif</b></code></td>
435 <td><code><b>icn/h.gif</b></code></td>
439 <td><code><b>icn/hlp.gif</b></code></td>
443 <td><code><b>icn/html.gif</b></code></td>
447 <td><code><b>icn/java.gif</b></code></td>
451 <td><code><b>icn/mov.gif</b></code></td>
455 <td><code><b>icn/pdf.gif</b></code></td>
459 <td><code><b>icn/pl.gif</b></code></td>
463 <td><code><b>icn/ppt.gif</b></code></td>
467 <td><code><b>icn/ps.gif</b></code></td>
471 <td><code><b>icn/py.gif</b></code></td>
475 <td><code><b>icn/ram.gif</b></code></td>
479 <td><code><b>icn/reg.gif</b></code></td>
483 <td><code><b>icn/sh.gif</b></code></td>
487 <td><code><b>icn/sniff.gif</b></code></td>
491 <td><code><b>icn/ttf.gif</b></code></td>
495 <td><code><b>icn/txt.gif</b></code></td>
499 <td><code><b>icn/wav.gif</b></code></td>
503 <td><code><b>icn/wri.gif</b></code></td>
507 <td><code><b>icn/xls.gif</b></code></td>
511 <td><code><b>icn/zip.gif</b></code></td>
515 <td><code><b>Know/IncorrectDllVersionW32PTH10DLL/W32PTH10.DLL</b></code></td>
519 <td><code><b>TWiki/FileAttachment/Sample.txt</b></code></td>
523 <td><code><b>TWiki/FileAttachment/Smile.gif</b></code></td>
527 <td><code><b>TWiki/PreviewBackground/blankltgraybg.gif</b></code></td>
531 <td><code><b>TWiki/PreviewBackground/blankwhitebg.gif</b></code></td>
535 <td><code><b>TWiki/PreviewBackground/previewbg.gif</b></code></td>
539 <td><code><b>TWiki/WabiSabi/wabisabi.gif</b></code></td>
544 <a name="DataFiles"></a>
546 #### <a name="Files under twiki/data"></a> Files under `twiki/data`
548 The <code>**data**</code> directory stores the content of TWiki pages as individual text files. Each active web has its own subdirectory. The TWiki distribution package includes four start-up webs, and quite a number of pages with documentation and demo content. _This is a representative partial file listing..._
550 <table border="1" cellpadding="0" cellspacing="0">
552 <th bgcolor="#99CCCC"><strong> File: </strong></th>
553 <th bgcolor="#99CCCC"><strong> Used for: </strong></th>
556 <td><code><b>.htpasswd</b></code></td>
560 <td><code><b>debug.txt</b></code></td>
564 <td><code><b>mime.types</b></code></td>
568 <td><code><b>warning.txt</b></code></td>
572 <td><code><b>_default/.changes</b></code></td>
576 <td><code><b>_default/WebChanges.txt</b></code></td>
580 <td><code><b>_default/WebChanges.txt,v</b></code></td>
584 <td><code><b>_default/WebHome.txt</b></code></td>
588 <td><code><b>_default/WebHome.txt,v</b></code></td>
592 <td><code><b>_default/WebIndex.txt</b></code></td>
596 <td><code><b>_default/WebIndex.txt,v</b></code></td>
600 <td><code><b>_default/WebNotify.txt</b></code></td>
604 <td><code><b>_default/WebNotify.txt,v</b></code></td>
608 <td><code><b>_default/WebPreferences.txt</b></code></td>
612 <td><code><b>_default/WebPreferences.txt,v</b></code></td>
616 <td><code><b>_default/WebSearch.txt</b></code></td>
620 <td><code><b>_default/WebSearch.txt,v</b></code></td>
624 <td><code><b>_default/WebStatistics.txt</b></code></td>
628 <td><code><b>_default/WebStatistics.txt,v</b></code></td>
632 <td align="center"> ... </td>
633 <td align="center"> ... </td>
636 <td><code><b>Know/TopicClassification.txt</b></code></td>
640 <td><code><b>Know/TopicClassification.txt,v</b></code></td>
644 <td><code><b>Know/TWikiCategory.txt</b></code></td>
648 <td><code><b>Know/TWikiCategory.txt,v</b></code></td>
652 <td><code><b>Know/UseCategory.txt</b></code></td>
656 <td><code><b>Know/UseCategory.txt,v</b></code></td>
660 <td><code><b>Know/WebChanges.txt</b></code></td>
664 <td><code><b>Know/WebChanges.txt,v</b></code></td>
668 <td><code><b>Know/WebForm.txt</b></code></td>
672 <td><code><b>Know/WebForm.txt,v</b></code></td>
676 <td align="center"> ... </td>
677 <td align="center"> ... </td>
680 <td><code><b>Main/NicholasLee.txt</b></code></td>
684 <td><code><b>Main/NicholasLee.txt,v</b></code></td>
688 <td><code><b>Main/NobodyGroup.txt</b></code></td>
692 <td><code><b>Main/NobodyGroup.txt,v</b></code></td>
696 <td><code><b>Main/OfficeLocations.txt</b></code></td>
700 <td><code><b>Main/OfficeLocations.txt,v</b></code></td>
704 <td><code><b>Main/PeterThoeny.txt</b></code></td>
708 <td><code><b>Main/PeterThoeny.txt,v</b></code></td>
712 <td><code><b>Main/SanJoseOffice.txt</b></code></td>
716 <td><code><b>Main/SanJoseOffice.txt,v</b></code></td>
720 <td align="center"> ... </td>
721 <td align="center"> ... </td>
724 <td><code><b>Main/TWikiGroups.txt</b></code></td>
728 <td><code><b>Main/TWikiGroups.txt,v</b></code></td>
732 <td><code><b>Main/TWikiGuest.txt</b></code></td>
736 <td><code><b>Main/TWikiGuest.txt,v</b></code></td>
740 <td><code><b>Main/TWikiUsers.txt</b></code></td>
744 <td><code><b>Main/TWikiUsers.txt,v</b></code></td>
748 <td><code><b>Main/TWikiVariables.txt</b></code></td>
752 <td><code><b>Main/TWikiVariables.txt,v</b></code></td>
756 <td align="center"> ... </td>
757 <td align="center"> ... </td>
760 <td><code><b>Test/TestTopic1.txt</b></code></td>
764 <td><code><b>Test/TestTopic1.txt,v</b></code></td>
768 <td><code><b>Test/WebChanges.txt</b></code></td>
772 <td><code><b>Test/WebChanges.txt,v</b></code></td>
776 <td><code><b>Test/WebHome.txt</b></code></td>
780 <td><code><b>Test/WebHome.txt,v</b></code></td>
784 <td align="center"> ... </td>
785 <td align="center"> ... </td>
788 <td><code><b>Trash/.changes</b></code></td>
792 <td><code><b>Trash/WebChanges.txt</b></code></td>
796 <td><code><b>Trash/WebChanges.txt,v</b></code></td>
800 <td><code><b>Trash/WebHome.txt</b></code></td>
804 <td><code><b>Trash/WebHome.txt,v</b></code></td>
808 <td align="center"> ... </td>
809 <td align="center"> ... </td>
812 <td><code><b>TWiki/AlWilliams.txt</b></code></td>
816 <td><code><b>TWiki/AlWilliams.txt,v</b></code></td>
820 <td><code><b>TWiki/AndreaSterbini.txt</b></code></td>
824 <td><code><b>TWiki/AndreaSterbini.txt,v</b></code></td>
828 <td align="center"> ... </td>
829 <td align="center"> ... </td>
832 <td><code><b>TWiki/DeleteTopic.txt</b></code></td>
836 <td><code><b>TWiki/DeleteTopic.txt,v</b></code></td>
840 <td><code><b>TWiki/DontNotify.txt</b></code></td>
844 <td><code><b>TWiki/DontNotify.txt,v</b></code></td>
849 <a name="TemplatesFiles"></a>
851 #### <a name="Files in twiki/templates"></a> Files in `twiki/templates`
853 **_Used to flexibly control appearance of rendered pages..._**
855 <table border="1" cellpadding="0" cellspacing="0">
857 <th bgcolor="#99CCCC"><strong> File: </strong></th>
858 <th bgcolor="#99CCCC"><strong> Used for: </strong></th>
861 <td><code><b>oopsbadpwformat.tmpl</b></code></td>
865 <td><code><b>attachagain.tmpl</b></code></td>
869 <td><code><b>attachnew.tmpl</b></code></td>
873 <td><code><b>changeform.tmpl</b></code></td>
877 <td><code><b>changes.tmpl</b></code></td>
881 <td><code><b>edit.iejs.tmpl</b></code></td>
885 <td><code><b>edit.tmpl</b></code></td>
889 <td><code><b>mailnotify.tmpl</b></code></td>
893 <td><code><b>moveattachment.tmpl</b></code></td>
897 <td><code><b>oopsaccesschange.tmpl</b></code></td>
901 <td><code><b>oopsaccessgroup.tmpl</b></code></td>
905 <td><code><b>oopsaccessrename.tmpl</b></code></td>
909 <td><code><b>oopsaccessview.tmpl</b></code></td>
913 <td><code><b>oopsauth.tmpl</b></code></td>
917 <td><code><b>attach.tmpl</b></code></td>
921 <td><code><b>oopschangepasswd.tmpl</b></code></td>
925 <td><code><b>oopsempty.tmpl</b></code></td>
929 <td><code><b>oopslocked.tmpl</b></code></td>
933 <td><code><b>oopslockedrename.tmpl</b></code></td>
937 <td><code><b>oopsmissing.tmpl</b></code></td>
941 <td><code><b>oopsmoveerr.tmpl</b></code></td>
945 <td><code><b>oopsnoformdef.tmpl</b></code></td>
949 <td><code><b>oopsnotwikiuser.tmpl</b></code></td>
953 <td><code><b>oopsnoweb.tmpl</b></code></td>
957 <td><code><b>oopspreview.tmpl</b></code></td>
961 <td><code><b>oopsregexist.tmpl</b></code></td>
965 <td><code><b>oopsregpasswd.tmpl</b></code></td>
969 <td><code><b>oopsregrequ.tmpl</b></code></td>
973 <td><code><b>oopsregthanks.tmpl</b></code></td>
977 <td><code><b>oopsregwiki.tmpl</b></code></td>
981 <td><code><b>oopsrenameerr.tmpl</b></code></td>
985 <td><code><b>oopsresetpasswd.tmpl</b></code></td>
989 <td><code><b>oopsrev.tmpl</b></code></td>
993 <td><code><b>oopssave.tmpl</b></code></td>
997 <td><code><b>oopssaveerr.tmpl</b></code></td>
1001 <td><code><b>oopssendmailerr.tmpl</b></code></td>
1005 <td><code><b>oopstopicexists.tmpl</b></code></td>
1009 <td><code><b>oopsupload.tmpl</b></code></td>
1013 <td><code><b>oopswrongpassword.tmpl</b></code></td>
1017 <td><code><b>preview.tmpl</b></code></td>
1021 <td><code><b>rdiff.tmpl</b></code></td>
1025 <td><code><b>register.tmpl</b></code></td>
1029 <td><code><b>registernotify.tmpl</b></code></td>
1033 <td><code><b>rename.tmpl</b></code></td>
1037 <td><code><b>renamebase.tmpl</b></code></td>
1041 <td><code><b>renameconfirm.tmpl</b></code></td>
1045 <td><code><b>renamerefs.tmpl</b></code></td>
1049 <td><code><b>search.tmpl</b></code></td>
1053 <td><code><b>searchbookview.tmpl</b></code></td>
1057 <td><code><b>searchmeta.tmpl</b></code></td>
1061 <td><code><b>searchrenameview.tmpl</b></code></td>
1065 <td><code><b>twiki.tmpl</b></code></td>
1069 <td><code><b>view.plain.tmpl</b></code></td>
1073 <td><code><b>view.print.tmpl</b></code></td>
1077 <td><code><b>view.tmpl</b></code></td>
1082 -- [[MikeMannix]] - 29 Aug 2001