configurationengine/doc/api/plugin.rst
author m2lahtel
Tue, 10 Aug 2010 14:29:28 +0300
changeset 3 e7e0ae78773e
parent 0 2e8eeb919028
permissions -rw-r--r--
ConE 1.2.11 release
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
     1
.. _plugin-api:
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     2
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
     3
Extending ConE with plugin API
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
     4
==============================
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     5
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
     6
The Plugin api is intended for extending the ConE functionality with plugins.
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
     7
Currently there are two ways to extend the functionality:
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
     8
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
     9
1. Adding support for new implementation languages
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    10
2. Extending ConfML or ImplML validation
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    11
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    12
Usually a plug-in that provides a new implementation language also provides
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    13
validation for it.
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    14
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    15
Developing a ConE plugin
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    16
------------------------
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    17
* See `Cone API epydoc <../epydoc/index.html>`_ for reference guide.
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    18
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    19
.. toctree::
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    20
    :maxdepth: 3
0
2e8eeb919028 Adding EPL version of configurationengine.
terytkon
parents:
diff changeset
    21
3
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    22
    ../plugins/dev-plugin/plugin-interface
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    23
    ../plugins/dev-plugin/index
e7e0ae78773e ConE 1.2.11 release
m2lahtel
parents: 0
diff changeset
    24
    ../plugins/dev-plugin/validation-plugin-index