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)TWikiContributorSourceCodehttps://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)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)TWikiContributorTWikiNetDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiNetDotPm2015-11-29T10:27:03ZPackage TWiki::Net Object that brokers access to network resources. ObjectMethod finish () Break circular references. ObjectMethod registerExternalHTTPHandler... (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)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)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)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)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)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)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)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)TWikiContributorWebLeftBarSearchhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/WebLeftBarSearch2009-04-29T20:53:55Z (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:39ZTWikiConfigureImgToolDotPmhttps://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)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)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)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)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)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)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)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)TWikiContributorTWikiEngineExceptionDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiEngineExceptionDotPm2010-05-29T14:44:11ZPackage TWiki::EngineException Exception used to raise an engine related error. This exception has the following fields: status status code to send to client... (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)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)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)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)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)TWikiContributorTWikiUsersApacheHtpasswdUserDotPmhttps://twiki.pp.rl.ac.uk/twiki/bin/view/TWiki/TWikiUsersApacheHtpasswdUserDotPm2008-01-22T03:21:31ZPackage TWiki::Users::ApacheHtpasswdUser Password manager that uses Apache::HtPasswd to manage users and passwords. Subclass of TWiki::Users::Password . See documentation... (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