diff options
| -rw-r--r-- | TWiki/TWikiPlugins.mdwn | 92 |
1 files changed, 46 insertions, 46 deletions
diff --git a/TWiki/TWikiPlugins.mdwn b/TWiki/TWikiPlugins.mdwn index 8ee87e80..5ea28c43 100644 --- a/TWiki/TWikiPlugins.mdwn +++ b/TWiki/TWikiPlugins.mdwn @@ -2,11 +2,11 @@ # <a name="TWiki_Plugins"> TWiki Plugins </a> -Plugin use and development; about the Plugin API. +_Plug-in enhanced feature add-ons, with a Plugin API for developers_ ## <a name="Overview"> Overview </a> -You can add Plugins to greatly extend TWiki's functionality, without alering the program core. With a plug-in approach, you can: +You can add Plugins to extend TWiki's functionality, without altering the core program code. With a plug-in approach, you can: * add virtually unlimited features while keeping the main TWiki code compact and efficient; * heavily customize an installation and still do clean updates to new versions of TWiki; @@ -22,7 +22,7 @@ TWiki comes with three Plugins as part of the standard installation. * **EmptyPlugin** is a fully functional module, minus active code; it does nothing and serves as a template for new Plugin development. -* **InterwikiPlugin** is preinstalled but can be disabled or removed. Use it for quick linking to to remote sites: <code>**TWiki:Plugins**</code> expands to TWiki:Plugins on TWiki.org. You can add your own shortcuts and URLs to the existing directory of Wiki-related and other probably useful sites. +* **InterwikiPlugin** is preinstalled but can be disabled or removed. Use it for quick linking to to remote sites: `TWiki:Plugins` expands to TWiki:Plugins on TWiki.org. You can add your own shortcuts and URLs to the existing directory of Wiki-related and other probably useful sites. <a name="InstallPlugin"></a> @@ -38,10 +38,10 @@ Most Plugins can be installed in three easy steps, with no programming skills re **Special Requests:** Some Plugins need certain Perl modules to be preinstalled on the host system. Plugins may also use other resources, like graphics, other modules, applications, templates. In these cases, detailed instructions are in the Plugin documentation. -Each Plugin has a standard release page, located in the TWiki:Plugins web at TWiki.org. In addition to the documentation topic (<code>**SomePlugin**</code>), there's a separate development page. +Each Plugin has a standard release page, located in the TWiki:Plugins web at TWiki.org. In addition to the documentation topic (`SomePlugin`), there's a separate development page. * **Doc page:** Read all available info about the Plugin; download the attached distribution files. -* **Dev page:** Post feature requests, bug reports and general dev comments; topic title ends in <code>**Dev**</code> (<code>**SomePluginDev**</code>). +* **Dev page:** Post feature requests, bug reports and general dev comments; topic title ends in `Dev` (`SomePluginDev`). * **User support:** Post installation, how to use type questions (and answers, if you have them) in the TWiki:Support web. ### <a name="On_Site_Pretesting"> On-Site Pretesting </a> @@ -49,11 +49,11 @@ Each Plugin has a standard release page, located in the TWiki:Plugins web at TWi To test new Plugins on your installation before making them public, you may want to use one of these two approaches: * **Method 1:** Create Production and a Test installation of TWiki. - * Duplicate the <code>**twiki/bin**</code> and <code>**twiki/lib**</code> directories for the Test version, adjusting the paths in the new <code>**lib/TWiki.cfg**</code>, the <code>**twiki/data**</code>; the <code>**twiki/templates**</code> and <code>**twiki/pub**</code> directories are shared. + * Duplicate the `twiki/bin` and `twiki/lib` directories for the Test version, adjusting the paths in the new `lib/TWiki.cfg`, the `twiki/data`; the `twiki/templates` and `twiki/pub` directories are shared. * Test Plugins and other new features in the Test installation until you're satisfied. * Copy the modified files to the Production installation. You can update a live TWiki installation and users won't even notice. -* **Method 2:** List the Plugin under <code>**Test**</code> in the DISABLEDPLUGINS variable in %TWIKIWEB%.TWikiPreferences. Redefine the DISABLEDPLUGINS variable in the Test web and do the testing there. +* **Method 2:** List the Plugin under `Test` in the DISABLEDPLUGINS variable in %TWIKIWEB%.TWikiPreferences. Redefine the DISABLEDPLUGINS variable in the Test web and do the testing there. ## <a name="Managing_Plugins"> Managing Plugins </a> @@ -63,33 +63,33 @@ Ideally, after you've installed a Plugin, just read the instructions and you're Installed Plugins can be **toggled on or off**, site-wide or by web, through TWikiPreferences and individual WebPreferences: -* All Plugin modules present in the <code>**lib/TWiki/Plugins**</code> directory are activated automatically unless disabled by the <code>**DISABLEDPLUGINS**</code> Preferences variable in TWikiPreferences. You can optionally list the installed Plugins in the <code>**INSTALLEDPLUGINS**</code> Preferences variable. This is useful to define the sequence of Plugin execution, or to specify other webs than the %WIKITOOLNAME% web for the Plugin topics. Settings in %TWIKIWEB%.TWikiPreferences are: - * <code>**Set INSTALLEDPLUGINS = DefaultPlugin, ...**</code> - * <code>**Set DISABLEDPLUGINS = EmptyPlugin, ...**</code> +* All Plugin modules present in the `lib/TWiki/Plugins` directory are activated automatically unless disabled by the `DISABLEDPLUGINS` Preferences variable in TWikiPreferences. You can optionally list the installed Plugins in the `INSTALLEDPLUGINS` Preferences variable. This is useful to define the sequence of Plugin execution, or to specify other webs than the %WIKITOOLNAME% web for the Plugin topics. Settings in %TWIKIWEB%.TWikiPreferences are: + * <code>Set INSTALLEDPLUGINS = DefaultPlugin, ...</code> + * <code>Set DISABLEDPLUGINS = EmptyPlugin, ...</code> -**Plugin execution order** in TWiki is determined by searching Plugin topics in a specific sequence: First, full <code>**web.topicname**</code> name, if specified in <code>**INSTALLEDPLUGINS**</code>; next, the %TWIKIWEB% web is searched; and finally, the current web. +**Plugin execution order** in TWiki is determined by searching Plugin topics in a specific sequence: First, full `web.topicname` name, if specified in `INSTALLEDPLUGINS`; next, the %TWIKIWEB% web is searched; and finally, the current web. **Plugin-specific settings** are done in individual Plugin topics. Two settings are standard for each Plugin: 1. One line description, used to form the bullets describing the Plugins in the %TWIKIWEB%.TextFormattingRules topic: - * <code>**Set SHORTDESCRIPTION = Blah blah woof woof.**</code> -2. Debug Plugin, output can be seen in <code>**data/debug.txt**</code>. Set to 0=off or 1=on: - * <code>**Set DEBUG = 0**</code> + * `Set SHORTDESCRIPTION = Blah blah woof woof.` +2. Debug Plugin, output can be seen in `data/debug.txt`. Set to 0=off or 1=on: + * `Set DEBUG = 0` -* The settings can be retrieved as Preferences variables like <code>**%<pluginname>\_<var>%**</code>, ex: <code>**%DEFAULTPLUGIN\_SHORTDESCRIPTION%**</code> shows the description of the DefaultPlugin. +* The settings can be retrieved as Preferences variables like `%<pluginname>_<var>%`, ex: <code>%DEFAULTPLUGIN\_SHORTDESCRIPTION%</code> shows the description of the DefaultPlugin. ### <a name="Listing_Active_Plugins"> Listing Active Plugins </a> Plugin status variables let you list all active Plugins wherever needed. There are two list formats: -* The <code>**%ACTIVATEDPLUGINS%**</code> variable lists activated Plugins by name. (This variable is displayed in %TWIKIWEB%.TWikiPreferences for debugging use.) -* The <code>**%PLUGINDESCRIPTIONS%**</code> variable displays a bullet list with a one-line description of each active Plugins. This variable is based on the <code>**%<plugin>\_SHORTDESCRIPTION%**</code> Preferences variables of individual topics and is shown in %TWIKIWEB%.TextFormattingRules. +* The <code>%ACTIVATEDPLUGINS%</code> variable lists activated Plugins by name. (This variable is displayed in %TWIKIWEB%.TWikiPreferences for debugging use.) +* The <code>%PLUGINDESCRIPTIONS%</code> 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 %TWIKIWEB%.TextFormattingRules. > > -> <code>**%ACTIVATEDPLUGINS%**</code><br /> On this TWiki site, the active Plugins are: %ACTIVATEDPLUGINS%. +> <code>%ACTIVATEDPLUGINS%</code><br /> On this TWiki site, the active Plugins are: %ACTIVATEDPLUGINS%. > -> <code>**%PLUGINDESCRIPTIONS%**</code><br /> You can use any of these active TWiki Plugins: %PLUGINDESCRIPTIONS% +> <code>%PLUGINDESCRIPTIONS%</code><br /> You can use any of these active TWiki Plugins: %PLUGINDESCRIPTIONS% <a name="PluginAPI"></a> @@ -99,28 +99,28 @@ The Application Programming Interface (API) for TWikiPlugins provides the specif ### <a name="Available_Core_Functions"> Available Core Functions </a> -The <code>**lib/TWiki/Func.pm**</code> implements ALL official Plugin functions. Plugins should ONLY use functions published in this module. +The `lib/TWiki/Func.pm` implements ALL official Plugin functions. Plugins should ONLY use functions published in this module. - If you use functions not in <code>**Func.pm**</code>, 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. + 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. -* For best performance, enable only the functions you really need. NOTE: <code>**outsidePREHandler**</code> and <code>**insidePREHandler**</code> are particularly expensive. +* For best performance, enable only the functions you really need. NOTE: `outsidePREHandler` and `insidePREHandler` are particularly expensive. ### <a name="Predefined_Hooks"> Predefined Hooks </a> -In addition to TWiki core functions, Plugins can use **predefined hooks**, or **call backs**, listed in the <code>**lib/TWiki/Plugins/EmptyPlugin.pm**</code> module. +In addition to TWiki core functions, Plugins can use **predefined hooks**, or **call backs**, listed in the `lib/TWiki/Plugins/EmptyPlugin.pm` module. -* All but the initPlugin are disabled. To enable a call back, remove <code>**DISABLE\_**</code> from the function name. +* All but the initPlugin are disabled. To enable a call back, remove `DISABLE_` from the function name. ### <a name="Plugin_Version_Detection"> Plugin Version Detection </a> -To eliminate the incompatibility problems bound to arise from active open Plugin development, a Plugin versioning system and an API <code>**GetVersion**</code> detection routine are provided for automatic compatibility checking. +To eliminate the incompatibility problems bound to arise from active open Plugin development, a Plugin versioning system and an API `GetVersion` detection routine are provided for automatic compatibility checking. -* All modules require a <code>**$VERSION='0.000'**</code> variable, beginning at <code>**1\.000**</code>. +* All modules require a `$VERSION='0.000'` variable, beginning at `1.000`. -* The <code>**initPlugin**</code> 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 <code>**initPlugin**</code> handler). +* 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). -* <code>**$VERSION='1.000'**</code> is the current setting in <code>**TWiki::Plugins.pm**</code> and in the preinstalled system Plugins ([[DefaultPlugin]], [[EmptyPlugin]], [[InterwikiPlugin]]). +* `$VERSION='1.000'` is the current setting in `TWiki::Plugins.pm` and in the preinstalled system Plugins ([[DefaultPlugin]], [[EmptyPlugin]], [[InterwikiPlugin]]). <a name="CreatePlugins"></a> @@ -136,16 +136,16 @@ With a reasonable knowledge of the Perl scripting language, you can create new P A basic TWiki Plugin consists of two elements: -* a Perl module, ex: <code>**MyFirstPlugin.pm**</code> -* a documentation topic, ex: <code>**MyFirstPlugin.txt**</code> +* a Perl module, ex: `MyFirstPlugin.pm` +* a documentation topic, ex: `MyFirstPlugin.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. In particular, files that should be web-accessible (graphics, Java applets ...) are best placed as attachments of the <code>**MyFirstPlugin**</code> topic. Other needed Perl code is best placed in a <code>**lib/TWiki/Plugins/MyFirstPlugin/**</code> directory. +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. In particular, files that should be web-accessible (graphics, Java applets ...) are best placed as attachments of the `MyFirstPlugin` topic. 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. ### <a name="Creating_the_Perl_Module"> Creating the Perl Module </a> -Copy file `lib/TWiki/Plugins/EmptyPlugin.pm` to <code>**<name>Plugin.pm**</code>. <code>**EmptyPlugin.pm**</code> contains no executable code, so it does nothing, but it's ready to be used. Customize it. Refer to the Plugin API specs for more information. +Copy file `lib/TWiki/Plugins/EmptyPlugin.pm` to `<name>Plugin.pm`. `EmptyPlugin.pm` contains no executable code, so it does nothing, but it's ready to be used. Customize it. Refer to the Plugin API specs for more information. <a name="CreatePluginTopic"></a> @@ -191,27 +191,27 @@ The Plugin documentation topic contains usage instructions and version details. ### <a name="Packaging_for_Distribution"> Packaging for Distribution </a> -A minimum Plugin release consists of a Perl module with a [[WikiName]] that ends in <code>**Plugin**</code>, ex: <code>**MyFirstPlugin.pm**</code>, and a documentation page with the same name(<code>**MyFirstPlugin.txt**</code>). +A minimum Plugin release consists of a Perl module with a [[WikiName]] that ends in `Plugin`, ex: `MyFirstPlugin.pm`, and a documentation page with the same name(`MyFirstPlugin.txt`). 1. Distribute the Plugin files in a directory structure that mirrors TWiki. If your Plugin uses additional files, include them ALL: - * <code>**lib/TWiki/Plugins/MyFirstPlugin.pm**</code> - * <code>**data/TWiki/MyFirstPlugin.txt**</code> - * <code>**pub/TWiki/MyFirstPlugin/uparrow.gif**</code> [a required graphic] -2. Create a zip archive with the Plugin name (<code>**MyFirstPlugin.zip**</code>) and add the entire directory structure from Step 1. The archive should look like this: - * <code>**lib/TWiki/Plugins/MyFirstPlugin.pm**</code> - * <code>**data/TWiki/MyFirstPlugin.txt**</code> - * <code>**pub/TWiki/MyFirstPlugin/uparrow.gif**</code> + * `lib/TWiki/Plugins/MyFirstPlugin.pm` + * `data/TWiki/MyFirstPlugin.txt` + * `pub/TWiki/MyFirstPlugin/uparrow.gif` [a required graphic] +2. Create a zip archive with the Plugin name (`MyFirstPlugin.zip`) and add the entire directory structure from Step 1. The archive should look like this: + * `lib/TWiki/Plugins/MyFirstPlugin.pm` + * `data/TWiki/MyFirstPlugin.txt` + * `pub/TWiki/MyFirstPlugin/uparrow.gif` <a name="PublishPlugin"></a> ### <a name="Publishing_for_Public_Use"> Publishing for Public Use </a> -You can release your tested, packaged Plugin to the TWiki community through the TWiki:Plugins web, where all Plugins submitted to TWiki.org are available for download and further development discussion. Publish your Plugin in three steps: +You can release your tested, packaged Plugin to the TWiki community through the TWiki:Plugins web. All Plugins submitted to TWiki.org are available for download and further development in TWiki:Plugins. Publish your Plugin in three steps: 1. **Post** the Plugin documentation topic in the TWiki:Plugins web: - * create a new topic using the Plugin name, ex: <code>**MyFirstPlugin.txt**</code>; - * paste in the topic text from Creating Plugin Documentation and Save. -2. **Attach** the distribution zip file to the topic, ex: <code>**MyFirstPlugin.zip**</code>. -3. **Link** from the doc page to a new, blank page named after the Plugin, and ending in <code>**Dev**</code>, ex: <code>**MyFirstPluginDev**</code>. This is the discussion page for future development. (User support for Plugins is handled in TWiki:Support.) + * create a new topic using the Plugin name, ex: `MyFirstPlugin.txt` + * paste in the topic text from Creating Plugin Documentation and save +2. **Attach** the distribution zip file to the topic, ex: `MyFirstPlugin.zip` +3. **Link** from the doc page to a new, blank page named after the Plugin, and ending in `Dev`, ex: `MyFirstPluginDev`. This is the discussion page for future development. (User support for Plugins is handled in TWiki:Support.) -- [[AndreaSterbini]] - 29 May 2001 <br /> -- [[MikeMannix]] - 01 Sep 2001 <br /> -- [[Main/PeterThoeny]] - 14 Sep 2001 <br /> |