• Do not register here on develop.twiki.org, login with your twiki.org account.
• Use View topic Item7848 for generic doc work for TWiki-6.1.1. Use View topic Item7851 for doc work on extensions that are not part of a release. More... Close
• Anything you create or change in standard webs (Main, TWiki, Sandbox etc) will be automatically reverted on every SVN update.
Does this site look broken?. Use the LitterTray web for test cases.

Ages ago I promised I would add work areas for plugins, so that they don't have to worry about where they can read and write files.

The spec is:

getWorkArea( $pluginName ) -> $directorypath

Gets a private directory for the plugin. The plugin is entirely responsible for managing this directory; TWiki will not read from it, or write to it.

The directory is guaranteed to exist, and to be writable by the webserver user. By default it will not be web accessible.

The directory and its contents are permanent, so plugins must be careful to keep their areas tidy.

For RcsWrap and RcsLite the directories will be saved under $cfg{RCS}{WorkAreaDir}


SVN 6848


OK, now we just have to get the plugin writers to re-write their plugins to use it. -- AJA

In addition, we have the convention that plugins can write to pub/Web/Topic/_PluginName. We should replace the naming convention with a workAreaDir call. e.g.

getWorkArea( $pluginName, $web, $topic )  -> $directoryPath

Returns pub/Web/Topic/_PluginName

I suspect having both general and topic-specific spaces areas are important. Do you agree?


Summary Need plugins work area
ReportedBy CrawfordCurrie
AppliesTo Engine
Priority Urgent
CurrentState Closed

Checkins 6847 6848 6849
Edit | Attach | Watch | Print version | History: r6 < r5 < r4 < r3 < r2 | Backlinks | Raw View |  Raw edit | More topic actions
Topic revision: r6 - 2005-10-08 - MartinCleaver
This site is powered by the TWiki collaboration platform Powered by PerlCopyright © 2008-2022 by the contributing authors. All material on this collaboration platform is the property of the contributing authors.
Ideas, requests, problems regarding TWiki? Send feedback