MyFirstPlugin::Attrs;= instead of just =Package Attrs;=. Then call it using:
use TWiki::Plugins::MyFirstPlugin::Attrs;
$var = MyFirstPlugin::Attrs->new();
#CreatePluginTopic
---+++ Writing the Documentation Topic
The Plugin documentation topic contains usage instructions and version details. It serves the Plugin files as %TWIKIWEB%.FileAttachments for downloading. (The doc topic is also included _in_ the [[#CreatePluginPackage][distribution package]].) To create a documentation topic:
1. *Copy* the Plugin topic template from TWiki.org. To copy the text, go to TWiki:Plugins/PluginPackage and:
* enter the Plugin name in the "How to Create a Plugin" section
* click Create
* select all in the Edit box & copy
* Cancel the edit
* go back to your site to the %TWIKIWEB% web
* In the GoBox enter your Plugin name, for example =MyFirstPlugin=, press enter and create the new topic
* paste & save new Plugin topic on your site
2. *Customize* your Plugin topic.
* In case you plan to publish your Plugin at TWiki.org, use Interwiki names for author names, like TWiki:Main/%WIKINAME%.
3. *Save* your topic, for use in [[#CreatePluginPackage][packaging]] and [[#PublishPlugin][publishing]] your Plugin.
*OUTLINE: Doc Topic Contents*
Check the Plugins web 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.>"
*Example:* <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!>"
*Plugin Settings:* <Description and settings for custom Plugin %VARIABLES%, and those required by TWiki.>"
* *Plugins Preferences* <If user settings are needed, explain... Entering values works exactly like %TWIKIWEB%.TWikiPreferences and WebPreferences: six (6) spaces and then:>"
* *Set <EXAMPLE = value added>*
*Plugin Installation Instructions:* <Step-by-step set-up guide, user help, whatever it takes to install and run, goes here.>"
*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.>"
#CreatePluginPackage
---+++ Packaging for Distribution
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=).
1. Distribute the Plugin files in a directory structure that mirrors TWiki. If your Plugin uses additional files, include them ALL:
* =lib/TWiki/Plugins/MyFirstPlugin.pm=
* =data/TWiki/MyFirstPlugin.txt=
* =pub/TWiki/MyFirstPlugin/uparrow.gif= [a required graphic]
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:
* =lib/TWiki/Plugins/MyFirstPlugin.pm=
* =data/TWiki/MyFirstPlugin.txt=
* =pub/TWiki/MyFirstPlugin/uparrow.gif=
#PublishPlugin
---+++ Publishing for Public Use
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:
1. *Post* the Plugin documentation topic in the TWiki:Plugins/PluginPackage:
* enter the Plugin name in the "How to Create a Plugin" section, for example =MyFirstPlugin=
* paste in the topic text from [[#CreatePluginTopic][Creating Plugin Documentation]] and save
1. *Attach* the distribution zip file to the topic, ex: =MyFirstPlugin.zip=
1. *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.)
1. *Put* the Plugin into the CVS repository, see TWiki:Plugins/ReadmeFirst (optional)
Thank you very much for sharing your Plugin with the TWiki community :-)
#RecommendedStorageOfPluginData
---++ Recommended Storage of Plugin Data
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.
---+++ Where to store Plugin Internal Data
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.
* The Plugin's attachment directory is =pubdir/Installweb/FooBarPlugin=
* =Installweb= refers to the name of the web where the Plugin is installed
* The Plugin's attachment URL is =%PUBURL%/Installweb/FooBarPlugin=
* The filename should start with an underscore, followed by an identifier, e.g. =_any_name.ext=
* The leading underscore avoids a nameclash with files attached to the Plugin topic
* Use only alphanumeric characters, underscores and periods to avoid platform dependency issues and URL issues
* Do not use subdirectories (rename and delete would fail)
* Use Plugin API functions documented in TWikiFuncModule to ensure portability:
* Use =getPubDir()= to get the attachment root directory
* Use =getUrlHost()= and =getPubUrlPath()= to build the URL in case you create content for the browser
* Use =$installWeb= to get the name of the web where the Plugin is installed
* Create the web directory and topic attachment directory if needed
* Hint: Package the Plugin at least with one file attachment. This ensures that the attachment directory already exists
---+++ Where to Store Data for Topics using the Plugin
In case the Plugin generates data which is specific to a topic, store it in the topic's attachment directory.
* The topic's attachment directory is =pubdir/Webname/TopicName=
* The topic's attachment URL is =%PUBURL%/Webname/TopicName=
* The filename should start with an underscore, followed by the Plugin name, an underscore and an identifier, e.g. =_FooBarPlugin_any_name.ext=
* The leading underscore avoids a nameclash with files attached to the same topic
* Use only alphanumeric characters, underscores and periods to avoid platform dependency issues and URL issues
* Do not use subdirectories (rename and delete would fail)
* Use Plugin API functions documented in TWiki.TWikiFuncModule to ensure portability:
* Use =getPubDir()= to get the attachment root directory
* Use =getUrlHost()= and =getPubUrlPath()= to build the URL in case you create content for the browser
Example code to build the file name:
sub _make_filename
{
my ( $web, $topic, $name ) = @_;
# Create web directory "pub/$web" if needed
my $dir = TWiki::Func::getPubDir() . "/$web";
unless( -e "$dir" ) {
umask( 002 );
mkdir( $dir, 0775 );
}
# Create topic directory "pub/$web/$topic" if needed
$dir .= "/$topic";
unless( -e "$dir" ) {
umask( 002 );
mkdir( $dir, 0775 );
}
return "$dir/_FooBarPlugin_$name";
}
-- TWiki:Main/PeterThoeny - 14 Aug 2004 %BR%
-- TWiki:Main/AndreaSterbini - 29 May 2001 %BR%
-- TWiki:Main/MikeMannix - 03 Dec 2001