root/gli/trunk/help/en/help.xml @ 15365

Revision 15365, 66.7 KB (checked in by anna, 12 years ago)

Fixed several typos and removed one sentence that is not applicable.

  • Property svn:keywords set to Author Date Id Revision
Line 
1<?xml version="1.0"?>
2<!DOCTYPE TutorialList [
3     <!ENTITY nbsp "&#160;">
4     <!ENTITY rarr "&#8594;">
5     <!ENTITY mdash "&#8212;">
6]>
7<Document>
8<Section name="introduction">
9<Title>
10<Text id="1">Introduction</Text>
11</Title>
12<Text id="2">The Greenstone Librarian Interface is a tool for collecting documents, adding metadata, then building digital library collections. It provides access to the Greenstone Digital Library Software's functionality from a graphical point and click interface.</Text>
13<Section name="ofmiceandmenus">
14<Title>
15<Text id="3">Of Mice and Menus</Text>
16</Title>
17<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>
18<Text id="5">The Librarian Interface follows Microsoft Windows conventions and draws upon ordinary knowledge of Windows.</Text>
19<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>
20<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>
21<Text id="8">You can use the keyboard to type into text fields. [Tab] enables one to navigate among multiple text fields.</Text>
22<Text id="11">Exit the Librarian Interface program by choosing "Exit" from the "File" menu.  Your collection will be saved first.</Text>
23</Section>
24<Section name="howtoavoidthisdocument">
25<Title>
26<Text id="12">How to Avoid Reading This Document</Text>
27</Title>
28<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>
29<Text id="14">Clicking on the "Help" icon in a given context either brings up the relevant help text or marks the relevant help heading with a question mark icon.</Text>
30<Text id="15">For many controls, if you station the mouse over them a "tool tip" appears that says what they do.</Text>
31<Text id="16">Before using the Librarian Interface, first read the Greenstone documentation.</Text>
32</Section>
33</Section>
34<Section name="startingoff">
35<Title>
36<Text id="17">Starting Off</Text>
37</Title>
38<Text id="18">This section covers how to create, load, save and delete collections.</Text>
39<Section name="creatingacollection">
40<Title>
41<Text id="19">Creating a New Collection</Text>
42</Title>
43<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 Format view.</Text>
44<Text id="21">"Collection title" is the text displayed at the top of your collection's home page.  It can be any length.</Text>
45<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>
46<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". Default new collections have a standard configuration and use the Dublin Core metadata set. These can be changed later.</Text>
47<Text id="24">Click "OK" to create the collection. </Text>
48<Text id="25">Clicking "Cancel" returns you to the main screen immediately.</Text>
49</Section>
50<Section name="savingacollection">
51<Title>
52<Text id="26">Saving the Collection</Text>
53</Title>
54<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>
55<Text id="28">The Librarian Interface protects your work by saving it whenever you exit the program or load another collection.</Text>
56<Text id="29a">Collections are saved to a folder within your Greenstone installation's "collect" folder, named with a short version of the collection name. Documents are saved to the "import" sub-folder, and metadata is saved to "metadata.xml" files within this folder. Configuration information is saved to the "collect.cfg" file within the "etc" sub-folder. Some information is also saved in a file named for the collection and with file extension ".col".</Text>
57</Section>
58<Section name="openingacollection">
59<Title>
60<Text id="30">Opening an Existing Collection</Text>
61</Title>
62<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.</Text>
63<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.  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. Feel free to do so unless you think that someone else is currently working on the same collection.</Text>
64<Text id="33">When you open a collection that the Greenstone Librarian Interface did not create, the Dublin Core metadata set will be assigned to it, and any existing 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>
65</Section>
66<Section name="deletingcollections">
67<Title>
68<Text id="34">Deleting Collections</Text>
69</Title>
70<Text id="35">To permanently delete collections from your Greenstone installation, choose "Delete..." from the "File" menu. A list of your collections appears. Select one to see its description, then tick the box at the bottom of the dialog and click "Delete". This action is irreversible, so be careful.</Text>
71</Section>
72</Section>
73<Section name="downloadingfiles">
74<Title>
75<Text id="36">Downloading Files From the Internet</Text>
76</Title>
77<Text id="37">The <AutoText key="glidict::GUI.Download"/> view helps you download resources from the Internet. This section explains the Librarian Interface's downloading process.</Text>
78<Section name="themirrorview">
79<Title>
80<Text id="38">The Download view</Text>
81</Title>
82<Text id="39">This section describes how to configure a download task and control the downloading process. Access the <AutoText key="glidict::GUI.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 download jobs. </Text>
83<Text id="39a">There are several protocols that can be used for downloading records, and these are listed on the left hand side at the top.</Text>
84<Text id="39b"><b>Web:</b> downloads web pages and files via HTTP and FTP.</Text>
85<Text id="39c"><b>OAI:</b> downloads metadata records from an OAI (Open Archives Initiative) server.</Text>
86<Text id="39d"><b>Z3950:</b> downloads MARC records that match a particular search criterion from a Z3950 server.</Text>
87<Text id="39e"><b>SRW:</b> downloads MARCXML records that match a particular search criterion from an SRW server.</Text>
88<Text id="39f">Select the appropriate type by clicking it in the left hand list. The right-hand side displays the options available for the selected download type. To find out what an option does, hover the mouse over it: a tool-tip explaining the option will appear. Some options are 'optional': these are presented with a check box which must be ticked on for the option to be used. Others are 'required': these have no check box, and a value must be given before the download is carried out. </Text>
89<Text id="39g">Once the configuration is set up, click <AutoText key="glidict::Download.ServerInformation"/> to check the connection to the server and view some basic information about the web page or server, or click <AutoText key="glidict::Mirroring.Download"/> to start the download. </Text>
90<Text id="39g-1">There are two other buttons: "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. You will need to set up proxy information if you use a proxy server to connect to the Internet. If authentication is needed when a download is being processed, the proxy server will prompt for username and password.  The Librarian Interface does not store passwords between sessions.</Text>
91<Text id="40">Files are downloaded into a folder called <AutoText key="glidict::Tree.DownloadedFiles"/> (only present when downloading is enabled), and can be used in any collections.  Files are named by their full web URL (for Web downloads) or a combination of URL and option values (for other download types). 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>
92<Text id="42">The download list has an entry for each download processed. 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 to pause a task. "View Log" opens a window showing the download log file. "Close" terminates the download and removes the task from the list.  </Text>
93</Section>
94</Section>
95<Section name="collectingfiles">
96<Title>
97<Text id="44">Collecting Files for Your Collection</Text>
98</Title>
99<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, from previously downloaded files, or from other Greenstone collections.  Some may already have attached metadata.  This section describes how to import files.</Text>
100<Section name="thegatherview">
101<Title>
102<Text id="46">The Gather View</Text>
103</Title>
104<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 <AutoText key="glidict::GUI.Gather"/> tab directly below the menu bar.</Text>
105<Text id="48">The two large areas titled "Workspace" and "Collection" are used to move files into your collection.  They contain "file trees" that represent files and folders.</Text>
106<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 (or right-click and select <AutoText key="glidict::Menu.Open_Externally"/>) to open it using its associated application program (see <Reference target="fileassociations"/>).</Text>
107<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>
108<Text id="51">The Collection file tree represents the contents of the collection so far.  Initially, it is empty.</Text>
109<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>
110<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>
111<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>
112<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>
113</Section>
114<Section name="creatingshortcuts">
115<Title>
116<Text id="55a">Creating A Shortcut in the Workspace Tree</Text>
117</Title>
118<Text id="56">Certain folders -- such as the one containing your own web pages -- sometimes have special significance. If you like, the Librarian Interface can map them to the top 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>
119</Section>
120<Section name="creatingfolders">
121<Title>
122<Text id="57">Creating Folders</Text>
123</Title>
124<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>
125<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>
126<Text id="60">Folders can also be created by right-clicking in the Collection Tree, or over a folder, choosing "New Folder" and proceeding as above.</Text>
127</Section>
128<Section name="addingfiles">
129<Title>
130<Text id="61">Adding Files</Text>
131</Title>
132<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>
133<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>
134<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>
135<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>
136<Text id="65a">You can also add a "dummy" document to the collection by right-clicking in the Collection Tree or on a folder, and selecting "New dummy document". This will create a new empty file to which metadata can be assigned. The file can be replaced with a "real" file later on.</Text>
137</Section>
138<Section name="replacingfiles">
139<Title>
140<Text id="65b">Renaming and Replacing Files</Text>
141</Title>
142<Text id="65c">Files can be renamed by right-clicking them and selecting "Rename" from the list. Enter the new name at the prompt and click "OK".</Text>
143<Text id="65d">Files can be replaced in the collection by right-clicking the file to replace and choosing "Replace". A file browser will open up: navigate to the new document and click "Open". The new document will replace the old one in the collection, and any metadata will be transferred to it. This is particularly useful for replacing dummy documents by their real ones.</Text>
144</Section>
145<Section name="removingfiles">
146<Title>
147<Text id="66">Removing Files</Text>
148</Title>
149<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>
150<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>
151</Section>
152<Section name="explodingfiles">
153<Title>
154<Text id="exm-1">"Exploding" Metadata Files</Text>
155</Title>
156<Text id="exm-2">Metadata database file types, such as MARC, CDS/ISIS, BibTex, Refer and ProCite can be imported into Greenstone but their metadata cannot be viewed or edited in the Librarian Interface. To see or edit any metadata, you need to go back to the program that created the file.</Text>
157<Text id="exm-3">"Exploding" a metadata database file splits it into individual records, with viewable and editable metadata. This process is irreversible: the original metadata file is deleted.</Text>
158<Text id="exm-4">Explodable files have a green icon in the Collection tree. To explode one, right click it and choose "Explode metadata database". A popup window shows options for the exploding process. The first option ("plugin") specifies the plugin to be used for exploding. In most cases, only one plugin will process a particular type of file, but in some cases, where different file types share the same filename extension, there may be two plugins that both process files with that extension. The "input_encoding" option can be used to specify the encoding of the database. The "metadata_set" option specifies the metadata set to which the new fields generated by exploding should be added. If none is specified, you will be prompted for what to do with each new field in the database: add it as a new element to an existing metadata set, merge with another element, or ignore.</Text>
159<Text id="exm-5">When a file is exploded, a new empty document is created for each record, and the metadata from the record is assigned to the document. These are named using numbers such as 000001.nul, 000002.nul etc. If the "document_field" option is set (to a database field name), the value of this field, if present, will be used for the filename. The exploding process will also try to download the file and use it instead of an empty file. The "document_prefix" and "document_suffix" options can be used to make a valid URL or file path from the document_field value. The "records_per_folder" option can be used to group exploded records into sub-folders. If the database is very large, using this option will accelerate subsequent metadata editing.</Text>
160<Text id="exm-6">Explodability is determined by file extension. In some cases, files may be incorrectly labelled as explodable if they have the same file extension as an explodable file. For example, the ProCite plugin processes files with a .txt extension, but most .txt files are plain text files, not ProCite files.</Text>
161</Section>
162<Section name="filteringthetree">
163<Title>
164<Text id="69">Filtering the Trees</Text>
165</Title>
166<Text id="70">"Filtering" the collection and workspace trees allows you to narrow down the search for particular files.</Text>
167<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>
168<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 "*.doc" ("*" matches any characters).</Text>
169</Section>
170</Section>
171<Section name="enrichingacollection">
172<Title>
173<Text id="73">Enriching Your Collection with Metadata</Text>
174</Title>
175<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>
176<Section name="theenrichview">
177<Title>
178<Text id="75">The Enrich View</Text>
179</Title>
180<Text id="76">Use the <AutoText key="glidict::GUI.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: <AutoText key="glidict::Metadata.Element"/> tells what kind of item it is (such as author), and <AutoText key="glidict::Metadata.Value"/> gives the value of that metadata element (such as the author's name).</Text>
181<Text id="77">On the left of the <AutoText key="glidict::GUI.Enrich"/> view is the Collection Tree. All the right-click functionality that was available for the Collection Tree in the <AutoText key="glidict::GUI.Gather"/> view is available here too. To the right is the Metadata Table, which shows metadata for any selected files or folders in the Collection Tree.  Columns are named in black at the top, and can be resized by dragging the separating line. If several files or folders are selected, black text indicates that the value is common to all of the selected items, while grey text indicates that it is not. Editing grey values will only affect those documents with that metadata. Any new metadata values entered will be added to all selected items.</Text>
182<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>
183<Text id="79">Clicking on a metadata element in the table will display the existing values for that element in the <AutoText key="glidict::EnrichPane.ExistingValues" args="..."/> area below the table. This "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 value 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>
184<Text id="80">Metadata values can be organized 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>
185<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>
186</Section>
187<Section name="selectingmetadatasets">
188<Title>
189<Text id="82">Selecting Metadata Sets</Text>
190</Title>
191<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> 
192<Text id="84">When you create a new collection, the Dublin Core metadata set is added by default. You can change which metadata sets are used in a collection by clicking the "Manage Metadata Sets..." button underneath the Collection Tree in the Enrich view. This brings up a new window for managing the collection's metadata sets.</Text>
193<Text id="84a">The "Assigned Metadata Sets" list shows you what sets are currently used by the collection.</Text>
194<Text id="84b">To use another metadata set with the loaded collection, click "Add...". A popup window shows you the default metadata sets that GLI knows about. To add one of these, select it from the list and click "Add". If you have defined your own metadata set, you can use the "Browse" button to locate the file on your file system.</Text>
195<Text id="84c">To create a new metadata set, click "New...". This will launch the Greenstone Editor for Metadata Sets, GEMS. An initial popup window prompts you for the set name, namespace and description. You can also choose to base the new set on an existing one, in which case it will inherit all the elements from the specified set. Click OK. The main window shows the elements of metadata set on the left hand side, and some attributes for the set on the right hand side. If you have based the set on an existing one, one or more elements will be displayed. Clicking one displays attributes of the element in the right hand side.</Text>
196<Text id="84d">To add a new element, right click on the name of the set and choose "Add Element". To add a new subelement, right click on the element and choose "Add Subelement". Elements and subelements can be deleted by choosing "Delete (Sub)element" from the right click menu. </Text>
197<Text id="84e">Note: the Greenstone Editor for Metadata Sets can be run independently of GLI by selecting it from the Greenstone folder in the Start menu, or by running gens.sh or gems.bat in the gli folder of your Greenstone installation.</Text>
198<Text id="84f">Sometimes two metadata sets may have the same namespace, for example, Dublin Core and Qualified Dublin Core both use the namespace "dc". Such sets cannot be used in the collection at the same time. If you try to add a set with a namespace already used by the collection, a warning will be shown. If you go ahead, the existing set will be removed and the new one added. Any assigned metadata values will be transferred to the new set providing those elements still exist.</Text>
199<Text id="191">With GEMS you can edit existing metadata sets as well as create new ones. Clicking the "Edit" button launches GEMS with the specified metadata set open. Once you have finished editing the set (as described above), save it (File->Save) and close GEMS.</Text>
200<Text id="192">If a collection no longer needs a metadata set, select it and press "Remove". If you have assigned any metadata to its elements you will be asked how to deal with this metadata when you next open the collection.</Text>
201</Section>
202<Section name="appendingmetadata">
203<Title>
204<Text id="85">Appending New Metadata</Text>
205</Title>
206<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>
207<Text id="87">Next select the metadata element you want to add by clicking its row in the table.</Text>
208<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>
209<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>
210</Section>
211<Section name="addingpreviouslydefinedmetadata">
212<Title>
213<Text id="90">Adding Previously Defined Metadata</Text>
214</Title>
215<Text id="91">To add metadata that has an existing value, first select the file, then select the metadata element that you are assigning to, then select the required value from the value tree, expanding hierarchy folders as necessary.  The value of the selected entry automatically appears in the metadata field (alternatively, use the value tree's auto-select and auto-complete features). </Text>
216<Text id="92">The process of adding metadata with already-existing values to folders or multiple files is just the same.</Text>
217</Section>
218<Section name="updatingmetadata">
219<Title>
220<Text id="93">Editing or Removing Metadata</Text>
221</Title>
222<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>
223<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>
224<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 all values that are no longer assigned.</Text>
225</Section>
226<Section name="reviewingmetadata">
227<Title>
228<Text id="97">Reviewing Assigned Metadata</Text>
229</Title>
230<Text id="98">Sometimes you need to see the metadata assigned to many 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>
231<Text id="99">Select the files in the Collection Tree 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>
232<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>
233<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>
234<Text id="102">The filter 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>
235<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>
236</Section>
237<Section name="importingpreviouslyassignedmetadata">
238<Title>
239<Text id="104">Importing Previously Assigned Metadata</Text>
240</Title>
241<Text id="105">This section describes how to import previously assigned metadata: metadata assigned to documents before they were added to the collection.</Text>
242<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>
243<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>
244<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>
245<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>
246</Section>
247</Section>
248<Section name="designingacollection">
249<Title>
250<Text id="110">Configuring Your Collection</Text>
251</Title>
252<Text id="111">Once your files are marked up with metadata, you next decide how the documents should be accessed by the end users. What kind of information is searchable?  What ways are provided to browse through the documents? These things can be customized; this section describes how to do it.</Text>
253<Section name="thedesignview">
254<Title>
255<Text id="112">The Design View</Text>
256</Title>
257<Text id="113">This section introduces you to the design view and explains how to navigate between the various views within this pane.</Text>
258<Text id="114">With the Librarian Interface, you can configure how the documents are processed, and how the collection is accessed by the user.  The configuration options are divided into different sections, each associated with a particular stage of collection customization.</Text>
259<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>
260<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>
261</Section>
262<Section name="plugins">
263<Title>
264<Text id="121">Document Plugins</Text>
265</Title>
266<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 the "Design" tab, click "Document Plugins".</Text>
267<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 "Assigned Plugins" list. In Librarian mode, each plugin, except for UnknownPlug, may only occur once in the collection. In higher modes, plugins can appear multiple times. The process_exp argument will need to be set in order to make this useful.</Text>
268<Text id="123aa">To see a short description of a plugin, select it in the "Select plugin to add" pull-down list, then hover the mouse over it. A tool-tip displaying the description will appear.</Text>
269<Text id="124">To remove a plugin, select it in the list and click "Remove Plugin".</Text>
270<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>
271<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>
272<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>
273<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>
274</Section>
275<Section name="searchindexes">
276<Title>
277<Text id="134">Search Indexes</Text>
278</Title>
279<Text id="si-1">Indexes specify what parts of the collection are searchable. This section explains how to add and remove indexes, and set a default index. Under the <AutoText key="glidict::GUI.Design"/> tab, click <AutoText key="glidict::CDM.GUI.Indexes"/>.</Text>
280<Text id="si-2">The top right of the <AutoText key="glidict::CDM.GUI.Indexes"/> panel displays information about which indexer is currently being used by the collection. This can be changed by clicking <AutoText key="glidict::CDM.BuildTypeManager.Change"/>. A popup window appears with the list of options: MG, MGPP, and Lucene. Changing this affects how the indexes are built, and may affect search functionality.</Text>
281<Text id="si-2a">The <AutoText key="glidict::CDM.IndexManager.Indexes"/> list shows what indexes are currently assigned to the collection. </Text>
282<Text id="si-3">To add an index, click <AutoText key="glidict::CDM.IndexManager.New_Index"/>... A popup window appears with a list of sources, which includes text and metadata. Select which sources you want to index. The <AutoText key="glidict::CDM.IndexManager.Select_All"/> and <AutoText key="glidict::CDM.IndexManager.Select_None"/> buttons will check or uncheck all of the items in the list, respectively. Once a new index has been defined, click <AutoText key="glidict::CDM.IndexManager.Add_Index"/> to add it to the collection. <AutoText key="glidict::CDM.IndexManager.Add_Index"/> will only become active once the settings describe a new index that is not already assigned to the collection. </Text>
283<Text id="s1-3a">For MG indexes, you also need to choose the granularity of the index, using the <AutoText key="glidict::CDM.IndexManager.Level"/> menu. </Text>
284<Text id="si-4">For MGPP and Lucene indexes, index granularity is determined globally, not per index. The possible levels are displayed on the main <AutoText key="glidict::CDM.GUI.Indexes"/> pane, and can be added to the collection by ticking the checkboxes.</Text>
285<Text id="si-5">A special index is available for MGPP and Lucene: an "allfields" index which merely provides combined searching over all specified indexes, without having to specify a separate index that contains all sources. To add this index, check the <AutoText key="glidict::CDM.IndexManager.Allfields_Index"/> check box and click <AutoText key="glidict::CDM.IndexManager.Add_Index"/>.</Text>
286<Text id="si-6">For MGPP and Lucene, an <AutoText key="glidict::CDM.IndexManager.Add_All"/> button is also provided, as a shortcut to adding all metadata and text sources as individual indexes.</Text>
287<Text id="si-7">To edit an index, select it and click <AutoText key="glidict::CDM.IndexManager.Edit_Index"/>. A similar dialog to the <AutoText key="glidict::CDM.IndexManager.New_Index"/> one is shown. </Text>
288<Text id="si-8">To remove an index, select it from the list of Assigned indexes and click <AutoText key="glidict::CDM.IndexManager.Remove_Index"/>.</Text>
289<Text id="si-9">The order in which the indexes are specified in the Assigned Indexes list is the order they appear in the drop down menu on the search page. Use the <AutoText key="glidict::CDM.Move.Move_Up"/> and <AutoText key="glidict::CDM.Move.Move_Down"/> buttons to change this ordering.</Text>
290<Text id="si-10">The one that is selected by default on the search page is called the "default index". This can be set by selecting an index from the list and clicking "Set Default". The default index is tagged with "[Default Index]" in the "Assigned Indexes" list. If no default index is set, the first one in the list will be used as the default.</Text>
291<Text id="si-11">The names used for the drop-down list of indexes on the search page can be set in the <AutoText key="glidict::CDM.GUI.SearchMetadata"/> part of the <AutoText key="glidict::GUI.Format"/> panel (see <Reference target="searchmetadatasettings"/>).</Text>
292<Text id="si-12">For MG and MGPP indexes, there are further options controlling how the indexes are built. Stemming and case-folding may be enabled or disabled in the indexes&mdash;if disabled, the options will not be displayed on the preferences page of the collection. Accent-folding is also available for MGPP indexes. This works in a similar way to case-folding, but instead of lower and upper case letters matching, letters with diacritics match those without.</Text>
293</Section>
294<Section name="partitionindexes">
295<Title>
296<Text id="143">Partition Indexes</Text>
297</Title>
298<Text id="144">Indexes are built on particular text or metadata sources.  The search space can be further controlled by partitioning the indexes, either by language or by a predetermined filter.  This section describes how to do this.  Under the "Design" tab, click "Partition Indexes".</Text>
299<Text id="145">The "Partition Indexes" view has three tabs; "Define Filters", "Assign Partitions" and "Assign Languages".  To learn more about partitions read about sub-collections and sub-indexes in Chapter 2 of the Greenstone Developer's Guide.</Text>
300<Text id="146">The Partition Indexes screen is only enabled in Library Systems Specialist and Expert modes (see <Reference target="preferences"/>). Note that for MG collections, the total number of partitions generated is a combination of all indexes, sub-collection filters and languages chosen. Two indexes with two sub-collection filters in two languages would yield eight index partitions. For MGPP, all indexes are created in one physical index, so there would only be four index partitions. For Lucene, the number of physical indexes is determined by the number of levels assigned to the collection, one index per level. So for the above situation, one level would result in four physical indexes, while two levels would result in eight.</Text>
301<Section name="definefilters">
302<Title>
303<Text id="147">Define Filters</Text>
304</Title>
305<Text id="148">Filters allow you to group together into a sub-collection all documents in an index for which a metadata value matches a given pattern.</Text>
306<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>
307<Text id="150">To remove a filter, select it from the list and click "Remove Filter".</Text>
308<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>
309<Text id="151a">Defining filters does not create sub-collections. Sub-collections are specified in the <AutoText key="glidict::CDM.SubcollectionManager.Subindex_Controls"/>, based on the filters you have just defined.</Text>
310</Section>
311<Section name="assignpartitions">
312<Title>
313<Text id="152">Assign Partitions</Text>
314</Title>
315<Text id="153">Having defined one or more sub-collection filters, 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 and click "Add Partition". Each specified partition will result in a sub-collection that contains documents that match any of the filters associated with that partition.</Text>
316<Text id="154a">To alter a partition, select it from the list, modify the filters, and click <AutoText key="glidict::CDM.SubcollectionIndexManager.Replace_Subindex"/>.</Text>
317<Text id="154">To remove a partition, select it from the list and click "Remove Partition".</Text>
318<Text id="154b">The order that the partitions are specified in the Assigned Partitions list is the order they appear in the drop down menu on the search page. Use the <AutoText key="glidict::CDM.Move.Move_Up"/> and <AutoText key="glidict::CDM.Move.Move_Down"/> buttons to change this ordering.</Text>
319<Text id="155">To make a partition the default one, select it from the list and click <AutoText key="glidict::CDM.SubcollectionIndexManager.Set_Default_Subindex"/>.</Text>
320<Text id="155a">The names used for the drop-down list of partitions on the search page can be set in the <AutoText key="glidict::CDM.GUI.SearchMetadata"/> part of the <AutoText key="glidict::GUI.Format"/> panel (see <Reference target="searchmetadatasettings"/>).</Text>
321</Section>
322<Section name="assignlanguages">
323<Title>
324<Text id="156">Assign Languages</Text>
325</Title>
326<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>
327<Text id="158">To add a new language partition, use the "Assign Languages" tab to build an index for it.  Select one or more languages from the "Languages to add" list and click "Add Partition".</Text>
328<Text id="158a">To change an existing partition, select it from the "Assigned Language Partitions" list, modify the selected languages in the "Languages to add" list below, and click "Replace Partition".</Text>
329<Text id="159">To remove a language partition, select it from the "Assigned Language Partitions" list and click "Remove Partition".</Text>
330<Text id="159a">The order that the language partitions are specified in the Assigned Language Partitions list is the order they appear in the drop down menu on the search page. Use the <AutoText key="glidict::CDM.Move.Move_Up"/> and <AutoText key="glidict::CDM.Move.Move_Down"/> buttons to change this ordering.</Text>
331<Text id="160">To set the default language partition, select it from the list and click "Set Default".</Text>
332<Text id="160a">The names used for the drop-down list of language partitions on the search page can be set in the <AutoText key="glidict::CDM.GUI.SearchMetadata"/> part of the <AutoText key="glidict::GUI.Format"/> panel (see <Reference target="searchmetadatasettings"/>).</Text>
333</Section>
334</Section>
335<Section name="classifiers">
336<Title>
337<Text id="166">Browsing Classifiers</Text>
338</Title>
339<Text id="167">This section explains how to assign "classifiers", which are used for browsing, to the collection.  Under the "Design" tab, click "Browsing Classifiers".</Text>
340<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 "Assigned Classifiers" list.</Text>
341<Text id="168a">To see a short description of a classifier, select it in the "Select classifier to add" pull-down list, then hover the mouse over it. A tool-tip displaying the description will appear.</Text>
342<Text id="168b">Each classifier has several arguments that can be configured. Important arguments include "metadata", which specifies the metadata that documents will be classified on, and "buttonname", which is the name that will appear in the navigation bar.</Text>
343<Text id="169">To remove a classifier, select it from the list and click "Remove Classifier".</Text>
344<Text id="170">To change the arguments for a classifier, select it from the list and click "Configure Classifier" (or double-click on the classifier in the list).</Text>
345<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 <AutoText key="glidict::CDM.Move.Move_Up"/> and <AutoText key="glidict::CDM.Move.Move_Down"/>.</Text>
346<Text id="172">For further information on classifiers read Chapter 2, Greenstone Developer's Guide -- Getting the most out of your documents.</Text>
347</Section>
348</Section>
349<Section name="producingthecollection">
350<Title>
351<Text id="193">Producing Your Collection</Text>
352</Title>
353<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>
354<Section name="thecreateview">
355<Title>
356<Text id="195">The Create View</Text>
357</Title>
358<Text id="196">The Create view is used to create the collection by running Greenstone collection-building scripts on the information you have provided. Access the Create view by clicking the Create tab.</Text>
359<Text id="196a">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". The lower part of the panel shows some output from the build process. The upper part shows some options for controlling the build process.</Text>
360<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>
361</Section>
362<Section name="builderrors">
363<Title>
364<Text id="199a">Errors in collection building</Text>
365</Title>
366<Text id="199b">Sometimes things go wrong during collection building. Maybe some files couldn't be processed: the rest of the collection builds fine, and can be previewed, but some documents are absent. Or the whole collection is not built properly, in which case a message says <AutoText key="glidict::CollectionManager.Cannot_Create_Collection"/> When this happens, it may be helpful to switch the GLI into expert mode (File->Preferences->Mode, see <Reference target="preferences"/>), set the build option "verbosity" to 5, and rebuild, to see if there are any error messages.</Text>
367</Section>
368<Section name="expertbuilding">
369<Title>
370<Text id="198a">Create view in Expert mode</Text>
371</Title>
372<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>
373<Text id="200a">In this mode, a full list of import and build options are shown in the Import and Build tabs to the left. The various settings are controlled just like the "Configuring Arguments" window described in the <Reference target="plugins"/> section.  Some fields require numeric arguments, and you can type these in or use the 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>
374<Text id="201a">For more information about importing and building read Chapter 1 of the Greenstone Developer's Guide -- Understanding the collection-building process.</Text>
375</Section>
376</Section>
377<Section name="formattingacollection">
378<Title>
379<Text id="fc-1">Customizing Your Collection's Appearance</Text>
380</Title>
381<Text id="fc-2">Once you have built the collection, you next decide how it should appear to the user. What names should be used for the drop-down list of indexes in the search form? How should search results be displayed? What metadata should be displayed when a document is viewed? These can be customized; this section explains how to do it. </Text>
382<Section name="theformatview">
383<Title>
384<Text id="fc-3">The Format View</Text>
385</Title>
386<Text id="fc-4">This section introduces you to the Format view and explains how to navigate among the various panes.</Text>
387<Text id="fc-5">With the Librarian Interface you can configure how the collection appears to the user. The configuration options are divided into sections, each associated with a different type of customization.</Text>
388<Text id="fc-6">On the left is a list of parameters and on the right are the control elements associated with each parameter. To edit a parameter, click its name in the list.</Text>
389<Text id="fc-7">Under the list of parameters is a "Preview Collection" button. Changes made in the Format view don't require a collection rebuild, so can be previewed straight away. However, the collection must have been built at least once to allow previewing.</Text>
390</Section>
391<Section name="generalsettings">
392<Title>
393<Text id="117">General</Text>
394</Title>
395<Text id="118">This section explains how to review and alter the general settings associated with your collection.  First, under the "Format" tab, click "General".</Text>
396<Text id="119">Here some collection wide metadata can be set or modified, including the title and description entered when starting a new collection.</Text>
397<Text id="120">First are the contact email addresses 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 altered. Then comes the icon to show at the top left of the collection's "About" page (in the form of a URL), followed by the icon used in the Greenstone library page to link to the collection. Next is a checkbox that controls whether the collection should be publicly accessible. Finally comes the "Collection Description" text area as described in <Reference target="creatingacollection"/>.</Text>
398</Section>
399<Section name="searchmetadatasettings">
400<Title>
401<Text id="fc-s1">Search</Text>
402</Title>
403<Text id="fc-s2">This section explains how to set the display text for the drop down lists on the search page. Under the "Format" tab, click "Search".</Text>
404<Text id="fc-s3">This pane contains a table listing each search index. Here you can enter the text to be used for the index names in the drop-down lists on the search page. This pane only allows you to set the text for one language, the current language used by GLI. To translate these names for other languages, use the Translate Text part of the Format view (see <Reference target="translatetext"/>).</Text>
405</Section>
406<Section name="formatstatements">
407<Title>
408<Text id="173">Format Features</Text>
409</Title>
410<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 which 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 the "Format" tab, click "Format Features".</Text>
411<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 a format string, position the cursor at the place to insert, then select the desired variable from the <AutoText key="glidict::CDM.FormatManager.Insert_Variable"/> combobox.</Text>
412<Text id="176">You can specify a default format for a particular component by selecting the "All Features" feature.  This format is then applied to all applicable features unless a more specific one is defined.</Text>
413<Text id="177">To add a new format command, select the applicable feature and component. The default value for this command will be displayed in grey. Click <AutoText key="glidict::CDM.FormatManager.Add"/> to assign it to the collection. The "HTML Format String" will become editable and you can change it if you wish. Only one format command can be assigned to each feature/component combination.</Text>
414<Text id="178">To remove a format command, select it from the list and click "Remove Format".</Text>
415<Text id="180">For more information about variables and the feature components, read Chapter 2 of the Greenstone Developer's Guide.</Text>
416</Section>
417<Section name="translatetext">
418<Title>
419<Text id="182">Translate Text</Text>
420</Title>
421<Text id="183">This section describes the translation pane, where you can translate text fragments for parts of the collection's interface into other languages. Under the "Format" tab, click "Translate Text".</Text>
422<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>
423<Text id="185">To remove an existing translation, select it in the "Assigned Translations" table and click "Remove Translation".</Text>
424<Text id="186">To edit a translation, select it, edit the "Translated Text" area and click "Replace Translation".</Text>
425</Section>
426<Section name="xcollectionsearching">
427<Title>
428<Text id="161">Cross-Collection Search</Text>
429</Title>
430<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 the "Format" tab, click "Cross-Collection Search".</Text>
431<Text id="163">The Cross-Collection Search view shows a checklist of available collections.  The current collection is ticked and cannot be de-selected.  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>
432<Text id="164">If the individual collections do not have the same indexes (including sub-collection 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>
433<Text id="165">For further details, see Chapter 1 of the Greenstone Developer's Guide.</Text>
434</Section>
435<Section name="collectionspecificmacros">
436<Title>
437<Text id="fc-m1">Collection Specific Macros</Text>
438</Title>
439<Text id="fc-m2">Under the "Format" tab, click "Collection Specific Macros".</Text> 
440<Text id="fc-m3">This pane shows the contents of the collection's extra.dm macro file. This is where collection specific macros can be defined. To learn more about macros, see Chapter 3 of the Greenstone Developer's Guide.</Text>
441</Section>
442</Section>
443<Section name="miscellaneous">
444<Title>
445<Text id="202">Miscellaneous</Text>
446</Title>
447<Text id="203">This section describes features of the Librarian Interface that are not associated with any particular view.</Text>
448<Section name="preferences">
449<Title>
450<Text id="204">Preferences</Text>
451</Title>
452<Text id="205">This section explains the preferences dialog, accessed by opening "File" -> "Preferences".</Text>
453<Text id="206">The preferences window opens at the "General" tab. The first option is a text field for entering your e-mail address. This will be used for the "creator" and "maintainer" collection metadata items for new collections. 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, the Librarian Interface must be restarted in order to load the new language strings from the dictionary.</Text>
454<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.  De-selecting 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>
455<Text id="208">The "Mode" tab 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 process 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>
456<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>
457<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 boxes next to warning messages you want to see again.</Text>
458</Section>
459<Section name="fileassociations">
460<Title>
461<Text id="212">File Associations</Text>
462</Title>
463<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>
464<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 the 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>
465<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>
466<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>
467<Text id="217">File associations are stored in the Librarian Interface's main folder, in a file called "associations.xml".</Text>
468</Section>
469<Section name="exporting">
470<Title>
471<Text id="exp-1">Exporting collections to other formats</Text>
472</Title>
473<Text id="exp-2">Greenstone can export the contents and/or metadata of a collection to several standard formats, including METS, DSpace and MARCXML.</Text>
474<Text id="exp-3">To export one or more collections, open the "File" menu and choose "Export...". You can choose which format to export to by selecting it in the "Export to" drop-down list. Specify a name for the directory where you want to put the exported files&mdash;the files will end up in &lt;path to greenstone&gt;/tmp/exported_xxx, where xxx is the name you specified. Select one or more collections in the list of available collections, then click "Export collection(s)".</Text>
475<Text id="exp-4">There are other options specific to the various formats. You can specify XSLT files which will be applied to the resulting XML document(s) in order to customize the output format. Exporting to MARCXML uses a mapping file to map Greenstone metadata to MARC fields. The default mapping file maps only Dublin Core metadata. You can specify a custom mapping file to be used instead.</Text>
476</Section>
477<Section name="exportingcollections">
478<Title>
479<Text id="218">Exporting Collections to CD/DVD</Text>
480</Title>
481<Text id="219">Greenstone can export one or more collections to a self-installing CD/DVD for Windows. </Text>
482<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 "CD/DVD name" box: this is what will appear in the Start menu when the CD/DVD has been installed. You can choose whether the resulting CD-ROM or DVD runs directly from the disk drive, or installs some files onto the computer. Then click "Write CD/DVD image". The process involves copying many files and may take a few minutes.</Text>
483<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>
484</Section>
485</Section>
486</Document>
Note: See TracBrowser for help on using the browser.