| 1 | <html>
|
|---|
| 2 | <head>
|
|---|
| 3 | <META http-equiv="Content-Type" content="text/html; charset=UTF-8">
|
|---|
| 4 | <title>The Greenstone Librarian Interface - Help Pages</title>
|
|---|
| 5 | </head>
|
|---|
| 6 | <body bgcolor="#E0F0E0">
|
|---|
| 7 | <table width="100%" cellspacing="0" cellpadding="5" bgcolor="#B0D0B0" border="2">
|
|---|
| 8 | <tr>
|
|---|
| 9 | <td width="15%" align="center"><img width="45" src="../gatherer_medium.gif" height="45"></td><td width="*" align="center"><a name="plugins"><font size="5" face="Verdana"><strong>6.3: Document Plugins</strong></font></a></td><td width="15%" align="center"><img width="45" src="../gatherer_medium.gif" height="45"></td>
|
|---|
| 10 | </tr>
|
|---|
| 11 | </table>
|
|---|
| 12 |
|
|---|
| 13 | This section describes how to configure the document plugins the
|
|---|
| 14 | collection uses. It explains how you specify what
|
|---|
| 15 | plugins to use, what parameters to pass to them, and in what order
|
|---|
| 16 | they occur. Under "Design Sections", click "Document Plugins".
|
|---|
| 17 | <p></p>
|
|---|
| 18 | <table bgcolor="#B0D0B0" width="480" cellpadding="2" border="2" align="center">
|
|---|
| 19 | <tr>
|
|---|
| 20 | <td align="center"><font size="4" face="Verdana"><strong>
|
|---|
| 21 | Contents
|
|---|
| 22 | </strong></font></td>
|
|---|
| 23 | </tr>
|
|---|
| 24 | <tr>
|
|---|
| 25 | <td>
|
|---|
| 26 | <table width="100%" cellpadding="2" border="0" bgcolor="#FFFFFF">
|
|---|
| 27 |
|
|---|
| 28 | <tr>
|
|---|
| 29 | <td colspan="3"><a href="#simple">Simple Instructions:</a></td>
|
|---|
| 30 | </tr>
|
|---|
| 31 |
|
|---|
| 32 | <tr>
|
|---|
| 33 | <td colspan="1"> </td><td colspan="2">
|
|---|
| 34 | Add a plugin
|
|---|
| 35 | </td>
|
|---|
| 36 | </tr>
|
|---|
| 37 |
|
|---|
| 38 | <tr>
|
|---|
| 39 | <td colspan="1"> </td><td colspan="2">
|
|---|
| 40 | Remove a plugin
|
|---|
| 41 | </td>
|
|---|
| 42 | </tr>
|
|---|
| 43 |
|
|---|
| 44 | <tr>
|
|---|
| 45 | <td colspan="1"> </td><td colspan="2">
|
|---|
| 46 | Configure a plugin
|
|---|
| 47 | </td>
|
|---|
| 48 | </tr>
|
|---|
| 49 |
|
|---|
| 50 | <tr>
|
|---|
| 51 | <td colspan="1"> </td><td colspan="2">
|
|---|
| 52 | Change plugin order
|
|---|
| 53 | </td>
|
|---|
| 54 | </tr>
|
|---|
| 55 |
|
|---|
| 56 |
|
|---|
| 57 | <tr>
|
|---|
| 58 | <td colspan="3"><a href="#advanced">Advanced Instructions:</a></td>
|
|---|
| 59 | </tr>
|
|---|
| 60 |
|
|---|
| 61 | <tr>
|
|---|
| 62 | <td colspan="1"> </td><td colspan="2">
|
|---|
| 63 | Custom configuration
|
|---|
| 64 | </td>
|
|---|
| 65 | </tr>
|
|---|
| 66 |
|
|---|
| 67 | <tr>
|
|---|
| 68 | <td colspan="1"> </td><td colspan="2">
|
|---|
| 69 | Rebuilding the plugin database
|
|---|
| 70 | </td>
|
|---|
| 71 | </tr>
|
|---|
| 72 |
|
|---|
| 73 |
|
|---|
| 74 | </table>
|
|---|
| 75 | </td>
|
|---|
| 76 | </tr>
|
|---|
| 77 | </table>
|
|---|
| 78 | <p></p>
|
|---|
| 79 |
|
|---|
| 80 | <p></p>
|
|---|
| 81 | <img width="20" src="../gatherer_small.gif" height="20"><a name="simple"> Simple Instructions:</a>
|
|---|
| 82 | <p style="text-align:justify"></p>
|
|---|
| 83 | To add a plugin, select it using the "Select plugin to add" pull-down list near the
|
|---|
| 84 | bottom and then click "Add Plugin". A window appears entitled
|
|---|
| 85 | "Configuring Arguments"; it is described later. Once you have configured the
|
|---|
| 86 | new plugin, it is added to the end of the "Currently Assigned Plugins" list.
|
|---|
| 87 | Note that a plugin may only occur once in the list.
|
|---|
| 88 | <p></p>
|
|---|
| 89 | To remove a plugin, select it in the list and click "Remove Plugin".
|
|---|
| 90 | <p></p>
|
|---|
| 91 | Plugins are configured by providing arguments. To alter them, select the
|
|---|
| 92 | plugin from the list and click "Configure Plugin" (or double-click
|
|---|
| 93 | the plugin). A "Configuring Arguments" dialog appears with three parts: a
|
|---|
| 94 | text field for entering custom arguments, an area containing controls for
|
|---|
| 95 | specifying arguments, and two buttons at the bottom.
|
|---|
| 96 | <p></p>
|
|---|
| 97 | There are different kinds of controls. Some are checkboxes, and clicking one
|
|---|
| 98 | adds the appropriate option to the plugin. Others are text strings, with a
|
|---|
| 99 | checkbox and a text field. Click the box to enable the argument, then type
|
|---|
| 100 | appropriate text (regular expression, file path etc) in the box. Others are
|
|---|
| 101 | pull-down menus from which you can select from a given set of values. Still
|
|---|
| 102 | others allow multiple selections from a list. To add a value, select it and
|
|---|
| 103 | click "Add"; to remove it, select it and click "Remove". To learn what an
|
|---|
| 104 | argument does, let the mouse hover over its name for a moment and a description
|
|---|
| 105 | will appear.
|
|---|
| 106 | <p></p>
|
|---|
| 107 | When you have changed the configuration, click "OK" to commit the changes and
|
|---|
| 108 | close the dialog, or "Cancel" to close the dialog without changing any plugin
|
|---|
| 109 | arguments.
|
|---|
| 110 | <p></p>
|
|---|
| 111 | The plugins in the list are executed in order, and the ordering is sometimes
|
|---|
| 112 | important. Two plugins, ArcPlug and RecPlug, are vital to the collection
|
|---|
| 113 | building process, and are fixed in place at the end of the list (with a
|
|---|
| 114 | separator line). To change the ordering of the other ones, select the plugin you want to move
|
|---|
| 115 | and click "Move To Top", "Move Up", "Move Down", or "Move To Bottom".
|
|---|
| 116 | <p></p>
|
|---|
| 117 | <img width="20" src="../gatherer_small.gif" height="20"><a name="advanced"> Advanced Instructions:</a>
|
|---|
| 118 | <p style="text-align:justify"></p>
|
|---|
| 119 | The Librarian Interface does its best to determine what arguments a plugin
|
|---|
| 120 | supports. However, there may be cases where the user wants to specify special
|
|---|
| 121 | arguments, and for this a text field called "Custom Arguments" (at the top) is
|
|---|
| 122 | provided. Any text in it is appended verbatim to the end of the plugin
|
|---|
| 123 | command.
|
|---|
| 124 | </body>
|
|---|
| 125 | </html>
|
|---|
