buildrelease
[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="#Installing Plugins"> Installing Plugins</a><ul>
6             <li><a href="#On-Site Pretesting"> On-Site Pretesting</a></li>
7             <li><a href="#Some Notes on Plugin Performance"> Some Notes on Plugin Performance</a></li>
8           </ul>
9         </li>
10         <li><a href="#Managing Installed Plugins"> Managing Installed Plugins</a><ul>
11             <li><a href="#Enabling Plugins"> Enabling Plugins</a></li>
12             <li><a href="#Plugin Evaluation Order"> Plugin Evaluation Order</a></li>
13             <li><a href="#Plugin-Specific Settings"> Plugin-Specific Settings</a></li>
14             <li><a href="#Listing Active Plugins"> Listing Active Plugins</a><ul>
15                 <li><a href="#=%ACTIVATEDPLUGINS%="> %ACTIVATEDPLUGINS%</a></li>
16                 <li><a href="#=%PLUGINDESCRIPTIONS%="> %PLUGINDESCRIPTIONS%</a></li>
17                 <li><a href="#=%FAILEDPLUGINS%="> %FAILEDPLUGINS%</a></li>
18               </ul>
19             </li>
20           </ul>
21         </li>
22         <li><a href="#The TWiki Plugin API"> The TWiki Plugin API</a><ul>
23             <li><a href="#Available Core Functions"> Available Core Functions</a></li>
24             <li><a href="#Predefined Hooks"> Predefined Hooks</a></li>
25             <li><a href="#Hints on Writing Fast Plugins"> Hints on Writing Fast Plugins</a></li>
26             <li><a href="#Plugin Version Detection"> Plugin Version Detection</a></li>
27             <li><a href="#Security"> Security</a></li>
28           </ul>
29         </li>
30         <li><a href="#Creating Plugins"> Creating Plugins</a><ul>
31             <li><a href="#Anatomy of a Plugin"> Anatomy of a Plugin</a></li>
32             <li><a href="#Creating the Perl Module"> Creating the Perl Module </a></li>
33             <li><a href="#Measuring and Improving the Plug"> Measuring and Improving the Plugin Performance</a></li>
34             <li><a href="#Writing the Documentation Topic"> Writing the Documentation Topic</a></li>
35             <li><a href="#Packaging for Distribution"> Packaging for Distribution</a></li>
36             <li><a href="#Publishing for Public Use"> Publishing for Public Use</a></li>
37           </ul>
38         </li>
39         <li><a href="#Recommended Storage of Plugin Sp"> Recommended Storage of Plugin Specific Data</a><ul>
40             <li><a href="#Plugin Internal Data"> Plugin Internal Data</a></li>
41             <li><a href="#Web Accessible Data"> Web Accessible Data</a></li>
42           </ul>
43         </li>
44         <li><a href="#Maintaining Plugins"> Maintaining Plugins</a><ul>
45             <li><a href="#Discussions and Feedback on Plug"> Discussions and Feedback on Plugins</a></li>
46             <li><a href="#Maintaining Compatibility with E"> Maintaining Compatibility with Earlier TWiki Versions</a></li>
47             <li><a href="#Handling deprecated functions"> Handling deprecated functions</a></li>
48           </ul>
49         </li>
50       </ul>
51     </li>
52   </ul>
53 </div>
54
55 # <a name="TWiki Plugins"></a> TWiki Plugins
56
57 _Add functionality to TWiki with readily available Plugins; create Plugins based on APIs_
58
59 ## <a name="Overview"></a> Overview
60
61 You can add Plugins to extend TWiki functionality, without altering the core code. A plug-in approach lets you:
62
63 - add virtually unlimited features while keeping the main TWiki code compact and efficient;
64 - heavily customize an installation and still do clean updates to new versions of TWiki;
65 - rapidly develop new TWiki functions in Perl using the Plugin API.
66
67 Everything to do with TWiki Plugins - demos, new releases, downloads, development, general discussion - is available at TWiki.org, in the ** TWiki:Plugins ** web.
68
69 TWiki Plugins are developed and contributed by interested members of the community. Plugins are provided on an 'as is' basis; they are not a part of TWiki, but are independently developed and maintained.
70
71 **_%T% Tip:_** TWiki:TWiki.TWikiPluginsSupplement on TWiki.org has supplemental documentation on TWiki Plugins.
72
73 <a name="InstallPlugin"></a>
74
75 ## <a name="Installing Plugins"></a> Installing Plugins
76
77 Each TWiki Plugin comes with its own documentation: step-by-step installation instructions, a detailed description of any special requirements, version details, and a working example for testing. Many Plugins have an install script that automates these steps for you.
78
79 **Special Requirements:** Some Plugins need certain Perl modules to be preinstalled on the host system. Plugins may also use other resources, like graphics, other modules, applications, and templates. You should be able to find detailed instructions in the Plugin's documentation.
80
81 Each Plugin has a standard release topic, located in the TWiki:Plugins web at TWiki.org. There's usually a number of other related topics, such as a developers page, and an appraisal page.
82
83 <a name="PreTesting"></a>
84
85 ### <a name="On-Site Pretesting"></a> On-Site Pretesting
86
87 The recommended approach to testing new Plugins before making them public is to create a second local TWiki installation, and test the Plugin there. You can allow selected users access to the test area. Once you are satisifed that it won't compromise your main installation, you can install it there as well.
88
89 [[InstalledPlugins]] shows which Plugins are: 1) installed, 2) loading properly, and 3) what TWiki:Codev.PluginHandlers they invoke. Any failures are shown in the Errors section. The <code>[[%FAILEDPLUGINS%|Main/VarFAILEDPLUGINS]]</code> variable can be used to debug failures. You may also want to check your webserver error log and the various TWiki log files.
90
91 ### <a name="Some Notes on Plugin Performance"></a> Some Notes on Plugin Performance
92
93 The performance of the system depends to some extent on the number of Plugins installed and on the Plugin implementation. Some Plugins impose no measurable performance decrease, some do. For example, a Plugin might use many Perl libraries that need to be initialized with each page view (unless you run mod\_perl). You can only really tell the performance impact by installing the Plugin and by measuring the performance with and without the new Plugin. Use the TWiki:Plugins.PluginBenchmarkAddOn, or test manually with the Apache `ab` utility. Example on Unix:%BR% `time wget -qO /dev/null http://www.dementia.org/twiki/view/TWiki/AbcPlugin`
94
95 %T% If you need to install an "expensive" Plugin, and you need its functionality only in one web, you can place the Plugin topic into that web. TWiki will initialize the Plugin only if the Plugin topic is found (which won't be the case for other webs.)
96
97 <a name="ManagingPlugins"></a>
98
99 ## <a name="Managing Installed Plugins"></a> Managing Installed Plugins
100
101 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:
102
103 ### <a name="Enabling Plugins"></a> Enabling Plugins
104
105 Plugins can be enabled and disabled with the [configure](http://www.dementia.org/twiki/configure) script. An installed Plugin needs to be enabled before it can be used.
106
107 ### <a name="Plugin Evaluation Order"></a> Plugin Evaluation Order
108
109 By default, TWiki executes Plugins in alphabetical order on Plugin name. It is possible to change the order, for example to evaluate database variables before the speadsheet CALCs. This can be done with `{PluginsOrder}` in the Plugins section of [configure](http://www.dementia.org/twiki/configure).
110
111 ### <a name="Plugin-Specific Settings"></a> Plugin-Specific Settings
112
113 Plugin-specific settings are done in individual Plugin topics. Two settings are standard for each Plugin:
114
115 1. One line description, used to form the bullets describing the Plugins in the [[TextFormattingRules]] topic:
116   - `Set SHORTDESCRIPTION = Create dynamic foo bar reports`
117 2. Debug Plugin, output can be seen in `data/debug.txt`. Set to 0=off or 1=on:
118   - `Set DEBUG = 0`
119
120 - The settings can be retrieved as Preferences variables like `%<pluginname>_<var>%`. For example, `%DEFAULTPLUGIN_SHORTDESCRIPTION%` shows the description of the DefaultPlugin.
121
122 ### <a name="Listing Active Plugins"></a> Listing Active Plugins
123
124 Plugin status variables let you list all active Plugins wherever needed.
125
126 #### <a name="=%ACTIVATEDPLUGINS%="></a> `%ACTIVATEDPLUGINS%`
127
128 On this TWiki site, the enabled Plugins are: [[SpreadSheetPlugin]], [[CommentPlugin]], [[EditTablePlugin]], [[InterwikiPlugin]], [[PreferencesPlugin]], [[SlideShowPlugin]], [[SmiliesPlugin]], [[TablePlugin]], [[TwistyPlugin]].
129
130 #### <a name="=%PLUGINDESCRIPTIONS%="></a> `%PLUGINDESCRIPTIONS%`
131
132 - [[SpreadSheetPlugin]] <span>(any TWiki, 10197)</span>:
133 - [[CommentPlugin]] <span>(Dakar, 11359)</span>: Allows users to quickly post comments to a page without an edit/preview/save cycle
134 - [[EditTablePlugin]] <span>(any TWiki, 11646)</span>:
135 - [[InterwikiPlugin]] <span>(Dakar, $Rev: 11935$)</span>:
136 - [[PreferencesPlugin]] <span>(Dakar, 9839)</span>:
137 - [[SlideShowPlugin]] <span>(Any TWiki, $Rev: 12847$)</span>:
138 - [[SmiliesPlugin]] <span>(Dakar, 8154)</span>:
139 - [[TablePlugin]] <span>(1.020, 12339)</span>:
140 - [[TwistyPlugin]] <span>(1.2.0, $Rev: 12154$)</span>:
141
142 #### <a name="=%FAILEDPLUGINS%="></a> `%FAILEDPLUGINS%`
143
144 <table border="1">
145   <tr>
146     <th>Plugin</th>
147     <th>Errors</th>
148   </tr>
149   <tr valign="top">
150     <td>[[TWiki/SpreadSheetPlugin]]</td>
151     <td><pre>
152 Plugins: could not fully register SpreadSheetPlugin, no plugin topic
153 </pre></td>
154   </tr>
155   <tr valign="top">
156     <td>[[TWiki/CommentPlugin]]</td>
157     <td><pre>
158 Plugins: could not fully register CommentPlugin, no plugin topic
159 </pre></td>
160   </tr>
161   <tr valign="top">
162     <td>[[TWiki/EditTablePlugin]]</td>
163     <td><pre>
164 Plugins: could not fully register EditTablePlugin, no plugin topic
165 </pre></td>
166   </tr>
167   <tr valign="top">
168     <td>[[TWiki/InterwikiPlugin]]</td>
169     <td><pre>
170 Plugins: could not fully register InterwikiPlugin, no plugin topic
171 </pre></td>
172   </tr>
173   <tr valign="top">
174     <td>[[TWiki/PreferencesPlugin]]</td>
175     <td><pre>
176 Plugins: could not fully register PreferencesPlugin, no plugin topic
177 </pre></td>
178   </tr>
179   <tr valign="top">
180     <td>[[TWiki/SlideShowPlugin]]</td>
181     <td><pre>
182 Plugins: could not fully register SlideShowPlugin, no plugin topic
183 </pre></td>
184   </tr>
185   <tr valign="top">
186     <td>[[TWiki/SmiliesPlugin]]</td>
187     <td><pre>
188 Plugins: could not fully register SmiliesPlugin, no plugin topic
189 </pre></td>
190   </tr>
191   <tr valign="top">
192     <td>[[TWiki/TablePlugin]]</td>
193     <td><pre>
194 Plugins: could not fully register TablePlugin, no plugin topic
195 </pre></td>
196   </tr>
197   <tr valign="top">
198     <td>[[TWiki/TwistyPlugin]]</td>
199     <td><pre>
200 Plugins: could not fully register TwistyPlugin, no plugin topic
201 </pre></td>
202   </tr>
203 </table>
204 <table border="1">
205   <tr>
206     <th>Handler</th>
207     <th>Plugins</th>
208   </tr>
209   <tr valign="top">
210     <td>beforeCommonTagsHandler</td>
211     <td>PreferencesPlugin<br />TwistyPlugin</td>
212   </tr>
213   <tr valign="top">
214     <td>beforeSaveHandler</td>
215     <td>CommentPlugin</td>
216   </tr>
217   <tr valign="top">
218     <td>commonTagsHandler</td>
219     <td>SpreadSheetPlugin<br />CommentPlugin<br />EditTablePlugin<br />SlideShowPlugin<br />SmiliesPlugin</td>
220   </tr>
221   <tr valign="top">
222     <td>initPlugin</td>
223     <td>SpreadSheetPlugin<br />CommentPlugin<br />EditTablePlugin<br />InterwikiPlugin<br />PreferencesPlugin<br />SlideShowPlugin<br />SmiliesPlugin<br />TablePlugin<br />TwistyPlugin</td>
224   </tr>
225   <tr valign="top">
226     <td>postRenderingHandler</td>
227     <td>EditTablePlugin<br />PreferencesPlugin<br />TwistyPlugin</td>
228   </tr>
229   <tr valign="top">
230     <td>preRenderingHandler</td>
231     <td>InterwikiPlugin<br />SmiliesPlugin<br />TablePlugin</td>
232   </tr>
233 </table>
234
235 **9 plugins**
236
237 <a name="PluginAPI"></a>
238
239 ## <a name="The TWiki Plugin API"></a> The TWiki Plugin API
240
241 The Application Programming Interface (API) for TWiki Plugins provides the specifications for hooking into the core TWiki code from your external Perl Plugin module.
242
243 ### <a name="Available Core Functions"></a> Available Core Functions
244
245 The [[TWikiFuncDotPm]] module (`lib/TWiki/Func.pm`) describes **all** the interfaces available to Plugins. Plugins should **only** use the interfaces described in this module.
246
247 **_%X% Note:_** If you use other core functions not described 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.
248
249 ### <a name="Predefined Hooks"></a> Predefined Hooks
250
251 In addition to TWiki core functions, Plugins can use **predefined hooks**, or **callbacks**, as described in the `lib/TWiki/Plugins/EmptyPlugin.pm` module.
252
253 - All but the initPlugin are disabled. To enable a callback, remove `DISABLE_` from the function name.
254
255 TWiki:Codev/StepByStepRenderingOrder helps you decide which rendering handler to use.
256
257 <a name="FastPluginHints"></a>
258
259 ### <a name="Hints on Writing Fast Plugins"></a> Hints on Writing Fast Plugins
260
261 - Delay initialization as late as possible. For example, if your Plugin is a simple syntax processor, you might delay loading extra Perl modules until you actually see the syntax in the text.
262 - For example, use an `eval` block like this:%BR% `eval { require IPC::Run }` %BR% `return "<font color=\"red\">SamplePlugin: Can't load required modules ($@)</font>" if $@;`
263 - You can use a flag to avoid running the initialization twice
264 - The TWiki:Plugins.PluginBenchmarkAddOn comes in handy to measure and fine-tune the performance of your Plugin
265
266 ### <a name="Plugin Version Detection"></a> Plugin Version Detection
267
268 To eliminate the incompatibility problems bound to arise from active open Plugin development, a Plugin versioning system is provided for automatic compatibility checking.
269
270 - All modules require a `$VERSION='0.000'` variable, beginning at `1.000`.
271
272 - The `initPlugin` handler should check all dependencies and return TRUE if the initialization is OK or FALSE if something went wrong.
273   - The Plugin initialization code does not register a Plugin that returns FALSE (or that has no `initPlugin` handler).
274
275 - `$TWiki::Plugins::VERSION` in the `TWiki::Plugins` module contains the TWiki Plugin API version, currently **1\.11**.
276   - You can also use the <code>[[%PLUGINVERSION{}%|Main/VarPLUGINVERSION]]</code> variable to query the Plugin API version or the version of installed Plugins.
277
278 ### <a name="Security"></a> Security
279
280 - Badly written Plugins can open huge security holes in TWiki. This is especially true if care isn't taken to prevent execution of arbitrary commands on the server.
281 - Don't allow sensitive configuration data to be edited by users. it is better to add sensitive configuration options to the `%TWiki::cfg` hash than adding it as preferences in the Plugin topic
282   - See TWiki:Plugins.MailInContrib for an example of this
283   - TWiki:Plugins.BuildContrib can help you with this
284 - Always use the TWiki::Sandbox to execute commands.
285 - Always audit the Plugins you install, and make sure you are happy with the level of security provided. While every effort is made to monitor Plugin authors activities, at the end of the day they are uncontrolled user contributions.
286
287 <a name="CreatePlugins"></a>
288
289 ## <a name="Creating Plugins"></a> Creating Plugins
290
291 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.
292
293 ### <a name="Anatomy of a Plugin"></a> Anatomy of a Plugin
294
295 A basic TWiki Plugin consists of two elements:
296
297 - a Perl module, ex: `MyFirstPlugin.pm`
298 - a documentation topic, ex: `MyFirstPlugin.txt`
299
300 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.
301
302 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.
303
304 ### <a name="Creating the Perl Module"></a> Creating the Perl Module
305
306 Copy file `lib/TWiki/Plugins/EmptyPlugin.pm` to `<name>Plugin.pm`. The `EmptyPlugin.pm` module contains mostly empty functions, 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.
307
308 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:
309
310     use TWiki::Plugins::MyFirstPlugin::Attrs;
311     $var = MyFirstPlugin::Attrs->new();
312
313 <a name="MeasurePerformance"></a>
314
315 ### <a name="Measuring and Improving the Plug"></a> Measuring and Improving the Plugin Performance
316
317 A high quality Plugin performs well. You can use the TWiki:Plugins.PluginBenchmarkAddOn to measure your TWiki:Plugins.PluginBenchmarks. The data is needed as part of the Documentation Topic.
318
319 See also [[Hints on Writing Fast Plugins|Main/WebHome#FastPluginHints]].
320
321 <a name="CreatePluginTopic"></a>
322
323 ### <a name="Writing the Documentation Topic"></a> Writing the Documentation Topic
324
325 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:
326
327 1. **Copy** the Plugin topic template from TWiki.org. To copy the text, go to TWiki:Plugins/PluginPackage and:
328   - enter the Plugin name in the "How to Create a Plugin" section
329   - click Create
330   - select all in the Edit box &amp; copy
331   - Cancel the edit
332   - go back to your site to the TWiki web
333   - In the [[GoBox]] enter your Plugin name, for example `MyFirstPlugin`, press enter and create the new topic
334   - paste &amp; save new Plugin topic on your site
335 2. **Customize** your Plugin topic.
336   - Important: In case you plan to publish your Plugin on TWiki.org, use Interwiki names for author names and links to TWiki.org topics, such as TWiki:Main/admin. This is important because links should work properly in a Plugin topic installed on any TWiki, not just on TWiki.org.
337 3. **Document** the performance data you gathered while [[measuring the performance|Main/WebHome#MeasurePerformance]]
338 4. **Save** your topic, for use in [[packaging|Main/WebHome#CreatePluginPackage]] and [[publishing|Main/WebHome#PublishPlugin]] your Plugin.
339
340 > **OUTLINE: Doc Topic Contents**
341 >
342 > <br />
343 >
344 > Check the Plugins web on TWiki.org for the latest Plugin doc topic template. Here's a quick overview of what's covered:
345 >
346 > **Syntax Rules:** &lt;_Describe any special text formatting that will be rendered._&gt;"
347 >
348 > **Example:** &lt;_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!_&gt;"
349 >
350 > **Plugin Settings:** &lt;_Description and settings for custom Plugin %VARIABLES%, and those required by TWiki._&gt;"
351 >
352 > - **Plugins Preferences** &lt;_If user settings are needed, explain... Entering values works exactly like [[TWikiPreferences]] and [[WebPreferences]]: six (6) spaces and then:_&gt;"
353 >   - **Set &lt;_EXAMPLE = value added_&gt;**
354 >
355 > **Plugin Installation Instructions:** &lt;_Step-by-step set-up guide, user help, whatever it takes to install and run, goes here._&gt;"
356 >
357 > **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;"
358
359 <a name="CreatePluginPackage"></a>
360
361 ### <a name="Packaging for Distribution"></a> Packaging for Distribution
362
363 The TWiki:Plugins.BuildContrib is a powerful build environment that is used by the TWiki project to build TWiki itself, as well as many of the Plugins. You don't **have** to use it, but it is highly recommended!
364
365 If you don't want (or can't) use the BuildContrib, then 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`).
366
367 1. Distribute the Plugin files in a directory structure that mirrors TWiki. If your Plugin uses additional files, include them all:
368   - `lib/TWiki/Plugins/MyFirstPlugin.pm`
369   - `data/TWiki/MyFirstPlugin.txt`
370   - `pub/TWiki/MyFirstPlugin/uparrow.gif` [a required graphic]
371 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:
372   - `lib/TWiki/Plugins/MyFirstPlugin.pm`
373   - `data/TWiki/MyFirstPlugin.txt`
374   - `pub/TWiki/MyFirstPlugin/uparrow.gif`
375
376 <a name="PublishPlugin"></a>
377
378 ### <a name="Publishing for Public Use"></a> Publishing for Public Use
379
380 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/PluginPackage.
381
382 Publish your Plugin by following these steps:
383
384 1. **Post** the Plugin documentation topic in the TWiki:Plugins/PluginPackage:
385   - enter the Plugin name in the "How to Create a Plugin" section, for example `MyFirstPlugin`
386   - paste in the topic text from [[Writing the Documentation Topic|Main/WebHome#CreatePluginTopic]] and save
387 2. **Attach** the distribution zip file to the topic, ex: `MyFirstPlugin.zip`
388 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.)
389 4. **Put** the Plugin into the SVN repository, see TWiki:Plugins/ReadmeFirst (optional)
390
391 %N% Once you have done the above steps once, you can use the BuildContrib to upload updates to your Plugin.
392
393 Thank you very much for sharing your Plugin with the TWiki community :-)
394
395 <a name="RecommendedStorageOfPluginData"></a>
396
397 ## <a name="Recommended Storage of Plugin Sp"></a> Recommended Storage of Plugin Specific Data
398
399 Plugins sometimes need to store data. This can be Plugin internal data such as cache data, or data generated for browser consumption such as images. Plugins should store data using [[TWikiFuncDotPm]] functions that support saving and loading of topics and attachments.
400
401 ### <a name="Plugin Internal Data"></a> Plugin Internal Data
402
403 You can create a Plugin "work area" using the `TWiki::Func::getWorkArea()` function, which gives you a persistant directory where you can store data files. By default they will not be web accessible. The directory is guaranteed to exist, and to be writable by the webserver user. For convenience, `TWiki::Func::storeFile()` and `TWiki::Func::readFile()` are provided to persistently store and retrieve simple data in this area.
404
405 ### <a name="Web Accessible Data"></a> Web Accessible Data
406
407 **_Topic-specific data_** such as generated images can be stored in the topics attachment area, which is web accessible. Use the `TWiki::Func::saveAttachment()` function to store the data.
408
409 Recommendation for file name:
410
411 - Prefix the filename with an underscore (the leading underscore avoids a nameclash with files attached to the same topic)
412 - Identify where the attachment originated from, typically by including the Plugin name in the file name
413 - Use only alphanumeric characters, underscores, dashes and periods to avoid platform dependency issues and URL issues
414 - Example: `_FooBarPlugin_img123.gif`
415
416 **_Web specific data_** can be stored in the Plugin's attachment area, which is web accessible. Use the `TWiki::Func::saveAttachment()` function to store the data.
417
418 Recommendation for file names in Plugin attachment area:
419
420 - Prefix the filename with an underscore
421 - Include the name of the web in the filename
422 - Use only alphanumeric characters, underscores, dashes and periods to avoid platform dependency issues and URL issues
423 - Example: `_Main_roundedge-ul.gif`
424
425 <a name="MaintainPlugins"></a>
426
427 ## <a name="Maintaining Plugins"></a> Maintaining Plugins
428
429 ### <a name="Discussions and Feedback on Plug"></a> Discussions and Feedback on Plugins
430
431 Each published Plugin has a Plugin development topic on TWiki.org. Plugin development topics are named after your Plugin and end in `Dev`, such as `MyFirstPluginDev`. The Plugin development topic is a great resource to discuss feature enhancements and to get feedback from the TWiki community.
432
433 ### <a name="Maintaining Compatibility with E"></a> Maintaining Compatibility with Earlier TWiki Versions
434
435 The Plugin interface ([[TWikiFuncDotPm]] functions and handlers) evolve over time. TWiki 4.0 introduced new API functions to address the needs of Plugin authors. It also deprecated some functions. Some Plugins written for earlier TWiki releases using unofficial TWiki internal functions no longer work on the TWiki 4.0 codebase. All this means that some Plugins need to be updated to work on the TWiki 4.0 codebase.
436
437 Organizations typically do not upgrade to the latest TWiki for many months. However, many administrators still would like to install the latest versions of a Plugin on their older TWiki installation. This need is fullfilled if Plugins are maintained in a compatible manner.
438
439 **_%T% Tip:_** Plugins can be written to be compatible with older and newer TWiki releases. This can be done also for Plugins using unofficial TWiki internal functions of an earlier release that no longer work on the latest TWiki codebase. TWiki:TWiki.TWikiPluginsSupplement#MaintainPlugins has more.
440
441 ### <a name="Handling deprecated functions"></a> Handling deprecated functions
442
443 From time-to-time, the TWiki developers will add new functions to the interface (either to [[TWikiFuncDotPm]], or new handlers). Sometimes these improvements mean that old functions have to be deprecated to keep the code manageable. When this happens, the deprecated functions will be supported in the interface for at least one more TWiki release, and probably longer, though this cannot be guaranteed.
444
445 When a plugin defines deprecated handlers, a warning will be shown in the list generated by %FAILEDPLUGINS%. Admins who see these warnings should check TWiki.org and if necessary, contact the plugin author, for an updated version of the plugin.
446
447 Updated plugins may still need to define deprecated handlers for compatibility with old TWiki versions. In this case, the plugin package that defines old handlers can suppress the warnings in %FAILEDPLUGINS%.
448
449 This is done by defining a map from the handler name to the `TWiki::Plugins` version _in which the handler was first deprecated_. For example, if we need to define the `endRenderingHandler` for compatibility with `TWiki::Plugins` versions before 1.1, we would add this to the plugin:
450
451     package TWiki::Plugins::SinkPlugin;
452     use vars qw( %TWikiCompatibility );
453     $TWikiCompatibility{endRenderingHandler} = 1.1;
454
455 If the currently-running TWiki version is 1.1 _or later_, then the _handler will not be called_ and _the warning will not be issued_. TWiki with versions of `TWiki::Plugins` before 1.1 will still call the handler as required.
456
457 **_Related Topics:_** [[DeveloperDocumentationCategory]], [[AdminDocumentationCategory]], TWiki:TWiki.TWikiPluginsSupplement
458
459 -- **_Contributors:_** TWiki:Main.PeterThoeny, TWiki:Main.AndreaSterbini, TWiki:MainMikeMannix, TWiki:CrawfordCurrie