Ignore:
Timestamp:
Oct 19, 2007, 9:28:06 AM (14 years ago)
Author:
Nicklas Nordborg
Message:

References #364: Support for automatic install of non-core plugins

Fixed some issues in the documentation.

File:
1 edited

Legend:

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

    r3765 r3866  
    8484      </menuchoice>
    8585      and click on the &gbNew; button. The pop-up window that appears looks different
    86       depending on if
    87       <property>plugins.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.
     86      depending on if the <property>plugins.dir</property> property
     87      in <filename>base.config</filename>
     88      has been defined or not. If this has been defined you will first have to
     89      choose between manual or automatic installation as described below. Otherwise
     90      you will immediately be taken to the manual installation.
    9791    </para>
    9892   
     
    10195      <para>
    10296        This window appears, like described above, when automatic installation/registration
    103         of plugins is available.
     97        of plug-ins is available.
    10498        <figure id="plugins.figures.selectinstall">
    10599          <title>Select installation type</title>
     
    122116            <listitem>
    123117              <para>
    124                 How to register the plugin(s) to BASE.
    125                 <variablelist>
    126                   <varlistentry>
    127                     <term><emphasis>Automatically</emphasis></term>
    128                     <listitem>
    129                       <para>
    130                         Lets you select one or many plugins from a list of
    131                         new external plugins found in the directory defined
    132                         in
    133                         <filename>base.config</filename>
    134                         . Next step will be
    135                         <xref linkend="plugins.autoinstall" />
    136                       </para>
    137                     </listitem>
    138                   </varlistentry>
    139                   <varlistentry>
    140                     <term><emphasis>Manually</emphasis></term>
    141                     <listitem>
    142                       <para>
    143                         Class name and jar-path have to be defined manually by the
    144                         administrator. Only one plugin can be registered at
    145                         a time in this way. Next step will be
    146                         <xref linkend="plugins.install.properties" />
    147                       </para>
    148                     </listitem>
    149                   </varlistentry>
    150                 </variablelist>
    151               </para>
     118              How to register the plug-in(s) with BASE.
     119              <variablelist>
     120              <varlistentry>
     121                <term><emphasis>Automatically</emphasis></term>
     122                <listitem>
     123                  <para>
     124                  BASE will scan the given path for JAR files containing
     125                  plug-ins. If it finds any, you will have the option
     126                  to select which ones to install from a list.
     127                  <nohelp>The next step will be <xref linkend="plugins.autoinstall" /></nohelp>
     128                  </para>
     129                </listitem>
     130              </varlistentry>
     131              <varlistentry>
     132                <term><emphasis>Manually</emphasis></term>
     133                <listitem>
     134                  <para>
     135                  Class name and JAR path have to be entered manually by the
     136                  administrator. Only one plug-in can be registered at
     137                  a time in this way. Next step will be
     138                  <nohelp><xref linkend="plugins.install.properties" /></nohelp>
     139                  </para>
     140                </listitem>
     141              </varlistentry>
     142              </variablelist>
     143            </para>
    152144            </listitem>
    153145          </varlistentry>
    154146          <varlistentry>
    155             <term><guilabel>Path</guilabel>(only when <emphasis>Automatically</emphasis> is selected)</term>
     147            <term><guilabel>Path</guilabel> (only when <emphasis>Automatically</emphasis> is selected)</term>
    156148            <listitem>
    157149              <para>
    158                 Where BASE will look for jar-files with plugins.
     150                Where BASE will look for JAR files with plug-ins.
    159151              </para>
    160152            </listitem>
    161153          </varlistentry>
    162154        </variablelist>
     155       
     156        <note>
     157          The automatic installation doesn't allow you to set all properties
     158          that can be set in a manual installation. If you for example, need
     159          to share the plug-ins to other users or assign them to job agents
     160          this must be done after the auto-installation has been completed.
     161        </note>
     162       
     163        <seeother>
     164          <other external_id="plugindefinition.edit">Manual installation</other>
     165          <other external_id="plugindefintion.autoinstaller">Automatic installation</other>
     166        </seeother>
     167       
    163168      </helptext>
    164169    </sect2>
     
    166171    <sect2 id="plugins.install.properties">
    167172      <title>Plug-in properties</title>
     173   
     174    <para>
     175      This section describes the manual installation of a plug-in.
     176    </para>
    168177   
    169178    <figure id="plugins.figures.install">
     
    294303        <other external_id="plugindefinition.edit.permissions">Plug-in permissions</other>
    295304        <other external_id="plugindefinition.jobagents">Job agents</other>
     305        <other external_id="plugindefintion.autoinstaller">Automatic installation</other>
    296306      </seeother>   
    297307     
     
    300310   
    301311    <sect2 id="plugins.autoinstall">
    302       <title>Register plugins automatically</title>
     312      <title>Automatic installation of plug-ins</title>
     313     
     314      <para>
     315        This section describes the automatic installation of plug-ins
     316        using a wizard.
     317      </para>
     318     
    303319      <figure id="plugins.figures.autoinstall">
    304         <title>Auto install plugins</title>
     320        <title>Auto install plug-ins</title>
    305321     
    306322        <screenshot>
     
    316332     
    317333      <para>
    318         This window lists all the plugins that were found in jar-files, located in the path defined in
    319         <filename>base.config</filename>
    320         . There is a few option to set for each plugin before they can be registered.
     334        This window lists all the plug-ins that were found in JAR files, located in the path defined in
     335        <filename>base.config</filename>.
     336        There is a few option to set for each plug-in before they can be registered.
    321337      </para>
    322338     
    323339      <helptext external_id="plugindefintion.autoinstaller" title="Auto install plugins">
    324340        <para>
    325           The page has, for each plugin, a row that is devided into four columns with
     341          The page has, for each plug-in, a row that is devided into four columns with
    326342          information or settings. These are explained more in details below. In front of
    327           each row is an icon that displays summarized information about the plugin when
    328           the mouse pointer is held over it. Most of this information is from the plugin's
     343          each row is an icon that displays summarized information about the plug-in when
     344          the mouse pointer is held over it. Most of this information is from the plug-in's
    329345          <classname>About</classname>
    330346          property but some, like 'Works with', 'Class' and 'Jar' is from the installation
    331           file included in the jar-file. A plugin can also be distributed with one or many
    332           configurations that can be selected for import together with plugin
     347          file included in the JAR file. A plug-in can also be distributed with one or many
     348          configurations that can be selected for import together with plug-in
    333349          registration. The configurations are by default hidden but can easily be viewed by
    334           expanding the configuration tree for a plugin.
     350          expanding the configuration tree for a plug-in.
    335351          <variablelist>
    336352            <varlistentry>
     
    340356              <listitem>
    341357                <para>
    342                   The plugin's name, from the plugin class. Names of the
    343                   configurations that comes with a plugin are also displayed in
    344                   this column but in a tree under the plugin they belong to.
     358                  The plug-in's name, from the plug-in class. Names of the
     359                  configurations that comes with a plug-in are also displayed in
     360                  this column but in a tree under the plug-in they belong to.
    345361                </para>
    346362              </listitem>
     
    352368              <listitem>
    353369                <para>
    354                   A select list for each plugin that can be registered. There are
    355                   at least two option for each plugin in this drop-down list. The
     370                  A select list for each plug-in that can be registered. There are
     371                  at least two option for each plug-in in this drop-down list. The
    356372                  default option
    357373                  <emphasis>no</emphasis>
    358                   will not register the plugin to BASE while
    359                   <emphasis>plugin</emphasis>
    360                   will register the plugin when proceeding. Those plugins that
    361                   also have configurations available in the jar will also have
    362                   <emphasis>with configs</emphasis>
    363                   as an option. This option will also set all, in the jar-file,
    364                   available configurations for the specific plugin to be imported.
     374                  will not register the plug-in to BASE while
     375                  <emphasis>yes</emphasis>
     376                  will register the plug-in when proceeding. If the plug-in
     377                  also have configurations the <emphasis>yes</emphasis>
     378                  option is replaced with <emphasis>plugin only</emphasis>
     379                  and <emphasis>plugin + configurations</emphasis>.
     380                  If the last option is selected all configurations for the
     381                  specific plug-in will be imported.
    365382                </para>
    366383                <para>
    367384                  Each listed configuration can individually be defined if it
    368385                  should be imported or not. This is done by selecting
    369                   <emphasis>yes</emphasis>
    370                   -to import or
    371                   <emphasis>no</emphasis>
    372                   to not import a configurations.
     386                  <emphasis>yes</emphasis> or <emphasis>no</emphasis>.
    373387                </para>
    374388                <note>
    375389                  <para>
    376                     Plugins that already are registered in BASE will not be enabled in the list,
    377                     unless the plugin in the list comes from a jar-file in a different path then the
     390                    Plug-ins that already are registered in BASE will not be displayed in the list,
     391                    unless the plug-in in the list comes from a JAR file in a different path than the
    378392                    one registered in BASE. In this case the drop-down lists is enabled for
    379                     selection but marked with a exclamation mark and the plugin will be
    380                     re-registered with the new jar-path if any of the two install options are
     393                    selection but marked with a exclamation mark and the plug-in will be
     394                    re-registered with the new JAR path if any of the two install options are
    381395                    selected.
    382396                  </para>
     
    385399                  <para>
    386400                    If a configuration in the list has an identical name as a configuration in BASE
    387                     and the configurations are for the same plugin, there will be a warning in the
     401                    and the configurations are for the same plug-in, there will be a warning in the
    388402                    list beside the install-select box. The already existing configuration will not
    389                     be overwritten if the new plugin is set to be imported, but there will be two
    390                     configurations with the same name and for the same plugin.
     403                    be overwritten if the new plug-in is set to be imported, but there will be two
     404                    configurations with the same name and for the same plug-in.
    391405                  </para>
    392406                </note>
Note: See TracChangeset for help on using the changeset viewer.