internal package Foswiki::Plugins::MeetingBingoPlugin

See PublishedAPI for packages intended to be used by Plugin and Contrib authors, or browse all packages.
See also Developing plugins, Developer's Bible, Technical Overview

internal package MeetingBingoPlugin

NOTE: When writing handlers, keep in mind that these may be invoked on included topics. For example, if a plugin generates links to the current topic, these need to be generated before the afterCommonTagsHandler is run, as at that point in the rendering loop we have lost the information that we the text had been included from another topic.

initPlugin($topic, $web, $user, $installWeb) -> $boolean

  • $topic - the name of the topic in the current CGI query
  • $web - the name of the web in the current CGI query
  • $user - the login name of the user
  • $installWeb - the name of the web the plugin is installed in

REQUIRED

Called to initialise the plugin. If everything is OK, should return a non-zero value. On non-fatal failure, should write a message using Foswiki::Func::writeWarning and return 0. In this case
PluginErrors
SpreadSheetPlugin
none
AntiWikiSpamPlugin
none
AutoViewTemplatePlugin
none
CommentPlugin
none
CompareRevisionsAddonPlugin
none
EditTablePlugin
none
HistoryPlugin
none
InterwikiPlugin
none
JQueryPlugin
none
MailerContribPlugin
none
MathModePlugin
none
NewUserPlugin
none
PreferencesPlugin
none
RenderListPlugin
none
SlideShowPlugin
none
SmiliesPlugin
none
SyntaxHighlightingPlugin
none
TablePlugin
none
TinyMCEPlugin
none
TwistyPlugin
none
VarCachePlugin
none
WysiwygPlugin
none
HandlerPlugins
afterCommonTagsHandlerTablePlugin
VarCachePlugin
afterEditHandlerWysiwygPlugin
beforeAttachmentSaveHandlerAntiWikiSpamPlugin
This handler is deprecated - please check for updated versions of the plugins that use it!
beforeCommonTagsHandlerEditTablePlugin
NewUserPlugin
PreferencesPlugin
VarCachePlugin
WysiwygPlugin
beforeEditHandlerTinyMCEPlugin
WysiwygPlugin
beforeMergeHandlerWysiwygPlugin
beforeSaveHandlerAntiWikiSpamPlugin
CommentPlugin
WysiwygPlugin
commonTagsHandlerSpreadSheetPlugin
CommentPlugin
CompareRevisionsAddonPlugin
EditTablePlugin
MathModePlugin
SlideShowPlugin
SmiliesPlugin
SyntaxHighlightingPlugin
finishPluginJQueryPlugin
initPluginSpreadSheetPlugin
AntiWikiSpamPlugin
AutoViewTemplatePlugin
CommentPlugin
CompareRevisionsAddonPlugin
EditTablePlugin
HistoryPlugin
InterwikiPlugin
JQueryPlugin
MailerContribPlugin
MathModePlugin
NewUserPlugin
PreferencesPlugin
RenderListPlugin
SlideShowPlugin
SmiliesPlugin
SyntaxHighlightingPlugin
TablePlugin
TinyMCEPlugin
TwistyPlugin
VarCachePlugin
WysiwygPlugin
modifyHeaderHandlerWysiwygPlugin
postRenderingHandlerEditTablePlugin
MathModePlugin
PreferencesPlugin
WysiwygPlugin
preRenderingHandlerInterwikiPlugin
RenderListPlugin
SmiliesPlugin
TablePlugin
registrationHandlerAntiWikiSpamPlugin
22 plugins

will indicate which plugins failed.

In the case of a catastrophic failure that will prevent the whole installation from working safely, this handler may use 'die', which will be trapped and reported in the browser.

You may also call Foswiki::Func::registerTagHandler here to register a function to handle variables that have standard TWiki syntax - for example, =%MYTAG{"my param" myarg="My Arg"}%. You can also override internal TWiki variable handling functions this way, though this practice is unsupported and highly dangerous!

Note: Please align variables names with the Plugin name, e.g. if your Plugin is called FooBarPlugin, name variables FOOBAR and/or FOOBARSOMETHING. This avoids namespace issues.

This topic: System > WebHome > ReferenceManual > DeveloperDocumentationCategory > PerlDoc
Topic revision: 19 Apr 2011, ProjectContributor
 
This site is powered by FoswikiCopyright © CC-BY-SA by the contributing authors. All material on this collaboration platform is copyrighted under CC-BY-SA by the contributing authors unless otherwise noted.
Ideas, requests, problems regarding Foswiki? Send feedback