From 47886358a8dbf05832d931ea0526e197d33a815f Mon Sep 17 00:00:00 2001 From: MikeMannix Date: Tue, 4 Sep 2001 01:04:17 +0000 Subject: none --- TWiki/TWikiImplementationNotes.mdwn | 1208 ++--------------------------------- 1 file changed, 55 insertions(+), 1153 deletions(-) (limited to 'TWiki') diff --git a/TWiki/TWikiImplementationNotes.mdwn b/TWiki/TWikiImplementationNotes.mdwn index cade6357..1a8c0d2e 100644 --- a/TWiki/TWikiImplementationNotes.mdwn +++ b/TWiki/TWikiImplementationNotes.mdwn @@ -2,7 +2,11 @@ ## TWiki Operating Environment -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. +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. ### Server-Side Requirements @@ -79,7 +83,7 @@ The basic TWiki engine and templates have a low requirement on the browser:   - Java Script? 1.? + JavaScript 1.? Optional: JS degrades gracefully @@ -94,16 +98,16 @@ The basic TWiki engine and templates have a low requirement on the browser: * TWiki generates XHTML 1.0 code as long as it is compatible with HTML 3.2. -**_WHAT ABOUT WEB STANDARDS PROJECT - CSS CONTROL_** +**_WHAT ABOUT WEB STANDARDS BROWSER COMPATIBILITY MOVEMENT & CSS CONTROL_** ### Known Issues -* Some [[TWikiSkins]] may require more, like cookies and [[JavaScript]] +* 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. -### TWiki Directory Structure +### TWiki File System -You can easily 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: @@ -124,17 +128,7 @@ You can easily rename the root TWiki directory - **twiki** - to wha - - - - - - - - - - - + @@ -155,12 +149,14 @@ You can easily rename the root TWiki directory - **twiki** - to wha ### 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. +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. #### Files in `twiki` +Introductory and installation files. +
twiki/lib list Configuration file & main library
twiki/lib/TWiki list Perl modules
twiki/lib/TWiki/Plugins list TWiki Plugins? Perl modules Configuration file, main library, Perl system modules, Plugins
twiki/pub
@@ -168,11 +164,11 @@ A rundown of the individual files in the current %VERSION% distribution, organiz - + - + @@ -180,11 +176,11 @@ A rundown of the individual files in the current %VERSION% distribution, organiz - + - +
File:
index.html A page with a link to first launch TWiki after install. A page with a link to first launch TWiki after install
license.txt Gnu General Public License and TWiki-specific info. GNU General Public License and TWiki-specific info
readme.txt
TWikiDocumentation.html All documentation packaged as a single page. All documentation packaged as a single page
TWikiHistory.html TWiki development timeline. TWiki development timeline
@@ -192,6 +188,8 @@ A rundown of the individual files in the current %VERSION% distribution, organiz #### Files in `twiki/bin` +All Perl CGI scripts. + @@ -275,6 +273,8 @@ A rundown of the individual files in the current %VERSION% distribution, organiz #### Files under `twiki/lib` +The new **lib/TWiki/Plugins** directories contain core configuration, libraries and function modules, and Plugins. +
File:
@@ -338,6 +338,8 @@ A rundown of the individual files in the current %VERSION% distribution, organiz #### Files under `twiki/pub` +**_attachments like images..._** +
File:
@@ -521,6 +523,8 @@ A rundown of the individual files in the current %VERSION% distribution, organiz #### 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..._ +
File:
@@ -603,124 +607,8 @@ A rundown of the individual files in the current %VERSION% distribution, organiz - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + @@ -763,108 +651,8 @@ A rundown of the individual files in the current %VERSION% distribution, organiz - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + @@ -907,20 +695,8 @@ A rundown of the individual files in the current %VERSION% distribution, organiz - - - - - - - - - - - - - - + + @@ -955,68 +731,8 @@ A rundown of the individual files in the current %VERSION% distribution, organiz - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - + + @@ -1043,883 +759,67 @@ A rundown of the individual files in the current %VERSION% distribution, organiz - - + + - + - + - + - + - + - - + + - + - + - + - + - - + + - + - + - + - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - +
File: xxxx
Know/.changes xxxx
Know/.mailnotify xxxx
Know/IncorrectDllVersionW32PTH10DLL.txt xxxx
Know/IncorrectDllVersionW32PTH10DLL.txt,v xxxx
Know/NoDisclosure.txt xxxx
Know/NoDisclosure.txt,v xxxx
Know/OperatingSystem.txt xxxx
Know/OperatingSystem.txt,v xxxx
Know/OsHPUX.txt xxxx
Know/OsHPUX.txt,v xxxx
Know/OsLinux.txt xxxx
Know/OsLinux.txt,v xxxx
Know/OsMacOS.txt xxxx
Know/OsMacOS.txt,v xxxx
Know/OsSolaris.txt xxxx
Know/OsSolaris.txt,v xxxx
Know/OsSunOS.txt xxxx
Know/OsSunOS.txt,v xxxx
Know/OsVersion.txt xxxx
Know/OsVersion.txt,v xxxx
Know/OsWin.txt xxxx
Know/OsWin.txt,v xxxx
Know/PublicFAQ.txt xxxx
Know/PublicFAQ.txt,v xxxx
Know/PublicSupported.txt xxxx
Know/PublicSupported.txt,v xxxx
Know/ReadmeFirst.txt xxxx
Know/ReadmeFirst.txt,v xxxx
Know/SunOS.txt xxxx
Know/SunOS.txt,v xxxx ... ...
Know/TopicClassification.txt xxxx
Know/WebHome.txt xxxx
Know/WebHome.txt,v xxxx
Know/WebIndex.txt xxxx
Know/WebIndex.txt,v xxxx
Know/WebNotify.txt xxxx
Know/WebNotify.txt,v xxxx
Know/WebPreferences.txt xxxx
Know/WebPreferences.txt,v xxxx
Know/WebSearch.txt xxxx
Know/WebSearch.txt,v xxxx
Know/WebStatistics.txt xxxx
Know/WebStatistics.txt,v xxxx
Know/WebTopicEditTemplate.txt xxxx
Know/WebTopicEditTemplate.txt,v xxxx
Know/WinDoze95Crash.txt xxxx
Know/WinDoze95Crash.txt,v xxxx
Main/TWikiAdminGroup.txt,v xxxx
Main/.mailnotify xxxx
Main/FileAttachment.txt xxxx
Main/FileAttachment.txt,v xxxx
Main/JohnTalintyre.txt xxxx
Main/JohnTalintyre.txt,v xxxx
Main/KevinKinnell.txt xxxx
Main/KevinKinnell.txt,v xxxx
Main/LondonOffice.txt xxxx
Main/LondonOffice.txt,v xxxx ... ...
Main/NicholasLee.txt xxxx
Main/TokyoOffice.txt xxxx
Main/TokyoOffice.txt,v xxxx
Main/TWikiAdminGroup.txt xxxx
Main/.changes xxxx ... ...
Main/TWikiGroups.txt xxxx
Main/WebChanges.txt xxxx
Main/WebChanges.txt,v xxxx
Main/WebHome.txt xxxx
Main/WebHome.txt,v xxxx
Main/WebIndex.txt xxxx
Main/WebIndex.txt,v xxxx
Main/WebNotify.txt xxxx
Main/WebNotify.txt,v xxxx
Main/WebPreferences.txt xxxx
Main/WebPreferences.txt,v xxxx
Main/WebSearch.txt xxxx
Main/WebSearch.txt,v xxxx
Main/WebStatistics.txt xxxx
Main/WebStatistics.txt,v xxxx
Test/.changes xxxx
Test/.mailnotify xxxx ... ...
Test/TestTopic1.txt xxxx
Test/WebIndex.txt xxxx ... ...
Test/WebIndex.txt,vTrash/.changes xxxx
Test/WebNotify.txtTrash/WebChanges.txt xxxx
Test/WebNotify.txt,vTrash/WebChanges.txt,v xxxx
Test/WebPreferences.txtTrash/WebHome.txt xxxx
Test/WebPreferences.txt,vTrash/WebHome.txt,v xxxx
Test/WebSearch.txt xxxx ... ...
Test/WebSearch.txt,vTWiki/AlWilliams.txt xxxx
Test/WebStatistics.txtTWiki/AlWilliams.txt,v xxxx
Test/WebStatistics.txt,vTWiki/AndreaSterbini.txt xxxx
Trash/.changesTWiki/AndreaSterbini.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
Trash/WebIndex.txt xxxx
Trash/WebIndex.txt,v xxxx
Trash/WebNotify.txt xxxx
Trash/WebNotify.txt,v xxxx
Trash/WebPreferences.txt xxxx
Trash/WebPreferences.txt,v xxxx
Trash/WebSearch.txt xxxx
Trash/WebSearch.txt,v xxxx
Trash/WebStatistics.txt xxxx
Trash/WebStatistics.txt,v xxxx
TWiki/.changes xxxx
TWiki/.mailnotify xxxx
TWiki/AlWilliams.txt xxxx
TWiki/AlWilliams.txt,v xxxx
TWiki/AndreaSterbini.txt xxxx
TWiki/AndreaSterbini.txt,v xxxx
TWiki/BillClinton.txt xxxx
TWiki/BillClinton.txt,v xxxx
TWiki/BookView.txt xxxx
TWiki/BookView.txt,v xxxx
TWiki/BumpyWord.txt xxxx
TWiki/BumpyWord.txt,v xxxx
TWiki/ChristopheVermeulen.txt xxxx
TWiki/ChristopheVermeulen.txt,v xxxx
TWiki/CrisBailiff.txt xxxx
TWiki/CrisBailiff.txt,v xxxx
TWiki/DavidWarman.txt xxxx
TWiki/DavidWarman.txt,v xxxx
TWiki/DefaultPlugin.txt xxxx
TWiki/DefaultPlugin.txt,v xxxx
TWiki/DeleteOrRenameATopic.txt xxxx
TWiki/DeleteOrRenameATopic.txt,v xxxx
TWiki/DeleteTopic.txt xxxx
TWiki/DeleteTopic.txt,v xxxx
TWiki/DontNotify.txt xxxx
TWiki/DontNotify.txt,v xxxx
TWiki/EditDoesNotIncreaseTheRevision.txt xxxx
TWiki/EditDoesNotIncreaseTheRevision.txt,v xxxx
TWiki/EmptyPlugin.txt xxxx
TWiki/EmptyPlugin.txt,v xxxx
TWiki/ExampleTopicTemplate.txt xxxx
TWiki/ExampleTopicTemplate.txt,v xxxx
TWiki/FileAttachment.txt xxxx
TWiki/FileAttachment.txt,v xxxx
TWiki/GnuGeneralPublicLicense.txt xxxx
TWiki/GnuGeneralPublicLicense.txt,v xxxx
TWiki/GoodStyle.txt xxxx
TWiki/GoodStyle.txt,v xxxx
TWiki/HaroldGottschalk.txt xxxx
TWiki/HaroldGottschalk.txt,v xxxx
TWiki/Hey.txt xxxx
TWiki/Hey.txt,v xxxx
TWiki/IncludeTopicsAndWebPages.txt xxxx
TWiki/IncludeTopicsAndWebPages.txt,v xxxx
TWiki/InterwikiPlugin.txt xxxx
TWiki/InterwikiPlugin.txt,v xxxx
TWiki/InterWikis.txt xxxx
TWiki/InterWikis.txt,v xxxx
TWiki/JaneDoeTestCreateForm.txt xxxx
TWiki/JaneDoeTestCreateForm.txt,v xxxx
TWiki/JaneDoeTestEditForm.txt xxxx
TWiki/JaneDoeTestEditForm.txt,v xxxx
TWiki/JohnAltstadt.txt xxxx
TWiki/JohnAltstadt.txt,v xxxx
TWiki/JohnTalintyre.txt xxxx
TWiki/JohnTalintyre.txt,v xxxx
TWiki/KevinKinnell.txt xxxx
TWiki/KevinKinnell.txt,v xxxx
TWiki/ManpreetSingh.txt xxxx
TWiki/ManpreetSingh.txt,v xxxx
TWiki/MetaDataDefinition.txt xxxx
TWiki/MetaDataDefinition.txt,v xxxx
TWiki/MoveTopic.txt xxxx
TWiki/MoveTopic.txt,v xxxx
TWiki/MoveWeb.txt xxxx
TWiki/MoveWeb.txt,v xxxx
TWiki/NicholasLee.txt xxxx
TWiki/NicholasLee.txt,v xxxx
TWiki/PeterFokkinga.txt xxxx
TWiki/PeterFokkinga.txt,v xxxx
TWiki/PeterThoeny.txt xxxx
TWiki/PeterThoeny.txt,v xxxx
TWiki/PreviewBackground.txt xxxx
TWiki/PreviewBackground.txt,v xxxx
TWiki/RandyKramer.txt xxxx
TWiki/RandyKramer.txt,v xxxx
TWiki/RegularExpression.txt xxxx
TWiki/RegularExpression.txt,v xxxx
TWiki/ManagingTopics.txt xxxx
TWiki/ManagingTopics.txt,v xxxx
TWiki/SearchDoesNotWork.txt xxxx
TWiki/SearchDoesNotWork.txt,v xxxx
TWiki/SimultaneousEdits.txt xxxx
TWiki/SimultaneousEdits.txt,v xxxx
TWiki/StandardColors.txt xxxx
TWiki/StandardColors.txt,v xxxx
TWiki/StanleyKnutson.txt xxxx
TWiki/StanleyKnutson.txt,v xxxx
TWiki/SvenDowideit.txt xxxx
TWiki/SvenDowideit.txt,v xxxx
TWiki/TextFormattingFAQ.txt xxxx
TWiki/TextFormattingFAQ.txt,v xxxx
TWiki/TextFormattingRules.txt xxxx
TWiki/TextFormattingRules.txt,v xxxx
TWiki/TWikiAccessControl.txt xxxx
TWiki/TWikiAccessControl.txt,v xxxx
TWiki/ManagingWebs.txt xxxx
TWiki/ManagingWebs.txt,v xxxx
TWiki/TWikiUserAuthentication.txt xxxx
TWiki/TWikiUserAuthentication.txt,v xxxx
TWiki/TWikiCategoryTable.txt xxxx
TWiki/TWikiCategoryTable.txt,v xxxx
TWiki/TWikiContributor.txt xxxx
TWiki/TWikiContributor.txt,v xxxx
TWiki/TWikiDocumentation.txt xxxx
TWiki/TWikiDocumentation.txt,v xxxx
TWiki/TWikiDownload.txt xxxx
TWiki/TWikiDownload.txt,v xxxx
TWiki/TWikiEnhancementRequests.txt xxxx
TWiki/TWikiEnhancementRequests.txt,v xxxx
TWiki/TWikiFAQ.txt xxxx
TWiki/TWikiFAQ.txt,v xxxx
TWiki/TWikiFormTemplate.txt xxxx
TWiki/TWikiFormTemplate.txt,v xxxx
TWiki/TWikiHistory.txt xxxx
TWiki/TWikiHistory.txt,v xxxx
TWiki/TWikiImplementationNotes.txt xxxx
TWiki/TWikiImplementationNotes.txt,v xxxx
TWiki/TWikiInstallationGuide.txt xxxx
TWiki/TWikiInstallationGuide.txt,v xxxx
TWiki/WebNotification.txt xxxx
TWiki/WebNotification.txt,v xxxx
TWiki/TWikiPlannedFeatures.txt xxxx
TWiki/TWikiPlannedFeatures.txt,v xxxx
TWiki/TWikiPlugins.txt xxxx
TWiki/TWikiPlugins.txt,v xxxx
TWiki/TWikiPreferences.txt xxxx
TWiki/TWikiPreferences.txt,v xxxx
TWiki/TWikiRegistration.txt xxxx
TWiki/TWikiRegistration.txt,v xxxx
TWiki/TWikiRegistrationPub.txt xxxx
TWiki/TWikiRegistrationPub.txt,v xxxx
TWiki/TWikiSkins.txt xxxx
TWiki/TWikiSkins.txt,v xxxx
TWiki/TWikiTemplates.txt xxxx
TWiki/TWikiTemplates.txt,v xxxx
TWiki/TWikiTutorial.txt xxxx
TWiki/TWikiTutorial.txt,v xxxx
TWiki/TWikiTutorialKK.txt xxxx
TWiki/TWikiUpgradeGuide.txt xxxx
TWiki/TWikiUpgradeGuide.txt,v xxxx
TWiki/TWikiUpgradeTo01May2000.txt xxxx
TWiki/TWikiUpgradeTo01May2000.txt,v xxxx
TWiki/TWikiUsernameVsLoginUsername.txt xxxx
TWiki/TWikiUsernameVsLoginUsername.txt,v xxxx
TWiki/TWikiVariables.txt xxxx
TWiki/TWikiVariables.txt,v xxxx
TWiki/TWikiWeb.txt xxxx
TWiki/TWikiWeb.txt,v xxxx
TWiki/TWikiWebsTable.txt xxxx
TWiki/TWikiWebsTable.txt,v xxxx
TWiki/UnlockTopic.txt xxxx
TWiki/UnlockTopic.txt,v xxxx
TWiki/WabiSabi.txt xxxx
TWiki/WabiSabi.txt,v xxxx
TWiki/WebChanges.txt xxxx
TWiki/WebChanges.txt,v xxxx
TWiki/WebHome.txt xxxx
TWiki/WebHome.txt,v xxxx
TWiki/WebIndex.txt xxxx
TWiki/WebIndex.txt,v xxxx
TWiki/WebNotify.txt xxxx
TWiki/WebNotify.txt,v xxxx
TWiki/WebPreferences.txt xxxx
TWiki/WebPreferences.txt,v xxxx
TWiki/WebSearch.txt xxxx
TWiki/WebSearch.txt,v xxxx
TWiki/WebStatistics.txt xxxx
TWiki/WebStatistics.txt,v xxxx
TWiki/WebTopicEditTemplate.txt xxxx
TWiki/WebTopicEditTemplate.txt,v xxxx
TWiki/WebTopicNonWikiTemplate.txt xxxx
TWiki/WebTopicNonWikiTemplate.txt,v xxxx
TWiki/WebTopicViewTemplate.txt xxxx
TWiki/WebTopicViewTemplate.txt,v xxxx
TWiki/WelcomeGuest.txt xxxx
TWiki/WelcomeGuest.txt,v xxxx
TWiki/WhatIsWikiWiki.txt xxxx
TWiki/WhatIsWikiWiki.txt,v xxxx
TWiki/WikiCulture.txt xxxx
TWiki/WikiCulture.txt,v xxxx
TWiki/WikiName.txt xxxx
TWiki/WikiName.txt,v xxxx
TWiki/WikiNotation.txt xxxx
TWiki/WikiNotation.txt,v xxxx
TWiki/WikiReferences.txt xxxx
TWiki/WikiReferences.txt,v xxxx
TWiki/WikiSyntax.txt xxxx
TWiki/WikiSyntax.txt,v xxxx
TWiki/WikiTopic.txt xxxx
TWiki/WikiTopic.txt,v xxxx
TWiki/WikiWikiClones.txt xxxx
TWiki/WikiWikiClones.txt,v xxxx
TWiki/WikiWord.txt xxxx
TWiki/WikiWord.txt,vTWiki/DontNotify.txt,v xxxx
@@ -1928,6 +828,8 @@ A rundown of the individual files in the current %VERSION% distribution, organiz #### Files in `twiki/templates` +**_Used to flexibly control appearance of rendered pages..._** + -- cgit v1.2.3
File: