From 75c61282ff7265c0abcd88f96dd33b32934e56c1 Mon Sep 17 00:00:00 2001 From: MikeMannix Date: Wed, 5 Sep 2001 11:01:11 +0000 Subject: none --- TWiki/TWikiImplementationNotes.mdwn | 574 +++++++++++++++--------------------- 1 file changed, 231 insertions(+), 343 deletions(-) (limited to 'TWiki') 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 @@ ## TWiki Operating Environment -Server and client system requirements, file system structure +_Server and client system requirements, file system structure_ ### Overview -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. ### Server-Side Requirements -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. - + @@ -40,74 +40,30 @@ TWiki is written in **Perl 5** and uses a number of **shell commands**. It requi - - - - - - - - - - - +
Required Server Environment by PlatformRequired Server Environment
Resource
Web server Apache and others (support for cgi, authentication, extended path) *
OS versionsLinux, Unix...every last Win?!
Required disk space     Apache; others (with support for CGI, authentication, extended path) *
-**_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. -## Client-Side Requirements +### Client-Side Requirements -The basic TWiki engine and templates have a low requirement on the browser: +The TWiki standard installation has extremely low browser requirements: - - - - - - - - -
Recommend PC Requirement
ComponentMin/Rec
+* HTML 3.2 compliant +* minimal use of JavaScript in the user interface (degrades gracefully) +* no cookies +* no CSS - - - - - - - - - - - - - - - - - - - - - - - - -
Browser Requirements
ResourceDetails
HTML 3.2 browser  
JavaScript 1.? Optional: JS degrades gracefully
Cookies Not used
CSS1/2 ????
+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. +#### Known Issues -**_WHAT ABOUT WEB STANDARDS BROWSER COMPATIBILITY MOVEMENT & CSS CONTROL_** - -### Known Issues - -* 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. ### TWiki File System -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: +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: @@ -116,44 +72,44 @@ You can rename the root TWiki directory - **twiki** - to whatever y - + - + - + - + - + - +
Used for:
twikitwiki list Start-up info
twiki/bintwiki/bin list Perl scripts
twiki/libtwiki/lib list Configuration file, main library, Perl system modules, Plugins
twiki/pubtwiki/pub list Public support files (ex: File Attachments?, images) and RCS histories)
twiki/datatwiki/data list Topic text (page content) and RCS histories;
twiki/templatestwiki/templates list HTML templates, used by TWiki scripts
-### File Descriptions +#### File Descriptions -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 **data** 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. -#### Files in `twiki` +##### Files in `twiki` Introductory and installation files. @@ -163,30 +119,30 @@ Introductory and installation files. Used for: - index.html + index.html A page with a link to first launch TWiki after install - license.txt + license.txt GNU General Public License and TWiki-specific info - readme.txt + readme.txt General TWiki start-up info with relevant URLs. - TWikiDocumentation.html + TWikiDocumentation.html All documentation packaged as a single page - TWikiHistory.html + TWikiHistory.html TWiki development timeline -#### Files in `twiki/bin` +##### Files in `twiki/bin` All Perl CGI scripts. @@ -196,84 +152,84 @@ All Perl CGI scripts. Used for: - .htaccess.txt + .htaccess.txt Authentication. Rename to .htaccess and customize if used - attach + attach Script that shows the attach file page (File Attachment?) - delete + delete (not used yet) - edit + edit Script to edit a topic - geturl + geturl Script to fetch URL data - mailnotify + mailnotify Script called by cron job to notify users of changes - oops + oops Script that shows an OK or oops dialog - preview + preview Script to preview topic after edit - rdiff + rdiff Script to see differences of topics - rename + rename Script to rename/move topics and move attachments - register + register Script to register new users - save + save Script that saves a topic, called by preview - search + search Script that displays search results - statistics + statistics Script to create statistics topic - testenv + testenv Script to test CGI environment variables - upload + upload Script that does file upload (File Attachment?) - view + view Script to view a topic ( the script ) - viewfile + viewfile Script to view an file attachment -#### Files under `twiki/lib` +##### Files under `twiki/lib` -The new **lib/TWiki/Plugins** 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. @@ -281,62 +237,62 @@ The new **lib/TWiki/Plugins** directories contain core configuratio - + - - + + - + - + - + - + - + - + - + - + - + - + - +
Used for:
TWiki.pmTWiki.pm Main TWiki library
TWiki.cfg For configuration, used by TWiki.pmTWiki.cfg For configuration, used by TWiki.pm
TWiki/Access.pmTWiki/Access.pm Access control
TWiki/Attach.pmTWiki/Attach.pm Attachment handling
TWiki/Meta.pmTWiki/Meta.pm Meta data in topics
TWiki/Net.pmTWiki/Net.pm SMTP mail handling
TWiki/Plugins.pmTWiki/Plugins.pm Plugin handling
TWiki/Prefs.pmTWiki/Prefs.pm Preferences handling
TWiki/Search.pmTWiki/Search.pm Search engine, used by wiki.pm
TWiki/Store.pmTWiki/Store.pm Back-end storage, *.txt text file and *.txt,v RCS repository file handling
TWiki/Plugins/DefaultPlugin.pmTWiki/Plugins/DefaultPlugin.pm Default plugin
TWiki/Plugins/EmptyPlugin.pmTWiki/Plugins/EmptyPlugin.pm Empty plugin, use to create your own
TWiki/Plugins/InterwikiPlugin.pmTWiki/Plugins/InterwikiPlugin.pm Refer to external Wikis and other Web sites
-#### Files under `twiki/pub` +##### Files under `twiki/pub` **_attachments like images..._** @@ -346,184 +302,184 @@ The new **lib/TWiki/Plugins** directories contain core configuratio Used for: - favicon.ico + favicon.ico xxxx - twikilogo.gif + twikilogo.gif xxxx - twikilogo1.gif + twikilogo1.gif xxxx - twikilogo2.gif + twikilogo2.gif xxxx - twikilogo3.gif + twikilogo3.gif xxxx - twikilogo4.gif + twikilogo4.gif xxxx - wikiHome.gif + wikiHome.gif xxxx - icn/_filetypes.txt + icn/_filetypes.txt xxxx - icn/bat.gif + icn/bat.gif xxxx - icn/bmp.gif + icn/bmp.gif xxxx - icn/c.gif + icn/c.gif xxxx - icn/dll.gif + icn/dll.gif xxxx - icn/doc.gif + icn/doc.gif xxxx - icn/else.gif + icn/else.gif xxxx - icn/exe.gif + icn/exe.gif xxxx - icn/fon.gif + icn/fon.gif xxxx - icn/h.gif + icn/h.gif xxxx - icn/hlp.gif + icn/hlp.gif xxxx - icn/html.gif + icn/html.gif xxxx - icn/java.gif + icn/java.gif xxxx - icn/mov.gif + icn/mov.gif xxxx - icn/pdf.gif + icn/pdf.gif xxxx - icn/pl.gif + icn/pl.gif xxxx - icn/ppt.gif + icn/ppt.gif xxxx - icn/ps.gif + icn/ps.gif xxxx - icn/py.gif + icn/py.gif xxxx - icn/ram.gif + icn/ram.gif xxxx - icn/reg.gif + icn/reg.gif xxxx - icn/sh.gif + icn/sh.gif xxxx - icn/sniff.gif + icn/sniff.gif xxxx - icn/ttf.gif + icn/ttf.gif xxxx - icn/txt.gif + icn/txt.gif xxxx - icn/wav.gif + icn/wav.gif xxxx - icn/wri.gif + icn/wri.gif xxxx - icn/xls.gif + icn/xls.gif xxxx - icn/zip.gif + icn/zip.gif xxxx - Know/IncorrectDllVersionW32PTH10DLL/W32PTH10.DLL + Know/IncorrectDllVersionW32PTH10DLL/W32PTH10.DLL xxxx - TWiki/FileAttachment/Sample.txt + TWiki/FileAttachment/Sample.txt xxxx - TWiki/FileAttachment/Smile.gif + TWiki/FileAttachment/Smile.gif xxxx - TWiki/PreviewBackground/blankltgraybg.gif + TWiki/PreviewBackground/blankltgraybg.gif xxxx - TWiki/PreviewBackground/blankwhitebg.gif + TWiki/PreviewBackground/blankwhitebg.gif xxxx - TWiki/PreviewBackground/previewbg.gif + TWiki/PreviewBackground/previewbg.gif xxxx - TWiki/WabiSabi/wabisabi.gif + TWiki/WabiSabi/wabisabi.gif xxxx -#### Files under `twiki/data` +##### Files under `twiki/data` -The **data** 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..._ @@ -531,304 +487,236 @@ The **data** directory stores the content of TWiki pages as individ - - - - - - - - - - - - - - - - - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - - - - - - - - - + - + - + - + - - + + - + - + - + - + - - - - - + - + - + - + - + - + - - + + - + - + - + - - - - - + - + - + - - + + - + - + - + - + - - + + - + - + - + - + - - + + - + - - - - - + - - + + - + - + - + - - - - - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + +
Used for:
.htpasswd xxxx
debug.txt xxxx
mime.types xxxx
warning.txt xxxx
_default/.changes.htpasswd xxxx
_default/WebChanges.txtdebug.txt xxxx
_default/WebChanges.txt,vmime.types xxxx
_default/WebHome.txtwarning.txt xxxx
_default/WebHome.txt,v_default/.changes xxxx
_default/WebIndex.txt_default/WebChanges.txt xxxx
_default/WebIndex.txt,v_default/WebChanges.txt,v xxxx
_default/WebNotify.txt_default/WebHome.txt xxxx
_default/WebNotify.txt,v_default/WebHome.txt,v xxxx
_default/WebPreferences.txt_default/WebIndex.txt xxxx
_default/WebPreferences.txt,v_default/WebIndex.txt,v xxxx
_default/WebSearch.txt_default/WebNotify.txt xxxx
_default/WebSearch.txt,v_default/WebNotify.txt,v xxxx
_default/WebStatistics.txt_default/WebPreferences.txt xxxx
_default/WebStatistics.txt,v_default/WebPreferences.txt,v xxxx
... ...
Know/TopicClassification.txt xxxx
Know/TopicClassification.txt,v_default/WebSearch.txt xxxx
Know/TWikiCategory.txt_default/WebSearch.txt,v xxxx
Know/TWikiCategory.txt,v_default/WebStatistics.txt xxxx
Know/UseCategory.txt_default/WebStatistics.txt,v xxxx
Know/UseCategory.txt,v xxxx ......
Know/WebChanges.txtKnow/TopicClassification.txt xxxx
Know/WebChanges.txt,vKnow/TopicClassification.txt,v xxxx
Know/WebForm.txtKnow/TWikiCategory.txt xxxx
Know/WebForm.txt,vKnow/TWikiCategory.txt,v xxxx
... ...
Main/NicholasLee.txtKnow/UseCategory.txt xxxx
Main/NicholasLee.txt,vKnow/UseCategory.txt,v xxxx
Main/NobodyGroup.txtKnow/WebChanges.txt xxxx
Main/NobodyGroup.txt,vKnow/WebChanges.txt,v xxxx
Main/OfficeLocations.txtKnow/WebForm.txt xxxx
Main/OfficeLocations.txt,vKnow/WebForm.txt,v xxxx
Main/PeterThoeny.txt xxxx ......
Main/PeterThoeny.txt,vMain/OfficeLocations.txt xxxx
Main/SanJoseOffice.txtMain/OfficeLocations.txt,v xxxx
Main/SanJoseOffice.txt,vMain/PeterThoeny.txt xxxx
... ...
Main/TWikiGroups.txtMain/PeterThoeny.txt,v xxxx
Main/TWikiGroups.txt,vMain/SanJoseOffice.txt xxxx
Main/TWikiGuest.txtMain/SanJoseOffice.txt,v xxxx
Main/TWikiGuest.txt,v xxxx ......
Main/TWikiUsers.txtMain/TWikiGuest.txt xxxx
Main/TWikiUsers.txt,vMain/TWikiGuest.txt,v xxxx
Main/TWikiVariables.txtMain/TWikiUsers.txt xxxx
Main/TWikiVariables.txt,vMain/TWikiUsers.txt,v xxxx
... ... ......
Test/TestTopic1.txtTest/TestTopic1.txt xxxx
Test/TestTopic1.txt,vTest/TestTopic1.txt,v xxxx
Test/WebChanges.txtTest/WebHome.txt xxxx
Test/WebChanges.txt,vTest/WebHome.txt,v xxxx
Test/WebHome.txt xxxx ......
Test/WebHome.txt,vTrash/WebHome.txt xxxx
... ...
Trash/.changesTrash/WebHome.txt,v xxxx
Trash/WebChanges.txt xxxx ......
Trash/WebChanges.txt,vTWiki/DeleteTopic.txt xxxx
Trash/WebHome.txtTWiki/DeleteTopic.txt,v xxxx
Trash/WebHome.txt,vTWiki/DontNotify.txt xxxx
... ...
TWiki/AlWilliams.txtTWiki/DontNotify.txt,v xxxx
TWiki/AlWilliams.txt,v xxxx
TWiki/AndreaSterbini.txt xxxx
TWiki/AndreaSterbini.txt,v xxxx
... ...
TWiki/DeleteTopic.txt xxxx
TWiki/DeleteTopic.txt,v xxxx
TWiki/DontNotify.txt xxxx
TWiki/DontNotify.txt,v xxxx ......
-#### Files in `twiki/templates` +##### Files in `twiki/templates` -**_Used to flexibly control appearance of rendered pages..._** +_Used to flexibly control appearance of rendered pages..._ @@ -836,223 +724,223 @@ The **data** directory stores the content of TWiki pages as individ - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - + - +
Used for:
oopsbadpwformat.tmploopsbadpwformat.tmpl xxxx
attachagain.tmplattachagain.tmpl xxxx
attachnew.tmplattachnew.tmpl xxxx
changeform.tmplchangeform.tmpl xxxx
changes.tmplchanges.tmpl xxxx
edit.iejs.tmpledit.iejs.tmpl xxxx
edit.tmpledit.tmpl xxxx
mailnotify.tmplmailnotify.tmpl xxxx
moveattachment.tmplmoveattachment.tmpl xxxx
oopsaccesschange.tmploopsaccesschange.tmpl xxxx
oopsaccessgroup.tmploopsaccessgroup.tmpl xxxx
oopsaccessrename.tmploopsaccessrename.tmpl xxxx
oopsaccessview.tmploopsaccessview.tmpl xxxx
oopsauth.tmploopsauth.tmpl xxxx
attach.tmplattach.tmpl xxxx
oopschangepasswd.tmploopschangepasswd.tmpl xxxx
oopsempty.tmploopsempty.tmpl xxxx
oopslocked.tmploopslocked.tmpl xxxx
oopslockedrename.tmploopslockedrename.tmpl xxxx
oopsmissing.tmploopsmissing.tmpl xxxx
oopsmoveerr.tmploopsmoveerr.tmpl xxxx
oopsnoformdef.tmploopsnoformdef.tmpl xxxx
oopsnotwikiuser.tmploopsnotwikiuser.tmpl xxxx
oopsnoweb.tmploopsnoweb.tmpl xxxx
oopspreview.tmploopspreview.tmpl xxxx
oopsregexist.tmploopsregexist.tmpl xxxx
oopsregpasswd.tmploopsregpasswd.tmpl xxxx
oopsregrequ.tmploopsregrequ.tmpl xxxx
oopsregthanks.tmploopsregthanks.tmpl xxxx
oopsregwiki.tmploopsregwiki.tmpl xxxx
oopsrenameerr.tmploopsrenameerr.tmpl xxxx
oopsresetpasswd.tmploopsresetpasswd.tmpl xxxx
oopsrev.tmploopsrev.tmpl xxxx
oopssave.tmploopssave.tmpl xxxx
oopssaveerr.tmploopssaveerr.tmpl xxxx
oopssendmailerr.tmploopssendmailerr.tmpl xxxx
oopstopicexists.tmploopstopicexists.tmpl xxxx
oopsupload.tmploopsupload.tmpl xxxx
oopswrongpassword.tmploopswrongpassword.tmpl xxxx
preview.tmplpreview.tmpl xxxx
rdiff.tmplrdiff.tmpl xxxx
register.tmplregister.tmpl xxxx
registernotify.tmplregisternotify.tmpl xxxx
rename.tmplrename.tmpl xxxx
renamebase.tmplrenamebase.tmpl xxxx
renameconfirm.tmplrenameconfirm.tmpl xxxx
renamerefs.tmplrenamerefs.tmpl xxxx
search.tmplsearch.tmpl xxxx
searchbookview.tmplsearchbookview.tmpl xxxx
searchmeta.tmplsearchmeta.tmpl xxxx
searchrenameview.tmplsearchrenameview.tmpl xxxx
twiki.tmpltwiki.tmpl xxxx
view.plain.tmplview.plain.tmpl xxxx
view.print.tmplview.print.tmpl xxxx
view.tmplview.tmpl xxxx
-- cgit v1.2.3