AddOnPackageHowTo < Plugins

You are here: TWiki>

How to Create a New Add-on Package

Create add-on extension:
- Create & test scripts, Java code, wiki applications, or whatever else you need.
Create add-on documentation topic:
- Decide on a WikiWord that ends in -AddOn, such as MyFirstAddOn.
- Enter add-on topic name:
  Note: New topics are based on NewAddOnTemplate
- Do not save the topic yet, but copy the content to the clipboard.
- Paste the content to your own add-on topic in the TWiki web of your TWiki installation.
- Modify the topic as needed. The template should be self-explanatory, but if not, look at other add-on topics listed in AddOnPackage.
Create add-on package:
- Place add-on documentation topic and supporting topics in the TWiki web, place sample topics in the Sandbox web.
- Attach binary files to add-on topic and/or supporting topics (if applicable).
- Create a zip file that contains all add-on files, keeping the directory structure intact. Use exactly the same name as the add-on, such as MyFirstAddOn.zip.
Publish add-on on TWiki.org:
- Return to this topic here and use above form to create the add-on topic.
- This time, paste your topic text into the edit window, replacing the default topic text, and save.
- Attach the zip file to the add-on topic