Changeset 3759 for trunk/doc/src/docbook/developerdoc/plugin_developer.xml

Timestamp:

Sep 20, 2007, 11:23:59 AM (15 years ago)

Author:

Martin Svensson

Message:

References #364, documentation

File:

• trunk/doc/src/docbook/developerdoc/plugin_developer.xml (modified) (1 diff)

trunk/doc/src/docbook/developerdoc/plugin_developer.xml

@@ -156 +156 @@
       <title>With Eclipse</title>
       <para>
-        If somebody is willing to add information to this
-        chapter please send us a note or some written text to put here.
-        Otherwise, this chapter will be removed.
+        If somebody is willing to add information to this chapter please send us a note or
+        some written text to put here. Otherwise, this chapter will be removed.
       </para>
     </sect2>
-    
+
     <sect2 id="plugin_developer.organize.autoinstallcompatible">
       <title>To be installed with auto install</title>
       <para>
-      
+        A jar-file with plugins needs to have a specific XML-file in it's
+        <filename>META-INF</filename>
+        folder if the plugins should be possible to use with the auto installation in BASE.
+        The XML-file should have the name
+        <filename>base-plugins.xml</filename>
+        and be in the format described below.
+      </para>
+      <programlisting>&lt;?xml version="1.0" encoding="UTF-8"?&gt;
+&lt;!DOCTYPE plugins SYSTEM "../src/core/net/sf/basedb/core/dtd/base-plugins.dtd" &gt;
+&lt;plugins jarname="<filename>jarfile.jar</filename>"&gt;
+  &lt;pluginclass classname="<classname>se.lu.thep.PluginClass</classname>"&gt;
+    &lt;minbaseversion&gt;2.4&lt;/minbaseversion&gt;
+    &lt;hasconfigurations/&gt;
+    &lt;/pluginclass&gt;
+    .
+    .
+    .
+&lt;/plugins&gt;</programlisting>
+      <para>
+        The first two lines should be the same in all base-plugins.xml, rest of the tags are
+        described in following list.
+        <variablelist>
+          <varlistentry>
+            <term><sgmltag class="element">plugins</sgmltag></term>
+            <listitem>
+              <para>
+                This is the root element in the XML-file and must have the
+                attribute
+                <sgmltag class="attribute">jarname</sgmltag>
+                set. The attribute should hold the name of the jar-file the XML-file
+                is in.
+              </para>
+            </listitem>
+          </varlistentry>
+          <varlistentry>
+            <term>
+              <sgmltag class="element">pluginclass</sgmltag>
+            </term>
+            <listitem>
+              <para>
+                This tag defines information about each plugin in the jar-file. The
+                <sgmltag class="attribute">classname</sgmltag>
+                attribute needs to have the full classname of the plugin's main
+                class. There can be one or several of this element inside the
+                <sgmltag>plugins</sgmltag>
+                tag, which means that there should be one pluginclass-element for
+                each plugin in the jar.
+              </para>
+            </listitem>
+          </varlistentry>
+          <varlistentry>
+            <term>
+              <sgmltag class="element">minbaseversion</sgmltag>
+            </term>
+            <listitem>
+              <para>
+                A required child element in
+                <sgmltag class="element">pluginclass</sgmltag>
+                . This defines from which version of BASE the plugin can be used.
+                The plugin will not be included in auto installer if the
+                BASE-version is lower then the value of this tag. Format of the
+                value in this tag should be
+                <emphasis>majorversion</emphasis>.<emphasis>minorversion</emphasis>
+              </para>
+            </listitem>
+          </varlistentry>
+          <varlistentry>
+            <term>
+              <sgmltag class="element">hasconfigurations</sgmltag>              
+            </term>
+            <listitem>
+              <para>
+                A required child element in
+                <sgmltag class="element">pluginclass</sgmltag>
+                . This should have information if there are plugin configurations
+                that are shipped with the plugin. Setting the value to
+                <emphasis>yes</emphasis>
+                will indicate that there are available configurations in the
+                jar-file. This can be left as an empty tag if no
+                configurations are available for import.
+              </para>
+              <para>
+                Configurations shipped with a jar-file should be exported with the
+                plugin configuration exporter in BASE. The exported file should have
+                the name
+                <filename>base-configurations.xml</filename>
+                . This file has to be put in the jar-file's
+                <filename class="directory">META-INF</filename>
+                folder together with
+                <filename>base-plugins.xml</filename>.
+              </para>
+            </listitem>
+          </varlistentry>
+        </variablelist>
       </para>
     </sect2>