Omea Open API and Plugin Development Kit

version 2.0, 6 Sep 2005

Archive Contents

This archive includes a set of documents, tools and sample code which will allow you to start developing Omea plugins. The archive includes:

• Omea OpenAPI.chm, a generated CHM help file for the Omea Open API assembly;
• OmeaPluginTutorial.html, a tutorial describing the development of an Omea plugin;
• SamplePlugins\Dictionary, a minimal sample plugin for Omea implementing a trivial action;
• SamplePlugins\Librarian, a sample plugin described in the tutorial;
• SamplePlugins\BloglinesPlugin, a sample plugin which allows to import the list of feed subscriptions from Bloglines.com;
• SamplePlugins\LiveJournalPlugin, a sample plugin which allows to import the list of a user's LiveJournal friends as RSS subscriptions in Omea;
• SamplePlugins\CategoryHotkeys, a sample plugin which allows to register hotkeys for assigning categories to resources;
• SamplePlugins\PostToConfluence, a sample plugin which allows to post the text of the selected resource as a page or blog post in Atlassian Confluence;
• DebugPlugin.dll, a plugin which provides several functions useful for Omea plugin developers.

The APIs described in the CHM file are valid for Omea Pro and Omea Reader version 2.0. The new API elements which have been added in the version 2.0 are labeled as such in the CHM file. The majority of the API is compatible between versions 1.0 and 2.0, but a number of rarely used or improperly designed APIs were removed in the version 2.0, so some of the plugins developed for version 1.0 may not be compatible with the version 2.0.

Browsing the Omea Database

We do not provide complete documentation on the resource types and property types used by Omea and its standard plugins. Instead, we provide a tool which lets you browse all the resources in your Omea resource store and all their properties and links.

A small introduction to the Omea data model can be found in this blog post.

In order to use the resource store browser, you will first need to install the debug plugin. The plugin (DebugPlugin.dll) is included in the Open API archive. You can install it from the Tools / Options / Omea / Plugins option page.

After you add the plugin and restart Omea, you will see a new menu "Debug" in the main menu. The first item in that menu, "Browse Resources...", will open the resource browser. It shows the list of all resource types on the left and the list of resources of each type to the right. Double-clicking a resource opens the window for viewing its properties.

You can also view the properties of a specific resource by right-clicking it and selecting "Show Properties..." from the context menu.

If you check "Show links" in the properties dialog, you will see links from the resource to other resources. Double-clicking the link will open the linked resource.

Questions?

Feel free to ask your questions by email (mailto:feedback.omea@jetbrains.com), in the jetbrains.omea.openapi newsgroup at news.jetbrains.com or in the Omea Plugin Development forum.