summaryrefslogtreecommitdiff
path: root/TWiki
diff options
context:
space:
mode:
authorMikeMannix <MikeMannix>2001-08-29 00:47:55 +0000
committerMikeMannix <MikeMannix>2001-08-29 00:47:55 +0000
commit3b5aaf37e3f8deed80216e5efb1ea60b784339ff (patch)
tree3e931656de5b93a3a5047209c101e0d5d0679169 /TWiki
parentcf5bb20fec0c3441cc2068175ac2b9c05e4d34eb (diff)
none
Diffstat (limited to 'TWiki')
-rw-r--r--TWiki/TWikiImplementationNotes.mdwn92
1 files changed, 76 insertions, 16 deletions
diff --git a/TWiki/TWikiImplementationNotes.mdwn b/TWiki/TWikiImplementationNotes.mdwn
index c6f34cd7..c1b1a64f 100644
--- a/TWiki/TWikiImplementationNotes.mdwn
+++ b/TWiki/TWikiImplementationNotes.mdwn
@@ -1,16 +1,18 @@
+%TOC% %STARTINCLUDE%
+
## <a name="TWiki_Implementation_Notes"> TWiki Implementation Notes </a>
-### <a name="Platform"> Platform </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.
+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>Package(s):</strong></th>
- <th bgcolor="#99CCCC"><strong>Unix:</strong></th>
+ <th bgcolor="#99CCCC"><strong>Packages:</strong></th>
+ <th bgcolor="#99CCCC"><strong>Linux/Unix:</strong></th>
<th bgcolor="#99CCCC"><strong>Windows:</strong></th>
</tr>
<tr>
@@ -26,7 +28,7 @@ TWiki is written in Perl 5 and also uses some shell commands. The current implem
<tr>
<td> Optional Perl modules </td>
<td><code>Net::SMTP</code> (or sendmail) </td>
- <td><code>Net::SMTP</code></td>
+ <td align="center"><code>Net::SMTP</code></td>
</tr>
<tr>
<td> RCS </td>
@@ -43,42 +45,76 @@ TWiki is written in Perl 5 and also uses some shell commands. The current implem
<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> TWiki Perl scripts </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;amp; main library </td>
</tr>
<tr>
<td><code><b>twiki/lib/TWiki</b></code></td>
- <td> TWiki Perl modules </td>
+ <td align="center"> list </td>
+ <td> Perl modules </td>
</tr>
<tr>
<td><code><b>twiki/lib/TWiki/Plugins</b></code></td>
- <td> Plugins modules </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> Public files (<span style="background:"><font color="">File Attachments</font></span><a href="http://LOCATION/FileAttachments">?</a>, images), plus RCS histories </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> source (topic) text, including RCS histories </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>
-#### <a name="Files_in_twiki_bin"> Files in twiki/bin </a>
+**_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>
@@ -159,7 +195,9 @@ TWiki is written in Perl 5 and also uses some shell commands. The current implem
</tr>
</table>
-#### <a name="Files_in_twiki_lib"> Files in twiki/lib </a>
+<a name="LibFiles"></a>
+
+#### <a name="Files_in_twiki_lib_code_"> Files in `twiki/lib` </a>
<table border="1" cellpadding="1" cellspacing="0">
<tr>
@@ -172,11 +210,13 @@ TWiki is written in Perl 5 and also uses some shell commands. The current implem
</tr>
<tr>
<td><code><b>TWiki.cfg</b></code></td>
- <td> For initialization and configuration, used by <code><b>TWiki.pm</b></code></td>
+ <td> For configuration, used by <code><b>TWiki.pm</b></code></td>
</tr>
</table>
-#### <a name="Files_in_twiki_lib_TWiki"> Files in twiki/lib/TWiki </a>
+<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>
@@ -217,7 +257,9 @@ TWiki is written in Perl 5 and also uses some shell commands. The current implem
</tr>
</table>
-#### <a name="Files_in_twiki_lib_TWiki_Plugins"> Files in twiki/lib/TWiki/Plugins </a>
+<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>
@@ -238,4 +280,22 @@ TWiki is written in Perl 5 and also uses some shell commands. The current implem
</tr>
</table>
--- [[Main/MikeMannix]] - 26 Aug 2001
+<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