source: trunk/gli/help/help.xml@ 6076

<Document>
  <Section name="introduction">
    <Title>Introduction</Title>
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.
    <Section name="ofmiceandmenus">
      <Title>Of Mice and Menus</Title>
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 the <Reference target="howtoavoidthisdocument">next section</Reference>.
      <Contents>
        <ContentsGroup linkto="simple">
          <ContentsItem>
        Basic concepts   
            <ContentsItem>
              Mouse actions
        </ContentsItem>
            <ContentsItem>
              Keyboard
        </ContentsItem>
          </ContentsItem>
          <ContentsItem>
        Exiting the program
          </ContentsItem>
    </ContentsGroup>
    <ContentsGroup linkto="advanced">
          <ContentsItem>
        Quick keys
          </ContentsItem>
    </ContentsGroup>
      </Contents>
      <Anchor name="simple">Simple Instructions:</Anchor>
The Librarian Interface follows Microsoft Windows conventions and draws upon
ordinary knowledge of Windows.
<Break/>
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.
<Break/>
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.
<Break/>
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.
<Break/>
Exit the Librarian Interface program by choosing "Exit" from the "File"
menu.  Your collection will be saved first.
       <Anchor name="advanced">Advanced Instructions:</Anchor>
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.
    </Section>
    <Section name="howtoavoidthisdocument">
      <Title>How to Avoid Reading This Document</Title>
Don't read this help text all the way through!  Just read enough to learn
how to get help when you need it.
      <Contents>
        <ContentsGroup linkto="simple">
          <ContentsItem>
            Context sensitive help
          </ContentsItem>
          <ContentsItem>
            Tool tips
          </ContentsItem>
          <ContentsItem>
            Other documents
          </ContentsItem>
        </ContentsGroup>
      </Contents>
      <Anchor name="simple">Simple Instructions:</Anchor>
The "Help" menu item marks what may be the most appropriate help item with a
little book icon.
<Break/>
For many controls, if you station the mouse over them a
"tool tip" appears that says what they do.
<Break/>
Before using the Librarian Interface, first read the Greenstone
documentation.
    </Section>
  </Section>

  <Section name="startingoff">
    <Title>Starting Off</Title>
This section covers how to create, save and load a collection.
    <Section name="creatingacollection">
      <Title>Creating a New Collection</Title>
<ObviousSentence>This section describes how to create a new collection.</ObviousSentence>
      <Contents>
        <ContentsGroup linkto="simple">
          <ContentsItem>
            The new collection prompt
          </ContentsItem>
          <ContentsItem>
            The collection title
          </ContentsItem>
          <ContentsItem>
            The collection name
          </ContentsItem>
          <ContentsItem>
            The creator's email
          </ContentsItem>
          <ContentsItem>
            Default metadata sets
          </ContentsItem>
          <ContentsItem>
            Collection description
          </ContentsItem>
          <ContentsItem>
            Creating the new collection
          </ContentsItem>
          <ContentsItem>
            Cancelling the new collection
          </ContentsItem>
        </ContentsGroup>
        <ContentsGroup linkto="advanced">
          <ContentsItem>
            Quick keys
          </ContentsItem>
        </ContentsGroup>
      </Contents>
      <Anchor name="simple">Simple Instructions:</Anchor>
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.
<Break/>
"Title" is the text displayed at the top of your collection's home page.  It can
be any length.
<Break/>
"Short Name" is the collection's filename.  It must be unique.
<Break/>
"Author's Email" should be a valid email address.
<Break/>
"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.
<Break/>
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".
<Break/>
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.
<Break/>
Clicking "Cancel" returns you to the main screen immediately.
      <Anchor name="advanced">Advanced Instructions:</Anchor>
Buttons, like menus, have one character underlined.  To "click" the button,
press [ALT] and the underlined character at the same time.
    </Section>
    <Section name="savingacollection">
      <Title>Saving the Collection</Title>
<ObviousSentence>This section describes how to save a collection, and the Save Collection Prompt.</ObviousSentence>
      <Contents>
        <ContentsGroup linkto="simple">
          <ContentsItem>
            How to save
          </ContentsItem>
        </ContentsGroup>
        <ContentsGroup linkto="advanced">
          <ContentsItem>
            Where the files are saved
          </ContentsItem>
        </ContentsGroup>
      </Contents>
      <Anchor name="simple">Simple Instructions:</Anchor>
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">Producing Your Collection</Reference>).
<Break/>
The Librarian Interface protects your work by saving it whenever you exit the
program or load another collection.
      <Anchor name="advanced">Advanced Instructions:</Anchor>
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.
    </Section>
    <Section name="openingacollection">
      <Title>Opening an Existing Collection</Title>
<ObviousSentence>This section tells you how to open existing collections using the Open
Collection prompt.</ObviousSentence>
      <Contents>
        <ContentsGroup linkto="simple">
          <ContentsItem>
            How to open a collection
          </ContentsItem>
        </ContentsGroup>
        <ContentsGroup linkto="advanced">
          <ContentsItem>
            Locked collections
          </ContentsItem>
      <ContentsItem>
        Legacy collections
      </ContentsItem>
        </ContentsGroup>
      </Contents>
      <Anchor name="simple">Simple Instructions:</Anchor>
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.
      <Anchor name="advanced">Advanced Instructions:</Anchor>
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.
<Break/>
Collections built by the Greenstone Librarian Interface program are slightly different to those built outside this program. When you open a collection in the Librarian Interface that was not created by it, there will be a few extra steps to go through. First, you will be asked to select a metadata set to use for your collection. You can choose more than one, and you can add others later. If you don't select any, any existing metadata for the collection will be ignored. If one or more sets are selected, any existing metadata will be imported into the collection. 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">Importing Previously Assigned Metadata</Reference> section. 
    </Section>
  </Section>

  <Section name="huntingforfiles">
    <Title>Hunting For Your Files</Title>
The Librarian Interface can run in different configurations.  This section only
applies when the "hunt" and/or "mirror" views are enabled.  If these tabs do
not appear, advanced users can enable them by editing the "config.xml" file in
the Librarian Interface installation folder (or, on a multiuser system, in your
home directory's ".gli" folder) to set the values of "workflow.browse" and
"workflow.mirror" to "true".
<Break/>
When using web resources, the Librarian Interface operates in two stages.  This
section describes the first, Hunting, where you browse the Internet for files
of interest. The <Reference target="downloadingfiles">next section</Reference> describes the second stage, Mirroring, where these files can be downloaded.
    <Section name="thehuntview">
      <Title>The Hunt view</Title>
This section describes how to use the simplified browsing interface to locate resources on the Internet.
      <Contents>
        <ContentsGroup linkto="simple">
          <ContentsItem>
            The address field
          </ContentsItem>
          <ContentsItem>
            The controls
          </ContentsItem>
        </ContentsGroup>
      </Contents>
      <Anchor name="simple">Simple Instructions:</Anchor>
The Hunt view is accessed by clicking on its tab.  Most of the screen shows a
web page.  Hyperlinks work in the usual way.  Underneath the page is a status bar
that shows you what the browser is doing.
<Break/>
You type URL addresses into the address field above the page.
<Break/>
To the left and right of the address field are web browser buttons for Back,
Reload, Home, Go, Stop and Forward.
    </Section>
  </Section>

  <Section name="downloadingfiles">
    <Title>Downloading Chosen Files</Title>
To enable web mirroring see <Reference target="huntingforfiles">Hunting For Your Files</Reference>.
To download web pages you need to install the mirroring tool wget (version v1.8
recommended) and make it accessible from the Librarian Interface "install"
folder.
<Break/>
After this, the second stage is to download (or "mirror") the
files you need.  This section explains the Librarian Interface's mirroring
process.
    <Section name="themirrorview">
      <Title>The Mirror view</Title>
This section describes how to configure a download task and control the downloading process.
      <Contents>
        <ContentsGroup linkto="simple">
          <ContentsItem>
            The workspace tree
          </ContentsItem>
          <ContentsItem>
            Download configuration
          </ContentsItem>
          <ContentsItem>
            The download list
          </ContentsItem>
        </ContentsGroup>
        <ContentsGroup linkto="advanced">
          <ContentsItem>
            Enabling web proxies
          </ContentsItem>
          <ContentsItem>
            Advanced mode
          </ContentsItem>
        </ContentsGroup>
      </Contents>
      <Anchor name="simple">Simple Instructions:</Anchor>
Access the "Mirror" 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 downloading jobs if there are some. 
<Break/>
Files are downloaded into a folder in the workspace tree called "Public
WebCache" (only present when mirroring is enabled), and can be used in all
collections built with the Librarian Interface.  When a collection is open a
second folder, "Private WebCache", appears, which only that collection can access files from.  Files in both these areas are named by their full web
URL.  A new folder is created for each host, followed by others for each part
of the path.  This ensures that each file is distinct.
<Break/>
Use the first of the download configuration controls, "Source URL",  to enter the URL of a
target resource.  If you have come from the "Hunt" view, this field points to
the last page visited.  Use the "Download Depth" control to determine how many
 hyperlinks deep to go when downloading: 0 means follow no hyperlinks and grabs just the
target resource. The depth limit is
ignored when downloading media other than html pages.  Use the "Destination Folder" radio
button control to choose whether the files are cached into the shared public
folder or the private collection-specific folder (if available). Next, there are four checkbox controls which can be set to turn on the specified feature for a specific download. A fifth checkbox control "Automatically remove failed downloads..." does not pertain to a specific download, but instead clears the list of any failed download information, and prevents any future failures from appearing in the list. The final control is a "Download" button, which adds to the download list a new job corresponding to the configuration
settings.
<Break/>
The download list has an entry for each unfinished download.  For each entry, a
central region with several lines of text and a progress bar is flanked by two
buttons.  The text gives details of the task, and updates as the task
progresses, while the bar measures progress.  The "play" triangle on the left
button starts the current task and then changes to a double vertical bar, which
pauses the current download.  The "stop" square on the right button removes the
current download task from the list.  Download tasks are removed from the list
when they finish successfully (ones that fail are controlled by the "Automatically remove failed downloads..." checkbox).
      <Anchor name="advanced">Advanced Instructions:</Anchor>
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.
    </Section>
  </Section>

  <Section name="collectingfiles">
    <Title>Collecting Files for Your Collection</Title>
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.
    <Section name="thegatherview">
      <Title>The Gather View</Title>
This section introduces the Gather area that you use to select what files
to include in the collection you are building.
      <Contents>
        <ContentsGroup linkto="simple">
          <ContentsItem>
            How to view the gather screen
          </ContentsItem>
          <ContentsItem>
            The file trees
          </ContentsItem>
          <ContentsItem>
            The status area
          </ContentsItem>
          <ContentsItem>
            Control buttons
          </ContentsItem>
        </ContentsGroup>
        <ContentsGroup linkto="advanced">
          <ContentsItem>
            Selection methods
          </ContentsItem>
          <ContentsItem>
            Special folder mapping
          </ContentsItem>
        </ContentsGroup>
      </Contents>
      <Anchor name="simple">Simple Instructions:</Anchor>
The Librarian Interface starts with the Gather view.  To return to this view
later, click the "Gather" tab directly below the menu bar.
<Break/>
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.
<Break/>
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">File Associations</Reference>).
<Break/>
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 public and private
download caches if Web mirroring is enabled.  You can copy and view these files
but you cannot move, delete, or edit them.  Navigate this space to find the
files you want to include in the collection.
<Break/>
The Collection file tree represents the contents of the collection so
far.  Initially, it is empty.
<Break/>
You can resize the spaces by mousing over the grey bar that separates the trees
(the shape of the pointer changes) and dragging.
<Break/>
Beneath is the Status Area, which describes the state of the Librarian
Interface: how many items are selected and what action is requested.  It
reports on the progress of actions that involve files, which can take some time
to complete. The "Stop" button stops any action that is currently in progress. 
<Break/>
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">Creating folders</Reference>). 
"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. 
       <Anchor name="advanced">Advanced Instructions:</Anchor>
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.
<Break/>
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 "Map", and enter a name for the folder.  To remove an item,
right-click the mapped folder and select "Unmap Folder".
    </Section>
    <Section name="creatingfolders">
      <Title>Creating Folders</Title>
<ObviousSentence>This section shows how to create new folders.</ObviousSentence>
      <Contents>
        <ContentsGroup linkto="simple">
          <ContentsItem>
            The new folder button
          </ContentsItem>
          <ContentsItem>
            The right-button menu
          </ContentsItem>
        </ContentsGroup>
      </Contents>
      <Anchor name="simple">Simple Instructions:</Anchor>
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.
<Break/>
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").
<Break/>
Folders can also be created by right-clicking over a folder, choosing "New
Folder" and proceeding as above.
    </Section>
    <Section name="addingfiles">
      <Title>Adding Files</Title>
<ObviousSentence>This section shows how to get files into your collection.</ObviousSentence>
      <Contents>
        <ContentsGroup linkto="simple">
          <ContentsItem>
            Dragging a file
          </ContentsItem>
          <ContentsItem>
            Multiple files
          </ContentsItem>
        </ContentsGroup>
        <ContentsGroup linkto="advanced">
          <ContentsItem>
            Existing metadata
          </ContentsItem>
        </ContentsGroup>
      </Contents>
      <Anchor name="simple">Simple Instructions:</Anchor>
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).
<Break/>
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.
<Break/>
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.
      <Anchor name="advanced">Advanced Instructions:</Anchor>
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">Importing Previously Assigned Metadata</Reference> 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.
    </Section>
    <Section name="removingfiles">
      <Title>Removing Files</Title>
<ObviousSentence>This section describes how to remove files and folders from your collection.</ObviousSentence>
      <Contents>
        <ContentsGroup linkto="simple">
          <ContentsItem>
            The delete button
          </ContentsItem>
          <ContentsItem>
            The delete key
          </ContentsItem>
          <ContentsItem>
            Delete by drag and drop
          </ContentsItem>
        </ContentsGroup>
      </Contents>
      <Anchor name="simple">Simple Instructions:</Anchor>
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">The Gather View</Reference>.
<Break/>
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.
    </Section>
    <Section name="filteringthetree">
      <Title>Filtering the Tree</Title>
"Filtering" the collection tree allows you to narrow down the search for particular files.
      <Contents>
        <ContentsGroup linkto="simple">
          <ContentsItem>
            The filter control
          </ContentsItem>
        </ContentsGroup>
        <ContentsGroup linkto="advanced">
          <ContentsItem>
            Custom filtering
          </ContentsItem>
        </ContentsGroup>
      </Contents>
      <Anchor name="simple">Simple Instructions:</Anchor>
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.
      <Anchor name="advanced">Advanced Instructions:</Anchor>
You can specify a custom filter by typing in a pattern to match files against.
Use standard file system abbreviations such as "*.*" or "*.doc" ("*" matches
any characters).
    </Section>
  </Section>

  <Section name="enrichingacollection">
    <Title>Enriching the Collection with Metadata</Title>
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).
    <Section name="theenrichview">
      <Title>The Enrich View</Title>
<ObviousSentence>This section describes how to input and edit metadata using the Enrich view.</ObviousSentence>
      <Contents>
        <ContentsGroup linkto="simple">
          <ContentsItem>
            The collection tree
          </ContentsItem>
          <ContentsItem>
            The MetaEdit Controls
          </ContentsItem>
          <ContentsItem>
            The value tree
          </ContentsItem>
          <ContentsItem>
            The metadata table
          </ContentsItem>
        </ContentsGroup>
      </Contents>
      <Anchor name="simple">Simple Instructions:</Anchor>
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).
<Break/>
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.  Clicking
any row transfers its details to the MetaEdit Controls below.  If several files
are selected, black text indicates that the value is common to all of the
selected files, while grey text indicates that it is not.  Black values may be
updated or removed, while grey ones can be removed from those that have it, or
appended to the others.
<Break/>
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.
<Break/>
The MetaEdit Controls at the lower right appear only when a file is selected
from the tree and a row is selected from the table.  Use them to update, append,
and remove the metadata value.  The value field is for entering or editing the
metadata value.  Beside it is a button labelled "..." which, when clicked,
opens a larger editing box.  In the buttons below, "Append" assigns the value as
new metadata and adds it to any existing values for the selected element,
"Replace" overwrites the selected existing value with the new one, and "Remove" clears
the selected value.  Underneath, labelled "All Previous Values", is the "Value
Tree".
<Break/>
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 [Enter] auto-completes the typing with the selected value.
<Break/>
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.
<Break/>
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, so the edit controls are hidden if such an entry is selected.  The
"..." button still serves to expand the value, but the text cannot be edited.
    </Section>
    <Section name="selectingmetadatasets">
      <Title>Selecting Metadata Sets</Title>
<ObviousSentence>This section explains how to specify metadata elements and how to add metadata sets to your collection.</ObviousSentence>
      <Contents>
        <ContentsGroup linkto="simple">
          <ContentsItem>
            Adding a metadata set
          </ContentsItem>
        </ContentsGroup>
        <ContentsGroup linkto="advanced">
          <ContentsItem>
            Updating a set
          </ContentsItem>
          <ContentsItem>
            Creating new sets
          </ContentsItem>
          <ContentsItem>
            Exporting a set
          </ContentsItem>
        </ContentsGroup>
      </Contents>
      <Anchor name="simple">Simple Instructions:</Anchor>
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".
<Break/>
To add a metadata set, choose "Metadata Sets" from the menu bar and select the
"Import Set" action.  A list appears that shows the sets stored in the Librarian
Interface's metadata folder.  Choose one and open it, or click "Browse" to
locate metadata set files stored elsewhere. If the metadata elements have associated value trees, you will be asked whether to import
all values associated with the elements in the set, just those values that make
up the structure of hierarchy-based metadata, or no values at all.
      <Anchor name="advanced">Advanced Instructions:</Anchor>
To install a newer version of a metadata set, simply add it as above.  The
Librarian Interface merges the sets, but does not alter values you have
entered.  You may be asked how to merge certain elements.  For example if the
current set and the one you are importing share a common element (which is
likely if you are installing a new version of a set), you are shown as much
information about the existing and new elements as possible, and asked how to
proceed.  Options include merging the elements, renaming the new one, replacing
the old element entirely, or skipping this element.  When merging two elements
you are confronted with the same options, but this time at the "attributes"
(rather than "elements") level.  You can cancel the import operation at any
time.
<Break/>
The ".mds" files are expressed in XML format.  You can edit an existing metadata
set or create a new one with an ordinary text editor.  If you are starting a
new file, copy the Document Type Definition and be sure to follow it, otherwise
the Librarian Interface will be unable to load the metadata set.  Use of an
XML validator or validating editor is recommended.
<Break/>
To export a metadata set, or part of one (e.g.  its assigned value hierarchy, or
all its values), return to the Librarian Interface and choose "Export Set" from
the "Metadata Set" menu.  You will be asked to select appropriate export
options, and a file to export into.
    </Section>
    <Section name="appendingmetadata">
      <Title>Appending New Metadata</Title>
<ObviousSentence>This section explains how to add metadata and values to files, and how to add new values for metadata elements.</ObviousSentence>
      <Contents>
        <ContentsGroup linkto="simple">
          <ContentsItem>
            Adding to files
          </ContentsItem>
          <ContentsItem>
            Adding to folders or multiple files
          </ContentsItem>
        </ContentsGroup>
        <ContentsGroup linkto="advanced">
          <ContentsItem>
            Adding to the metadata table
          </ContentsItem>
          <ContentsItem>
            Subject hierarchies
            <ContentsItem>
              Introduction to subjects
        </ContentsItem>
            <ContentsItem>
              Metadata set editor
        </ContentsItem>
          </ContentsItem>
          <ContentsItem>
            Text field entry
          </ContentsItem>
        </ContentsGroup>
        <ContentsGroup linkto="advanced">
          <ContentsItem>
            Value hierarchies and editing values
          </ContentsItem>
        </ContentsGroup>
      </Contents>
      <Anchor name="simple">Simple Instructions:</Anchor>
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.
<Break/>
Next select the metadata element you want to add by clicking its row in the
table.
<Break/>
Type the value into the value field.  Do not use the character "\", as it is
used for constructing hierarchies.  When finished, click "Append" to add the new
value as metadata for the chosen file.  The value immediately appears in the
Metadata table.
<Break/>
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.
<Break/>
When you add metadata to multiple files at once, you will be prompted for confirmation for any files that already have a value for that metadata. You are shown the name of the file in question, the element's
title, previously-assigned values for this element, and the new value.  The
buttons offer different options: "Append" appends the metadata to the file
without altering any existing values; "Append All" adds the new value to all
other files too, without requiring individual confirmation; "Skip File" proceeds to the next file; "Cancel"
undoes any changes and cancels the action.
<Break/>
If you choose metadata that occurs in some of the selected files and click
"Append", it is added to the other files in the selection too.
      <Anchor name="advanced">Advanced Instructions:</Anchor>
You can add structure to metadata values by using paths as described in <Reference target="theenrichview">The Enrich View</Reference>.  Correct any mistakes in creating hierarchies by using
the metadata set editor explained in <Reference target="editingmetadatasets">Editing Metadata Sets</Reference>.
    </Section>
    <Section name="addingpreviouslydefinedmetadata">
      <Title>Adding Previously Defined Metadata</Title>
<ObviousSentence>This section explains how to add metadata that uses values already present in the value tree.</ObviousSentence>
      <Contents>
        <ContentsGroup linkto="simple">
          <ContentsItem>
            Adding to files
          </ContentsItem>
          <ContentsItem>
            Adding to folders or multiple files
          </ContentsItem>
        </ContentsGroup>
      </Contents>
      <Anchor name="simple">Simple Instructions:</Anchor>
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
text field (alternatively, use the value tree's auto-select and auto-complete
features).  Click "Append" to add the metadata to the selected file.
<Break/>
The process of adding metadata with already-existing values to folders
or multiple files is just the same.
    </Section>
    <Section name="updatingmetadata">
      <Title>Updating Metadata</Title>
<ObviousSentence>This section explains how to update the metadata assigned to a file.</ObviousSentence>
      <Contents>
        <ContentsGroup linkto="simple">
          <ContentsItem>
            Updating files
          </ContentsItem>
          <ContentsItem>
            Updating folders or multiple files
          </ContentsItem>
        </ContentsGroup>
      </Contents>
      <Anchor name="simple">Simple Instructions:</Anchor>
To update the value of a piece of metadata, first choose the file to which that
value applies, and then the metadata element whose value you want to change.
Your selection appears in the metadata edit controls.  Edit the value field and
click "Replace" to alter the metadata.
<Break/>
The process is the same when updating a folder with child folders or multiple
files, except that when you click "Replace" you are asked what to do with the
other files.  The buttons offer different options: "Replace" replaces any
previous value with the new one; "Replace All" adds the new value in the same
way to all other files; "Skip File" skips the current file and proceeds to the
next; "Cancel" undoes any changes and cancels the action.  You can only update
metadata that is common to all files selected.  For a folder, this means that
all its contents must share the same metadata.
<Break/>
The value tree shows all previous values, not just those currently assigned.
Thus the value you have replaced will remain in the value tree.
    </Section>
    <Section name="removingmetadata">
      <Title>Removing Metadata</Title>
<ObviousSentence>This section explains how to remove metadata from a file.</ObviousSentence>
      <Contents>
        <ContentsGroup linkto="simple">
          <ContentsItem>
            Removing from files
          </ContentsItem>
          <ContentsItem>
            Removing from folders or multiple files
          </ContentsItem>
        </ContentsGroup>
        <ContentsGroup linkto="advanced">
          <ContentsItem>
            Removing from the table
          </ContentsItem>
        </ContentsGroup>
      </Contents>
      <Anchor name="simple">Simple Instructions:</Anchor>
You remove metadata the same way as you update it.  First select a file from the
file tree, then use the metadata table to select the metadata.  If the metadata
has a value assigned, the "Remove" button in the MetaEdit Controls becomes
active.  Click it to remove the metadata from the specified file.  Other files
remain unchanged, and the value remains in the Value Tree.
<Break/>
When you remove metadata from a folder, or from several files, you are
presented with various options: removing the metadata from this file, removing
it from this and all other files, and skipping this file.  You can cancel the
operation at any time.  If you choose metadata that is not common to all the
selected files and click "Remove", the metadata is removed from those
files that have it; all others are unaffected.
    </Section>
    <Section name="reviewingmetadata">
      <Title>Reviewing Assigned Metadata</Title>
<ObviousSentence>This section describes how to view all metadata assigned to an entire collection.</ObviousSentence>
      <Contents>
        <ContentsGroup linkto="simple">
          <ContentsItem>
            The audit table
          </ContentsItem>
        </ContentsGroup>
        <ContentsGroup linkto="advanced">
          <ContentsItem>
            Right button menu
          </ContentsItem>
          <ContentsItem>
            Autofilter
          </ContentsItem>
        </ContentsGroup>
      </Contents>
      <Anchor name="simple">Simple Instructions:</Anchor>
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.
<Break/>
Select the files you wish to examine, and from the "Metadata Set" menu choose "Assigned Metadata...".  A window called
"All Metadata", dominated by a large table with many columns, appears.  The
first column shows file names; the rows show all metadata values assigned to
those files.
<Break/>
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.
<Break/>
Click "Close" to hide the window.
      <Anchor name="advanced">Advanced Instructions:</Anchor>
You can also view the "All Metadata" table by selecting the files you wish to
examine, right-clicking, and choosing "Assigned Metadata...".  If a folder has
been selected, all its child files are included in the table.
<Break/>
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.
<Break/>
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.
<Break/>
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.
    </Section>
    <Section name="importingpreviouslyassignedmetadata">
      <Title>Importing Previously Assigned Metadata</Title>
This section describes how to import previously assigned metadata,
and install parsers to handle various metadata types.
      <Contents>
        <ContentsGroup linkto="simple">
          <ContentsItem>
            While adding files
          </ContentsItem>
        </ContentsGroup>
      </Contents>
      <Anchor name="simple">Simple Instructions:</Anchor>
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.
<Break/>
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.
<Break/>
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.
<Break/>
Once you have specified how to import a certain piece of metadata, the mapping
information is retained for the collection's lifetime.  To correct any mistakes
during importing, use the metadata set editor described in <Reference target="editingmetadatasets">Editing Metadata Sets</Reference>.
<Break/>
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.
    </Section>
  </Section>

  <Section name="designingacollection">
    <Title>Designing Your Collection's Appearance</Title>
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.
    <Section name="thedesignview">
      <Title>The Design View</Title>
This section introduces you to the design view and explains how to navigate
between the various views within this pane.
      <Contents>
        <ContentsGroup linkto="simple">
          <ContentsItem>
            Choosing a design section
          </ContentsItem>
        </ContentsGroup>
      </Contents>
      <Anchor name="simple">Simple Instructions:</Anchor>
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.
<Break/>
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.
<Break/>
To understand the stages and terms involved in designing a collection, first
read Chapters 1 and 2 of the Greenstone Developer's Guide.
    </Section>
    <Section name="generalsettings">
      <Title>General Settings</Title>
This section explains how to review and alter the general settings associated
with your collection.  First, under "Design Sections", click "General".
      <Contents>
        <ContentsGroup linkto="simple">
          <ContentsItem>
            General settings
          </ContentsItem>
        </ContentsGroup>
      </Contents>
      <Anchor name="simple">Simple Instructions:</Anchor>
Here the values provided during collection creation can be modified.
<Break/>
At the top of the page is an instruction box, which appears for each of the
different sections.  It contains a brief list of instructions to remind you
what functionality is available.
<Break/>
First are the contact emails of the collection's creator and maintainer.  Then
come two checkboxes for whether the collection should be publicly accessible,
and whether it is still under construction.  The following field allows you to
change the collection title.  The next one specifies (in the form of a URL) the
icon to show at the top left of the collection's "About" page, and the next is
the icon used in the Greenstone library page to link to the collection.  Finally
comes the "Collection Description" text area as described in <Reference target="creatingacollection">Creating A New Collection</Reference>.
    </Section>
    <Section name="plugins">
      <Title>Document Plugins</Title>
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".
      <Contents>
        <ContentsGroup linkto="simple">
          <ContentsItem>
            Add a plugin
          </ContentsItem>
          <ContentsItem>
            Remove a plugin
          </ContentsItem>
          <ContentsItem>
            Configure a plugin
          </ContentsItem>
          <ContentsItem>
            Change plugin order
          </ContentsItem>
        </ContentsGroup>
        <ContentsGroup linkto="advanced">
          <ContentsItem>
            Custom configuration
          </ContentsItem>
          <ContentsItem>
            Rebuilding the plugin database
          </ContentsItem>
        </ContentsGroup>
      </Contents>
      <Anchor name="simple">Simple Instructions:</Anchor>
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 a plugin may only occur once in the list.
<Break/>
To remove a plugin, select it in the list and click "Remove Plugin".
<Break/>
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 three parts: a
text field for entering custom arguments, an area containing controls for
specifying arguments, and two buttons at the bottom.
<Break/>
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.  Still
others allow multiple selections from a list.  To add a value, select it and
click "Add"; to remove it, select it and click "Remove".  To learn what an
argument does, let the mouse hover over its name for a moment and a description
will appear.
<Break/>
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.
<Break/>
The plugins in the list are executed in order, and the ordering is sometimes
important.  Two plugins, ArcPlug and RecPlug, are vital to the collection
building process, and are fixed in place at the end of the list (with a
separator line).  To change the ordering of the other ones, select the plugin you want to move
and click "Move To Top", "Move Up", "Move Down", or "Move To Bottom".
       <Anchor name="advanced">Advanced Instructions:</Anchor>
The Librarian Interface does its best to determine what arguments a plugin
supports.  However, there may be cases where the user wants to specify special
arguments, and for this a text field called "Custom Arguments" (at the top) is
provided.  Any text in it is appended verbatim to the end of the plugin
command.
    </Section>
    <Section name="searchtypes">
      <Title>Search Types</Title>
This section explains how to modify a new design feature in Greenstone, Search Types, which allow fielded searching.  Under "Design Sections", click "Search Types".
      <Contents>
        <ContentsGroup linkto="simple">
          <ContentsItem>
            What enabling advanced searches means
          </ContentsItem>
          <ContentsItem>
            Adding a new search type
          </ContentsItem>
          <ContentsItem>
            Removing a search type
          </ContentsItem>
          <ContentsItem>
            Changing the order of search types
          </ContentsItem>
        </ContentsGroup>
      </Contents>
      <Anchor name="simple">Simple Instructions:</Anchor>
When you enter the Search Types view, first check "Enable Advanced
Searches", which activates the other controls.  This migrates the collection to
Greenstone 2.4 format, which supports fielded searching, and means that (a)
the index design is different (explained in the <Reference target="searchindexes">Search Indexes</Reference> section),
(b) there are more text fragments to translate (see <Reference target="translatetext">Translation</Reference>), and (c) the collection will not be usable under older Greenstone
installations.  If you later uncheck this field, most of your collection will
be migrated back to Greenstone 2.39.  However the Librarian Interface cannot
convert the new index specifications into older ones, so you will have to
re-enter them manually.
<Break/>
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.
<Break/>
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.
<Break/>
To change to order of a search type, select it from the list and click "Move
Up" or "Move Down". The first one will be the default.
    </Section>
    <Section name="searchindexes">
      <Title>Search Indexes</Title>
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".
      <Contents>
        <ContentsGroup linkto="simple">
          <ContentsItem>
            Add an index
          </ContentsItem>
          <ContentsItem>
            Remove an index
          </ContentsItem>
          <ContentsItem>
            Set default index
          </ContentsItem>
          <ContentsItem>
            Clear default index
          </ContentsItem>
        </ContentsGroup>
      </Contents>
      <Anchor name="simple">Simple Instructions:</Anchor>
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.
<Break/>
To remove an index, select it from the list of assigned indexes and click
"Remove Index".
<Break/>
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".  To reset it, click "Clear Default".
<Break/>
If advanced searching is enabled (via the Search Types view), the index controls are different.  Each index
is based on just one data source.  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.  Indexes are removed in the same way as above, but
the default index can no longer be set -- it is simply the
first index assigned.
<Break/>
To create indexes on all sources, click the "Add All" button. 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".
    </Section>
    <Section name="partitionindexes">
      <Title>Partition Indexes</Title>
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".
<Break/>
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.

      <Section name="definefilters">
        <Title>Define Filters</Title>
<ObviousSentence>The section explains how to define a partition filter.</ObviousSentence>
        <Contents>
          <ContentsGroup linkto="simple">
            <ContentsItem>
              Add a filter
            </ContentsItem>
            <ContentsItem>
              Remove a filter
            </ContentsItem>
            <ContentsItem>
              Update a filter
            </ContentsItem>
          </ContentsGroup>
        </Contents>
        <Anchor name="simple">Simple Instructions:</Anchor>
Filters allows you to group together into a subcollection all documents in an
index for which a metadata value matches a given pattern.
<Break/>
To create a filter, click the "Define Filters" tab and enter a name for the
new filter into the "Name the subcollection filter" 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.
<Break/>
To remove a filter, select it from the list and click "Remove Filter".
<Break/>
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.
      </Section>
      <Section name="assignpartitions">
        <Title>Assign Partitions</Title>
<ObviousSentence>This section explains how to assign a previous defined partition filter.</ObviousSentence>
        <Contents>
          <ContentsGroup linkto="simple">
            <ContentsItem>
              Add a partition
            </ContentsItem>
            <ContentsItem>
              Remove a partition
            </ContentsItem>
            <ContentsItem>
              Set default partition
            </ContentsItem>
            <ContentsItem>
              Clear default partition
            </ContentsItem>
          </ContentsGroup>
        </Contents>
        <Anchor name="simple">Simple Instructions:</Anchor>
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".
<Break/>
To remove a partition, select it from the list and click "Remove Partition".
<Break/>
To make a partition the default one, select it from the list and click "Set
Default".
<Break/>
To clear the default partition, click "Clear Default".
      </Section>
      <Section name="assignlanguages">
        <Title>Assign Languages</Title>
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.
        <Contents>
          <ContentsGroup linkto="simple">
            <ContentsItem>
              Language controls
            </ContentsItem>
            <ContentsItem>
              Add language
            </ContentsItem>
            <ContentsItem>
              Remove language
            </ContentsItem>
            <ContentsItem>
              Set default language
            </ContentsItem>
            <ContentsItem>
              Clear default language
            </ContentsItem>
          </ContentsGroup>
        </Contents>
        <Anchor name="simple">Simple Instructions:</Anchor>
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".
<Break/>
To remove a language, select it from the "Language Selection" list and click
"Remove Language".
<Break/>
To set the default language, select it from the list and click "Set Default".
<Break/>
To clear the default language, click "Clear Default".
      </Section>
    </Section>
    <Section name="xcollectionsearching">
      <Title>Cross-Collection Searching</Title>
Greenstone can search across several different collections as though they were
one.  This is done by creating a "super-collection" that comprises the
individual collections.  Under "Design Sections", click "Cross-Collection Search".
      <Contents>
        <ContentsGroup linkto="simple">
          <ContentsItem>
            Selecting a collection
          </ContentsItem>
        </ContentsGroup>
      </Contents>
      <Anchor name="simple">Simple Instructions:</Anchor>
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.
<Break/>
For further details, see Chapter 1 of the Greenstone Developer's Guide.
    </Section>
    <Section name="classifiers">
      <Title>Classifiers</Title>
This section explains how to assign "classifiers", which are used for browsing,
to the collection.  Under "Design Sections", click "Browsing Classifiers".
      <Contents>
        <ContentsGroup linkto="simple">
          <ContentsItem>
            Classifier selection and configuration
          </ContentsItem>
          <ContentsItem>
            Add a classifier
          </ContentsItem>
          <ContentsItem>
            Remove a classifier
          </ContentsItem>
          <ContentsItem>
            Configure a classifier
          </ContentsItem>
          <ContentsItem>
            Alter classifier ordering
          </ContentsItem>
        </ContentsGroup>
        <ContentsGroup linkto="advanced">
          <ContentsItem>
            CustomAZList
          </ContentsItem>
        </ContentsGroup>
      </Contents>
      <Anchor name="simple">Simple Instructions:</Anchor>
To add a classifier, select it using the "Select classifier to add" pull-down list near the
bottom and then click "Add Specified Classifier".  A window appears entitled
"Configuring Arguments"; instructions for this dialog are just the same as for
plugins (see <Reference target="plugins">Document Plugins</Reference>).  Once you have configured the new
classifier, it is added to the end of the "Currently Assigned Classifiers"
list.
<Break/>
To remove a classifier, select it from the list and click "Remove Selected
Classifier".
<Break/>
To change the arguments a classifier, select it from the list and click
"Configure Selected Classifier" (or double-click on the classifier in the
list).
<Break/>
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 To Top", "Move Up", "Move Down", or "Move To Bottom".
<Break/>
For further information on classifiers read Chapter 2, Greenstone
Developer's Guide -- Getting the most out of your documents.
      <Anchor name="advanced">Advanced Instructions:</Anchor>
The CustomAZList classifier is a special classifier that builds an alphabetical
selection list ("AZList") and allows you to specify the letter ranges.  This
classifier has its own configuration dialogue.  When a metadata element is
selected, the "Ranges" tree automatically becomes populated with appropriate
values.  Expand or collapse the tree as desired.  Select any two values and
click "Merge" to specify a range, or select a previously merged value and click
"Split" to restore the values contained within.  When satisfied with the ranges,
click "OK" to begin processing the documents in the collection.  You can
"Cancel" the dialog without making any changes to the collection.
    </Section>
    <Section name="formatstatements">
      <Title>Format Features</Title>
Format commands control the structure and appearance of the collection.  They
affect such things as where buttons appear when a document is shown, and what
links are displayed by the DateList classifier.  Format commands are not easy
to develop, and you should read Chapter 2 of the Greenstone Developer's Guide.
This section discusses the format settings, and how the Librarian Interface
gives access to them.  Under "Design Sections", click "Format Features".
      <Contents>
        <ContentsGroup linkto="simple">
          <ContentsItem>
            Formatting
          </ContentsItem>
          <ContentsItem>
            Add format command
          </ContentsItem>
          <ContentsItem>
            Remove format command
          </ContentsItem>
          <ContentsItem>
            Update format command
          </ContentsItem>
        </ContentsGroup>
        <ContentsGroup linkto="advanced">
          <ContentsItem>
            Extended formatting options
          </ContentsItem>
        </ContentsGroup>
      </Contents>
      <Anchor name="simple">Simple Instructions:</Anchor>
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".
<Break/>
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
otherwise specified.
<Break/>
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.
<Break/>
To remove a format command, select it from the list and click "Remove Format".
<Break/>
To change a format command, select it from the list, modify the settings, and
click "Replace Format".
<Break/>
For more information about variables and the feature components, read Chapter 2
of the Greenstone Developer's Guide.
      <Anchor name="advanced">Advanced Instructions:</Anchor>
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.
    </Section>
    <Section name="translatetext">
      <Title>Translate Text</Title>
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".
      <Contents>
        <ContentsGroup linkto="simple">
          <ContentsItem>
            Add translation
          </ContentsItem>
          <ContentsItem>
            Remove translation
          </ContentsItem>
          <ContentsItem>
            Update translation
          </ContentsItem>
        </ContentsGroup>
      </Contents>
      <Anchor name="simple">Simple Instructions:</Anchor>
First choose the 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.
<Break/>
To remove an existing translation, select it in the "Assigned Translations"
table and click "Remove Translation".
<Break/>
To edit a translation, select it, edit it in the "Translated Text" text
area, and click "Replace Translation".
    </Section>
    <Section name="metadatasets">
      <Title>Metadata Sets</Title>
This section explains the metadata set review panel.
Under "Design Sections", click "Metadata Sets".
      <Contents>
        <ContentsGroup linkto="simple">
          <ContentsItem>
            Available metadata sets
          </ContentsItem>
        </ContentsGroup>
      </Contents>
      <Anchor name="simple">Simple Instructions:</Anchor>
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.  This view is
read-only.
    </Section>
  </Section>

  <Section name="producingthecollection">
    <Title>Producing Your Collection</Title>
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.
    <Section name="thecreateview">
      <Title>The Create View</Title>
<ObviousSentence>This section explains the Create view used to produce a collection.</ObviousSentence>
      <Contents>
        <ContentsGroup linkto="simple">
          <ContentsItem>
      </ContentsItem>
    </ContentsGroup>
      </Contents>
The Create view is used to create the collection by running Greenstone
collection-building scripts on the information you have provided.  This is
generally straightforward: just click "Build Collection" at the bottom of the
screen.  However, the building process can be customized.  You can also use 
this view to review details of previous attempts to build this collection,
whether successful or not.
<Break/>
The buttons for building and cancelling the building process are at the bottom.
Above appears a group of controls titled "Collection Import &amp; Build Options".
To the left is a list of three items, and to the right is a pane that reflects
the currently chosen item in the list, as described in the following sections.
<Break/>
Clicking "Build Collection" initiates the collection building process.  The time
this takes depends on the size of the collection and the number of indexes
being created (for huge collections it can be hours).  To cancel the process at
any time, click "Cancel Build".
    </Section>
    <Section name="buildsettings">
      <Title>Import and Build Settings</Title>
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.
      <Contents>
        <ContentsGroup linkto="simple">
          <ContentsItem>
            General settings
          </ContentsItem>
          <ContentsItem>
            Import settings
          </ContentsItem>
          <ContentsItem>
            Build settings
          </ContentsItem>
        </ContentsGroup>
      </Contents>
      <Anchor name="simple">Simple Instructions:</Anchor>
The first two entries in the list on the left are "Import" and "Build", which
give settings that apply to the import and build scripts respectively.
<Break/>
Controlling the various settings is done in a similar way to the
"Configuring Arguments" window described in the <Reference target="plugins">Document Plugins</Reference> 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).
    </Section>
    <Section name="messagelog">
      <Title>Message Log</Title>
<ObviousSentence>This section explains the message log.</ObviousSentence>
      <Contents>
        <ContentsGroup linkto="simple">
          <ContentsItem>
            Message log
          </ContentsItem>
        </ContentsGroup>
      </Contents>
      <Anchor name="simple">Simple Instructions:</Anchor>
The third item on the left is "Message Log".  This shows the output that
Greenstone generated when it built the collection before.  Select the
log you want by clicking on the desired date in the "Log History" list.
    </Section>
    <Section name="theprogressview">
      <Title>The Progress View</Title>
<ObviousSentence>This section explains the building progress view.</ObviousSentence>
      <Contents>
        <ContentsGroup linkto="simple">
          <ContentsItem>
            Measuring progress
          </ContentsItem>
        </ContentsGroup>
      </Contents>
      <Anchor name="simple">Simple Instructions:</Anchor>
When you start to build a collection, the view changes immediately.  The
controls described <Reference target="thecreateview">previously</Reference> are replaced by two
progress bars and a text area.  The bars indicate progress through the import
phase, then the build phase.  The text area shows the Message Log mentioned in
the <Reference target="messagelog">previous section</Reference>.
    </Section>
  </Section>

  <Section name="previewingthecollection">
    <Title>Previewing the Collection</Title>
<ObviousSentence>This section explains how to use the "Preview" view to inspect the collection you have produced.</ObviousSentence>
    <Section name="thepreviewview">
      <Title>The Preview View</Title>
<ObviousSentence>This section explains how to use the "Preview" view to inspect the collection you have produced.</ObviousSentence>
      <Contents>
        <ContentsGroup linkto="simple">
          <ContentsItem>
            Browsing the preview
          </ContentsItem>
        </ContentsGroup>
      </Contents>
      <Anchor name="simple">Simple Instructions:</Anchor>
Once you have built a collection the "Preview" tab on the main screen becomes
enabled.  This allows you to inspect the new collection.  It shows a simplified
Web browser with initial page (and home page) set to the new collection's "About" page.  You can navigate the collection using standard hyperlink clicks.
    </Section>
  </Section>

  <Section name="miscellaneous">
    <Title>Miscellaneous</Title>
This section describes features of the Librarian Interface that are not associated
with any particular view.
    <Section name="preferences">
      <Title>Preferences</Title>
This section explains the preferences dialog, accessed by opening "File" -> "Preferences".
      <Contents>
        <ContentsGroup linkto="simple">
          <ContentsItem>
            Workflow
          </ContentsItem>
          <ContentsItem>
            Connection
          </ContentsItem>
          <ContentsItem>
            Warnings
          </ContentsItem>
        </ContentsGroup>
      </Contents>
      <Anchor name="simple">Simple Instructions:</Anchor>
There are three "General" options.  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).
<Break/>
If "Show File Size" is checked, the file size is shown next to each file in the Workspace and Collection file trees in the Gather and Enrich views.
<Break/>
The third "General" option is a pull-down list of the various languages that
the Librarian Interface can be presented in.  These correspond to the
dictionaries located in the "classes" folder of the Librarian Interface's
directory.  If you change the dictionary by choosing one from the list, you must
restart the Librarian Interface in order to load the new language strings from
the dictionary.
<Break/>
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.
<Break/>
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 Browsing or
Mirroring your files; see 3.0 and 4.0 for details).  Check the box to enable
proxy connection and supply details of the proxy host address and port number.
The proxy connection is established when you close the Preferences dialog.
<Break/>
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.
    </Section>
    <Section name="fileassociations">
      <Title>File Associations</Title>
The Librarian Interface uses particular application programs to open particular
file types.  This section explains how to assign and edit these file
associations.
      <Contents>
        <ContentsGroup linkto="simple">
          <ContentsItem>
            Add association
          </ContentsItem>
          <ContentsItem>
            Edit association
          </ContentsItem>
          <ContentsItem>
            Remove association
          </ContentsItem>
        </ContentsGroup>
      </Contents>
      <Anchor name="simple">Simple Instructions:</Anchor>
To alter file associations open the "File" menu and click "File
Associations...".
<Break/>
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 Association" is enabled and can be clicked to add the association.
<Break/>
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 Association".
<Break/>
To remove an association, select an existing file extension and click "Remove Association".
(The file extension remains in the "For Files Ending" pull-down list.)
<Break/>
File associations are stored in the Librarian Interface's main folder, in a file
called "associations.xml".
    </Section>
    <Section name="exportingcollections">
      <Title>Exporting Collections to CD-ROM</Title>
      This section describes how to export collections to Windows CD-ROM, and the Export Collection Prompt.
      <Contents>
        <ContentsGroup linkto="simple">
          <ContentsItem>
            How to export
          </ContentsItem>
        </ContentsGroup>
      </Contents>
      <Anchor name="simple">Simple Instructions:</Anchor>
      Greenstone can export one or more collections to a Windows self-installing CD-ROM. To use this feature you need to have installed the 'Export to CD-ROM' package that comes with Greenstone. This is not included by default, so you may need to 'modify' your Greenstone installation to include this.
      <Break/>
      To export a collection, open the "File" menu and choose "Export to CD-ROM". A list of your Greenstone collections appears. Click on a collection to see its description. Tick the check boxes of those collections you want exported. You can enter the name of the CD-ROM in the box: this is what will appear in the Start menu when the resulting CD has been installed. Then click "Export" to start the process. The exporting process involves copying many files and may take a few minutes.
      <Break/>
      At the completion of exporting, you will be told the name of the folder where the collections have been exported to. To make a CD-ROM, you need to copy the contents of this folder onto a blank CD-ROM using a CD writer.
    </Section>
  </Section>

  <Section name="metadatasetandprofileediting">
    <Title>Metadata Set and Profile Editing</Title>
This section explains how to edit metadata sets used by the Librarian
Interface.  This is the only way to remove a value from the "Previous Values"
tree.  Although you can use the Enrich view to remove a certain value
from a record, the value remains in the value tree.  To remove it (or any
part of the metadata set, including its elements), use the metadata set editor.
<Break/>
The same tool is used to alter the instructions that map metadata from files
imported into the collection to existing metadata sets.  These are called
"importing profiles".
<Break/>
To edit a metadata set or importing profile, choose "Metadata Sets" from the menu
bar and select the "Edit Set" action.
    <Section name="editingmetadatasets">
      <Title>Editing Metadata Sets</Title>
<ObviousSentence>This section describes how to edit metadata sets and previously assigned values.</ObviousSentence>
      <Contents>
        <ContentsGroup linkto="simple">
          <ContentsItem>
            Editing sets
          </ContentsItem>
          <ContentsItem>
            Editing elements
          </ContentsItem>
        </ContentsGroup>
      </Contents>
      <Anchor name="simple">Simple Instructions:</Anchor>
On the left of the "Edit Metadata Sets" dialog is a list showing what metadata
sets and profiles can be edited.  Click one of these and its details will
appear on the right in one or more tables.  Beneath are buttons for adding,
editing or removing the various parts; alongside them is the "Close" button.
Many buttons are greyed out initially, and are activated by selections in the
tables.  Now we describe how to edit sets and elements.
<Break/>
To define a new metadata set, beside "Set" click "Add", fill out the
information requested, and click "OK".  "Namespace" is a short identifier for
the new set (e.g.  "dc" for Dublin Core; "dls" for the Development Library
Subset).
<Break/>
To remove a metadata set, select it in the list on the left and click "Remove".
A confirmation prompt will appear; confirming it <strong>permanently</strong>
removes the set and all associated metadata.
<Break/>
Some information is associated with each metadata set, such as its creator and
creation date.  We call these "attributes" of the metadata set, and you can
alter them.
Beside "Attribute", click "Add" to add an attribute to the selected metadata
set, fill in the requested information -- name, language and values -- and
click "OK".  Each metadata set is considered unique, so for a new metadata set
the pull-down list for the name and value are initially empty.  Beside
"Attribute", "Edit" becomes active when an attribute is selected in the table
and leads to the same dialog as "Add" (except that the current value is already
filled out).  Beside "Attribute", "Remove" becomes active when the attribute is
selected; when clicked the attribute is removed.
<Break/>
Double clicking on a set in the list on the left will display a list of metadata elements in that set. You can add an element, remove it, and remove values from
it.  To add an element, beside "Element" click "Add" and specify the new
element's name.
<Break/>
To remove a metadata element, select it and beside "Element" click "Remove".
This <strong>permanently</strong> removes the element and all metadata
associated with it.
<Break/>
Just as information is associated with each metadata set, information can also
be associated with each metadata element -- metadata about metadata!  Again we
call these "attributes"; Examples are a language-specific name for the element,
its definition, or perhaps a general comment.
<Break/>
You edit the attributes of an element in the same way that you edit the
attributes of a metadata set, explained above.  In this case the pull-down
lists in the add and edit prompts may contain values from the same attribute of
other elements within the set. 
<Break/>
You can also alter the "value tree" for an element, which
contains all the values that have been assigned to it.  You
can "Add" a value whenever an element is selected.  Choose a parent folder
(if any), enter the value and click "OK" to put the
new value in the tree.  You can "Edit" a value that you have selected in the
value tree; click "OK" to commit the changes.  Note that changing the parent
subject will cause the value to be moved to that subject.  You can "Remove" a
value that you have selected in the tree -- but note that this does
<strong>not</strong> remove all metadata referring to this value, and if the
value is still in use it will be restored the next time you save.
<Break/>
Once you have finished changing the metadata set, click "Close".
    </Section>
    <Section name="editingimportprofiles">
      <Title>Editing Metadata Import Profiles</Title>
<ObviousSentence>This section describes how to edit metadata importing profiles.</ObviousSentence>
      <Contents>
        <ContentsGroup linkto="simple">
          <ContentsItem>
            Editing profiles
          </ContentsItem>
        </ContentsGroup>
      </Contents>
      <Anchor name="simple">Simple Instructions:</Anchor>
Double-click the "Importing Profiles" item to see a list of importing profiles
for importing from other collections into this one.  Each profile is named
after the collection to which it applies -- that is, the collection that
documents are coming from.  You can add a profile by clicking "Add" beside
"Profile" and specifying the name of the collection that it should apply to.  You
can remove a profile by selecting it and click "Remove" beside "Profile".
<Break/>
When a profile is selected, its mapping table appears.  Each line gives a
correspondence between a metadata element in the collection that the metadata
comes from, and a metadata element in the collection being constructed.  You
can edit this table.  To add a new mapping, select a source profile, then click
"Add" beside "Attribute".  The standard attribute dialog box appears, except
that the language field is disabled and the "Values" pull-down list contains
all the elements currently available in the collection.  Mappings can be edited
and removed as described above.
<Break/>
Once you have finished changing the metadata importing profile, click "Close".
    </Section>
  </Section>
</Document>