source: trunk/gli/help/en/help.xml@ 11596

<Document>
<Section name="introduction">
<Title>
<Text id="1">Introduction</Text>
</Title>
<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>
<Section name="ofmiceandmenus">
<Title>
<Text id="3">Of Mice and Menus</Text>
</Title>
<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>
<Text id="5">The Librarian Interface follows Microsoft Windows conventions and draws upon ordinary knowledge of Windows.</Text>
<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>
<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>
<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>
<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>
<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>
<Text id="11">Exit the Librarian Interface program by choosing "Exit" from the "File" menu.  Your collection will be saved first.</Text>
</Section>
<Section name="howtoavoidthisdocument">
<Title>
<Text id="12">How to Avoid Reading This Document</Text>
</Title>
<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>
<Text id="14">The "Help" menu item marks what may be the most appropriate help item with a little book icon.</Text>
<Text id="15">For many controls, if you station the mouse over them a "tool tip" appears that says what they do.</Text>
<Text id="16">Before using the Librarian Interface, first read the Greenstone documentation.</Text>
</Section>
</Section>
<Section name="startingoff">
<Title>
<Text id="17">Starting Off</Text>
</Title>
<Text id="18">This section covers how to create, load, save and delete collections.</Text>
<Section name="creatingacollection">
<Title>
<Text id="19">Creating a New Collection</Text>
</Title>
<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>
<Text id="21">"Collection title" is the text displayed at the top of your collection's home page.  It can be any length.</Text>
<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>
<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>
<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>
<Text id="25">Clicking "Cancel" returns you to the main screen immediately.</Text>
</Section>
<Section name="savingacollection">
<Title>
<Text id="26">Saving the Collection</Text>
</Title>
<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>
<Text id="28">The Librarian Interface protects your work by saving it whenever you exit the program or load another collection.</Text>
<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>
</Section>
<Section name="openingacollection">
<Title>
<Text id="30">Opening an Existing Collection</Text>
</Title>
<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>
<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>
<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>
</Section>
<Section name="deletingcollections">
<Title>
<Text id="34">Deleting Collections</Text>
</Title>
<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>
</Section>
</Section>
<Section name="downloadingfiles">
<Title>
<Text id="36">Downloading Files From the Internet</Text>
</Title>
<Text id="37">The "Download" view helps you download resources from the internet. This section explains the Librarian Interface's mirroring process.</Text>
<Section name="themirrorview">
<Title>
<Text id="38">The Download view</Text>
</Title>
<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>
<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>
<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>
<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>
<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>
</Section>
</Section>
<Section name="collectingfiles">
<Title>
<Text id="44">Collecting Files for Your Collection</Text>
</Title>
<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>
<Section name="thegatherview">
<Title>
<Text id="46">The Gather View</Text>
</Title>
<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>
<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>
<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>
<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>
<Text id="51">The Collection file tree represents the contents of the collection so far.  Initially, it is empty.</Text>
<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>
<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>
<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>
<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>
<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>
</Section>
<Section name="creatingfolders">
<Title>
<Text id="57">Creating Folders</Text>
</Title>
<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>
<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>
<Text id="60">Folders can also be created by right-clicking over a folder, choosing "New Folder" and proceeding as above.</Text>
</Section>
<Section name="addingfiles">
<Title>
<Text id="61">Adding Files</Text>
</Title>
<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>
<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>
<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>
<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>
</Section>
<Section name="removingfiles">
<Title>
<Text id="66">Removing Files</Text>
</Title>
<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>
<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>
</Section>
<Section name="filteringthetree">
<Title>
<Text id="69">Filtering the Tree</Text>
</Title>
<Text id="70">"Filtering" the collection tree allows you to narrow down the search for particular files.</Text>
<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>
<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>
</Section>
</Section>
<Section name="enrichingacollection">
<Title>
<Text id="73">Enriching the Collection with Metadata</Text>
</Title>
<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>
<Section name="theenrichview">
<Title>
<Text id="75">The Enrich View</Text>
</Title>
<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>
<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>
<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>
<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>
<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>
<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>
</Section>
<Section name="selectingmetadatasets">
<Title>
<Text id="82">Selecting Metadata Sets</Text>
</Title>
<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> 
<Text id="84">To control the metadata sets used in a collection, use the "Metadata Sets" entry on the Design view.</Text>
</Section>
<Section name="appendingmetadata">
<Title>
<Text id="85">Appending New Metadata</Text>
</Title>
<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>
<Text id="87">Next select the metadata element you want to add by clicking its row in the table.</Text>
<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>
<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>
</Section>
<Section name="addingpreviouslydefinedmetadata">
<Title>
<Text id="90">Adding Previously Defined Metadata</Text>
</Title>
<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>
<Text id="92">The process of adding metadata with already-existing values to folders or multiple files is just the same.</Text>
</Section>
<Section name="updatingmetadata">
<Title>
<Text id="93">Editing or Removing Metadata</Text>
</Title>
<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>
<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>
<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>
</Section>
<Section name="reviewingmetadata">
<Title>
<Text id="97">Reviewing Assigned Metadata</Text>
</Title>
<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>
<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>
<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>
<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>
<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>
<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>
</Section>
<Section name="importingpreviouslyassignedmetadata">
<Title>
<Text id="104">Importing Previously Assigned Metadata</Text>
</Title>
<Text id="105">This section describes how to import previously assigned metadata: metadata assigned to documents before they were added to the collection.</Text>
<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>
<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>
<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>
<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>
</Section>
</Section>
<Section name="designingacollection">
<Title>
<Text id="110">Designing Your Collection's Appearance</Text>
</Title>
<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>
<Section name="thedesignview">
<Title>
<Text id="112">The Design View</Text>
</Title>
<Text id="113">This section introduces you to the design view and explains how to navigate between the various views within this pane.</Text>
<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>
<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>
<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>
</Section>
<Section name="generalsettings">
<Title>
<Text id="117">General</Text>
</Title>
<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>
<Text id="119">Here the values provided during collection creation can be modified.</Text>
<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>
</Section>
<Section name="plugins">
<Title>
<Text id="121">Document Plugins</Text>
</Title>
<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>
<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>
<Text id="124">To remove a plugin, select it in the list and click "Remove Plugin".</Text>
<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>
<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>
<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>
<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>
</Section>
<Section name="searchtypes">
<Title>
<Text id="129">Search Types</Text>
</Title>
<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>
<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>
<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>
<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>
</Section>
<Section name="searchindexes">
<Title>
<Text id="134">Search Indexes</Text>
</Title>
<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>
<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>
<Text id="137">To edit an index, select it and change the index details, then click "Replace Index".</Text>
<Text id="138">To remove an index, select it from the list of assigned indexes and click "Remove Index".</Text>
<Text id="139">To create an index covering text and all metadata, click "Add All".</Text>
<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>
<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>
<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>
</Section>
<Section name="partitionindexes">
<Title>
<Text id="143">Partition Indexes</Text>
</Title>
<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>
<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>
<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>
<Section name="definefilters">
<Title>
<Text id="147">Define Filters</Text>
</Title>
<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>
<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>
<Text id="150">To remove a filter, select it from the list and click "Remove Filter".</Text>
<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>
</Section>
<Section name="assignpartitions">
<Title>
<Text id="152">Assign Partitions</Text>
</Title>
<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>
<Text id="154">To remove a partition, select it from the list and click "Remove Partition".</Text>
<Text id="155">To make a partition the default one, select it from the list and click "Set Default".</Text>
</Section>
<Section name="assignlanguages">
<Title>
<Text id="156">Assign Languages</Text>
</Title>
<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>
<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>
<Text id="159">To remove a language, select it from the "Language Selection" list and click "Remove Language".</Text>
<Text id="160">To set the default language, select it from the list and click "Set Default".</Text>
</Section>
</Section>
<Section name="xcollectionsearching">
<Title>
<Text id="161">Cross-Collection Search</Text>
</Title>
<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>
<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>
<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>
<Text id="165">For further details, see Chapter 1 of the Greenstone Developer's Guide.</Text>
</Section>
<Section name="classifiers">
<Title>
<Text id="166">Browsing Classifiers</Text>
</Title>
<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>
<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>
<Text id="169">To remove a classifier, select it from the list and click "Remove Classifier".</Text>
<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>
<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>
<Text id="172">For further information on classifiers read Chapter 2, Greenstone Developer's Guide -- Getting the most out of your documents.</Text>
</Section>
<Section name="formatstatements">
<Title>
<Text id="173">Format Features</Text>
</Title>
<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>
<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>
<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
otherwise specified.</Text>
<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>
<Text id="178">To remove a format command, select it from the list and click "Remove Format".</Text>
<Text id="179">To change a format command, select it from the list, modify the settings, and click "Replace Format".</Text>
<Text id="180">For more information about variables and the feature components, read Chapter 2 of the Greenstone Developer's Guide.</Text>
<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>
</Section>
<Section name="translatetext">
<Title>
<Text id="182">Translate Text</Text>
</Title>
<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>
<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>
<Text id="185">To remove an existing translation, select it in the "Assigned Translations" table and click "Remove Translation".</Text>
<Text id="186">To edit a translation, select it, edit it in the "Translated Text" text area, and click "Replace Translation".</Text>
</Section>
<Section name="metadatasets">
<Title>
<Text id="187">Metadata Sets</Text>
</Title>
<Text id="188">This section explains the metadata set review panel. Under "Design Sections", click "Metadata Sets".</Text>
<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>
<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>
<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>
<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>
</Section>
</Section>
<Section name="producingthecollection">
<Title>
<Text id="193">Producing Your Collection</Text>
</Title>
<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>
<Section name="thecreateview">
<Title>
<Text id="195">The Create View</Text>
</Title>
<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>
<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>
<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>
</Section>
<Section name="buildsettings">
<Title>
<Text id="199">Import and Build Settings</Text>
</Title>
<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>
<Text id="201">Controlling the various settings is done in a similar way to the
"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>
</Section>
</Section>
<Section name="miscellaneous">
<Title>
<Text id="202">Miscellaneous</Text>
</Title>
<Text id="203">This section describes features of the Librarian Interface that are not associated with any particular view.</Text>
<Section name="preferences">
<Title>
<Text id="204">Preferences</Text>
</Title>
<Text id="205">This section explains the preferences dialog, accessed by opening "File" -> "Preferences".</Text>
<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>
<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>
<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>
<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>
<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>
<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>
</Section>
<Section name="fileassociations">
<Title>
<Text id="212">File Associations</Text>
</Title>
<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>
<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>
<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>
<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>
<Text id="217">File associations are stored in the Librarian Interface's main folder, in a file called "associations.xml".</Text>
</Section>
<Section name="exportingcollections">
<Title>
<Text id="218">Exporting Collections to CD/DVD</Text>
</Title>
<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>
<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>
<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>
</Section>
</Section>
</Document>