Changeset 5284 for trunk/gli/help


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

Latest version generated from help text.

Location:
trunk/gli/help
Files:
6 added
48 edited

Legend:

Unmodified
Added
Removed
  • trunk/gli/help/1-0.htm

    r4293 r5284  
    2525      <font face="Verdana" size="3">
    2626<p style="text-align:justify">
    27 The Greenstone Librarian Interface is a tool for collecting, expanding and building digital libraries. It gives you access to the Greenstone Digital Library Software's functionality from an easy-to-use 'point and click' interface. This tutorial walks you through the functionality of the Librarian Interface.
    28 </p>
    29 <p style="text-align:justify">
    30 The initial screen is titled "The Librarian Interface: No Collection". The software directs you through the process of creating a collection in an ordered way. This is why many components on the initial screen are greyed out.
     27The Greenstone Librarian Interface is a tool for collecting and marking up documents, then building digital library collections.  It provides access to the Greenstone Digital Library Software's functionality from an graphical point and click interface.
    3128</p>
    3229
  • trunk/gli/help/1-1.htm

    r4293 r5284  
    7676                <td>
    7777                  <font face="Verdana" size="4">
    78 Controls
     78Mouse actions
    7979                  </font>
    8080                  </a>
     
    9191                  <font face="Verdana" size="4">
    9292Keyboard
    93                   </font>
    94                   </a>
    95                 </td>
    96               </tr>
    97               <tr>
    98                 <td>
    99                   &nbsp;
    100                 </td>
    101                 <td>
    102                   &nbsp;
    103                 </td>
    104                 <td>
    105                   <font face="Verdana" size="4">
    106 Mouse actions
    107                   </font>
    108                   </a>
    109                 </td>
    110               </tr>
    111               <tr>
    112                 <td>
    113                   &nbsp;
    114                 </td>
    115                 <td colspan="2">
    116                   <font face="Verdana" size="4">
    117 Menus
    118                   </font>
    119                   </a>
    120                 </td>
    121               </tr>
    122               <tr>
    123                 <td>
    124                   &nbsp;
    125                 </td>
    126                 <td>
    127                   &nbsp;
    128                 </td>
    129                 <td>
    130                   <font face="Verdana" size="4">
    131 Opening menus
    132                   </font>
    133                   </a>
    134                 </td>
    135               </tr>
    136               <tr>
    137                 <td>
    138                   &nbsp;
    139                 </td>
    140                 <td>
    141                   &nbsp;
    142                 </td>
    143                 <td>
    144                   <font face="Verdana" size="4">
    145 Selecting menu items
    146                   </font>
    147                   </a>
    148                 </td>
    149               </tr>
    150               <tr>
    151                 <td>
    152                   &nbsp;
    153                 </td>
    154                 <td>
    155                   &nbsp;
    156                 </td>
    157                 <td>
    158                   <font face="Verdana" size="4">
    159 Closing menus
    16093                  </font>
    16194                  </a>
     
    210143      <font size="3">
    211144<p style="text-align:justify">
    212 The Librarian Interface behaves like other Microsoft Windows programs and draws upon ordinary knowledge of Windows. There are several basic concepts which you must understand before you can proceed.
    213 </p>
    214 <p style="text-align:justify">
    215 We call any part of the screen that you can interact with a 'control'. Examples include buttons you can press and text fields into which you can type values. At any time there is one control, called the 'focus', which you can interact with simply by typing on the keyboard. When in focus a button gains a dotted border and a text field has a flashing line (a 'caret') that shows the position in the text. Several controls allow you to select them or parts of them as discussed later. In all cases the control or its contents are highlighted in dark blue. Finally, controls may be enabled or disabled. Enabled controls can be interacted with by clicking or typing. Disabled ones cannot be interacted with and are greyed out.
    216 </p>
    217 <p style="text-align:justify">
    218 One method of interacting with a control is by using the keyboard to type into text fields and other text based controls. The keyboard can be used with buttons too -- for example, the [Tab] key cycles through the controls visible on the screen. This help text tells you what keys are available. We put the key's name in square brackets, and use a plus sign to show when other keys must be pressed at the same time. For example, a common command for any text field is [Ctrl] + [C], which copies the currently selected text.
    219 </p>
    220 <p style="text-align:justify">
    221 You also interact with the Librarian Interface using the mouse. As you move it, the mouse pointer follows along. You interact with the control under the mouse pointer by clicking on it. There are several different types of click:
    222 </p>
    223 <p style="text-align:justify">
    224 Single left mouse-button click. This is what we normally use,
    225 </p>
    226 <p style="text-align:justify">
    227 Single right mouse-button click. This is used to open context sensitive menus and is always explicitly noted within these help pages,
    228 </p>
    229 <p style="text-align:justify">
    230 Double click. This involves clicking the mouse button twice in quick succession. (It can take practice to get right. You can practice by opening the Microsoft Windows Start Menu, choosing Settings->Control Panel, and opening the 'mouse' icon in this folder. The window that appears will not only let you practice double clicking on the test area at the bottom right of the window, but will let you slow the required clicking down using the double-click speed slider),
    231 </p>
    232 <p style="text-align:justify">
    233 Drag'n'drop. 'Dragging' is when you press a mouse button and move the mouse before releasing it; 'dropping' is when you finally release the button. If you begin dragging over certain controls, such as icons on the Windows desktop, the control attaches to the mouse pointer and you can move it elsewhere on the screen and drop it there. However, you can only drop into certain places, called 'drop targets', and they are indicated by highlighting. If you drop something where it can't be dropped it returns immediately to its original position.
    234 </p>
    235 <p style="text-align:justify">
    236 To use the Librarian Interface you also need to be able to use menus. The 'menu bar' is at the top of the program's window just below the blue title bar. This contains several drop-down submenus, accessed by clicking their label.
    237 </p>
    238 <p style="text-align:justify">
    239 Move the mouse over the label File, and it changes appearance to look like a button. Click once on the label/button File, and the file menu 'drops down' beneath where you clicked.
    240 </p>
    241 <p style="text-align:justify">
    242 You can then move to an item, indicated by blue highlighting, and click once on it. This will execute the corresponding command, or perhaps open a further submenu which appears beside the current menu.
    243 </p>
    244 <p style="text-align:justify">
    245 To close the menu click anywhere else on the screen (not the submenu), or click again on the File label. These menu actions are the same for all menus within Librarian Interface.
    246 </p>
    247 <p style="text-align:justify">
    248 When you have finished working, you can exit the Librarian Interface program at any time either by choosing the Exit item from the File menu, or by clicking the little 'x' button just to the right of the program title (this buttons is called 'Destroy'). If you are working on a collection you will be prompted to save your collection before the program terminates.
     145The Librarian Interface follows Microsoft Windows conventions and draws upon ordinary knowledge of Windows.
     146</p>
     147<p style="text-align:justify">
     148Any part of the screen that you interact with, such as a button or text field, is called a "control".  At any given time one control, called the "focus", is highlighted and responds to the keyboard.  Several controls allow you to select parts that are highlighted in dark blue.  Some controls are greyed out to indicate that they are disabled.
     149</p>
     150<p style="text-align:justify">
     151You can move and left- or right-click the mouse in the usual way.  Many components also allow you to "drag" them, by clicking and holding the left mouse button, move them with the mouse, and "drop" them elsewhere by releasing the button.  Potential drop targets alter their appearance when a component hovers over them.
     152</p>
     153<p style="text-align:justify">
     154You can use the keyboard to type into text fields.  Keyboard alternatives are available for many controls, indicated by a key name in square brackets -- for example, [Tab] alters the focus.  The plus sign shows if other keys must be pressed at the same time.
     155</p>
     156<p style="text-align:justify">
     157Exit the Librarian Interface program by choosing "Exit" from the "File" menu.  Your collection will be saved first.
    249158</p>
    250159
     
    262171      <font size="3">
    263172<p style="text-align:justify">
    264 In each menu and submenu label one letter is underlined. To quickly access any menu within the menu bar, hold down the [ALT] key and then press the underlined letter corresponding to what you want to do. For example, to access the [F]ile menu press [ALT] + [F]. To choose items from a submenu, press the key matching the indicated letter. Thus once in the File menu, press [S] to [S]ave a collection.
     173To access a menu, hold down [ALT] and press the corresponding letter (underlined).  For example, for the "File" menu press [ALT] + [F].  To choose an item, press the corresponding key.  For example.  Thus once in the File menu press [S] to "Save" a collection.
    265174</p>
    266175
  • trunk/gli/help/1-2.htm

    r4293 r5284  
    2525      <font face="Verdana" size="3">
    2626<p style="text-align:justify">
    27 You don't have to read this help text all the way through! You just have to know how to get help when you need it.
     27Don't read this help text all the way through!  Just read enough to learn how to get help when you need it.
    2828</p>
    2929
     
    105105      <font size="3">
    106106<p style="text-align:justify">
    107 One of the menu items is [H]elp. This provides context sensitive help by highlighting what it thinks is the most appropriate help item with a little book icon (the same as appears next to the help menu item).
     107The "Help" menu item marks what may be the most appropriate help item with a little book icon.
    108108</p>
    109109<p style="text-align:justify">
    110 Some controls have tool tips associated with them. If you leave you mouse pointer over them, for a second or two, the tip will appear detailing what the control does.
     110For many controls, if you station the mouse over them a "tool tip" appears that says what they do.
    111111</p>
    112112<p style="text-align:justify">
    113 Before using the Librarian Interface, you should be generally familiar with Greenstone. The documentation explains some of the terms and actions available within the Librarian Interface.
     113Before using the Librarian Interface, first read the Greenstone documentation.
    114114</p>
    115115
  • trunk/gli/help/10-0.htm

    r4293 r5284  
    2525      <font face="Verdana" size="3">
    2626<p style="text-align:justify">
    27 This chapter describes features of the Librarian Interface which are not associated with any particular view.
     27This chapter describes features of the Librarian Interface that are not associated with any particular view.
    2828</p>
    2929
  • trunk/gli/help/10-1.htm

    r4293 r5284  
    1313      <font face="Verdana" size="5">
    1414      <strong>
    15 10.1 Search And Replace
     1510.1 Preferences
    1616      </strong>
    1717      </font>
     
    2525      <font face="Verdana" size="3">
    2626<p style="text-align:justify">
    27 This section explains the search and replace functionality of the Librarian Interface.
     27This section explains the preferences dialog, accessed by opening "File" -> "Preferences".
    2828</p>
    2929
     
    6262                <td colspan="2">
    6363                  <font face="Verdana" size="4">
    64 Search and replace
    65                   </font>
    66                   </a>
    67                 </td>
    68               </tr>
    69               <tr>
    70                 <td colspan="3">
    71                   <font face="Verdana" size="4">
    72                   <strong>
    73 <a href="#AI">Advanced instructions</a>
    74                   </strong>
    75                   </a>
    76                   </font>
    77                 </td>
    78               </tr>
    79               <tr>
    80                 <td>
    81                   &nbsp;
    82                 </td>
    83                 <td colspan="2">
    84                   <font face="Verdana" size="4">
    85 Match case
     64Workflow
    8665                  </font>
    8766                  </a>
     
    9473                <td colspan="2">
    9574                  <font face="Verdana" size="4">
    96 Regular expressions
     75Connection
    9776                  </font>
    9877                  </a>
     
    10584                <td colspan="2">
    10685                  <font face="Verdana" size="4">
    107 Search space
     86Warnings
    10887                  </font>
    10988                  </a>
     
    126105      <font size="3">
    127106<p style="text-align:justify">
    128 It becomes tedious to correct a spelling mistake in an metadata value one occurrence at time.  Consequently the Librarian Interface includes a search and replace feature that allows text to be modified over the entire breadth of a collection. To search, click on the menu item [E]dit -> [S]earch, and to replace choose [E]dit- >Search and [R]eplace. Both prompts are essentially the same, but the former has the replace part disabled.
     107There are two "General" options.  If "View Extracted Metadata" is selected, the various controls dealing with metadata always show all metadata that has been extracted automatically from documents.  "Hide Extracted Metadata" hides it (although it is still available during collection design, and within the final Greenstone collection).
    129108</p>
    130109<p style="text-align:justify">
    131 Type the term that you seek and press [F]ind to begin the search. The first matching text will be shown, in the appropriate view, using highlighting. Furthermore the [F]ind button is disabled and two new buttons become active.  Find [N]ext carries on searching from the last match found, while re[S]tart causes the search position to be reset to the start so that pressing the re-enabled find button find the first match again.
     110The second "General" option is a pull-down list of the various languages that the Librarian Interface can be presented in.  These correspond to the dictionaries located in the "classes" folder of the Librarian Interface's directory.  If you change the dictionary by choosing one from the list, you must restart the Librarian Interface in order to load the new language strings from the dictionary.
    132111</p>
    133112<p style="text-align:justify">
    134 If a replace prompt was chosen, you may type a text string to be substituted for any matches to the search term. When you enter a value in the 'Replace with' field, two new buttons become active. [R]eplace replaces the currently located text with the replacement text. If no text has yet been found, a find operation is run first.  Replace [A]ll replaces all occurrences of the search term within the search space. Once you have performed a replace operation, the [U]ndo button becomes active. Clicking this will undo the most recent operation (or operations if you chose replace all). The Re[D]o button redoes something you've just undone. During any of these steps, Re[S]tart works exactly as described above (although the first match returned may not be the same if you have substituted it with replacement text).
     113The Librarian Interface can support different workflows by determining which of the various view tabs are visible.  Use the "Workflow" tab to customise what views are available by checking the boxes next to the views that you want to be available.  Alternatively, use the pull-down list at the bottom to select predetermined configurations.  Closing the preferences dialog establishes these workflow settings.  These settings are stored with the collection, not in the Librarian Interface configuration file.
    135114</p>
    136115<p style="text-align:justify">
    137 At any time, in either prompt you may click the [C]lose button to hide the dialog prompt.
    138 </p>
    139 
    140       </font>
    141       </p>
    142     </td>
    143   </tr>
    144   <tr bgcolor="#E0F0E0">
    145     <td colspan="3" width="100%">
    146       <img height="20" src="gatherer_small.gif" width="20">
    147       <font face="Verdana" size="4">
    148       <u>
    149 <a name="AI">Advanced Instructions:</a>
    150       </u>
    151       <font size="3">
    152 <p style="text-align:justify">
    153 Below the text fields are several checkboxes that allow you to further customize the search. By default all searches are case insensitive, but you can change this by checking the match case box.
     116The "Connection" tab lets you alter the path to the locally-running Greenstone library server, which is used when Previewing collections.  It also lets you set proxy information for connecting to the Internet (e.g.  when Browsing or Mirroring your files; see 3.0 and 4.0 for details).  Check the box to enable proxy connection and supply details of the proxy host address and port number. The proxy connection is established when you close the Preferences dialog.
    154117</p>
    155118<p style="text-align:justify">
    156 You can also use regular expressions within the search and replace text fields. Most standard regular expression functionality is supported, including capture groups. For instance you could choose to search for 'Re\(.*\)gees'.  This will seek all the 'shortest' text fragments that match 're', followed by any number of characters, followed by 'gees' -- matching 'Refugees', for example. The 'any number of characters' is marked as a capture group (in this case capture group 1) by escaped parentheses. In the replace field you can type '\1\1', which if run would replace 'Refugees' with 'fufu'.
    157 </p>
    158 <p style="text-align:justify">
    159 You can control just what gets searched by checking and unchecking the boxes called metadata elements, filenames and metadata values. Only those that are checked will be searched during a find operation.
     119During the course of a session the Librarian Interface may give warning messages which inform you of possibly unforeseen consequences of an action.  You can disable the messages by checking the "Do not show this warning again" box. You can re-enable warning messages using the "Warnings" tab.  Check the box next to warning messages you want to see again.
    160120</p>
    161121
  • trunk/gli/help/10-2.htm

    r4293 r5284  
    1313      <font face="Verdana" size="5">
    1414      <strong>
    15 10.2 Preferences
     1510.2 File Associations
    1616      </strong>
    1717      </font>
     
    2525      <font face="Verdana" size="3">
    2626<p style="text-align:justify">
    27 This section explains the preferences dialog, accessed by opening [F]ile->[P]references.
     27The Librarian Interface uses particular application programs to open particular file types.  This section explains how to assign and edit these file associations.
    2828</p>
    2929
     
    6262                <td colspan="2">
    6363                  <font face="Verdana" size="4">
    64 Workflow
     64Add association
    6565                  </font>
    6666                  </a>
     
    7373                <td colspan="2">
    7474                  <font face="Verdana" size="4">
    75 Connection
     75Edit association
    7676                  </font>
    7777                  </a>
     
    8484                <td colspan="2">
    8585                  <font face="Verdana" size="4">
    86 Warnings
     86Remove association
    8787                  </font>
    8888                  </a>
     
    105105      <font size="3">
    106106<p style="text-align:justify">
    107 One of the more powerful features of the Librarian Interface is the ability to model different workflows, or progressions through the various view tabs. For instance a simple user might prefer the Librarian Interface without any of the web browsing or mirroring capability, while a user 'in the field' might prefer a Librarian Interface which does everything up to the create step but instead has an export ability to send thier collection to a central 'repository'. Use the 'Workflow' tab of the preferences pane to customise what views are available. Check the box next to the view you wish to be available, otherwise leave it unchecked to cause that view to be disabled. You can use the combobox at the bottom of this page to select predetermined configurations of settings. Once you are done, closing the preferences dialog will establish these workflow settings. Note that these settings are stored with the collection, and not in the Librarian Interface configuration file. In fact the workflow settings in the configuration file are used to hide the view tabs in the Librarian Interface, rather than just disable them (useful for Librarian Interface administrators).
     107To alter file associations open the "File" menu and click "File Associations...".
    108108</p>
    109109<p style="text-align:justify">
    110 If you wish to connect to the interent, such as when Browsing or Mirroring your files (see 3.0 and 4.0 for details), but you must connect via a proxy, then the 'Connection' tab of the preferences dialog is used to set the proxy information. Check the box to enabled proxy connection then fill in the details of the proxy host address and port number. When you close the preferences dialog the proxy connection will be established.
     110To add an association, select the target file extension from the pull-down list, or type in a new extension (do not include the ".").  Next either type command that launches the desired application in the appropriate field, or choose the application from the "Browse" dialog.  "%1" can be used in the launch command to insert the name of the file being opened.  Once these are filled out, "Add" is enabled and can be clicked to add the association.
    111111</p>
    112112<p style="text-align:justify">
    113 During the course of a session you may be provided with one or more warning dialogs. These dialogs inform you of possible unforeseen consequences of an action (such as metadata that is added to a folder automatically being persistantly inherited by all the child files and folders of that folder). If you wish you may choose to disable these dialogs by checking the 'Do not show this warning again' box. However if you later decide to re-enable a warning message then the third tab of the preferences dialog, 'Warnings', will allow you to do this. Simply check the box next to the warning message you wish to show again, selected from the list of dialogs.
     113To edit an association, select an existing file extension.  Any existing associated command is shown in the launch command field.  Edit it, and then click "Update".
     114</p>
     115<p style="text-align:justify">
     116To remove an association, select an existing file extension and click "Remove". (The file extension remains in the "For Files Ending" pull-down list.)
     117</p>
     118<p style="text-align:justify">
     119File associations are stored in the Librarian Interface's folder, in a file called "associations.xml".
    114120</p>
    115121
  • trunk/gli/help/11-0.htm

    r4293 r5284  
    2525      <font face="Verdana" size="3">
    2626<p style="text-align:justify">
    27 This chapter explains how to edit the various metadata sets used by the Librarian Interface, and is pertinent to anyone who wishes to remove a value from the previous values tree. While it is simple to remove a certain metadata value from a record or records, the value itself still appears in the the value tree. This is a feature, not a bug. Instead the way to remove previously assigned values, or indeed any part of the metadata set including its elements, is via the metadata set editor, available under the Metadata menu.
     27This chapter explains how to edit metadata sets used by the Librarian Interface.  This is the only way to remove a value from the "Previous Values" tree.  Although you can use the Librarian Interface to remove a certain value from a record, the value remains in the value tree.  To remove it (or any part of the metadata set, including its elements), use the metadata set editor.
    2828</p>
    2929<p style="text-align:justify">
    30 Also this is a tool used to alter the import profiles, the instructions used to map metadata from files imported into the collection onto existing metadata sets.
     30The same tool is used to alter the instructions that map metadata from files imported into the collection to existing metadata sets.  These are called "importing profiles".
     31</p>
     32<p style="text-align:justify">
     33To edit a metadata set or importing profile, choose "Metadata Sets" from the menu bar and select the "Edit Set" action.
    3134</p>
    3235
     
    3437    </td>
    3538  </tr>
     39</table>
     40&nbsp;<br>
     41&nbsp;<br>
     42&nbsp;<br>
     43&nbsp;<br>
     44&nbsp;<br>
     45&nbsp;<br>
     46&nbsp;<br>
     47&nbsp;<br>
     48&nbsp;<br>
     49&nbsp;<br>
     50&nbsp;<br>
     51&nbsp;<br>
     52&nbsp;<br>
     53&nbsp;<br>
     54&nbsp;<br>
     55&nbsp;<br>
     56&nbsp;<br>
     57&nbsp;<br>
     58&nbsp;<br>
     59&nbsp;<br>
     60&nbsp;<br>
     61&nbsp;<br>
     62&nbsp;<br>
     63&nbsp;<br>
     64&nbsp;<br>
     65&nbsp;<br>
     66&nbsp;<br>
     67&nbsp;<br>
     68&nbsp;<br>
     69&nbsp;<br>
     70&nbsp;<br>
     71&nbsp;<br>
     72</body>
     73</html>
  • trunk/gli/help/11-1.htm

    r4411 r5284  
    1313      <font face="Verdana" size="5">
    1414      <strong>
    15 11.1 Edit Metadata Sets
     1511.1 Editing Metadata Sets
    1616      </strong>
    1717      </font>
     
    2525      <font face="Verdana" size="3">
    2626<p style="text-align:justify">
    27 This section describes the various parts of metadata set and profile editing.
     27This section describes how to edit metadata sets and previously assigned values.
    2828</p>
    2929
     
    7878                </td>
    7979              </tr>
    80               <tr>
    81                 <td>
    82                   &nbsp;
    83                 </td>
    84                 <td colspan="2">
    85                   <font face="Verdana" size="4">
    86 Editing profiles
    87                   </font>
    88                   </a>
    89                 </td>
    90               </tr>
    9180            </font>
    9281            </table>
     
    10594      <font size="3">
    10695<p style="text-align:justify">
    107 The 'Edit Metadata Sets' dialog, which is co-incidently modal, is once again split into three areas. The left consists of a tree containing all of the various parts of the metadata sets or profiles which can be edited. The right instead shows the details of the currently selected part of the tree, in one or more tables. The bottom is layed out with an array of buttons for adding, editing or removing the various parts, while along-side them is the button to close this prompt. Many of the buttons are grayed out initially, but will change depending on your selections in the tree and tables. Now we look at the slightly differing tasks of editing sets, elements and profiles.
     96On the left of the "Edit Metadata Sets" dialog is a list showing what metadata sets and profiles can be edited.  Click one of these and its details will appear on the right in one or more tables.  Beneath are buttons for adding, editing or removing the various parts; alongside them is the "Close" button. Many buttons are greyed out initially, and are activated by selections in the tables.  Now we describe how to edit sets, elements and profiles.
    10897</p>
    10998<p style="text-align:justify">
    110 There are two ways in which you can modify the metadata sets associated with this collection. Firstly you can add a new set or remove an exiting set. Adding can be done at any time, and when you click the button you will be presented with another prompt for garnering details about the new set. The namespace is a short but unique indentifer for your new set (for the namespace for the Development Library Subset is 'dls', while the Dublin Core is 'dc'). Clicking OK in this prompt will create the new set, while Cancel will dispose of the dialog without altering your collection. Removing a set can only be done when a set is selected from the tree. A click on the set Remove button will causes a confirmation prompt to appear, and confirming it will <strong>permanently</strong> remove the set, and all metadata associated with it. The second way in which you can edit a set is by selecting a set, then altering its attributes. The general method for altering attributes is used int several parts of the editor. Add attribute becomes active as soon as a set is selected, and clicking it will provide a dialog for gathering attribute details such as name, language and value. Note that the combobox for the name and value will be empty and each set is considered unique. Pressing OK here will add the new attribute, while Cancel removes the prompt without altering your collection. Edit attribute becomes active when a certain attribute from the table shown when a set is selected. The edit prompt is exactly the same as the add one, except the previous value should be filled out. Edit as necessary and click OK to update. Remove also becomes active, and if clicked and the subsequent confirmation made, the selected attribute is removed.
     99To define a new metadata set, beside "Set" click "Add", fill out the information requested, and click "OK".  "Namespace" is a short identifer for the new set (e.g.  "dc" for Dublin Core; "dls" for the Development Library Subset).
    111100</p>
    112101<p style="text-align:justify">
    113 For metadata elements there are three more editing tasks you can undertake. You could choose to add or remove elements. Adding a element can be done whenever a set is selected, and is accomplished by clicking add on the element row of controls. A prompt will appear asking for the elements name, and once filled out and submitted with the OK button, a new element will be created in the selected set. To <strong>permanently</strong> remove an element, select it from the tree, click the remove button, an accept the confirmation dialog. Note that removing an element will remove all metadata associated with that element. The second subtask, attribute editing, has exactly the same proceedure as for sets explained above. The biggest difference is the the comboboxes in the add and edit prompts should contain several values, as noticed from other elements within the same set. Thus is you have assigned comment to several other elements, other than this one, in the set, then the name 'comment' plus the various values for comment should be available via the comboboxes on the prompt. A feature specific to element editing is the ability to alter the value tree. The value tree contains all the past value assigned for the element selected. You can add a new value whenever an element is selected. Press the appropriate add button, then from the choose the parent subject (if any), enter the value and optionally the alias. Finally click OK to create the node. Editing values is similar except you must first have selected an entry from the value tree. The prompt shown is the same as form adding, except the various fields should already be filled out. Note that changing the parent subject will cause the value to be moved to that subject. Press OK to commit the changes, Cancel to revert. And if a value in the tree is selected the remove button should also become active, and if clicked and the confirmation made, the value will be removed from the tree. Take note, that this <strong>doesn't</strong> remove all metadata referring to this value. In fact this value will be restored, next time you save, if it is still in use.
     102To remove a metadata set, select it in the list on the left and click "Remove". A confirmation prompt will appear; confirming it <strong>permanently</strong> removes the set and all associated metadata.
    114103</p>
    115104<p style="text-align:justify">
    116 If you expand the 'Importing Profiles' folder, which in and of itself has no editing ability, you will be presented with the source locations that have importing profiles associated with them. Not all files you include in your collection will have previous metadata, and not all those that do will require special instructions to map onto existing metadata (especially if they are built from the same metadata set). Once the 'Importing Profiles' folder is selected you may add new 'file' sources by clicking the add button next to the 'file' label. The prompt displayed is rather basic requiring you only to fill in a file name (the Librarian Interface doesn't even check that its legal, unfortunately), before pressing OK to add the file source. If you select a file you can choose to delete it using the same method for all other removals. Also once a file is selected its 'attributes' table appears. In this case the attributes are actually the mappings from the name of an element from the source file location to the name of an element within the collection. The add a new mapping, select a source file, then click the add attribute button. The standard add/edit attribute dialog will appear, except the language field will be disabled and the values combobox will contain all of the elements currently available in the collection. OK will add the new profile while Cancel does exactly that. Editing a napping is exactly as above, as is deletion.
     105Some information is associated with each metadata set, such as its creator and creation date.  We call these "attributes" of the metadata set, and you can alter them. Beside "Attribute", click "Add" to add an attribute to the selected metadata set, fill in the requested information -- name, language and values -- and click "OK".  Each metadata set is considered unique, so for a new metadata set the pull-down list for the name and value are initially empty.  Beside "Attribute", "Edit" becomes active when an attribute is selected in the table and leads to the same dialog as "Add" (except that the current value is already filled out).  Beside "Attribute", "Remove" becomes active when the attribute is selected; when clicked the attribute is removed.
    117106</p>
    118107<p style="text-align:justify">
    119 Once you are happy with the changes click Close to close the dialog.
     108For metadata elements you can add an element, remove it, and remove values from it.  To add an element, beside "Element" click "Add" and specify the new element's name.
     109</p>
     110<p style="text-align:justify">
     111To remove a metadata element, select it and beside "Element" click "Remove". This <strong>permanently</strong> removes the element and all metadata associated with it.
     112</p>
     113<p style="text-align:justify">
     114Just as information is associated with each metadata set, information can also be associated with each metadata element -- metadata about metadata!  Again we call these "attributes"; Examples are a language-specific name for the element, its definition, or perhaps a general comment.
     115</p>
     116<p style="text-align:justify">
     117You edit the attributes of an element in the same way that you edit the attributes of a metadata set, explained above.  In this case the pull-down lists in the add and edit prompts may contain values from the same attribute of other elements within the set.  Also, you can alter the "value tree", which contains all the values that have been assigned to a particular element.  You can "Add" a value whenever an element is selected.  Choose the parent subject (if any), enter the value and optionally the alias, and click "OK" to put the new value in the tree.  You can "Edit" a value that you have selected in the value tree; click "OK" to commit the changes.  Note that changing the parent subject will cause the value to be moved to that subject.  You can "Remove" a value that you have selected in the tree -- but note that this does <strong>not</strong> remove all metadata referring to this value, and if the value is still in use it will be restored the next time you save.
     118</p>
     119<p style="text-align:justify">
     120Once you have finished changing the metadata set, click "Close".
    120121</p>
    121122
  • trunk/gli/help/2-0.htm

    r4293 r5284  
    2525      <font face="Verdana" size="3">
    2626<p style="text-align:justify">
    27 This chapter covers how to create, save and load a collection session.
     27This chapter covers how to create, save and load a collection.
    2828</p>
    2929
  • trunk/gli/help/2-1.htm

    r4293 r5284  
    165165                </td>
    166166              </tr>
    167               <tr>
    168                 <td>
    169                   &nbsp;
    170                 </td>
    171                 <td colspan="2">
    172                   <font face="Verdana" size="4">
    173 Current collection
    174                   </font>
    175                   </a>
    176                 </td>
    177               </tr>
    178               <tr>
    179                 <td colspan="3">
    180                   <font face="Verdana" size="4">
    181                   <strong>
    182 <a href="#QA">Problems and solutions</a>
    183                   </strong>
    184                   </a>
    185                   </font>
    186                 </td>
    187               </tr>
    188               <tr>
    189                 <td>
    190                   &nbsp;
    191                 </td>
    192                 <td colspan="2">
    193                   <font face="Verdana" size="4">
    194 "I want to change the values I entered for title/email/description. How do I do that?"
    195                   </font>
    196                   </a>
    197                 </td>
    198               </tr>
    199167            </font>
    200168            </table>
     
    213181      <font size="3">
    214182<p style="text-align:justify">
    215 To create a new collection, open the [F]ile menu and choose the menu item [N]ew. A new form, the New Collection Prompt, appears. Several fields need to be filled out. Click in any field (the white area) to move the cursor there, or press [Tab] to cycle through the fields (and buttons). You can change any value you enter later, in the 'Design' view.
    216 </p>
    217 <p style="text-align:justify">
    218 The collection title is the text that will be displayed at the top of your collection's homepage, and can be any length. You should not use the quotation character (") in this (or any other) text field; if you do the Librarian Interface will remove it.
    219 </p>
    220 <p style="text-align:justify">
    221 The collection name is the actual file name of your collection, under which it will be saved to disk. The Librarian Interface uses this name in several places. It is limited to seven characters in length. Also note that it must be unique, and that if a collection with this name already exists the new collection action will fail with an error message. If this happens you will be returned to the new collection prompt and the name field will be highlit to indicate the file clash.
    222 </p>
    223 <p style="text-align:justify">
    224 The author's email must be a valid email address.
    225 </p>
    226 <p style="text-align:justify">
    227 The collection description should describe, in as much detail as possible, what your new collection is about. It is unlimited in length, and you can use the [Enter] key to break it into paragraphs. You cannot use the [Tab] key to set margins, because this key shifts the focus to one of the buttons at the bottom of the screen.
    228 </p>
    229 <p style="text-align:justify">
    230 The final field allows you to chose which metadata sets are to be available within your collection. All the metadata sets found in the Librarian Interface metadata directory will be shown here.  Click the checkbox next to the sets you want to add. You may of course choose to start a new collection with no metadata sets loaded. Regardless one metadata set is always loaded, "Greenstone.mds".
    231 </p>
    232 <p style="text-align:justify">
    233 Once you have entered information in these fields, click the [O]K button to create the collection.
    234 </p>
    235 <p style="text-align:justify">
    236 If at any time you decide not to create a new collection, click the [C]ancel button. The prompt will close and you will return to the main screen.
     183To create a new collection, open the "File" menu and choose "New".  Several fields need to be filled out -- but you can change their values later if you need to, in the design view.
     184</p>
     185<p style="text-align:justify">
     186"Title" is the text displayed at the top of your collection's homepage.  It can be any length.
     187</p>
     188<p style="text-align:justify">
     189"Short Name" is the collection's filename.  It must be unique.
     190</p>
     191<p style="text-align:justify">
     192"Author's Email" should be a valid email address.
     193</p>
     194<p style="text-align:justify">
     195"Description of content" should describe, in as much detail as possible, what the collection is about. Use the [Enter] key to break it into paragraphs.
     196</p>
     197<p style="text-align:justify">
     198Now choose whether to view or hide the metadata that Greenstone extracts automatically from documents.  (This option can be changed later -- see Section 10.1 -- Preferences.)
     199</p>
     200<p style="text-align:justify">
     201Finally you must specify whether the new collection will have the same appearance and metadata sets as an existing collection, or whether to start a default "New Collection".
     202</p>
     203<p style="text-align:justify">
     204Click "OK" to create the collection.  If you chose "New Collection" you are prompted for the metadata sets to use in it.  You can choose more than one, and you can add others later.
     205</p>
     206<p style="text-align:justify">
     207Clicking "Cancel" returns you to the main screen immediately.
    237208</p>
    238209
     
    250221      <font size="3">
    251222<p style="text-align:justify">
    252 Buttons, like menus, have one character underlined. If you press [ALT] and the underlined character at the same time, the response will be just as if you clicked the button. (This goes for most buttons in the Librarian Interface.)
    253 </p>
    254 <p style="text-align:justify">
    255 If a collection is already open and you ask for a new one, a Save Collection prompt appears before the New Collection prompt. This is described in the next section, saving your collection. You have to finish with this prompt before the New Collection prompt will appear.
     223Buttons, like menus, have one character underlined.  To "click" the button, press [ALT] and the underlined character at the same time.
    256224</p>
    257225
    258226      </font>
    259227      </p>
    260     </td>
    261   </tr>
    262   <tr bgcolor="#E0F0E0">
    263     <td colspan="3" width="100%">
    264       <img height="20" src="gatherer_small.gif" width="20">
    265       <font face="Verdana" size="4">
    266       <u>
    267 <a name="QA">Problems and Solutions:</a>
    268       </u>
    269       <font size="3">
    270       <i>
    271 <p style="text-align:justify">
    272 "I want to change the values I entered for title/email/description. How do I do that?"
    273 </p>
    274 
    275       </i>
    276 <p style="text-align:justify">
    277 Once a collection has been created these details can be changed in the Design view.
    278 </p>
    279 
    280       </font>
    281228    </td>
    282229  </tr>
  • trunk/gli/help/2-2.htm

    r4293 r5284  
    1313      <font face="Verdana" size="5">
    1414      <strong>
    15 2.2 Saving Your Collection
     152.2 Saving the Collection
    1616      </strong>
    1717      </font>
     
    2525      <font face="Verdana" size="3">
    2626<p style="text-align:justify">
    27 This section describes how to save a collection, and how to address the Save Collection Prompt.
     27This section describes how to save a collection, and the Save Collection Prompt.
    2828</p>
    2929
     
    6868              </tr>
    6969              <tr>
    70                 <td>
    71                   &nbsp;
    72                 </td>
    73                 <td colspan="2">
    74                   <font face="Verdana" size="4">
    75 The save collection prompt
    76                   </font>
    77                   </a>
    78                 </td>
    79               </tr>
    80               <tr>
    8170                <td colspan="3">
    8271                  <font face="Verdana" size="4">
     
    9988                </td>
    10089              </tr>
    101               <tr>
    102                 <td colspan="3">
    103                   <font face="Verdana" size="4">
    104                   <strong>
    105 Problems and Solutions
    106                   </strong>
    107                   </a>
    108                   </font>
    109                 </td>
    110               </tr>
    111               <tr>
    112                 <td>
    113                   &nbsp;
    114                 </td>
    115                 <td colspan="2">
    116                   <font face="Verdana" size="4">
    117 "What happens if I make a mistake while I'm working and want to reload the original collection?"
    118                   </font>
    119                   </a>
    120                 </td>
    121               </tr>
    12290            </font>
    12391            </table>
     
    136104      <font size="3">
    137105<p style="text-align:justify">
    138 Now you have created a new collection, you should save it regularly. To do this, open the [F]ile menu and choose the [S]ave command, or type [Alt] + [F] followed by [S]. After a slight delay while the collection is saved, you will return to the main screen ready to continue. Note that this saved collection needs to be 'created' before it can be viewed through Greenstone (see Previewing Your Collection).
     106Save your work regularly by opening the "File" menu and choosing "Save". Saving a collection is not the same as making it ready for use in Greenstone (see Chapter 8 -- Producing Your Collection).
    139107</p>
    140108<p style="text-align:justify">
    141 If the current collection is unsaved and you take any action that might lose it (such as exiting the program or loading another collection), the Librarian Interface will prompt you to save first by presenting a small window in the middle of the screen that won't go away until you attend to it. For the Save prompt, the available actions are:
    142 </p>
    143 <p style="text-align:justify">
    144 [Y]es -- saves the current collection before carrying out the next action. [N]o -- does not save the collection and carries out the next action regardless. [C]ancel -- does not save the collection, but does not carry out the action either. The program returns to the state it was in before the action.
     109The Librarian Interface protects your work by saving it whenever you exit the program or load another collection.
    145110</p>
    146111
     
    158123      <font size="3">
    159124<p style="text-align:justify">
    160 When you save a collection, its data will be written to a file whose name is the same as the collection name (maximum seven characters), with file extension .col, located in a directory of the same name within the collect directory of your Greenstone installation.
     125Saved collections are written to a file named for the collection and with file extension ".col", located in a folder of the same name within your Greenstone installation's "collect" folder.
    161126</p>
    162127
    163128      </font>
    164129      </p>
    165     </td>
    166   </tr>
    167   <tr bgcolor="#E0F0E0">
    168     <td colspan="3" width="100%">
    169       <img height="20" src="gatherer_small.gif" width="20">
    170       <font face="Verdana" size="4">
    171       <u>
    172 <a name="QA">Problems And Solutions:</a>
    173       </u>
    174       <font size="3">
    175       <i>
    176 <p style="text-align:justify">
    177 "What happens if I make a mistake while I'm working and want to reload the original collection?"
    178 </p>
    179 
    180       </i>
    181 <p style="text-align:justify">
    182 Just open the original collection as described in Opening An Existing Collection, but select [N]o within the Save Collection prompt. The current version will not be saved, and the original will be reloaded.
    183 </p>
    184 
    185       </font>
    186130    </td>
    187131  </tr>
  • trunk/gli/help/2-3.htm

    r4293 r5284  
    7171                  <font face="Verdana" size="4">
    7272                  <strong>
    73 <a href="#QA">Problems and solutions</a>
     73<a href="#AI">Advanced instructions</a>
    7474                  </strong>
    7575                  </a>
     
    8383                <td colspan="2">
    8484                  <font face="Verdana" size="4">
    85 "I can't see my collection file?"
    86                   </font>
    87                   </a>
    88                 </td>
    89               </tr>
    90               <tr>
    91                 <td>
    92                   &nbsp;
    93                 </td>
    94                 <td colspan="2">
    95                   <font face="Verdana" size="4">
    96 "Whenever I try to load my collection I receive an error message about some other Librarian Interface session using the collection?" or "What does the little red icon next to my collection mean?"
     85Locked collections
    9786                  </font>
    9887                  </a>
     
    115104      <font size="3">
    116105<p style="text-align:justify">
    117 To open an existing collection, choose [O]pen from the [F]ile menu to get the Open Collection prompt (just like in any Windows program).
    118 </p>
    119 <p style="text-align:justify">
    120 At the top of the window is a text field with a little triangular button at its right end (this is called a 'ComboBox'). Click on the triangle to reveal a list of items that you can select. The items are directories in your file system; this is a quick way to select one.
    121 </p>
    122 <p style="text-align:justify">
    123 Another of the buttons to the right of the dropdown box shows a folder with an upward-pointing arrow, and this is used to move to a parent directory. If you are in the directory 'c:\program files\gsdl\collect\modelcol\', pressing this button would move to 'c:\program files\gsdl\collect\'.
    124 </p>
    125 <p style="text-align:justify">
    126 Most of the screen is a large white area that lists the files and subdirectories within the directory you are currently in. If you interact with a file it will appear in the text field at the bottom of the screen, and may be opened as well (depending on the interaction). If you interact with a directory you will move into it. Down the right-hand side of this white space is a scroll bar with arrows at top and bottom to move the list up and down, and a large grey button which represents the part you are viewing. Drag the scroll bar up and down to move to a desired part of the page.
    127 </p>
    128 <p style="text-align:justify">
    129 Next on the page is a text area where the description of the collection is displayed (if a collection is currently selected).
    130 </p>
    131 <p style="text-align:justify">
    132 To the left of the [O]pen and [C]ancel buttons is the text field where the name of any selected file is shown. If you know what file you are seeking, type its name here and click [O]pen.
    133 </p>
    134 <p style="text-align:justify">
    135 The list of files displayed initially is determined from the collect directory of your Greenstone installation. Open the folder corresponding to your collection by double-clicking it and in it locate the file whose name is the collection name followed by ".col". Click once and then respond [O]K, or alternatively double-click on the file (anywhere in its row will do), or use the arrow keys to change your selection. After a short loading delay, the collection will open and you will be returned to the main screen. Clicking [C]ancel will return you to the main screen without opening anything.
     106To open an existing collection, choose "Open" from the "File" menu to get the Open Collection prompt.  A list of your Greenstone collections appears. Select one to see its description, and click "Open" to load it.  If you seek a collection that resides outside Greenstone's "collect" folder, click "Browse" for a file system browsing dialog.
    136107</p>
    137108
     
    145116      <font face="Verdana" size="4">
    146117      <u>
    147 <a name="QA">Problems And Solutions:</a>
     118<a name="AI">Advanced Instructions:</a>
    148119      </u>
    149120      <font size="3">
    150       <i>
    151121<p style="text-align:justify">
    152 "I can't see my collection file?"
     122In case more than one Greenstone Librarian Interface program is running concurrently, the relevant directories are "locked" to prevent interference. On opening a collection, a small temporary lock file is created in its folder.  Before opening a collection, the Librarian Interface checks to ensure that no lock file already exists.  You can tell whether a collection is locked by the colour of its icon: green for a normal collection, red for a locked one.  However, when the Librarian Interface is exited prematurely the lock file is sometimes left in place.  When you open such a collection, the Librarian asks if you want to "steal" control of it.  Never steal a collection that someone else is currently working on.
    153123</p>
    154124
    155       </i>
    156 <p style="text-align:justify">
    157 The file is named '<collection name>.col' within a directory named '<collection name>'. Ensure that you are in the correct directory. If you are unsure, cancel the Open Collection prompt by clicking [C]ancel, then reopen it as described above. It always starts in the Greenstone collection directory.
    158 </p>
    159 
    160       <i>
    161 <p style="text-align:justify">
    162 "Whenever I try to load my collection I receive an error message about some other Librarian Interface session using the collection. Why? How do I fix it?" or "What does the little red icon next to my collection mean?"
    163 </p>
    164 
    165       </i>
    166 <p style="text-align:justify">
    167 To allow for several copies of the Librarian Interface to be running at once, without encountering problems when two users attempt to edit the same collection, 'lock files' are used. When you open or create a collection, a small temporary file, 'lock.tmp', is created in that collection's directory. Before the Librarian Interface opens a collection, it checks whether a lock file exists, and if so refuses to open the collection. You can quickly tell if the collection is locked by the colour of its icon: greenstone green for a normal collection, red for a locked collection. However, sometimes lock files are left behind when the Librarian Interface is exited prematurely. In this case you can choose to 'steal' control over the collection. Be warned though that stealing the lock from a collection that is currently opened by someone else will cause one of the users data to be lost adter saving (it depends on who saves last).
    168 </p>
    169 
     125      </font>
     126      </p>
     127    </td>
     128  </tr>
    170129      </font>
    171130    </td>
  • trunk/gli/help/3-0.htm

    r4293 r5284  
    2525      <font face="Verdana" size="3">
    2626<p style="text-align:justify">
    27 Please note that this section is only relevant if you have run the Librarian Interface using the '-mirror' argument flag used to enable the 'Hunt' and 'Mirror' views. If the flag was not used then those tabs will not appear in the row of tabs, nor will any preference options related to these features be available.
     27The Librarian Interface can run in different configurations.  This chapter only applies when the "browse" and/or "mirror" views are enabled.  If these tabs do not appear, advanced users can enable them by editing the "config.xml" file in the Librarian Interface installation folder (or, on a multiuser system, in your home directory's ".gli" folder) to set the values of "workspace.browse" and "workspace.mirror" to "true".
    2828</p>
    2929<p style="text-align:justify">
    30 While the Librarian Interface allows you to import files from anywhere on the local file system, it was originally designed to locate web-based resources. To support this required two distinct stages. This chapter describes the first, Hunting, where you browse the internet for files of interest.
     30When using web resources, the Librarian Interface operates in two stages.  This chapter describes the first, Hunting, where you browse the Internet for files of interest.
    3131</p>
    3232
  • trunk/gli/help/3-1.htm

    r4293 r5284  
    1313      <font face="Verdana" size="5">
    1414      <strong>
    15 3.1 The 'Hunt' view
     153.1 The Hunt view
    1616      </strong>
    1717      </font>
     
    2525      <font face="Verdana" size="3">
    2626<p style="text-align:justify">
    27 This section describes how to use the simplified browsing interface to locate resources on the internet.
     27This section describes how to use the simplified browsing interface to locate resources on the Internet.
    2828</p>
    2929
     
    7878                </td>
    7979              </tr>
    80               <tr>
    81                 <td colspan="3">
    82                   <font face="Verdana" size="4">
    83                   <strong>
    84 Problems and Solutions
    85                   </strong>
    86                   </a>
    87                   </font>
    88                 </td>
    89               </tr>
    90               <tr>
    91                 <td>
    92                   &nbsp;
    93                 </td>
    94                 <td colspan="2">
    95                   <font face="Verdana" size="4">
    96 "The page I'm attempting to view to won't renderer or only partially renders, then the program appears to hang?"
    97                   </font>
    98                   </a>
    99                 </td>
    100               </tr>
    10180            </font>
    10281            </table>
     
    11594      <font size="3">
    11695<p style="text-align:justify">
    117 When you first encounter the 'Hunt' view, by clicking on the similarily named tab along the top of the screen, you should hopefully be greeted by a familiar screen. The majority of the screen is dedicated to the view of the webpage, and also provides scrollable ability if the page shown is large than the available space. The document shown within this pane is either a 'rendered' HTML page, or and image or other media. Rendering is the process whereby specially structured text, such as HTML, is turned into a formatted page. The document itself is exactly the same as any web-page shown in Internet Explorer or similar internet browing software, with hyperlinks underlined and highlighted. Clicking on a hyperlink will take you to the page it refers to. At the very bottom of the screen is the status bar which gives you feedback as to what the browser is currently doing. When it displays 'Ready' the current page is fully loaded.
     96The Hunt view is accessed by clicking on its tab.  Most of the screen shows a web page.  Hyperlinks work in the usual way.  Underneath the page is a status bar that shows you what the browser is doing.
    11897</p>
    11998<p style="text-align:justify">
    120 Directly above the page view, and in the center of the screen, is the address field. You type URL addresses into this box, which should be in the same form as http://www.greenstone.org/ or http://www.cs.waikato.ac.nz/ etc. The field will also be updated to show the address of any page you surf through to (by clicking on hyperlinks within the html page), or are redirected to.
     99You type URL addresses into the address field above the page.
    121100</p>
    122101<p style="text-align:justify">
    123 To the left and right of the address field are six buttons. These provide control over the web page being shown. The buttons are, from left to right: Back, Reload, Home, Go, Stop and Forward. Back is used to return to the previous page you viewed this session, and will only have an effect if there was a page previous to the currently shown one. Reload caused the currently displayed page to be reloaded from its web source, ensuring the latest copy is shown or reattempting to find images and other imbedded objects that may have failed on the first attempt. Home causes the nzdl homepage to be loaded. Go is used to make the browser visit the url you have typed in the address field. It is usually quicker to press [Enter] while in the address field. Stop causes the browser to stop whatever it is doing and return to the ready state. Forward only works if you have previously gone back in the browsing history, and it loads the next page you visited. To review which button is which, let your mouse pointer sit over it for a moment and its name should appear.
     102To the left and right of the address field are web browser buttons for Back, Reload, Home, Go, Stop and Forward.
    124103</p>
    125104
    126105      </font>
    127106      </p>
    128     </td>
    129   </tr>
    130   <tr bgcolor="#E0F0E0">
    131     <td colspan="3" width="100%">
    132       <img height="20" src="gatherer_small.gif" width="20">
    133       <font face="Verdana" size="4">
    134       <u>
    135 <a name="QA">Problems And Solutions:</a>
    136       </u>
    137       <font size="3">
    138       <i>
    139 <p style="text-align:justify">
    140 "The page I'm attempting to view to won't renderer or only partially renders, then the program appears to hang?"
    141 </p>
    142 
    143       </i>
    144 <p style="text-align:justify">
    145 Currently no 'perfect' html renderer exists for pure java programs. The package I've choosen to use, CalpaHTML, is one of the best, but it too has some drawbacks. The most common of these is that it flickers when its renderer a web page that contains animated images. Less common, but more problematic, is when it encounters pages with heavy use of frames, internal frames or nested tables. Most of the time these pages will render, although their layout will be questionable. Occasionally they will cause CalpaHTML to get stuck in an infinite loop, and even pressing stop will have no effect. The only solution known is to press the back button, which will return you to the last page successfully rendered. However you will not be able to view the problem page in the built-in browser.
    146 </p>
    147 <p style="text-align:justify">
    148 Investigation was done into whether we could use a more stable, native HTML renderer, such as the Mozilla engine, to renderer. But these too had serious drawbacks such as lack of control, the restriction to only one view pane per JVM and large library sizes (increasing the size of Librarian Interface to unreasonable proportions).
    149 </p>
    150 <p style="text-align:justify">
    151 (That said, I have found web pages which even Internet Explorer and Netscape refuse to render, so perhaps the Librarian Interfaces not doing too badly.)
    152 </p>
    153 
    154       </font>
    155107    </td>
    156108  </tr>
  • trunk/gli/help/4-0.htm

    r4293 r5284  
    2525      <font face="Verdana" size="3">
    2626<p style="text-align:justify">
    27 Please note that this section is only relevant if you have run the Librarian Interface using the '-mirror' argument flag used to enable the 'Hunt' and 'Mirror' views. If the flag was not used then those tabs will not appear in the row of tabs, nor will any preference options related to these features be available.
     27To enable web mirroring see Section 3.1 -- The Hunt View. To download web pages you need to install the mirroring tool wget (version v1.8 recommended) and make it accessible from the Librarian Interface "install" folder.
    2828</p>
    2929<p style="text-align:justify">
    30 The current system of downloading requires you to have a copy of the open source mirroring tool wget installed (preferrably WGet v1.8) and have it accessible from the Librarian Interface install directory (by including it in your path settings).
    31 </p>
    32 <p style="text-align:justify">
    33 As mentioned previously, sourcing files from the web is a two stage process. The second stage, having found the files you wish to gather, is to download (or 'mirror') onto the local filespace. This chapter explains the Librarian Interfaces mirroring process.
     30When using web resources, the second stage is to download (or "mirror") the files you need.  This chapter explains the Librarian Interface's mirroring process.
    3431</p>
    3532
  • trunk/gli/help/4-1.htm

    r4293 r5284  
    1313      <font face="Verdana" size="5">
    1414      <strong>
    15 4.1 The 'Mirror' view
     154.1 The Mirror view
    1616      </strong>
    1717      </font>
     
    2525      <font face="Verdana" size="3">
    2626<p style="text-align:justify">
    27 This section describes how to configure a download task, and how to control the downloading process.
     27This section describes how to configure a download task and control the downloading process.
    2828</p>
    2929
     
    137137      <font size="3">
    138138<p style="text-align:justify">
    139 The 'Mirror' view is accessed by clicking on its tab within the row of tabs. Unfortunately the mirroring view is probably the most complex in the Librarian Interface. To the left of the screen is the workspace tree which is the same as the one shown on the left of the 'Gather' view. The bottom of the screen is initially blank, but will later contain a list of pending download jobs. Finally the right of the screen is covered with the controls used to configure a new download job.
    140 </p>
    141 <p style="text-align:justify">
    142 The workspace tree will be discussed in detail in later sections. But for now notice the appearance of one or two new base level folders. The first of these, 'Public Workspace', is always present when mirroring is enabled, and can be thought of as the shared cache of files. Any files downloaded here will be availble to any other collections built with this copy of the Librarian Interface. The second folder, 'Private Workspace', only appears once a collection has been opened. This file cache is stored with the collection, so only this collection has access to it. In either case, files will be stored into these areas using their full path names as determined from the url of these source page. Thus a new folder will be created for the url host name, then more as necessary as the path specifies. This ensures that each file is distinct, so that you can download several index.htm pages from different urls, without overwriting the previous ones.
    143 </p>
    144 <p style="text-align:justify">
    145 Now for the new download task configuration controls. The very top field is used to enter the url to the target resource you wish to retrieve. If you have been browsing using the 'Hunt' view, this field will automatically be filled with the url of the last page visited. The next control, labelled 'Download depth' informs the Librarian Interface how many times you wish to follow hyperlinks and download the resources found there as well. A depth of 0 means no hyperlinks will be followed and only the target resource will be retrieved, while ticking the infinite box could possibly cause you to mirror <strong>the entire internet!</strong> The depth is ignored when downloading media other than html pages. The next control lets you choose the destination for the files downloaded, by clicking on the appropriate toggle button. The selected destination is denoted by a large tick. The next control, when ticked, causes any hyperlinked objects needed to render the page properly to be downloaded. Note that this is independant of the download depth setting as it only considers embedded objects (i.e. internal not external hyperlinks). The next control lets you determine if the Librarian Interface can mirror files from paths above the target url (this is determined from the path, which is the portion of the url after the hostname). The 'Only mirror within the same site' control restricts the mirroring to files with the same host name when ticked. The next control determines whether local files should ever be overwritten during download and the second to last control, within the 'Download List Options' group, allows you to specify what should happen to download tasks if they fail for some reason. Note that changes to this control are immediate, rather than part of a specific download job. The final control to discuss is the 'Download' button which creates a new job by looking at the configuration settings above, then adds it to the download list.
    146 </p>
    147 <p style="text-align:justify">
    148 Whil blank initially the download list will eventually contain several entries, each representing a download task, and each with the same general appearance. You can scroll the list to see further tasks. Looking at a single task, you will notice two buttons to the left and right, and a central region with several lines of text and a progress bar. The text gives details of the task, and will update as the task progresses, while the progress bar gives an indicating of activity. The button to the left, with the blue 'play' triangle on it, will begin the current task. Once it has been pressed the downloading will begin, and its icon will change to double vertical bars or 'pause'. Pressing pause will pause the current download. The button to the right, with the blue 'stop' square, will cause the current download task to be removed from the list. If a download task completes successfully it will automatically be removed from the download list, while whether it is removed on failure is controlled by the download list option.
     139Access the "Mirror" view by clicking its tab.  On the left is the workspace tree described in section 5.1 -- The Gather View.  The bottom of the screen shows a list of pending download jobs.  On the right are the controls used to control downloading.
     140</p>
     141<p style="text-align:justify">
     142Files are downloaded into a folder in the workspace tree called "Public WebCache" (only present when mirroring is enabled), and can be used in all collections built with the Librarian Interface.  When a collection is open a second folder, "Private WebCache", appears, associated with that collection so that it alone has access.  Files in both these areas are named by their full web URL.  A new folder is created for each host, followed by others for each part of the path.  This ensures that each file is distinct.
     143</p>
     144<p style="text-align:justify">
     145Use the first of the download configuration controls to enter the URL of a target resource.  If you have come from the "Hunt" view, this field points to the last page visited.  Use the "Download Depth" control to determine how many hyperlinks to follow when downloading: 0 means no hyperlinks and grabs just the target resource; "infinite" would grab the entire Internet!  The depth limit is ignored when downloading media other than html pages.  Use the next radio button control to choose whether the files are cached into the shared public folder or the private collection-specific folder.  Checking "Automatically download embedded objects" also downloads any objects needed to render the page properly (irrespective of the depth setting).  Use the next control to determine whether to mirror files from paths above the target URL.  "Only mirror within the same site" restricts the mirroring to files with the same host name.  The next control determines whether local files can be overwritten during download.  The next one, in the "Download List Options" group, determines what happens to download tasks that fail for some reason.  This takes effect immediately, rather than pertaining to a specific download job as the other specifications do.  The final control is a "Download" button which adds to the download list a new job corresponding to the configuration settings.
     146</p>
     147<p style="text-align:justify">
     148The download list has an entry for each unfinished download.  For each entry, a central region with several lines of text and a progress bar is flanked by two buttons.  The text gives details of the task, and updates as the task progresses, while the bar measures progress.  The "play" triangle on the left button starts the current task and then changes to a double vertical bar, which pauses the current download.  The "stop" square on the right button removes the current download task from the list.  Download tasks are removed from the list when they finish successfully (ones that fail are controlled by the "Download List Options").
    149149</p>
    150150
     
    162162      <font size="3">
    163163<p style="text-align:justify">
    164 You may have noticed that there is a label at the bottom of the download configuration controls that states you should see the preferences page for more options. This is available for those users who must access the internet via a proxy web server. If you open the preference prompt, found under the File menu, and change to the 'Connection' tab, you will be presented with controls for setting the proxy. First tick the box if it is appropriate, then enter the name and port of the proxy server. Finally you can press the 'Establish Connection' button to attempt to connect to the proxy immediately, otherwise the Librarian Interface will connect the next time it is started. The reason these options are provded here, and not on the 'Mirror' view, is that they are persistant between sessions, and are automatically re-established whenever the Librarian Interface starts. Also note that if authentication is needed for connection to the proxy server you should be prompted for a login and password (you may infact be prompted twice due to a bug in how Java connects to proxies). A valid login/password is persistant for the remainder of that Librarian Interface session, but is not stored between sessions due to security considerations.
    165 </p>
    166 <p style="text-align:justify">
    167 Again you may have noticed that the feedback during downloading is poor at the very best, with the progress bar only showing that something is happening, and the status text sometimes very vague about what is actually happening (you are told last file downloaded, not what is downloading at this time). This is due to limitations of running Wget as an external process to the Librarian Interface. There is a more advance mode of running the mirroring part of the Librarian Interface which integrate WGet functionality directly using special java libraries called the JNI. This provides exact details of what is happening including an accurate progress bar for each file. However this mode is currently disabled due to its platform specific nature. Watch for this ability in the future.
     164Section 10.1 -- Preferences describes how to establish an Internet connection via a proxy.  If authentication is needed, the proxy server prompts for identification and password.  The Librarian Interface does not store passwords between sessions.
    168165</p>
    169166
  • trunk/gli/help/5-0.htm

    r4293 r5284  
    2525      <font face="Verdana" size="3">
    2626<p style="text-align:justify">
    27 You have created a new collection and it's time to import some files into it. These files may be sourced from several areas, including previous Greenstone Collections. You may also choose to import files that already have metadata assigned to them. The actions involved in this file gathering stage are detailed within this chapter.
     27Once you have a new collection you need to get some files into it.  These may come from your ordinary file space, or from other Greenstone collections.  Some may already have attached metadata.  This chapter describes how to import files.
    2828</p>
    2929
  • trunk/gli/help/5-1.htm

    r4293 r5284  
    1313      <font face="Verdana" size="5">
    1414      <strong>
    15 5.1 The 'Gather' View
     155.1 The Gather View
    1616      </strong>
    1717      </font>
     
    127127                <td colspan="2">
    128128                  <font face="Verdana" size="4">
    129 Special directory mapping
    130                   </font>
    131                   </a>
    132                 </td>
    133               </tr>
    134               <tr>
    135                 <td colspan="3">
    136                   <font face="Verdana" size="4">
    137                   <strong>
    138 <a href="#QA">Problems and solutions</a>
    139                   </strong>
    140                   </a>
    141                   </font>
    142                 </td>
    143               </tr>
    144               <tr>
    145                 <td>
    146                   &nbsp;
    147                 </td>
    148                 <td colspan="2">
    149                   <font face="Verdana" size="4">
    150 "I attempt to change the name of a file but nothing happens? or I can't drag'n'drop files in the workspace tree?"
     129Special folder mapping
    151130                  </font>
    152131                  </a>
     
    169148      <font size="3">
    170149<p style="text-align:justify">
    171 The Librarian Interface starts with the Gather view. If, later, you need to return to this view, notice the tabs (like file-cabinet tabs) directly below the menu bar. Clicking a tab opens the view with that name. To open the Gather view, click on the tab labelled Gather.
    172 </p>
    173 <p style="text-align:justify">
    174 There are two large areas titled 'Workspace' and 'Collection'. These are used to move files into and out of your collection. They contain 'file trees', which are graphical structures that represent directories (shown with folder icons) and the files they contain.
    175 </p>
    176 <p style="text-align:justify">
    177 Select any item in the tree by clicking on it once. (There are more ways; see below.) Double-clicking a directory node whose children (files and directories) are not shown expands that directory by making its children visible. Double clicking an expanded directory node collapses it again. You can also expand and collapse directories by clicking on the little switch symbol that precedes the folder name. If you double-click on a file the Librarian Interface will attempt to open it in whatever program is best suited to view it. If you press [F2] (Function Key 2) while a file or directory is selected (or if you did not double-click quickly enough), a black box will appear around the selected item, with a flashing cursor. This visual prompt indicates that you can now edit the name of the selected item. (As explained below, you can only do this if the item is not read-only). When you have finished editing, press [Enter], or click anywhere else on the program screen, to leave edit mode. The areas containing the trees are also scrollable as explained earlier.
    178 </p>
    179 <p style="text-align:justify">
    180 There are two different file trees; the Workspace and the Collection. The Workspace contains the sources of data that are available to the Librarian Interface. These include: the complete local file system (including all disk and CD-ROM drives), the contents of existing Greenstone collections, the public download space if Web mirroring is enabled, and the private download space, again only if mirroring is enabled. The files in this tree are read-only: you can copy and view them but you cannot move, delete, or edit them. Navigate around this tree until you find the files you want to include in your collection. The Collection represents the contents of your collection so far, and can be fully edited except the very top folder (which can never be deleted). Initially, it will be empty. This tree is shared with the MetaEdit view described later in this document.
    181 </p>
    182 <p style="text-align:justify">
    183 If you move the mouse pointer over the small vertical grey bar that separates the two trees, the shape of the pointer changes, and you can alter the two spaces by pressing and dragging the mouse, widening one while shrinking the other.
    184 </p>
    185 <p style="text-align:justify">
    186 At the bottom are the Status Area and the Control Buttons. The Status Area tells you about the state of the Librarian Interface: how many items you have selected and what action you are requesting. When you start performing actions that involve files it reports on the progress of the operation. Actions involving large files can take some time to complete, but you needn't wait. While one action is being performed you can initiate others, and they will just wait until the current action is complete. This feature allows you to perform other actions, or visit other views, without having to wait for the current action to finish.
    187 </p>
    188 <p style="text-align:justify">
    189 The three large Control Buttons occupy the lower right corner of the screen. The first is the Cancel Action button, which is used to immediately cancel any file movement tasks that are occurring or pending. The next is the New Folder button, which is used to create new folders: it shows a picture of a folder (see Creating folders). The last is the Delete button, which is used to remove files; it shows a garbage can.
     150The Librarian Interface starts with the Gather view.  To return to this view later, click the "Gather" tab directly below the menu bar.
     151</p>
     152<p style="text-align:justify">
     153The two large areas titled "Workspace" and "Collection" are used to move files into your collection.  They contain "file trees", graphical structures that represent files and folders.
     154</p>
     155<p style="text-align:justify">
     156Select an item in the tree by clicking it.  (There are other ways; see below.) Double-click a folder, or the switch symbol beside it, to expand (or collapse) its contents.  Double-click a file to open it using its associated application program (see Section 10.2 -- File Associations).
     157</p>
     158<p style="text-align:justify">
     159The Workspace file tree shows the sources of data available to the Librarian Interface -- the local file system (including disk and CD-ROM drives), the contents of existing Greenstone collections, and the public and private download caches if Web mirroring is enabled.  You can copy and view these files but you cannot move, delete, or edit them.  Navigate this space to find the files you want to include in the collection.
     160</p>
     161<p style="text-align:justify">
     162The Collection file tree represents the contents of the collection so far.  Initially, it is empty.
     163</p>
     164<p style="text-align:justify">
     165You can resize the spaces by mousing over the grey bar that separates the trees (the shape of the pointer changes) and dragging.
     166</p>
     167<p style="text-align:justify">
     168Beneath is the Status Area, which describes the state of the Librarian Interface: how many items are selected and what action is requested.  It reports on the progress of actions that involve files, which can take some time to complete.
     169</p>
     170<p style="text-align:justify">
     171Three large buttons occupy the lower right corner of the screen.  "Cancel" stops any file movement tasks that are occurring.  "New Folder", with a picture of a folder, creates new folders (see Section 5.2 -- Creating folders). "Delete", with a garbage can, removes files.
    190172</p>
    191173
     
    194176    </td>
    195177  </tr>
    196   <tr bgcolor="#E0F0E0">
    197     <td colspan="3" width="100%">
    198       <img height="20" src="gatherer_small.gif" width="20">
    199       <font face="Verdana" size="4">
    200       <u>
    201 <a name="AI">Advanced Instructions:</a>
    202       </u>
    203       <font size="3">
    204 <p style="text-align:justify">
    205 There are more powerful techniques for file selection. To select several contiguous items, select the one at the start of the range and then hold down a [Shift] key while clicking on the one at the end of the range -- the selection will encompass all intervening items. You can select non-sequential files by holding down the [Ctrl] key while clicking on the target item. These two methods, which are common to all Microsoft Windows applications, can be used in combination to select groups of non-adjacent items.
    206 </p>
    207 <p style="text-align:justify">
    208 There are sometimes folders in your filespace that have special significance such as the root folder of your home web pages, or perhaps a 'drop-box' used as the destination folder for resources from other programs. To provide move convenient access to these directories, which may otherwise appear deep within the workspace tree, you may crate a special 'mapping' to such a folder, causing it to appear at the first level of the tree. For instance the 'Greenstone Collections' folder is simply a special mapping to the greenstone collections folder. To create a mapping, expand the workspace tree so that the special folder is visible, then right button mouse click over the folder. A menu should appear with the option the 'map' the folder. If you choose this option a prompt will appear asking you for a meaningful alias for this folder. Providing a name and clicking OK will create the new special folder mapping at the top level of the tree. Now you access the files in the special folder via this aliased shortcut, or by expanding the tree as before. To remove a special mapping you once again right click over the mapped folder. The option to remove the mapped folder is available. Note that no confirmation is asked for when removing the mapping.
    209 </p>
    210 
    211       </font>
    212       </p>
    213     </td>
    214   </tr>
    215   <tr bgcolor="#E0F0E0">
    216     <td colspan="3" width="100%">
    217       <img height="20" src="gatherer_small.gif" width="20">
    218       <font face="Verdana" size="4">
    219       <u>
    220 <a name="QA">Problems And Solutions:</a>
    221       </u>
    222       <font size="3">
    223       <i>
    224 <p style="text-align:justify">
    225 "Nothing happens when I try to change the name of a file?" or "I can't drag'n'drop files in the workspace tree?"
    226 </p>
    227 
    228       </i>
    229 <p style="text-align:justify">
    230 Files and directories in the Workspace tree are read-only and the Librarian Interface cannot change them. This protects other people's collections, and also your own files. The topmost directory of the Collection tree, which has your collection name as a title, is also read-only. If you try to edit these, nothing will happen.
    231 </p>
    232 
    233       </font>
    234     </td>
    235   </tr>
    236178</table>
    237179&nbsp;<br>
  • trunk/gli/help/5-2.htm

    r4293 r5284  
    2525      <font face="Verdana" size="3">
    2626<p style="text-align:justify">
    27 This section shows how to create new folders, and introduces the right-button-click menu.
     27This section shows how to create new folders.
    2828</p>
    2929
     
    7878                </td>
    7979              </tr>
    80               <tr>
    81                 <td colspan="3">
    82                   <font face="Verdana" size="4">
    83                   <strong>
    84 <a href="#AI">Advanced instructions</a>
    85                   </strong>
    86                   </a>
    87                   </font>
    88                 </td>
    89               </tr>
    90               <tr>
    91                 <td>
    92                   &nbsp;
    93                 </td>
    94                 <td colspan="2">
    95                   <font face="Verdana" size="4">
    96 Multiple folders
    97                   </font>
    98                   </a>
    99                 </td>
    100               </tr>
    101               <tr>
    102                 <td colspan="3">
    103                   <font face="Verdana" size="4">
    104                   <strong>
    105 <a href="#QA">Problems and solutions</a>
    106                   </strong>
    107                   </a>
    108                   </font>
    109                 </td>
    110               </tr>
    111               <tr>
    112                 <td>
    113                   &nbsp;
    114                 </td>
    115                 <td colspan="2">
    116                   <font face="Verdana" size="4">
    117 "No matter how I try I can't create a new folder?"
    118                   </font>
    119                   </a>
    120                 </td>
    121               </tr>
    12280            </font>
    12381            </table>
     
    13694      <font size="3">
    13795<p style="text-align:justify">
    138 A 'folder' in Microsoft Windows is the same as a directory, and directories are indicated by the folder icon. When the Librarian Interface creates a folder it is actually creating a directory. However, we continue to use the more familiar term 'folder'. Folders are used in the tree to group files together, and to introduce structure that makes it easier to find files. Folders can be placed inside folders. There is virtually no limit to how many folders you can have or how deeply they can be nested.
     96Use folders in the Workspace file tree to group files together and make them easier to find.  Folders can be placed inside folders. There is virtually no limit to how many folders you can have or how deeply they can be nested.
    13997</p>
    14098<p style="text-align:justify">
    141 To create a folder, select a non-read-only folder from either tree and click the New Folder button. A folder called 'New Folder' appears within the selected one. [Renaming files using Java is problematic, so for the time being it is disabled. If you rename this folder using some other method, the new name will be visible the next time the tree is refreshed; when it parent folder is collapsed and expanded, or when the collection is reloaded].
     99To create a new folder, optionally select an existing folder in the Collection Tree and click the New Folder button.  The new folder appears within the selected one, or at the top level if none is selected.  You are prompted for the folder's name (default "New Folder").
    142100</p>
    143101<p style="text-align:justify">
    144 Folders can be created more conveniently using the right-click menu. Move the mouse pointer over the parent folder and click the right mouse button. A menu, just like those in the menu bar, appears below the mouse pointer. It may have just one item, or several of them, depending on what item you clicked it over. Choose the New Folder item to create a new child folder exactly as above.
     102Folders can also be created by right-clicking over a folder, choosing "New Folder" and proceeding as above.
    145103</p>
    146104
    147105      </font>
    148106      </p>
    149     </td>
    150   </tr>
    151   <tr bgcolor="#E0F0E0">
    152     <td colspan="3" width="100%">
    153       <img height="20" src="gatherer_small.gif" width="20">
    154       <font face="Verdana" size="4">
    155       <u>
    156 <a name="AI">Advanced Instructions:</a>
    157       </u>
    158       <font size="3">
    159 <p style="text-align:justify">
    160 You can create several folders, one after another, without having to rename them in between. They will be given names New Folder 001, New Folder 002, and so on.
    161 </p>
    162 
    163       </font>
    164       </p>
    165     </td>
    166   </tr>
    167   <tr bgcolor="#E0F0E0">
    168     <td colspan="3" width="100%">
    169       <img height="20" src="gatherer_small.gif" width="20">
    170       <font face="Verdana" size="4">
    171       <u>
    172 <a name="QA">Problems And Solutions:</a>
    173       </u>
    174       <font size="3">
    175       <i>
    176 <p style="text-align:justify">
    177 "No matter how I try I can't create a new folder."
    178 </p>
    179 
    180       </i>
    181 <p style="text-align:justify">
    182 If a folder is read-only, the Librarian Interface cannot change its contents. You are probably trying to create a folder where you're not able to.
    183 </p>
    184 
    185       </font>
    186107    </td>
    187108  </tr>
  • trunk/gli/help/5-3.htm

    r4293 r5284  
    9999                </td>
    100100              </tr>
    101               <tr>
    102                 <td colspan="3">
    103                   <font face="Verdana" size="4">
    104                   <strong>
    105 <a href="#QA">Problems and solutions</a>
    106                   </strong>
    107                   </a>
    108                   </font>
    109                 </td>
    110               </tr>
    111               <tr>
    112                 <td>
    113                   &nbsp;
    114                 </td>
    115                 <td colspan="2">
    116                   <font face="Verdana" size="4">
    117 "I drag a file, but when I drop it nothing happens?"
    118                   </font>
    119                   </a>
    120                 </td>
    121               </tr>
    122101            </font>
    123102            </table>
     
    136115      <font size="3">
    137116<p style="text-align:justify">
    138 Files can be copied into the collection using the drag-and-drop method introduced earlier. After selecting one or more files and directories, you initiate a drag action by clicking and holding over any selected item. The mouse pointer changes into a ghost of the item (if just one was selected) or the number of selected items (if more than one was selected). The Status Area changes to reflect the beginning of a drag.
     117Files can be copied into the collection by dragging and dropping.  The mouse pointer becomes a ghost of the selected item (or, if more than one is selected, the number of them).  Drop the selection into the Collection Tree to copy the files there (if the source was the Workspace Tree) or move them around within the collection (if the source was the Collection Tree).
    139118</p>
    140119<p style="text-align:justify">
    141 Keeping the mouse button pressed, move the mouse around the screen. Areas that become highlighted when you move over them are valid drop targets, places where you can drop the selected items. If you drop items into a tree, they are copied from their origin into the place where you dropped them.
     120When copying multiple files, they are all placed in the target folder at the same level, irrespective of the folder structure they occupied originally. When you copy a second file with the same name into the same folder, you are asked whether to overwrite the first one.  Respond "No" and the file will not be copied, but the others will be.  To cancel all remaining copy actions, click the "stop" button.
    142121</p>
    143122<p style="text-align:justify">
    144 To copy files into your collection, select them from the Workspace (???) and drag them into a folder within your collection. You can copy directories as well. You can also copy files about within the same tree if you wish. If you drag files from an existing collection which contains metadata information for them, the metadata will be automatically imported along with the files. (See Adding Metadata for a detailed explanation of metadata and its use in the Librarian Interface.)
    145 </p>
    146 <p style="text-align:justify">
    147 Some extra rules apply when copying multiple files. No matter what directory structure the files occupied before you copied them, they are all placed in the target folder at the same level. If you try to copy two files with the same name into the same folder, the Librarian Interface will ask whether you want to overwrite the first one. If you say No, the file in question will not be copied, but the other files will. If instead you wish to cancel all remaining copy actions click the stop button as described in the 'Gather' View.
    148 </p>
    149 <p style="text-align:justify">
    150 Another rule is that only the 'highest' items in a selection will be moved. A folder is higher than its children, which are higher than their own children, and so on. If you choose several files within a folder and the folder itself, the folder will be copied in its entirety and your selections within it will be ignored.
     123Only the "highest" items in a selection are moved.  A folder is higher than its children.  You cannot select files within a folder and also the folder itself.
    151124</p>
    152125
     
    164137      <font size="3">
    165138<p style="text-align:justify">
    166 When you add a file, the Librarian Interface also performs a further task. It searches through the source directories for auxiliary files which contain metadata previously assigned to the target file, and if found begins a process of importing this metadata. As this operation proceeds, you may be prompted several times to provide extra information to enable the Librarian Interface to correctly match the imported metadata to metadata you may have already added to your collection. This process involves many different prompts, which are described in the section titled Importing Previously Assigned Metadata.
     139When you add a file, the Librarian Interface searches through the source folders for auxiliary files containing metadata previously assigned to the added file and, if it finds one, begins to import this metadata.  As the operation proceeds, you may be prompted (perhaps several times) for extra information to match the imported metadata to the metadata sets in your collection.  This process involves many different prompts, described in the section 6.8 -- Importing Previously Assigned Metadata.  For a more detailed explanation of associating metadata with files read Chapter 2 of the Greenstone Developer's Guide -- Getting the most out of your documents.
    167140</p>
    168141
    169142      </font>
    170143      </p>
    171     </td>
    172   </tr>
    173   <tr bgcolor="#E0F0E0">
    174     <td colspan="3" width="100%">
    175       <img height="20" src="gatherer_small.gif" width="20">
    176       <font face="Verdana" size="4">
    177       <u>
    178 <a name="QA">Problems And Solutions:</a>
    179       </u>
    180       <font size="3">
    181       <i>
    182 <p style="text-align:justify">
    183 "I drag a file, but when I drop it nothing happens."
    184 </p>
    185 
    186       </i>
    187 <p style="text-align:justify">
    188 In principle, only valid drop targets are highlighted, so most drops should succeed. However, successful drops must meet several conditions: they must be dropped on a valid target; they must be dropped into some other place than where the drag started; they must be dropped into a folder, not a file; and the target must not be read-only.
    189 </p>
    190 
    191       </font>
    192144    </td>
    193145  </tr>
  • trunk/gli/help/5-4.htm

    r4293 r5284  
    2525      <font face="Verdana" size="3">
    2626<p style="text-align:justify">
    27 This section shows how to remove files and folders from your collection.
     27This section describes how to remove files and folders from your collection.
    2828</p>
    2929
     
    8989                </td>
    9090              </tr>
    91               <tr>
    92                 <td colspan="3">
    93                   <font face="Verdana" size="4">
    94                   <strong>
    95 <a href="#QA">Problems and solutions</a>
    96                   </strong>
    97                   </a>
    98                   </font>
    99                 </td>
    100               </tr>
    101               <tr>
    102                 <td>
    103                   &nbsp;
    104                 </td>
    105                 <td colspan="2">
    106                   <font face="Verdana" size="4">
    107 "Why can't I remove a certain selected item?"
    108                   </font>
    109                   </a>
    110                 </td>
    111               </tr>
    11291            </font>
    11392            </table>
     
    126105      <font size="3">
    127106<p style="text-align:justify">
    128 The files in your collection are copies of the original files, so you can remove them without fear of deleting the only copy. There are several methods for removing files and folders.
     107There are several methods for removing files and folders.  You must first indicate what items to remove by selecting one or more files and folders as described in section 5.1 -- The Gather View.
    129108</p>
    130109<p style="text-align:justify">
    131 In general, all remove actions require you to first select the items to remove. You may select one or more files and directories using the techniques outlined here.
    132 </p>
    133 <p style="text-align:justify">
    134 Once some files have been selected, click once on the Delete Button in the Control Button area. This immediately removes the selected items.
    135 </p>
    136 <p style="text-align:justify">
    137 Another method is to make your selection and then press the [Delete] key on your keyboard to remove the files.
    138 </p>
    139 <p style="text-align:justify">
    140 The final way to remove files uses the same drag and drop method you used to copy the files, except this time you drag from your collection down to the Delete Button. The button responds by becoming highlit, indicating that it is a valid drop target. Drop the selected items here and they will be removed from your collection.
     110Once files have been selected, click the "delete" button to remove them, or press the [Delete] key on your keyboard, or drag them from the collection to the delete button and drop them there.
    141111</p>
    142112
    143113      </font>
    144114      </p>
    145     </td>
    146   </tr>
    147   <tr bgcolor="#E0F0E0">
    148     <td colspan="3" width="100%">
    149       <img height="20" src="gatherer_small.gif" width="20">
    150       <font face="Verdana" size="4">
    151       <u>
    152 <a name="QA">Problems And Solutions:</a>
    153       </u>
    154       <font size="3">
    155       <i>
    156 <p style="text-align:justify">
    157 "Why can't I remove a certain item?"
    158 </p>
    159 
    160       </i>
    161 <p style="text-align:justify">
    162 If you can't remove a file, then most likely you are not meant to because it is read-only.
    163 </p>
    164 
    165       </font>
    166115    </td>
    167116  </tr>
  • trunk/gli/help/5-5.htm

    r4293 r5284  
    2525      <font face="Verdana" size="3">
    2626<p style="text-align:justify">
    27 In order to allow you to narrow down your search for particular files, we introduce the concept of filtering the trees.
     27"Filtering" the collection tree allows you to narrow down the search for particular files.
    2828</p>
    2929
     
    104104      <font size="3">
    105105<p style="text-align:justify">
    106 There is a ComboBox control at the bottom of the trees; it says 'All Files'. If you select the down arrow button at the end of the box, you will see a list of predefined filters, such as: 'Images' or 'Text Files'. Choosing one of these temporarily hides all files within the tree that do not match the chosen filter. To restore the tree to its original state, restore the filter to 'All Files'. Note that filtering does not change what files are in your collection, nor does it affect the folders within the tree.
    107 </p>
    108 <p style="text-align:justify">
    109 The workspace tree filter stands alone. However, the collection trees here and on the Enrich view share the same filter.
     106The "All Files" pull-down menu underneath each tree shows a list of predefined filters, such as "Images".  Choosing this temporarily hides all other files in the tree.  To restore the tree, change the filter back to "All Files".  These operations do not alter the collection, nor do they affect the folders in the tree.
    110107</p>
    111108
     
    123120      <font size="3">
    124121<p style="text-align:justify">
    125 The filter control ComboBox is editable. You can specify a custom filter by typing in a pattern against which files will be matched. This pattern may be a regular expression, or use standard file system abbreviations such as *.* or *.doc.
     122You can specify a custom filter by typing in a pattern to match files against. Use standard file system abbreviations such as "*.*" or "*.doc" ("*" matches any characters).
    126123</p>
    127124
  • trunk/gli/help/6-0.htm

    r4293 r5284  
    1313      <font face="Verdana" size="5">
    1414      <strong>
    15 6.0 Enriching Your Collection with Metadata
     156.0 Enriching the Collection with Metadata
    1616      </strong>
    1717      </font>
     
    2525      <font face="Verdana" size="3">
    2626<p style="text-align:justify">
    27 Now that you have gathered several files into your collection it is time to enrich them with additional information. This process is also known as marking-up or assigning metadata. This chapter explains how to do this, how metadata is created, edited, remembered and retrieved within the Librarian Interface, and how to use external sources of metadata (such as the hand-edited metadata.xml files that Greenstone can use).
     27Having gathered several files into the collection, now enrich them with additional information called "metadata".  This chapter explains how metadata is created, edited, assigned and retrieved, and how to use external metadata sources (see Chapter 2 of the Greenstone Developer's Guide -- Getting the most out of your documents).
    2828</p>
    2929
  • trunk/gli/help/6-1.htm

    r4293 r5284  
    7373                <td colspan="2">
    7474                  <font face="Verdana" size="4">
    75 The metaedit controls
     75The MetaEdit Controls
    7676                  </font>
    7777                  </a>
     
    100100                </td>
    101101              </tr>
    102               <tr>
    103                 <td colspan="3">
    104                   <font face="Verdana" size="4">
    105                   <strong>
    106 <a href="#QA">Problems and solutions</a>
    107                   </strong>
    108                   </a>
    109                   </font>
    110                 </td>
    111               </tr>
    112               <tr>
    113                 <td>
    114                   &nbsp;
    115                 </td>
    116                 <td colspan="2">
    117                   <font face="Verdana" size="4">
    118 "How can I quickly see all the metadata I've assigned in this collection?"
    119                   </font>
    120                   </a>
    121                 </td>
    122               </tr>
    123               <tr>
    124                 <td>
    125                   &nbsp;
    126                 </td>
    127                 <td colspan="2">
    128                   <font face="Verdana" size="4">
    129 "How can I make the metadata table larger?"
    130                   </font>
    131                   </a>
    132                 </td>
    133               </tr>
    134102            </font>
    135103            </table>
     
    148116      <font size="3">
    149117<p style="text-align:justify">
    150 The Enrich view is where you assign metadata to the documents in your collection. Metadata is data about data -- typically information such as title, author, creation date, and so on. Each metadata item has two parts: 'element' and 'value'. The element tells what kind of item it is (such as author or subject); the value gives the value of that metadata element (such as the name of the author or of the subject).
     118Use the Enrich view to assign metadata to the documents in the collection. Metadata is data about data -- typically title, author, creation date, and so on.  Each metadata item has two parts: "element" tells what kind of item it is (such as author), and "value" gives the value of that metadata element (such as the author's name).
    151119</p>
    152120<p style="text-align:justify">
    153 On the left of the Enrich view is the Collection file tree. This is the same as the Collection file tree in the Gather view. It can be expanded, collapsed, scrolled and filtered, just as before. In fact, the same filter is shared between the Gather and Enrich Collection trees, so filtering one applies the same filter to the other. However, you cannot edit the tree. When you select files their details appear on the right.
     121On the left of the "Enrich" view is the Collection Tree.  When you select files their details appear in the Metadata Table on the right.
    154122</p>
    155123<p style="text-align:justify">
    156 The Metadata Table is a spreadsheet-like table that occupies the upper right of the screen. It can show all metadata assigned for the selected files, or just the unassigned elements, or both assigned and unassigned metadata. These views are obtained by toggling the two appropriately named buttons directly underneath the table. Names of the columns are shown in grey labels at the top. You can resize columns by selecting and dragging the lines separating their names. Clicking any row of the table transfers its details to the MetaEdit Controls, as explained below, and the Remove button becomes active. If several files are selected in the tree, some of the tables' rows will be greyed out. If you click on one of these rows, only the Append and Remove edit controls become active. That is because this row's metadata is not common to all the selected files. A row which retains its normal black text colour shows metadata that is common to all selected files, and enables the use of the Update edit control when clicked. Having selected a file, you may find magnifying glass icons alongside some of the metadata entries. This indicates metadata that is inherited from one of this files parent folders. Such inherited metadata cannot be edited or removed, only appended to or overwritten. Click on the magnifying glass to be taken directly to the folder where the metadata is assigned, where you are free to update or remove it.
     124The Metadata Table appears the upper right of the screen when files are selected and shows all metadata for the selected files.  Columns are named in grey at the top, and can be resized by dragging the separating line.  Clicking any row transfers its details to the MetaEdit Controls below.  If several files are selected, black text indicates that the value is common to all of the selected files, while grey text indicates that it is not.  Black values may be updated or removed, while grey ones can be removed from those that have it, or appended to the others.
    157125</p>
    158126<p style="text-align:justify">
    159 On the lower right are the MetaEdit Controls. They remain hidden until you select a file; when they appear you use them to assign, update and remove metadata associated with the selected file. At the top is a grey ComboBox that shows the label elements. You cannot type new elements directly into it because the text area is disabled. However, the triangular arrow button drops down a scrollable list of available elements. If you choose one, the large white area immediately below the ComboBox will change. This area, including the text field below it, is called the Value Tree and is described shortly. Finally, the six buttons along the bottom only become active when their actions make sense. [S]earch and Restore [T]ree are used to search for particular metadata values. The [E]dit Text... button causes a large text editing dialog to appear, for multi-line metadata values. [A]ppend is used to append a new metadata value to the ones assigned to a file and is used when a file is selected and you have selected an element and entered a value. [U]pdate is used when a row in the metadata table is selected; it updates that metadata with whatever value has been entered for it. [R]emove removes a metadata value and is only active when a metadata row is selected.
     127A folder icon may appear beside some metadata entries.  This indicates that the values are inherited from a parent (or ancestor) folder.  Inherited metadata cannot be edited or removed, only appended to or overwritten.  Click on the folder icon to go immediately to the folder where the metadata is assigned.
    160128</p>
    161129<p style="text-align:justify">
    162 The Value Tree is a scrollable tree which expands and collapses just as you expect. Usually this tree acts as a list, showing all previous values that have been entered for the selected element. Clicking an entry in the Value Tree automatically enters it into the text field labelled Value. Conversely, typing in the text field auto-selects the Value Tree entry that starts with the characters you have typed. Pressing [Enter] auto-completes the typing with the selected value.
     130The MetaEdit Controls at the lower right appear only when a file is selected from the tree and a row is selected from the table.  Use them to update, append, and remove the metadata value.  The value field is for entering or editing the metadata value.  Beside it is a button labelled "..." which, when clicked, opens a larger editing box.  In the buttons below, "Append" assigns the value as new metadata and adds it to any existing values for the selected element, "Replace" overwrites any existing value(s) with the new one, and "Remove clears any existing values.  Underneath, labelled "All Previous Values", is the "Value Tree".
    163131</p>
    164132<p style="text-align:justify">
    165 Unlike an ordinary list, the Value Tree can also show hierarchical structures -- like a subject hierarchy. Values can be grouped into subjects, and subjects and values can be further grouped. Note that a 'subject' is a value as well, and can be assigned as part of a metadata item or used to expedite access to large collections of values. You can figure out the 'path' to a certain value by tracing from the highest level down to the value in question. This path can be typed into the text field using the character '\' to separate the various levels. For example, in a hierarchy that represents pack of playing cards hierarchy you might type "Red\Diamonds\Jack" or "Black\Clubs\Seven".
     133The Value Tree expands and collapses.  Usually it is a list that shows all values entered previously for the selected element.  Clicking an entry automatically places it into the value field.  Conversely, typing in the text field selects the Value Tree entry that starts with the characters you have typed.  Pressing [Enter] auto-completes the typing with the selected value.
    166134</p>
    167135<p style="text-align:justify">
    168 If you know the value you seek is unique, just type the value name. The Value Tree will find and select the first item that matches. When you press [Enter], the full hierarchical path appears in the text field.
     136The Value Tree also shows hierarchical structures.  Values can be grouped together, and a group can be assigned as a metadata value.  Each value has a "path" obtained by tracing down to it from the tree root, and the path can be typed into the text field using the character "\" to separate the levels.  For example, in a hierarchy that represents a pack of playing cards you might type "Cards\Red\Diamonds\Seven".
    169137</p>
    170138<p style="text-align:justify">
    171 The [S]earch button beneath the Value Tree reduces the tree by showing only entries that contain a target text fragment. First type the desired text fragment into the value field, then press search. Press the Restore [T]ree button to return the Value Tree to its initial state.
     139Greenstone extracts metadata automatically from documents into a metadata set whose elements are prefixed by "ex.".  This has no value tree and cannot be edited, so the edit controls are hidden if such an entry is selected.  The "..." button still serves to expand the value, but the text cannot be edited.
    172140</p>
    173141
    174142      </font>
    175143      </p>
    176     </td>
    177   </tr>
    178   <tr bgcolor="#E0F0E0">
    179     <td colspan="3" width="100%">
    180       <img height="20" src="gatherer_small.gif" width="20">
    181       <font face="Verdana" size="4">
    182       <u>
    183 <a name="QA">Problems And Solutions:</a>
    184       </u>
    185       <font size="3">
    186       <i>
    187 <p style="text-align:justify">
    188 "How can I quickly review all metadata I've assigned to this collection?"
    189 </p>
    190 
    191       </i>
    192 <p style="text-align:justify">
    193 The easiest way is to use the All Metadata View as discussed later under 'Reviewing All Metadata'.
    194 </p>
    195 
    196       <i>
    197 <p style="text-align:justify">
    198 "How can I make the metadata table larger?"
    199 </p>
    200 
    201       </i>
    202 <p style="text-align:justify">
    203 Between the MetaEdit Controls and the Metadata Table is a movable divider that you can use to make the Controls smaller so that you can see more of the Value Tree.
    204 </p>
    205 
    206       </font>
    207144    </td>
    208145  </tr>
  • trunk/gli/help/6-2.htm

    r4293 r5284  
    126126      <font size="3">
    127127<p style="text-align:justify">
    128 Sets of predefined elements known as 'metadata sets' can be loaded from the Librarian Interface's directory. An example is the Dublin Core metadata set. When you add a metadata set to your collection, its elements become available for selection. You can have more than one set; to prevent name clashes a short identifier that identifies the metadata set is prepended to the element name. For instance the Dublin Core element Creator becomes dc_Creator.
     128Sets of predefined metadata elements are known as "metadata sets".  An example is the Dublin Core metadata set.  When you add a metadata set to your collection, its elements become available for selection.  You can have more than one set; to prevent name clashes a short identifier that identifies the metadata set is pre-pended to the element name.  For instance the Dublin Core element Creator becomes "dc.Creator".  Metadata sets are stored in the Librarian Interface's folder and have the suffix ".mds".
    129129</p>
    130130<p style="text-align:justify">
    131 To add a metadata set, open the [M]etadata menu from the menu bar and select the [A]dd Metadata Set action. You will be presented with an Open File Prompt (just like the Open Collection Prompt discussed earlier) that shows the contents of the Librarian Interface's metadata directory. Choose an '.mds' or metadata set file and open it. Next you will be prompted as to whether you wish to import all of the values associated with the elements in this set, just those values that make up the structure of hierarchy-based metadata, or no values at all. When you return to the Enrich view the element ComboBox will now show the appropriate entries.
     131To add a metadata set, choose "Metadata Sets" from the menu bar and select the "Import Set" action.  A list appears that shows the sets stored in the Librarian Interface's metadata folder.  Choose one and open it, or click "Browse" to locate metadata set files stored elsewhere.  You may be asked whether to import all values associated with the elements in the set, just those values that make up the structure of hierarchy-based metadata, or no values at all.
    132132</p>
    133133
     
    145145      <font size="3">
    146146<p style="text-align:justify">
    147 To install a newer version of a metadata set, simply add it as above. The Librarian Interface uses some simple strategies for merging the two sets, and will not lose track of values you have entered. You may however be prompted as to how to merge certain elements. For example if a currently available set and the set you are importing have an element of the same name (which is most likely if you are installing a new version of a set), you will be presented with a prompt showing as much information about the existing and new elements as possible, and providing you with several options on how to proceed with the merging. These options include merging the two elements, renaming the new element so there is no longer a clash, replacing the old element entirely, or not adding this element by skipping it. Merging the elements provides basically the same options, but at an element attributes level. You may of course choose to cancel the metadata set import at any time.
     147To install a newer version of a metadata set, simply add it as above.  The Librarian Interface merges the sets, but does not alter values you have entered.  You may be asked how to merge certain elements.  For example if the current set and the one you are importing share a common element (which is likely if you are installing a new version of a set), you are shown as much information about the existing and new elements as possible, and asked how to proceed.  Options include merging the elements, renaming the new one, replacing the old element entirely, or skipping this element.  When merging two elements you are confronted with the same options, but this time at the "attributes" (rather than "elements") level.  You can cancel the import operation at any time.
    148148</p>
    149149<p style="text-align:justify">
    150 The ".mds" files themselves are expressed in XML format. To edit an existing metadata set, or to create a brand new one, you can use an ordinary text editor. If you are starting a new file, copy the Document Type Definition (the text within the tag) to the top of your new file and ensure that you follow it, otherwise the Librarian Interface will be unable to load your metadata set. Use of an XML validator or validating editor is recommended.
     150The ".mds" files are expressed in XML format.  You can edit an existing metadata set or create a new one with an ordinary text editor.  If you are starting a new file, copy the Document Type Definition and be sure to follow it, otherwise the Librarian Interface will be unable to load the metadata set.  Use of an XML validator or validating editor is recommended.
    151151</p>
    152152<p style="text-align:justify">
    153 If you know XML, the text itself will look familiar. It comprises a series of tags between '<' and '>' symbols. Each opening tag is closed by a correspondingly-named closing tag, which contains the same name preceded by '/'. For example, <Element>...</Element>.
    154 </p>
    155 <p style="text-align:justify">
    156 Any time you want to export a metadata set, or part of a metadata set (e.g. its assigned value hierarchy, or all its values), return to the Librarian Interface and choose [E]xport Metadata Set from the [M]etadata menu. A prompt will ask you to select appropriate export options, and a file to export into.
     153To export a metadata set, or part of one (e.g.  its assigned value hierarchy, or all its values), return to the Librarian Interface and choose "Export Set" from the "Metadata Set" menu.  You will be asked to select appropriate export options, and a file to export into.
    157154</p>
    158155
  • trunk/gli/help/6-3.htm

    r4293 r5284  
    7373                <td colspan="2">
    7474                  <font face="Verdana" size="4">
    75 Adding to directories or multiple files
     75Adding to folders or multiple files
    7676                  </font>
    7777                  </a>
     
    153153                  <font face="Verdana" size="4">
    154154                  <strong>
    155 <a href="#QA">Problems and solutions</a>
     155<a href="#AI">Advanced instructions</a>
    156156                  </strong>
    157157                  </a>
     
    165165                <td colspan="2">
    166166                  <font face="Verdana" size="4">
    167 "How do I fix a value that has ended up in the wrong subject?"
    168                   </font>
    169                   </a>
    170                 </td>
    171               </tr>
    172               <tr>
    173                 <td>
    174                   &nbsp;
    175                 </td>
    176                 <td colspan="2">
    177                   <font face="Verdana" size="4">
    178 "What if I have a value and a subject with the same name?"
     167Value hierarchies and editing values
    179168                  </font>
    180169                  </a>
     
    197186      <font size="3">
    198187<p style="text-align:justify">
    199 We now add a metadata item -- both element and value -- to a file. First select the file from the Collection file tree on the left. Notice that the Select action causes some changes to the right of the view. If this is the first file selected, the MetaEdit Controls will appear in the upper right, ready for you to start editing. The name of the selected file appears in the text field in the middle on the right. Any metadata previously assigned to this file appears in a table at the bottom right.
    200 </p>
    201 <p style="text-align:justify">
    202 Next, select the metadata element you want to add. Click on the triangle at the right of the 'element' ComboBox and scroll to find the element name you wish to add; then click it. The Value Tree below may change when you change elements -- but probably, right now, it's blank.
    203 </p>
    204 <p style="text-align:justify">
    205 Now focus on the 'value' text field, either by pressing [Tab] several time or by clicking anywhere in the field. When the flashing caret appears in the field, you can type your value. Be careful not to use the character '\', because it is used for constructing hierarchies. When finished, press [Enter] or [Tab], or just click elsewhere on the screen. If you have entered a new value for the first time a pop-up will ask for confirmation of the value. When you confirm by clicking [Y]es, the value is added to the Value Tree, and the [A]dd button is enabled. Click [A]dd to add the new value as metadata for the chosen file. The metadata immediately appears in the Metadata Table. If the file already had a value assigned for that specific metadata element you may be prompted for what action to take. This prompt and the available actions are described below.
    206 </p>
    207 <p style="text-align:justify">
    208 You can also add metadata to a folder, or to several files at once that have been multiply selected.  This adds it to all files within the folder or selection, and to any child directories. However keep in mind that if you assign metadata to a folder that any new files added to that folder will automatically inherit the aforementioned metadata.
    209 </p>
    210 <p style="text-align:justify">
    211 When you add metadata in this way, or if previous metadata exists for the element you have selected, you will be prompted for the action to take on the files it contains. The prompt includes the name of the file in question, the element's title, any previously-assigned values for this element, and the new value that you have entered. The buttons offer different options: '[A]ppend' appends the metadata to the specified file without altering any existing values; 'Append All ([D])' adds the new value in the same way to all child files; '[R]eplace' replaces any previous value with the new one; 'R[E]place All' adds the new value in the same way to all child files; '[S]kip File' skips the current file and proceeds to the next; '[C]ancel' undoes any changes and cancels the action.
    212 </p>
    213 <p style="text-align:justify">
    214 If you choose metadata that is not common to all the selected files, and you press the Add button in the edit controls, the metadata will be added as necessary to make it common to all files in the selection.
     188We now add a metadata item -- both element and value -- to a file.  First select the file from the Collection file tree on the left.  The action causes any metadata previously assigned to this file to appear in the table at the right.
     189</p>
     190<p style="text-align:justify">
     191Next select the metadata element you want to add by clicking its row in the table.
     192</p>
     193<p style="text-align:justify">
     194Type the value into the value field.  Do not use the character "\", as it is used for constructing hierarchies.  When finished, click "Append" to add the new value as metadata for the chosen file.  The value immediately appears in the Metadata table.
     195</p>
     196<p style="text-align:justify">
     197You can also add metadata to a folder, or to several multiply selected files at once.  It is added to all files within the folder or selection, and to child folders.  Keep in mind that if you assign metadata to a folder, any new files in it automatically inherit the folder's values.
     198</p>
     199<p style="text-align:justify">
     200When you add metadata to an element that already has some, you need to decide what to do.  You are shown the name of the file in question, the element's title, previously-assigned values for this element, and the new value.  The buttons offer different options: "Append" appends the metadata to the file without altering any existing values; "Append All" adds the new value to all other files too; "Replace" replaces the previous value; "Replace All" replaces it for all other files too; "Skip File" proceeds to the next file; "Cancel" undoes any changes and cancels the action.
     201</p>
     202<p style="text-align:justify">
     203If you choose metadata that occurs in some of the selected files and click "Append", it is added to the other files in the selection too.
    215204</p>
    216205
     
    228217      <font size="3">
    229218<p style="text-align:justify">
    230 You can add structure to metadata values by using paths. When Greenstone builds certain classifiers, it uses as additional information a hierarchy of possible values. No longer is the classifier a flat list; instead it has a tree structure which can make large collections far easier to navigate. The Librarian Interface automates the process of generating hierarchy files.
    231 </p>
    232 <p style="text-align:justify">
    233 All values you assign in the Librarian Interface can also be subjects. They begin with no subvalues, and so appear flat. However, you can create a value that is a child of another value, and now the parent appears as a folder in the Value Tree. Expanding the folder shows the value contained within. Remember that all subject folders are also values, so you can assign a folder from the Value Tree as the value for a metadata element. For instance, the subject folder might be the default value of some element, while its child values and folders offer increasingly specific metadata values.
    234 </p>
    235 <p style="text-align:justify">
    236 The way to build hierarchies is to specify a path, using '\' as a level separator, when typing into the Value text field of the MetaEdit Control. If you type in a new path, any subject folders that aren't already in the tree will be created. This method can be used to build arbitrarily complex structures.
    237 </p>
    238 <p style="text-align:justify">
    239 Anywhere you can type in a value for the metadata value, you can use a fully-qualified path to specify its position in the hierarchy. However, be warned: a spelling mistake may introduce several new subject folders unintentionally.
     219You can add structure to metadata values by using paths as described in section 6.1 -- The Enrich View.  Correct any mistakes in creating hierarchies by using the metadata set editor explained in Chapter 11.1 -- Editing Metadata Sets.
    240220</p>
    241221
    242222      </font>
    243223      </p>
    244     </td>
    245   </tr>
    246   <tr bgcolor="#E0F0E0">
    247     <td colspan="3" width="100%">
    248       <img height="20" src="gatherer_small.gif" width="20">
    249       <font face="Verdana" size="4">
    250       <u>
    251 <a name="QA">Problems And Solutions:</a>
    252       </u>
    253       <font size="3">
    254       <i>
    255 <p style="text-align:justify">
    256 "A value has ended up in the wrong subject."
    257 </p>
    258 
    259       </i>
    260 <p style="text-align:justify">
    261 The easiest fix is to create the value in the right place and ignore the incorrect one. It won't vanish from the tree, but it won't matter as long as you assign the correctly located value. Alternatively you can use the Metadata Set Editor, explained in chapter 11, to move the value from its current parent subject to the desired one.
    262 </p>
    263 
    264       <i>
    265 <p style="text-align:justify">
    266 "What if I have a value and a subject with the same name?"
    267 </p>
    268 
    269       </i>
    270 <p style="text-align:justify">
    271 At first this seems a problem. What if I wanted a Words subject folder, and then one of the values I wanted to place in it was Words? There are two solutions. First, it is perfectly ok to add "Words\Words". It may look strange but it works -- just make sure you get the right one when adding it as metadata to files. The second, preferred, solution is to use the folder Words when you want to assign the values Words. Remember, all folders are also values!
    272 </p>
    273 
    274       </font>
    275224    </td>
    276225  </tr>
  • trunk/gli/help/6-4.htm

    r4293 r5284  
    2525      <font face="Verdana" size="3">
    2626<p style="text-align:justify">
    27 This section explains how to add metadata that assigns values that already exist in the value tree.
     27This section explains how to add metadata that uses values already present in the value tree.
    2828</p>
    2929
     
    7373                <td colspan="2">
    7474                  <font face="Verdana" size="4">
    75 Adding to directories or multiple files
     75Adding to folders or multiple files
    7676                  </font>
    7777                  </a>
     
    9494      <font size="3">
    9595<p style="text-align:justify">
    96 To add metadata that has an already-existing value, first select the file and then select the required value from the value tree, expanding subject folders as necessary. The value of any selected entry in the tree automatically appears in the Value text field. Alternatively, you can use the auto-select and auto-complete features of the value tree. Click [A]dd to add the metadata to the selected file.
     96To add metadata that has an existing value, first select the file, then select the required value from the value tree, expanding subject folders as necessary.  The value of the selected entry automatically appears in the Value text field (alternatively, use the value tree's auto-select and auto-complete features).  Click "Append" to add the metadata to the selected file.
    9797</p>
    9898<p style="text-align:justify">
    99 The process of adding metadata with already-existing values to directories or multiple files is just the same.
     99The process of adding metadata with already-existing values to folders or multiple files is just the same.
    100100</p>
    101101
  • trunk/gli/help/6-5.htm

    r4293 r5284  
    7373                <td colspan="2">
    7474                  <font face="Verdana" size="4">
    75 Updating directories or multiple files
    76                   </font>
    77                   </a>
    78                 </td>
    79               </tr>
    80               <tr>
    81                 <td colspan="3">
    82                   <font face="Verdana" size="4">
    83                   <strong>
    84 <a href="#QA">Problems and solutions</a>
    85                   </strong>
    86                   </a>
    87                   </font>
    88                 </td>
    89               </tr>
    90               <tr>
    91                 <td>
    92                   &nbsp;
    93                 </td>
    94                 <td colspan="2">
    95                   <font face="Verdana" size="4">
    96 "I've updated a value, why does the old value still appear in the Value Tree?"
     75Updating folders or multiple files
    9776                  </font>
    9877                  </a>
     
    11594      <font size="3">
    11695<p style="text-align:justify">
    117 To update the value of a certain piece of metadata, first choose the file to which that value applies. In the Metadata Table control, find the metadata element whose value you want to change, and select it by clicking anywhere in that row. Your selection appears in the MetaEdit Controls above, and the [U]pdate button is activated. Edit the value in the Value Text field and then click [U]pdate to alter the metadata.
     96To update the value of a piece of metadata, first choose the file to which that value applies, and then the metadata element whose value you want to change. Your selection appears in the metadata edit controls.  Edit the value field and click "Replace" to alter the metadata.
    11897</p>
    11998<p style="text-align:justify">
    120 The process is the same when updating a directory with child folders or multiple files, except that pressing [U]pdate yields a prompt to specify what to do with child files. The buttons offer different options: '[R]eplace' replaces any previous value with the new one; 'R[E]place All' adds the new value in the same way to all child files; '[S]kip File' skips the current file and proceeds to the next; '[C]ancel' undoes any changes and cancels the action. Note that you can only update metadata that is common to all files selected. For a directory this means that all its children must share the same metadata.
     99The process is the same when updating a folder with child folders or multiple files, except that when you click "Replace" you are asked what to do with the other files.  The buttons offer different options: "Replace" replaces any previous value with the new one; "Replace All" adds the new value in the same way to all other files; "Skip File" skips the current file and proceeds to the next; "Cancel" undoes any changes and cancels the action.  You can only update metadata that is common to all files selected.  For a folder, this means that all its contents must share the same metadata.
     100</p>
     101<p style="text-align:justify">
     102The value tree shows all previous values, not just those currently assigned. Thus the value you have replaced will remain in the value tree.
    121103</p>
    122104
    123105      </font>
    124106      </p>
    125     </td>
    126   </tr>
    127   <tr bgcolor="#E0F0E0">
    128     <td colspan="3" width="100%">
    129       <img height="20" src="gatherer_small.gif" width="20">
    130       <font face="Verdana" size="4">
    131       <u>
    132 <a name="QA">Problems And Solutions:</a>
    133       </u>
    134       <font size="3">
    135       <i>
    136 <p style="text-align:justify">
    137 "I've updated a value, why does the old value still appear in the Value Tree?"
    138 </p>
    139 
    140       </i>
    141 <p style="text-align:justify">
    142 This is a feature, not a bug! Even if you remove all references to a value, it doesn't mean you'll never want that value again.
    143 </p>
    144 
    145       </font>
    146107    </td>
    147108  </tr>
  • trunk/gli/help/6-6.htm

    r4293 r5284  
    7373                <td colspan="2">
    7474                  <font face="Verdana" size="4">
    75 Removing from directories or multiple files
     75Removing from folders or multiple files
    7676                  </font>
    7777                  </a>
     
    9999                </td>
    100100              </tr>
    101               <tr>
    102                 <td colspan="3">
    103                   <font face="Verdana" size="4">
    104                   <strong>
    105 <a href="#QA">Problems and solutions</a>
    106                   </strong>
    107                   </a>
    108                   </font>
    109                 </td>
    110               </tr>
    111               <tr>
    112                 <td>
    113                   &nbsp;
    114                 </td>
    115                 <td colspan="2">
    116                   <font face="Verdana" size="4">
    117 "I've removed some metadata, buts its value still appears in the Value Tree?"
    118                   </font>
    119                   </a>
    120                 </td>
    121               </tr>
    122101            </font>
    123102            </table>
     
    136115      <font size="3">
    137116<p style="text-align:justify">
    138 You remove metadata the same way as you update it. First select a file from the file tree, then use the Metadata Table in its Assigned Metadata or All Metadata modes to select the metadata. If the metadata has a value assigned, the [R]emove button in the MetaEdit Controls becomes active. Click it to remove the metadata from the specified file. Other files remain unchanged, and the value still appears in the Value Tree.
     117You remove metadata the same way as you update it.  First select a file from the file tree, then use the metadata table to select the metadata.  If the metadata has a value assigned, the "Remove" button in the MetaEdit Controls becomes active.  Click it to remove the metadata from the specified file.  Other files remain unchanged, and the value remains in the Value Tree.
    139118</p>
    140119<p style="text-align:justify">
    141 If you remove metadata from a directory with children or from multiple files, a prompt presents several options. '[R]emove' removes the metadata from this file; 'Remove [A]ll' removes it from all remaining files; '[S]kip' leaves the metadata in this file and proceeds to the next; '[C]ancel' undoes any changes and cancels the action. Note that if you choose metadata that is not common to all the selected files, and you click the [R]emove button in the edit controls, the metadata will be removed from those files that have it. Those that do not contain this metadata will be unaffected.
     120When you remove metadata from a folder, or from several files, you are presented with various options: removing the metadata from this file, removing it from this and all other files, and skipping this file.  You can cancel the operation at any time.  If you choose metadata that is not common to all the selected files and click "Remove", the metadata is removed from those files that have it; all others are unaffected.
    142121</p>
    143122
    144123      </font>
    145124      </p>
    146     </td>
    147   </tr>
    148   <tr bgcolor="#E0F0E0">
    149     <td colspan="3" width="100%">
    150       <img height="20" src="gatherer_small.gif" width="20">
    151       <font face="Verdana" size="4">
    152       <u>
    153 <a name="QA">Problems And Solutions:</a>
    154       </u>
    155       <font size="3">
    156       <i>
    157 <p style="text-align:justify">
    158 "I've removed some metadata, but its value still appears in the Value Tree"
    159 </p>
    160 
    161       </i>
    162 <p style="text-align:justify">
    163 This is a feature, not a bug!  Even if you remove all references to a value, it doesn't mean you'll never want that value again. If you truely wish to remove the value as well you should use the Metadata Set Editor explained at the end of these help pages.
    164 </p>
    165 
    166       </font>
    167125    </td>
    168126  </tr>
  • trunk/gli/help/6-7.htm

    r4293 r5284  
    2525      <font face="Verdana" size="3">
    2626<p style="text-align:justify">
    27 This section shows how to view all metadata assigned to an entire collection.
     27This section describes how to view all metadata assigned to an entire collection.
    2828</p>
    2929
     
    115115      <font size="3">
    116116<p style="text-align:justify">
    117 Sometimes you need to see all metadata assigned to all files. For instance, you may wonder how many files are left to work on, or you may want to get some idea of the spread of dates.
     117Sometimes you need to see the metadata assigned to all files -- for instance, to determine how many files are left to work on, or to get some idea of the spread of dates.
    118118</p>
    119119<p style="text-align:justify">
    120 >From the [M]etadata menu choose the 'Assigned [M]etadata...' action. This opens a new window called the All Metadata view. The view is dominated by a large table like the Metadata Table, with many columns. The first column shows file names; the remaining ones show metadata element names. Each row shows all metadata values assigned to that file.
     120>From the "Metadata Set" menu choose "Assigned Metadata...".  A window called "All Metadata", dominated by a large table with many columns, appears.  The first column shows file names; the rows show all metadata values assigned to that file.
    121121</p>
    122122<p style="text-align:justify">
    123 The audit view itself is non-modal, which means that you can carry on using the Librarian Interface even while the audit window is open. In fact, any changes in the collection files selected will immediately update the table accordingly.
     123Drawing the table can take some time.  You can continue to use the Librarian Interface while the "All Metadata" window is open.
    124124</p>
    125125<p style="text-align:justify">
    126 A lot of preparatory work must be done when creating the audit view's model, so drawing the table can take some time. If you select ten thousand files, the audit view may take thirty seconds to calculate and display.
    127 </p>
    128 <p style="text-align:justify">
    129 Once you have finished reviewing the metadata, click [C]lose to hide the audit table.
     126Click "Close" to hide the window.
    130127</p>
    131128
     
    143140      <font size="3">
    144141<p style="text-align:justify">
    145 You may view the metadata audit table at any time by selecting the files you wish to audit and opening the right click menu. Now click on the item [V]iew All Metadata. If a directory has been selected, all its child files will be included in the table.
     142You can also view the "All Metadata" table by selecting the files you wish to examine, right-clicking, and choosing "Assigned Metadata...".  If a folder has been selected, all its child files are included in the table.
    146143</p>
    147144<p style="text-align:justify">
    148 The metadata audit table quickly becomes daunting to navigate, and so a filtering mechanism is included, modelled on Microsoft Excel's concept of 'Autofilter'.  It allows a single filter to be applied to each column of the audit table. As new filters is added, only those rows that match the filters set on all columns remain visible. To set, modify or clear a filter, click on the grey area containing the metadata element name and an icon of a funnel, at the top of the column you wish to filter.  A new prompt appears allowing you to control filtering. Once a filter is set, the column header, and the funnel within it, changes colour to indicate that the column is being filtered.
     145When it gets too large, you can filter the "All Metadata" table by applying filters to the columns.  As new filters are added, only those rows that match them remain visible.  To set, modify or clear a filter, click on the "funnel" icon at the top of a column.  You are prompted for information about the filter. Once a filter is set, the column header changes colour.
    149146</p>
    150147<p style="text-align:justify">
    151 The prompt itself contains four main components. The top field reminds you of the name of the column, the second to bottom ComboBox control allows you to change the alphabetical order of the values in the column (move rows as necessary) and the bottom area offers you buttons to [S]et and [C]lear the filter. This leaves the middle area, where the filtering is actually controlled. Initially the Simple tab will be selected. This allows you to filter a column so that it only shows rows which contain a certain existing metadata value. Note that the * matches all values. Just choose the value you want to limit the column to, then set the filter.
     148The prompt has a "Simple" and an "Advanced" tab.  The Simple version filters columns so that they only show rows that contain a certain metadata value ("*" matches all values).  You can select metadata values from the pull-down list. The Advanced version allows different matching operations: must start with, does not contain, alphabetically less than and is equal to.  The value to be matched can be edited to be any string (including "*"), and you can choose whether the matching should be case insensitive.  Finally, you can specify a second matching condition that you can use to specify a range of values (by selecting AND) or alternative values (by selecting OR).  Below this area is a box that allows you to change the sort order (ascending or descending).  Once you have finished, click "Set Filter" to apply the new filter to the column. Click "Clear Filter" to remove a current filter.  Note that the filter details are retained even when the filter is cleared.
    152149</p>
    153150<p style="text-align:justify">
    154 There is also an 'advanced' tab. While the simple filter is essentially a 'must equal', the advanced tab allows several different matching operations such as: must start with, does not contain, alphabetically less than and is equal to. Furthermore, the value to be matched can be edited to be any string, not just values that already exist within that column (although by default these values are made available as the drop down list connected to the value ComboBox). You may also choose whether the matching should be case sensitive. Finally, the advanced filtering allows you to specify a second condition that must be matched. This allows you to specify ranges of values accepted (by selecting the AND checkbox then filling out the filter) or possibly alternate values accepted (by selecting the OR checkbox instead).
    155 </p>
    156 <p style="text-align:justify">
    157 Once you have finished select the ordering, click [S]et Filter. The new filter will be applied to the column, and you should notice that fewer rows are now visible.
    158 </p>
    159 <p style="text-align:justify">
    160 If at any time you wish to stop adding a new filter, or to remove a current filter, click the [C]lear Filter button. Note that the details of a certain filter are retained even when the filter is cleared.
    161 </p>
    162 <p style="text-align:justify">
    163 A trick to quickly sort the table is to choose the column to sort by, select a simple filter of *, then choose ascending or descending ordering.
     151For example, to sort the "All Metadata" table, choose a column, select the default filter setting (a Simple filter on "*"), and choose ascending or descending ordering.
    164152</p>
    165153
  • trunk/gli/help/6-8.htm

    r4293 r5284  
    2525      <font face="Verdana" size="3">
    2626<p style="text-align:justify">
    27 This section details the process for importing previously assigned metadata, and how to install parsers to handle various metadata types.
     27This section describes how to import previously assigned metadata, and install parsers to handle various metadata types.
    2828</p>
    2929
     
    6767                </td>
    6868              </tr>
    69               <tr>
    70                 <td colspan="3">
    71                   <font face="Verdana" size="4">
    72                   <strong>
    73 <a href="#AI">Advanced instructions</a>
    74                   </strong>
    75                   </a>
    76                   </font>
    77                 </td>
    78               </tr>
    79               <tr>
    80                 <td>
    81                   &nbsp;
    82                 </td>
    83                 <td colspan="2">
    84                   <font face="Verdana" size="4">
    85 New parsers
    86                   </font>
    87                   </a>
    88                 </td>
    89               </tr>
    90               <tr>
    91                 <td colspan="3">
    92                   <font face="Verdana" size="4">
    93                   <strong>
    94 <a href="#QA">Problems and solutions</a>
    95                   </strong>
    96                   </a>
    97                   </font>
    98                 </td>
    99               </tr>
    100               <tr>
    101                 <td>
    102                   &nbsp;
    103                 </td>
    104                 <td colspan="2">
    105                   <font face="Verdana" size="4">
    106 "What if I accidentally import information to the wrong element?"
    107                   </font>
    108                   </a>
    109                 </td>
    110               </tr>
    11169            </font>
    11270            </table>
     
    12583      <font size="3">
    12684<p style="text-align:justify">
    127 If metadata has been previously assigned to a certain file, and that metadata is in a form recognized by the Librarian Interface, the metadata will be imported when you add the file. This sometimes happens without any user intervention. However, if the Librarian Interface does not know how to map previously assigned metadata onto the metadata sets available in the collection, it prompts the user on how to do so.
     85If metadata in a form recognized by the Librarian Interface has been previously assigned to a file -- for example, when you choose documents from an existing Greenstone collection -- it is imported automatically when you add the file. To do this, the metadata must be mapped to the metadata sets available in the collection.
    12886</p>
    12987<p style="text-align:justify">
    130 The prompt contains brief instructions on what must be done. Below the instruction box are three text fields.  The first shows the name of the metadata element that the Librarian Interface is importing, just as it appears in whatever source file the Librarian Interface has found. This field cannot be edited or changed. The second control allows you to choose what metadata set this element should map to, and contains all the sets available in the collection. The third control allows you to choose which metadata element the original element should map to if you intend to merge elements.
     88The Librarian Interface prompts for the necessary information.  The prompt gives brief instructions and then shows the name of the metadata element that is being imported, just as it appears in the source file.  This field cannot be edited or changed.  Next you choose what metadata set the new element should map to, and then the appropriate metadata element in that set.  The system automatically selects the closest match, in terms of set and element, for the new metadata.
    13189</p>
    13290<p style="text-align:justify">
    133 When this display is created the Librarian Interface makes an educated guess about which element and set should be chosen. For instance, if the element being imported were called 'Publisher' and there existed only one element within the available sets called 'dls.Publisher', then the Librarian Interface would guess the metadata set to be the Development Library Subset (dls) and the element to be Publisher. However this doesn't always work as intended, so be sure to check the fields before committing any changes.
     91Having checked the mapping, you can choose "Add" to add the new metadata element to the chosen metadata set.  (This is only enabled if there is no element of the same name within the chosen set.) "Merge" maps the new element to the one chosen by the user.  Finally, "Ignore" does not import any metadata with this element name.
    13492</p>
    13593<p style="text-align:justify">
    136 The actions allowed are: [A]dd, [M]erge or [I]gnore. The add button allows you to add a new element to the chosen metadata set with the name as given in the original. This control is only enabled if there is no element of the same name within the chosen set. Merging maps the original element to the element chosen by the user. Finally, ignore skips importing any metadata which has an element as named in the original element field.
     94Once you have specified how to import a certain piece of metadata, the mapping information is retained for the collection's lifetime.  To correct any mistakes during importing, use the metadata set editor described in Chapter 11 -- Editing Metadata Sets.
    13795</p>
    13896<p style="text-align:justify">
    139 Once you have advised the Librarian Interface how to import a certain piece of metadata from a certain source location, it retains this information for the lifetime of the collection.
     97For details on how design metadata.xml files see Chapter 2 of the Greenstone Developer's Guide -- Getting the most out of your documents.
    14098</p>
    14199
    142100      </font>
    143101      </p>
    144     </td>
    145   </tr>
    146   <tr bgcolor="#E0F0E0">
    147     <td colspan="3" width="100%">
    148       <img height="20" src="gatherer_small.gif" width="20">
    149       <font face="Verdana" size="4">
    150       <u>
    151 <a name="AI">Advanced Instructions:</a>
    152       </u>
    153       <font size="3">
    154 <p style="text-align:justify">
    155 When attempting to find metadata, the Librarian Interface consults a series of dynamically loaded metadata file parsers for information about where to find metadata and how to read it once it is found. For instance, the directory '<gatherer install directory>\classes\org\greenstone\gatherer\msm\parsers' contains a file named 'GreenstoneMetadataParser.class'. This, and the other files starting with the same name, instructs the Librarian Interface how to read Greenstone metadata files, or metadata.xml files. Any new parser must implement the org.greenstone.gatherer.msm.MetadataParser interface. If this is done it is simply a matter of placing the file in the directory named above and restarting the Librarian Interface. Thus you are able to parse metadata from any source you have installed a parser for.
    156 </p>
    157 
    158       </font>
    159       </p>
    160     </td>
    161   </tr>
    162   <tr bgcolor="#E0F0E0">
    163     <td colspan="3" width="100%">
    164       <img height="20" src="gatherer_small.gif" width="20">
    165       <font face="Verdana" size="4">
    166       <u>
    167 <a name="QA">Problems And Solutions:</a>
    168       </u>
    169       <font size="3">
    170       <i>
    171 <p style="text-align:justify">
    172 "What if I accidentally import information to the wrong element?"
    173 </p>
    174 
    175       </i>
    176 <p style="text-align:justify">
    177 Currently the solution is the edit the profile.xml file located in the collection's metadata directory, to remove any erroneous entries. Once this is done, remove the files affected then re-import them. Eventually an 'import profile' editor will be included with the option of re-importing metadata.
    178 </p>
    179 
    180       </font>
    181102    </td>
    182103  </tr>
  • trunk/gli/help/7-0.htm

    r4293 r5284  
    2525      <font face="Verdana" size="3">
    2626<p style="text-align:justify">
    27 Once you have a set of marked-up files, it is time to consider how it will appear to users as a Greenstone collection.  What kind of information will be searchable?  What ways are provided to browse through the documents?  What languages are supported?  Where do the buttons appear on the page?  Many such features can be customized; this chapter shows how to do it.
     27Once your files are marked up with metadata, you next decide how it should appear to users as a Greenstone collection.  What kind of information is searchable?  What ways are provided to browse through the documents?  What languages are supported?  Where do the buttons appear on the page?  These things can be customized; this chapter describes how to do it.
    2828</p>
    2929
  • trunk/gli/help/7-1.htm

    r4293 r5284  
    1313      <font face="Verdana" size="5">
    1414      <strong>
    15 7.1 The 'Design' View
     157.1 The Design View
    1616      </strong>
    1717      </font>
     
    2525      <font face="Verdana" size="3">
    2626<p style="text-align:justify">
    27 This section introduces you to the design view, and explains how to navigate between the various sub-views within this pane.
     27This section introduces you to the design view and explains how to navigate between the various views within this pane.
    2828</p>
    2929
     
    8383      <font size="3">
    8484<p style="text-align:justify">
    85 In Greenstone every collection has a collection configuration file, called collect.cfg, which controls most aspects of how the collection appears to the user. The Librarian Interface provides a graphical user interface to this file. It divides the kinds of commands that are available into different sections, each associated with a particular stage of the collection building or presentation.
     85With the Librarian Interface, you can configure how the collection appears to the user.  The configuration options are divided into different sections, each associated with a particular stage of navigating or presenting information.
    8686</p>
    8787<p style="text-align:justify">
    88 The design view is split into two halves. On the left is a list of different sub-views, and on the right are the controls associated with the current sub-view. To change to a different sub-view, click its name in the list. The right pane updates to reflect the change.
     88On the left is a list of different views, and on the right are the controls associated with the current one.  To change to a different view, click its name in the list.
    8989</p>
    9090<p style="text-align:justify">
    91 When you change panes, the state of the previous pane is retained so that you can return to it later.
     91To understand the stages and terms involved in designing a collection, first read Chapters 1 & 2 of the Greenstone Developer's Guide.
    9292</p>
    9393
  • trunk/gli/help/7-2.htm

    r4293 r5284  
    2525      <font face="Verdana" size="3">
    2626<p style="text-align:justify">
    27 This section explains how to review and alter the general settings associated with your collection.
     27This section explains how to review and alter the general settings associated with your collection.  First, under "Design Sections", click "General".
    2828</p>
    2929
     
    8383      <font size="3">
    8484<p style="text-align:justify">
    85 When you first switch to the design view, the general settings section is the one that is open. This is where the values provided during collection creation can be modified.
     85Here the values provided during collection creation can be modified.
    8686</p>
    8787<p style="text-align:justify">
    88 At the top of the page is an instruction box, which appears for each of the different sections.  The brief list of instructions it contains is intended as a reminder of what functionality is available. The box can be scrolled using the scrollbar at the right edge, but is not itself editable.
     88At the top of the page is an instruction box, which appears for each of the different sections.  It contains a brief list of instructions to remind you what functionality is available.
    8989</p>
    9090<p style="text-align:justify">
    91 The first two fields below the instructions give the contact email of the collection's creator and maintainer, and must be valid email addresses. The next two controls are checkboxes. The next and last text boxes show details from the 'new collection' prompt, and can be modified if necessary.  The remaining control allows you to specify the URL path to the image that will be used as the icon for your collection from the Greenstone server's home page.
    92 </p>
    93 <p style="text-align:justify">
    94 The labels beside the text boxes (which most likely say 'English') show the language of the currently displayed values. Here, in conjunction with the Languages section, you can specify such things as the collection's title in several different languages. However, this is more easily done through the Translate prompt found in the Languages section.
     91First are the contact emails of the collection's creator and maintainer.  Then come two checkboxes for whether the collection should be publicly accessible, and whether it is still under construction.  The following field allows you to change the collection title.  The next one specifies (in the form of a URL) the icon to show at the top left of the collection's "About" page, and the next is the icon used in the Greenstone library page to link to the collection.  Finally comes the "Collection Description" text area as described in section 2.1 -- Creating A New Collection.
    9592</p>
    9693
  • trunk/gli/help/7-3.htm

    r4293 r5284  
    1313      <font face="Verdana" size="5">
    1414      <strong>
    15 7.3 Indexes
     157.3 Plug-Ins
    1616      </strong>
    1717      </font>
     
    2525      <font face="Verdana" size="3">
    2626<p style="text-align:justify">
    27 This section explains how to add and remove indexes, and how to set an index as the default one.
     27This section describes how to configure the document plug-ins the collection uses.  It explains how you specify what plug-ins to use, what parameters to pass to them, and in what order they occur.  Under "Design Sections", click "Plug-ins".
    2828</p>
    2929
     
    6262                <td colspan="2">
    6363                  <font face="Verdana" size="4">
    64 Add an index
    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 Remove an index
    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 Set default index
    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 Clear default index
     64Add a plug-in
     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">
     75Remove 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">
     86Configure 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">
     97Change plug-in order
     98                  </font>
     99                  </a>
     100                </td>
     101              </tr>
     102              <tr>
     103                <td colspan="3">
     104                  <font face="Verdana" size="4">
     105                  <strong>
     106<a href="#AI">Advanced instructions</a>
     107                  </strong>
     108                  </a>
     109                  </font>
     110                </td>
     111              </tr>
     112              <tr>
     113                <td>
     114                  &nbsp;
     115                </td>
     116                <td colspan="2">
     117                  <font face="Verdana" size="4">
     118Custom configuration
     119                  </font>
     120                  </a>
     121                </td>
     122              </tr>
     123              <tr>
     124                <td>
     125                  &nbsp;
     126                </td>
     127                <td colspan="2">
     128                  <font face="Verdana" size="4">
     129Rebuilding the plug-in database
    98130                  </font>
    99131                  </a>
     
    116148      <font size="3">
    117149<p style="text-align:justify">
    118 We start by adding a new index. First, notice the instructions area at the top of the screen. Directly below it, on the left, are the controls used to add indexes.  To add an index, first provide a name for it by typing into the Index Name field. Next, select exactly what is to be indexed from the list of available sources. This list shows all the assigned metadata elements, as well as an option to use a full 'text' index. Having selected a source, now choose the level (i.e. what granularity) of the index, using the level selector. Once these details are complete (and assuming that there is not already an index with the same settings), the [A]dd Specified Index button becomes active. Click it to add the new index to the list of assigned indexes.
    119 </p>
    120 <p style="text-align:justify">
    121 To remove an index, select it from the list of indexes beneath the instructions and to the right, and click the [R]emove Selected Index button. The selected index will then be removed from the list.
    122 </p>
    123 <p style="text-align:justify">
    124 The default index is the one used on the collections search page. To set it, select the desired index from the list and click [S]et Default Index. The index's name will appear in the default index field directly below the assigned indexes list. Note that the default index field is not editable.
    125 </p>
    126 <p style="text-align:justify">
    127 To reset the default index click the [C]lear Default Index button and the default index field will become blank.
     150To add a plug-in, use the "Select plug-in to add" pull-down list near the bottom and then click "Add Specified Plug-in".  A window appears entitled "Configuring Arguments"; it is described later.  Once you have configured the new plug-in, it is added to the end of the "Currently Assigned Plug-Ins" list. Note that a plug-in may only occur once in the list.
     151</p>
     152<p style="text-align:justify">
     153To remove a plug-in, select it in the list and click "Remove Selected Plug-in".
     154</p>
     155<p style="text-align:justify">
     156Plug-Ins are configured by providing arguments.  To alter them, select the plug-in from the list and click "Configure Selected Plug-in" (or double-click the plug-in).  A "Configuring Arguments" dialog appears with three parts: a text field for entering custom arguments, an area containing controls for specifying arguments, and two buttons at the bottom.
     157</p>
     158<p style="text-align:justify">
     159There are different kinds of controls.  Some are checkboxes, and clicking one adds the appropriate option to the plug-in.  Others are text strings, with a checkbox and a text field.  Click the box to enable the argument, then type appropriate text (regular expression, file path etc) in the box.  Others are pull-down menus from which you can select from a given set of values.  Still others allow multiple selections from a list.  To add a value, select it and click "Add"; to remove it, select it and click "Remove".  To learn what an argument does, let the mouse hover over its name for a moment and a description will appear.
     160</p>
     161<p style="text-align:justify">
     162When you have changed the configuration, click "OK" to commit the changes and close the dialog, or "Cancel" to close the dialog without changing any plug-in arguments.
     163</p>
     164<p style="text-align:justify">
     165The plug-ins in the list are executed in order, and the ordering is sometimes important.  Two plug-ins, ArcPlug and RecPlug, are vital to the collection building process, and are fixed in place at the end of the list (with a separator line).  To change the ordering, select the plug-in you want to move and click "Move To Top", "Move Up", "Move Down", or "Move To Bottom".
    128166</p>
    129167
  • trunk/gli/help/7-4.htm

    r4293 r5284  
    1313      <font face="Verdana" size="5">
    1414      <strong>
    15 7.4 Sub-collections
     157.4 Search Types
    1616      </strong>
    1717      </font>
     
    2525      <font face="Verdana" size="3">
    2626<p style="text-align:justify">
    27 This section describes how to create sub-collections within a collection, and how to create indexes upon these sub-collections.
     27This section explains how to modify a new design feature in Greenstone, Search Types, which allow fielded searching.  Under "Design Sections", click "Search Types".
    2828</p>
    2929
     
    6262                <td colspan="2">
    6363                  <font face="Verdana" size="4">
    64 Sub-collection controls
     64What enabling advanced searches means
    6565                  </font>
    6666                  </a>
     
    7373                <td colspan="2">
    7474                  <font face="Verdana" size="4">
    75 Add a sub-collection
     75Adding a new search type
    7676                  </font>
    7777                  </a>
     
    8484                <td colspan="2">
    8585                  <font face="Verdana" size="4">
    86 Remove a sub-collection
    87                   </font>
    88                   </a>
    89                 </td>
    90               </tr>
    91               <tr>
    92                 <td colspan="3">
    93                   <font face="Verdana" size="4">
    94                   <strong>
    95 <a href="#AI">Advanced instructions</a>
    96                   </strong>
    97                   </a>
    98                   </font>
    99                 </td>
    100               </tr>
    101               <tr>
    102                 <td>
    103                   &nbsp;
    104                 </td>
    105                 <td colspan="2">
    106                   <font face="Verdana" size="4">
    107 Sub-index controls
     86Removing a search type
    10887                  </font>
    10988                  </a>
     
    11695                <td colspan="2">
    11796                  <font face="Verdana" size="4">
    118 Add a sub-index
    119                   </font>
    120                   </a>
    121                 </td>
    122               </tr>
    123               <tr>
    124                 <td>
    125                   &nbsp;
    126                 </td>
    127                 <td colspan="2">
    128                   <font face="Verdana" size="4">
    129 Remove a sub-index
    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 Set default sub-index
    141                   </font>
    142                   </a>
    143                 </td>
    144               </tr>
    145               <tr>
    146                 <td>
    147                   &nbsp;
    148                 </td>
    149                 <td colspan="2">
    150                   <font face="Verdana" size="4">
    151 Clear default sub-index
     97Changing the order of search types
    15298                  </font>
    15399                  </a>
     
    170116      <font size="3">
    171117<p style="text-align:justify">
    172 The Sub-collections feature allows you to group together all documents in a collection for which a specified metadata value matches a given pattern.  Within this section are two related views, chosen by clicking the appropriate tab on the tabbed pane. The Sub-collection Controls are discussed here, while the Sub-index Controls are relegated to the 'advanced topics' below.
     118When you enter the Search Types view, first check "Enable Advanced Searches", which activates the other controls.  This migrates the collection to Greenstone 2.4 format, which supports for fielded searching, and means that (a) the index design is different (explained in section 7.5 -- Search Indexes), (b) there are more text fragments to translate (see Section 7.10 -- Translation), and (c) the collection will not be usable under older Greenstone installations.  If you later uncheck this field, most of your collection will be migrated back to Greenstone 2.39.  However the Librarian Interface cannot convert the new index specifications into older ones, so you will have to re-enter them manually.
    173119</p>
    174120<p style="text-align:justify">
    175 To add a new sub-collection, first give it a name by typing into the name field. Next, choose what part of the documents must match in order to belong to this sub-collection. You can choose any metadata, or the name of the file in question. Next, enter a regular expression that will be used in the match.  You can toggle between [I]ncluding documents that match the filter, or e[X]cluding them.  Finally, you can specify flags to be set while matching. These may be any of the standard PERL regular expression flags, such as 'i' for case-insensitive matching; alternatively just leave this field blank. Once you have filled out these fields, click on the [A]dd New Sub-collection button to add the sub-collection to the list. This list contains the sub-collection commands exactly as they appear in the collection configuration file.
     121To add a search type, select it from the "Search Types" list and click "Add New Search Type".  Each type can only appear in the list once.
    176122</p>
    177123<p style="text-align:justify">
    178 To remove a sub-collection, select it from the list of assigned sub-collections and click [R]emove Selected Sub-collection.
    179 </p>
    180 
    181       </font>
    182       </p>
    183     </td>
    184   </tr>
    185   <tr bgcolor="#E0F0E0">
    186     <td colspan="3" width="100%">
    187       <img height="20" src="gatherer_small.gif" width="20">
    188       <font face="Verdana" size="4">
    189       <u>
    190 <a name="AI">Advanced Instructions:</a>
    191       </u>
    192       <font size="3">
    193 <p style="text-align:justify">
    194 Once you have a sub-collection you can instruct Greenstone to build indexes specifically for that sub-collection, or for a group of sub-collections.  To do this, click on the Sub-index Controls tab. The centre of the pane changes to show two lists, a field and four buttons. The upper list shows all currently assigned Sub-collections. Below it is a list of groupings for which you can build indexes. The field shows the current default sub-collection sub-index. Note that sub-indexes are not the same as indexes.
     124To remove a search type, select it from the "Currently Assigned Search Types" list and click "Remove Selected Search Type".  The list must contain at least one search type.
    195125</p>
    196126<p style="text-align:justify">
    197 To assign a sub-index, select the desired sub-collection or sub-collections from the upper list, using multiple selection methods as necessary. Now click [A]dd Selected As New Sub-index, and a new grouping for the selected sub-collections will appear in the assigned sub-indexes.
    198 </p>
    199 <p style="text-align:justify">
    200 Remove an existing sub-index group be first selecting it from the sub-index list, then clicking the [R]emove Selected Sub-index.
    201 </p>
    202 <p style="text-align:justify">
    203 You can make a particular sub-index the default by selecting it from the list of sub-indexes, then click [S]et Default Sub-index.  The grouping of the selected sub-index will appear in the default sub-index field.
    204 </p>
    205 <p style="text-align:justify">
    206 To clear the default sub-index, click [C]lear Default Sub-index.
     127To change to order of a search type, select it from the list and click "Move Up" or "Move Down".
    207128</p>
    208129
  • trunk/gli/help/7-5.htm

    r4293 r5284  
    1313      <font face="Verdana" size="5">
    1414      <strong>
    15 7.5 Languages
     157.5 Search Indexes
    1616      </strong>
    1717      </font>
     
    2525      <font face="Verdana" size="3">
    2626<p style="text-align:justify">
    27 This section details how multilingual support is defined by entries in the collection configuration file, and shows how to modify such settings using the Language section sub-view.
     27Indexes specify what parts of the collection are searchable.  This section explains how to add and remove indexes, and set a default index.  Under "Design Sections", click "Search Indexes".
    2828</p>
    2929
     
    6262                <td colspan="2">
    6363                  <font face="Verdana" size="4">
    64 Language controls
     64Add an index
    6565                  </font>
    6666                  </a>
     
    7373                <td colspan="2">
    7474                  <font face="Verdana" size="4">
    75 Add language
     75Remove an index
    7676                  </font>
    7777                  </a>
     
    8484                <td colspan="2">
    8585                  <font face="Verdana" size="4">
    86 Remove language
     86Set default index
    8787                  </font>
    8888                  </a>
     
    9595                <td colspan="2">
    9696                  <font face="Verdana" size="4">
    97 Set default language
    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 Clear default language
    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 Translate assigned text fragments
     97Clear default index
    13098                  </font>
    13199                  </a>
     
    148116      <font size="3">
    149117<p style="text-align:justify">
    150 Directly below the instruction text area is the control used to select a language. To the right is a list of currently supported languages and a field showing the default. At the bottom are four buttons for manipulating assignments.
     118To add an index, type a name for it into the "Index Name" field.  Select which of the possible information sources to index by clicking the checkboxes beside them.  The list shows all the assigned metadata elements, as well the full text.  Having selected the data sources, choose the granularity of the index, using the "At the level" menu.  Once these details are complete, "Add Index" becomes active (unless there is an existing index with the same settings). Click it to add the new index.
    151119</p>
    152120<p style="text-align:justify">
    153 To add a new language to those we wish to publish a collection in, first select the desired language from the Language to add ComboBox control. These values come from a file called language.dat in the Librarian Interface's install directory. Once a language is chosen, press [A]dd Language to add it to the list of supported languages.
     121To remove an index, select it from the list of assigned indexes and click "Remove Index".
    154122</p>
    155123<p style="text-align:justify">
    156 Removing language support is just as easy. Select the language you wish to remove from the list, then click [R]emove Language.
     124The default index, the one used on the collection's search page, is tagged with "[Default Index]" in the "Assigned Indexes" list.  To set it, select an index from the list and click "Set Default".  To reset it, click "Clear Index".
    157125</p>
    158126<p style="text-align:justify">
    159 The default language is set by selecting it from the list of supported languages, then clicking [S]et Default Language.  The name of the chosen language will appear in the default language field.
    160 </p>
    161 <p style="text-align:justify">
    162 To reset the default language, click [C]lear Default Language.
    163 </p>
    164 
    165       </font>
    166       </p>
    167     </td>
    168   </tr>
    169   <tr bgcolor="#E0F0E0">
    170     <td colspan="3" width="100%">
    171       <img height="20" src="gatherer_small.gif" width="20">
    172       <font face="Verdana" size="4">
    173       <u>
    174 <a name="AI">Advanced Instructions:</a>
    175       </u>
    176       <font size="3">
    177 <p style="text-align:justify">
    178 There is one remaining button, [T]ranslate Assigned Text Fragment. This opens a new prompt box containing three entry areas and a list titled 'Affected Features' on the left. If you select a feature from this list, the panels to the left will change.
    179 </p>
    180 <p style="text-align:justify">
    181 The top area, titled 'Assigned Languages', displays a table with two columns.  The first is the languages you have chosen to support; the second is the text fragment for the associated feature, in each language. The central text shows the fragment associated with the default language for this collection.  This may be blank, but is more likely to be a value that you entered previously. It is used as a reference when translating text fragments.  The bottom pane will remain blank until you select a row from the Assigned Languages table. Then, it shows the previous string entered for this language and this feature (if any). To add or edit the text for the chosen row, click within the editable bottom text area and type as desired. As you type, the fragment entry within the table changes to reflect what you have typed. However, the reference text area does not change, even if you are editing the default language text fragment. Changes to the default language will be committed only when you select a different language.
     127If advanced searching is enabled, the index controls are different.  Each index is based on just one data source.  There is a new data source "allfields" which is equivalent to entering a list of all the metadata elements.  Levels are not assigned to a specific index, but apply across all indexes: thus indexes and levels are added separately.  Indexes are removed in the same way as above, but the default index can no longer controls be set and cleared -- it is simply the first index assigned.
    182128</p>
    183129
  • 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>
  • trunk/gli/help/7-7.htm

    r4293 r5284  
    1313      <font face="Verdana" size="5">
    1414      <strong>
    15 7.7 Classifiers
     157.7 Cross-Collection Searching
    1616      </strong>
    1717      </font>
     
    2525      <font face="Verdana" size="3">
    2626<p style="text-align:justify">
    27 This section explains the process of assigning classifiers to your collection using the Librarian Interface.
     27Greenstone can search across several different collections as though they were one.  This is done by creating a "super-collection" that comprises the individual collections.  Under "Design Sections", click "Super-Collection".
    2828</p>
    2929
     
    6262                <td colspan="2">
    6363                  <font face="Verdana" size="4">
    64 Classifier 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 classifier
    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 classifier
    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 classifier
    98                   </font>
    99                   </a>
    100                 </td>
    101               </tr>
    102               <tr>
    103                 <td colspan="3">
    104                   <font face="Verdana" size="4">
    105                   <strong>
    106 <a href="#AI">Advanced instructions</a>
    107                   </strong>
    108                   </a>
    109                   </font>
    110                 </td>
    111               </tr>
    112               <tr>
    113                 <td>
    114                   &nbsp;
    115                 </td>
    116                 <td colspan="2">
    117                   <font face="Verdana" size="4">
    118 Rebuilding the classifier database
    119                   </font>
    120                   </a>
    121                 </td>
    122               </tr>
    123               <tr>
    124                 <td>
    125                   &nbsp;
    126                 </td>
    127                 <td colspan="2">
    128                   <font face="Verdana" size="4">
    129 Custom classifiers
    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 CustomAZList
     64Selecting a collection
    14165                  </font>
    14266                  </a>
     
    15983      <font size="3">
    16084<p style="text-align:justify">
    161 The classifiers sub-view is just the same as the plug-in sub-view, except that there are no movement controls.
     85The Super-Collection view shows a checklist of available collections.  The current collection is ticked and cannot be deselected.  To add another collection to be searched in parallel, click it in the list (click again to remove it).  If only one collection is selected, there is no cross-collection searching.
    16286</p>
    16387<p style="text-align:justify">
    164 To add a classifier, choose it from the ComboBox of known classifiers. Click the [A]dd Specified Classifier button, configure the classifier as desired, and commit the changes. Once this is done the new classifier appears in the list of assigned classifiers.
    165 </p>
    166 <p style="text-align:justify">
    167 To remove a classifier, select it from the list and click [R]emove Selected Classifier.
    168 </p>
    169 <p style="text-align:justify">
    170 To change the argument configuration of a classifier, select it from the list and press [C]onfigure Selected Classifier. Instructions for the 'Configuring Arguments' dialog are just the same as for plug-ins (except for custom classifiers explained below).
    171 </p>
    172 
    173       </font>
    174       </p>
    175     </td>
    176   </tr>
    177   <tr bgcolor="#E0F0E0">
    178     <td colspan="3" width="100%">
    179       <img height="20" src="gatherer_small.gif" width="20">
    180       <font face="Verdana" size="4">
    181       <u>
    182 <a name="AI">Advanced Instructions:</a>
    183       </u>
    184       <font size="3">
    185 <p style="text-align:justify">
    186 As for plug-ins, the Librarian Interface automatically rebuilds the classifier database when it detects that the old one is missing. This is how new standard classifiers can be registered with the Librarian Interface. Make sure that the classifier is in an appropriate directory, then rename the file 'classifiers.dat' from the Librarian Interface's installation directory. The next time the Librarian Interface requires classifier data it will rebuild the database, including the new classifier. Note that this is not the same as using custom classifiers. Also, as with plugins, you requires the latest classifier and clasinfo.pl to ensure the -xml flag is supported. Again such versions are available for download from the Librarian Interface site.
    187 </p>
    188 <p style="text-align:justify">
    189 A custom classifier is not a classifier in itself, but instead uses one or more basic classifiers to accomplish an advanced classification task. Custom classifiers are written in Java (not PERL like other classifiers) and dynamically loaded when the Librarian Interface is started.  To add a new custom classifier, place it in the classes/org/greenstone/gatherer/cdm/custom directory within the Librarian Interface install directory. (On a more technical note, custom classifiers implement the class org.greenstone.gatherer.cdm.CustomClassifier.)  Aside from the control differences explained below, custom classifiers are added, configured and removed in the same way as regular ones.
    190 </p>
    191 <p style="text-align:justify">
    192 The CustomAZList classifier, included with the Librarian Interface, is an example of a custom classifier. It allows users to build an AZList, and specify what the various letter ranges should be, e.g. #,A-F,G-P,Q-Z. This is accomplished by using a Hierarchy classifier behind the scenes, and adding hidden metadata to files in the collection.
    193 </p>
    194 <p style="text-align:justify">
    195 Custom classifiers provide a fully-customized set of controls for the purposes of configuration.  The CustomAZList classifier has a distinct dialog window, with two familiar fields, metadata and button name, at the top. Most of the pane is taken by several rows of buttons, each one matching a letter of the alphabet (with # for numbers), and a field below that shows the current letter ranges. Toggling a button on (so it appears selected) indicates the letter a range should begin with. There are two buttons at the bottom. [C]reate Classifier causes the custom classifier to be applied to the collection. While adding normal classifiers is just a case of writing an extra line in the collection configuration file, custom classifiers may require changes to the entire collection. Thus the creation of a custom classifier can take considerable time. Clicking the [C]ancel button rolls back any changes and prevents the CustomAZList from being added.
     88For further details, see Chapter 1 of the Greenstone Developer's Guide.
    19689</p>
    19790
  • trunk/gli/help/7-8.htm

    r4293 r5284  
    1313      <font face="Verdana" size="5">
    1414      <strong>
    15 7.8 Format Settings
     157.8 Classifiers
    1616      </strong>
    1717      </font>
     
    2525      <font face="Verdana" size="3">
    2626<p style="text-align:justify">
    27 This section discusses the dark art of format settings, and how the Librarian Interface simplifies and enhances access to this powerful feature of Greenstone.
     27This section explains how to assign "classifiers", which are used for browsing, to the collection.  Under "Design Sections", click "Classifiers".
    2828</p>
    2929
     
    6262                <td colspan="2">
    6363                  <font face="Verdana" size="4">
    64 Format commands
    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 Static vs. Dynamic features
    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 Components
    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 Flag controls
    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 Format string editing
    109                   </font>
    110                   </a>
    111                 </td>
    112               </tr>
    113               <tr>
    114                 <td>
    115                   &nbsp;
    116                 </td>
    117                 <td colspan="2">
    118                   <font face="Verdana" size="4">
    119 Add format command
    120                   </font>
    121                   </a>
    122                 </td>
    123               </tr>
    124               <tr>
    125                 <td>
    126                   &nbsp;
    127                 </td>
    128                 <td colspan="2">
    129                   <font face="Verdana" size="4">
    130 Remove format command
    131                   </font>
    132                   </a>
    133                 </td>
    134               </tr>
    135               <tr>
    136                 <td>
    137                   &nbsp;
    138                 </td>
    139                 <td colspan="2">
    140                   <font face="Verdana" size="4">
    141 Editing assigned controls
     64Classifier 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">
     75Add a classifier
     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">
     86Remove a classifier
     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">
     97Configure a classifier
     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">
     108Alter classifier ordering
     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">
     129CustomAZList
    142130                  </font>
    143131                  </a>
     
    160148      <font size="3">
    161149<p style="text-align:justify">
    162 Format strings are how you control the appearance of your collection, from where buttons appear on the screen to what colours and icons are displayed in the horizontal component of a DateList classifier. The procedure of using formatting commands can be quite daunting.
    163 </p>
    164 <p style="text-align:justify">
    165 Below the instructions text area are several controls. The lower third of this control area depends on the type of feature you have selected, static vs. dynamic, flag vs. format string. The list at the top of the control area shows the format commands exactly as they appear in the collection configuration file.  The two ComboBoxes in the centre (one of which may be disabled, again depending on feature selection) allow you to specify what feature and component are to be formatted.
    166 </p>
    167 <p style="text-align:justify">
    168 When you begin choosing what feature you wish to format, keep in mind that there are two (overlapping) types of feature: static and dynamic. Static features are always the same and are used to format more general parts of the Greenstone collection, such as whether documents show a cover image, or whether the collection should behave differently as it is exclusively HTML based???. Dynamic features are ones based upon the classifiers assigned to the collection. When a selection is made from the 'Choose feature' ComboBox, the controls below change to reflect the current selection.
    169 </p>
    170 <p style="text-align:justify">
    171 If the selected feature is associated with a browsable result page, such as the dynamic features or the static feature Search, there are several components of this page that may be formatted separately. The possible components are DateList, HList, Invisible or VList. For an explanation of these components please refer to the Greenstone Developers Guide. You may also apply a format to an entire feature by choosing the blank entry from the ComboBox. You may also decide to set a default format for all components of a certain type by choosing a blank entry for the features ComboBox.
    172 </p>
    173 <p style="text-align:justify">
    174 Many of the static featured are 'flags' that have only an on or off state. Selecting one of these changes the controls at the button of the view to toggle buttons titled 'True' and 'False'. Selecting one deselects the other. For example, to format DocumentArrowsBottom so that next and previous arrows are show at the bottom of the page, select DocumentArrowsBottom from the feature ComboBox and then click on the True button to prepare the appropriate format command.
    175 </p>
    176 <p style="text-align:justify">
    177 The second type of control provides you with a text area title 'Edit Format String' with a sidebar of controls titled 'Variables'. I will not go into the details of how to write format strings; again, refer to the Greenstone Developers Guide.
    178 </p>
    179 <p style="text-align:justify">
    180 To make string editing simpler a list of predefined 'variables', including the current assigned metadata elements, are provided in a ComboBox.  To add a certain variable, first ensure that the editing caret is at the appropriate place within the text area. Next choose the variable from the ComboBox, then press [I]nsert to insert the variable at the cursor position.
    181 </p>
    182 <p style="text-align:justify">
    183 To add a new format command, fill out the details as explained above and click [A]dd Format. The new format command appears in the list of 'Currently Assigned Format Commands'.
    184 </p>
    185 <p style="text-align:justify">
    186 To remove a format command, select it from the list of assigned format commands, then click [R]emove Format.
    187 </p>
    188 <p style="text-align:justify">
    189 To alter an assigned format command, select it from the assigned commands list. The command's details appear in the editing controls; change them as desired. Any changes will be immediately reflected in the assigned command. Select a different feature to stop editing.
     150To add a classifier, use the "Select classifier to add" pull-down list near the bottom and then click "Add Specified Classifier".  A window appears entitled "Configuring Arguments"; instructions for this dialog are just the same as for plug-ins (see Section 7.3 -- Plug-Ins).  Once you have configured the new classifier, it is added to the end of the "Currently Assigned Classifiers" list.
     151</p>
     152<p style="text-align:justify">
     153To remove a classifier, select it from the list and click "Remove Selected Classifier".
     154</p>
     155<p style="text-align:justify">
     156To change the arguments a classifier, select it from the list and click "Configure Selected Classifier" (or double-click on the classifier in the list).
     157</p>
     158<p style="text-align:justify">
     159The ordering of classifiers in the collection's navigation bar is reflected in their order here.  To change it, select the classifier you want to move and click "Move To Top", "Move Up", "Move Down", or "Move To Bottom".
     160</p>
     161<p style="text-align:justify">
     162For further information on classifiers read Chapter 2, Greenstone Developer's Guide -- Getting the most out of your documents.
     163</p>
     164
     165      </font>
     166      </p>
     167    </td>
     168  </tr>
     169  <tr bgcolor="#E0F0E0">
     170    <td colspan="3" width="100%">
     171      <img height="20" src="gatherer_small.gif" width="20">
     172      <font face="Verdana" size="4">
     173      <u>
     174<a name="AI">Advanced Instructions:</a>
     175      </u>
     176      <font size="3">
     177<p style="text-align:justify">
     178The CustomAZList classifier is a special classifier that builds an alphabetical selection list ("AZList") and allows you to specify the letter ranges.  This classifier has its own configuration dialogue.  When a metadata element is selected, the "Ranges" tree automatically becomes populated with appropriate values.  Expand or collapse the tree as desired.  Select any two values and click "Merge" to specify a range, or select a previously merged value and click "Split" to restore the values contained within.  When satisfied with the ranges, click "OK" to begin processing the documents in the collection.  You can "Cancel" the dialog without making any changes to the collection.
    190179</p>
    191180
  • trunk/gli/help/7-9.htm

    r4293 r5284  
    1313      <font face="Verdana" size="5">
    1414      <strong>
    15 7.9 Metadata Sets
     157.9 Format Features
    1616      </strong>
    1717      </font>
     
    2525      <font face="Verdana" size="3">
    2626<p style="text-align:justify">
    27 This section explains the metadata sets sub-view.
     27Format commands control the structure and appearance of the collection.  They affect such things as where buttons appear when a document is shown, and what links are displayed by the DateList classifier.  Format commands are not easy to develop, and you should read Chapter 2 of the Greenstone Developer's Guide. This section discusses the format settings, and how the Librarian Interface gives access to them.  Under "Design Sections", click "Format".
    2828</p>
    2929
     
    6262                <td colspan="2">
    6363                  <font face="Verdana" size="4">
    64 Available metadata sets
     64Formatting
     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">
     75Add format command
     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">
     86Remove format command
     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">
     97Update format command
    6598                  </font>
    6699                  </a>
     
    83116      <font size="3">
    84117<p style="text-align:justify">
    85 The metadata sets sub-view is read-only. It is used to review what metadata sets have been imported, and what elements are available within that set. It contains a brief set of instructions in a scrollable text area at the top of the page. There are very few other controls. Choose a set from the list of available metadata sets in order to see details of the elements in that set.
     118You can apply a format command to anything in the "Choose Feature" pull-down list, which includes each classifier and a predefined list of features.  When you select a feature, there are two types of control.  Some features are simply enabled or disabled, and this is controlled by a checkbox.  Others require a format string to be specified.  For these there is a text area ("Edit Format String") for entering the string, a pull-down list ("Affected Component") for selecting which part of the feature the string applies to (if necessary), and a selection of predefined "Variables".  To insert a variable into the current position in the format string, select it from the pull-down list and click "Insert".
    86119</p>
    87120<p style="text-align:justify">
    88 The main use of this sub-view is to provide context for an element during a search and replace action, as described later in this help text.
     121You can specify a default format for a particular component by selecting the blank feature.  This format is then applied to all applicable features unless otherwise specified.
     122</p>
     123<p style="text-align:justify">
     124For more information about variables and the feature components, read Chapter 2 of the Greenstone Developer's Guide.
     125</p>
     126<p style="text-align:justify">
     127To add a new format command, fill out the information as explained above and click "Add Format".  The new format command appears in the list of "Currently Assigned Format Commands".  Only one format command can be assigned to each feature/component combination.
     128</p>
     129<p style="text-align:justify">
     130To remove a format command, select it from the list and click "Remove Format".
     131</p>
     132<p style="text-align:justify">
     133To change a format command, select it from the list, modify the settings, and click "Update Format".
    89134</p>
    90135
  • trunk/gli/help/8-0.htm

    r4293 r5284  
    2525      <font face="Verdana" size="3">
    2626<p style="text-align:justify">
    27 Your collection is ready to go. You have collected the documents for it, annotated them with metadata, designed how your collection will appear and specified what control options a user will have. You only have to feed this information to Greenstone and have it produce a finished collection. This chapter explains how to do this.
     27Having collected the documents for the collection, annotated them with metadata, and designed how the collection will appear, you can now produce the collection using Greenstone.  This chapter explains how.
    2828</p>
    2929
  • trunk/gli/help/8-1.htm

    r4293 r5284  
    1313      <font face="Verdana" size="5">
    1414      <strong>
    15 8.1 The 'Create' View
     158.1 The Create View
    1616      </strong>
    1717      </font>
     
    2525      <font face="Verdana" size="3">
    2626<p style="text-align:justify">
    27 This section explains the Create view, used to produce the collection.
     27This section explains the Create view used to produce a collection.
    2828</p>
    2929
     
    6262                <td colspan="2">
    6363                  <font face="Verdana" size="4">
    64 How to view the 'Create' viewOnly two tabs remained unexplored in the main control pane. The 'Create' view is used to create the collection by running the various Greenstone collection building scripts on the data you have collected and otherwise created. This is generally as straight-forward as clicking the [B]uild Collection button at the bottom of the screen. However, the Librarian Interface provides graphical access to Greenstone features, and here it is possible to customize the build process via arguments passed to Greenstone's PERL scripts. Moreover, this view is used to review details of previous attempts to build this collection, successful or otherwise.Apart from a brief status area stating the number of files in the collection and two buttons for building or canceling the building process, the bulk of this view is taken up by a group of controls titled 'Collection Import & Build Options'.  This contains a contents tree located to the left of the group, and a sub-view pane which reflects the currently chosen item in the tree.First look at the buttons at the bottom of the view. Clicking [B]uild Collection initiates the collection building process. The time this takes depends on the size of your collection and the number of indexes being created (for huge collections it can he hours). To cancel the building process at any time, click on the [C]ancel Build button. Cancelling the build does not damage the collection in any way other than ensuring that the remove_old flag is set within the import settings.
     64The Create view is used to create the collection by running Greenstone collection-building scripts on the information you have provided.  This is generally straightforward: just click "Build Collection" at the bottom of the screen.  However, the building process can be customized.  You can also use this view is to review details of previous attempts to build this collection, whether successful or not.The buttons for building and cancelling the building process are at the bottom. Above appears a group of controls titled "Collection Import & Build Options". To the left is a list of three items, and to the right is a pane that reflects the currently chosen item in the list, as described in the following sections.Clicking "Build Collection" initiates the collection building process.  The time this takes depends on the size of the collection and the number of indexes being created (for huge collections it can be hours).  To cancel the process at any time, click "Cancel Build".
    6565                  </font>
    6666                  </a>
  • trunk/gli/help/8-2.htm

    r4293 r5284  
    2525      <font face="Verdana" size="3">
    2626<p style="text-align:justify">
    27 This section explains how to access the various import and build settings.
     27This section explains how to access the various import and build settings. For more information of importing and building read Chapter 1 of the Greenstone Developer's Guide -- Understanding the collection-building process.
    2828</p>
    2929
     
    138138      <font size="3">
    139139<p style="text-align:justify">
    140 The first entry in the Option Groups tree is 'Import' settings. These settings are specific to the import script.  The second entry is 'Build' settings and apply only the build script.
     140The first two entries in the list on the left are "Import" and "Build", which give settings that apply to the import and build scripts respectively.
    141141</p>
    142142<p style="text-align:justify">
    143 Controlling the various settings is done in the same way as for the 'Configuring Arguments' dialog window described under "7.6 Plug-ins". There are two previously unseen controls: the Spinner and the CheckList.
    144 </p>
    145 <p style="text-align:justify">
    146 The spinner is like a text field in that you can type into it and use the checkbox to enable it. However, it only accepts numeric values, and only within a certain range. For instance, the verbosity argument only accepts values in the range 0-3 inclusive. The two small up and down arrows at the far right of the field, reminiscent of the controls on a vertical scroll bar, allow you to increment or decrement the value in the field.
    147 </p>
    148 <p style="text-align:justify">
    149 The CheckList control is the same as that used when selecting what metadata sets to include in a new collection. After you have enabled it by clicking on the checkbox next to the argument's name, you select the active values by checking the checkbox next to them. The list is scrollable because there may be many entries to review. Note that the selection highlight has no real effect other than indicating the last entry whose state you changed.
     143Controlling the various settings is done in the same way as for the "Configuring Arguments" window described under Section 7.3 -- Plug-Ins.  Some fields require numeric arguments, and you can either type these in or use the up and down arrows to increase or decrease the current value (in some cases, the interface restricts the range you can enter).  Others are enabled by clicking a checkbox (click again to disable).
    150144</p>
    151145
  • trunk/gli/help/8-3.htm

    r4293 r5284  
    8383      <font size="3">
    8484<p style="text-align:justify">
    85 The final entry in the Option Groups tree is 'Message Log'. This has little to do with the import and build arguments, but instead holds a record of the output generated from the Greenstone PERL scripts the last time the collection was built.  The text area contains three types of lines: Command, import.pl and buildcol.pl. Command lines show the exact command issued to the Greenstone script. Lines beginning 'import.pl>' come from the importing phase of the collection build, and those starting 'buildcol.pl' are from the building phase.
     85The third item on the left is "Message Log".  This shows the output that Greenstone generated when it built the collection before.  Select the log you want by clicking on the desired date in the "Log History" list.
    8686</p>
    8787
  • trunk/gli/help/8-4.htm

    r4293 r5284  
    1313      <font face="Verdana" size="5">
    1414      <strong>
    15 8.4 The 'Progress' View
     158.4 The Progress View
    1616      </strong>
    1717      </font>
     
    8383      <font size="3">
    8484<p style="text-align:justify">
    85 When you click the [B]uild Collection button, the view immediately changes. The controls described in the first section of this chapter are replaced by two progress bars and a text area. The progress bars indicate how much of the import phase, then build phase are complete. The current implementation shows only that work is progressing by offering an indeterminate progress bar (where a coloured band moves from left to right). Immediately below the progress bars in a scrollable text area which has the same general appearance as the Message Log explained in the previous section. However this log shows the messages for this build attempt. All of this display is for interest sake only.
    86 </p>
    87 <p style="text-align:justify">
    88 Whether the build process succeeds, fails or is cancelled, when it has completed the view returns to the original 'Create' view. If the attempt has failed, the Message Log will automatically be opened to the appropriate line.
     85When you start to build a collection, the view changes immediately.  The controls described in the first section of this chapter are replaced by two progress bars and a text area.  The bars indicate progress through the import phase, then the build phase.  The text area shows the Message Log mentioned in the previous section.
    8986</p>
    9087
  • trunk/gli/help/9-0.htm

    r4293 r5284  
    1313      <font face="Verdana" size="5">
    1414      <strong>
    15 9.0 Previewing Your Collection
     159.0 Previewing the Collection
    1616      </strong>
    1717      </font>
     
    2525      <font face="Verdana" size="3">
    2626<p style="text-align:justify">
    27 This chapter explains how to use the final view, the 'Preview', to inspect the freshly built collection.
     27This chapter explains how to use the "Preview" view to inspect the collection you have produced.
    2828</p>
    2929
  • trunk/gli/help/9-1.htm

    r4293 r5284  
    1313      <font face="Verdana" size="5">
    1414      <strong>
    15 9.1 The 'Preview' View
     159.1 The Preview View
    1616      </strong>
    1717      </font>
     
    2525      <font face="Verdana" size="3">
    2626<p style="text-align:justify">
    27 In this section we look at how to preview what our built collection will look like before we publish it.
     27This section explains how to use the "Preview" view to inspect the collection you have produced.
    2828</p>
    2929
     
    8383      <font size="3">
    8484<p style="text-align:justify">
    85 After you have successfully built a collection, the final tab on the main screen becomes enabled. This tab opens up the preview view so that you can inspect the collection. The pane itself is a simplified Web browser with initial page, and home page, set to the new collection's title page. The title page appears inside a scrollable pane. You can navigate the collection using standard hyperlink clicks. Some browser controls are also provided. The back button, far left, returns to the previous page, and become active as some as you click out of the initial screen. Next is the home button which returns you to the collection's title page. Third is the refresh button, which causes a new copy of the page to be loaded (rather than using an older version cached within the Librarian Interface), and is especially important for determining the effect of changing format statements.  Format statements are live: as soon as you change them Greenstone will begin to format the HTML pages returned using the new specifications. The forward button, on the far right, is used to 'undo' a back button click.
     85Once you have built a collection the "Preview" tab on the main screen becomes enabled.  This allows you to inspect the new collection.  It shows a simplified Web browser with initial page (and home page) set to the new collection's "About" page.  You can navigate the collection using standard hyperlink clicks.
    8686</p>
    8787
Note: See TracChangeset for help on using the changeset viewer.