Sunday, 3 December 2006
blojsom Plugin API and Event/Listener API documentation
I needed an excuse to get motivated about flushing out the blojsom 3 wiki pages.
So ... I've put up pages describing the plugin API and the event/listener API.
Plugin API you ask?
Plugins allow developers to add to the capabilities of blojsom in a well-defined way. Plugins can be responsible for changing how an entry is displayed, adding or removing information to an entry, making information or objects available to the templates, etc. You are not limited to what you can do with plugins. In fact, the web-based administration console was developed as a series of plugins.
Event and Listener API you ask?
The blojsom event notification and listener API allows developers to write components that respond to events from other blojsom components in a well-defined way. For example, based on an event indicating that a blog entry was added or updated, a listener or plugin could be written to respond to that event and "ping" a weblog update notification service like weblogs.com or blo.gs. Another example might be a listener or plugin which e-mails a list of individuals when a blog entry has been added to a blog.
There are also some pages with plugin API examples and event/listener API examples. They're simple, but then decidedly so they illustrate key techniques of plugin development and things you might want to do with plugins.
Of course, this complements the "code" documentation that's already available (also here) if you want to see how some of the near 100+ plugins that have been written for blojsom.
Enjoy!
Posted by at 1:43 PM in blojsom ... all blojsom
