Difference: TWikiPlugins (10 vs. 11)

Revision 112001-09-02 - AndreaSterbini

Line: 1 to 1
	On this page: Overview Installing Plugins On-Site Pretesting Some Notes on Plugin Performance Managing Installed Plugins Enabling/Disabling Plugins Plugin Evaluation Order Plugin-Specific Settings Listing Active Plugins %ACTIVATEDPLUGINS% %PLUGINDESCRIPTIONS% %FAILEDPLUGINS% The TWiki Plugin API Available Core Functions Predefined Hooks Hints on Writing Fast Plugins Version Detection Security Creating Plugins Anatomy of a Plugin Creating the Perl Module Writing the Documentation Topic Packaging for Distribution Measuring and Improving the Plugin Performance Publishing for Public Use Recommended Storage of Plugin Specific Data Plugin Internal Data Web Accessible Data Integrating with `configure` Structure of a `Config.spec` file Maintaining Plugins Discussions and Feedback on Plugins Maintaining Compatibility with Earlier TWiki Versions Handling deprecated functions TWiki Plugins
Line: 117 to 117
	All modules require a `$VERSION='0.000'` variable, beginning at `1.000`.
Changed:
< <	The `initPlugin` handler checks all dependencies and returns TRUE if the initialization is OK or FALSE if something went wrong.
> >	The `initPlugin` handler should check all dependencies and return TRUE if the initialization is OK or FALSE if something went wrong.
	The Plugin initialization code does not register a Plugin that returns FALSE (or that has no `initPlugin` handler). `$VERSION='1.000'` is the current setting in `TWiki::Plugins.pm` and in the preinstalled system Plugins (DefaultPlugin, EmptyPlugin, InterwikiPlugin).
Line: 140 to 140
	a documentation topic, ex: `YourPlugin.txt` The Perl module can be a block of code that connects with TWiki alone, or it can include other elements, like other Perl modules (including other Plugins), graphics, TWiki templates, external applications (ex: a Java applet), or just about anything else it can call.
Added:
> >	In particular, files that should be web-accessible (graphics, Java applets ...) are best placed as attachments of the `YourPlugin` topic. Other needed Perl code is best placed in a `lib/TWiki/Plugins/YourPlugin/` directory.
	The Plugin API handles the details of connecting your Perl module with main TWiki code. When you're familiar with the Plugin API, you're ready to develop Plugins.

View topic | History: r38 < r37 < r36 < r35 | More topic actions...

Copyright © 1999-2025 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback
Note: Please contribute updates to this topic on TWiki.org at TWiki:TWiki.TWikiPlugins.

Difference: TWikiPlugins (10 vs. 11)

Revision 112001-09-02 - AndreaSterbini

TWiki Plugins