TWiki's TWiki webThe Documentation Web of TWiki. TWiki is an Enterprise Collaboration Platform.
Changed:
< <
https://twiki.pp.rl.ac.uk/twiki/bin/view/TWikiCopyright 2025 by contributing authors2015-11-29T10:27:04ZTWikiFormFieldDefinitionDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiFormFieldDefinitionDotPm2015-11-29T10:27:04ZPackage TWiki::Form::FieldDefinition Base class of all field definition classes. Type specific classes are derived from this class to define specific per type behaviours... (last changed by TWikiContributor)TWikiContributorTWikiDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiDotPm2015-11-29T10:27:03ZPackage TWiki TWiki operates by creating a singleton object (known as the Session object) that acts as a point of reference for all the different modules in the system... (last changed by TWikiContributor)TWikiContributorTWikiUISearchDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiUISearchDotPm2013-10-14T08:02:47ZPackage TWiki::UI::Search UI functions for searching. StaticMethod search ($session) Perform a search as dictated by CGI parameters: Parameter: Description... (last changed by TWikiContributor)TWikiContributorTWikiOopsExceptionDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiOopsExceptionDotPm2013-10-14T08:02:47ZPackage TWiki::OopsException Exception used to raise a request to redirect to an Oops URL. An OopsException thrown anywhere in the code will redirect the browser... (last changed by TWikiContributor)TWikiContributorTWikiUsersBaseUserMappingDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiUsersBaseUserMappingDotPm2013-10-14T08:02:47ZPackage TWiki::Users::BaseUserMapping User mapping is the process by which TWiki maps from a username (a login name) to a display name and back. It is also where... (last changed by TWikiContributor)TWikiContributorTWikiLoginManagerDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiLoginManagerDotPm2013-10-14T08:02:47ZPackage TWiki::LoginManager The package is also a Factory for login managers and also the base class for all login managers. On its own, an object of this class is... (last changed by TWikiContributor)TWikiContributorTWikiResponseDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiResponseDotPm2013-10-14T08:02:47ZPackage TWiki::Response Class to encapsulate response data. Fields: status response status headers hashref to response headers body... (last changed by TWikiContributor)TWikiContributorTWikiPluginDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiPluginDotPm2013-10-14T08:02:47ZPackage TWiki::Plugin ClassMethod new ($session,$name,$module) $session TWiki object $name name of the plugin e.g. MyPlugin $module... (last changed by TWikiContributor)TWikiContributorTWikiStoreSearchAlgorithmsPurePerlDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiStoreSearchAlgorithmsPurePerlDotPm2013-10-14T08:02:47ZPackage TWiki::Store::SearchAlgorithms::PurePerl Pure perl implementation of the RCS cache search. StaticMethod search ($searchString,$topics,$options,$sDir)... (last changed by TWikiContributor)TWikiContributorTWikiAccessDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiAccessDotPm2013-10-14T08:02:47ZPackage TWiki::Access A singleton object of this class manages the access control database. Dynamic access control and permission caching As TWiki:Codev/DynamicAccessControl... (last changed by TWikiContributor)TWikiContributorTWikiUsersHtPasswdUserDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiUsersHtPasswdUserDotPm2011-08-21T04:15:17ZPackage TWiki::Users::HtPasswdUser Support for htpasswd and htdigest format password files. Subclass of TWiki::Users::Password . See documentation of that class... (last changed by TWikiContributor)TWikiContributorTWikiPluralsDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiPluralsDotPm2009-03-30T09:17:52ZPackage TWiki::Plurals Handle conversion of plural topic names to singular form. StaticMethod singularForm ($web,$pluralForm) $singularForm Try to singularise... (last changed by TWikiContributor)TWikiContributorTWikiInfixParserDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiInfixParserDotPm2008-12-06T09:02:22ZPackage TWiki::Infix::Parser A simple stack based parser that parses infix expressions with nonary, unary and binary operators specified using an operator table.... (last changed by TWikiContributor)TWikiContributorTWikiQueryParserDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiQueryParserDotPm2008-01-22T03:21:35ZPackage TWiki::Query::Parser Parser for queries (last changed by TWikiContributor)TWikiContributorTWikiUIRegisterDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiUIRegisterDotPm2008-01-22T03:21:35ZPackage TWiki::UI::Register User registration handling. StaticMethod register cgi ($session) register command handler. This method is designed to be invoked... (last changed by TWikiContributor)TWikiContributorTWikiUIRDiffDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiUIRDiffDotPm2008-01-22T03:21:32ZPackage TWiki::UI::RDiff UI functions for diffing. StaticMethod diff ($session,$web,$topic,$query) diff command handler. This method is designed to be invoked... (last changed by TWikiContributor)TWikiContributor
TWiki's TWiki webThe Documentation Web of TWiki. TWiki is an Enterprise Collaboration Platform.https://twiki.pp.rl.ac.uk/twiki/bin/view/TWikiCopyright 2025 by contributing authors2014-10-05T11:03:28ZTWikiFormDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiFormDotPm2014-10-05T11:03:28ZPackage TWiki::Form Object representing a single form definition. Form definitions are mainly used to control rendering of a form for editing, though there is some... (last changed by TWikiContributor)TWikiContributorTWikiConfigureUIsEXTENDDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiConfigureUIsEXTENDDotPm2013-10-14T08:02:47ZPackage TWiki::Configure::UIs::EXTEND StaticMethod unpackArchive ($archive ,$dir ) Unpack an archive. The unpacking method is determined from the file extension... (last changed by TWikiContributor)TWikiContributorTWikiStoreRcsFileDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiStoreRcsFileDotPm2013-10-14T08:02:47ZPackage TWiki::Store::RcsFile This class is PACKAGE PRIVATE to Store, and should never be used from anywhere else. It is the base class of implementations of stores... (last changed by TWikiContributor)TWikiContributorTWikiStoreSearchAlgorithmsForkingDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiStoreSearchAlgorithmsForkingDotPm2013-10-14T08:02:47ZPackage TWiki::Store::SearchAlgorithms::Forking Forking implementation of the RCS cache search. StaticMethod search ($searchString,$topics,$options,$sDir)... (last changed by TWikiContributor)TWikiContributorTWikiConfigureCheckersCertificateDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiConfigureCheckersCertificateDotPm2013-10-14T08:02:47ZPackage TWiki::Configure::Checkers::CertificateChecker Configure GUI checker for Certificate items. This checker validates files that contain X.509 certificates,... (last changed by TWikiContributor)TWikiContributorTWikiFormSelectDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiFormSelectDotPm2013-10-14T08:02:47ZPackage TWiki::Form::Select getDefaultValue() $value The default for a select is always the empty string, as there is no way in TWiki form definitions to indicate... (last changed by TWikiContributor)TWikiContributorTWikiMdrepoDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiMdrepoDotPm2013-10-14T08:02:47ZPackage TWiki::Mdrepo ClassMethod new ($session) Construct a Mdrepo module. It`s a caller`s responsibility to guarantee all of the followings defined: $TWiki... (last changed by TWikiContributor)TWikiContributorTWikiUserMappingDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiUserMappingDotPm2011-08-21T04:16:08ZPackage TWiki::UserMapping This is a virtual base class (a.k.a an interface) for all user mappers. It is not useable as a mapping in TWiki use the BaseUserMapping... (last changed by TWikiContributor)TWikiContributorTWikiUsersPasswordDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiUsersPasswordDotPm2011-08-21T04:15:50ZPackage TWiki::Users::Password Base class of all password handlers. Default behaviour is no passwords, so anyone can be anyone they like. The methods of this class... (last changed by TWikiContributor)TWikiContributorTWikiSearchDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiSearchDotPm2011-04-12T00:50:47ZPackage TWiki::Search This module implements all the search functionality. ClassMethod new ($session) Constructor for the singleton Search engine object. ObjectMethod... (last changed by TWikiContributor)TWikiContributorTWikiPluginsDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiPluginsDotPm2010-05-29T14:44:56ZPackage TWiki::Plugins This module defines the singleton object that handles Plugins loading, initialization and execution. This class uses Chain of Responsibility... (last changed by TWikiContributor)TWikiContributorTWikiUIUploadDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiUIUploadDotPm2010-05-29T14:44:45ZPackage TWiki::UI::Upload UI delegate for attachment management functions StaticMethod attach ($session) attach command handler. This method is designed to be... (last changed by TWikiContributor)TWikiContributorTWikiUIRestDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiUIRestDotPm2010-05-29T14:44:12ZPackage TWiki::UI::Rest UI delegate for REST interface (last changed by TWikiContributor)TWikiContributorTWikiPrefsDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiPrefsDotPm2010-05-29T14:44:10ZPackage TWiki::Prefs The Prefs class is a singleton that implements management of preferences. It uses a stack of TWiki::Prefs::PrefsCache objects to store the preferences... (last changed by TWikiContributor)TWikiContributorTWikiUISaveDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiUISaveDotPm2008-01-22T03:21:35ZPackage TWiki::UI::Save UI delegate for save function StaticMethod save ($session) Command handler for save command. This method is designed to be invoked via... (last changed by TWikiContributor)TWikiContributorTWikiTemplatesDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiTemplatesDotPm2008-01-22T03:21:31ZPackage TWiki::Templates Support for the TWiki template language. The following tokens are supported by this language: % TMPL:P% Instantiates a previously defined... (last changed by TWikiContributor)TWikiContributor
TWiki's TWiki webThe Documentation Web of TWiki. TWiki is an Enterprise Collaboration Platform.https://twiki.pp.rl.ac.uk/twiki/bin/view/TWikiCopyright 2025 by contributing authors2014-10-05T11:03:28ZTWikiFormDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiFormDotPm2014-10-05T11:03:28ZPackage TWiki::Form Object representing a single form definition. Form definitions are mainly used to control rendering of a form for editing, though there is some... (last changed by TWikiContributor)TWikiContributorTWikiStoreSearchAlgorithmsForkingDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiStoreSearchAlgorithmsForkingDotPm2013-10-14T08:02:47ZPackage TWiki::Store::SearchAlgorithms::Forking Forking implementation of the RCS cache search. StaticMethod search ($searchString,$topics,$options,$sDir)... (last changed by TWikiContributor)TWikiContributorTWikiStoreRcsFileDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiStoreRcsFileDotPm2013-10-14T08:02:47ZPackage TWiki::Store::RcsFile This class is PACKAGE PRIVATE to Store, and should never be used from anywhere else. It is the base class of implementations of stores... (last changed by TWikiContributor)TWikiContributorTWikiFormSelectDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiFormSelectDotPm2013-10-14T08:02:47ZPackage TWiki::Form::Select getDefaultValue() $value The default for a select is always the empty string, as there is no way in TWiki form definitions to indicate... (last changed by TWikiContributor)TWikiContributorTWikiConfigureCheckersCertificateDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiConfigureCheckersCertificateDotPm2013-10-14T08:02:47ZPackage TWiki::Configure::Checkers::CertificateChecker Configure GUI checker for Certificate items. This checker validates files that contain X.509 certificates,... (last changed by TWikiContributor)TWikiContributorTWikiMdrepoDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiMdrepoDotPm2013-10-14T08:02:47ZPackage TWiki::Mdrepo ClassMethod new ($session) Construct a Mdrepo module. It`s a caller`s responsibility to guarantee all of the followings defined: $TWiki... (last changed by TWikiContributor)TWikiContributorTWikiUserMappingDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiUserMappingDotPm2011-08-21T04:16:08ZPackage TWiki::UserMapping This is a virtual base class (a.k.a an interface) for all user mappers. It is not useable as a mapping in TWiki use the BaseUserMapping... (last changed by TWikiContributor)TWikiContributorTWikiUsersPasswordDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiUsersPasswordDotPm2011-08-21T04:15:50ZPackage TWiki::Users::Password Base class of all password handlers. Default behaviour is no passwords, so anyone can be anyone they like. The methods of this class... (last changed by TWikiContributor)TWikiContributorTWikiSearchDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiSearchDotPm2011-04-12T00:50:47ZPackage TWiki::Search This module implements all the search functionality. ClassMethod new ($session) Constructor for the singleton Search engine object. ObjectMethod... (last changed by TWikiContributor)TWikiContributorTWikiUIUploadDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiUIUploadDotPm2010-05-29T14:44:45ZPackage TWiki::UI::Upload UI delegate for attachment management functions StaticMethod attach ($session) attach command handler. This method is designed to be... (last changed by TWikiContributor)TWikiContributorTWikiUIRestDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiUIRestDotPm2010-05-29T14:44:12ZPackage TWiki::UI::Rest UI delegate for REST interface (last changed by TWikiContributor)TWikiContributorTWikiPrefsDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiPrefsDotPm2010-05-29T14:44:10ZPackage TWiki::Prefs The Prefs class is a singleton that implements management of preferences. It uses a stack of TWiki::Prefs::PrefsCache objects to store the preferences... (last changed by TWikiContributor)TWikiContributorTWikiUISaveDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiUISaveDotPm2008-01-22T03:21:35ZPackage TWiki::UI::Save UI delegate for save function StaticMethod save ($session) Command handler for save command. This method is designed to be invoked via... (last changed by TWikiContributor)TWikiContributorTWikiCompatibilityDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiCompatibilityDotPm2008-01-22T03:21:32ZPackage TWiki::Compatibility Support for compatibility with old TWiki versions. Packaged separately because 99.999999% of the time this won`t be needed. StaticMethod... (last changed by TWikiContributor)TWikiContributorTWikiTemplatesDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiTemplatesDotPm2008-01-22T03:21:31ZPackage TWiki::Templates Support for the TWiki template language. The following tokens are supported by this language: % TMPL:P% Instantiates a previously defined... (last changed by TWikiContributor)TWikiContributorTWikiIfParserDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiIfParserDotPm2008-01-22T03:21:31ZPackage TWiki::If::Parser Support for the conditions in } statements. (last changed by TWikiContributor)TWikiContributor