diff options
| -rw-r--r-- | TWiki/TWikiImplementationNotes.mdwn | 440 |
1 files changed, 96 insertions, 344 deletions
diff --git a/TWiki/TWikiImplementationNotes.mdwn b/TWiki/TWikiImplementationNotes.mdwn index d30b789d..8dde8834 100644 --- a/TWiki/TWikiImplementationNotes.mdwn +++ b/TWiki/TWikiImplementationNotes.mdwn @@ -1,8 +1,8 @@ %TOC% %STARTINCLUDE% -# <a name="TWiki_Operating_Environment"> TWiki Operating Environment </a> +# <a name="TWiki_Application_Environment"> TWiki Application Environment </a> -_Server and client system requirements, file system structure_ +_Server and client system requirements; file system structure_ ## <a name="Overview"> Overview </a> @@ -105,13 +105,13 @@ You can rename the root TWiki directory - `twiki` - to whatever you like by chan ### <a name="File_Descriptions"> File Descriptions </a> -A rundown of the individual files in the current %VERSION% distribution, organized by TWiki root directories. All listings are complete unless otherwise noted. +A rundown of the individual files included in the current 01-Sep-2001 distribution, organized by TWiki root directories. <a name="TWikiFiles"></a> #### <a name="Files_in_twiki_code_"> Files in `twiki` </a> -Introductory and installation files. +Application info and the current reference documentation. _Full file list:_ <table border="1" cellpadding="1" cellspacing="0"> <tr> @@ -128,7 +128,7 @@ Introductory and installation files. </tr> <tr> <td><code>readme.txt</code></td> - <td> General TWiki start-up info with relevant URLs. </td> + <td> General TWiki start-up info with relevant URLs </td> </tr> <tr> <td><code>TWikiDocumentation.html</code></td> @@ -144,7 +144,7 @@ Introductory and installation files. #### <a name="Files_in_twiki_bin_code_"> Files in `twiki/bin` </a> -All Perl CGI scripts. +Perl CGI scripts. _Full file list:_ <table border="1" cellpadding="1" cellspacing="0"> <tr> @@ -229,7 +229,7 @@ All Perl CGI scripts. #### <a name="Files_under_twiki_lib_code_"> Files under `twiki/lib` </a> -The new `lib/TWiki/Plugins` directories contain core configuration, libraries and function modules, and Plugins. +The new `lib/TWiki/Plugins` directories contain configuration, library and function files, and [[TWikiDocumentation]]. _Full file list:_ <table border="1" cellpadding="1" cellspacing="0"> <tr> @@ -282,7 +282,7 @@ The new `lib/TWiki/Plugins` directories contain core configuration, libraries an </tr> <tr> <td><code>TWiki/Plugins/DefaultPlugin.pm</code></td> - <td> Default plugin </td> + <td> Handles some legacy rules </td> </tr> <tr> <td><code>TWiki/Plugins/EmptyPlugin.pm</code></td> @@ -290,7 +290,7 @@ The new `lib/TWiki/Plugins` directories contain core configuration, libraries an </tr> <tr> <td><code>TWiki/Plugins/InterwikiPlugin.pm</code></td> - <td> Refer to external Wikis and other Web sites </td> + <td> Use aliases as links for predefined URLs </td> </tr> </table> @@ -298,7 +298,7 @@ The new `lib/TWiki/Plugins` directories contain core configuration, libraries an #### <a name="Files_under_twiki_pub_code_"> Files under `twiki/pub` </a> -**_attachments like images..._** +The `pub` directory stores data-related files, including images used by TWiki and [[FileAttachments]]. Attachments are stored in sub-directories created with the related topic name. _Partial file list:_ <table border="1" cellpadding="1" cellspacing="0"> <tr> @@ -307,175 +307,71 @@ The new `lib/TWiki/Plugins` directories contain core configuration, libraries an </tr> <tr> <td><code>favicon.ico</code></td> - <td> xxxx </td> + <td> ICO file </td> </tr> <tr> <td><code>twikilogo.gif</code></td> - <td> xxxx </td> + <td> GIF file </td> </tr> <tr> <td><code>twikilogo1.gif</code></td> - <td> xxxx </td> + <td> GIF file </td> </tr> <tr> <td><code>twikilogo2.gif</code></td> - <td> xxxx </td> + <td> GIF file </td> </tr> <tr> <td><code>twikilogo3.gif</code></td> - <td> xxxx </td> + <td> GIF file </td> </tr> <tr> <td><code>twikilogo4.gif</code></td> - <td> xxxx </td> + <td> GIF file </td> </tr> <tr> <td><code>wikiHome.gif</code></td> - <td> xxxx </td> + <td> GIF file </td> </tr> <tr> <td><code>icn/_filetypes.txt</code></td> - <td> xxxx </td> + <td> GIF file </td> </tr> <tr> <td><code>icn/bat.gif</code></td> - <td> xxxx </td> + <td> GIF file </td> </tr> <tr> <td><code>icn/bmp.gif</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>icn/c.gif</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>icn/dll.gif</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>icn/doc.gif</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>icn/else.gif</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>icn/exe.gif</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>icn/fon.gif</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>icn/h.gif</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>icn/hlp.gif</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>icn/html.gif</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>icn/java.gif</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>icn/mov.gif</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>icn/pdf.gif</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>icn/pl.gif</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>icn/ppt.gif</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>icn/ps.gif</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>icn/py.gif</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>icn/ram.gif</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>icn/reg.gif</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>icn/sh.gif</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>icn/sniff.gif</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>icn/ttf.gif</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>icn/txt.gif</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>icn/wav.gif</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>icn/wri.gif</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>icn/xls.gif</code></td> - <td> xxxx </td> + <td> GIF file </td> </tr> <tr> - <td><code>icn/zip.gif</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>Know/IncorrectDllVersionW32PTH10DLL/W32PTH10.DLL</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>TWiki/FileAttachment/Sample.txt</code></td> - <td> xxxx </td> + <td> TEXT file </td> </tr> <tr> <td><code>TWiki/FileAttachment/Smile.gif</code></td> - <td> xxxx </td> + <td> GIF file </td> </tr> <tr> <td><code>TWiki/PreviewBackground/blankltgraybg.gif</code></td> - <td> xxxx </td> + <td> GIF file </td> </tr> <tr> <td><code>TWiki/PreviewBackground/blankwhitebg.gif</code></td> - <td> xxxx </td> + <td> GIF file </td> </tr> <tr> <td><code>TWiki/PreviewBackground/previewbg.gif</code></td> - <td> xxxx </td> + <td> GIF file </td> </tr> <tr> <td><code>TWiki/WabiSabi/wabisabi.gif</code></td> - <td> xxxx </td> + <td> GIF file </td> </tr> </table> @@ -483,7 +379,7 @@ The new `lib/TWiki/Plugins` directories contain core configuration, libraries an #### <a name="Files_under_twiki_data_code_"> Files under `twiki/data` </a> -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..._ +TWiki page data stored as individual text files. Each active web has its own subdirectory. The TWiki distribution includes four start-up webs - `Main`, `TWiki`, `Know`, `Test` - with documentation and demo content, and a `_default` directory containing all topics required to start a new web. _Partial file list:_ <table border="1" cellpadding="1" cellspacing="0"> <tr> @@ -492,226 +388,82 @@ The `data` directory stores TWiki page data as individual text files. Each activ </tr> <tr> <td><code>.htpasswd</code></td> - <td> xxxx </td> + <td> Basic Authentication (htaccess) password file </td> </tr> <tr> <td><code>debug.txt</code></td> - <td> xxxx </td> + <td> Program messages useful for debugging </td> </tr> <tr> <td><code>mime.types</code></td> - <td> xxxx </td> + <td> Recognized file formats </td> </tr> <tr> <td><code>warning.txt</code></td> - <td> xxxx </td> + <td> Diagnostic messages for identifying problems </td> </tr> <tr> <td colspan="2"> _default directory can be copied to empty directory when creating new Webs </td> </tr> <tr> <td><code>_default/.changes</code></td> - <td> Record of topic changes recorded here </td> + <td> Web-level record of topic changes </td> </tr> <tr> <td><code>_default/WebChanges.txt</code></td> - <td> Display most recent changes </td> + <td> Display most recent topic changes in web </td> </tr> <tr> <td><code>_default/WebChanges.txt,v</code></td> - <td> History </td> + <td> Revisions history (RCS) </td> </tr> <tr> <td><code>_default/WebHome.txt</code></td> - <td> xxxx </td> + <td> Default web home page </td> </tr> <tr> <td><code>_default/WebHome.txt,v</code></td> - <td> xxxx </td> + <td> Revisions history (RCS) </td> </tr> <tr> <td><code>_default/WebIndex.txt</code></td> - <td> xxxx </td> + <td> Lists all topics in a web </td> </tr> <tr> <td><code>_default/WebIndex.txt,v</code></td> - <td> xxxx </td> + <td> Revisions history (RCS) </td> </tr> <tr> <td><code>_default/WebNotify.txt</code></td> - <td> xxxx </td> + <td> Subscribe/unsubscribe to web changes email alert </td> </tr> <tr> <td><code>_default/WebNotify.txt,v</code></td> - <td> xxxx </td> + <td> Revisions history (RCS) </td> </tr> <tr> <td><code>_default/WebPreferences.txt</code></td> - <td> xxxx </td> + <td> Web-level preference settings </td> </tr> <tr> <td><code>_default/WebPreferences.txt,v</code></td> - <td> xxxx </td> + <td> Revisions history (RCS) </td> </tr> <tr> <td><code>_default/WebSearch.txt</code></td> - <td> xxxx </td> + <td> Web-level search options </td> </tr> <tr> <td><code>_default/WebSearch.txt,v</code></td> - <td> xxxx </td> + <td> Revisions history (RCS) </td> </tr> <tr> <td><code>_default/WebStatistics.txt</code></td> - <td> xxxx </td> + <td> Generates web usage statistics </td> </tr> <tr> <td><code>_default/WebStatistics.txt,v</code></td> - <td> xxxx </td> - </tr> - <tr> - <th align="center" bgcolor="#99CCCC"><strong>...</strong></th> - <th align="center" bgcolor="#99CCCC"><strong>...</strong></th> - </tr> - <tr> - <td><code>Know/TopicClassification.txt</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>Know/TopicClassification.txt,v</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>Know/TWikiCategory.txt</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>Know/TWikiCategory.txt,v</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>Know/UseCategory.txt</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>Know/UseCategory.txt,v</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>Know/WebChanges.txt</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>Know/WebChanges.txt,v</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>Know/WebForm.txt</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>Know/WebForm.txt,v</code></td> - <td> xxxx </td> - </tr> - <tr> - <th align="center" bgcolor="#99CCCC"><strong>...</strong></th> - <th align="center" bgcolor="#99CCCC"><strong>...</strong></th> - </tr> - <tr> - <td><code>Main/OfficeLocations.txt</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>Main/OfficeLocations.txt,v</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>Main/PeterThoeny.txt</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>Main/PeterThoeny.txt,v</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>Main/SanJoseOffice.txt</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>Main/SanJoseOffice.txt,v</code></td> - <td> xxxx </td> - </tr> - <tr> - <th align="center" bgcolor="#99CCCC"><strong>...</strong></th> - <th align="center" bgcolor="#99CCCC"><strong>...</strong></th> - </tr> - <tr> - <td><code>Main/TWikiGuest.txt</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>Main/TWikiGuest.txt,v</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>Main/TWikiUsers.txt</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>Main/TWikiUsers.txt,v</code></td> - <td> xxxx </td> - </tr> - <tr> - <th align="center" bgcolor="#99CCCC"><strong>...</strong></th> - <th align="center" bgcolor="#99CCCC"><strong>...</strong></th> - </tr> - <tr> - <td><code>Test/TestTopic1.txt</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>Test/TestTopic1.txt,v</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>Test/WebHome.txt</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>Test/WebHome.txt,v</code></td> - <td> xxxx </td> - </tr> - <tr> - <th align="center" bgcolor="#99CCCC"><strong>...</strong></th> - <th align="center" bgcolor="#99CCCC"><strong>...</strong></th> - </tr> - <tr> - <td><code>Trash/WebHome.txt</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>Trash/WebHome.txt,v</code></td> - <td> xxxx </td> - </tr> - <tr> - <th align="center" bgcolor="#99CCCC"><strong>...</strong></th> - <th align="center" bgcolor="#99CCCC"><strong>...</strong></th> - </tr> - <tr> - <td><code>TWiki/DeleteTopic.txt</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>TWiki/DeleteTopic.txt,v</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>TWiki/DontNotify.txt</code></td> - <td> xxxx </td> - </tr> - <tr> - <td><code>TWiki/DontNotify.txt,v</code></td> - <td> xxxx </td> + <td> Revisions history (RCS) </td> </tr> <tr> <th align="center" bgcolor="#99CCCC"><strong>...</strong></th> @@ -723,7 +475,7 @@ The `data` directory stores TWiki page data as individual text files. Each activ #### <a name="Files_in_twiki_templates_code_"> Files in `twiki/templates` </a> -_Used to flexibly control appearance of rendered pages..._ +Templates used to control appearance of all rendered pages. _Full file list:_ <table border="1" cellpadding="1" cellspacing="0"> <tr> @@ -732,23 +484,23 @@ _Used to flexibly control appearance of rendered pages..._ </tr> <tr> <td><code>oopsbadpwformat.tmpl</code></td> - <td> xxxx </td> + <td> Error message </td> </tr> <tr> <td><code>attachagain.tmpl</code></td> - <td> xxxx </td> + <td> Control screen </td> </tr> <tr> <td><code>attachnew.tmpl</code></td> - <td> xxxx </td> + <td> Control screen </td> </tr> <tr> <td><code>changeform.tmpl</code></td> - <td> xxxx </td> + <td> Control screen </td> </tr> <tr> <td><code>changes.tmpl</code></td> - <td> xxxx </td> + <td> Displays <span style="background:"><font color="">Web Changes</font></span><a href="http://LOCATION/WebChanges">?</a> list of recently changed topics </td> </tr> <tr> <td><code>edit.iejs.tmpl</code></td> @@ -756,7 +508,7 @@ _Used to flexibly control appearance of rendered pages..._ </tr> <tr> <td><code>edit.tmpl</code></td> - <td> xxxx </td> + <td> Main edit window </td> </tr> <tr> <td><code>mailnotify.tmpl</code></td> @@ -764,139 +516,139 @@ _Used to flexibly control appearance of rendered pages..._ </tr> <tr> <td><code>moveattachment.tmpl</code></td> - <td> xxxx </td> + <td> Control screen </td> </tr> <tr> <td><code>oopsaccesschange.tmpl</code></td> - <td> xxxx </td> + <td> Error message </td> </tr> <tr> <td><code>oopsaccessgroup.tmpl</code></td> - <td> xxxx </td> + <td> Error message </td> </tr> <tr> <td><code>oopsaccessrename.tmpl</code></td> - <td> xxxx </td> + <td> Error message </td> </tr> <tr> <td><code>oopsaccessview.tmpl</code></td> - <td> xxxx </td> + <td> Error message </td> </tr> <tr> <td><code>oopsauth.tmpl</code></td> - <td> xxxx </td> + <td> Error message </td> </tr> <tr> <td><code>attach.tmpl</code></td> - <td> xxxx </td> + <td> Error message </td> </tr> <tr> <td><code>oopschangepasswd.tmpl</code></td> - <td> xxxx </td> + <td> Error message </td> </tr> <tr> <td><code>oopsempty.tmpl</code></td> - <td> xxxx </td> + <td> Error message </td> </tr> <tr> <td><code>oopslocked.tmpl</code></td> - <td> xxxx </td> + <td> Error message </td> </tr> <tr> <td><code>oopslockedrename.tmpl</code></td> - <td> xxxx </td> + <td> Error message </td> </tr> <tr> <td><code>oopsmissing.tmpl</code></td> - <td> xxxx </td> + <td> Error message </td> </tr> <tr> <td><code>oopsmoveerr.tmpl</code></td> - <td> xxxx </td> + <td> Error message </td> </tr> <tr> <td><code>oopsnoformdef.tmpl</code></td> - <td> xxxx </td> + <td> Error message </td> </tr> <tr> <td><code>oopsnotwikiuser.tmpl</code></td> - <td> xxxx </td> + <td> Error message </td> </tr> <tr> <td><code>oopsnoweb.tmpl</code></td> - <td> xxxx </td> + <td> Error message </td> </tr> <tr> <td><code>oopspreview.tmpl</code></td> - <td> xxxx </td> + <td> Error message </td> </tr> <tr> <td><code>oopsregexist.tmpl</code></td> - <td> xxxx </td> + <td> Error message </td> </tr> <tr> <td><code>oopsregpasswd.tmpl</code></td> - <td> xxxx </td> + <td> Error message </td> </tr> <tr> <td><code>oopsregrequ.tmpl</code></td> - <td> xxxx </td> + <td> Error message </td> </tr> <tr> <td><code>oopsregthanks.tmpl</code></td> - <td> xxxx </td> + <td> Error message </td> </tr> <tr> <td><code>oopsregwiki.tmpl</code></td> - <td> xxxx </td> + <td> Error message </td> </tr> <tr> <td><code>oopsrenameerr.tmpl</code></td> - <td> xxxx </td> + <td> Error message </td> </tr> <tr> <td><code>oopsresetpasswd.tmpl</code></td> - <td> xxxx </td> + <td> Error message </td> </tr> <tr> <td><code>oopsrev.tmpl</code></td> - <td> xxxx </td> + <td> Error message </td> </tr> <tr> <td><code>oopssave.tmpl</code></td> - <td> xxxx </td> + <td> Error message </td> </tr> <tr> <td><code>oopssaveerr.tmpl</code></td> - <td> xxxx </td> + <td> Error message </td> </tr> <tr> <td><code>oopssendmailerr.tmpl</code></td> - <td> xxxx </td> + <td> Error message </td> </tr> <tr> <td><code>oopstopicexists.tmpl</code></td> - <td> xxxx </td> + <td> Error message </td> </tr> <tr> <td><code>oopsupload.tmpl</code></td> - <td> xxxx </td> + <td> Error message </td> </tr> <tr> <td><code>oopswrongpassword.tmpl</code></td> - <td> xxxx </td> + <td> Error message </td> </tr> <tr> <td><code>preview.tmpl</code></td> - <td> xxxx </td> + <td> Preview Changes screen </td> </tr> <tr> <td><code>rdiff.tmpl</code></td> - <td> xxxx </td> + <td> Displays text changes before &amp; after (Diffs) </td> </tr> <tr> <td><code>register.tmpl</code></td> - <td> xxxx </td> + <td> Registration page </td> </tr> <tr> <td><code>registernotify.tmpl</code></td> @@ -912,11 +664,11 @@ _Used to flexibly control appearance of rendered pages..._ </tr> <tr> <td><code>renameconfirm.tmpl</code></td> - <td> Confirming a pre-specified rename e.g. when undoing a rename </td> + <td> Confirms a pre-specified rename, ex: undoing a rename </td> </tr> <tr> <td><code>renamerefs.tmpl</code></td> - <td> Rename done, still some references to change (topcis were previously locked) </td> + <td> Rename done, but some references not changed (topics were locked) </td> </tr> <tr> <td><code>search.tmpl</code></td> @@ -924,7 +676,7 @@ _Used to flexibly control appearance of rendered pages..._ </tr> <tr> <td><code>searchbookview.tmpl</code></td> - <td> xxxx </td> + <td> Search results with full topic content </td> </tr> <tr> <td><code>searchmeta.tmpl</code></td> @@ -936,19 +688,19 @@ _Used to flexibly control appearance of rendered pages..._ </tr> <tr> <td><code>twiki.tmpl</code></td> - <td> xxxx </td> + <td> Base template definitions used by other templates </td> </tr> <tr> <td><code>view.plain.tmpl</code></td> - <td> xxxx </td> + <td> Alternate topic header/footer view </td> </tr> <tr> <td><code>view.print.tmpl</code></td> - <td> xxxx </td> + <td> Alternate topic header/footer view </td> </tr> <tr> <td><code>view.tmpl</code></td> - <td> xxxx </td> + <td> Main topic view </td> </tr> </table> |