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

Last change on this file since 9641 was 9641, checked in by mdewsnip, 19 years ago

With the changes made for the Greenstone v2.60 (UNESCO CD-ROM) release.

  • Property svn:keywords set to Author Date Id Revision
File size: 70.9 KB
Line 
1<Document>
2 <Section name="introduction">
3 <Title>Introduction</Title>
4The Greenstone Librarian Interface is a tool for collecting and marking up documents, then building digital library collections. It provides access to the Greenstone Digital Library Software's functionality from a graphical point and click interface.
5 <Section name="ofmiceandmenus">
6 <Title>Of Mice and Menus</Title>
7This section provides basic information about interacting with the Librarian Interface.
8If you are familiar with programs such as Internet Explorer or Microsoft
9Office and are comfortable with mouse clicks and menus, skip to the <Reference target="howtoavoidthisdocument">next section</Reference>.
10 <Contents>
11 <ContentsGroup linkto="simple">
12 <ContentsItem>
13 Basic concepts
14 <ContentsItem>
15 Mouse actions
16 </ContentsItem>
17 <ContentsItem>
18 Keyboard
19 </ContentsItem>
20 </ContentsItem>
21 <ContentsItem>
22 Exiting the program
23 </ContentsItem>
24 </ContentsGroup>
25 <ContentsGroup linkto="advanced">
26 <ContentsItem>
27 Quick keys
28 </ContentsItem>
29 </ContentsGroup>
30 </Contents>
31 <Anchor name="simple">Simple Instructions:</Anchor>
32The Librarian Interface follows Microsoft Windows conventions and draws upon
33ordinary knowledge of Windows.
34<Break/>
35Any part of the screen that you interact with, such as a button or text field,
36is called a "control". At any given time one control, called the "focus", is
37highlighted and responds to the keyboard. Several controls allow you to select
38parts that are highlighted in dark blue. Some controls are greyed out to
39indicate that they are disabled.
40<Break/>
41You can move and left- or right-click the mouse in the usual way. Many
42components also allow you to "drag" them, by clicking and holding the left
43mouse button, move them with the mouse, and "drop" them elsewhere by releasing
44the button. Potential drop targets alter their appearance when a component
45hovers over them.
46<Break/>
47You can use the keyboard to type into text fields. Keyboard alternatives are
48available for many controls, indicated by a key name in square brackets -- for
49example, [Tab] alters the focus. The plus sign shows if other keys must be
50pressed at the same time.
51<Break/>
52Exit the Librarian Interface program by choosing "Exit" from the "File"
53menu. Your collection will be saved first.
54 <Anchor name="advanced">Advanced Instructions:</Anchor>
55To access a menu, hold down [ALT] and press the corresponding letter
56(underlined). For example, for the "File" menu press [ALT] + [F]. To choose an
57item, press the corresponding key. For example, while in the File menu
58press [S] to "Save" a collection.
59 </Section>
60 <Section name="howtoavoidthisdocument">
61 <Title>How to Avoid Reading This Document</Title>
62Don't read this help text all the way through! Just read enough to learn
63how to get help when you need it.
64 <Contents>
65 <ContentsGroup linkto="simple">
66 <ContentsItem>
67 Context sensitive help
68 </ContentsItem>
69 <ContentsItem>
70 Tool tips
71 </ContentsItem>
72 <ContentsItem>
73 Other documents
74 </ContentsItem>
75 </ContentsGroup>
76 </Contents>
77 <Anchor name="simple">Simple Instructions:</Anchor>
78The "Help" menu item marks what may be the most appropriate help item with a
79little book icon.
80<Break/>
81For many controls, if you station the mouse over them a
82"tool tip" appears that says what they do.
83<Break/>
84Before using the Librarian Interface, first read the Greenstone
85documentation.
86 </Section>
87 </Section>
88
89 <Section name="startingoff">
90 <Title>Starting Off</Title>
91 This section covers how to create, load, save and delete collections.
92 <Section name="creatingacollection">
93 <Title>Creating a New Collection</Title>
94<ObviousSentence>This section describes how to create a new collection.</ObviousSentence>
95 <Contents>
96 <ContentsGroup linkto="simple">
97 <ContentsItem>
98 The new collection prompt
99 </ContentsItem>
100 <ContentsItem>
101 The collection title
102 </ContentsItem>
103 <ContentsItem>
104 Default metadata sets
105 </ContentsItem>
106 <ContentsItem>
107 Collection description
108 </ContentsItem>
109 <ContentsItem>
110 Creating the new collection
111 </ContentsItem>
112 <ContentsItem>
113 Cancelling the new collection
114 </ContentsItem>
115 </ContentsGroup>
116 <ContentsGroup linkto="advanced">
117 <ContentsItem>
118 Quick keys
119 </ContentsItem>
120 </ContentsGroup>
121 </Contents>
122 <Anchor name="simple">Simple Instructions:</Anchor>
123To create a new collection, open the "File" menu and choose "New". Several
124fields need to be filled out -- but you can change their values later if you
125need to, in the design view.
126<Break/>
127"Collection title" is the text displayed at the top of your collection's home page. It can
128be any length.
129<Break/>
130"Description of content"
131should describe, in as much detail as possible, what the collection is about.
132Use the [Enter] key to break it into paragraphs.
133<Break/>
134Finally you must specify whether the new collection will have the same
135appearance and metadata sets as an existing collection, or whether to start a
136default "New Collection".
137<Break/>
138Click "OK" to create the collection. If you chose "New Collection" you are
139prompted for the metadata sets to use in it. You can choose more than one, and
140you can add others later.
141<Break/>
142Clicking "Cancel" returns you to the main screen immediately.
143 <Anchor name="advanced">Advanced Instructions:</Anchor>
144Buttons, like menus, have one character underlined. To "click" the button,
145press [ALT] and the underlined character at the same time.
146 </Section>
147 <Section name="savingacollection">
148 <Title>Saving the Collection</Title>
149<ObviousSentence>This section describes how to save a collection, and the Save Collection Prompt.</ObviousSentence>
150 <Contents>
151 <ContentsGroup linkto="simple">
152 <ContentsItem>
153 How to save
154 </ContentsItem>
155 </ContentsGroup>
156 <ContentsGroup linkto="advanced">
157 <ContentsItem>
158 Where the files are saved
159 </ContentsItem>
160 </ContentsGroup>
161 </Contents>
162 <Anchor name="simple">Simple Instructions:</Anchor>
163Save your work regularly by opening the "File" menu and choosing "Save".
164Saving a collection is not the same as making it ready for use in Greenstone
165(see <Reference target="producingthecollection">Producing Your Collection</Reference>).
166<Break/>
167The Librarian Interface protects your work by saving it whenever you exit the
168program or load another collection.
169 <Anchor name="advanced">Advanced Instructions:</Anchor>
170Saved collections are written to a file named for the collection and with file
171extension ".col", located in a folder of the same name within your Greenstone
172installation's "collect" folder.
173 </Section>
174 <Section name="openingacollection">
175 <Title>Opening an Existing Collection</Title>
176<ObviousSentence>This section tells you how to open existing collections using the Open
177Collection prompt.</ObviousSentence>
178 <Contents>
179 <ContentsGroup linkto="simple">
180 <ContentsItem>
181 How to open a collection
182 </ContentsItem>
183 </ContentsGroup>
184 <ContentsGroup linkto="advanced">
185 <ContentsItem>
186 Locked collections
187 </ContentsItem>
188 <ContentsItem>
189 Legacy collections
190 </ContentsItem>
191 </ContentsGroup>
192 </Contents>
193 <Anchor name="simple">Simple Instructions:</Anchor>
194To open an existing collection, choose "Open" from the "File" menu to get the
195Open Collection prompt. A list of your Greenstone collections appears.
196Select one to see its description, and click "Open" to load it. If you seek a
197collection that resides outside Greenstone's "collect" folder, click "Browse"
198for a file system browsing dialog.
199 <Anchor name="advanced">Advanced Instructions:</Anchor>
200In case more than one Greenstone Librarian Interface program is running
201concurrently, the relevant directories are "locked" to prevent interference.
202On opening a collection, a small temporary lock file is created in its
203folder. Before opening a collection, the Librarian Interface checks to ensure
204that no lock file already exists. You can tell whether a collection is locked
205by the colour of its icon: green for a normal collection, red for a locked
206one. However, when the Librarian Interface is exited prematurely the lock file
207is sometimes left in place. When you open such a collection, the Librarian asks
208if you want to "steal" control of it. Never steal a collection that someone
209else is currently working on.
210<Break/>
211When you open a collection that the Greenstone Librarian Interface did
212not create, you will be asked to select a metadata set (or sets). If
213none are selected, any existing metadata will be ignored. Otherwise,
214metadata will be imported just as it is when you drag in files with
215existing metadata. The process is described in the <Reference target="importingpreviouslyassignedmetadata">Importing Previously Assigned Metadata</Reference> section.
216 </Section>
217 <Section name="deletingcollections">
218 <Title>Deleting Collections</Title>
219<ObviousSentence>This section explains how to permanently delete collections from your Greenstone installation.</ObviousSentence>
220 <Contents>
221 <ContentsGroup linkto="simple">
222 <ContentsItem>
223 How to delete collections
224 </ContentsItem>
225 </ContentsGroup>
226 </Contents>
227 <Anchor name="simple">Simple Instructions:</Anchor>
228To 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!
229 </Section>
230 </Section>
231
232 <Section name="downloadingfiles">
233 <Title>Downloading Files From the Internet</Title>
234The "Download" view helps you download resources from the internet. This section explains the Librarian Interface's mirroring process.
235 <Section name="themirrorview">
236 <Title>The Download view</Title>
237This section describes how to configure a download task and control the downloading process.
238 <Contents>
239 <ContentsGroup linkto="simple">
240 <ContentsItem>
241 The workspace tree
242 </ContentsItem>
243 <ContentsItem>
244 Download configuration
245 </ContentsItem>
246 <ContentsItem>
247 The download list
248 </ContentsItem>
249 </ContentsGroup>
250 <ContentsGroup linkto="advanced">
251 <ContentsItem>
252 Enabling web proxies
253 </ContentsItem>
254 </ContentsGroup>
255 </Contents>
256 <Anchor name="simple">Simple Instructions:</Anchor>
257Access 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.
258<Break/>
259Files 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.
260<Break/>
261Use 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.
262<Break/>
263The 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.
264 <Anchor name="advanced">Advanced Instructions:</Anchor>
265The <Reference target="preferences">Preferences section</Reference> describes how to establish an Internet connection via a proxy. If authentication is needed, the proxy server prompts for identification and password. The Librarian Interface does not store passwords between sessions.
266 </Section>
267 </Section>
268
269 <Section name="collectingfiles">
270 <Title>Collecting Files for Your Collection</Title>
271Once you have a new collection you need to get some files into it. These may
272come from your ordinary file space, or from other Greenstone collections. Some
273may already have attached metadata. This section describes how to import files.
274 <Section name="thegatherview">
275 <Title>The Gather View</Title>
276This section introduces the Gather area that you use to select what files
277to include in the collection you are building.
278 <Contents>
279 <ContentsGroup linkto="simple">
280 <ContentsItem>
281 How to view the gather screen
282 </ContentsItem>
283 <ContentsItem>
284 The file trees
285 </ContentsItem>
286 <ContentsItem>
287 The status area
288 </ContentsItem>
289 <ContentsItem>
290 Control buttons
291 </ContentsItem>
292 </ContentsGroup>
293 <ContentsGroup linkto="advanced">
294 <ContentsItem>
295 Selection methods
296 </ContentsItem>
297 <ContentsItem>
298 Special folder mapping
299 </ContentsItem>
300 </ContentsGroup>
301 </Contents>
302 <Anchor name="simple">Simple Instructions:</Anchor>
303The Librarian Interface starts with the Gather view. To return to this view
304later, click the "Gather" tab directly below the menu bar.
305<Break/>
306The two large areas titled "Workspace" and "Collection" are used to move files
307into your collection. They contain "file trees", graphical structures that
308represent files and folders.
309<Break/>
310Select an item in the tree by clicking it. (There are other ways; see below.)
311Double-click a folder, or single-click the switch symbol beside it, to expand (or collapse)
312its contents. Double-click a file to open it using its associated application
313program (see <Reference target="fileassociations">File Associations</Reference>).
314<Break/>
315The 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 if Web mirroring is enabled. 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.
316<Break/>
317The Collection file tree represents the contents of the collection so
318far. Initially, it is empty.
319<Break/>
320You can resize the spaces by mousing over the grey bar that separates the trees
321(the shape of the pointer changes) and dragging.
322<Break/>
323At 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.
324<Break/>
325Two large buttons occupy the lower right corner of the screen. "New Folder", with a picture
326of a folder, creates new folders (see <Reference target="creatingfolders">Creating folders</Reference>).
327"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.
328 <Anchor name="advanced">Advanced Instructions:</Anchor>
329To select several sequential items, select the first and then hold down [Shift]
330and click on the last -- the selection will encompass all intervening
331items. Select non-sequential files by holding down [Ctrl] while clicking. Use
332these two methods together to select groups of non-adjacent items.
333<Break/>
334Certain folders -- such as the one containing your own web pages -- sometimes
335have special significance. The Librarian Interface can map such folders to
336the first level of the file tree. To do this, right-click the desired
337folder. Select "Create Shortcut", and enter a name for the folder. To remove an item,
338right-click the mapped folder and select "Remove Shortcut".
339 </Section>
340 <Section name="creatingfolders">
341 <Title>Creating Folders</Title>
342<ObviousSentence>This section shows how to create new folders.</ObviousSentence>
343 <Contents>
344 <ContentsGroup linkto="simple">
345 <ContentsItem>
346 The new folder button
347 </ContentsItem>
348 <ContentsItem>
349 The right-button menu
350 </ContentsItem>
351 </ContentsGroup>
352 </Contents>
353 <Anchor name="simple">Simple Instructions:</Anchor>
354Use folders in the Collection file tree to group files together and make them
355easier to find. Folders can be placed inside folders. There is virtually no
356limit to how many folders you can have or how deeply they can be nested.
357<Break/>
358To create a new folder, optionally select an existing folder in the Collection
359Tree and click the New Folder button. The new folder appears within the
360selected one, or at the top level if none is selected. You are prompted for the
361folder's name (default "New Folder").
362<Break/>
363Folders can also be created by right-clicking over a folder, choosing "New
364Folder" and proceeding as above.
365 </Section>
366
367
368 <Section name="addingfiles">
369 <Title>Adding Files</Title>
370<ObviousSentence>This section shows how to get files into your collection.</ObviousSentence>
371 <Contents>
372 <ContentsGroup linkto="simple">
373 <ContentsItem>
374 Dragging a file
375 </ContentsItem>
376 <ContentsItem>
377 Multiple files
378 </ContentsItem>
379 </ContentsGroup>
380 <ContentsGroup linkto="advanced">
381 <ContentsItem>
382 Existing metadata
383 </ContentsItem>
384 </ContentsGroup>
385 </Contents>
386 <Anchor name="simple">Simple Instructions:</Anchor>
387Files can be copied into the collection by dragging and dropping. The mouse
388pointer becomes a ghost of the selected item (or, if more than one is selected,
389the number of them). Drop the selection into the Collection Tree to copy the
390files there (if the source was the Workspace Tree) or move them around within
391the collection (if the source was the Collection Tree).
392<Break/>
393When copying multiple files, they are all placed in the target folder at the
394same level, irrespective of the folder structure they occupied originally.
395When you copy a second file with the same name into the same folder, you are
396asked whether to overwrite the first one. Respond "No" and the file will not be
397copied, but the others will be. To cancel all remaining copy actions, click the
398"stop" button.
399<Break/>
400Only the "highest" items in a selection are moved. A folder is higher than its
401children. You cannot select files within a folder and also the folder itself.
402 <Anchor name="advanced">Advanced Instructions:</Anchor>
403When you add a file, the Librarian Interface searches through the source
404folders for auxiliary files containing metadata previously assigned to the
405added file and, if it finds one, begins to import this metadata. As the
406operation proceeds, you may be prompted (perhaps several times) for extra
407information to match the imported metadata to the metadata sets in your
408collection. This process involves many different prompts, described in the <Reference target="importingpreviouslyassignedmetadata">Importing Previously Assigned Metadata</Reference> section. For a more detailed
409explanation of associating metadata with files read Chapter 2 of the Greenstone
410Developer's Guide -- Getting the most out of your documents.
411 </Section>
412 <Section name="removingfiles">
413 <Title>Removing Files</Title>
414<ObviousSentence>This section describes how to remove files and folders from your collection.</ObviousSentence>
415 <Contents>
416 <ContentsGroup linkto="simple">
417 <ContentsItem>
418 The delete button
419 </ContentsItem>
420 <ContentsItem>
421 The delete key
422 </ContentsItem>
423 <ContentsItem>
424 Delete by drag and drop
425 </ContentsItem>
426 </ContentsGroup>
427 </Contents>
428 <Anchor name="simple">Simple Instructions:</Anchor>
429There are several methods for removing files and folders. You must first
430indicate what items to remove by selecting one or more files and folders as
431described in <Reference target="thegatherview">The Gather View</Reference>.
432<Break/>
433Once files have been selected, click the "delete" button to remove them, or
434press the [Delete] key on your keyboard, or drag them from the collection to
435the delete button and drop them there.
436 </Section>
437 <Section name="filteringthetree">
438 <Title>Filtering the Tree</Title>
439"Filtering" the collection tree allows you to narrow down the search for particular files.
440 <Contents>
441 <ContentsGroup linkto="simple">
442 <ContentsItem>
443 The filter control
444 </ContentsItem>
445 </ContentsGroup>
446 <ContentsGroup linkto="advanced">
447 <ContentsItem>
448 Custom filtering
449 </ContentsItem>
450 </ContentsGroup>
451 </Contents>
452 <Anchor name="simple">Simple Instructions:</Anchor>
453The "Show Files" pull-down menu underneath each tree shows a list of predefined
454filters, such as "Images". Choosing this temporarily hides all other files in
455the tree. To restore the tree, change the filter back to "All Files". These
456operations do not alter the collection, nor do they affect the folders in the
457tree.
458 <Anchor name="advanced">Advanced Instructions:</Anchor>
459You can specify a custom filter by typing in a pattern to match files against.
460Use standard file system abbreviations such as "*.*" or "*.doc" ("*" matches
461any characters).
462 </Section>
463 </Section>
464
465 <Section name="enrichingacollection">
466 <Title>Enriching the Collection with Metadata</Title>
467Having gathered several files into the collection, now enrich them with
468additional information called "metadata". This section explains how metadata is
469created, edited, assigned and retrieved, and how to use external metadata
470sources (also see Chapter 2 of the Greenstone Developer's Guide -- Getting the most
471out of your documents).
472 <Section name="theenrichview">
473 <Title>The Enrich View</Title>
474<ObviousSentence>This section describes how to input and edit metadata using the Enrich view.</ObviousSentence>
475 <Contents>
476 <ContentsGroup linkto="simple">
477 <ContentsItem>
478 The collection tree
479 </ContentsItem>
480 <ContentsItem>
481 The metadata editing controls
482 </ContentsItem>
483 <ContentsItem>
484 The value tree
485 </ContentsItem>
486 <ContentsItem>
487 The metadata table
488 </ContentsItem>
489 </ContentsGroup>
490 </Contents>
491 <Anchor name="simple">Simple Instructions:</Anchor>
492Use the Enrich view to assign metadata to the documents in the collection.
493Metadata is data about data -- typically title, author, creation date, and so
494on. Each metadata item has two parts: "element" tells what kind of item it is
495(such as author), and "value" gives the value of that metadata element (such as
496the author's name).
497<Break/>
498On 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
499grey at the top, and can be resized by dragging the separating line. Clicking any row transfers its details to the metadata editing controls below. If several files are selected, black text indicates that the value is common to all of the
500selected files, while grey text indicates that it is not. Black values may be
501updated or removed, while grey ones can be removed from those that have it, or
502appended to the others.
503<Break/>
504A folder icon may appear beside some metadata entries. This indicates that the
505values are inherited from a parent (or ancestor) folder. Inherited metadata
506cannot be edited or removed, only appended to or overwritten. Click on the
507folder icon to go immediately to the folder where the metadata is assigned.
508<Break/>
509The metadata editing controls at the lower right appear only when a file is selected from the tree and a row is selected from the table. Use them to update, append,
510and remove the metadata value. The value field is for entering or editing the
511metadata value. Beside it is a button labelled "..." which, when clicked,
512opens a larger editing box. In the buttons below, "Append" assigns the value as
513new metadata and adds it to any existing values for the selected element,
514"Replace" overwrites the selected existing value with the new one, and "Remove" clears
515the selected value. Underneath, labelled "All Previous Values", is the "Value
516Tree".
517<Break/>
518The Value Tree expands and collapses. Usually it is a list that shows all
519values entered previously for the selected element. Clicking an entry
520automatically places it into the value field. Conversely, typing in the text
521field selects the Value Tree entry that starts with the characters you have
522typed. Pressing [Tab] auto-completes the typing with the selected value.
523<Break/>
524Metadata 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
525example, "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.
526<Break/>
527Greenstone extracts metadata automatically from documents into a metadata set
528whose elements are prefixed by "ex.". This has no value tree and cannot be
529edited, so the edit controls are hidden if such an entry is selected. The
530"..." button still serves to expand the value, but the text cannot be edited.
531 </Section>
532 <Section name="selectingmetadatasets">
533 <Title>Selecting Metadata Sets</Title>
534<ObviousSentence>This section explains how to specify metadata elements and how to add metadata sets to your collection.</ObviousSentence>
535 <Contents>
536 <ContentsGroup linkto="simple">
537 <ContentsItem>
538 What is a metadata set?
539 </ContentsItem>
540 <ContentsItem>
541 Controlling the metadata sets used
542 </ContentsItem>
543 </ContentsGroup>
544 </Contents>
545 <Anchor name="simple">Simple Instructions:</Anchor>
546Sets of predefined metadata elements are known as "metadata sets". An example
547is the Dublin Core metadata set. When you add a metadata set to your
548collection, its elements become available for selection. You can have more than
549one set; to prevent name clashes a short identifier that identifies the
550metadata set is pre-pended to the element name. For instance the Dublin Core
551element Creator becomes "dc.Creator". Metadata sets are stored in the
552Librarian Interface's metadata folder and have the suffix ".mds".
553<Break/>
554To control the metadata sets used in a collection, use the "Metadata Sets" entry on the Design view.
555 </Section>
556 <Section name="appendingmetadata">
557 <Title>Appending New Metadata</Title>
558<ObviousSentence>This section explains how to add metadata and values to files, and how to add new values for metadata elements.</ObviousSentence>
559 <Contents>
560 <ContentsGroup linkto="simple">
561 <ContentsItem>
562 Adding to files
563 </ContentsItem>
564 <ContentsItem>
565 Adding to folders or multiple files
566 </ContentsItem>
567 </ContentsGroup>
568 <ContentsGroup linkto="advanced">
569 <ContentsItem>
570 Value hierarchies and editing values
571 </ContentsItem>
572 </ContentsGroup>
573 </Contents>
574 <Anchor name="simple">Simple Instructions:</Anchor>
575We now add a metadata item -- both element and value -- to a file. First select
576the file from the Collection file tree on the left. The action causes any
577metadata previously assigned to this file to appear in the table at the right.
578<Break/>
579Next select the metadata element you want to add by clicking its row in the
580table.
581<Break/>
582Type the value into the value field. Do not use the character "|", as it is
583used for constructing hierarchies. When finished, click "Append" to add the new
584value as metadata for the chosen file. The value immediately appears in the
585Metadata table.
586<Break/>
587You can also add metadata to a folder, or to several multiply selected files at
588once. It is added to all files within the folder or selection, and to child
589folders. Keep in mind that if you assign metadata to a folder, any new files in
590it automatically inherit the folder's values.
591<Break/>
592If you choose metadata that occurs in some of the selected files and click
593"Append", it is added to the other files in the selection too.
594 <Anchor name="advanced">Advanced Instructions:</Anchor>
595You can add structure to metadata values by using paths as described in <Reference target="theenrichview">The Enrich View</Reference>.
596 </Section>
597 <Section name="addingpreviouslydefinedmetadata">
598 <Title>Adding Previously Defined Metadata</Title>
599<ObviousSentence>This section explains how to add metadata that uses values already present in the value tree.</ObviousSentence>
600 <Contents>
601 <ContentsGroup linkto="simple">
602 <ContentsItem>
603 Adding to files
604 </ContentsItem>
605 <ContentsItem>
606 Adding to folders or multiple files
607 </ContentsItem>
608 </ContentsGroup>
609 </Contents>
610 <Anchor name="simple">Simple Instructions:</Anchor>
611To add metadata that has an existing value, first select the file, then select
612the required value from the value tree, expanding hierarchy folders as
613necessary. The value of the selected entry automatically appears in the Value
614text field (alternatively, use the value tree's auto-select and auto-complete
615features). Click "Append" to add the metadata to the selected file.
616<Break/>
617The process of adding metadata with already-existing values to folders
618or multiple files is just the same.
619 </Section>
620 <Section name="updatingmetadata">
621 <Title>Updating Metadata</Title>
622<ObviousSentence>This section explains how to update the metadata assigned to a file.</ObviousSentence>
623 <Contents>
624 <ContentsGroup linkto="simple">
625 <ContentsItem>
626 Updating files
627 </ContentsItem>
628 <ContentsItem>
629 Updating folders or multiple files
630 </ContentsItem>
631 </ContentsGroup>
632 </Contents>
633 <Anchor name="simple">Simple Instructions:</Anchor>
634To update the value of a piece of metadata, first choose the file to which that
635value applies, and then the metadata element whose value you want to change.
636Your selection appears in the metadata edit controls. Edit the value field and
637click "Replace" to alter the metadata.
638<Break/>
639The 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.
640<Break/>
641The value tree shows all previous values, not just those currently assigned.
642Thus the value you have replaced will remain in the value tree.
643 </Section>
644 <Section name="removingmetadata">
645 <Title>Removing Metadata</Title>
646<ObviousSentence>This section explains how to remove metadata from a file.</ObviousSentence>
647 <Contents>
648 <ContentsGroup linkto="simple">
649 <ContentsItem>
650 Removing from files
651 </ContentsItem>
652 <ContentsItem>
653 Removing from folders or multiple files
654 </ContentsItem>
655 </ContentsGroup>
656 </Contents>
657 <Anchor name="simple">Simple Instructions:</Anchor>
658You remove metadata the same way as you update it. First select a file from the
659file tree, then use the metadata table to select the metadata. If the metadata has a value assigned, the "Remove" button becomes active.
660Click it to remove the metadata from the specified file. Other files
661remain unchanged, and the value remains in the Value Tree.
662<Break/>
663Removing metadata from folders or multiple files works the same way.
664 </Section>
665 <Section name="reviewingmetadata">
666 <Title>Reviewing Assigned Metadata</Title>
667<ObviousSentence>This section describes how to view all metadata assigned to an entire collection.</ObviousSentence>
668 <Contents>
669 <ContentsGroup linkto="simple">
670 <ContentsItem>
671 The audit table
672 </ContentsItem>
673 </ContentsGroup>
674 <ContentsGroup linkto="advanced">
675 <ContentsItem>
676 Right button menu
677 </ContentsItem>
678 <ContentsItem>
679 Autofilter
680 </ContentsItem>
681 </ContentsGroup>
682 </Contents>
683 <Anchor name="simple">Simple Instructions:</Anchor>
684Sometimes you need to see the metadata assigned to many or all files at once -- for instance,
685to determine how many files are left to work on, or to get some idea of the
686spread of dates.
687<Break/>
688Select the files you wish to examine, then right-click and choose "Assigned Metadata...". A window called
689"All Metadata", dominated by a large table with many columns, appears. The
690first column shows file names; the rows show all metadata values assigned to
691those files.
692<Break/>
693Drawing the table can take some time if many files are selected. You can continue to use the Librarian
694Interface while the "All Metadata" window is open.
695<Break/>
696Click "Close" to hide the window.
697 <Anchor name="advanced">Advanced Instructions:</Anchor>
698You can also view the "All Metadata" table by selecting the files you wish to
699examine, right-clicking, and choosing "Assigned Metadata...". If a folder has
700been selected, all its child files are included in the table.
701<Break/>
702When it gets too large, you can filter the "All Metadata" table by applying
703filters to the columns. As new filters are added, only those rows that match
704them remain visible. To set, modify or clear a filter, click on the "funnel"
705icon at the top of a column. You are prompted for information about the filter.
706Once a filter is set, the column header changes colour.
707<Break/>
708The prompt has a "Simple" and an "Advanced" tab. The Simple version filters
709columns so that they only show rows that contain a certain metadata value ("*"
710matches all values). You can select metadata values from the pull-down list.
711The Advanced version allows different matching operations: must start with,
712does not contain, alphabetically less than and is equal to. The value to be
713matched can be edited to be any string (including "*"), and you can choose
714whether the matching should be case insensitive. Finally, you can specify a
715second matching condition that you can use to specify a range of values (by
716selecting AND) or alternative values (by selecting OR). Below this area is a
717box that allows you to change the sort order (ascending or descending). Once
718you have finished, click "Set Filter" to apply the new filter to the column.
719Click "Clear Filter" to remove a current filter. Note that the filter details
720are retained even when the filter is cleared.
721<Break/>
722For example, to sort the "All Metadata" table, choose a column, select the
723default filter setting (a Simple filter on "*"), and choose ascending or
724descending ordering.
725 </Section>
726 <Section name="importingpreviouslyassignedmetadata">
727 <Title>Importing Previously Assigned Metadata</Title>
728This section describes how to import previously assigned metadata: metadata assigned to documents before they were added to the collection.
729 <Contents>
730 <ContentsGroup linkto="simple">
731 <ContentsItem>
732 While adding files
733 </ContentsItem>
734 </ContentsGroup>
735 </Contents>
736 <Anchor name="simple">Simple Instructions:</Anchor>
737If metadata in a form recognized by the Librarian Interface has been previously
738assigned to a file -- for example, when you choose documents from an existing
739Greenstone collection -- it is imported automatically when you add the file.
740To do this, the metadata must be mapped to the metadata sets available in the
741collection.
742<Break/>
743The Librarian Interface prompts for the necessary information. The prompt
744gives brief instructions and then shows the name of the metadata element that
745is being imported, just as it appears in the source file. This field cannot be
746edited or changed. Next you choose what metadata set the new element should map
747to, and then the appropriate metadata element in that set. The system
748automatically selects the closest match, in terms of set and element, for the
749new metadata.
750<Break/>
751Having checked the mapping, you can choose "Add" to add the new metadata
752element to the chosen metadata set. (This is only enabled if there is no
753element of the same name within the chosen set.) "Replace" maps the new element
754to the one chosen by the user. Finally, "Ignore" does not import any metadata
755with this element name. Once you have specified how to import a certain piece of metadata, the mapping
756information is retained for the collection's lifetime.
757<Break/>
758For details on the metadata.xml files which Greenstone uses to store the metadata, see Chapter 2 of the Greenstone
759Developer's Guide -- Getting the most out of your documents.
760 </Section>
761 </Section>
762
763 <Section name="designingacollection">
764 <Title>Designing Your Collection's Appearance</Title>
765Once your files are marked up with metadata, you next decide how it should
766appear to users as a Greenstone collection. What kind of information is
767searchable? What ways are provided to browse through the documents? What
768languages are supported? Where do the buttons appear on the page? These
769things can be customized; this section describes how to do it.
770 <Section name="thedesignview">
771 <Title>The Design View</Title>
772This section introduces you to the design view and explains how to navigate
773between the various views within this pane.
774 <Contents>
775 <ContentsGroup linkto="simple">
776 <ContentsItem>
777 Choosing a design section
778 </ContentsItem>
779 </ContentsGroup>
780 </Contents>
781 <Anchor name="simple">Simple Instructions:</Anchor>
782With the Librarian Interface, you can configure how the collection appears to
783the user. The configuration options are divided into different sections, each
784associated with a particular stage of navigating or presenting information.
785<Break/>
786On the left is a list of different views, and on the right are the controls
787associated with the current one. To change to a different view, click its name
788in the list.
789<Break/>
790To understand the stages and terms involved in designing a collection, first
791read Chapters 1 and 2 of the Greenstone Developer's Guide.
792 </Section>
793 <Section name="generalsettings">
794 <Title>General Settings</Title>
795This section explains how to review and alter the general settings associated
796with your collection. First, under "Design Sections", click "General".
797 <Contents>
798 <ContentsGroup linkto="simple">
799 <ContentsItem>
800 General settings
801 </ContentsItem>
802 </ContentsGroup>
803 </Contents>
804 <Anchor name="simple">Simple Instructions:</Anchor>
805Here the values provided during collection creation can be modified.
806<Break/>
807At the top of the page is an instruction box, which appears for each of the
808different sections. It contains a brief list of instructions to remind you
809what functionality is available.
810<Break/>
811First are the contact emails of the collection's creator and maintainer.
812The 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.
813The next one specifies (in the form of a URL) the
814icon to show at the top left of the collection's "About" page, and the next is
815the icon used in the Greenstone library page to link to the collection. Then, a checkbox controls whether the collection should be publicly accessible.
816Finally comes the "Collection Description" text area as described in <Reference target="creatingacollection">Creating A New Collection</Reference>.
817 </Section>
818 <Section name="plugins">
819 <Title>Document Plugins</Title>
820This section describes how to configure the document plugins the
821collection uses. It explains how you specify what
822plugins to use, what parameters to pass to them, and in what order
823they occur. Under "Design Sections", click "Document Plugins".
824 <Contents>
825 <ContentsGroup linkto="simple">
826 <ContentsItem>
827 Add a plugin
828 </ContentsItem>
829 <ContentsItem>
830 Remove a plugin
831 </ContentsItem>
832 <ContentsItem>
833 Configure a plugin
834 </ContentsItem>
835 <ContentsItem>
836 Change plugin order
837 </ContentsItem>
838 </ContentsGroup>
839 <ContentsGroup linkto="advanced">
840 <ContentsItem>
841 Custom configuration
842 </ContentsItem>
843 </ContentsGroup>
844 </Contents>
845 <Anchor name="simple">Simple Instructions:</Anchor>
846To add a plugin, select it using the "Select plugin to add" pull-down list near the
847bottom and then click "Add Plugin". A window appears entitled
848"Configuring Arguments"; it is described later. Once you have configured the
849new plugin, it is added to the end of the "Currently Assigned Plugins" list.
850Note that, except for UnknownPlug, each plugin may only occur once in the list.
851<Break/>
852To remove a plugin, select it in the list and click "Remove Plugin".
853<Break/>
854Plugins are configured by providing arguments. To alter them, select the
855plugin from the list and click "Configure Plugin" (or double-click
856the plugin). A "Configuring Arguments" dialog appears with various controls for specifying arguments.
857<Break/>
858There are different kinds of controls. Some are checkboxes, and clicking one
859adds the appropriate option to the plugin. Others are text strings, with a
860checkbox and a text field. Click the box to enable the argument, then type
861appropriate text (regular expression, file path etc) in the box. Others are
862pull-down menus from which you can select from a given set of values. To learn what an
863argument does, let the mouse hover over its name for a moment and a description
864will appear.
865<Break/>
866When you have changed the configuration, click "OK" to commit the changes and
867close the dialog, or "Cancel" to close the dialog without changing any plugin
868arguments.
869<Break/>
870The plugins in the list are executed in order, and the ordering is sometimes
871important. Two plugins, ArcPlug and RecPlug, are vital to the collection
872building process, and are fixed in place at the end of the list (with a
873separator line). To change the ordering of the other ones, select the plugin you want to move
874and click "Move Up" or "Move Down".
875 <Anchor name="advanced">Advanced Instructions:</Anchor>
876The Librarian Interface does its best to determine what arguments a plugin
877supports. However, there may be cases where the user wants to specify special arguments, and for this a text field called "Custom Arguments" (at the bottom) is provided. Any text in it is appended verbatim to the end of the plugin
878command.
879 </Section>
880 <Section name="searchtypes">
881 <Title>Search Types</Title>
882This section explains how to modify a new design feature in Greenstone, Search Types, which allow fielded searching. Under "Design Sections", click "Search Types".
883 <Contents>
884 <ContentsGroup linkto="simple">
885 <ContentsItem>
886 What enabling advanced searches means
887 </ContentsItem>
888 <ContentsItem>
889 Adding a new search type
890 </ContentsItem>
891 <ContentsItem>
892 Removing a search type
893 </ContentsItem>
894 <ContentsItem>
895 Changing the order of search types
896 </ContentsItem>
897 </ContentsGroup>
898 </Contents>
899 <Anchor name="simple">Simple Instructions:</Anchor>
900When you enter the Search Types view, first check "Enable Advanced
901Searches", which activates the other controls. This migrates the collection to
902Greenstone 2.4 format, which supports fielded searching, and means that (a)
903the index design is different (explained in the <Reference target="searchindexes">Search Indexes</Reference> section),
904(b) there are more text fragments to translate (see <Reference target="translatetext">Translation</Reference>), and (c) the collection will not be usable under older Greenstone
905installations. If you later uncheck this field, most of your collection will
906be migrated back to Greenstone 2.39. However the Librarian Interface cannot
907convert the new index specifications into older ones, so you will have to
908re-enter them manually.
909<Break/>
910To 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.
911<Break/>
912To remove a search type, select it from the "Currently Assigned Search Types"
913list and click "Remove Search Type". The list must contain at least
914one search type.
915<Break/>
916To change to order of a search type, select it from the list and click "Move
917Up" or "Move Down". The first one will be the default.
918 </Section>
919 <Section name="searchindexes">
920 <Title>Search Indexes</Title>
921Indexes 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".
922 <Contents>
923 <ContentsGroup linkto="simple">
924 <ContentsItem>
925 Add an index
926 </ContentsItem>
927 <ContentsItem>
928 Edit an index
929 </ContentsItem>
930 <ContentsItem>
931 Remove an index
932 </ContentsItem>
933 <ContentsItem>
934 Set default index
935 </ContentsItem>
936 </ContentsGroup>
937 </Contents>
938 <Anchor name="simple">Simple Instructions:</Anchor>
939To add an index, type a name for it into the "Index Name" field. Select which
940of the possible information sources to index by clicking the checkboxes beside
941them. The list shows all the assigned metadata elements, as well the full
942text. Having selected the data sources, choose the granularity of the index,
943using the "At the level" menu. Once these details are complete, "Add Index"
944becomes active (unless there is an existing index with the same settings).
945Click it to add the new index.
946<Break/>
947To edit an index, select it and change the index details, then click "Replace Index".
948<Break/>
949To remove an index, select it from the list of assigned indexes and click
950"Remove Index".
951<Break/>
952The default index, the one used on the collection's search page, is tagged with
953"[Default Index]" in the "Assigned Indexes" list. To set it, select an index
954from the list and click "Set Default".
955<Break/>
956If advanced searching is enabled (via the Search Types view), the index controls are different. Each index
957is based on just one data source. There is a new pseudo-data source "allfields" which provides searching across all specified indexes at once. Levels are not
958assigned to a specific index, but apply across all indexes: thus indexes and
959levels are added separately. Indexes are removed in the same way as above, but
960the default index can no longer be set -- it is simply the
961first index assigned.
962<Break/>
963To create indexes on all sources, click the "Add All" button. The name of each index will default to the source name. To change the name, select an index, change its details, and click "Replace Index".
964 </Section>
965 <Section name="partitionindexes">
966 <Title>Partition Indexes</Title>
967Indexes are built on particular text or metadata sources. The search space can
968be further controlled by partitioning the index, either by language or by a
969predetermined filter. This section describes how to do this. Under "Design
970Sections", click "Partition Indexes".
971<Break/>
972The "Partition Indexes" view has three tabs; "Define Filters", "Assign
973Partitions" and "Assign Languages". To learn more about partitions read about
974subcollections and subindexes in Chapter 2 of the Greenstone Developer's Guide.
975
976 <Section name="definefilters">
977 <Title>Define Filters</Title>
978<ObviousSentence>The section explains how to define a partition filter.</ObviousSentence>
979 <Contents>
980 <ContentsGroup linkto="simple">
981 <ContentsItem>
982 Add a filter
983 </ContentsItem>
984 <ContentsItem>
985 Remove a filter
986 </ContentsItem>
987 <ContentsItem>
988 Update a filter
989 </ContentsItem>
990 </ContentsGroup>
991 </Contents>
992 <Anchor name="simple">Simple Instructions:</Anchor>
993Filters allows you to group together into a subcollection all documents in an
994index for which a metadata value matches a given pattern.
995<Break/>
996To create a filter, click the "Define Filters" tab and enter a name for the
997new filter into the "Name the subcollection filter" field. Next choose a
998document attribute to match against, either a metadata element or the name of
999the file in question. Enter a regular expression to use during the matching.
1000You can toggle between "Including" documents that match the filter, or
1001"Excluding" them. Finally, you can specify any of the standard PERL regular
1002expression flags to use when matching (e.g. "i" for case-insensitive matching).
1003Finally, click "Add Filter" to add the filter to the "Defined Subcollection Filters"
1004list.
1005<Break/>
1006To remove a filter, select it from the list and click "Remove Filter".
1007<Break/>
1008To alter a filter, select it from the list, change any of the values that
1009appear in the editing controls and click "Replace Filter" to commit the changes.
1010 </Section>
1011 <Section name="assignpartitions">
1012 <Title>Assign Partitions</Title>
1013<ObviousSentence>This section explains how to assign a previous defined partition filter.</ObviousSentence>
1014 <Contents>
1015 <ContentsGroup linkto="simple">
1016 <ContentsItem>
1017 Add a partition
1018 </ContentsItem>
1019 <ContentsItem>
1020 Remove a partition
1021 </ContentsItem>
1022 <ContentsItem>
1023 Set default partition
1024 </ContentsItem>
1025 <ContentsItem>
1026 Clear default partition
1027 </ContentsItem>
1028 </ContentsGroup>
1029 </Contents>
1030 <Anchor name="simple">Simple Instructions:</Anchor>
1031Having defined a subcollection filter, use the "Assign Partitions" tab to build
1032indexes for it (or for a group of filters). Select the desired filter (or
1033filters) from the "Defined Subcollection Filters" list, enter a name for your partition in the "Partition Name" field, and click "Add Partition".
1034<Break/>
1035To remove a partition, select it from the list and click "Remove Partition".
1036<Break/>
1037To make a partition the default one, select it from the list and click "Set
1038Default".
1039<Break/>
1040To clear the default partition, click "Clear Default".
1041 </Section>
1042 <Section name="assignlanguages">
1043 <Title>Assign Languages</Title>
1044This section details how to restrict search indexes to particular languages.
1045You do this by generating a partition using the "Assign Languages" tab of the
1046"Partition Indexes" view.
1047 <Contents>
1048 <ContentsGroup linkto="simple">
1049 <ContentsItem>
1050 Language controls
1051 </ContentsItem>
1052 <ContentsItem>
1053 Add language
1054 </ContentsItem>
1055 <ContentsItem>
1056 Remove language
1057 </ContentsItem>
1058 <ContentsItem>
1059 Set default language
1060 </ContentsItem>
1061 <ContentsItem>
1062 Clear default language
1063 </ContentsItem>
1064 </ContentsGroup>
1065 </Contents>
1066 <Anchor name="simple">Simple Instructions:</Anchor>
1067To add a new language to partition by, use the "Assign Languages" tab to build
1068an index for it. Select the desired language from the "Language to add"
1069pull-down list and click "Add Language".
1070<Break/>
1071To remove a language, select it from the "Language Selection" list and click
1072"Remove Language".
1073<Break/>
1074To set the default language, select it from the list and click "Set Default".
1075<Break/>
1076To clear the default language, click "Clear Default".
1077 </Section>
1078 </Section>
1079 <Section name="xcollectionsearching">
1080 <Title>Cross-Collection Searching</Title>
1081Greenstone can search across several different collections as though they were
1082one. This is done by creating a "super-collection" that comprises the
1083individual collections. Under "Design Sections", click "Cross-Collection Search".
1084 <Contents>
1085 <ContentsGroup linkto="simple">
1086 <ContentsItem>
1087 Selecting a collection
1088 </ContentsItem>
1089 </ContentsGroup>
1090 </Contents>
1091 <Anchor name="simple">Simple Instructions:</Anchor>
1092The Cross-Collection Search view shows a checklist of available collections. The
1093current collection is ticked and cannot be deselected. To add another
1094collection to be searched in parallel, click it in the list (click again to
1095remove it). If only one collection is selected, there is no cross-collection
1096searching.
1097<Break/>
1098For further details, see Chapter 1 of the Greenstone Developer's Guide.
1099 </Section>
1100 <Section name="classifiers">
1101 <Title>Classifiers</Title>
1102This section explains how to assign "classifiers", which are used for browsing,
1103to the collection. Under "Design Sections", click "Browsing Classifiers".
1104 <Contents>
1105 <ContentsGroup linkto="simple">
1106 <ContentsItem>
1107 Classifier selection and configuration
1108 </ContentsItem>
1109 <ContentsItem>
1110 Add a classifier
1111 </ContentsItem>
1112 <ContentsItem>
1113 Remove a classifier
1114 </ContentsItem>
1115 <ContentsItem>
1116 Configure a classifier
1117 </ContentsItem>
1118 <ContentsItem>
1119 Alter classifier ordering
1120 </ContentsItem>
1121 </ContentsGroup>
1122 </Contents>
1123 <Anchor name="simple">Simple Instructions:</Anchor>
1124To add a classifier, select it using the "Select classifier to add" pull-down list near the
1125bottom and then click "Add Specified Classifier". A window appears entitled
1126"Configuring Arguments"; instructions for this dialog are just the same as for
1127plugins (see <Reference target="plugins">Document Plugins</Reference>). Once you have configured the new
1128classifier, it is added to the end of the "Currently Assigned Classifiers"
1129list.
1130<Break/>
1131To remove a classifier, select it from the list and click "Remove Selected
1132Classifier".
1133<Break/>
1134To change the arguments a classifier, select it from the list and click
1135"Configure Selected Classifier" (or double-click on the classifier in the
1136list).
1137<Break/>
1138The ordering of classifiers in the collection's navigation bar is reflected in
1139their order here. To change it, select the classifier you want to move and
1140click "Move Up" or "Move Down".
1141<Break/>
1142For further information on classifiers read Chapter 2, Greenstone
1143Developer's Guide -- Getting the most out of your documents.
1144 </Section>
1145 <Section name="formatstatements">
1146 <Title>Format Features</Title>
1147Format commands control the structure and appearance of the collection. They
1148affect such things as where buttons appear when a document is shown, and what
1149links are displayed by the DateList classifier. Format commands are not easy
1150to develop, and you should read Chapter 2 of the Greenstone Developer's Guide.
1151This section discusses the format settings, and how the Librarian Interface
1152gives access to them. Under "Design Sections", click "Format Features".
1153 <Contents>
1154 <ContentsGroup linkto="simple">
1155 <ContentsItem>
1156 Formatting
1157 </ContentsItem>
1158 <ContentsItem>
1159 Add format command
1160 </ContentsItem>
1161 <ContentsItem>
1162 Remove format command
1163 </ContentsItem>
1164 <ContentsItem>
1165 Update format command
1166 </ContentsItem>
1167 </ContentsGroup>
1168 <ContentsGroup linkto="advanced">
1169 <ContentsItem>
1170 Extended formatting options
1171 </ContentsItem>
1172 </ContentsGroup>
1173 </Contents>
1174 <Anchor name="simple">Simple Instructions:</Anchor>
1175You can apply a format command to anything in the "Choose Feature" pull-down
1176list, which includes each classifier and a predefined list of features. When
1177you select a feature, there are two types of control. Some features are simply
1178enabled or disabled, and this is controlled by a checkbox. Others require a
1179format string to be specified. For these there is a pull-down list ("Affected
1180Component") for selecting which part of the feature the string applies to
1181(if necessary), a text area ("HTML Format String") for entering the string,
1182and a selection of predefined "Variables". To insert a variable into the
1183current position in the format string, select it from the pull-down list and
1184click "Insert".
1185<Break/>
1186You can specify a default format for a particular component by selecting the
1187blank feature. This format is then applied to all applicable features unless
1188otherwise specified.
1189<Break/>
1190To add a new format command, fill out the information as explained above and
1191click "Add Format". The new format command appears in the list of "Currently
1192Assigned Format Commands". Only one format command can be assigned to each
1193feature/component combination.
1194<Break/>
1195To remove a format command, select it from the list and click "Remove Format".
1196<Break/>
1197To change a format command, select it from the list, modify the settings, and
1198click "Replace Format".
1199<Break/>
1200For more information about variables and the feature components, read Chapter 2
1201of the Greenstone Developer's Guide.
1202 <Anchor name="advanced">Advanced Instructions:</Anchor>
1203If 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.
1204 </Section>
1205 <Section name="translatetext">
1206 <Title>Translate Text</Title>
1207This section describes the translation view, where you can define
1208language-specific text fragments for parts of the collection's interface.
1209Under "Design Sections", click "Translate Text".
1210 <Contents>
1211 <ContentsGroup linkto="simple">
1212 <ContentsItem>
1213 Add translation
1214 </ContentsItem>
1215 <ContentsItem>
1216 Remove translation
1217 </ContentsItem>
1218 <ContentsItem>
1219 Update translation
1220 </ContentsItem>
1221 </ContentsGroup>
1222 </Contents>
1223 <Anchor name="simple">Simple Instructions:</Anchor>
1224First choose the an entry from the "Features" list. The language-specific
1225strings associated with this feature appear below. Use the "Language of
1226translation" pull-down list to select the target language, and type the
1227translated text into the text area, referring to the "Initial Text Fragment" if
1228necessary. Click "Add Translation" when finished.
1229<Break/>
1230To remove an existing translation, select it in the "Assigned Translations"
1231table and click "Remove Translation".
1232<Break/>
1233To edit a translation, select it, edit it in the "Translated Text" text
1234area, and click "Replace Translation".
1235 </Section>
1236 <Section name="metadatasets">
1237 <Title>Metadata Sets</Title>
1238This section explains the metadata set review panel.
1239Under "Design Sections", click "Metadata Sets".
1240 <Contents>
1241 <ContentsGroup linkto="simple">
1242 <ContentsItem>
1243 Available metadata sets
1244 </ContentsItem>
1245 <ContentsItem>
1246 Adding metadata sets
1247 </ContentsItem>
1248 <ContentsItem>
1249 Editing metadata sets
1250 </ContentsItem>
1251 <ContentsItem>
1252 Removing metadata sets
1253 </ContentsItem>
1254 </ContentsGroup>
1255 </Contents>
1256 <Anchor name="simple">Simple Instructions:</Anchor>
1257This view is used to review the metadata sets that the collection uses, and the
1258elements that are available within each set. Choose from the list of "Available
1259Metadata Sets" in order to see details of their elements.
1260<Break/>
1261To use another metadata set with the loaded collection, click "Add Metadata Set" and select the metadata set file (.mds) for the new metadata set.
1262<Break/>
1263Editing 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.
1264<Break/>
1265If 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.
1266 </Section>
1267 </Section>
1268
1269 <Section name="producingthecollection">
1270 <Title>Producing Your Collection</Title>
1271Having collected the documents for the collection, annotated them with
1272metadata, and designed how the collection will appear, you can now produce the
1273collection using Greenstone. This section explains how.
1274 <Section name="thecreateview">
1275 <Title>The Create View</Title>
1276<ObviousSentence>This section explains the Create view used to produce a collection.</ObviousSentence>
1277 <Contents>
1278 <ContentsGroup linkto="simple">
1279 <ContentsItem>
1280 Building the collection
1281 </ContentsItem>
1282 <ContentsItem>
1283 Previewing the collection
1284 </ContentsItem>
1285 </ContentsGroup>
1286 <ContentsGroup linkto="advanced">
1287 <ContentsItem>
1288 Message log
1289 </ContentsItem>
1290 </ContentsGroup>
1291 </Contents>
1292 <Anchor name="simple">Simple Instructions:</Anchor>
1293The Create view is used to create the collection by running Greenstone
1294collection-building scripts on the information you have provided.
1295Clicking "Build Collection" initiates the collection building process. The time
1296this takes depends on the size of the collection and the number of indexes
1297being 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
1298any time, click "Cancel Build".
1299<Break/>
1300<!-- added -->
1301Once the collection has successfully built, clicking "Preview Collection" will launch a web browser showing the home page of the collection.
1302 <Anchor name="advanced">Advanced Instructions:</Anchor>
1303In 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.
1304 </Section>
1305 <Section name="buildsettings">
1306 <Title>Import and Build Settings</Title>
1307This section explains how to access the various import and build settings.
1308For more information of importing and building read Chapter 1 of the Greenstone
1309Developer's Guide -- Understanding the collection-building process.
1310 <Contents>
1311 <ContentsGroup linkto="simple">
1312 <ContentsItem>
1313 General settings
1314 </ContentsItem>
1315 <ContentsItem>
1316 Import settings
1317 </ContentsItem>
1318 <ContentsItem>
1319 Build settings
1320 </ContentsItem>
1321 </ContentsGroup>
1322 </Contents>
1323 <Anchor name="simple">Simple Instructions:</Anchor>
1324Controlling the various settings is done in a similar way to the
1325"Configuring Arguments" window described in the <Reference target="plugins">Document Plugins</Reference> section. Some
1326fields require numeric arguments, and you can either type these in or use the
1327up and down arrows to increase or decrease the current value (in some cases,
1328the interface restricts the range you can enter). Others are enabled by
1329clicking a checkbox (click again to disable).
1330 </Section>
1331 </Section>
1332
1333 <Section name="miscellaneous">
1334 <Title>Miscellaneous</Title>
1335This section describes features of the Librarian Interface that are not associated
1336with any particular view.
1337 <Section name="preferences">
1338 <Title>Preferences</Title>
1339This section explains the preferences dialog, accessed by opening "File" -> "Preferences".
1340 <Contents>
1341 <ContentsGroup linkto="simple">
1342 <ContentsItem>
1343 General
1344 </ContentsItem>
1345 <ContentsItem>
1346 Mode
1347 </ContentsItem>
1348 <ContentsItem>
1349 Workflow
1350 </ContentsItem>
1351 <ContentsItem>
1352 Connection
1353 </ContentsItem>
1354 <ContentsItem>
1355 Warnings
1356 </ContentsItem>
1357 </ContentsGroup>
1358 </Contents>
1359 <Anchor name="simple">Simple Instructions:</Anchor>
1360The 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
1361restart the Librarian Interface in order to load the new language strings from
1362the dictionary.
1363<Break/>
1364If "View Extracted Metadata" is checked, the
1365various controls dealing with metadata always show all metadata that has been
1366extracted automatically from documents. Deselecting it hides this metadata
1367(although it is still available during collection design, and within the
1368final 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.
1369<Break/>
1370The "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.
1371<Break/>
1372The Librarian Interface can support different workflows by determining which of
1373the various view tabs are visible. Use the "Workflow" tab to customise what
1374views are available by checking the boxes next to the views that you want to be
1375available. Alternatively, use the pull-down list at the bottom to select
1376predetermined configurations. Closing the preferences dialog establishes these
1377workflow settings. These settings are stored with the collection, not in the
1378Librarian Interface configuration file.
1379<Break/>
1380The "Connection" tab lets you alter the path to the locally-running Greenstone library server, which is used when Previewing collections. It also lets you set proxy information for connecting to the Internet (e.g. when downloading files; see the <Reference target="downloadingfiles">Downloading Files From the Internet</Reference> section for details). Check the box to enable proxy connection and supply details of the proxy host address and port number. The proxy connection is established when you close the Preferences dialog.
1381<Break/>
1382During the course of a session the Librarian Interface may give warning
1383messages which inform you of possibly unforeseen consequences of an action. You
1384can disable the messages by checking the "Do not show this warning again" box.
1385You can re-enable warning messages using the "Warnings" tab. Check the box
1386next to warning messages you want to see again.
1387 </Section>
1388 <Section name="fileassociations">
1389 <Title>File Associations</Title>
1390The Librarian Interface uses particular application programs to open particular
1391file types. This section explains how to assign and edit these file
1392associations.
1393 <Contents>
1394 <ContentsGroup linkto="simple">
1395 <ContentsItem>
1396 Add association
1397 </ContentsItem>
1398 <ContentsItem>
1399 Edit association
1400 </ContentsItem>
1401 <ContentsItem>
1402 Remove association
1403 </ContentsItem>
1404 </ContentsGroup>
1405 </Contents>
1406 <Anchor name="simple">Simple Instructions:</Anchor>
1407To alter file associations open the "File" menu and click "File
1408Associations...".
1409<Break/>
1410To add an association, select the target file extension from the pull-down
1411list, or type in a new extension (do not include the "."). Next either type
1412command that launches the desired application in the appropriate field, or
1413choose the application from the "Browse" dialog. "%1" can be used in the launch
1414command to insert the name of the file being opened. Once these are filled out,
1415"Add Association" is enabled and can be clicked to add the association.
1416<Break/>
1417To edit an association, select an existing file extension. Any existing
1418associated command is shown in the launch command field. Edit it, and then
1419click "Replace Association".
1420<Break/>
1421To remove an association, select an existing file extension and click "Remove Association".
1422(The file extension remains in the "For Files Ending" pull-down list.)
1423<Break/>
1424File associations are stored in the Librarian Interface's main folder, in a file
1425called "associations.xml".
1426 </Section>
1427 <Section name="exportingcollections">
1428 <Title>Exporting Collections to CD-ROM</Title>
1429
1430This section describes how to export collections to a self-installing
1431Greenstone CD-ROM.
1432 <Contents>
1433 <ContentsGroup linkto="simple">
1434 <ContentsItem>
1435 How to export
1436 </ContentsItem>
1437 </ContentsGroup>
1438 </Contents>
1439 <Anchor name="simple">Simple Instructions:</Anchor>
1440Greenstone can export one or more collections to a self-installing
1441CD-ROM for Windows. To do so, Greenstone's "Export to CD-ROM" package
1442must be installed. This is not included by default, so you may need to
1443modify your installation to include it.
1444<Break/>
1445To export a collection, open the "File" menu and choose "Export to
1446CD-ROM". A list of Greenstone collections appears; click on any one to
1447see its description. Tick the check boxes of the collections to export.
1448You can enter the CD-ROM's name in the box: this is what will appear in
1449the Start menu when the CD-ROM has been installed. Then click "Export".
1450The process involves copying many files and may take a few minutes.
1451<Break/>
1452Upon completion, Greenstone will show the name of a folder containing
1453the exported collections. Use a CD writer to copy its contents to a
1454blank CD-ROM.
1455 </Section>
1456 </Section>
1457</Document>
Note: See TracBrowser for help on using the repository browser.