Ignore:
Timestamp:
2003-08-27T10:49:15+12:00 (21 years ago)
Author:
jmt12
Message:

Latest version generated from help text.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/gli/help/7-6.htm

    r4293 r5284  
    1313      <font face="Verdana" size="5">
    1414      <strong>
    15 7.6 Plug-ins
     157.6 Partition Indexes
    1616      </strong>
    1717      </font>
    … …  
    2525      <font face="Verdana" size="3">
    2626<p style="text-align:justify">
    27 This section describes how to configure the plug-ins used in your Greenstone collection. It explains how the Librarian Interface determines what plug-ins are available to the system, and how you specify what plug-ins to use, what parameters to pass to them, and in what order they occur.
     27Indexes are built on particular text or metadata sources.  The search space can be further controlled by partitioning the index, either by language or by a predetermined filter.  This section describes how to do this.  Under "Design Sections", click "Partition Indexes".
     28</p>
     29<p style="text-align:justify">
     30The "Partition Indexes" view has three tabs; "Define Filters", "Assign Partitions" and "Assign Languages".  To learn more about partitions read about subcollections and subindexes in Chapter 2 of the Greenstone Developer's Guide.
    2831</p>
    2932
    3033      </font>
    31     </td>
    32   </tr>
    33   <tr bgcolor="#E0F0E0">
    34     <td align="center" colspan="3" width="100%">
    35       <table border="2" cellpadding="2" width="480" bgcolor="#B0D0B0">
    36         <tr>
    37           <td align="center">
    38             <font face="Verdana" size="4">
    39             <strong>
    40             Contents
    41             </strong>
    42             </font>
    43           </td>
    44         </tr>
    45         <tr>
    46           <td>
    47             <table background="gatherer.gif" bgcolor="#FFFFFF" border="0" cellpadding="2" width="100%">
    48               <tr>
    49                 <td colspan="3">
    50                   <font face="Verdana" size="4">
    51                   <strong>
    52 <a href="#SI">Simple instructions</a>
    53                   </strong>
    54                   </a>
    55                   </font>
    56                 </td>
    57               </tr>
    58               <tr>
    59                 <td>
    60                   &nbsp;
    61                 </td>
    62                 <td colspan="2">
    63                   <font face="Verdana" size="4">
    64 Plug-in selection and configuration
    65                   </font>
    66                   </a>
    67                 </td>
    68               </tr>
    69               <tr>
    70                 <td>
    71                   &nbsp;
    72                 </td>
    73                 <td colspan="2">
    74                   <font face="Verdana" size="4">
    75 Add a plug-in
    76                   </font>
    77                   </a>
    78                 </td>
    79               </tr>
    80               <tr>
    81                 <td>
    82                   &nbsp;
    83                 </td>
    84                 <td colspan="2">
    85                   <font face="Verdana" size="4">
    86 Remove a plug-in
    87                   </font>
    88                   </a>
    89                 </td>
    90               </tr>
    91               <tr>
    92                 <td>
    93                   &nbsp;
    94                 </td>
    95                 <td colspan="2">
    96                   <font face="Verdana" size="4">
    97 Configure a plug-in
    98                   </font>
    99                   </a>
    100                 </td>
    101               </tr>
    102               <tr>
    103                 <td>
    104                   &nbsp;
    105                 </td>
    106                 <td colspan="2">
    107                   <font face="Verdana" size="4">
    108 Change plug-in order
    109                   </font>
    110                   </a>
    111                 </td>
    112               </tr>
    113               <tr>
    114                 <td colspan="3">
    115                   <font face="Verdana" size="4">
    116                   <strong>
    117 <a href="#AI">Advanced instructions</a>
    118                   </strong>
    119                   </a>
    120                   </font>
    121                 </td>
    122               </tr>
    123               <tr>
    124                 <td>
    125                   &nbsp;
    126                 </td>
    127                 <td colspan="2">
    128                   <font face="Verdana" size="4">
    129 Custom configuration
    130                   </font>
    131                   </a>
    132                 </td>
    133               </tr>
    134               <tr>
    135                 <td>
    136                   &nbsp;
    137                 </td>
    138                 <td colspan="2">
    139                   <font face="Verdana" size="4">
    140 Rebuilding the plug-in database
    141                   </font>
    142                   </a>
    143                 </td>
    144               </tr>
    145             </font>
    146             </table>
    147           </td>
    148         </tr>
    149       </table>
    150     </td>
    151   </tr>
    152   <tr bgcolor="#E0F0E0">
    153     <td colspan="3" width="100%">
    154       <img height="20" src="gatherer_small.gif" width="20">
    155       <font face="Verdana" size="4">
    156       <u>
    157 <a name="SI">Simple Instructions:</a>
    158       </u>
    159       <font size="3">
    160 <p style="text-align:justify">
    161 As usual, a text area of instructions appears at the top of the view, with several controls below. The controls are split into a list of currently assigned plug-ins, and a group of 'Editing Controls' used to change the current plug-ins. Note that the list shows the plug-in commands as they will actually appear in the collection configuration file; thus you can review the arguments that are set.
    162 </p>
    163 <p style="text-align:justify">
    164 To add a plug-in, use the 'Select plug-in to add' ComboBox in the edit controls. Once a plug-in is selected, press the [A]dd Specified Plug-in button. A new dialog window will appear titled 'Configuring Arguments'; it is described in detail later. If you accept any changes you have made to the configuration, the prompt will vanish and the new plug-in will be added to the end of the 'movable' plug-ins within the assigned plug-in list.  Note that a plug-in may only occur in this list once only.
    165 </p>
    166 <p style="text-align:justify">
    167 To remove a plug-in, first select it from the assigned plug-ins list and then click [R]emove Selected Plug-in.
    168 </p>
    169 <p style="text-align:justify">
    170 Plug-ins are PERL scripts used to convert the collection's documents from one format to another, and for metadata extraction. Arguments can be used to configure what they do. To alter these arguments, select the desired plug-in from the assigned plug-in list, then click [C]onfigure Selected Plug-in. This will cause the 'Configuring Arguments' dialog window to appear again. This window has three parts, a text field for entering custom arguments, as explained below, a scrollable area from which particular arguments can be specified, and two buttons at the very bottom.
    171 </p>
    172 <p style="text-align:justify">
    173 The controls come in several flavours.  The most basic is a flag value, represented by a checkbox. Clicking the checkbox instructs the Librarian Interface to add the appropriate flag (for example, for a control named 'cover_image' the flag added is '-cover_image'). The second control is a text parameter argument comprising a checkbox and a text field. Click on the checkbox to enable this argument, then type appropriate text (regular expression, file path etc) in the box. The next type of control uses a ComboBox from which you can select one of a limited set of values. The final control is a variation on the ComboBox in which multiple selections can be made from a restricted list, and multiple parameters are passed with the argument. This control consists of a checkbox, to enable the argument, a ComboBox, from which the user selects desired values, two buttons 'add' and 'remove' which perform the corresponding functions, and a scrollable list of the values that are currently assigned for this argument. To add a value, select it from the ComboBox and click Add; to remove it, select it and click Remove. To review exactly what an argument does, leave the mouse pointer hovering over its name for a moment and a tool tip box will appear with description of the argument. When you have changed the configuration to suit, click the [O]k button to commit the changes and close the dialog, or [C]ancel to close the dialog without changing any plug-in arguments.
    174 </p>
    175 <p style="text-align:justify">
    176 The ordering of plug-ins in the list can be important.  The plug-ins in the list are executed in order. Two standard plug-ins, ArcPlug and RecPlug, are vital to the collection building process (ArcPlug identifies the collection files within the archives directory and RecPlug recursively traverses the collection tree.) These plug-ins are fixed in place at the end of the list -- denoted by a separator line. Only the plug-ins above the line can be moved.  To change the ordering, select the plug-in you want to move.  There are four options, Move To [T]op, Move [U]p, Move [D]own, and Move To [B]ottom, which re-order the list in corresponding ways.  You cannot move a component outside the list bounds, nor can you move a fixed component.
    177 </p>
    178 
    179       </font>
    180       </p>
    181     </td>
    182   </tr>
    183   <tr bgcolor="#E0F0E0">
    184     <td colspan="3" width="100%">
    185       <img height="20" src="gatherer_small.gif" width="20">
    186       <font face="Verdana" size="4">
    187       <u>
    188 <a name="AI">Advanced Instructions:</a>
    189       </u>
    190       <font size="3">
    191 <p style="text-align:justify">
    192 When you enter the plug-in configuration dialog, the focus is initially on a text field called 'Custom Arguments'.  This field is provided because although the Librarian Interface does its best to determine the arguments supported by the plug-in, there may be cases when the user wants to specify special arguments. Any text in it is appended verbatim to the end of the plug-in command.
    193 </p>
    194 <p style="text-align:justify">
    195 Whenever a new plug-in becomes available for use, the Librarian Interface's plug-in database should be rebuilt. To do this, rename the file 'plugins.dat' to something like 'plugins.bak'.  The next time the Librarian Interface starts (or a collection is loaded), the plug-in database will be rebuilt automatically. This is done using a Greenstone PERL script called pluginfo.pl, with the special argument -xml, and requires the latest versions of the plugins and pluginfo to work properly (such files are available for download from the Librarian Interface site). This causes each plug-in found in the appropriate directories to be polled and asked what arguments it supports. The process is automatic and requires no further user intervention. If for any reason the process fails you can restore the original plugins database to get the Librarian Interface running again.
    196 </p>
    197 
    198       </font>
    199       </p>
    20034    </td>
    20135  </tr>
Note: See TracChangeset for help on using the changeset viewer.