Changeset 3759


Ignore:
Timestamp:
Sep 20, 2007, 11:23:59 AM (14 years ago)
Author:
Martin Svensson
Message:

References #364, documentation

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/src/docbook/developerdoc/plugin_developer.xml

    r3755 r3759  
    156156      <title>With Eclipse</title>
    157157      <para>
    158         If somebody is willing to add information to this
    159         chapter please send us a note or some written text to put here.
    160         Otherwise, this chapter will be removed.
     158        If somebody is willing to add information to this chapter please send us a note or
     159        some written text to put here. Otherwise, this chapter will be removed.
    161160      </para>
    162161    </sect2>
    163    
     162
    164163    <sect2 id="plugin_developer.organize.autoinstallcompatible">
    165164      <title>To be installed with auto install</title>
    166165      <para>
    167      
     166        A jar-file with plugins needs to have a specific XML-file in it's
     167        <filename>META-INF</filename>
     168        folder if the plugins should be possible to use with the auto installation in BASE.
     169        The XML-file should have the name
     170        <filename>base-plugins.xml</filename>
     171        and be in the format described below.
     172      </para>
     173      <programlisting>&lt;?xml version="1.0" encoding="UTF-8"?&gt;
     174&lt;!DOCTYPE plugins SYSTEM "../src/core/net/sf/basedb/core/dtd/base-plugins.dtd" &gt;
     175&lt;plugins jarname="<filename>jarfile.jar</filename>"&gt;
     176  &lt;pluginclass classname="<classname>se.lu.thep.PluginClass</classname>"&gt;
     177    &lt;minbaseversion&gt;2.4&lt;/minbaseversion&gt;
     178    &lt;hasconfigurations/&gt;
     179    &lt;/pluginclass&gt;
     180    .
     181    .
     182    .
     183&lt;/plugins&gt;</programlisting>
     184      <para>
     185        The first two lines should be the same in all base-plugins.xml, rest of the tags are
     186        described in following list.
     187        <variablelist>
     188          <varlistentry>
     189            <term><sgmltag class="element">plugins</sgmltag></term>
     190            <listitem>
     191              <para>
     192                This is the root element in the XML-file and must have the
     193                attribute
     194                <sgmltag class="attribute">jarname</sgmltag>
     195                set. The attribute should hold the name of the jar-file the XML-file
     196                is in.
     197              </para>
     198            </listitem>
     199          </varlistentry>
     200          <varlistentry>
     201            <term>
     202              <sgmltag class="element">pluginclass</sgmltag>
     203            </term>
     204            <listitem>
     205              <para>
     206                This tag defines information about each plugin in the jar-file. The
     207                <sgmltag class="attribute">classname</sgmltag>
     208                attribute needs to have the full classname of the plugin's main
     209                class. There can be one or several of this element inside the
     210                <sgmltag>plugins</sgmltag>
     211                tag, which means that there should be one pluginclass-element for
     212                each plugin in the jar.
     213              </para>
     214            </listitem>
     215          </varlistentry>
     216          <varlistentry>
     217            <term>
     218              <sgmltag class="element">minbaseversion</sgmltag>
     219            </term>
     220            <listitem>
     221              <para>
     222                A required child element in
     223                <sgmltag class="element">pluginclass</sgmltag>
     224                . This defines from which version of BASE the plugin can be used.
     225                The plugin will not be included in auto installer if the
     226                BASE-version is lower then the value of this tag. Format of the
     227                value in this tag should be
     228                <emphasis>majorversion</emphasis>.<emphasis>minorversion</emphasis>
     229              </para>
     230            </listitem>
     231          </varlistentry>
     232          <varlistentry>
     233            <term>
     234              <sgmltag class="element">hasconfigurations</sgmltag>             
     235            </term>
     236            <listitem>
     237              <para>
     238                A required child element in
     239                <sgmltag class="element">pluginclass</sgmltag>
     240                . This should have information if there are plugin configurations
     241                that are shipped with the plugin. Setting the value to
     242                <emphasis>yes</emphasis>
     243                will indicate that there are available configurations in the
     244                jar-file. This can be left as an empty tag if no
     245                configurations are available for import.
     246              </para>
     247              <para>
     248                Configurations shipped with a jar-file should be exported with the
     249                plugin configuration exporter in BASE. The exported file should have
     250                the name
     251                <filename>base-configurations.xml</filename>
     252                . This file has to be put in the jar-file's
     253                <filename class="directory">META-INF</filename>
     254                folder together with
     255                <filename>base-plugins.xml</filename>.
     256              </para>
     257            </listitem>
     258          </varlistentry>
     259        </variablelist>
    168260      </para>
    169261    </sect2>
Note: See TracChangeset for help on using the changeset viewer.