summaryrefslogtreecommitdiff
path: root/TWiki/TWikiImplementationNotes.mdwn
diff options
context:
space:
mode:
authorMikeMannix <MikeMannix>2001-09-05 11:01:11 +0000
committerMikeMannix <MikeMannix>2001-09-05 11:01:11 +0000
commit75c61282ff7265c0abcd88f96dd33b32934e56c1 (patch)
tree9bf555f4b5d2ef6eb347856577b39c280e4af93a /TWiki/TWikiImplementationNotes.mdwn
parent5282dc8b13ec7d810a497b681f125033cf81ffde (diff)
none
Diffstat (limited to 'TWiki/TWikiImplementationNotes.mdwn')
-rw-r--r--TWiki/TWikiImplementationNotes.mdwn574
1 files changed, 231 insertions, 343 deletions
diff --git a/TWiki/TWikiImplementationNotes.mdwn b/TWiki/TWikiImplementationNotes.mdwn
index 1a8c0d2e..f70b281a 100644
--- a/TWiki/TWikiImplementationNotes.mdwn
+++ b/TWiki/TWikiImplementationNotes.mdwn
@@ -2,19 +2,19 @@
## <a name="TWiki_Operating_Environment"> TWiki Operating Environment </a>
-Server and client system requirements, file system structure
+_Server and client system requirements, file system structure_
### <a name="Overview"> Overview </a>
-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.
+Maintaining minimum client and server requirements is necessary to keep TWiki deployment as broad as possible.
### <a name="Server_Side_Requirements"> Server-Side Requirements </a>
-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.
+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.
<table border="1" cellpadding="1" cellspacing="0">
<tr>
- <th bgcolor="#99CCCC" colspan="3"><strong>Required Server Environment by Platform</strong></th>
+ <th bgcolor="#99CCCC" colspan="3"><strong>Required Server Environment</strong></th>
</tr>
<tr>
<th bgcolor="#99CCCC"><strong>Resource</strong></th>
@@ -40,74 +40,30 @@ TWiki is written in **Perl 5** and uses a number of **shell commands**. It requi
</tr>
<tr>
<td> Web server </td>
- <td align="center" colspan="2"> Apache and others (support for cgi, authentication, extended path) <strong>*</strong></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>
- <tr>
- <td> Required disk space </td>
- <td>   </td>
- <td>   </td>
+ <td align="center" colspan="2"> Apache; others (with support for CGI, authentication, extended path) <strong>*</strong></td>
</tr>
</table>
-**_ISP INSTALLATION REQUIREMENTS: SSI, RCS local or sysadmin, same for perl modules for plugins, cron, basic authentication,..._**
+Current documentation covers Linux only. Compiling a basic [TWikiOnWindows](http://twiki.org/cgi-bin/view/Codev/TWikiOnWindows) installation guide is an ongoing effort.
-## <a name="Client_Side_Requirements"> Client-Side Requirements </a>
+### <a name="Client_Side_Requirements"> Client-Side Requirements </a>
-The basic TWiki engine and templates have a low requirement on the browser:
+The TWiki standard installation has extremely low browser requirements:
-<table border="1" cellpadding="1" cellspacing="0">
- <tr>
- <th align="center" bgcolor="#99CCCC" colspan="3"><strong>Recommend PC Requirement</strong></th>
- </tr>
- <tr>
- <th bgcolor="#99CCCC"><strong>Component</strong></th>
- <th bgcolor="#99CCCC"><strong>Min/Rec</strong></th>
- </tr>
-</table>
+* HTML 3.2 compliant
+* minimal use of JavaScript in the user interface (degrades gracefully)
+* no cookies
+* no CSS
-<table border="1" cellpadding="1" cellspacing="0">
- <tr>
- <th align="center" bgcolor="#99CCCC" colspan="2"><strong>Browser Requirements</strong></th>
- </tr>
- <tr>
- <th bgcolor="#99CCCC"><strong>Resource</strong></th>
- <th bgcolor="#99CCCC"><strong>Details</strong></th>
- </tr>
- <tr>
- <td> HTML 3.2 browser </td>
- <td>   </td>
- </tr>
- <tr>
- <td><nop>JavaScript 1.? </nop></td>
- <td> Optional: JS degrades gracefully </td>
- </tr>
- <tr>
- <td> Cookies </td>
- <td> Not used </td>
- </tr>
- <tr>
- <td> CSS1/2 </td>
- <td> ???? </td>
- </tr>
-</table>
+TWiki generates XHTML 1.0 code as long as it is compatible with HTML 3.2.
-* TWiki generates XHTML 1.0 code as long as it is compatible with HTML 3.2.
+#### <a name="Known_Issues"> Known Issues </a>
-**_WHAT ABOUT WEB STANDARDS BROWSER COMPATIBILITY MOVEMENT &amp; CSS CONTROL_**
-
-### <a name="Known_Issues"> Known Issues </a>
-
-* Some TWikiSkins may require more, like cookies and JavaScript
-* At present, contributed Plugins are not checked against compatibility standards, and may require anything imaginable: browser-specific functions, Java, cookies, CSS, etc.
+* 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.
### <a name="TWiki_File_System"> TWiki File System </a>
-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:
+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:
<table border="1" cellpadding="1" cellspacing="0">
<tr>
@@ -116,44 +72,44 @@ You can rename the root TWiki directory - <code>**twiki**</code> - to whatever y
<th bgcolor="#99CCCC"><strong>Used for:</strong></th>
</tr>
<tr>
- <td><code><b>twiki</b></code></td>
+ <td><code>twiki</code></td>
<td align="center"> list </td>
<td> Start-up info </td>
</tr>
<tr>
- <td><code><b>twiki/bin</b></code></td>
+ <td><code>twiki/bin</code></td>
<td align="center"> list </td>
<td> Perl scripts </td>
</tr>
<tr>
- <td><code><b>twiki/lib</b></code></td>
+ <td><code>twiki/lib</code></td>
<td align="center"> list </td>
<td> Configuration file, main library, Perl system modules, Plugins </td>
</tr>
<tr>
- <td><code><b>twiki/pub</b></code></td>
+ <td><code>twiki/pub</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><code>twiki/data</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><code>twiki/templates</code></td>
<td align="center"> list </td>
<td> HTML templates, used by TWiki scripts </td>
</tr>
</table>
-### <a name="File_Descriptions"> File Descriptions </a>
+#### <a name="File_Descriptions"> File Descriptions </a>
-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.
+A rundown of the individual files in the current %VERSION% distribution, organized by TWiki root directories. All listings are complete unless otherwise noted.
<a name="TWikiFiles"></a>
-#### <a name="Files_in_twiki_code_"> Files in `twiki` </a>
+##### <a name="Files_in_twiki_code_"> Files in `twiki` </a>
Introductory and installation files.
@@ -163,30 +119,30 @@ Introductory and installation files.
<th bgcolor="#99CCCC"><strong>Used for:</strong></th>
</tr>
<tr>
- <td><code><b>index.html</b></code></td>
+ <td><code>index.html</code></td>
<td> A page with a link to first launch TWiki after install </td>
</tr>
<tr>
- <td><code><b>license.txt</b></code></td>
+ <td><code>license.txt</code></td>
<td> GNU General Public License and TWiki-specific info </td>
</tr>
<tr>
- <td><code><b>readme.txt</b></code></td>
+ <td><code>readme.txt</code></td>
<td> General TWiki start-up info with relevant URLs. </td>
</tr>
<tr>
- <td><code><b>TWikiDocumentation.html</b></code></td>
+ <td><code>TWikiDocumentation.html</code></td>
<td> All documentation packaged as a single page </td>
</tr>
<tr>
- <td><code><b>TWikiHistory.html</b></code></td>
+ <td><code>TWikiHistory.html</code></td>
<td> TWiki development timeline </td>
</tr>
</table>
<a name="BinFiles"></a>
-#### <a name="Files_in_twiki_bin_code_"> Files in `twiki/bin` </a>
+##### <a name="Files_in_twiki_bin_code_"> Files in `twiki/bin` </a>
All Perl CGI scripts.
@@ -196,84 +152,84 @@ All Perl CGI scripts.
<th bgcolor="#99CCCC"><strong>Used for:</strong></th>
</tr>
<tr>
- <td><code><b>.htaccess.txt</b></code></td>
+ <td><code>.htaccess.txt</code></td>
<td> Authentication. Rename to .htaccess and customize if used </td>
</tr>
<tr>
- <td><code><b>attach</b></code></td>
+ <td><code>attach</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><code>delete</code></td>
<td> (not used yet) </td>
</tr>
<tr>
- <td><code><b>edit</b></code></td>
+ <td><code>edit</code></td>
<td> Script to edit a topic </td>
</tr>
<tr>
- <td><code><b>geturl</b></code></td>
+ <td><code>geturl</code></td>
<td> Script to fetch URL data </td>
</tr>
<tr>
- <td><code><b>mailnotify</b></code></td>
+ <td><code>mailnotify</code></td>
<td> Script called by cron job to notify users of changes </td>
</tr>
<tr>
- <td><code><b>oops</b></code></td>
+ <td><code>oops</code></td>
<td> Script that shows an OK or oops dialog </td>
</tr>
<tr>
- <td><code><b>preview</b></code></td>
+ <td><code>preview</code></td>
<td> Script to preview topic after edit </td>
</tr>
<tr>
- <td><code><b>rdiff</b></code></td>
+ <td><code>rdiff</code></td>
<td> Script to see differences of topics </td>
</tr>
<tr>
- <td><code><b>rename</b></code></td>
+ <td><code>rename</code></td>
<td> Script to rename/move topics and move attachments </td>
</tr>
<tr>
- <td><code><b>register</b></code></td>
+ <td><code>register</code></td>
<td> Script to register new users </td>
</tr>
<tr>
- <td><code><b>save</b></code></td>
+ <td><code>save</code></td>
<td> Script that saves a topic, called by preview </td>
</tr>
<tr>
- <td><code><b>search</b></code></td>
+ <td><code>search</code></td>
<td> Script that displays search results </td>
</tr>
<tr>
- <td><code><b>statistics</b></code></td>
+ <td><code>statistics</code></td>
<td> Script to create statistics topic </td>
</tr>
<tr>
- <td><code><b>testenv</b></code></td>
+ <td><code>testenv</code></td>
<td> Script to test CGI environment variables </td>
</tr>
<tr>
- <td><code><b>upload</b></code></td>
+ <td><code>upload</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><code>view</code></td>
<td> Script to view a topic ( <strong>the</strong> script ) </td>
</tr>
<tr>
- <td><code><b>viewfile</b></code></td>
+ <td><code>viewfile</code></td>
<td> Script to view an file attachment </td>
</tr>
</table>
<a name="LibFiles"></a>
-#### <a name="Files_under_twiki_lib_code_"> Files under `twiki/lib` </a>
+##### <a name="Files_under_twiki_lib_code_"> Files under `twiki/lib` </a>
-The new <code>**lib/TWiki/Plugins**</code> directories contain core configuration, libraries and function modules, and Plugins.
+The new `lib/TWiki/Plugins` directories contain core configuration, libraries and function modules, and Plugins.
<table border="1" cellpadding="1" cellspacing="0">
<tr>
@@ -281,62 +237,62 @@ The new <code>**lib/TWiki/Plugins**</code> directories contain core configuratio
<th bgcolor="#99CCCC"><strong>Used for:</strong></th>
</tr>
<tr>
- <td><code><b>TWiki.pm</b></code></td>
+ <td><code>TWiki.pm</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>
+ <td><code>TWiki.cfg</code></td>
+ <td> For configuration, used by <code>TWiki.pm</code></td>
</tr>
<tr>
- <td><code><b>TWiki/Access.pm</b></code></td>
+ <td><code>TWiki/Access.pm</code></td>
<td> Access control </td>
</tr>
<tr>
- <td><code><b>TWiki/Attach.pm</b></code></td>
+ <td><code>TWiki/Attach.pm</code></td>
<td> Attachment handling </td>
</tr>
<tr>
- <td><code><b>TWiki/Meta.pm</b></code></td>
+ <td><code>TWiki/Meta.pm</code></td>
<td> Meta data in topics </td>
</tr>
<tr>
- <td><code><b>TWiki/Net.pm</b></code></td>
+ <td><code>TWiki/Net.pm</code></td>
<td> SMTP mail handling </td>
</tr>
<tr>
- <td><code><b>TWiki/Plugins.pm</b></code></td>
+ <td><code>TWiki/Plugins.pm</code></td>
<td> Plugin handling </td>
</tr>
<tr>
- <td><code><b>TWiki/Prefs.pm</b></code></td>
+ <td><code>TWiki/Prefs.pm</code></td>
<td> Preferences handling </td>
</tr>
<tr>
- <td><code><b>TWiki/Search.pm</b></code></td>
+ <td><code>TWiki/Search.pm</code></td>
<td> Search engine, used by wiki.pm </td>
</tr>
<tr>
- <td><code><b>TWiki/Store.pm</b></code></td>
+ <td><code>TWiki/Store.pm</code></td>
<td> Back-end storage, <code>*.txt</code> text file and <code>*.txt,v</code> RCS repository file handling </td>
</tr>
<tr>
- <td><code><b>TWiki/Plugins/DefaultPlugin.pm</b></code></td>
+ <td><code>TWiki/Plugins/DefaultPlugin.pm</code></td>
<td> Default plugin </td>
</tr>
<tr>
- <td><code><b>TWiki/Plugins/EmptyPlugin.pm</b></code></td>
+ <td><code>TWiki/Plugins/EmptyPlugin.pm</code></td>
<td> Empty plugin, use to create your own </td>
</tr>
<tr>
- <td><code><b>TWiki/Plugins/InterwikiPlugin.pm</b></code></td>
+ <td><code>TWiki/Plugins/InterwikiPlugin.pm</code></td>
<td> Refer to external Wikis and other Web sites </td>
</tr>
</table>
<a name="PubFiles"></a>
-#### <a name="Files_under_twiki_pub_code_"> Files under `twiki/pub` </a>
+##### <a name="Files_under_twiki_pub_code_"> Files under `twiki/pub` </a>
**_attachments like images..._**
@@ -346,184 +302,184 @@ The new <code>**lib/TWiki/Plugins**</code> directories contain core configuratio
<th bgcolor="#99CCCC"><strong>Used for:</strong></th>
</tr>
<tr>
- <td><code><b>favicon.ico</b></code></td>
+ <td><code>favicon.ico</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>twikilogo.gif</b></code></td>
+ <td><code>twikilogo.gif</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>twikilogo1.gif</b></code></td>
+ <td><code>twikilogo1.gif</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>twikilogo2.gif</b></code></td>
+ <td><code>twikilogo2.gif</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>twikilogo3.gif</b></code></td>
+ <td><code>twikilogo3.gif</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>twikilogo4.gif</b></code></td>
+ <td><code>twikilogo4.gif</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>wikiHome.gif</b></code></td>
+ <td><code>wikiHome.gif</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>icn/_filetypes.txt</b></code></td>
+ <td><code>icn/_filetypes.txt</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>icn/bat.gif</b></code></td>
+ <td><code>icn/bat.gif</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>icn/bmp.gif</b></code></td>
+ <td><code>icn/bmp.gif</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>icn/c.gif</b></code></td>
+ <td><code>icn/c.gif</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>icn/dll.gif</b></code></td>
+ <td><code>icn/dll.gif</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>icn/doc.gif</b></code></td>
+ <td><code>icn/doc.gif</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>icn/else.gif</b></code></td>
+ <td><code>icn/else.gif</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>icn/exe.gif</b></code></td>
+ <td><code>icn/exe.gif</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>icn/fon.gif</b></code></td>
+ <td><code>icn/fon.gif</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>icn/h.gif</b></code></td>
+ <td><code>icn/h.gif</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>icn/hlp.gif</b></code></td>
+ <td><code>icn/hlp.gif</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>icn/html.gif</b></code></td>
+ <td><code>icn/html.gif</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>icn/java.gif</b></code></td>
+ <td><code>icn/java.gif</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>icn/mov.gif</b></code></td>
+ <td><code>icn/mov.gif</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>icn/pdf.gif</b></code></td>
+ <td><code>icn/pdf.gif</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>icn/pl.gif</b></code></td>
+ <td><code>icn/pl.gif</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>icn/ppt.gif</b></code></td>
+ <td><code>icn/ppt.gif</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>icn/ps.gif</b></code></td>
+ <td><code>icn/ps.gif</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>icn/py.gif</b></code></td>
+ <td><code>icn/py.gif</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>icn/ram.gif</b></code></td>
+ <td><code>icn/ram.gif</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>icn/reg.gif</b></code></td>
+ <td><code>icn/reg.gif</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>icn/sh.gif</b></code></td>
+ <td><code>icn/sh.gif</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>icn/sniff.gif</b></code></td>
+ <td><code>icn/sniff.gif</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>icn/ttf.gif</b></code></td>
+ <td><code>icn/ttf.gif</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>icn/txt.gif</b></code></td>
+ <td><code>icn/txt.gif</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>icn/wav.gif</b></code></td>
+ <td><code>icn/wav.gif</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>icn/wri.gif</b></code></td>
+ <td><code>icn/wri.gif</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>icn/xls.gif</b></code></td>
+ <td><code>icn/xls.gif</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>icn/zip.gif</b></code></td>
+ <td><code>icn/zip.gif</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>Know/IncorrectDllVersionW32PTH10DLL/W32PTH10.DLL</b></code></td>
+ <td><code>Know/IncorrectDllVersionW32PTH10DLL/W32PTH10.DLL</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>TWiki/FileAttachment/Sample.txt</b></code></td>
+ <td><code>TWiki/FileAttachment/Sample.txt</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>TWiki/FileAttachment/Smile.gif</b></code></td>
+ <td><code>TWiki/FileAttachment/Smile.gif</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>TWiki/PreviewBackground/blankltgraybg.gif</b></code></td>
+ <td><code>TWiki/PreviewBackground/blankltgraybg.gif</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>TWiki/PreviewBackground/blankwhitebg.gif</b></code></td>
+ <td><code>TWiki/PreviewBackground/blankwhitebg.gif</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>TWiki/PreviewBackground/previewbg.gif</b></code></td>
+ <td><code>TWiki/PreviewBackground/previewbg.gif</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>TWiki/WabiSabi/wabisabi.gif</b></code></td>
+ <td><code>TWiki/WabiSabi/wabisabi.gif</code></td>
<td> xxxx </td>
</tr>
</table>
<a name="DataFiles"></a>
-#### <a name="Files_under_twiki_data_code_"> Files under `twiki/data` </a>
+##### <a name="Files_under_twiki_data_code_"> Files under `twiki/data` </a>
-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..._
+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..._
<table border="1" cellpadding="1" cellspacing="0">
<tr>
@@ -531,304 +487,236 @@ The <code>**data**</code> directory stores the content of TWiki pages as individ
<th bgcolor="#99CCCC"><strong>Used for:</strong></th>
</tr>
<tr>
- <td><code><b>.htpasswd</b></code></td>
- <td> xxxx </td>
- </tr>
- <tr>
- <td><code><b>debug.txt</b></code></td>
- <td> xxxx </td>
- </tr>
- <tr>
- <td><code><b>mime.types</b></code></td>
- <td> xxxx </td>
- </tr>
- <tr>
- <td><code><b>warning.txt</b></code></td>
- <td> xxxx </td>
- </tr>
- <tr>
- <td><code><b>_default/.changes</b></code></td>
+ <td><code>.htpasswd</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>_default/WebChanges.txt</b></code></td>
+ <td><code>debug.txt</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>_default/WebChanges.txt,v</b></code></td>
+ <td><code>mime.types</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>_default/WebHome.txt</b></code></td>
+ <td><code>warning.txt</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>_default/WebHome.txt,v</b></code></td>
+ <td><code>_default/.changes</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>_default/WebIndex.txt</b></code></td>
+ <td><code>_default/WebChanges.txt</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>_default/WebIndex.txt,v</b></code></td>
+ <td><code>_default/WebChanges.txt,v</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>_default/WebNotify.txt</b></code></td>
+ <td><code>_default/WebHome.txt</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>_default/WebNotify.txt,v</b></code></td>
+ <td><code>_default/WebHome.txt,v</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>_default/WebPreferences.txt</b></code></td>
+ <td><code>_default/WebIndex.txt</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>_default/WebPreferences.txt,v</b></code></td>
+ <td><code>_default/WebIndex.txt,v</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>_default/WebSearch.txt</b></code></td>
+ <td><code>_default/WebNotify.txt</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>_default/WebSearch.txt,v</b></code></td>
+ <td><code>_default/WebNotify.txt,v</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>_default/WebStatistics.txt</b></code></td>
+ <td><code>_default/WebPreferences.txt</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>_default/WebStatistics.txt,v</b></code></td>
+ <td><code>_default/WebPreferences.txt,v</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td align="center"> ... </td>
- <td align="center"> ... </td>
- </tr>
- <tr>
- <td><code><b>Know/TopicClassification.txt</b></code></td>
- <td> xxxx </td>
- </tr>
- <tr>
- <td><code><b>Know/TopicClassification.txt,v</b></code></td>
+ <td><code>_default/WebSearch.txt</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>Know/TWikiCategory.txt</b></code></td>
+ <td><code>_default/WebSearch.txt,v</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>Know/TWikiCategory.txt,v</b></code></td>
+ <td><code>_default/WebStatistics.txt</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>Know/UseCategory.txt</b></code></td>
+ <td><code>_default/WebStatistics.txt,v</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>Know/UseCategory.txt,v</b></code></td>
- <td> xxxx </td>
+ <th align="center" bgcolor="#99CCCC"><strong>...</strong></th>
+ <th align="center" bgcolor="#99CCCC"><strong>...</strong></th>
</tr>
<tr>
- <td><code><b>Know/WebChanges.txt</b></code></td>
+ <td><code>Know/TopicClassification.txt</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>Know/WebChanges.txt,v</b></code></td>
+ <td><code>Know/TopicClassification.txt,v</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>Know/WebForm.txt</b></code></td>
+ <td><code>Know/TWikiCategory.txt</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>Know/WebForm.txt,v</b></code></td>
+ <td><code>Know/TWikiCategory.txt,v</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td align="center"> ... </td>
- <td align="center"> ... </td>
- </tr>
- <tr>
- <td><code><b>Main/NicholasLee.txt</b></code></td>
+ <td><code>Know/UseCategory.txt</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>Main/NicholasLee.txt,v</b></code></td>
+ <td><code>Know/UseCategory.txt,v</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>Main/NobodyGroup.txt</b></code></td>
+ <td><code>Know/WebChanges.txt</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>Main/NobodyGroup.txt,v</b></code></td>
+ <td><code>Know/WebChanges.txt,v</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>Main/OfficeLocations.txt</b></code></td>
+ <td><code>Know/WebForm.txt</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>Main/OfficeLocations.txt,v</b></code></td>
+ <td><code>Know/WebForm.txt,v</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>Main/PeterThoeny.txt</b></code></td>
- <td> xxxx </td>
+ <th align="center" bgcolor="#99CCCC"><strong>...</strong></th>
+ <th align="center" bgcolor="#99CCCC"><strong>...</strong></th>
</tr>
<tr>
- <td><code><b>Main/PeterThoeny.txt,v</b></code></td>
+ <td><code>Main/OfficeLocations.txt</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>Main/SanJoseOffice.txt</b></code></td>
+ <td><code>Main/OfficeLocations.txt,v</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>Main/SanJoseOffice.txt,v</b></code></td>
+ <td><code>Main/PeterThoeny.txt</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td align="center"> ... </td>
- <td align="center"> ... </td>
- </tr>
- <tr>
- <td><code><b>Main/TWikiGroups.txt</b></code></td>
+ <td><code>Main/PeterThoeny.txt,v</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>Main/TWikiGroups.txt,v</b></code></td>
+ <td><code>Main/SanJoseOffice.txt</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>Main/TWikiGuest.txt</b></code></td>
+ <td><code>Main/SanJoseOffice.txt,v</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>Main/TWikiGuest.txt,v</b></code></td>
- <td> xxxx </td>
+ <th align="center" bgcolor="#99CCCC"><strong>...</strong></th>
+ <th align="center" bgcolor="#99CCCC"><strong>...</strong></th>
</tr>
<tr>
- <td><code><b>Main/TWikiUsers.txt</b></code></td>
+ <td><code>Main/TWikiGuest.txt</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>Main/TWikiUsers.txt,v</b></code></td>
+ <td><code>Main/TWikiGuest.txt,v</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>Main/TWikiVariables.txt</b></code></td>
+ <td><code>Main/TWikiUsers.txt</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>Main/TWikiVariables.txt,v</b></code></td>
+ <td><code>Main/TWikiUsers.txt,v</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td align="center"> ... </td>
- <td align="center"> ... </td>
+ <th align="center" bgcolor="#99CCCC"><strong>...</strong></th>
+ <th align="center" bgcolor="#99CCCC"><strong>...</strong></th>
</tr>
<tr>
- <td><code><b>Test/TestTopic1.txt</b></code></td>
+ <td><code>Test/TestTopic1.txt</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>Test/TestTopic1.txt,v</b></code></td>
+ <td><code>Test/TestTopic1.txt,v</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>Test/WebChanges.txt</b></code></td>
+ <td><code>Test/WebHome.txt</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>Test/WebChanges.txt,v</b></code></td>
+ <td><code>Test/WebHome.txt,v</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>Test/WebHome.txt</b></code></td>
- <td> xxxx </td>
+ <th align="center" bgcolor="#99CCCC"><strong>...</strong></th>
+ <th align="center" bgcolor="#99CCCC"><strong>...</strong></th>
</tr>
<tr>
- <td><code><b>Test/WebHome.txt,v</b></code></td>
+ <td><code>Trash/WebHome.txt</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td align="center"> ... </td>
- <td align="center"> ... </td>
- </tr>
- <tr>
- <td><code><b>Trash/.changes</b></code></td>
+ <td><code>Trash/WebHome.txt,v</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>Trash/WebChanges.txt</b></code></td>
- <td> xxxx </td>
+ <th align="center" bgcolor="#99CCCC"><strong>...</strong></th>
+ <th align="center" bgcolor="#99CCCC"><strong>...</strong></th>
</tr>
<tr>
- <td><code><b>Trash/WebChanges.txt,v</b></code></td>
+ <td><code>TWiki/DeleteTopic.txt</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>Trash/WebHome.txt</b></code></td>
+ <td><code>TWiki/DeleteTopic.txt,v</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>Trash/WebHome.txt,v</b></code></td>
+ <td><code>TWiki/DontNotify.txt</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td align="center"> ... </td>
- <td align="center"> ... </td>
- </tr>
- <tr>
- <td><code><b>TWiki/AlWilliams.txt</b></code></td>
+ <td><code>TWiki/DontNotify.txt,v</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>TWiki/AlWilliams.txt,v</b></code></td>
- <td> xxxx </td>
- </tr>
- <tr>
- <td><code><b>TWiki/AndreaSterbini.txt</b></code></td>
- <td> xxxx </td>
- </tr>
- <tr>
- <td><code><b>TWiki/AndreaSterbini.txt,v</b></code></td>
- <td> xxxx </td>
- </tr>
- <tr>
- <td align="center"> ... </td>
- <td align="center"> ... </td>
- </tr>
- <tr>
- <td><code><b>TWiki/DeleteTopic.txt</b></code></td>
- <td> xxxx </td>
- </tr>
- <tr>
- <td><code><b>TWiki/DeleteTopic.txt,v</b></code></td>
- <td> xxxx </td>
- </tr>
- <tr>
- <td><code><b>TWiki/DontNotify.txt</b></code></td>
- <td> xxxx </td>
- </tr>
- <tr>
- <td><code><b>TWiki/DontNotify.txt,v</b></code></td>
- <td> xxxx </td>
+ <th align="center" bgcolor="#99CCCC"><strong>...</strong></th>
+ <th align="center" bgcolor="#99CCCC"><strong>...</strong></th>
</tr>
</table>
<a name="TemplatesFiles"></a>
-#### <a name="Files_in_twiki_templates_code_"> Files in `twiki/templates` </a>
+##### <a name="Files_in_twiki_templates_code_"> Files in `twiki/templates` </a>
-**_Used to flexibly control appearance of rendered pages..._**
+_Used to flexibly control appearance of rendered pages..._
<table border="1" cellpadding="1" cellspacing="0">
<tr>
@@ -836,223 +724,223 @@ The <code>**data**</code> directory stores the content of TWiki pages as individ
<th bgcolor="#99CCCC"><strong>Used for:</strong></th>
</tr>
<tr>
- <td><code><b>oopsbadpwformat.tmpl</b></code></td>
+ <td><code>oopsbadpwformat.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>attachagain.tmpl</b></code></td>
+ <td><code>attachagain.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>attachnew.tmpl</b></code></td>
+ <td><code>attachnew.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>changeform.tmpl</b></code></td>
+ <td><code>changeform.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>changes.tmpl</b></code></td>
+ <td><code>changes.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>edit.iejs.tmpl</b></code></td>
+ <td><code>edit.iejs.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>edit.tmpl</b></code></td>
+ <td><code>edit.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>mailnotify.tmpl</b></code></td>
+ <td><code>mailnotify.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>moveattachment.tmpl</b></code></td>
+ <td><code>moveattachment.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>oopsaccesschange.tmpl</b></code></td>
+ <td><code>oopsaccesschange.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>oopsaccessgroup.tmpl</b></code></td>
+ <td><code>oopsaccessgroup.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>oopsaccessrename.tmpl</b></code></td>
+ <td><code>oopsaccessrename.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>oopsaccessview.tmpl</b></code></td>
+ <td><code>oopsaccessview.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>oopsauth.tmpl</b></code></td>
+ <td><code>oopsauth.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>attach.tmpl</b></code></td>
+ <td><code>attach.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>oopschangepasswd.tmpl</b></code></td>
+ <td><code>oopschangepasswd.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>oopsempty.tmpl</b></code></td>
+ <td><code>oopsempty.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>oopslocked.tmpl</b></code></td>
+ <td><code>oopslocked.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>oopslockedrename.tmpl</b></code></td>
+ <td><code>oopslockedrename.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>oopsmissing.tmpl</b></code></td>
+ <td><code>oopsmissing.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>oopsmoveerr.tmpl</b></code></td>
+ <td><code>oopsmoveerr.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>oopsnoformdef.tmpl</b></code></td>
+ <td><code>oopsnoformdef.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>oopsnotwikiuser.tmpl</b></code></td>
+ <td><code>oopsnotwikiuser.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>oopsnoweb.tmpl</b></code></td>
+ <td><code>oopsnoweb.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>oopspreview.tmpl</b></code></td>
+ <td><code>oopspreview.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>oopsregexist.tmpl</b></code></td>
+ <td><code>oopsregexist.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>oopsregpasswd.tmpl</b></code></td>
+ <td><code>oopsregpasswd.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>oopsregrequ.tmpl</b></code></td>
+ <td><code>oopsregrequ.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>oopsregthanks.tmpl</b></code></td>
+ <td><code>oopsregthanks.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>oopsregwiki.tmpl</b></code></td>
+ <td><code>oopsregwiki.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>oopsrenameerr.tmpl</b></code></td>
+ <td><code>oopsrenameerr.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>oopsresetpasswd.tmpl</b></code></td>
+ <td><code>oopsresetpasswd.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>oopsrev.tmpl</b></code></td>
+ <td><code>oopsrev.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>oopssave.tmpl</b></code></td>
+ <td><code>oopssave.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>oopssaveerr.tmpl</b></code></td>
+ <td><code>oopssaveerr.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>oopssendmailerr.tmpl</b></code></td>
+ <td><code>oopssendmailerr.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>oopstopicexists.tmpl</b></code></td>
+ <td><code>oopstopicexists.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>oopsupload.tmpl</b></code></td>
+ <td><code>oopsupload.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>oopswrongpassword.tmpl</b></code></td>
+ <td><code>oopswrongpassword.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>preview.tmpl</b></code></td>
+ <td><code>preview.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>rdiff.tmpl</b></code></td>
+ <td><code>rdiff.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>register.tmpl</b></code></td>
+ <td><code>register.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>registernotify.tmpl</b></code></td>
+ <td><code>registernotify.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>rename.tmpl</b></code></td>
+ <td><code>rename.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>renamebase.tmpl</b></code></td>
+ <td><code>renamebase.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>renameconfirm.tmpl</b></code></td>
+ <td><code>renameconfirm.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>renamerefs.tmpl</b></code></td>
+ <td><code>renamerefs.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>search.tmpl</b></code></td>
+ <td><code>search.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>searchbookview.tmpl</b></code></td>
+ <td><code>searchbookview.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>searchmeta.tmpl</b></code></td>
+ <td><code>searchmeta.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>searchrenameview.tmpl</b></code></td>
+ <td><code>searchrenameview.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>twiki.tmpl</b></code></td>
+ <td><code>twiki.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>view.plain.tmpl</b></code></td>
+ <td><code>view.plain.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>view.print.tmpl</b></code></td>
+ <td><code>view.print.tmpl</code></td>
<td> xxxx </td>
</tr>
<tr>
- <td><code><b>view.tmpl</b></code></td>
+ <td><code>view.tmpl</code></td>
<td> xxxx </td>
</tr>
</table>