Changeset 3753


Ignore:
Timestamp:
Sep 18, 2007, 3:47:23 PM (14 years ago)
Author:
Martin Svensson
Message:

References #364, documentation

Location:
trunk/doc/src/docbook
Files:
1 added
2 edited

Legend:

Unmodified
Added
Removed
  • trunk/doc/src/docbook/admindoc/plugin_installation.xml

    r3740 r3753  
    7676   
    7777    <para>
    78       When the plug-in is installed on the server you must register it
    79       with BASE. BASE lacks functionality for discovering plug-ins automatically
    80       so you have to enter information about the JAR file and plug-in manually.
    81       This can be hard to get right. To register the plug-in with BASE go to
     78      When the plug-in is installed on the server you must register it with BASE. To register
     79      the plug-in with BASE go to
    8280      <menuchoice>
    8381        <guimenu>Administrate</guimenu>
    8482        <guisubmenu>Plugins</guisubmenu>
    8583        <guimenuitem>Definitions</guimenuitem>
    86       </menuchoice> and click on the &gbNew;
    87       button.
     84      </menuchoice>
     85      and click on the &gbNew; button. The pop-up window that appears looks different
     86      depending on if
     87      <property>plugin.dir</property>
     88      in
     89      <filename>base.config</filename>
     90      has been defined or not, and if the defined directory contains any plugins. Is the directory
     91      not defined or there are no plugins in the defined directory, the pop-up window will
     92      have the look described in
     93      <xref linkend="plugins.install.properties" />
     94      otherwise it will look like described in
     95      <xref linkend="plugins.select.installtype" />
     96      below.
    8897    </para>
    8998   
     99    <sect2 id="plugins.select.installtype">
     100      <title>Select installation method</title>
     101      <para>
     102        This window appears, like described above, when automatic installation/registration
     103        of plugins are available.
     104        <figure id="plugins.figures.selectinstall">
     105          <title>Select installation type</title>
     106          <screenshot>
     107            <mediaobject>
     108              <imageobject>
     109                <imagedata fileref="figures/select_install.png" format="PNG"
     110                  scalefit="1" width="70%" />
     111              </imageobject>
     112            </mediaobject>
     113          </screenshot>
     114        </figure>
     115      </para>
     116      <helptext external_id="plugindefinition.installationtype"
     117        title="Select installation type">
     118        <variablelist>
     119          <varlistentry>
     120            <term><guilabel>Install</guilabel>
     121            </term>
     122            <listitem>
     123              <para>
     124                How the plugins should be registered to BASE.
     125                <variablelist>
     126                  <varlistentry>
     127                    <term><guilabel>Automatically</guilabel></term>
     128                    <listitem>
     129                      <para>
     130                        Lets you select one or many plugins from a list with
     131                        new external plugins found in the directory defined
     132                        in
     133                        <filename>base.config</filename>
     134                        . Next step is
     135                        <xref linkend="plugins.install.auto" />
     136                      </para>
     137                    </listitem>
     138                  </varlistentry>
     139                  <varlistentry>
     140                    <term><guilabel>Manually</guilabel></term>
     141                    <listitem>
     142                      <para>
     143                        Class name and jar-path have to be defined by the
     144                        administrator. Only one plugin can be registered at
     145                        a time in this way. Next step is
     146                        <xref linkend="plugins.install.properties" />
     147                      </para>
     148                    </listitem>
     149                  </varlistentry>
     150                </variablelist>
     151              </para>
     152            </listitem>
     153          </varlistentry>
     154          <varlistentry>
     155            <term><guilabel>Path</guilabel>(only <guilabel>Automatically</guilabel>)</term>
     156            <listitem>
     157              <para>
     158                Where BASE will look for jar-files with plugins.
     159              </para>
     160            </listitem>
     161          </varlistentry>
     162        </variablelist>
     163      </helptext>
     164    </sect2>
     165
    90166    <sect2 id="plugins.install.properties">
    91167      <title>Plug-in properties</title>
     
    221297     
    222298    </helptext>
     299    </sect2>
     300   
     301    <sect2 id="plugins.install.auto">
     302      <title>Register plugins automatically</title>
     303      <para>
     304     
     305      </para>
    223306    </sect2>
    224307   
  • trunk/doc/src/docbook/appendix/base.config.xml

    r3675 r3753  
    600600      </listitem>
    601601    </varlistentry>
     602    <varlistentry>
     603      <term><property>plugin.dir</property></term>
     604      <listitem>
     605        <para>
     606          The path to the directory where jar-files for external plugins should be located
     607          if they should be used with the auto-installer. All new plugins found in this directory, or
     608          in any of it's subdirectories, can be selected for installation, see
     609          <xref linkend="plugins.installation" />
     610          . The plugin auto-installer will not be availble if this property isn't defined.
     611        </para>
     612      </listitem>
     613    </varlistentry>
    602614    </variablelist>
    603615  </simplesect>
Note: See TracChangeset for help on using the changeset viewer.