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

Timestamp:

Sep 21, 2007, 2:35:48 PM (16 years ago)

Author:

Martin Svensson

Message:

References #364, Added instructions how to make ant put base-plugins.xml and base-configurations.xml
in the plugin jar-file when building an external plugin.
Also updated the examples about this.

File:

• trunk/doc/src/docbook/developerdoc/plugin_developer.xml (modified) (5 diffs)

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

@@ -117 +117 @@
          manifest="MANIFEST.MF"
          >
+         <!--Include this to add required files for auto registration wizard-->
+         <metainf file="./base-plugins.xml"></metainf>
+         <metainf file="./base-configurations.xml"></metainf>       
       </jar>
 
@@ -132 +135 @@
 <programlisting>Manifest-Version: 1.0
 Class-Path: OtherJar.jar ASecondJar.jar</programlisting>
+        </para>
+        <para>
+          If your plugin should support registration with the auto-installation-wizzard it
+          could be a good idea to add the
+          <sgmltag class="element">metainf</sgmltag>
+          tags. By doing this you don't have to insert any files to the plugin-jar file
+          after it had been created. Place the
+          <filename>base-plugins.xml</filename>
+          and
+          <filename>base-configurations.xml</filename>
+          (if any configurations are shipped with the plugin) in the project root
+          directory before you compile. The files will end up in the jar-file's
+          <filename class="directory">META-INF</filename>
+          . Go to
+          <xref linkend="plugin_developer.organize.autoinstallcompatible" />
+          to get more information how to create this files.
         </para>
       </sect3>
@@ -172 +191 @@
       </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;!DOCTYPE plugins SYSTEM "base-plugins.dtd" &gt;
 &lt;plugins jarname="<filename>jarfile.jar</filename>"&gt;
   &lt;pluginclass classname="<classname>se.lu.thep.PluginClass</classname>"&gt;
@@ -238 +257 @@
                 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
+                . This should tell if there are plugin configurations
+                shipped with the plugin. Setting the value to
                 <emphasis>yes</emphasis>
                 will indicate that there are available configurations in the
@@ -247 +266 @@
               <para>
                 Configurations shipped with a jar-file should be exported with the
-                plugin configuration exporter in BASE. The exported file should have
+                plugin configuration exporter in BASE. The exported file must have
                 the name
                 <filename>base-configurations.xml</filename>