Changeset 11596 for trunk/gli/help/en


Ignore:
Timestamp:
2006-04-06T14:27:46+12:00 (18 years ago)
Author:
kjdon
Message:

new xml format so that it can be used in the translator. basically the same as the old format, except that each para has <text> tags around it. Also, breaks are gone, references are changed.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/gli/help/en/help.xml

    r11091 r11596  
    11<Document>
    2   <Section name="introduction">
    3     <Title>Introduction</Title>
    4 The 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 a graphical point and click interface.
    5     <Section name="ofmiceandmenus">
    6       <Title>Of Mice and Menus</Title>
    7 This section provides basic information about interacting with the Librarian Interface.
    8 If you are familiar with programs such as Internet Explorer or Microsoft
    9 Office and are comfortable with mouse clicks and menus, skip to the <Reference target="howtoavoidthisdocument">next section</Reference>.
    10 <Break/>
    11 The Librarian Interface follows Microsoft Windows conventions and draws upon
    12 ordinary knowledge of Windows.
    13 <Break/>
    14 Any part of the screen that you interact with, such as a button or text field,
    15 is called a "control".  At any given time one control, called the "focus", is
    16 highlighted and responds to the keyboard.  Several controls allow you to select
    17 parts that are highlighted in dark blue.  Some controls are greyed out to
    18 indicate that they are disabled.
    19 <Break/>
    20 You can move and left- or right-click the mouse in the usual way.  Many
    21 components also allow you to "drag" them, by clicking and holding the left
    22 mouse button, move them with the mouse, and "drop" them elsewhere by releasing
    23 the button.  Potential drop targets alter their appearance when a component
    24 hovers over them.
    25 <Break/>
    26 You can use the keyboard to type into text fields.  Keyboard alternatives are
    27 available for many controls, indicated by a key name in square brackets -- for
    28 example, [Tab] alters the focus.  The plus sign shows if other keys must be
    29 pressed at the same time.
    30 <Break/>
    31 Buttons, like menus, have one character underlined.  To "click" the button,
    32 press [ALT] and the underlined character at the same time.
    33 <Break/>
    34 To access a menu, hold down [ALT] and press the corresponding letter
    35 (underlined).  For example, for the "File" menu press [ALT] + [F].  To choose an
    36 item, press the corresponding key.  For example, while in the File menu
    37 press [S] to "Save" a collection.
    38 <Break/>
    39 Exit the Librarian Interface program by choosing "Exit" from the "File"
    40 menu.  Your collection will be saved first.
    41     </Section>
    42     <Section name="howtoavoidthisdocument">
    43       <Title>How to Avoid Reading This Document</Title>
    44       Don't read this help text all the way through!  Just read enough to learn
    45       how to get help when you need it.
    46       <Break/>
    47       The "Help" menu item marks what may be the most appropriate help item with a little book icon.
    48       <Break/>
    49       For many controls, if you station the mouse over them a "tool tip" appears that says what they do.
    50       <Break/>
    51       Before using the Librarian Interface, first read the Greenstone documentation.
    52     </Section>
    53   </Section>
    54  
    55   <Section name="startingoff">
    56     <Title>Starting Off</Title>
    57     This section covers how to create, load, save and delete collections.
    58     <Section name="creatingacollection">
    59       <Title>Creating a New Collection</Title>
    60 To create a new collection, open the "File" menu and choose "New".  Several
    61 fields need to be filled out -- but you can change their values later if you
    62 need to, in the design view.
    63 <Break/>
    64 "Collection title" is the text displayed at the top of your collection's home page.  It can
    65 be any length.
    66 <Break/>
    67 "Description of content"
    68 should describe, in as much detail as possible, what the collection is about.
    69 Use the [Enter] key to break it into paragraphs.
    70 <Break/>
    71 Finally you must specify whether the new collection will have the same
    72 appearance and metadata sets as an existing collection, or whether to start a
    73 default "New Collection".
    74 <Break/>
    75 Click "OK" to create the collection.  If you chose "New Collection" you are
    76 prompted for the metadata sets to use in it.  You can choose more than one, and
    77 you can add others later.
    78 <Break/>
    79 Clicking "Cancel" returns you to the main screen immediately.
    80     </Section>
    81     <Section name="savingacollection">
    82       <Title>Saving the Collection</Title>
    83 Save your work regularly by opening the "File" menu and choosing "Save".
    84 Saving a collection is not the same as making it ready for use in Greenstone
    85 (see <Reference target="producingthecollection">Producing Your Collection</Reference>).
    86 <Break/>
    87 The Librarian Interface protects your work by saving it whenever you exit the
    88 program or load another collection.
    89 <Break/>
    90 Saved collections are written to a file named for the collection and with file
    91 extension ".col", located in a folder of the same name within your Greenstone
    92 installation's "collect" folder.
    93     </Section>
    94     <Section name="openingacollection">
    95       <Title>Opening an Existing Collection</Title>
    96 To open an existing collection, choose "Open" from the "File" menu to get the
    97 Open Collection prompt.  A list of your Greenstone collections appears.
    98 Select one to see its description, and click "Open" to load it.  If you seek a
    99 collection that resides outside Greenstone's "collect" folder, click "Browse"
    100 for a file system browsing dialog.
    101 <Break/>
    102 In case more than one Greenstone Librarian Interface program is running
    103 concurrently, the relevant directories are "locked" to prevent interference.
    104 On opening a collection, a small temporary lock file is created in its
    105 folder.  Before opening a collection, the Librarian Interface checks to ensure
    106 that no lock file already exists.  You can tell whether a collection is locked
    107 by the colour of its icon: green for a normal collection, red for a locked
    108 one.  However, when the Librarian Interface is exited prematurely the lock file
    109 is sometimes left in place.  When you open such a collection, the Librarian asks
    110 if you want to "steal" control of it.  Never steal a collection that someone
    111 else is currently working on.
    112 <Break/>
    113 When you open a collection that the Greenstone Librarian Interface did
    114 not create, you will be asked to select a metadata set (or sets).  If
    115 none are selected, any existing metadata will be ignored. Otherwise,
    116 metadata will be imported just as it is when you drag in files with
    117 existing metadata. The process is described in the <Reference target="importingpreviouslyassignedmetadata">Importing Previously Assigned Metadata</Reference> section.
    118     </Section>
    119     <Section name="deletingcollections">
    120       <Title>Deleting Collections</Title>
    121 To permanently delete collections from your Greenstone installation, choose "Delete..." from the "File" menu. A list of your Greenstone collections appears. Select one to see its description, then tick the box at the bottom of the dialog and click "Delete" to delete the collection. This action is irreversible, so check carefully that you no longer need the collection before proceeding!
    122     </Section>
    123   </Section>
    124 
    125  <Section name="downloadingfiles">
    126     <Title>Downloading Files From the Internet</Title>
    127 The "Download" view helps you download resources from the internet. This section explains the Librarian Interface's mirroring process.
    128     <Section name="themirrorview">
    129       <Title>The Download view</Title>
    130 This section describes how to configure a download task and control the downloading process.
    131 Access the "Download" view by clicking its tab. The top half of the screen shows the downloading controls. The bottom half is initially empty, but will show a list of pending and completed downloading jobs.
    132 <Break/>
    133 Files are downloaded into a folder in the workspace called "Downloaded Files" (only present when mirroring is enabled), and can be used in all collections built with the Librarian Interface.  Files in this area 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.
    134 <Break/>
    135 Use the first of the download configuration controls, "Source URL", to enter the URL of a target resource. Use the "Download Depth" control to limit how many  hyperlinks to follow when downloading: Set this to 0 to download a single web page; set it to 1 to download a page and all the pages it points to. The depth limit is ignored when downloading media other than html pages. Next, there are several checkbox controls which can be set to turn on the specified feature for a specific download. Once the configuration is set up, click "Download" to start the new download job. There are two other button controls: "Preferences", which links to the connection section of the Preferences where proxy settings can be edited; and "Clear Cache", which deletes all previously downloaded files.
    136 <Break/>
    137 The download list has an entry for each web page download.  Each entry has a text region that gives details of the task along with a progress bar showing current activity. Three buttons appear to the left of each entry. "Pause" is used for pausing a currently downloading task. "View Log" opens a window showing the download log file. "Close" terminates the download and removes the task from the list. 
    138 <Break/>
    139 The <Reference target="preferences">Preferences section</Reference> 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.
    140     </Section>
    141   </Section>
    142 
    143   <Section name="collectingfiles">
    144     <Title>Collecting Files for Your Collection</Title>
    145 Once you have a new collection you need to get some files into it.  These may
    146 come from your ordinary file space, or from other Greenstone collections.  Some
    147 may already have attached metadata.  This section describes how to import files.
    148     <Section name="thegatherview">
    149       <Title>The Gather View</Title>
    150 This section introduces the Gather area that you use to select what files
    151 to include in the collection you are building.
    152 The Librarian Interface starts with the Gather view.  To return to this view
    153 later, click the "Gather" tab directly below the menu bar.
    154 <Break/>
    155 The two large areas titled "Workspace" and "Collection" are used to move files
    156 into your collection.  They contain "file trees", graphical structures that
    157 represent files and folders.
    158 <Break/>
    159 Select an item in the tree by clicking it.  (There are other ways; see below.)
    160 Double-click a folder, or single-click the switch symbol beside it, to expand (or collapse)
    161 its contents.  Double-click a file to open it using its associated application
    162 program (see <Reference target="fileassociations">File Associations</Reference>).
    163 <Break/>
    164 The 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 cache of downloaded files. You can copy and view these files but you cannot move, delete, or edit them, with the exception of the downloaded files, which can be deleted.  Navigate this space to find the files you want to include in the collection.
    165 <Break/>
    166 The Collection file tree represents the contents of the collection so
    167 far.  Initially, it is empty.
    168 <Break/>
    169 You can resize the spaces by mousing over the grey bar that separates the trees
    170 (the shape of the pointer changes) and dragging.
    171 <Break/>
    172 At the bottom of the window is a status area that shows the progress of actions involving files (copying, moving and deleting). These can take some time to complete. The "Stop" button stops any action that is currently in progress.
    173 <Break/>
    174 Two large buttons occupy the lower right corner of the screen. "New Folder", with a picture
    175 of a folder, creates new folders (see <Reference target="creatingfolders">Creating folders</Reference>).
    176 "Delete", with a garbage can, removes files. Clicking the Delete button will remove any selected files from the Collection file tree. Alternatively, files can be deleted by dragging them onto the Delete button.
    177 <Break/>
    178 To select several sequential items, select the first and then hold down [Shift]
    179 and click on the last -- the selection will encompass all intervening
    180 items.  Select non-sequential files by holding down [Ctrl] while clicking.  Use
    181 these two methods together to select groups of non-adjacent items.
    182 <Break/>
    183 Certain folders -- such as the one containing your own web pages -- sometimes
    184 have special significance.  The Librarian Interface can map such folders to
    185 the first level of the file tree.  To do this, right-click the desired
    186 folder.  Select "Create Shortcut", and enter a name for the folder.  To remove an item,
    187 right-click the mapped folder and select "Remove Shortcut".
    188     </Section>
    189     <Section name="creatingfolders">
    190       <Title>Creating Folders</Title>
    191 Use folders in the Collection file tree to group files together and make them
    192 easier to find.  Folders can be placed inside folders.  There is virtually no
    193 limit to how many folders you can have or how deeply they can be nested.
    194 <Break/>
    195 To create a new folder, optionally select an existing folder in the Collection
    196 Tree and click the New Folder button.  The new folder appears within the
    197 selected one, or at the top level if none is selected.  You are prompted for the
    198 folder's name (default "New Folder").
    199 <Break/>
    200 Folders can also be created by right-clicking over a folder, choosing "New
    201 Folder" and proceeding as above.
    202     </Section>
    203 
    204 
    205     <Section name="addingfiles">
    206       <Title>Adding Files</Title>
    207 Files can be copied into the collection by dragging and dropping.  The mouse
    208 pointer becomes a ghost of the selected item (or, if more than one is selected,
    209 the number of them).  Drop the selection into the Collection Tree to copy the
    210 files there (if the source was the Workspace Tree) or move them around within
    211 the collection (if the source was the Collection Tree).
    212 <Break/>
    213 When copying multiple files, they are all placed in the target folder at the
    214 same level, irrespective of the folder structure they occupied originally.
    215 When you copy a second file with the same name into the same folder, you are
    216 asked whether to overwrite the first one.  Respond "No" and the file will not be
    217 copied, but the others will be.  To cancel all remaining copy actions, click the
    218 "stop" button.
    219 <Break/>
    220 Only the "highest" items in a selection are moved.  A folder is higher than its
    221 children.  You cannot select files within a folder and also the folder itself.
    222 <Break/>
    223 When you add a file, the Librarian Interface searches through the source
    224 folders for auxiliary files containing metadata previously assigned to the
    225 added file and, if it finds one, begins to import this metadata.  As the
    226 operation proceeds, you may be prompted (perhaps several times) for extra
    227 information to match the imported metadata to the metadata sets in your
    228 collection.  This process involves many different prompts, described in the <Reference target="importingpreviouslyassignedmetadata">Importing Previously Assigned Metadata</Reference> section.  For a more detailed
    229 explanation of associating metadata with files read Chapter 2 of the Greenstone
    230 Developer's Guide -- Getting the most out of your documents.
    231     </Section>
    232     <Section name="removingfiles">
    233       <Title>Removing Files</Title>
    234 There are several methods for removing files and folders.  You must first
    235 indicate what items to remove by selecting one or more files and folders as
    236 described in <Reference target="thegatherview">The Gather View</Reference>.
    237 <Break/>
    238 Once files have been selected, click the "delete" button to remove them, or
    239 press the [Delete] key on your keyboard, or drag them from the collection to
    240 the delete button and drop them there.
    241     </Section>
    242     <Section name="filteringthetree">
    243       <Title>Filtering the Tree</Title>
    244 "Filtering" the collection tree allows you to narrow down the search for particular files.
    245       <Break/>
    246 The "Show Files" pull-down menu underneath each tree shows a list of predefined
    247 filters, such as "Images".  Choosing this temporarily hides all other files in
    248 the tree.  To restore the tree, change the filter back to "All Files".  These
    249 operations do not alter the collection, nor do they affect the folders in the
    250 tree.
    251 <Break/>
    252 You can specify a custom filter by typing in a pattern to match files against (Librarian Systems Specialist and Expert modes only).
    253 Use standard file system abbreviations such as "*.*" or "*.doc" ("*" matches
    254 any characters).
    255     </Section>
    256   </Section>
    257 
    258   <Section name="enrichingacollection">
    259     <Title>Enriching the Collection with Metadata</Title>
    260 Having gathered several files into the collection, now enrich them with
    261 additional information called "metadata".  This section explains how metadata is
    262 created, edited, assigned and retrieved, and how to use external metadata
    263 sources (also see Chapter 2 of the Greenstone Developer's Guide -- Getting the most
    264 out of your documents).
    265     <Section name="theenrichview">
    266       <Title>The Enrich View</Title>
    267 Use the Enrich view to assign metadata to the documents in the collection.
    268 Metadata is data about data -- typically title, author, creation date, and so
    269 on.  Each metadata item has two parts: "element" tells what kind of item it is
    270 (such as author), and "value" gives the value of that metadata element (such as
    271 the author's name).
    272 <Break/>
    273 On the left of the "Enrich" view is the Collection Tree. To the right is the Metadata Table, which shows metadata for any selected files or folders in the Collection Tree.  Columns are named in
    274 grey at the top, and can be resized by dragging the separating line. If several files are selected, black text indicates that the value is common to all of the
    275 selected files, while grey text indicates that it is not.  Black values may be
    276 updated or removed, while grey ones can be removed from those that have it, or
    277 appended to the others.
    278 <Break/>
    279 A folder icon may appear beside some metadata entries.  This indicates that the
    280 values are inherited from a parent (or ancestor) folder.  Inherited metadata
    281 cannot be edited or removed, only appended to or overwritten.  Click on the
    282 folder icon to go immediately to the folder where the metadata is assigned.
    283 <Break/>
    284 Clicking on a metadata element in the table will display the existing values for that element in the "Existing values for..." area below the table. The Value Tree expands and collapses.  Usually it is a list that shows all
    285 values entered previously for the selected element.  Clicking an entry
    286 automatically places it into the value field.  Conversely, typing in the text
    287 field selects the Value Tree entry that starts with the characters you have
    288 typed.  Pressing [Tab] auto-completes the typing with the selected value.
    289 <Break/>
    290 Metadata values can be organised into a hierarchy. This is shown in the Value Tree using folders for internal levels. Hierarchical values can be entered using the character "|" to separate the levels.  For
    291 example, "Cards|Red|Diamonds|Seven" might be used in a hierarchy that represents a pack of playing cards. This enables values to be grouped together. Groups can also be assigned as metadata to files.
    292 <Break/>
    293 Greenstone extracts metadata automatically from documents into a metadata set
    294 whose elements are prefixed by "ex.".  This has no value tree and cannot be
    295 edited.
    296     </Section>
    297     <Section name="selectingmetadatasets">
    298       <Title>Selecting Metadata Sets</Title>
    299 Sets of predefined metadata elements are known as "metadata sets".  An example
    300 is the Dublin Core metadata set.  When you add a metadata set to your
    301 collection, its elements become available for selection.  You can have more than
    302 one set; to prevent name clashes a short identifier that identifies the
    303 metadata set is pre-pended to the element name.  For instance the Dublin Core
    304 element Creator becomes "dc.Creator".  Metadata sets are stored in the
    305 Librarian Interface's metadata folder and have the suffix ".mds".
    306 <Break/>
    307 To control the metadata sets used in a collection, use the "Metadata Sets" entry on the Design view.
    308     </Section>
    309     <Section name="appendingmetadata">
    310       <Title>Appending New Metadata</Title>
    311 We now add a metadata item -- both element and value -- to a file.  First select
    312 the file from the Collection file tree on the left.  The action causes any
    313 metadata previously assigned to this file to appear in the table at the right.
    314 <Break/>
    315 Next select the metadata element you want to add by clicking its row in the
    316 table.
    317 <Break/>
    318 Type the value into the value field.  Use the "|" character to add structure, as described in <Reference target="theenrichview">The Enrich View</Reference>. Pressing the [Up] or [Down] arrow keys will save the metadata value and move the selection appropriately. Pressing [Enter] will save the metadata value and create a new empty entry for the metadata element, allowing you to assign multiple values to a metadata element.
    319 <Break/>
    320 You can also add metadata to a folder, or to several multiply selected files at
    321 once.  It is added to all files within the folder or selection, and to child
    322 folders.  Keep in mind that if you assign metadata to a folder, any new files in
    323 it automatically inherit the folder's values.
    324     </Section>
    325     <Section name="addingpreviouslydefinedmetadata">
    326       <Title>Adding Previously Defined Metadata</Title>
    327 To add metadata that has an existing value, first select the file, then select
    328 the required value from the value tree, expanding hierarchy folders as
    329 necessary.  The value of the selected entry automatically appears in the Value
    330 field (alternatively, use the value tree's auto-select and auto-complete
    331 features).
    332 <Break/>
    333 The process of adding metadata with already-existing values to folders
    334 or multiple files is just the same.
    335     </Section>
    336     <Section name="updatingmetadata">
    337       <Title>Editing or Removing Metadata</Title>
    338 To edit or remove a piece of metadata, first select the appropriate file, and then the metadata value from the table. Edit the value field, deleting all text if you wish to remove the metadata.
    339 <Break/>
    340 The process is the same when updating a folder with child folders or multiple files, but you can only update metadata that is common to all files/folders selected.
    341 <Break/>
    342 The value tree shows all currently assigned values as well as previous values for the current session, so changed or deleted values will remain in the tree. Closing the collection and then re-opening it will remove the values which are no longer assigned.
    343     </Section>
    344     <Section name="reviewingmetadata">
    345       <Title>Reviewing Assigned Metadata</Title>
    346 Sometimes you need to see the metadata assigned to many or all files at once -- for instance,
    347 to determine how many files are left to work on, or to get some idea of the
    348 spread of dates.
    349 <Break/>
    350 Select the files you wish to examine, then right-click and choose "Assigned Metadata...". A window called
    351 "All Metadata", dominated by a large table with many columns, appears.  The
    352 first column shows file names; the rows show all metadata values assigned to
    353 those files.
    354 <Break/>
    355 Drawing the table can take some time if many files are selected.  You can continue to use the Librarian
    356 Interface while the "All Metadata" window is open.
    357 <Break/>
    358 When it gets too large, you can filter the "All Metadata" table by applying
    359 filters to the columns.  As new filters are added, only those rows that match
    360 them remain visible.  To set, modify or clear a filter, click on the "funnel"
    361 icon at the top of a column.  You are prompted for information about the filter.
    362 Once a filter is set, the column header changes colour.
    363 <Break/>
    364 The prompt has a "Simple" and an "Advanced" tab.  The Simple version filters
    365 columns so that they only show rows that contain a certain metadata value ("*"
    366 matches all values).  You can select metadata values from the pull-down list.
    367 The Advanced version allows different matching operations: must start with,
    368 does not contain, alphabetically less than and is equal to.  The value to be
    369 matched can be edited to be any string (including "*"), and you can choose
    370 whether the matching should be case insensitive.  Finally, you can specify a
    371 second matching condition that you can use to specify a range of values (by
    372 selecting AND) or alternative values (by selecting OR).  Below this area is a
    373 box that allows you to change the sort order (ascending or descending).  Once
    374 you have finished, click "Set Filter" to apply the new filter to the column.
    375 Click "Clear Filter" to remove a current filter.  Note that the filter details
    376 are retained even when the filter is cleared.
    377 <Break/>
    378 For example, to sort the "All Metadata" table, choose a column, select the
    379 default filter setting (a Simple filter on "*"), and choose ascending or
    380 descending ordering.
    381     </Section>
    382     <Section name="importingpreviouslyassignedmetadata">
    383       <Title>Importing Previously Assigned Metadata</Title>
    384 This section describes how to import previously assigned metadata: metadata assigned to documents before they were added to the collection.
    385       <Break/>
    386 If metadata in a form recognized by the Librarian Interface has been previously
    387 assigned to a file -- for example, when you choose documents from an existing
    388 Greenstone collection -- it is imported automatically when you add the file.
    389 To do this, the metadata must be mapped to the metadata sets available in the
    390 collection.
    391 <Break/>
    392 The Librarian Interface prompts for the necessary information.  The prompt
    393 gives brief instructions and then shows the name of the metadata element that
    394 is being imported, just as it appears in the source file.  This field cannot be
    395 edited or changed.  Next you choose what metadata set the new element should map
    396 to, and then the appropriate metadata element in that set.  The system
    397 automatically selects the closest match, in terms of set and element, for the
    398 new metadata.
    399 <Break/>
    400 Having checked the mapping, you can choose "Add" to add the new metadata
    401 element to the chosen metadata set.  (This is only enabled if there is no
    402 element of the same name within the chosen set.) "Merge" maps the new element
    403 to the one chosen by the user.  Finally, "Ignore" does not import any metadata
    404 with this element name.  Once you have specified how to import a certain piece of metadata, the mapping
    405 information is retained for the collection's lifetime.
    406 <Break/>
    407 For details on the metadata.xml files which Greenstone uses to store the metadata, see Chapter 2 of the Greenstone
    408 Developer's Guide -- Getting the most out of your documents.
    409     </Section>
    410   </Section>
    411 
    412   <Section name="designingacollection">
    413     <Title>Designing Your Collection's Appearance</Title>
    414 Once your files are marked up with metadata, you next decide how it should
    415 appear to users as a Greenstone collection.  What kind of information is
    416 searchable?  What ways are provided to browse through the documents?  What
    417 languages are supported?  Where do the buttons appear on the page?  These
    418 things can be customized; this section describes how to do it.
    419     <Section name="thedesignview">
    420       <Title>The Design View</Title>
    421 This section introduces you to the design view and explains how to navigate
    422 between the various views within this pane.
    423 <Break/>
    424 With the Librarian Interface, you can configure how the collection appears to
    425 the user.  The configuration options are divided into different sections, each
    426 associated with a particular stage of navigating or presenting information.
    427 <Break/>
    428 On the left is a list of different views, and on the right are the controls
    429 associated with the current one.  To change to a different view, click its name
    430 in the list.
    431 <Break/>
    432 To understand the stages and terms involved in designing a collection, first
    433 read Chapters 1 and 2 of the Greenstone Developer's Guide.
    434     </Section>
    435     <Section name="generalsettings">
    436       <Title>General</Title>
    437 This section explains how to review and alter the general settings associated
    438 with your collection.  First, under "Design Sections", click "General".
    439       <Break/>
    440 Here the values provided during collection creation can be modified.
    441 <Break/>
    442 First are the contact emails of the collection's creator and maintainer. 
    443 The following field allows you to change the collection title. The folder that the collection is stored in is shown next, but this cannot be edited.
    444 The next one specifies (in the form of a URL) the
    445 icon to show at the top left of the collection's "About" page, and the next is
    446 the icon used in the Greenstone library page to link to the collection. Then, a checkbox controls whether the collection should be publicly accessible.
    447 Finally comes the "Collection Description" text area as described in <Reference target="creatingacollection">Creating A New Collection</Reference>.
    448     </Section>
    449     <Section name="plugins">
    450       <Title>Document Plugins</Title>
    451 This section describes how to configure the document plugins the
    452 collection uses.  It explains how you specify what
    453 plugins to use, what parameters to pass to them, and in what order
    454 they occur.  Under "Design Sections", click "Document Plugins".
    455       <Break/>
    456 To add a plugin, select it using the "Select plugin to add" pull-down list near the
    457 bottom and then click "Add Plugin".  A window appears entitled
    458 "Configuring Arguments"; it is described later.  Once you have configured the
    459 new plugin, it is added to the end of the "Currently Assigned Plugins" list.
    460 Note that, except for UnknownPlug, each plugin may only occur once in the list.
    461 <Break/>
    462 To remove a plugin, select it in the list and click "Remove Plugin".
    463 <Break/>
    464 Plugins are configured by providing arguments.  To alter them, select the
    465 plugin from the list and click "Configure Plugin" (or double-click
    466 the plugin). A "Configuring Arguments" dialog appears with various controls for specifying arguments.
    467 <Break/>
    468 There are different kinds of controls.  Some are checkboxes, and clicking one
    469 adds the appropriate option to the plugin.  Others are text strings, with a
    470 checkbox and a text field.  Click the box to enable the argument, then type
    471 appropriate text (regular expression, file path etc) in the box.  Others are
    472 pull-down menus from which you can select from a given set of values.  To learn what an
    473 argument does, let the mouse hover over its name for a moment and a description
    474 will appear.
    475 <Break/>
    476 When you have changed the configuration, click "OK" to commit the changes and
    477 close the dialog, or "Cancel" to close the dialog without changing any plugin
    478 arguments.
    479 <Break/>
    480 The plugins in the list are executed in order, and the ordering is sometimes
    481 important. The order of the plugins can be changed in Library Systems Specialist and Expert modes only (see <Reference target="preferences">Preferences</Reference>).   
    482     </Section>
    483     <Section name="searchtypes">
    484       <Title>Search Types</Title>
    485 This section explains how to modify a new design feature in Greenstone, Search Types, which allow fielded searching. The search types specify what kind of search interface should be provided: form, for fielded searching, and/or plain for regular searching.  Under "Design Sections", click "Search Types".
    486       <Break/>
    487 When you enter the Search Types view, first check "Enable Advanced Searches", which activates the other controls. This changes the collection to use an indexing mechanism that allows fielded searching. Index specification is slightly different in this mode. (When switching between standard and advanced searching, the GLI does its best to convert the index specification, but may not get it completely right.)
    488 <Break/>
    489 To add a search type, select it from the "Search Types" list and click "Add Search Type".  Each type can only appear in the list once. The first search type will be the default, and will appear on the search page of the built collection. Any others will be selectable from the preferences page.
    490 <Break/>
    491 To remove a search type, select it from the "Currently Assigned Search Types"
    492 list and click "Remove Search Type".  The list must contain at least
    493 one search type.
    494     </Section>
    495     <Section name="searchindexes">
    496       <Title>Search Indexes</Title>
    497 Indexes 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".
    498       <Break/>
    499 To add an index, type a name for it into the "Index Name" field.  Select which
    500 of the possible information sources to index by clicking the checkboxes beside
    501 them.  The list shows all the assigned metadata elements, as well the full
    502 text.  Having selected the data sources, choose the granularity of the index,
    503 using the "At the level" menu.  Once these details are complete, "Add Index"
    504 becomes active (unless there is an existing index with the same settings).
    505 Click it to add the new index.
    506 <Break/>
    507 To edit an index, select it and change the index details, then click "Replace Index".
    508 <Break/>
    509 To remove an index, select it from the list of assigned indexes and click
    510 "Remove Index".
    511 <Break/>
    512 To create an index covering text and all metadata, click "Add All".
    513 <Break/>
    514 The default index, the one used on the collection's search page, is tagged with
    515 "[Default Index]" in the "Assigned Indexes" list.  To set it, select an index
    516 from the list and click "Set Default".
    517 <Break/>
    518 If advanced searching is enabled (via the Search Types view), the index controls are different.  There is a new pseudo-data source "allfields" which provides searching across all specified indexes at once.  Levels are not
    519 assigned to a specific index, but apply across all indexes: thus indexes and
    520 levels are added separately. "Add All" creates a separate index for each metadata field in this mode.
    521 <Break/>
    522 The name of each index will default to the source name. To change the name, select an index, change its details, and click "Replace Index".
    523     </Section>
    524     <Section name="partitionindexes">
    525       <Title>Partition Indexes</Title>
    526 Indexes are built on particular text or metadata sources.  The search space can
    527 be further controlled by partitioning the index, either by language or by a
    528 predetermined filter.  This section describes how to do this.  Under "Design
    529 Sections", click "Partition Indexes".
    530 <Break/>
    531 The "Partition Indexes" view has three tabs; "Define Filters", "Assign
    532 Partitions" and "Assign Languages".  To learn more about partitions read about
    533 subcollections and subindexes in Chapter 2 of the Greenstone Developer's Guide.
    534 <Break/>
    535 The Partition Indexes screen is only enables in Library Systems Specialist and Expert modes (see <Reference target="preferences">Preferences</Reference>). Note that the total number of partitions generated is a combination of all indexes, subcollection filters and languages chosen. Two indexes with two subcollection filters in two languages would yield eight index partitions.
    536       <Section name="definefilters">
    537         <Title>Define Filters</Title>
    538 Filters allow you to group together into a subcollection all documents in an
    539 index for which a metadata value matches a given pattern.
    540 <Break/>
    541 To create a filter, click the "Define Filters" tab and enter a name for the
    542 new filter into the "Subcollection filter name:" field.  Next choose a
    543 document attribute to match against, either a metadata element or the name of
    544 the file in question.  Enter a regular expression to use during the matching.
    545 You can toggle between "Including" documents that match the filter, or
    546 "Excluding" them.  Finally, you can specify any of the standard PERL regular
    547 expression flags to use when matching (e.g.  "i" for case-insensitive matching).
    548 Finally, click "Add Filter" to add the filter to the "Defined Subcollection Filters"
    549 list.
    550 <Break/>
    551 To remove a filter, select it from the list and click "Remove Filter".
    552 <Break/>
    553 To alter a filter, select it from the list, change any of the values that
    554 appear in the editing controls and click "Replace Filter" to commit the changes.
    555       </Section>
    556       <Section name="assignpartitions">
    557         <Title>Assign Partitions</Title>
    558 Having defined a subcollection filter, use the "Assign Partitions" tab to build
    559 indexes for it (or for a group of filters).  Select the desired filter (or
    560 filters) from the "Defined Subcollection Filters" list, enter a name for your partition in the "Partition Name" field,  and click "Add Partition".
    561 <Break/>
    562 To remove a partition, select it from the list and click "Remove Partition".
    563 <Break/>
    564 To make a partition the default one, select it from the list and click "Set
    565 Default".
    566       </Section>
    567       <Section name="assignlanguages">
    568         <Title>Assign Languages</Title>
    569 This section details how to restrict search indexes to particular languages.
    570 You do this by generating a partition using the "Assign Languages" tab of the
    571 "Partition Indexes" view.
    572     <Break/>
    573 To add a new language to partition by, use the "Assign Languages" tab to build
    574 an index for it.  Select the desired language from the "Language to add"
    575 pull-down list and click "Add Language".
    576 <Break/>
    577 To remove a language, select it from the "Language Selection" list and click
    578 "Remove Language".
    579 <Break/>
    580 To set the default language, select it from the list and click "Set Default".
    581       </Section>
    582     </Section>
    583     <Section name="xcollectionsearching">
    584       <Title>Cross-Collection Search</Title>
    585 Greenstone can search across several different collections as though they were
    586 one. This is done by specifying a list of other collections to be searched along with the current one.  Under "Design Sections", click "Cross-Collection Search".
    587       <Break/>
    588 The Cross-Collection Search view shows a checklist of available collections.  The
    589 current collection is ticked and cannot be deselected.  To add another
    590 collection to be searched in parallel, click it in the list (click again to
    591 remove it).  If only one collection is selected, there is no cross-collection
    592 searching.
    593 <Break/>
    594 If the individual collections do not have the same indexes (including subcollection partitions and language partitions) as each other, cross-collection searching will not work properly. The user will only be able to search using indexes common to all collections.
    595 <Break/>
    596 For further details, see Chapter 1 of the Greenstone Developer's Guide.
    597     </Section>
    598     <Section name="classifiers">
    599       <Title>Browsing Classifiers</Title>
    600 This section explains how to assign "classifiers", which are used for browsing,
    601 to the collection.  Under "Design Sections", click "Browsing Classifiers".
    602       <Break/>
    603 To add a classifier, select it using the "Select classifier to add" pull-down list near the
    604 bottom and then click "Add Classifier".  A window appears entitled
    605 "Configuring Arguments"; instructions for this dialog are just the same as for
    606 plugins (see <Reference target="plugins">Document Plugins</Reference>).  Once you have configured the new
    607 classifier, it is added to the end of the "Currently Assigned Classifiers"
    608 list.
    609 <Break/>
    610 To remove a classifier, select it from the list and click "Remove Classifier".
    611 <Break/>
    612 To change the arguments a classifier, select it from the list and click
    613 "Configure Classifier" (or double-click on the classifier in the
    614 list).
    615 <Break/>
    616 The ordering of classifiers in the collection's navigation bar is reflected in
    617 their order here.  To change it, select the classifier you want to move and
    618 click "Move Up" or "Move Down".
    619 <Break/>
    620 For further information on classifiers read Chapter 2, Greenstone
    621 Developer's Guide -- Getting the most out of your documents.
    622     </Section>
    623     <Section name="formatstatements">
    624       <Title>Format Features</Title>
    625 The web pages you see when using Greenstone are not pre-stored but are generated 'on the fly' as they are needed. Format commands are used to change the appearance of these generated pages. They affect such things as where buttons appear when a document is shown, and what
    626 links are displayed by the DateList classifier.  Format commands are not easy
    627 to develop, and you should read Chapter 2 of the Greenstone Developer's Guide.
    628 This section discusses the format settings, and how the Librarian Interface
    629 gives access to them.  Under "Design Sections", click "Format Features".
    630       <Break/>
    631 You can apply a format command to anything in the "Choose Feature" pull-down
    632 list, which includes each classifier and a predefined list of features.  When
    633 you select a feature, there are two types of control.  Some features are simply
    634 enabled or disabled, and this is controlled by a checkbox.  Others require a
    635 format string to be specified.  For these there is a pull-down list ("Affected
    636 Component") for selecting which part of the feature the string applies to
    637 (if necessary), a text area ("HTML Format String") for entering the string,
    638 and a selection of predefined "Variables".  To insert a variable into the
    639 current position in the format string, select it from the pull-down list and
    640 click "Insert".
    641 <Break/>
    642 You can specify a default format for a particular component by selecting the
    643 blank feature.  This format is then applied to all applicable features unless
    644 otherwise specified.
    645 <Break/>
    646 To add a new format command, fill out the information as explained above and
    647 click "Add Format".  The new format command appears in the list of "Currently
    648 Assigned Format Commands".  Only one format command can be assigned to each
    649 feature/component combination.
    650 <Break/>
    651 To remove a format command, select it from the list and click "Remove Format".
    652 <Break/>
    653 To change a format command, select it from the list, modify the settings, and
    654 click "Replace Format".
    655 <Break/>
    656 For more information about variables and the feature components, read Chapter 2
    657 of the Greenstone Developer's Guide.
    658 <Break/>
    659 If the "Allow Extended Options" checkbox is ticked, some advanced formatting options are enabled. The list of features that can be formatted is changed slightly, and more variables are available to be used in the format command, providing greater control over the page layout.
    660     </Section>
    661     <Section name="translatetext">
    662       <Title>Translate Text</Title>
    663 This section describes the translation view, where you can define
    664 language-specific text fragments for parts of the collection's interface.
    665 Under "Design Sections", click "Translate Text".
    666       <Break/>
    667 First choose an entry from the "Features" list.  The language-specific
    668 strings associated with this feature appear below.  Use the "Language of
    669 translation" pull-down list to select the target language, and type the
    670 translated text into the text area, referring to the "Initial Text Fragment" if
    671 necessary.  Click "Add Translation" when finished.
    672 <Break/>
    673 To remove an existing translation, select it in the "Assigned Translations"
    674 table and click "Remove Translation".
    675 <Break/>
    676 To edit a translation, select it, edit it in the "Translated Text" text
    677 area, and click "Replace Translation".
    678     </Section>
    679     <Section name="metadatasets">
    680       <Title>Metadata Sets</Title>
    681 This section explains the metadata set review panel.
    682 Under "Design Sections", click "Metadata Sets".
    683       <Break/>
    684 This view is used to review the metadata sets that the collection uses, and the
    685 elements that are available within each set.  Choose from the list of "Available
    686 Metadata Sets" in order to see details of their elements.
    687 <Break/>
    688 To use another metadata set with the loaded collection, click "Add Metadata Set" and select the metadata set file (.mds) for the new metadata set.
    689 <Break/>
    690 Editing metadata sets is done with the Greenstone Editor for Metadata Sets (GEMS). Clicking the "Edit Metadata Set" button provides information on how to run the GEMS.
    691 <Break/>
    692 If you no longer need a metadata set, select it and press "Remove Metadata Set" to remove it. If you have assigned any metadata to elements in the removed set you will be asked how to deal with this metadata when you next open the collection.
    693     </Section>
    694   </Section>
    695 
    696   <Section name="producingthecollection">
    697     <Title>Producing Your Collection</Title>
    698 Having collected the documents for the collection, annotated them with
    699 metadata, and designed how the collection will appear, you can now produce the
    700 collection using Greenstone.  This section explains how.
    701     <Section name="thecreateview">
    702       <Title>The Create View</Title>
    703 The Create view is used to create the collection by running Greenstone
    704 collection-building scripts on the information you have provided.
    705 Clicking "Build Collection" initiates the collection building process.  The time
    706 this takes depends on the size of the collection and the number of indexes
    707 being created (for huge collections it can be hours). A progress bar indicates how much of the process has been completed. To cancel the process at
    708 any time, click "Cancel Build".
    709 <Break/>
    710 Once the collection has successfully built, clicking "Preview Collection" will launch a web browser showing the home page of the collection.
    711 <Break/>
    712 In Expert mode, you can use the "Message Log" entry at the left to review previous attempts to build the collection, whether successful or not. Select the log you want by clicking on the desired date in the "Log History" list.
    713     </Section>
    714     <Section name="buildsettings">
    715       <Title>Import and Build Settings</Title>
    716 This section explains how to access the various import and build settings.
    717 For more information of importing and building read Chapter 1 of the Greenstone
    718 Developer's Guide -- Understanding the collection-building process.
    719       <Break/>
    720 Controlling the various settings is done in a similar way to the
    721 "Configuring Arguments" window described in the <Reference target="plugins">Document Plugins</Reference> section.  Some
    722 fields require numeric arguments, and you can either type these in or use the
    723 up and down arrows to increase or decrease the current value (in some cases,
    724 the interface restricts the range you can enter).  Others are enabled by
    725 clicking a checkbox (click again to disable).
    726     </Section>
    727   </Section>
    728 
    729   <Section name="miscellaneous">
    730     <Title>Miscellaneous</Title>
    731 This section describes features of the Librarian Interface that are not associated
    732 with any particular view.
    733     <Section name="preferences">
    734       <Title>Preferences</Title>
    735 This section explains the preferences dialog, accessed by opening "File" -> "Preferences".
    736       <Break/>
    737 The first "General" option is a text field for entering your e-mail address. This will be used for the "creator" and "maintainer" collection metadata items. The next option is a pull-down list of the languages in which the Librarian Interface can be presented. If you change the dictionary by choosing one from the list, you must
    738 restart the Librarian Interface in order to load the new language strings from
    739 the dictionary.
    740 <Break/>
    741 If "View Extracted Metadata" is checked, the
    742 various controls dealing with metadata always show all metadata that has been
    743 extracted automatically from documents.  Deselecting it hides this metadata
    744 (although it is still available during collection design, and within the
    745 final Greenstone collection). If "Show file sizes" is checked, the file size is shown next to each file in the Workspace and Collection file trees in the Gather and Enrich views.
    746 <Break/>
    747 The "Mode" panel is used to control the level of detail within the interface. At its lowest setting, "Library Assistant", the design view is disabled, arguments requiring regular expressions are hidden and the collection building produces a minimal log of events. In contrast the highest setting, "Expert", provides access to all of the features of design, including plugin positioning and regular expression arguments, and also allows the full output from the collection building to be recorded in the logs. To change or review modes, click the radio button next to the mode you are interested in. You can quickly review what mode you are in by looking at the Librarian Interface's title bar.
    748 <Break/>
    749 The Librarian Interface can support different workflows by determining which of
    750 the various view tabs are visible.  Use the "Workflow" tab to customise what
    751 views are available by checking the boxes next to the views that you want to be
    752 available.  Alternatively, use the pull-down list at the bottom to select
    753 predetermined configurations.  Closing the preferences dialog establishes these
    754 workflow settings.  These settings are stored with the collection, not in the
    755 Librarian Interface configuration file.
    756 <Break/>
    757 The "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 downloading files; see the <Reference target="downloadingfiles">Downloading Files From the Internet</Reference> section 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.
    758 <Break/>
    759 During the course of a session the Librarian Interface may give warning
    760 messages which inform you of possibly unforeseen consequences of an action.  You
    761 can disable the messages by checking the "Do not show this warning again" box.
    762 You can re-enable warning messages using the "Warnings" tab.  Check the box
    763 next to warning messages you want to see again.
    764     </Section>
    765     <Section name="fileassociations">
    766       <Title>File Associations</Title>
    767 The Librarian Interface uses particular application programs to open particular
    768 file types.
    769 To alter file associations open the "File" menu and click "File
    770 Associations...".
    771 <Break/>
    772 To add an association, select the target file extension from the pull-down
    773 list, or type in a new extension (do not include the ".").  Next either type
    774 command that launches the desired application in the appropriate field, or
    775 choose the application from the "Browse" dialog.  "%1" can be used in the launch
    776 command to insert the name of the file being opened.  Once these are filled out,
    777 "Add" is enabled and can be clicked to add the association.
    778 <Break/>
    779 To edit an association, select an existing file extension.  Any existing
    780 associated command is shown in the launch command field.  Edit it, and then
    781 click "Replace".
    782 <Break/>
    783 To remove an association, select an existing file extension and click "Remove".
    784 (The file extension remains in the "For Files Ending" pull-down list.)
    785 <Break/>
    786 File associations are stored in the Librarian Interface's main folder, in a file
    787 called "associations.xml".
    788     </Section>
    789     <Section name="exportingcollections">
    790       <Title>Exporting Collections to CD/DVD</Title>
    791 Greenstone can export one or more collections to a self-installing
    792 CD/DVD for Windows. To do so, Greenstone's "Export to CD-ROM" package
    793 must be installed. This is not included by default, so you may need to
    794 modify your installation to include it.
    795 <Break/>
    796 To export a collection, open the "File" menu and choose "Write CD/DVD Image". A list of Greenstone collections appears; click on any one to
    797 see its description. Tick the check boxes of the collections to export.
    798 You can enter the CD/DVD's name in the box: this is what will appear in
    799 the Start menu when the CD/DVD has been installed. Then click "Export".
    800 The process involves copying many files and may take a few minutes.
    801 <Break/>
    802 Upon completion, Greenstone will show the name of a folder containing
    803 the exported collections. Use a CD/DVD writer to copy its contents to a
    804 blank CD/DVD.
    805     </Section>
    806   </Section>
     2<Section name="introduction">
     3<Title>
     4<Text id="1">Introduction</Text>
     5</Title>
     6<Text id="2">The 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 a graphical point and click interface.</Text>
     7<Section name="ofmiceandmenus">
     8<Title>
     9<Text id="3">Of Mice and Menus</Text>
     10</Title>
     11<Text id="4">This section provides basic information about interacting with the Librarian Interface. If you are familiar with programs such as Internet Explorer or Microsoft Office and are comfortable with mouse clicks and menus, skip to <Reference target="howtoavoidthisdocument"/>.</Text>
     12<Text id="5">The Librarian Interface follows Microsoft Windows conventions and draws upon ordinary knowledge of Windows.</Text>
     13<Text id="6">Any 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.</Text>
     14<Text id="7">You 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.</Text>
     15<Text id="8">You 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.</Text>
     16<Text id="9">Buttons, like menus, have one character underlined.  To "click" the button, press [ALT] and the underlined character at the same time.</Text>
     17<Text id="10">To 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, while in the File menu press [S] to "Save" a collection.</Text>
     18<Text id="11">Exit the Librarian Interface program by choosing "Exit" from the "File" menu.  Your collection will be saved first.</Text>
     19</Section>
     20<Section name="howtoavoidthisdocument">
     21<Title>
     22<Text id="12">How to Avoid Reading This Document</Text>
     23</Title>
     24<Text id="13">Don't read this help text all the way through!  Just read enough to learn how to get help when you need it.</Text>
     25<Text id="14">The "Help" menu item marks what may be the most appropriate help item with a little book icon.</Text>
     26<Text id="15">For many controls, if you station the mouse over them a "tool tip" appears that says what they do.</Text>
     27<Text id="16">Before using the Librarian Interface, first read the Greenstone documentation.</Text>
     28</Section>
     29</Section>
     30<Section name="startingoff">
     31<Title>
     32<Text id="17">Starting Off</Text>
     33</Title>
     34<Text id="18">This section covers how to create, load, save and delete collections.</Text>
     35<Section name="creatingacollection">
     36<Title>
     37<Text id="19">Creating a New Collection</Text>
     38</Title>
     39<Text id="20">To 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.</Text>
     40<Text id="21">"Collection title" is the text displayed at the top of your collection's home page.  It can be any length.</Text>
     41<Text id="22">"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.</Text>
     42<Text id="23">Finally 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".</Text>
     43<Text id="24">Click "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.</Text>
     44<Text id="25">Clicking "Cancel" returns you to the main screen immediately.</Text>
     45</Section>
     46<Section name="savingacollection">
     47<Title>
     48<Text id="26">Saving the Collection</Text>
     49</Title>
     50<Text id="27">Save 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 <Reference target="producingthecollection"/>).</Text>
     51<Text id="28">The Librarian Interface protects your work by saving it whenever you exit the program or load another collection.</Text>
     52<Text id="29">Saved 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.</Text>
     53</Section>
     54<Section name="openingacollection">
     55<Title>
     56<Text id="30">Opening an Existing Collection</Text>
     57</Title>
     58<Text id="31">To 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.</Text>
     59<Text id="32">In 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.</Text>
     60<Text id="33">When you open a collection that the Greenstone Librarian Interface did not create, you will be asked to select a metadata set (or sets).  If none are selected, any existing metadata will be ignored. Otherwise, metadata will be imported just as it is when you drag in files with existing metadata. The process is described in the <Reference target="importingpreviouslyassignedmetadata"/> section. </Text>
     61</Section>
     62<Section name="deletingcollections">
     63<Title>
     64<Text id="34">Deleting Collections</Text>
     65</Title>
     66<Text id="35">To permanently delete collections from your Greenstone installation, choose "Delete..." from the "File" menu. A list of your Greenstone collections appears. Select one to see its description, then tick the box at the bottom of the dialog and click "Delete" to delete the collection. This action is irreversible, so check carefully that you no longer need the collection before proceeding!</Text>
     67</Section>
     68</Section>
     69<Section name="downloadingfiles">
     70<Title>
     71<Text id="36">Downloading Files From the Internet</Text>
     72</Title>
     73<Text id="37">The "Download" view helps you download resources from the internet. This section explains the Librarian Interface's mirroring process.</Text>
     74<Section name="themirrorview">
     75<Title>
     76<Text id="38">The Download view</Text>
     77</Title>
     78<Text id="39">This section describes how to configure a download task and control the downloading process. Access the "Download" view by clicking its tab. The top half of the screen shows the downloading controls. The bottom half is initially empty, but will show a list of pending and completed downloading jobs. </Text>
     79<Text id="40">Files are downloaded into a folder in the workspace called "Downloaded Files" (only present when mirroring is enabled), and can be used in all collections built with the Librarian Interface.  Files in this area 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.</Text>
     80<Text id="41">Use the first of the download configuration controls, "Source URL", to enter the URL of a target resource. Use the "Download Depth" control to limit how many  hyperlinks to follow when downloading: Set this to 0 to download a single web page; set it to 1 to download a page and all the pages it points to. The depth limit is ignored when downloading media other than html pages. Next, there are several checkbox controls which can be set to turn on the specified feature for a specific download. Once the configuration is set up, click "Download" to start the new download job. There are two other button controls: "Preferences", which links to the connection section of the Preferences where proxy settings can be edited; and "Clear Cache", which deletes all previously downloaded files.</Text>
     81<Text id="42">The download list has an entry for each web page download.  Each entry has a text region that gives details of the task along with a progress bar showing current activity. Three buttons appear to the left of each entry. "Pause" is used for pausing a currently downloading task. "View Log" opens a window showing the download log file. "Close" terminates the download and removes the task from the list.  </Text>
     82<Text id="43">The <Reference target="preferences"/> section 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.</Text>
     83</Section>
     84</Section>
     85<Section name="collectingfiles">
     86<Title>
     87<Text id="44">Collecting Files for Your Collection</Text>
     88</Title>
     89<Text id="45">Once 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 section describes how to import files.</Text>
     90<Section name="thegatherview">
     91<Title>
     92<Text id="46">The Gather View</Text>
     93</Title>
     94<Text id="47">This section introduces the Gather area that you use to select what files to include in the collection you are building. The Librarian Interface starts with the Gather view.  To return to this view later, click the "Gather" tab directly below the menu bar.</Text>
     95<Text id="48">The 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.</Text>
     96<Text id="49">Select an item in the tree by clicking it.  (There are other ways; see below.) Double-click a folder, or single-click the switch symbol beside it, to expand (or collapse) its contents.  Double-click a file to open it using its associated application program (see <Reference target="fileassociations"/>).</Text>
     97<Text id="50">The 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 cache of downloaded files. You can copy and view these files but you cannot move, delete, or edit them, with the exception of the downloaded files, which can be deleted.  Navigate this space to find the files you want to include in the collection.</Text>
     98<Text id="51">The Collection file tree represents the contents of the collection so far.  Initially, it is empty.</Text>
     99<Text id="52">You can resize the spaces by mousing over the grey bar that separates the trees (the shape of the pointer changes) and dragging.</Text>
     100<Text id="53">At the bottom of the window is a status area that shows the progress of actions involving files (copying, moving and deleting). These can take some time to complete. The "Stop" button stops any action that is currently in progress. </Text>
     101<Text id="54">Two large buttons occupy the lower right corner of the screen. "New Folder", with a picture of a folder, creates new folders (see <Reference target="creatingfolders"/>). "Delete", with a garbage can, removes files. Clicking the Delete button will remove any selected files from the Collection file tree. Alternatively, files can be deleted by dragging them onto the Delete button. </Text>
     102<Text id="55">To select several sequential items, select the first and then hold down [Shift] and click on the last -- the selection will encompass all intervening items.  Select non-sequential files by holding down [Ctrl] while clicking.  Use these two methods together to select groups of non-adjacent items.</Text>
     103<Text id="56">Certain folders -- such as the one containing your own web pages -- sometimes have special significance.  The Librarian Interface can map such folders to the first level of the file tree.  To do this, right-click the desired folder.  Select "Create Shortcut", and enter a name for the folder.  To remove an item, right-click the mapped folder and select "Remove Shortcut".</Text>
     104</Section>
     105<Section name="creatingfolders">
     106<Title>
     107<Text id="57">Creating Folders</Text>
     108</Title>
     109<Text id="58">Use folders in the Collection 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.</Text>
     110<Text id="59">To 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").</Text>
     111<Text id="60">Folders can also be created by right-clicking over a folder, choosing "New Folder" and proceeding as above.</Text>
     112</Section>
     113<Section name="addingfiles">
     114<Title>
     115<Text id="61">Adding Files</Text>
     116</Title>
     117<Text id="62">Files 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).</Text>
     118<Text id="63">When 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.</Text>
     119<Text id="64">Only 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.</Text>
     120<Text id="65">When 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 <Reference target="importingpreviouslyassignedmetadata"/> section.  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.</Text>
     121</Section>
     122<Section name="removingfiles">
     123<Title>
     124<Text id="66">Removing Files</Text>
     125</Title>
     126<Text id="67">There 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 <Reference target="thegatherview"/>.</Text>
     127<Text id="68">Once 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.</Text>
     128</Section>
     129<Section name="filteringthetree">
     130<Title>
     131<Text id="69">Filtering the Tree</Text>
     132</Title>
     133<Text id="70">"Filtering" the collection tree allows you to narrow down the search for particular files.</Text>
     134<Text id="71">The "Show 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.</Text>
     135<Text id="72">You can specify a custom filter by typing in a pattern to match files against (Librarian Systems Specialist and Expert modes only). Use standard file system abbreviations such as "*.*" or "*.doc" ("*" matches any characters).</Text>
     136</Section>
     137</Section>
     138<Section name="enrichingacollection">
     139<Title>
     140<Text id="73">Enriching the Collection with Metadata</Text>
     141</Title>
     142<Text id="74">Having gathered several files into the collection, now enrich them with additional information called "metadata".  This section explains how metadata is created, edited, assigned and retrieved, and how to use external metadata sources (also see Chapter 2 of the Greenstone Developer's Guide -- Getting the most out of your documents).</Text>
     143<Section name="theenrichview">
     144<Title>
     145<Text id="75">The Enrich View</Text>
     146</Title>
     147<Text id="76">Use 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).</Text>
     148<Text id="77">On the left of the "Enrich" view is the Collection Tree. To the right is the Metadata Table, which shows metadata for any selected files or folders in the Collection Tree.  Columns are named in grey at the top, and can be resized by dragging the separating line. 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.</Text>
     149<Text id="78">A 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.</Text>
     150<Text id="79">Clicking on a metadata element in the table will display the existing values for that element in the "Existing values for..." area below the table. The 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 [Tab] auto-completes the typing with the selected value.</Text>
     151<Text id="80">Metadata values can be organised into a hierarchy. This is shown in the Value Tree using folders for internal levels. Hierarchical values can be entered using the character "|" to separate the levels.  For example, "Cards|Red|Diamonds|Seven" might be used in a hierarchy that represents a pack of playing cards. This enables values to be grouped together. Groups can also be assigned as metadata to files.</Text>
     152<Text id="81">Greenstone extracts metadata automatically from documents into a metadata set whose elements are prefixed by "ex.".  This has no value tree and cannot be edited. </Text>
     153</Section>
     154<Section name="selectingmetadatasets">
     155<Title>
     156<Text id="82">Selecting Metadata Sets</Text>
     157</Title>
     158<Text id="83">Sets 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 metadata folder and have the suffix ".mds".</Text>
     159<Text id="84">To control the metadata sets used in a collection, use the "Metadata Sets" entry on the Design view.</Text>
     160</Section>
     161<Section name="appendingmetadata">
     162<Title>
     163<Text id="85">Appending New Metadata</Text>
     164</Title>
     165<Text id="86">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.  The action causes any metadata previously assigned to this file to appear in the table at the right.</Text>
     166<Text id="87">Next select the metadata element you want to add by clicking its row in the table.</Text>
     167<Text id="88">Type the value into the value field.  Use the "|" character to add structure, as described in <Reference target="theenrichview"/>. Pressing the [Up] or [Down] arrow keys will save the metadata value and move the selection appropriately. Pressing [Enter] will save the metadata value and create a new empty entry for the metadata element, allowing you to assign multiple values to a metadata element.</Text>
     168<Text id="89">You 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.</Text>
     169</Section>
     170<Section name="addingpreviouslydefinedmetadata">
     171<Title>
     172<Text id="90">Adding Previously Defined Metadata</Text>
     173</Title>
     174<Text id="91">To add metadata that has an existing value, first select the file, then select the required value from the value tree, expanding hierarchy folders as necessary.  The value of the selected entry automatically appears in the Value field (alternatively, use the value tree's auto-select and auto-complete features). </Text>
     175<Text id="92">The process of adding metadata with already-existing values to folders or multiple files is just the same.</Text>
     176</Section>
     177<Section name="updatingmetadata">
     178<Title>
     179<Text id="93">Editing or Removing Metadata</Text>
     180</Title>
     181<Text id="94">To edit or remove a piece of metadata, first select the appropriate file, and then the metadata value from the table. Edit the value field, deleting all text if you wish to remove the metadata.</Text>
     182<Text id="95">The process is the same when updating a folder with child folders or multiple files, but you can only update metadata that is common to all files/folders selected.</Text>
     183<Text id="96">The value tree shows all currently assigned values as well as previous values for the current session, so changed or deleted values will remain in the tree. Closing the collection and then re-opening it will remove the values which are no longer assigned.</Text>
     184</Section>
     185<Section name="reviewingmetadata">
     186<Title>
     187<Text id="97">Reviewing Assigned Metadata</Text>
     188</Title>
     189<Text id="98">Sometimes you need to see the metadata assigned to many or all files at once -- for instance, to determine how many files are left to work on, or to get some idea of the spread of dates.</Text>
     190<Text id="99">Select the files you wish to examine, then right-click and 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 those files.</Text>
     191<Text id="100">Drawing the table can take some time if many files are selected.  You can continue to use the Librarian Interface while the "All Metadata" window is open.</Text>
     192<Text id="101">When 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.</Text>
     193<Text id="102">The 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.</Text>
     194<Text id="103">For 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.</Text>
     195</Section>
     196<Section name="importingpreviouslyassignedmetadata">
     197<Title>
     198<Text id="104">Importing Previously Assigned Metadata</Text>
     199</Title>
     200<Text id="105">This section describes how to import previously assigned metadata: metadata assigned to documents before they were added to the collection.</Text>
     201<Text id="106">If 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.</Text>
     202<Text id="107">The 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.</Text>
     203<Text id="108">Having 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.  Once you have specified how to import a certain piece of metadata, the mapping information is retained for the collection's lifetime.</Text>
     204<Text id="109">For details on the metadata.xml files which Greenstone uses to store the metadata, see Chapter 2 of the Greenstone Developer's Guide -- Getting the most out of your documents.</Text>
     205</Section>
     206</Section>
     207<Section name="designingacollection">
     208<Title>
     209<Text id="110">Designing Your Collection's Appearance</Text>
     210</Title>
     211<Text id="111">Once 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 section describes how to do it.</Text>
     212<Section name="thedesignview">
     213<Title>
     214<Text id="112">The Design View</Text>
     215</Title>
     216<Text id="113">This section introduces you to the design view and explains how to navigate between the various views within this pane.</Text>
     217<Text id="114">With 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.</Text>
     218<Text id="115">On 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.</Text>
     219<Text id="116">To understand the stages and terms involved in designing a collection, first read Chapters 1 and 2 of the Greenstone Developer's Guide.</Text>
     220</Section>
     221<Section name="generalsettings">
     222<Title>
     223<Text id="117">General</Text>
     224</Title>
     225<Text id="118">This section explains how to review and alter the general settings associated with your collection.  First, under "Design Sections", click "General".</Text>
     226<Text id="119">Here the values provided during collection creation can be modified.</Text>
     227<Text id="120">First are the contact emails of the collection's creator and maintainer. The following field allows you to change the collection title. The folder that the collection is stored in is shown next, but this cannot be edited. 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. Then, a checkbox controls whether the collection should be publicly accessible. Finally comes the "Collection Description" text area as described in <Reference target="creatingacollection"/>.</Text>
     228</Section>
     229<Section name="plugins">
     230<Title>
     231<Text id="121">Document Plugins</Text>
     232</Title>
     233<Text id="122">This section describes how to configure the document plugins the collection uses.  It explains how you specify what plugins to use, what parameters to pass to them, and in what order they occur.  Under "Design Sections", click "Document Plugins".</Text>
     234<Text id="123">To add a plugin, select it using the "Select plugin to add" pull-down list near the bottom and then click "Add Plugin".  A window appears entitled "Configuring Arguments"; it is described later.  Once you have configured the new plugin, it is added to the end of the "Currently Assigned Plugins" list. Note that, except for UnknownPlug, each plugin may only occur once in the list.</Text>
     235<Text id="124">To remove a plugin, select it in the list and click "Remove Plugin".</Text>
     236<Text id="125">Plugins are configured by providing arguments.  To alter them, select the plugin from the list and click "Configure Plugin" (or double-click the plugin). A "Configuring Arguments" dialog appears with various controls for specifying arguments.</Text>
     237<Text id="126">There are different kinds of controls.  Some are checkboxes, and clicking one adds the appropriate option to the plugin.  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.  To learn what an argument does, let the mouse hover over its name for a moment and a description will appear.</Text>
     238<Text id="127">When you have changed the configuration, click "OK" to commit the changes and close the dialog, or "Cancel" to close the dialog without changing any plugin arguments.</Text>
     239<Text id="128">The plugins in the list are executed in order, and the ordering is sometimes important. The order of the plugins can be changed in Library Systems Specialist and Expert modes only (see <Reference target="preferences"/>).    </Text>
     240</Section>
     241<Section name="searchtypes">
     242<Title>
     243<Text id="129">Search Types</Text>
     244</Title>
     245<Text id="130">This section explains how to modify a new design feature in Greenstone, Search Types, which allow fielded searching. The search types specify what kind of search interface should be provided: form, for fielded searching, and/or plain for regular searching.  Under "Design Sections", click "Search Types".</Text>
     246<Text id="131">When you enter the Search Types view, first check "Enable Advanced Searches", which activates the other controls. This changes the collection to use an indexing mechanism that allows fielded searching. Index specification is slightly different in this mode. (When switching between standard and advanced searching, the GLI does its best to convert the index specification, but may not get it completely right.)</Text>
     247<Text id="132">To add a search type, select it from the "Search Types" list and click "Add Search Type".  Each type can only appear in the list once. The first search type will be the default, and will appear on the search page of the built collection. Any others will be selectable from the preferences page.</Text>
     248<Text id="133">To remove a search type, select it from the "Currently Assigned Search Types" list and click "Remove Search Type".  The list must contain at least one search type.</Text>
     249</Section>
     250<Section name="searchindexes">
     251<Title>
     252<Text id="134">Search Indexes</Text>
     253</Title>
     254<Text id="135">Indexes 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".</Text>
     255<Text id="136">To 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.</Text>
     256<Text id="137">To edit an index, select it and change the index details, then click "Replace Index".</Text>
     257<Text id="138">To remove an index, select it from the list of assigned indexes and click "Remove Index".</Text>
     258<Text id="139">To create an index covering text and all metadata, click "Add All".</Text>
     259<Text id="140">The 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".</Text>
     260<Text id="141">If advanced searching is enabled (via the Search Types view), the index controls are different.  There is a new pseudo-data source "allfields" which provides searching across all specified indexes at once.  Levels are not assigned to a specific index, but apply across all indexes: thus indexes and levels are added separately. "Add All" creates a separate index for each metadata field in this mode.</Text>
     261<Text id="142">The name of each index will default to the source name. To change the name, select an index, change its details, and click "Replace Index".</Text>
     262</Section>
     263<Section name="partitionindexes">
     264<Title>
     265<Text id="143">Partition Indexes</Text>
     266</Title>
     267<Text id="144">Indexes 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".</Text>
     268<Text id="145">The "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.</Text>
     269<Text id="146">The Partition Indexes screen is only enables in Library Systems Specialist and Expert modes (see <Reference target="preferences"/>). Note that the total number of partitions generated is a combination of all indexes, subcollection filters and languages chosen. Two indexes with two subcollection filters in two languages would yield eight index partitions.</Text>
     270<Section name="definefilters">
     271<Title>
     272<Text id="147">Define Filters</Text>
     273</Title>
     274<Text id="148">Filters allow you to group together into a subcollection all documents in an index for which a metadata value matches a given pattern.</Text>
     275<Text id="149">To create a filter, click the "Define Filters" tab and enter a name for the new filter into the "Subcollection filter name:" field.  Next choose a document attribute to match against, either a metadata element or the name of the file in question.  Enter a regular expression to use during the matching. You can toggle between "Including" documents that match the filter, or "Excluding" them.  Finally, you can specify any of the standard PERL regular expression flags to use when matching (e.g.  "i" for case-insensitive matching). Finally, click "Add Filter" to add the filter to the "Defined Subcollection Filters" list.</Text>
     276<Text id="150">To remove a filter, select it from the list and click "Remove Filter".</Text>
     277<Text id="151">To alter a filter, select it from the list, change any of the values that appear in the editing controls and click "Replace Filter" to commit the changes.</Text>
     278</Section>
     279<Section name="assignpartitions">
     280<Title>
     281<Text id="152">Assign Partitions</Text>
     282</Title>
     283<Text id="153">Having defined a subcollection filter, use the "Assign Partitions" tab to build indexes for it (or for a group of filters).  Select the desired filter (or filters) from the "Defined Subcollection Filters" list, enter a name for your partition in the "Partition Name" field,  and click "Add Partition".</Text>
     284<Text id="154">To remove a partition, select it from the list and click "Remove Partition".</Text>
     285<Text id="155">To make a partition the default one, select it from the list and click "Set Default".</Text>
     286</Section>
     287<Section name="assignlanguages">
     288<Title>
     289<Text id="156">Assign Languages</Text>
     290</Title>
     291<Text id="157">This section details how to restrict search indexes to particular languages. You do this by generating a partition using the "Assign Languages" tab of the "Partition Indexes" view.</Text>
     292<Text id="158">To add a new language to partition by, use the "Assign Languages" tab to build an index for it.  Select the desired language from the "Language to add" pull-down list and click "Add Language".</Text>
     293<Text id="159">To remove a language, select it from the "Language Selection" list and click "Remove Language".</Text>
     294<Text id="160">To set the default language, select it from the list and click "Set Default".</Text>
     295</Section>
     296</Section>
     297<Section name="xcollectionsearching">
     298<Title>
     299<Text id="161">Cross-Collection Search</Text>
     300</Title>
     301<Text id="162">Greenstone can search across several different collections as though they were one. This is done by specifying a list of other collections to be searched along with the current one.  Under "Design Sections", click "Cross-Collection Search".</Text>
     302<Text id="163">The Cross-Collection Search 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.</Text>
     303<Text id="164">If the individual collections do not have the same indexes (including subcollection partitions and language partitions) as each other, cross-collection searching will not work properly. The user will only be able to search using indexes common to all collections.</Text>
     304<Text id="165">For further details, see Chapter 1 of the Greenstone Developer's Guide.</Text>
     305</Section>
     306<Section name="classifiers">
     307<Title>
     308<Text id="166">Browsing Classifiers</Text>
     309</Title>
     310<Text id="167">This section explains how to assign "classifiers", which are used for browsing, to the collection.  Under "Design Sections", click "Browsing Classifiers".</Text>
     311<Text id="168">To add a classifier, select it using the "Select classifier to add" pull-down list near the bottom and then click "Add Classifier".  A window appears entitled "Configuring Arguments"; instructions for this dialog are just the same as for plugins (see <Reference target="plugins"/>).  Once you have configured the new classifier, it is added to the end of the "Currently Assigned Classifiers" list.</Text>
     312<Text id="169">To remove a classifier, select it from the list and click "Remove Classifier".</Text>
     313<Text id="170">To change the arguments a classifier, select it from the list and click "Configure Classifier" (or double-click on the classifier in the list).</Text>
     314<Text id="171">The 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 Up" or "Move Down".</Text>
     315<Text id="172">For further information on classifiers read Chapter 2, Greenstone Developer's Guide -- Getting the most out of your documents.</Text>
     316</Section>
     317<Section name="formatstatements">
     318<Title>
     319<Text id="173">Format Features</Text>
     320</Title>
     321<Text id="174">The web pages you see when using Greenstone are not pre-stored but are generated 'on the fly' as they are needed. Format commands are used to change the appearance of these generated pages. 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 Features".</Text>
     322<Text id="175">You 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 pull-down list ("Affected Component") for selecting which part of the feature the string applies to (if necessary), a text area ("HTML Format String") for entering the string, 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".</Text>
     323<Text id="176">You can specify a default format for a particular component by selecting the blank feature.  This format is then applied to all applicable features unless
     324otherwise specified.</Text>
     325<Text id="177">To 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.</Text>
     326<Text id="178">To remove a format command, select it from the list and click "Remove Format".</Text>
     327<Text id="179">To change a format command, select it from the list, modify the settings, and click "Replace Format".</Text>
     328<Text id="180">For more information about variables and the feature components, read Chapter 2 of the Greenstone Developer's Guide.</Text>
     329<Text id="181">If the "Allow Extended Options" checkbox is ticked, some advanced formatting options are enabled. The list of features that can be formatted is changed slightly, and more variables are available to be used in the format command, providing greater control over the page layout.</Text>
     330</Section>
     331<Section name="translatetext">
     332<Title>
     333<Text id="182">Translate Text</Text>
     334</Title>
     335<Text id="183">This section describes the translation view, where you can define language-specific text fragments for parts of the collection's interface. Under "Design Sections", click "Translate Text".</Text>
     336<Text id="184">First choose an entry from the "Features" list.  The language-specific strings associated with this feature appear below.  Use the "Language of translation" pull-down list to select the target language, and type the translated text into the text area, referring to the "Initial Text Fragment" if necessary.  Click "Add Translation" when finished.</Text>
     337<Text id="185">To remove an existing translation, select it in the "Assigned Translations" table and click "Remove Translation".</Text>
     338<Text id="186">To edit a translation, select it, edit it in the "Translated Text" text area, and click "Replace Translation".</Text>
     339</Section>
     340<Section name="metadatasets">
     341<Title>
     342<Text id="187">Metadata Sets</Text>
     343</Title>
     344<Text id="188">This section explains the metadata set review panel. Under "Design Sections", click "Metadata Sets".</Text>
     345<Text id="189">This view is used to review the metadata sets that the collection uses, and the elements that are available within each set.  Choose from the list of "Available Metadata Sets" in order to see details of their elements.</Text>
     346<Text id="190">To use another metadata set with the loaded collection, click "Add Metadata Set" and select the metadata set file (.mds) for the new metadata set.</Text>
     347<Text id="191">Editing metadata sets is done with the Greenstone Editor for Metadata Sets (GEMS). Clicking the "Edit Metadata Set" button provides information on how to run the GEMS.</Text>
     348<Text id="192">If you no longer need a metadata set, select it and press "Remove Metadata Set" to remove it. If you have assigned any metadata to elements in the removed set you will be asked how to deal with this metadata when you next open the collection.</Text>
     349</Section>
     350</Section>
     351<Section name="producingthecollection">
     352<Title>
     353<Text id="193">Producing Your Collection</Text>
     354</Title>
     355<Text id="194">Having 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 section explains how.</Text>
     356<Section name="thecreateview">
     357<Title>
     358<Text id="195">The Create View</Text>
     359</Title>
     360<Text id="196">The Create view is used to create the collection by running Greenstone collection-building scripts on the information you have provided. 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). A progress bar indicates how much of the process has been completed. To cancel the process at any time, click "Cancel Build".</Text>
     361<Text id="197">Once the collection has successfully built, clicking "Preview Collection" will launch a web browser showing the home page of the collection.</Text>
     362<Text id="198">In Expert mode, you can use the "Message Log" entry at the left to review previous attempts to build the collection, whether successful or not. Select the log you want by clicking on the desired date in the "Log History" list.</Text>
     363</Section>
     364<Section name="buildsettings">
     365<Title>
     366<Text id="199">Import and Build Settings</Text>
     367</Title>
     368<Text id="200">This 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.</Text>
     369<Text id="201">Controlling the various settings is done in a similar way to the
     370"Configuring Arguments" window described in the <Reference target="plugins"/> section.  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).</Text>
     371</Section>
     372</Section>
     373<Section name="miscellaneous">
     374<Title>
     375<Text id="202">Miscellaneous</Text>
     376</Title>
     377<Text id="203">This section describes features of the Librarian Interface that are not associated with any particular view.</Text>
     378<Section name="preferences">
     379<Title>
     380<Text id="204">Preferences</Text>
     381</Title>
     382<Text id="205">This section explains the preferences dialog, accessed by opening "File" -> "Preferences".</Text>
     383<Text id="206">The first "General" option is a text field for entering your e-mail address. This will be used for the "creator" and "maintainer" collection metadata items. The next option is a pull-down list of the languages in which the Librarian Interface can be presented. 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.</Text>
     384<Text id="207">If "View Extracted Metadata" is checked, the various controls dealing with metadata always show all metadata that has been extracted automatically from documents.  Deselecting it hides this metadata (although it is still available during collection design, and within the final Greenstone collection). If "Show file sizes" is checked, the file size is shown next to each file in the Workspace and Collection file trees in the Gather and Enrich views.</Text>
     385<Text id="208">The "Mode" panel is used to control the level of detail within the interface. At its lowest setting, "Library Assistant", the design view is disabled, arguments requiring regular expressions are hidden and the collection building produces a minimal log of events. In contrast the highest setting, "Expert", provides access to all of the features of design, including plugin positioning and regular expression arguments, and also allows the full output from the collection building to be recorded in the logs. To change or review modes, click the radio button next to the mode you are interested in. You can quickly review what mode you are in by looking at the Librarian Interface's title bar.</Text>
     386<Text id="209">The 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.</Text>
     387<Text id="210">The "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 downloading files; see the <Reference target="downloadingfiles"/> section 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.</Text>
     388<Text id="211">During 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.</Text>
     389</Section>
     390<Section name="fileassociations">
     391<Title>
     392<Text id="212">File Associations</Text>
     393</Title>
     394<Text id="213">The Librarian Interface uses particular application programs to open particular file types. To alter file associations open the "File" menu and click "File Associations...".</Text>
     395<Text id="214">To 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.</Text>
     396<Text id="215">To edit an association, select an existing file extension.  Any existing associated command is shown in the launch command field.  Edit it, and then click "Replace".</Text>
     397<Text id="216">To remove an association, select an existing file extension and click "Remove". (The file extension remains in the "For Files Ending" pull-down list.)</Text>
     398<Text id="217">File associations are stored in the Librarian Interface's main folder, in a file called "associations.xml".</Text>
     399</Section>
     400<Section name="exportingcollections">
     401<Title>
     402<Text id="218">Exporting Collections to CD/DVD</Text>
     403</Title>
     404<Text id="219">Greenstone can export one or more collections to a self-installing CD/DVD for Windows. To do so, Greenstone's "Export to CD-ROM" package must be installed. This is not included by default, so you may need to modify your installation to include it.</Text>
     405<Text id="220">To export a collection, open the "File" menu and choose "Write CD/DVD Image". A list of Greenstone collections appears; click on any one to see its description. Tick the check boxes of the collections to export. You can enter the CD/DVD's name in the box: this is what will appear in the Start menu when the CD/DVD has been installed. Then click "Export". The process involves copying many files and may take a few minutes.</Text>
     406<Text id="221">Upon completion, Greenstone will show the name of a folder containing the exported collections. Use a CD/DVD writer to copy its contents to a blank CD/DVD.</Text>
     407</Section>
     408</Section>
    807409</Document>
Note: See TracChangeset for help on using the changeset viewer.