diff options
| -rw-r--r-- | TWiki/TWikiImplementationNotes.mdwn | 67 |
1 files changed, 22 insertions, 45 deletions
diff --git a/TWiki/TWikiImplementationNotes.mdwn b/TWiki/TWikiImplementationNotes.mdwn index adbb8425..11c4b307 100644 --- a/TWiki/TWikiImplementationNotes.mdwn +++ b/TWiki/TWikiImplementationNotes.mdwn @@ -1,10 +1,10 @@ %TOC% %STARTINCLUDE% -## <a name="TWiki_Implementation_Notes"> TWiki Implementation Notes </a> +## <a name="TWiki_Software_Environment"> TWiki Software Environment </a> -### <a name="Platforms_and_System_Requirement"> Platforms and System Requirements </a> +### <a name="System_Requirements"> System Requirements </a> -TWiki is written in **Perl 5** and also uses some **shell commands**. The current implementation runs best on a Unix machine, but it is also possible on Microsoft Windows. **RCS** (for revision control) must be installed on the system. [ **_MM: Locate elsewhere and/or include one-liner and link for RCS..._** ] +TWiki is written in **Perl 5** and also uses some **shell commands**. It also requires that **GNU RCS** (Revision Control System) is installed on the same system. The current implementation runs best on a Linux machine, but it can also run with Microsoft Windows. <table border="1" cellpadding="1" cellspacing="0"> <tr> @@ -52,9 +52,9 @@ TWiki is written in **Perl 5** and also uses some **shell commands**. The curren </tr> </table> -### <a name="Directory_Structure"> Directory Structure </a> +### <a name="TWiki_Directory_Structure"> TWiki Directory Structure </a> -You can easily 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 - the folder names and locations - exactly as is: +You can easily 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: <table border="1" cellpadding="1" cellspacing="0"> <tr> @@ -104,7 +104,9 @@ You can easily rename the root TWiki directory - <code>**twiki**</code> - to wha </tr> </table> -**_Note: about the additional directories in data, elsewhere_** +### <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. <a name="TWikiFiles"></a> @@ -222,7 +224,7 @@ You can easily rename the root TWiki directory - <code>**twiki**</code> - to wha <a name="LibFiles"></a> -#### <a name="Files_in_twiki_lib_code_"> Files in `twiki/lib` </a> +#### <a name="Files_under_twiki_lib_code_"> Files under `twiki/lib` </a> <table border="1" cellpadding="1" cellspacing="0"> <tr> @@ -237,86 +239,61 @@ You can easily rename the root TWiki directory - <code>**twiki**</code> - to wha <td><code><b>TWiki.cfg</b></code></td> <td> For configuration, used by <code><b>TWiki.pm</b></code></td> </tr> -</table> - -<a name="LibTWiki"></a> - -#### <a name="Files_in_twiki_lib_TWiki_code_"> Files in `twiki/lib/TWiki` </a> - -<table border="1" cellpadding="1" cellspacing="0"> <tr> - <th bgcolor="#99CCCC"><strong>File:</strong></th> - <th bgcolor="#99CCCC"><strong>Used for:</strong></th> - </tr> - <tr> - <td><code><b>Access.pm</b></code></td> + <td><code><b>TWiki/Access.pm</b></code></td> <td> Access control </td> </tr> <tr> - <td><code><b>Attach.pm</b></code></td> + <td><code><b>TWiki/Attach.pm</b></code></td> <td> Attachment handling </td> </tr> <tr> - <td><code><b>Meta.pm</b></code></td> + <td><code><b>TWiki/Meta.pm</b></code></td> <td> Meta data in topics </td> </tr> <tr> - <td><code><b>Net.pm</b></code></td> + <td><code><b>TWiki/Net.pm</b></code></td> <td> SMTP mail handling </td> </tr> <tr> - <td><code><b>Plugins.pm</b></code></td> + <td><code><b>TWiki/Plugins.pm</b></code></td> <td> Plugin handling </td> </tr> <tr> - <td><code><b>Prefs.pm</b></code></td> + <td><code><b>TWiki/Prefs.pm</b></code></td> <td> Preferences handling </td> </tr> <tr> - <td><code><b>Search.pm</b></code></td> + <td><code><b>TWiki/Search.pm</b></code></td> <td> Search engine, used by wiki.pm </td> </tr> <tr> - <td><code><b>Store.pm</b></code></td> + <td><code><b>TWiki/Store.pm</b></code></td> <td> Back-end storage, <code>*.txt</code> text file and <code>*.txt,v</code> RCS repository file handling </td> </tr> -</table> - -<a name="LibTWikiPlugins"></a> - -#### <a name="Files_in_twiki_lib_TWiki_Plugins"> Files in `twiki/lib/TWiki/Plugins` </a> - -<table border="1" cellpadding="1" cellspacing="0"> - <tr> - <th bgcolor="#99CCCC"><strong>File:</strong></th> - <th bgcolor="#99CCCC"><strong>Used for:</strong></th> - </tr> <tr> - <td><code><b>DefaultPlugin.pm</b></code></td> + <td><code><b>TWiki/Plugins/DefaultPlugin.pm</b></code></td> <td> Default plugin </td> </tr> <tr> - <td><code><b>EmptyPlugin.pm</b></code></td> + <td><code><b>TWiki/Plugins/EmptyPlugin.pm</b></code></td> <td> Empty plugin, use to create your own </td> </tr> <tr> - <td><code><b>InterwikiPlugin.pm</b></code></td> + <td><code><b>TWiki/Plugins/InterwikiPlugin.pm</b></code></td> <td> Refer to external Wikis and other Web sites </td> </tr> </table> <a name="PubFiles"></a> -#### <a name="Files_in_twiki_pub_code_"> Files in `twiki/pub` </a> +#### <a name="Files_under_twiki_pub_code_"> Files under `twiki/pub` </a> <table border="1" cellpadding="1" cellspacing="0"> <tr> <th bgcolor="#99CCCC"><strong>File:</strong></th> <th bgcolor="#99CCCC"><strong>Used for:</strong></th> </tr> -</table> - -<table border="1" cellpadding="1" cellspacing="0"> <tr> <td><code><b>favicon.ico</b></code></td> <td> xxxx </td> @@ -493,7 +470,7 @@ You can easily rename the root TWiki directory - <code>**twiki**</code> - to wha <a name="DataFiles"></a> -#### <a name="Files_in_twiki_data_code_"> Files in `twiki/data` </a> +#### <a name="Files_under_twiki_data_code_"> Files under `twiki/data` </a> <table border="1" cellpadding="1" cellspacing="0"> <tr> |