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 authors2018-07-16T03:20:47ZTWikiRenderDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiRenderDotPm2018-07-16T03:20:47ZPackage TWiki::Render This module provides most of the actual HTML rendering code in TWiki. ClassMethod new ($session) Creates a new renderer ObjectMethod finish... (last changed by TWikiContributor)TWikiContributorTWikiUIDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiUIDotPm2018-07-16T03:20:41ZPackage TWiki::UI Coordinator of execution flow and service functions used by the UI packages StaticMethod handleRequest ($req) $res Main coordinator of request... (last changed by TWikiContributor)TWikiContributorTWikiConfigureImgToolDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiConfigureImgToolDotPm2018-07-16T03:20:39ZPackage TWiki::Configure::ImgTool This class is a singleton that offers URLs for the images (logos, warning, info) used during configuration when neither pub... (last changed by TWikiContributor)TWikiContributorTWikiStoreDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiStoreDotPm2018-07-16T03:20:37ZPackage TWiki::Store This module hosts the generic storage backend. This module provides the interface layer between the `real` store provider which is hidden behind... (last changed by TWikiContributor)TWikiContributorTWikiFuncDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiFuncDotPm2018-07-16T03:20:32ZPackage TWiki::Func Official list of stable TWiki functions for Plugin developers This module defines official functions that TWiki plugins can use to interact... (last changed by TWikiContributor)TWikiContributorTWikiFormFieldDefinitionDotPmhttps://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)TWikiContributorTWikiTimeDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiTimeDotPm2014-10-05T11:03:29ZPackage TWiki::Time Time handling functions. StaticMethod parseTime ($szDate,$defaultLocal) $iSecs Convert string date/time string to seconds since epoch (... (last changed by TWikiContributor)TWikiContributorTWikiEngineDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiEngineDotPm2013-10-14T08:02:47ZPackage TWiki::Engine The engine class is a singleton that implements details about TWiki`s execution mode. This is the base class and implements basic behavior.... (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)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)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)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)TWikiContributorTWikiLoginManagerSessionDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiLoginManagerSessionDotPm2013-10-14T08:02:47ZPackage TWiki::LoginManager::Session Class to provide CGI::Session like infra structure, compatible with TWiki Runtime Engine mechanisms other than CGI. It inherits... (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)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)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 authors2018-07-16T03:20:45ZSourceCodehttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/SourceCode2018-07-16T03:20:45ZTWiki Source Code Packages This documentation is automatically generated from the pod , so it always matches the running code TWiki::AccessControlException Exception... (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)TWikiContributorTWikiEngineDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiEngineDotPm2013-10-14T08:02:47ZPackage TWiki::Engine The engine class is a singleton that implements details about TWiki`s execution mode. This is the base class and implements basic behavior.... (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)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)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)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)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)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)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)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)TWikiContributorTWikiLoginManagerTemplateLoginDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiLoginManagerTemplateLoginDotPm2008-01-22T03:21:30ZPackage TWiki::LoginManager::TemplateLogin This is a login manager that you can specify in the security setup section of configure. It provides users with a template... (last changed by TWikiContributor)TWikiContributorTWikiInfixErrorDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiInfixErrorDotPm2008-01-22T03:21:30ZPackage TWiki::Infix::Error Class of errors used with TWiki::Infix::Parser (last changed by TWikiContributor)TWikiContributorTWikiUIViewDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiUIViewDotPm2008-01-22T03:21:29ZPackage TWiki::UI::View UI delegate for view function StaticMethod view ($session) view command handler. This method is designed to be invoked via the UI::run... (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 authors2018-07-16T03:20:47ZTWikiRenderDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiRenderDotPm2018-07-16T03:20:47ZPackage TWiki::Render This module provides most of the actual HTML rendering code in TWiki. ClassMethod new ($session) Creates a new renderer ObjectMethod finish... (last changed by TWikiContributor)TWikiContributorTWikiUIDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiUIDotPm2018-07-16T03:20:41ZPackage TWiki::UI Coordinator of execution flow and service functions used by the UI packages StaticMethod handleRequest ($req) $res Main coordinator of request... (last changed by TWikiContributor)TWikiContributorTWikiConfigureImgToolDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiConfigureImgToolDotPm2018-07-16T03:20:39ZPackage TWiki::Configure::ImgTool This class is a singleton that offers URLs for the images (logos, warning, info) used during configuration when neither pub... (last changed by TWikiContributor)TWikiContributorTWikiStoreDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiStoreDotPm2018-07-16T03:20:37ZPackage TWiki::Store This module hosts the generic storage backend. This module provides the interface layer between the `real` store provider which is hidden behind... (last changed by TWikiContributor)TWikiContributorTWikiFuncDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiFuncDotPm2018-07-16T03:20:32ZPackage TWiki::Func Official list of stable TWiki functions for Plugin developers This module defines official functions that TWiki plugins can use to interact... (last changed by TWikiContributor)TWikiContributorTWikiFormFieldDefinitionDotPmhttps://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)TWikiContributorTWikiTimeDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiTimeDotPm2014-10-05T11:03:29ZPackage TWiki::Time Time handling functions. StaticMethod parseTime ($szDate,$defaultLocal) $iSecs Convert string date/time string to seconds since epoch (... (last changed by TWikiContributor)TWikiContributorTWikiRequestDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiRequestDotPm2013-10-14T08:02:47ZPackage TWiki::Request Class to encapsulate request data. Fields: action action requested (view, edit, save, ...) cookies hashref whose keys are cookie... (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)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)TWikiContributorTWikiLoginManagerSessionDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiLoginManagerSessionDotPm2013-10-14T08:02:47ZPackage TWiki::LoginManager::Session Class to provide CGI::Session like infra structure, compatible with TWiki Runtime Engine mechanisms other than CGI. It inherits... (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)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)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)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)TWikiContributor
Copyright © 1999-2025 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.