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

Last change on this file since 11064 was 11064, checked in by mdewsnip, 18 years ago

Added some extra Break tags in preparation for removing the Anchor tags.

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