/*-------------------------------------------------------------------------
* C-Pluff, a plug-in framework for C
* Copyright 2007 Johannes Lehtinen
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included
* in all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
* IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
* CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
* TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
*-----------------------------------------------------------------------*/
/**
* @page plugin Plug-in
*
* @section pluginOverview Overview
*
* Plug-in is the core element of an extensible application. The extensions and
* also the main application logic are implemented as plug-ins. Plug-ins can
* be developed, distributed and deployed independently, subject to
* inter-plugin dependencies. Deploying a new plug-in does not require
* recompilation or relinking if the operating system platform supports
* required dynamic linking facilities.
*
* @section pluginStructure Structure
*
* A plug-in includes the following structural elements.
*
* - @ref pluginDescriptor "Plug-in descriptor"
* - @ref pluginRuntime "Plug-in runtime library"
* - @ref pluginData "Static plug-in data"
*
* @subsection pluginDescriptor Plug-in descriptor
*
* A plug-in descriptor is an XML document describing a plug-in. It includes
* information about the contents of the plug-in, the features provided by
* the plug-in, plug-in version information and static dependencies of the
* plug-in. Most of the elements are optional. Most of the descriptor
* information described here is available to software via
* @ref cp_plugin_info_t structure. The plug-in descriptor must be located
* in the plug-in directory as @c plugin.xml.
*
* The formal declaration of plug-in descriptor is available as
* XML Schema Definition in @c plugin.xsd located in the top level source
* directory. Currently there is no namespace associated with the plug-in
* descriptor. Here is an example of a plug-in descriptor. Click element name
* to jump into documentation for that element.
*
*
*
* <plugin id="org.c-pluff.example" name="Example Plug-in" version="0.3.2" provider-name="Johannes Lehtinen">
* <backwards-compatibility abi="0.3" api="0.2.8"/>
* <requires>
* <c-pluff version="0.1"/>
* <import plugin="org.c-pluff.util" version="0.2"/>
* <import plugin="org.c-pluff.extra" optional="true"/>
* </requires>
* <runtime library="libruntime" funcs="org_cpluff_example_funcs"/>
* <extension-point id="editors" name="Text Editors" schema="editors_schema.xsd"/>
* <extension-point id="url-families"/>
* <extension point="org.c-pluff.util.archivers" id="tar" name="Tar Archiver Support">
* <type random-access="false"/>
* <exec bin="tar"/>
* </extension>
* <extension point="org.c-pluff.example.editors>
* <editor name="Text Editor" runtime="org_cpluff_example_txteditor_runtime">
* <file-types>
* <file-type mime-type="text/plain"/>
* </file-types>
* </editor>
* </extension>
* </plugin>
*
*
* <plugin id="org.c-pluff.useless"/>
*