TWiki:Pluginsexpands to TWiki:Plugins on TWiki.org. You can edit the predefined set of of Wiki-related sites, and add your own.
SomePlugin), there's a separate development page.
twiki/libdirectories for the Test version, adjusting the paths in the new
twiki/pubdirectories are shared.
DISABLEDPLUGINSvariable in TWikiPreferences. Redefine the
DISABLEDPLUGINSvariable in the
Sandboxweb and do the testing there.
lib/TWiki/Pluginsdirectory are activated automatically unless disabled by the
DISABLEDPLUGINSPreferences variable in TWikiPreferences. You can optionally list the installed Plugins in the
INSTALLEDPLUGINSPreferences variable. This is useful to define the sequence of Plugin execution, or to specify other webs than the TWiki web for the Plugin topics. Settings in TWikiPreferences are:
Set INSTALLEDPLUGINS = DefaultPlugin, ...
Set DISABLEDPLUGINS = EmptyPlugin, ...
web.topicnamename, if specified in
INSTALLEDPLUGINS; next, the TWiki web is searched; and finally, the current web. Plugin-specific settings are done in individual Plugin topics. Two settings are standard for each Plugin:
Set SHORTDESCRIPTION = Blah blah woof woof.
data/debug.txt. Set to 0=off or 1=on:
Set DEBUG = 0
%DEFAULTPLUGIN_SHORTDESCRIPTION%shows the description of the DefaultPlugin.
%ACTIVATEDPLUGINS%variable lists activated Plugins by name. (This variable is displayed in TWikiPreferences for debugging use.)
%PLUGINDESCRIPTIONS%variable displays a bullet list with a one-line description of each active Plugins. This variable is based on the
%<plugin>_SHORTDESCRIPTION%Preferences variables of individual topics and is shown in TextFormattingRules.
DEMO: Automatically List Active Plugins Using Variables UsingTWikiFuncModule (
On this TWiki site, the active Plugins are: DefaultPlugin, BeautifierPlugin, InterwikiPlugin, SyntaxHighlightingPlugin, TocPlugin. Using
You can use any of these active TWiki Plugins:
- DefaultPlugin: This plugin can be used to specify some simple custom rendering rules. It also renders deprecated
*_text_*as bold italic text.
- BeautifierPlugin: Highlights and formats code fragments.
- InterwikiPlugin: Link
ExternalSite:Pagetext to external sites based on aliases defined in the InterWikis topic.
- SyntaxHighlightingPlugin: This Plugin is used to emphasize the rendering of your twiki text according to several languages.
lib/TWiki/Func.pm) implements ALL official Plugin functions. Plugins should ONLY use functions published in this module. If you use functions not in
Func.pm, you run the risk of creating security holes. Also, your Plugin will likely break and require updating when you upgrade to a new version of TWiki.
DISABLE_from the function name.
insidePREHandlerare particularly expensive.
GetVersiondetection routine are provided for automatic compatibility checking.
$VERSION='0.000'variable, beginning at
initPluginhandler should check all dependencies and return TRUE if the initialization is OK or FALSE if something went wrong.
$VERSION='1.000'is the current setting in
TWiki::Plugins.pmand in the preinstalled system Plugins (DefaultPlugin, EmptyPlugin, InterwikiPlugin).
MyFirstPlugintopic. Other needed Perl code is best placed in a
lib/TWiki/Plugins/MyFirstPlugin/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.
EmptyPlugin.pmmodule contains mostly empty functions, so it does nothing, but it's ready to be used. Customize it. Refer to the Plugin API specs for more information. If your Plugin uses its own modules and objects, you must include the name of the Plugin in the package name. For example, write
Package MyFirstPlugin::Attrs;instead of just
Package Attrs;. Then call it using:
use TWiki::Plugins::MyFirstPlugin::Attrs; $var = MyFirstPlugin::Attrs->new();FileAttachments for downloading. (The doc topic is also included in the distribution package.) To create a documentation topic:
MyFirstPlugin, press enter and create the new topic
OUTLINE: Doc Topic ContentsWikiName that ends in
Check the Plugins web on TWiki.org for the latest Plugin doc topic template. Here's a quick overview of what's covered: Syntax Rules: <Describe any special text formatting that will be rendered.>" Example: <Include an example of the Plugin in action. Possibly include a static HTML version of the example to compare if the installation was a success!>" Plugin Global Settings: <Description and settings for custom Plugin %VARIABLES%, and those required by TWiki.>"
Plugin Installation Instructions: <Step-by-step set-up guide, user help, whatever it takes to install and run, goes here.>" Plugin Info: <Version, credits, history, requirements - entered in a form, displayed as a table. Both are automatically generated when you create or edit a page in the TWiki:Plugins web.>"
- Plugins Preferences <If user settings are needed, explain... Entering values works exactly like TWikiPreferences and WebPreferences: six (6) spaces and then:>"
- Set <EXAMPLE = value added>
MyFirstPlugin.pm, and a documentation page with the same name(
pub/TWiki/MyFirstPlugin/uparrow.gif[a required graphic]
MyFirstPlugin.zip) and add the entire directory structure from Step 1. The archive should look like this:
MyFirstPluginDev. This is the discussion page for future development. (User support for Plugins is handled in TWiki:Support.)