diff options
author | MikeMannix <MikeMannix> | 2001-09-18 03:55:18 +0000 |
---|---|---|
committer | MikeMannix <MikeMannix> | 2001-09-18 03:55:18 +0000 |
commit | b689edc80e045be193698c578d1e71a1845093d0 (patch) | |
tree | 53663cdc6715f778cfe90d93b6c3cfd6e0a4ede5 /TWiki/TWikiPlugins.mdwn | |
parent | 5e57739235e28c1937ea58d7733eba08efed05b2 (diff) |
none
Diffstat (limited to 'TWiki/TWikiPlugins.mdwn')
-rw-r--r-- | TWiki/TWikiPlugins.mdwn | 36 |
1 files changed, 19 insertions, 17 deletions
diff --git a/TWiki/TWikiPlugins.mdwn b/TWiki/TWikiPlugins.mdwn index 17dff185..fc18173a 100644 --- a/TWiki/TWikiPlugins.mdwn +++ b/TWiki/TWikiPlugins.mdwn @@ -6,23 +6,23 @@ _Plug-in enhanced feature add-ons, with a Plugin API for developers_ ## <a name="Overview"> Overview </a> -You can add Plugins to extend TWiki's functionality, without altering the core program code. With a plug-in approach, you can: +You can add Plugins to extend TWiki's functionality, without altering the core program code. A plug-in approach lets you: * 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; * rapidly develop new TWiki functions in Perl using the Plugin API. -Everything to do with TWiki Plugins - demos, new releases, downloads, development, general discussion - is available at TWiki.org, in the **[[TWikiPlugins]] web**. +Everything to do with TWiki Plugins - demos, new releases, downloads, development, general discussion - is available at TWiki.org, in the ** TWiki:Plugins ** web. ## <a name="Preinstalled_Plugins"> Preinstalled Plugins </a> TWiki comes with three Plugins as part of the standard installation. -* **DefaultPlugin** handles some legacy TWiki variables that may be present in long-established sites. This option can be controlled from %TWIKIWEB%.TWikiPreferences. (Perl programmers can also add rules for simple custom processing.) +* **[[TWIKIWEBDefaultPlugin]]** optionally handles some legacy variables from older versions of TWiki. You can control this option from %TWIKIWEB%.TWikiPreferences. (Perl programmers can also add rules for simple custom processing.) -* **EmptyPlugin** is a fully functional module, minus active code; it does nothing and serves as a template for new Plugin development. +* **[[TWIKIWEBEmptyPlugin]]** 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: `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. +* **[[TWIKIWEBInterwikiPlugin]]** is preinstalled but can be disabled or removed. Use it for shorthand linking to remote sites, ex: `TWiki:Plugins` expands to TWiki:Plugins on TWiki.org. You can edit the predefined set of of Wiki-related sites, and add your own. <a name="InstallPlugin"></a> @@ -53,11 +53,11 @@ To test new Plugins on your installation before making them public, you may want * 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 `Test` 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> -Ideally, after you've installed a Plugin, just read the instructions and you're set. In fact, some Plugins require additional settings or offer extra options that you can modify on Preferences pages. You may want to make a Plugin available only in certain webs, or temporarily disable it. And having to list all available Plugins will probably come up. You can handle all of these with simple procedures. +When you finish installing a Plugin, you should be able to read the user instructions and go. In fact, some Plugins require additional settings or offer extra options that you have to select. Also, you may want to make a Plugin available only in certain webs, or temporarily disable it. And may want to list all available Plugins in certain topics. You can handle all of these management tasks with simple procedures. ### <a name="Setting_Preferences"> Setting Preferences </a> @@ -85,11 +85,11 @@ Plugin status variables let you list all active Plugins wherever needed. There a * 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. -> +> **DEMO: Automatically List Active Plugins Using Variables** > -> <code>%ACTIVATEDPLUGINS%</code><br /> On this TWiki site, the active Plugins are: %ACTIVATEDPLUGINS%. +> Using <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% +> Using <code>%PLUGINDESCRIPTIONS%</code>:<br /> You can use any of these active TWiki Plugins: %PLUGINDESCRIPTIONS% <a name="PluginAPI"></a> @@ -128,6 +128,8 @@ To eliminate the incompatibility problems bound to arise from active open Plugin With a reasonable knowledge of the Perl scripting language, you can create new Plugins or modify and extend existing ones. Basic plug-in architecture uses an Application Programming Interface (API), a set of software instructions that allow external code to interact with the main program. The TWiki Plugin API Plugins by providing a programming interface for TWiki. +<a name="DefaultPluginAlt"></a> + ### <a name="The_DefaultPlugin_Alternative"> The DefaultPlugin Alternative </a> * **DefaultPlugin** can handle some outdated TWiki variables, found, for example, in sites recently updated from an old version. Settings are in [[DefaultPlugin]] topic. You can also add your own simple custom processing rules here, though in all but very simple cases, writing a new Plugin is preferable. @@ -173,19 +175,19 @@ The Plugin documentation topic contains usage instructions and version details. > > 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. +> **Syntax Rules:** <_Describe any special text formatting that will be rendered._>" > -> **MyFirstPlugin Settings:** Description and settings for custom Plugin %VARIABLES%, and those required by TWiki. +> **MyFirstPlugin Settings:** <_Description and settings for custom Plugin %VARIABLES%, and those required by TWiki._>" > -> Plugins Preferences work exactly like %TWIKIWEB%.TWikiPreferences and [[WebPreferences]]: six (6) spaces and then: +> **Plugins Preferences** <_If user settings are needed, explain... Entering valuse works exactly like %TWIKIWEB%.TWikiPreferences and [[WebPreferences]]: six (6) spaces and then:_>" > -> * * Set EXAMPLE = got it! +> * * **Set <_EXAMPLE = value added_>** > -> **How-to Instructions:** Step-by-step set-up guide, user help, whatever it takes to install and run, goes here. +> **How-to Instructions:** <_Step-by-step set-up guide, user help, whatever it takes to install and run, goes here._>" > -> **Test Example:** Include an example of the Plugin in action: if it works, the installation was a success! +> **Test Example:** <_Include an example of the Plugin in action: if it works, the installation was a success!_>" > -> **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. +> **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._>" <a name="CreatePluginPackage"></a> |