b07bcdc150e5349553ff29e49a7114e3eaa8304b
[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             <li><a href="#Checking that Plugins are Workin"> Checking that Plugins are Working on a Live Server</a></li>
9             <li><a href="#A Note on Plugin Performance"> A Note on Plugin Performance</a></li>
10           </ul>
11         </li>
12         <li><a href="#Managing Plugins"> Managing Plugins</a><ul>
13             <li><a href="#Setting Preferences"> Setting Preferences</a></li>
14             <li><a href="#Listing Active Plugins"> Listing Active Plugins</a></li>
15           </ul>
16         </li>
17         <li><a href="#The TWiki Plugin API"> The TWiki Plugin API</a><ul>
18             <li><a href="#Available Core Functions"> Available Core Functions</a></li>
19             <li><a href="#Predefined Hooks"> Predefined Hooks</a></li>
20             <li><a href="#Hints on Writing Fast Plugins"> Hints on Writing Fast Plugins</a></li>
21             <li><a href="#Plugin Version Detection"> Plugin Version Detection</a></li>
22           </ul>
23         </li>
24         <li><a href="#Creating Plugins"> Creating Plugins</a><ul>
25             <li><a href="#The _DefaultPlugin Alternative"> The DefaultPlugin Alternative</a></li>
26             <li><a href="#Anatomy of a Plugin"> Anatomy of a Plugin</a></li>
27             <li><a href="#Creating the Perl Module"> Creating the Perl Module </a></li>
28             <li><a href="#Writing the Documentation Topic"> Writing the Documentation Topic</a></li>
29             <li><a href="#Packaging for Distribution"> Packaging for Distribution</a></li>
30             <li><a href="#Publishing for Public Use"> Publishing for Public Use</a></li>
31           </ul>
32         </li>
33         <li><a href="#Recommended Storage of Plugin Da"> Recommended Storage of Plugin Data</a><ul>
34             <li><a href="#Where to store Plugin Internal D"> Where to store Plugin Internal Data</a></li>
35             <li><a href="#Where to Store Data for Topics u"> Where to Store Data for Topics using the Plugin</a></li>
36           </ul>
37         </li>
38       </ul>
39     </li>
40   </ul>
41 </div>
42
43 # <a name="TWiki Plugins"></a> TWiki Plugins
44
45 _Plug-in enhanced feature add-ons, with a Plugin API for developers_
46
47 ## <a name="Overview"></a> Overview
48
49 You can add Plugins to extend TWiki's functionality, without altering the core program code. A plug-in approach lets you:
50
51 - add virtually unlimited features while keeping the main TWiki code compact and efficient;
52 - heavily customize an installation and still do clean updates to new versions of TWiki;
53 - rapidly develop new TWiki functions in Perl using the Plugin API.
54
55 Everything to do with TWiki Plugins - demos, new releases, downloads, development, general discussion - is available at TWiki.org, in the ** TWiki:Plugins ** web.
56
57 ## <a name="Preinstalled Plugins"></a> Preinstalled Plugins
58
59 TWiki comes with a set of Plugins as part of the standard installation.
60
61 - [[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.)
62 - [[EmptyPlugin]]: Is a fully functional module, minus active code; it does nothing and serves as a template for new Plugin development.
63 - [[InterwikiPlugin]]: 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.
64 - [[EditTablePlugin]]: %EDITTABLEPLUGIN\_SHORTDESCRIPTION%
65 - [[RenderListPlugin]]: %RENDERLISTPLUGIN\_SHORTDESCRIPTION%
66 - [[SlideShowPlugin]]: %SLIDESHOWPLUGIN\_SHORTDESCRIPTION%
67 - [[SmiliesPlugin]]: %SMILIESPLUGIN\_SHORTDESCRIPTION%
68 - [[SpreadSheetPlugin]]: %SPREADSHEETPLUGIN\_SHORTDESCRIPTION%
69 - [[TablePlugin]]: %TABLEPLUGIN\_SHORTDESCRIPTION%
70
71 <a name="InstallPlugin"></a>
72
73 ## <a name="Installing Plugins"></a> Installing Plugins
74
75 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.
76
77 Most Plugins can be installed in three easy steps, with no programming skills required:
78
79 1. **Download** the zip file containing the Plugin, documentation, and any other required files, from TWiki:Plugins.
80 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.
81 3. **Check** the demo example on the Plugin topic: if it's working, the installation was fine!
82
83 **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.
84
85 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.
86
87 - **Doc page:** Read all available info about the Plugin; download the attached distribution files.
88 - **Dev page:** Post feature requests, bug reports and general dev comments; topic title ends in `Dev` (`SomePluginDev`).
89 - **User support:** Post installation, how to use type questions (and answers, if you have them) in the TWiki:Support web.
90
91 <a name="PreTesting"></a>
92
93 ### <a name="On-Site Pretesting"></a> On-Site Pretesting
94
95 To test new Plugins on your installation before making them public, you may want to use one of these two approaches:
96
97 - **Method 1:** Safely test on-the-fly by creating separate Production and Test branches in your live TWiki installation.
98   - **Duplicate** the `twiki/bin` and `twiki/lib` directories for the Test version, and adjust the paths in the new `lib/TWiki.cfg`. The following directories are shared: `twiki/data`, `twiki/templates` and `twiki/pub`.
99   - **Test** Plugins and other new features in the Test installation until you're satisfied.
100     - %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.
101   - **Copy** the modified files to the Production installation. You can update a TWiki installation live and users won't even notice.
102
103 - **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.
104
105 ### <a name="Checking that Plugins are Workin"></a> Checking that Plugins are Working on a Live Server
106
107 [[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.
108
109 ### <a name="A Note on Plugin Performance"></a> A Note on Plugin Performance
110
111 The performance of the system depends on the number of Plugins installed and on the Plugin implementation. Some Plugins impose no measurable performance decrease, some do. For example, `outsidePREHandler` is an expensive callback function, or a Plugin might use many Perl libraries that need to be initialized with each page view (unless you run mod\_perl). It is recommended to measure the performance with and without a new Plugin. Example for Unix:%BR% `time wget -qO /dev/null http://www.dementia.org/twiki//view/TWiki/AbcPlugin`
112
113 In case 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.)
114
115 ## <a name="Managing Plugins"></a> Managing Plugins
116
117 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.
118
119 ### <a name="Setting Preferences"></a> Setting Preferences
120
121 Installed Plugins can be **toggled on or off**, site-wide or by web, through TWikiPreferences and individual WebPreferences:
122
123 - 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:
124   - `Set INSTALLEDPLUGINS = DefaultPlugin, ...`
125   - `Set DISABLEDPLUGINS = EmptyPlugin, ...`
126
127 **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.
128
129 **Plugin-specific settings** are done in individual Plugin topics. Two settings are standard for each Plugin:
130
131 1. One line description, used to form the bullets describing the Plugins in the [[TextFormattingRules]] topic:
132   - `Set SHORTDESCRIPTION = Blah blah woof woof.`
133 2. Debug Plugin, output can be seen in `data/debug.txt`. Set to 0=off or 1=on:
134   - `Set DEBUG = 0`
135
136 - The settings can be retrieved as Preferences variables like `%<pluginname>_<var>%`, ex: `%DEFAULTPLUGIN_SHORTDESCRIPTION%` shows the description of the DefaultPlugin.
137
138 ### <a name="Listing Active Plugins"></a> Listing Active Plugins
139
140 Plugin status variables let you list all active Plugins wherever needed. There are two list formats:
141
142 - The `%ACTIVATEDPLUGINS%` variable lists activated Plugins by name. (This variable is displayed in [[TWikiPreferences]] for debugging use.)
143 - 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]].
144
145 > **DEMO: Automatically List Active Plugins Using Variables**
146 >
147 > Using `%ACTIVATEDPLUGINS%`:<br /> On this TWiki site, the active Plugins are: [[SpreadSheetPlugin]], [[CommentPlugin]], [[EditTablePlugin]], [[InterwikiPlugin]], [[PreferencesPlugin]], [[SlideShowPlugin]], [[SmiliesPlugin]], [[TablePlugin]], [[TwistyPlugin]].
148 >
149 > Using <code>%PLUGINDESCRIPTIONS%</code>:<br /> You can use any of these active TWiki Plugins:
150 >
151 > - [[SpreadSheetPlugin]] <span>(any TWiki, 10197)</span>:
152 > - [[CommentPlugin]] <span>(Dakar, 11359)</span>: Allows users to quickly post comments to a page without an edit/preview/save cycle
153 > - [[EditTablePlugin]] <span>(any TWiki, 11646)</span>:
154 > - [[InterwikiPlugin]] <span>(Dakar, $Rev: 11935$)</span>:
155 > - [[PreferencesPlugin]] <span>(Dakar, 9839)</span>:
156 > - [[SlideShowPlugin]] <span>(Any TWiki, $Rev: 12847$)</span>:
157 > - [[SmiliesPlugin]] <span>(Dakar, 8154)</span>:
158 > - [[TablePlugin]] <span>(1.020, 12339)</span>:
159 > - [[TwistyPlugin]] <span>(1.2.0, $Rev: 12154$)</span>:
160
161 <a name="PluginAPI"></a>
162
163 ## <a name="The TWiki Plugin API"></a> The TWiki Plugin API
164
165 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.
166
167 ### <a name="Available Core Functions"></a> Available Core Functions
168
169 The [[TWikiFuncModule]] (`lib/TWiki/Func.pm`) implements ALL official Plugin functions. Plugins should ONLY use functions published in this module.
170
171 %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.
172
173 ### <a name="Predefined Hooks"></a> Predefined Hooks
174
175 In addition to TWiki core functions, Plugins can use **predefined hooks**, or **call backs**, listed in the `lib/TWiki/Plugins/EmptyPlugin.pm` module.
176
177 - All but the initPlugin are disabled. To enable a call back, remove `DISABLE_` from the function name.
178 - For best performance, enable only the functions you really need. NOTE: `outsidePREHandler` and `insidePREHandler` are particularly expensive.
179
180 Most Plugins use either the `commonTagsHandler` or `startRenderingHandler` for rendering tasks:
181
182 - `commonTagsHandler:` Use it to expand `%XYZPLUGIN%` and `%XYZPLUGIN{...}%` variables
183 - `startRenderingHandler:` Use it for your own rendering rules or to overload TWiki's internal rendering like `[[links]]`
184
185 TWiki:Codev/StepByStepRenderingOrder helps you decide which rendering handler to use.
186
187 ### <a name="Hints on Writing Fast Plugins"></a> Hints on Writing Fast Plugins
188
189 - Delay the Plugin initialization to the actual function which is handling the tag. This way all the expensive initialization is done only when needed.
190 - For example, use an `eval` block like:%BR% `eval { require IPC::Run }` %BR% `return "<font color=\"red\">SamplePlugin: Can't load required modules ($@)</font>" if $@;`
191 - You could return errors as strings to show what happened
192 - You can use a flag to avoid running the initialization twice
193
194 ### <a name="Plugin Version Detection"></a> Plugin Version Detection
195
196 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.
197
198 - All modules require a `$VERSION='0.000'` variable, beginning at `1.000`.
199
200 - The `initPlugin` handler should check all dependencies and return TRUE if the initialization is OK or FALSE if something went wrong.
201   - The Plugin initialization code does not register a Plugin that returns FALSE (or that has no `initPlugin` handler).
202
203 - `$VERSION='1.000'` is the current setting in `TWiki::Plugins.pm` and in the preinstalled system Plugins ([[DefaultPlugin]], [[EmptyPlugin]], [[InterwikiPlugin]]).
204
205 <a name="CreatePlugins"></a>
206
207 ## <a name="Creating Plugins"></a> Creating Plugins
208
209 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.
210
211 <a name="DefaultPluginAlt"></a>
212
213 ### <a name="The _DefaultPlugin Alternative"></a> The DefaultPlugin Alternative
214
215 - **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.
216
217 ### <a name="Anatomy of a Plugin"></a> Anatomy of a Plugin
218
219 A basic TWiki Plugin consists of two elements:
220
221 - a Perl module, ex: `MyFirstPlugin.pm`
222 - a documentation topic, ex: `MyFirstPlugin.txt`
223
224 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.
225
226 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.
227
228 ### <a name="Creating the Perl Module"></a> Creating the Perl Module
229
230 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.
231
232 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:
233
234       use TWiki::Plugins::MyFirstPlugin::Attrs;
235       $var = MyFirstPlugin::Attrs->new();
236
237 <a name="CreatePluginTopic"></a>
238
239 ### <a name="Writing the Documentation Topic"></a> Writing the Documentation Topic
240
241 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:
242
243 1. **Copy** the Plugin topic template from TWiki.org. To copy the text, go to TWiki:Plugins/PluginPackage and:
244   - enter the Plugin name in the "How to Create a Plugin" section
245   - click Create
246   - select all in the Edit box &amp; copy
247   - Cancel the edit
248   - go back to your site to the TWiki web
249   - In the [[GoBox]] enter your Plugin name, for example `MyFirstPlugin`, press enter and create the new topic
250   - paste &amp; save new Plugin topic on your site
251 2. **Customize** your Plugin topic.
252   - In case you plan to publish your Plugin at TWiki.org, use Interwiki names for author names, like TWiki:Main/admin.
253 3. **Save** your topic, for use in [[packaging|Main/WebHome#CreatePluginPackage]] and [[publishing|Main/WebHome#PublishPlugin]] your Plugin.
254
255 > **OUTLINE: Doc Topic Contents**
256 >
257 > <br />
258 >
259 > Check the Plugins web on TWiki.org for the latest Plugin doc topic template. Here's a quick overview of what's covered:
260 >
261 > **Syntax Rules:** &lt;_Describe any special text formatting that will be rendered._&gt;"
262 >
263 > **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;"
264 >
265 > **Plugin Settings:** &lt;_Description and settings for custom Plugin %VARIABLES%, and those required by TWiki._&gt;"
266 >
267 > - **Plugins Preferences** &lt;_If user settings are needed, explain... Entering values works exactly like [[TWikiPreferences]] and [[WebPreferences]]: six (6) spaces and then:_&gt;"
268 >   - **Set &lt;_EXAMPLE = value added_&gt;**
269 >
270 > **Plugin Installation Instructions:** &lt;_Step-by-step set-up guide, user help, whatever it takes to install and run, goes here._&gt;"
271 >
272 > **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;"
273
274 <a name="CreatePluginPackage"></a>
275
276 ### <a name="Packaging for Distribution"></a> Packaging for Distribution
277
278 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`).
279
280 1. Distribute the Plugin files in a directory structure that mirrors TWiki. If your Plugin uses additional files, include them ALL:
281   - `lib/TWiki/Plugins/MyFirstPlugin.pm`
282   - `data/TWiki/MyFirstPlugin.txt`
283   - `pub/TWiki/MyFirstPlugin/uparrow.gif` [a required graphic]
284 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:
285   - `lib/TWiki/Plugins/MyFirstPlugin.pm`
286   - `data/TWiki/MyFirstPlugin.txt`
287   - `pub/TWiki/MyFirstPlugin/uparrow.gif`
288
289 <a name="PublishPlugin"></a>
290
291 ### <a name="Publishing for Public Use"></a> Publishing for Public Use
292
293 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. Publish your Plugin in these steps:
294
295 1. **Post** the Plugin documentation topic in the TWiki:Plugins/PluginPackage:
296   - enter the Plugin name in the "How to Create a Plugin" section, for example `MyFirstPlugin`
297   - paste in the topic text from [[Creating Plugin Documentation|Main/WebHome#CreatePluginTopic]] and save
298 2. **Attach** the distribution zip file to the topic, ex: `MyFirstPlugin.zip`
299 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.)
300 4. **Put** the Plugin into the CVS repository, see TWiki:Plugins/ReadmeFirst (optional)
301
302 Thank you very much for sharing your Plugin with the TWiki community :-)
303
304 <a name="RecommendedStorageOfPluginData"></a>
305
306 ## <a name="Recommended Storage of Plugin Da"></a> Recommended Storage of Plugin Data
307
308 Plugins sometimes need to store data. This can be Plugin internal data like cache data, or generated data for the browser like images. The following is a recommendation where to store the data.
309
310 ### <a name="Where to store Plugin Internal D"></a> Where to store Plugin Internal Data
311
312 In case the Plugin generates data just for internal use, or data which is not specific to a topic, store it in the Plugin's attachment directory.
313
314 - The Plugin's attachment directory is `pubdir/Installweb/FooBarPlugin`
315   - `Installweb` refers to the name of the web where the Plugin is installed
316 - The Plugin's attachment URL is `%PUBURL%/Installweb/FooBarPlugin`
317 - The filename should start with an underscore, followed by an identifier, e.g. `_any_name.ext`
318   - The leading underscore avoids a nameclash with files attached to the Plugin topic
319   - Use only alphanumeric characters, underscores and periods to avoid platform dependency issues and URL issues
320   - Do not use subdirectories (rename and delete would fail)
321 - Use Plugin API functions documented in [[TWikiFuncModule]] to ensure portability:
322   - Use `getPubDir()` to get the attachment root directory
323   - Use `getUrlHost()` and `getPubUrlPath()` to build the URL in case you create content for the browser
324   - Use `$installWeb` to get the name of the web where the Plugin is installed
325   - Create the web directory and topic attachment directory if needed
326 - Hint: Package the Plugin at least with one file attachment. This ensures that the attachment directory already exists
327
328 ### <a name="Where to Store Data for Topics u"></a> Where to Store Data for Topics using the Plugin
329
330 In case the Plugin generates data which is specific to a topic, store it in the topic's attachment directory.
331
332 - The topic's attachment directory is `pubdir/Webname/TopicName`
333 - The topic's attachment URL is `%PUBURL%/Webname/TopicName`
334 - The filename should start with an underscore, followed by the Plugin name, an underscore and an identifier, e.g. `_FooBarPlugin_any_name.ext`
335   - The leading underscore avoids a nameclash with files attached to the same topic
336   - Use only alphanumeric characters, underscores and periods to avoid platform dependency issues and URL issues
337   - Do not use subdirectories (rename and delete would fail)
338 - Use Plugin API functions documented in [[TWikiFuncModule]] to ensure portability:
339   - Use `getPubDir()` to get the attachment root directory
340   - Use `getUrlHost()` and `getPubUrlPath()` to build the URL in case you create content for the browser
341
342 Example code to build the file name:
343
344     sub _make_filename
345     {
346         my ( $web, $topic, $name ) = @_;
347
348         # Create web directory "pub/$web" if needed
349         my $dir = TWiki::Func::getPubDir() . "/$web";
350         unless( -e "$dir" ) {
351             umask( 002 );
352             mkdir( $dir, 0775 );
353         }
354         # Create topic directory "pub/$web/$topic" if needed
355         $dir .= "/$topic";
356         unless( -e "$dir" ) {
357             umask( 002 );
358             mkdir( $dir, 0775 );
359         }
360         return "$dir/_FooBarPlugin_$name";
361     }
362
363 -- TWiki:Main/PeterThoeny - 18 May 2004 %BR% -- TWiki:Main/AndreaSterbini - 29 May 2001 %BR% -- TWiki:Main/MikeMannix - 03 Dec 2001