From NeOn Wiki

How to Write and Package a Plugin

Nearby: Plugin_Template, Quality_Assurance

Contents 1 Setting up NTK and writing the Plugin 2 Packaging 3 Updating 4 Documentation 4.1 Documentation Structure 4.1.1 Functional Description 4.1.2 User Documentation 4.1.3 Intended Usage in Case Studies

Setting up NTK and writing the Plugin

• Download Eclipse 3.5 ("Galileo") for Java EE developers e.g. at http://www.eclipse.org/downloads/.
• Install Subclipse for using SVN in Eclipse. Just check the update site http://subclipse.tigris.org/update_1.6.x in the "Help --> Software Updates" Section.
• Please check out the NeOn Toolkit (core) plugins on our source-forge repository
• Now the NTK is set up and you can write your plugin using Eclipse 3.5 and OWL API. Please check API_Migration for help with the API migration if you are still using Kaon2 API.
• Please do not use qualifiers in your version number.
• Please integrate GOntt into your plugin. Please check GOntt_Integration to do so.

Packaging

• We use a google code repository for the sources of the (non core) Plugins of NTK.
• Please commit to: https://neon-plugins.googlecode.com/svn/trunk/
• Felix will create the Feature and upload the packaged Feature to the update site
• Go to the wiki and fill in the form for your plugin
• Fill in the CODO-o-matic to generate an OWL file which you publish online (this is needed for the KaliMa Plugin)
• Add the URI of the Codo light description
• done!

Updating

If you made some changes in a plugin which is already on the update site, please proceed as follows:

• Increase the version number of your plugin. This is even necessary for small changes.
• Commit the changes on google code or the repository you use.
• Send an email to felix.kiechle@student.kit.edu.

Documentation

in plugin.xml:

<extension point="org.eclipse.help.toc">
   <toc extradir="html" primary="true" file="toc.xml"/>
</extension>

File toc.xml:

<?xml version="1.0" encoding="utf-8"?>
<?NLS TYPE="org.eclipse.help.toc"?>
<toc label="SPARQL Query Plugin">
   <topic label="Introduction" href="html/intro.html"/>
   <topic label="User Documentation" href="html/doc.html"/>
   <topic label="Use Cases" href="html/use.html"/>
</toc>

Other HTML files in directory html/

Documentation Structure

We fixed the following structure for the Eclipse help documentation during the WP6 Session in St. Goar:

Functional Description

High-level overview of what the plugin does (also in wiki)

User Documentation

How to use the plugin (fairly extensive with screenshots)

Intended Usage in Case Studies

Based on case studies describe what the plugins is useful for