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)TWikiContributorTWikiUsersDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiUsersDotPm2018-07-16T03:20:32ZPackage TWiki::Users This package provides services for the lookup and manipulation of login and wiki names of users, and their authentication. It is a Facade that... (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)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)TWikiContributorTWikiUIMdrepoUIDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiUIMdrepoUIDotPm2013-10-14T08:02:47ZPackage TWiki::UI::MdrepoUI UI delegate for mdrepo function StaticMethod mdrepo ($session); (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)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)TWikiContributorTWikiConfigureCheckersCertificateKeyCheckerDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiConfigureCheckersCertificateKeyCheckerDotPm2013-10-14T08:02:47ZPackage TWiki::Configure::Checkers::Certificate::KeyChecker Configure GUI checker for Certificate Key items. This checker validates files that contain private key... (last changed by TWikiContributor)TWikiContributorTWikiMetaDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiMetaDotPm2013-10-14T08:02:47ZPackage TWiki::Meta All TWiki topics have data (text) and meta data (information about the topic). Meta data includes information such as file attachments, form... (last changed by TWikiContributor)TWikiContributorTWikiUsersTWikiUserMappingDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiUsersTWikiUserMappingDotPm2011-08-21T04:16:00ZPackage TWiki::Users::TWikiUserMapping The User mapping is the process by which TWiki maps from a username (a login name) to a wikiname and back. It is also where... (last changed by TWikiContributor)TWikiContributorTWikiUIEditDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiUIEditDotPm2011-04-12T00:50:46ZPackage TWiki::UI::Edit Edit command handler StaticMethod edit ($session) Edit command handler. This method is designed to be invoked via the UI::run method... (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)TWikiContributorTWikiStoreRcsWrapDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiStoreRcsWrapDotPm2008-01-22T03:21:33ZPackage TWiki::Store::RcsWrap This package does not publish any methods. It implements the virtual methods of the TWiki::Store::RcsFile superclass. Wrapper around... (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)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)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:37ZTWikiStoreDotPmhttps://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)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)TWikiContributorTWikiUIMdrepoUIDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiUIMdrepoUIDotPm2013-10-14T08:02:47ZPackage TWiki::UI::MdrepoUI UI delegate for mdrepo function StaticMethod mdrepo ($session); (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)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)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)TWikiContributorTWikiUICopyDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiUICopyDotPm2013-10-14T08:02:47ZPackage TWiki::UI::Copy UI delegate for copy function StaticMethod copy ($session) copy command handler. This method is designed to be invoked via the UI::run... (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)TWikiContributorWebLeftBarSearchhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/WebLeftBarSearch2009-04-29T20:53:55Z (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)TWikiContributorTWikiStoreRcsWrapDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiStoreRcsWrapDotPm2008-01-22T03:21:33ZPackage TWiki::Store::RcsWrap This package does not publish any methods. It implements the virtual methods of the TWiki::Store::RcsFile superclass. Wrapper around... (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