Changeset 3755


Ignore:
Timestamp:
Sep 19, 2007, 2:36:00 PM (14 years ago)
Author:
Martin Svensson
Message:

References #364, documentation

Location:
trunk
Files:
1 added
3 edited

Legend:

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

    r3753 r3755  
    101101      <para>
    102102        This window appears, like described above, when automatic installation/registration
    103         of plugins are available.
     103        of plugins is available.
    104104        <figure id="plugins.figures.selectinstall">
    105105          <title>Select installation type</title>
     
    122122            <listitem>
    123123              <para>
    124                 How the plugins should be registered to BASE.
     124                How to register the plugin(s) to BASE.
    125125                <variablelist>
    126126                  <varlistentry>
    127                     <term><guilabel>Automatically</guilabel></term>
     127                    <term><emphasis>Automatically</emphasis></term>
    128128                    <listitem>
    129129                      <para>
    130                         Lets you select one or many plugins from a list with
     130                        Lets you select one or many plugins from a list of
    131131                        new external plugins found in the directory defined
    132132                        in
    133133                        <filename>base.config</filename>
    134                         . Next step is
    135                         <xref linkend="plugins.install.auto" />
     134                        . Next step will be
     135                        <xref linkend="plugins.autoinstall" />
    136136                      </para>
    137137                    </listitem>
    138138                  </varlistentry>
    139139                  <varlistentry>
    140                     <term><guilabel>Manually</guilabel></term>
     140                    <term><emphasis>Manually</emphasis></term>
    141141                    <listitem>
    142142                      <para>
    143                         Class name and jar-path have to be defined by the
     143                        Class name and jar-path have to be defined manually by the
    144144                        administrator. Only one plugin can be registered at
    145                         a time in this way. Next step is
     145                        a time in this way. Next step will be
    146146                        <xref linkend="plugins.install.properties" />
    147147                      </para>
     
    153153          </varlistentry>
    154154          <varlistentry>
    155             <term><guilabel>Path</guilabel>(only <guilabel>Automatically</guilabel>)</term>
     155            <term><guilabel>Path</guilabel>(only when <emphasis>Automatically</emphasis> is selected)</term>
    156156            <listitem>
    157157              <para>
     
    299299    </sect2>
    300300   
    301     <sect2 id="plugins.install.auto">
     301    <sect2 id="plugins.autoinstall">
    302302      <title>Register plugins automatically</title>
    303       <para>
    304      
    305       </para>
     303      <figure id="plugins.figures.autoinstall">
     304        <title>Auto install plugins</title>
     305     
     306        <screenshot>
     307          <mediaobject>
     308            <imageobject>
     309              <imagedata
     310                fileref="figures/plugin_autoinstall.png" format="PNG"
     311              />
     312            </imageobject>
     313          </mediaobject>
     314        </screenshot>
     315      </figure>
     316     
     317      <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.
     321      </para>
     322     
     323      <helptext external_id="plugindefintion.autoinstaller" title="Auto install plugins">
     324        <para>
     325          The page has, for each plugin, a row that is devided into four columns with
     326          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
     329          <classname>About</classname>
     330          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
     333          registration. The configurations are by default hidden but can easily be viewed by
     334          expanding the configuration tree for a plugin.
     335          <variablelist>
     336            <varlistentry>
     337              <term>
     338                <guilabel>Plugins</guilabel>
     339              </term>
     340              <listitem>
     341                <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.
     345                </para>
     346              </listitem>
     347            </varlistentry>
     348            <varlistentry>
     349              <term>
     350                <guilabel>Install</guilabel>
     351              </term>
     352              <listitem>
     353                <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
     356                  default option
     357                  <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.
     365                </para>
     366                <para>
     367                  Each listed configuration can individually be defined if it
     368                  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.
     373                </para>
     374                <note>
     375                  <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
     378                    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
     381                    selected.
     382                  </para>
     383                </note>
     384                <note>
     385                  <para>
     386                    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
     388                    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.
     391                  </para>
     392                </note>
     393              </listitem>
     394            </varlistentry>
     395            <varlistentry>
     396              <term>
     397                <guilabel>Trusted</guilabel>
     398              </term>
     399              <listitem>
     400                <para>
     401                  If the plug-in is trusted enough to be executed in an
     402                  unprotected environment. See
     403                  <nohelp>
     404                    <xref linkend="plugins.install.properties" />
     405                  </nohelp>
     406                </para>
     407              </listitem>
     408            </varlistentry>
     409            <varlistentry>
     410              <term>
     411                <guilabel>Immediate execution</guilabel>
     412              </term>
     413              <listitem>
     414                <para>
     415                  If the plug-in is allowed to bypass the job queue and be
     416                  executed immediately. See
     417                  <nohelp>
     418                    <xref linkend="plugins.install.properties" />
     419                  </nohelp>
     420                </para>
     421              </listitem>
     422            </varlistentry>
     423          </variablelist>
     424        </para>       
     425        <para>
     426          Click on &gbSave; to finish the registration
     427          or on &gbCancel; to abort.
     428        </para>
     429        <seeother>
     430          <other external_id="plugindefinition.edit">Edit plugins</other>
     431        </seeother>
     432      </helptext>
    306433    </sect2>
    307434   
  • trunk/doc/src/docbook/developerdoc/plugin_developer.xml

    r3675 r3755  
    159159        chapter please send us a note or some written text to put here.
    160160        Otherwise, this chapter will be removed.
     161      </para>
     162    </sect2>
     163   
     164    <sect2 id="plugin_developer.organize.autoinstallcompatible">
     165      <title>To be installed with auto install</title>
     166      <para>
     167     
    161168      </para>
    162169    </sect2>
  • trunk/www/admin/plugindefinitions/auto_install.jsp

    r3733 r3755  
    224224    <t:tabcontrol id="plugins" contentstyle="<%="height: "+(int)(scale*260)+"px;"%>"
    225225      position="bottom">
    226       <t:tab id="plugins" title="Available plugins" validate="validatePlugins()" helpid="plugindefinition.autoinstaller.plugins">
     226      <t:tab id="plugins" title="Available plugins" validate="validatePlugins()" helpid="plugindefinition.autoinstaller">
    227227        <div align="left">
    228228          <table border="0" cellspacing="0" cellpadding="0">
Note: See TracChangeset for help on using the changeset viewer.