none
[openafs-wiki.git] / TWiki / TWikiPlugins.mdwn
1 <div>
2   <ul>
3     <li><a href="#TWiki Plugins"> TWiki Plugins</a><ul>
4         <li><a href="#Overview"> Overview</a></li>
5         <li><a href="#Preinstalled Plugins"> Preinstalled Plugins</a></li>
6         <li><a href="#Installing Plugins"> Installing Plugins</a><ul>
7             <li><a href="#On-Site Pretesting"> On-Site Pretesting</a></li>
8           </ul>
9         </li>
10         <li><a href="#Managing Plugins"> Managing Plugins</a><ul>
11             <li><a href="#Setting Preferences"> Setting Preferences</a></li>
12             <li><a href="#Listing Active Plugins"> Listing Active Plugins</a></li>
13           </ul>
14         </li>
15         <li><a href="#The TWiki Plugin API"> The TWiki Plugin API</a><ul>
16             <li><a href="#Available Core Functions"> Available Core Functions</a></li>
17             <li><a href="#Predefined Hooks"> Predefined Hooks</a></li>
18             <li><a href="#Plugin Version Detection"> Plugin Version Detection</a></li>
19           </ul>
20         </li>
21         <li><a href="#Creating Plugins"> Creating Plugins</a><ul>
22             <li><a href="#The _DefaultPlugin Alternative"> The DefaultPlugin Alternative</a></li>
23             <li><a href="#Anatomy of a Plugin"> Anatomy of a Plugin</a></li>
24             <li><a href="#Creating the Perl Module"> Creating the Perl Module </a></li>
25             <li><a href="#Writing the Documentation Topic"> Writing the Documentation Topic</a></li>
26             <li><a href="#Packaging for Distribution"> Packaging for Distribution</a></li>
27             <li><a href="#Publishing for Public Use"> Publishing for Public Use</a></li>
28           </ul>
29         </li>
30       </ul>
31     </li>
32   </ul>
33 </div>
34
35 # <a name="TWiki Plugins"></a> TWiki Plugins
36
37 _Plug-in enhanced feature add-ons, with a Plugin API for developers_
38
39 ## <a name="Overview"></a> Overview
40
41 You can add Plugins to extend TWiki's functionality, without altering the core program code. A plug-in approach lets you:
42
43 - add virtually unlimited features while keeping the main TWiki code compact and efficient;
44 - heavily customize an installation and still do clean updates to new versions of TWiki;
45 - rapidly develop new TWiki functions in Perl using the Plugin API.
46
47 Everything to do with TWiki Plugins - demos, new releases, downloads, development, general discussion - is available at TWiki.org, in the ** TWiki:Plugins ** web.
48
49 ## <a name="Preinstalled Plugins"></a> Preinstalled Plugins
50
51 TWiki comes with three Plugins as part of the standard installation.
52
53 - **[[DefaultPlugin]]** optionally handles some legacy variables from older versions of TWiki. You can control this option from [[TWikiPreferences]]. (Perl programmers can also [[add rules|Main/WebHome#DefaultPluginAlt]] for simple custom processing.)
54
55 - **[[EmptyPlugin]]** is a fully functional module, minus active code; it does nothing and serves as a template for new Plugin development.
56
57 - **[[InterwikiPlugin]]** 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.
58
59 <a name="InstallPlugin"></a>
60
61 ## <a name="Installing Plugins"></a> Installing Plugins
62
63 Each TWikiPlugin comes with full documentation: step-by-step installation instructions, a detailed description of any special requirements, version details, and a working example for testing.
64
65 Most Plugins can be installed in three easy steps, with no programming skills required:
66
67 1. **Download** the zip file containing the Plugin, documentation, and any other required files, from TWiki:Plugins.
68 2. **Distribute** the files to their proper locations - unzip the zip archive in your TWiki installation directory - if have a standard TWiki installation, this will distribute automatically. Otherwise, place the files according to the directory paths listed on the Plugin top in TWiki:Plugins.
69 3. **Check** the demo example on the Plugin topic: if it's working, the installation was fine!
70
71 **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.
72
73 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.
74
75 - **Doc page:** Read all available info about the Plugin; download the attached distribution files.
76 - **Dev page:** Post feature requests, bug reports and general dev comments; topic title ends in `Dev` (`SomePluginDev`).
77 - **User support:** Post installation, how to use type questions (and answers, if you have them) in the TWiki:Support web.
78
79 <a name="PreTesting"></a>
80
81 ### <a name="On-Site Pretesting"></a> On-Site Pretesting
82
83 To test new Plugins on your installation before making them public, you may want to use one of these two approaches:
84
85 - **Method 1:** Safely test on-the-fly by creating separate Production and Test branches in your live TWiki installation.
86   - **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.
87   - **Test** Plugins and other new features in the Test installation until you're satisfied.
88     - %X% If you modify topics using the new features, live users will likely see unfamiliar new META tags showing up on their pages - to avoid this, create and edit test-only topics to try out new features.
89   - **Copy** the modified files to the Production installation. You can update a TWiki installation live and users won't even notice.
90
91 - **Method 2:** List the Plugin being tested in the `DISABLEDPLUGINS` variable in [[TWikiPreferences]]. Redefine the `DISABLEDPLUGINS` variable in the `Sandbox` web and do the testing there.
92
93 ## <a name="Managing Plugins"></a> Managing Plugins
94
95 When you finish [[installing a Plugin|Main/WebHome#InstallPlugin]], 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.
96
97 ### <a name="Setting Preferences"></a> Setting Preferences
98
99 Installed Plugins can be **toggled on or off**, site-wide or by web, through TWikiPreferences and individual WebPreferences:
100
101 - 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 [[TWikiPreferences]] are:
102   - `Set INSTALLEDPLUGINS = DefaultPlugin, ...`
103   - `Set DISABLEDPLUGINS = EmptyPlugin, ...`
104
105 **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 TWiki web is searched; and finally, the current web.
106
107 **Plugin-specific settings** are done in individual Plugin topics. Two settings are standard for each Plugin:
108
109 1. One line description, used to form the bullets describing the Plugins in the [[TextFormattingRules]] topic:
110   - `Set SHORTDESCRIPTION = Blah blah woof woof.`
111 2. Debug Plugin, output can be seen in `data/debug.txt`. Set to 0=off or 1=on:
112   - `Set DEBUG = 0`
113
114 - The settings can be retrieved as Preferences variables like `%<pluginname>_<var>%`, ex: `%DEFAULTPLUGIN_SHORTDESCRIPTION%` shows the description of the DefaultPlugin.
115
116 ### <a name="Listing Active Plugins"></a> Listing Active Plugins
117
118 Plugin status variables let you list all active Plugins wherever needed. There are two list formats:
119
120 - The `%ACTIVATEDPLUGINS%` variable lists activated Plugins by name. (This variable is displayed in [[TWikiPreferences]] for debugging use.)
121 - The `%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]].
122
123 > **DEMO: Automatically List Active Plugins Using Variables**
124 >
125 > Using `%ACTIVATEDPLUGINS%`:<br /> On this TWiki site, the active Plugins are: [[SpreadSheetPlugin]], [[CommentPlugin]], [[EditTablePlugin]], [[InterwikiPlugin]], [[PreferencesPlugin]], [[SlideShowPlugin]], [[SmiliesPlugin]], [[TablePlugin]], [[TwistyPlugin]].
126 >
127 > Using <code>%PLUGINDESCRIPTIONS%</code>:<br /> You can use any of these active TWiki Plugins:
128 >
129 > - [[SpreadSheetPlugin]] <span>(any TWiki, 10197)</span>:
130 > - [[CommentPlugin]] <span>(Dakar, 11359)</span>: Allows users to quickly post comments to a page without an edit/preview/save cycle
131 > - [[EditTablePlugin]] <span>(any TWiki, 11646)</span>:
132 > - [[InterwikiPlugin]] <span>(Dakar, $Rev: 11935$)</span>:
133 > - [[PreferencesPlugin]] <span>(Dakar, 9839)</span>:
134 > - [[SlideShowPlugin]] <span>(Any TWiki, $Rev: 12847$)</span>:
135 > - [[SmiliesPlugin]] <span>(Dakar, 8154)</span>:
136 > - [[TablePlugin]] <span>(1.020, 12339)</span>:
137 > - [[TwistyPlugin]] <span>(1.2.0, $Rev: 12154$)</span>:
138
139 <a name="PluginAPI"></a>
140
141 ## <a name="The TWiki Plugin API"></a> The TWiki Plugin API
142
143 The Application Programming Interface (API) for TWikiPlugins provides the specifications for hooking into the core TWiki code from your external Perl Plugin module. The Plugin API is new to the Production version of TWiki with the 01-Sep-2001 release.
144
145 ### <a name="Available Core Functions"></a> Available Core Functions
146
147 The `lib/TWiki/Func.pm` implements ALL official Plugin functions. Plugins should ONLY use functions published in this module.
148
149 %X% 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.
150
151 - For best performance, enable only the functions you really need. NOTE: `outsidePREHandler` and `insidePREHandler` are particularly expensive.
152
153 ### <a name="Predefined Hooks"></a> Predefined Hooks
154
155 In addition to TWiki core functions, Plugins can use **predefined hooks**, or **call backs**, listed in the `lib/TWiki/Plugins/EmptyPlugin.pm` module.
156
157 - All but the initPlugin are disabled. To enable a call back, remove `DISABLE_` from the function name.
158
159 ### <a name="Plugin Version Detection"></a> Plugin Version Detection
160
161 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.
162
163 - All modules require a `$VERSION='0.000'` variable, beginning at `1.000`.
164
165 - The `initPlugin` handler should check all dependencies and return TRUE if the initialization is OK or FALSE if something went wrong.
166   - The Plugin initialization code does not register a Plugin that returns FALSE (or that has no `initPlugin` handler).
167
168 - `$VERSION='1.000'` is the current setting in `TWiki::Plugins.pm` and in the preinstalled system Plugins ([[DefaultPlugin]], [[EmptyPlugin]], [[InterwikiPlugin]]).
169
170 <a name="CreatePlugins"></a>
171
172 ## <a name="Creating Plugins"></a> Creating Plugins
173
174 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|Main/WebHome#PluginAPI]] Plugins by providing a programming interface for TWiki.
175
176 <a name="DefaultPluginAlt"></a>
177
178 ### <a name="The _DefaultPlugin Alternative"></a> The DefaultPlugin Alternative
179
180 - **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.
181
182 ### <a name="Anatomy of a Plugin"></a> Anatomy of a Plugin
183
184 A basic TWiki Plugin consists of two elements:
185
186 - a Perl module, ex: `MyFirstPlugin.pm`
187 - a documentation topic, ex: `MyFirstPlugin.txt`
188
189 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.
190
191 The Plugin API handles the details of connecting your Perl module with main TWiki code. When you're familiar with the [[Plugin API|Main/WebHome#PluginAPI]], you're ready to develop Plugins.
192
193 ### <a name="Creating the Perl Module"></a> Creating the Perl Module
194
195 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|Main/WebHome#PluginAPI]] specs for more information.
196
197 <a name="CreatePluginTopic"></a>
198
199 ### <a name="Writing the Documentation Topic"></a> Writing the Documentation Topic
200
201 The Plugin documentation topic contains usage instructions and version details. It serves the Plugin files as [[FileAttachments]] for downloading. (The doc topic is also included _in_ the [[distribution package|Main/WebHome#CreatePluginPackage]].) To create a documentation topic:
202
203 1. **Copy** the Plugin topic template from [[EmptyPlugin]]. To copy the text, go to the page and:
204   - click Edit
205   - select all in the Edit box &amp; copy
206   - Cancel the edit
207   - paste &amp; save as a text file or new topic on your site
208 2. **Customize** the template for your Plugin; you'll probably want to post a working version on your local TWiki site.
209 3. **Save** your topic as a text file, for use in [[packaging|Main/WebHome#CreatePluginPackage]] and [[publishing|Main/WebHome#PublishPlugin]] your Plugin.
210
211 > **OUTLINE: Doc Topic Contents**
212 >
213 > <br />
214 >
215 > Check
216 >
217 > [[EmptyPlugin]]
218 >
219 > on TWiki.org for the latest Plugin doc topic template. Here's a quick overview of what's covered:
220 >
221 > **Syntax Rules:** &lt;_Describe any special text formatting that will be rendered._&gt;"
222 >
223 > **MyFirstPlugin Settings:** &lt;_Description and settings for custom Plugin %VARIABLES%, and those required by TWiki._&gt;"
224 >
225 > - **Plugins Preferences** &lt;_If user settings are needed, explain... Entering valuse works exactly like [[TWikiPreferences]] and [[WebPreferences]]: six (6) spaces and then:_&gt;"
226 >   - **Set &lt;_EXAMPLE = value added_&gt;**
227 >
228 > **How-to Instructions:** &lt;_Step-by-step set-up guide, user help, whatever it takes to install and run, goes here._&gt;"
229 >
230 > **Test Example:** &lt;_Include an example of the Plugin in action: if it works, the installation was a success!_&gt;"
231 >
232 > **Plugin Info:** &lt;_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._&gt;"
233
234 <a name="CreatePluginPackage"></a>
235
236 ### <a name="Packaging for Distribution"></a> Packaging for Distribution
237
238 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`).
239
240 1. Distribute the Plugin files in a directory structure that mirrors TWiki. If your Plugin uses additional files, include them ALL:
241   - `lib/TWiki/Plugins/MyFirstPlugin.pm`
242   - `data/TWiki/MyFirstPlugin.txt`
243   - `pub/TWiki/MyFirstPlugin/uparrow.gif` [a required graphic]
244 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:
245   - `lib/TWiki/Plugins/MyFirstPlugin.pm`
246   - `data/TWiki/MyFirstPlugin.txt`
247   - `pub/TWiki/MyFirstPlugin/uparrow.gif`
248
249 <a name="PublishPlugin"></a>
250
251 ### <a name="Publishing for Public Use"></a> Publishing for Public Use
252
253 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:
254
255 1. **Post** the Plugin documentation topic in the TWiki:Plugins web:
256   - create a new topic using the Plugin name, ex: `MyFirstPlugin.txt`
257   - paste in the topic text from [[Creating Plugin Documentation|Main/WebHome#CreatePluginTopic]] and save
258 2. **Attach** the distribution zip file to the topic, ex: `MyFirstPlugin.zip`
259 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.)
260
261 -- [[AndreaSterbini]] - 29 May 2001 <br /> -- [[PeterThoeny]] - 14 Sep 2001 <br /> -- [[MikeMannix]] - 03 Dec 2001