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

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

Updated GLI help files from the first set of translations for the UNESCO 2005 CD-ROM. Have NOT updated the HTML files -- this will be done once the translations are complete.

  • Property svn:keywords set to Author Date Id Revision
File size: 67.6 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{2.intro}
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>{2.4.title}</Title>
219<ObviousSentence>{2.4.obvious}</ObviousSentence>
220 <Contents>
221 <ContentsGroup linkto="simple">
222 <ContentsItem>
223 {2.4.contents}
224 </ContentsItem>
225 </ContentsGroup>
226 </Contents>
227 <Anchor name="simple">Simple Instructions:</Anchor>
228{2.4.text}
229 </Section>
230 </Section>
231
232 <Section name="downloadingfiles">
233 <Title>Downloading Files From the Internet</Title>
234{3.intro} This section explains the Librarian Interface's mirroring process.
235 <Section name="themirrorview">
236 <Title>The Mirror 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 "Mirror" view by clicking its tab. The top half of the screen shows the downloading controls. The bottom half is initially empty, but will show a list of pending 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/>
323{4.1.status} 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 {5.1.controls.short}
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. {5.1.controls.1}
500If several files are selected, black text indicates that the value is common to all of the
501selected files, while grey text indicates that it is not. Black values may be
502updated or removed, while grey ones can be removed from those that have it, or
503appended to the others.
504<Break/>
505A folder icon may appear beside some metadata entries. This indicates that the
506values are inherited from a parent (or ancestor) folder. Inherited metadata
507cannot be edited or removed, only appended to or overwritten. Click on the
508folder icon to go immediately to the folder where the metadata is assigned.
509<Break/>
510{5.1.controls.2} Use them to update, append,
511and remove the metadata value. The value field is for entering or editing the
512metadata value. Beside it is a button labelled "..." which, when clicked,
513opens a larger editing box. In the buttons below, "Append" assigns the value as
514new metadata and adds it to any existing values for the selected element,
515"Replace" overwrites the selected existing value with the new one, and "Remove" clears
516the selected value. Underneath, labelled "All Previous Values", is the "Value
517Tree".
518<Break/>
519The Value Tree expands and collapses. Usually it is a list that shows all
520values entered previously for the selected element. Clicking an entry
521automatically places it into the value field. Conversely, typing in the text
522field selects the Value Tree entry that starts with the characters you have
523typed. Pressing [Tab] auto-completes the typing with the selected value.
524<Break/>
525Metadata 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
526example, "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.
527<Break/>
528Greenstone extracts metadata automatically from documents into a metadata set
529whose elements are prefixed by "ex.". This has no value tree and cannot be
530edited, so the edit controls are hidden if such an entry is selected. The
531"..." button still serves to expand the value, but the text cannot be edited.
532 </Section>
533 <Section name="selectingmetadatasets">
534 <Title>Selecting Metadata Sets</Title>
535<ObviousSentence>This section explains how to specify metadata elements and how to add metadata sets to your collection.</ObviousSentence>
536 <Contents>
537 <ContentsGroup linkto="simple">
538 <ContentsItem>
539 {5.2.contents.1}
540 </ContentsItem>
541 <ContentsItem>
542 {5.2.contents.2}
543 </ContentsItem>
544 </ContentsGroup>
545 </Contents>
546 <Anchor name="simple">Simple Instructions:</Anchor>
547Sets of predefined metadata elements are known as "metadata sets". An example
548is the Dublin Core metadata set. When you add a metadata set to your
549collection, its elements become available for selection. You can have more than
550one set; to prevent name clashes a short identifier that identifies the
551metadata set is pre-pended to the element name. For instance the Dublin Core
552element Creator becomes "dc.Creator". Metadata sets are stored in the
553Librarian Interface's metadata folder and have the suffix ".mds".
554<Break/>
555{5.2.metadatasets}
556 </Section>
557 <Section name="appendingmetadata">
558 <Title>Appending New Metadata</Title>
559<ObviousSentence>This section explains how to add metadata and values to files, and how to add new values for metadata elements.</ObviousSentence>
560 <Contents>
561 <ContentsGroup linkto="simple">
562 <ContentsItem>
563 Adding to files
564 </ContentsItem>
565 <ContentsItem>
566 Adding to folders or multiple files
567 </ContentsItem>
568 </ContentsGroup>
569 <ContentsGroup linkto="advanced">
570 <ContentsItem>
571 Value hierarchies and editing values
572 </ContentsItem>
573 </ContentsGroup>
574 </Contents>
575 <Anchor name="simple">Simple Instructions:</Anchor>
576We now add a metadata item -- both element and value -- to a file. First select
577the file from the Collection file tree on the left. The action causes any
578metadata previously assigned to this file to appear in the table at the right.
579<Break/>
580Next select the metadata element you want to add by clicking its row in the
581table.
582<Break/>
583Type the value into the value field. Do not use the character "|", as it is
584used for constructing hierarchies. When finished, click "Append" to add the new
585value as metadata for the chosen file. The value immediately appears in the
586Metadata table.
587<Break/>
588You can also add metadata to a folder, or to several multiply selected files at
589once. It is added to all files within the folder or selection, and to child
590folders. Keep in mind that if you assign metadata to a folder, any new files in
591it automatically inherit the folder's values.
592<Break/>
593If you choose metadata that occurs in some of the selected files and click
594"Append", it is added to the other files in the selection too.
595 <Anchor name="advanced">Advanced Instructions:</Anchor>
596You can add structure to metadata values by using paths as described in <Reference target="theenrichview">The Enrich View</Reference>.
597 </Section>
598 <Section name="addingpreviouslydefinedmetadata">
599 <Title>Adding Previously Defined Metadata</Title>
600<ObviousSentence>This section explains how to add metadata that uses values already present in the value tree.</ObviousSentence>
601 <Contents>
602 <ContentsGroup linkto="simple">
603 <ContentsItem>
604 Adding to files
605 </ContentsItem>
606 <ContentsItem>
607 Adding to folders or multiple files
608 </ContentsItem>
609 </ContentsGroup>
610 </Contents>
611 <Anchor name="simple">Simple Instructions:</Anchor>
612To add metadata that has an existing value, first select the file, then select
613the required value from the value tree, expanding hierarchy folders as
614necessary. The value of the selected entry automatically appears in the Value
615text field (alternatively, use the value tree's auto-select and auto-complete
616features). Click "Append" to add the metadata to the selected file.
617<Break/>
618The process of adding metadata with already-existing values to folders
619or multiple files is just the same.
620 </Section>
621 <Section name="updatingmetadata">
622 <Title>Updating Metadata</Title>
623<ObviousSentence>This section explains how to update the metadata assigned to a file.</ObviousSentence>
624 <Contents>
625 <ContentsGroup linkto="simple">
626 <ContentsItem>
627 Updating files
628 </ContentsItem>
629 <ContentsItem>
630 Updating folders or multiple files
631 </ContentsItem>
632 </ContentsGroup>
633 </Contents>
634 <Anchor name="simple">Simple Instructions:</Anchor>
635To update the value of a piece of metadata, first choose the file to which that
636value applies, and then the metadata element whose value you want to change.
637Your selection appears in the metadata edit controls. Edit the value field and
638click "Replace" to alter the metadata.
639<Break/>
640{5.5.multiple}
641<Break/>
642The value tree shows all previous values, not just those currently assigned.
643Thus the value you have replaced will remain in the value tree.
644 </Section>
645 <Section name="removingmetadata">
646 <Title>Removing Metadata</Title>
647<ObviousSentence>This section explains how to remove metadata from a file.</ObviousSentence>
648 <Contents>
649 <ContentsGroup linkto="simple">
650 <ContentsItem>
651 Removing from files
652 </ContentsItem>
653 <ContentsItem>
654 Removing from folders or multiple files
655 </ContentsItem>
656 </ContentsGroup>
657 </Contents>
658 <Anchor name="simple">Simple Instructions:</Anchor>
659You remove metadata the same way as you update it. First select a file from the
660file tree, then use the metadata table to select the metadata. {5.6.remove}
661Click it to remove the metadata from the specified file. Other files
662remain unchanged, and the value remains in the Value Tree.
663<Break/>
664{5.6.multiple}
665 </Section>
666 <Section name="reviewingmetadata">
667 <Title>Reviewing Assigned Metadata</Title>
668<ObviousSentence>This section describes how to view all metadata assigned to an entire collection.</ObviousSentence>
669 <Contents>
670 <ContentsGroup linkto="simple">
671 <ContentsItem>
672 The audit table
673 </ContentsItem>
674 </ContentsGroup>
675 <ContentsGroup linkto="advanced">
676 <ContentsItem>
677 Right button menu
678 </ContentsItem>
679 <ContentsItem>
680 Autofilter
681 </ContentsItem>
682 </ContentsGroup>
683 </Contents>
684 <Anchor name="simple">Simple Instructions:</Anchor>
685Sometimes you need to see the metadata assigned to many or all files at once -- for instance,
686to determine how many files are left to work on, or to get some idea of the
687spread of dates.
688<Break/>
689{5.7.activate} A window called
690"All Metadata", dominated by a large table with many columns, appears. The
691first column shows file names; the rows show all metadata values assigned to
692those files.
693<Break/>
694Drawing the table can take some time if many files are selected. You can continue to use the Librarian
695Interface while the "All Metadata" window is open.
696<Break/>
697Click "Close" to hide the window.
698 <Anchor name="advanced">Advanced Instructions:</Anchor>
699You can also view the "All Metadata" table by selecting the files you wish to
700examine, right-clicking, and choosing "Assigned Metadata...". If a folder has
701been selected, all its child files are included in the table.
702<Break/>
703When it gets too large, you can filter the "All Metadata" table by applying
704filters to the columns. As new filters are added, only those rows that match
705them remain visible. To set, modify or clear a filter, click on the "funnel"
706icon at the top of a column. You are prompted for information about the filter.
707Once a filter is set, the column header changes colour.
708<Break/>
709The prompt has a "Simple" and an "Advanced" tab. The Simple version filters
710columns so that they only show rows that contain a certain metadata value ("*"
711matches all values). You can select metadata values from the pull-down list.
712The Advanced version allows different matching operations: must start with,
713does not contain, alphabetically less than and is equal to. The value to be
714matched can be edited to be any string (including "*"), and you can choose
715whether the matching should be case insensitive. Finally, you can specify a
716second matching condition that you can use to specify a range of values (by
717selecting AND) or alternative values (by selecting OR). Below this area is a
718box that allows you to change the sort order (ascending or descending). Once
719you have finished, click "Set Filter" to apply the new filter to the column.
720Click "Clear Filter" to remove a current filter. Note that the filter details
721are retained even when the filter is cleared.
722<Break/>
723For example, to sort the "All Metadata" table, choose a column, select the
724default filter setting (a Simple filter on "*"), and choose ascending or
725descending ordering.
726 </Section>
727 <Section name="importingpreviouslyassignedmetadata">
728 <Title>Importing Previously Assigned Metadata</Title>
729{5.8.intro}
730 <Contents>
731 <ContentsGroup linkto="simple">
732 <ContentsItem>
733 While adding files
734 </ContentsItem>
735 </ContentsGroup>
736 </Contents>
737 <Anchor name="simple">Simple Instructions:</Anchor>
738If metadata in a form recognized by the Librarian Interface has been previously
739assigned to a file -- for example, when you choose documents from an existing
740Greenstone collection -- it is imported automatically when you add the file.
741To do this, the metadata must be mapped to the metadata sets available in the
742collection.
743<Break/>
744The Librarian Interface prompts for the necessary information. The prompt
745gives brief instructions and then shows the name of the metadata element that
746is being imported, just as it appears in the source file. This field cannot be
747edited or changed. Next you choose what metadata set the new element should map
748to, and then the appropriate metadata element in that set. The system
749automatically selects the closest match, in terms of set and element, for the
750new metadata.
751<Break/>
752Having checked the mapping, you can choose "Add" to add the new metadata
753element to the chosen metadata set. (This is only enabled if there is no
754element of the same name within the chosen set.) "Replace" maps the new element
755to the one chosen by the user. Finally, "Ignore" does not import any metadata
756with this element name. Once you have specified how to import a certain piece of metadata, the mapping
757information is retained for the collection's lifetime.
758<Break/>
759For details on the metadata.xml files which Greenstone uses to store the metadata, see Chapter 2 of the Greenstone
760Developer's Guide -- Getting the most out of your documents.
761 </Section>
762 </Section>
763
764 <Section name="designingacollection">
765 <Title>Designing Your Collection's Appearance</Title>
766Once your files are marked up with metadata, you next decide how it should
767appear to users as a Greenstone collection. What kind of information is
768searchable? What ways are provided to browse through the documents? What
769languages are supported? Where do the buttons appear on the page? These
770things can be customized; this section describes how to do it.
771 <Section name="thedesignview">
772 <Title>The Design View</Title>
773This section introduces you to the design view and explains how to navigate
774between the various views within this pane.
775 <Contents>
776 <ContentsGroup linkto="simple">
777 <ContentsItem>
778 Choosing a design section
779 </ContentsItem>
780 </ContentsGroup>
781 </Contents>
782 <Anchor name="simple">Simple Instructions:</Anchor>
783With the Librarian Interface, you can configure how the collection appears to
784the user. The configuration options are divided into different sections, each
785associated with a particular stage of navigating or presenting information.
786<Break/>
787On the left is a list of different views, and on the right are the controls
788associated with the current one. To change to a different view, click its name
789in the list.
790<Break/>
791To understand the stages and terms involved in designing a collection, first
792read Chapters 1 and 2 of the Greenstone Developer's Guide.
793 </Section>
794 <Section name="generalsettings">
795 <Title>General Settings</Title>
796This section explains how to review and alter the general settings associated
797with your collection. First, under "Design Sections", click "General".
798 <Contents>
799 <ContentsGroup linkto="simple">
800 <ContentsItem>
801 General settings
802 </ContentsItem>
803 </ContentsGroup>
804 </Contents>
805 <Anchor name="simple">Simple Instructions:</Anchor>
806Here the values provided during collection creation can be modified.
807<Break/>
808At the top of the page is an instruction box, which appears for each of the
809different sections. It contains a brief list of instructions to remind you
810what functionality is available.
811<Break/>
812First are the contact emails of the collection's creator and maintainer.
813The following field allows you to change the collection title. {6.2.collectionfolder}
814The next one specifies (in the form of a URL) the
815icon to show at the top left of the collection's "About" page, and the next is
816the icon used in the Greenstone library page to link to the collection. {6.2.publiccheckbox}
817Finally comes the "Collection Description" text area as described in <Reference target="creatingacollection">Creating A New Collection</Reference>.
818 </Section>
819 <Section name="plugins">
820 <Title>Document Plugins</Title>
821This section describes how to configure the document plugins the
822collection uses. It explains how you specify what
823plugins to use, what parameters to pass to them, and in what order
824they occur. Under "Design Sections", click "Document Plugins".
825 <Contents>
826 <ContentsGroup linkto="simple">
827 <ContentsItem>
828 Add a plugin
829 </ContentsItem>
830 <ContentsItem>
831 Remove a plugin
832 </ContentsItem>
833 <ContentsItem>
834 Configure a plugin
835 </ContentsItem>
836 <ContentsItem>
837 Change plugin order
838 </ContentsItem>
839 </ContentsGroup>
840 <ContentsGroup linkto="advanced">
841 <ContentsItem>
842 Custom configuration
843 </ContentsItem>
844 </ContentsGroup>
845 </Contents>
846 <Anchor name="simple">Simple Instructions:</Anchor>
847To add a plugin, select it using the "Select plugin to add" pull-down list near the
848bottom and then click "Add Plugin". A window appears entitled
849"Configuring Arguments"; it is described later. Once you have configured the
850new plugin, it is added to the end of the "Currently Assigned Plugins" list.
851{6.3.onceonly}
852<Break/>
853To remove a plugin, select it in the list and click "Remove Plugin".
854<Break/>
855Plugins are configured by providing arguments. To alter them, select the
856plugin from the list and click "Configure Plugin" (or double-click
857the plugin). {6.3.dialog}
858<Break/>
859There are different kinds of controls. Some are checkboxes, and clicking one
860adds the appropriate option to the plugin. Others are text strings, with a
861checkbox and a text field. Click the box to enable the argument, then type
862appropriate text (regular expression, file path etc) in the box. Others are
863pull-down menus from which you can select from a given set of values. To learn what an
864argument does, let the mouse hover over its name for a moment and a description
865will appear.
866<Break/>
867When you have changed the configuration, click "OK" to commit the changes and
868close the dialog, or "Cancel" to close the dialog without changing any plugin
869arguments.
870<Break/>
871The plugins in the list are executed in order, and the ordering is sometimes
872important. Two plugins, ArcPlug and RecPlug, are vital to the collection
873building process, and are fixed in place at the end of the list (with a
874separator line). To change the ordering of the other ones, select the plugin you want to move
875and click "Move Up" or "Move Down".
876 <Anchor name="advanced">Advanced Instructions:</Anchor>
877The Librarian Interface does its best to determine what arguments a plugin
878supports. {6.3.customargs} Any text in it is appended verbatim to the end of the plugin
879command.
880 </Section>
881 <Section name="searchtypes">
882 <Title>Search Types</Title>
883This section explains how to modify a new design feature in Greenstone, Search Types, which allow fielded searching. Under "Design Sections", click "Search Types".
884 <Contents>
885 <ContentsGroup linkto="simple">
886 <ContentsItem>
887 What enabling advanced searches means
888 </ContentsItem>
889 <ContentsItem>
890 Adding a new search type
891 </ContentsItem>
892 <ContentsItem>
893 Removing a search type
894 </ContentsItem>
895 <ContentsItem>
896 Changing the order of search types
897 </ContentsItem>
898 </ContentsGroup>
899 </Contents>
900 <Anchor name="simple">Simple Instructions:</Anchor>
901When you enter the Search Types view, first check "Enable Advanced
902Searches", which activates the other controls. This migrates the collection to
903Greenstone 2.4 format, which supports fielded searching, and means that (a)
904the index design is different (explained in the <Reference target="searchindexes">Search Indexes</Reference> section),
905(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
906installations. If you later uncheck this field, most of your collection will
907be migrated back to Greenstone 2.39. However the Librarian Interface cannot
908convert the new index specifications into older ones, so you will have to
909re-enter them manually.
910<Break/>
911To 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.
912<Break/>
913To remove a search type, select it from the "Currently Assigned Search Types"
914list and click "Remove Search Type". The list must contain at least
915one search type.
916<Break/>
917To change to order of a search type, select it from the list and click "Move
918Up" or "Move Down". The first one will be the default.
919 </Section>
920 <Section name="searchindexes">
921 <Title>Search Indexes</Title>
922Indexes 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".
923 <Contents>
924 <ContentsGroup linkto="simple">
925 <ContentsItem>
926 Add an index
927 </ContentsItem>
928 <ContentsItem>
929 {6.5.replace.short}
930 </ContentsItem>
931 <ContentsItem>
932 Remove an index
933 </ContentsItem>
934 <ContentsItem>
935 Set default index
936 </ContentsItem>
937 </ContentsGroup>
938 </Contents>
939 <Anchor name="simple">Simple Instructions:</Anchor>
940To add an index, type a name for it into the "Index Name" field. Select which
941of the possible information sources to index by clicking the checkboxes beside
942them. The list shows all the assigned metadata elements, as well the full
943text. Having selected the data sources, choose the granularity of the index,
944using the "At the level" menu. Once these details are complete, "Add Index"
945becomes active (unless there is an existing index with the same settings).
946Click it to add the new index.
947<Break/>
948{6.5.replace}
949<Break/>
950To remove an index, select it from the list of assigned indexes and click
951"Remove Index".
952<Break/>
953The default index, the one used on the collection's search page, is tagged with
954"[Default Index]" in the "Assigned Indexes" list. To set it, select an index
955from the list and click "Set Default".
956<Break/>
957If advanced searching is enabled (via the Search Types view), the index controls are different. Each index
958is 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
959assigned to a specific index, but apply across all indexes: thus indexes and
960levels are added separately. Indexes are removed in the same way as above, but
961the default index can no longer be set -- it is simply the
962first index assigned.
963<Break/>
964To 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".
965 </Section>
966 <Section name="partitionindexes">
967 <Title>Partition Indexes</Title>
968Indexes are built on particular text or metadata sources. The search space can
969be further controlled by partitioning the index, either by language or by a
970predetermined filter. This section describes how to do this. Under "Design
971Sections", click "Partition Indexes".
972<Break/>
973The "Partition Indexes" view has three tabs; "Define Filters", "Assign
974Partitions" and "Assign Languages". To learn more about partitions read about
975subcollections and subindexes in Chapter 2 of the Greenstone Developer's Guide.
976
977 <Section name="definefilters">
978 <Title>Define Filters</Title>
979<ObviousSentence>The section explains how to define a partition filter.</ObviousSentence>
980 <Contents>
981 <ContentsGroup linkto="simple">
982 <ContentsItem>
983 Add a filter
984 </ContentsItem>
985 <ContentsItem>
986 Remove a filter
987 </ContentsItem>
988 <ContentsItem>
989 Update a filter
990 </ContentsItem>
991 </ContentsGroup>
992 </Contents>
993 <Anchor name="simple">Simple Instructions:</Anchor>
994Filters allows you to group together into a subcollection all documents in an
995index for which a metadata value matches a given pattern.
996<Break/>
997To create a filter, click the "Define Filters" tab and enter a name for the
998new filter into the "Name the subcollection filter" field. Next choose a
999document attribute to match against, either a metadata element or the name of
1000the file in question. Enter a regular expression to use during the matching.
1001You can toggle between "Including" documents that match the filter, or
1002"Excluding" them. Finally, you can specify any of the standard PERL regular
1003expression flags to use when matching (e.g. "i" for case-insensitive matching).
1004Finally, click "Add Filter" to add the filter to the "Defined Subcollection Filters"
1005list.
1006<Break/>
1007To remove a filter, select it from the list and click "Remove Filter".
1008<Break/>
1009To alter a filter, select it from the list, change any of the values that
1010appear in the editing controls and click "Replace Filter" to commit the changes.
1011 </Section>
1012 <Section name="assignpartitions">
1013 <Title>Assign Partitions</Title>
1014<ObviousSentence>This section explains how to assign a previous defined partition filter.</ObviousSentence>
1015 <Contents>
1016 <ContentsGroup linkto="simple">
1017 <ContentsItem>
1018 Add a partition
1019 </ContentsItem>
1020 <ContentsItem>
1021 Remove a partition
1022 </ContentsItem>
1023 <ContentsItem>
1024 Set default partition
1025 </ContentsItem>
1026 <ContentsItem>
1027 Clear default partition
1028 </ContentsItem>
1029 </ContentsGroup>
1030 </Contents>
1031 <Anchor name="simple">Simple Instructions:</Anchor>
1032Having defined a subcollection filter, use the "Assign Partitions" tab to build
1033indexes for it (or for a group of filters). Select the desired filter (or
1034filters) from the "Defined Subcollection Filters" list, enter a name for your partition in the "Partition Name" field, and click "Add Partition".
1035<Break/>
1036To remove a partition, select it from the list and click "Remove Partition".
1037<Break/>
1038To make a partition the default one, select it from the list and click "Set
1039Default".
1040<Break/>
1041To clear the default partition, click "Clear Default".
1042 </Section>
1043 <Section name="assignlanguages">
1044 <Title>Assign Languages</Title>
1045This section details how to restrict search indexes to particular languages.
1046You do this by generating a partition using the "Assign Languages" tab of the
1047"Partition Indexes" view.
1048 <Contents>
1049 <ContentsGroup linkto="simple">
1050 <ContentsItem>
1051 Language controls
1052 </ContentsItem>
1053 <ContentsItem>
1054 Add language
1055 </ContentsItem>
1056 <ContentsItem>
1057 Remove language
1058 </ContentsItem>
1059 <ContentsItem>
1060 Set default language
1061 </ContentsItem>
1062 <ContentsItem>
1063 Clear default language
1064 </ContentsItem>
1065 </ContentsGroup>
1066 </Contents>
1067 <Anchor name="simple">Simple Instructions:</Anchor>
1068To add a new language to partition by, use the "Assign Languages" tab to build
1069an index for it. Select the desired language from the "Language to add"
1070pull-down list and click "Add Language".
1071<Break/>
1072To remove a language, select it from the "Language Selection" list and click
1073"Remove Language".
1074<Break/>
1075To set the default language, select it from the list and click "Set Default".
1076<Break/>
1077To clear the default language, click "Clear Default".
1078 </Section>
1079 </Section>
1080 <Section name="xcollectionsearching">
1081 <Title>Cross-Collection Searching</Title>
1082Greenstone can search across several different collections as though they were
1083one. This is done by creating a "super-collection" that comprises the
1084individual collections. Under "Design Sections", click "Cross-Collection Search".
1085 <Contents>
1086 <ContentsGroup linkto="simple">
1087 <ContentsItem>
1088 Selecting a collection
1089 </ContentsItem>
1090 </ContentsGroup>
1091 </Contents>
1092 <Anchor name="simple">Simple Instructions:</Anchor>
1093The Cross-Collection Search view shows a checklist of available collections. The
1094current collection is ticked and cannot be deselected. To add another
1095collection to be searched in parallel, click it in the list (click again to
1096remove it). If only one collection is selected, there is no cross-collection
1097searching.
1098<Break/>
1099For further details, see Chapter 1 of the Greenstone Developer's Guide.
1100 </Section>
1101 <Section name="classifiers">
1102 <Title>Classifiers</Title>
1103This section explains how to assign "classifiers", which are used for browsing,
1104to the collection. Under "Design Sections", click "Browsing Classifiers".
1105 <Contents>
1106 <ContentsGroup linkto="simple">
1107 <ContentsItem>
1108 Classifier selection and configuration
1109 </ContentsItem>
1110 <ContentsItem>
1111 Add a classifier
1112 </ContentsItem>
1113 <ContentsItem>
1114 Remove a classifier
1115 </ContentsItem>
1116 <ContentsItem>
1117 Configure a classifier
1118 </ContentsItem>
1119 <ContentsItem>
1120 Alter classifier ordering
1121 </ContentsItem>
1122 </ContentsGroup>
1123 </Contents>
1124 <Anchor name="simple">Simple Instructions:</Anchor>
1125To add a classifier, select it using the "Select classifier to add" pull-down list near the
1126bottom and then click "Add Specified Classifier". A window appears entitled
1127"Configuring Arguments"; instructions for this dialog are just the same as for
1128plugins (see <Reference target="plugins">Document Plugins</Reference>). Once you have configured the new
1129classifier, it is added to the end of the "Currently Assigned Classifiers"
1130list.
1131<Break/>
1132To remove a classifier, select it from the list and click "Remove Selected
1133Classifier".
1134<Break/>
1135To change the arguments a classifier, select it from the list and click
1136"Configure Selected Classifier" (or double-click on the classifier in the
1137list).
1138<Break/>
1139The ordering of classifiers in the collection's navigation bar is reflected in
1140their order here. To change it, select the classifier you want to move and
1141click "Move Up" or "Move Down".
1142<Break/>
1143For further information on classifiers read Chapter 2, Greenstone
1144Developer's Guide -- Getting the most out of your documents.
1145 </Section>
1146 <Section name="formatstatements">
1147 <Title>Format Features</Title>
1148Format commands control the structure and appearance of the collection. They
1149affect such things as where buttons appear when a document is shown, and what
1150links are displayed by the DateList classifier. Format commands are not easy
1151to develop, and you should read Chapter 2 of the Greenstone Developer's Guide.
1152This section discusses the format settings, and how the Librarian Interface
1153gives access to them. Under "Design Sections", click "Format Features".
1154 <Contents>
1155 <ContentsGroup linkto="simple">
1156 <ContentsItem>
1157 Formatting
1158 </ContentsItem>
1159 <ContentsItem>
1160 Add format command
1161 </ContentsItem>
1162 <ContentsItem>
1163 Remove format command
1164 </ContentsItem>
1165 <ContentsItem>
1166 Update format command
1167 </ContentsItem>
1168 </ContentsGroup>
1169 <ContentsGroup linkto="advanced">
1170 <ContentsItem>
1171 Extended formatting options
1172 </ContentsItem>
1173 </ContentsGroup>
1174 </Contents>
1175 <Anchor name="simple">Simple Instructions:</Anchor>
1176You can apply a format command to anything in the "Choose Feature" pull-down
1177list, which includes each classifier and a predefined list of features. When
1178you select a feature, there are two types of control. Some features are simply
1179enabled or disabled, and this is controlled by a checkbox. Others require a
1180format string to be specified. For these there is a pull-down list ("Affected
1181Component") for selecting which part of the feature the string applies to
1182(if necessary), a text area ("HTML Format String") for entering the string,
1183and a selection of predefined "Variables". To insert a variable into the
1184current position in the format string, select it from the pull-down list and
1185click "Insert".
1186<Break/>
1187You can specify a default format for a particular component by selecting the
1188blank feature. This format is then applied to all applicable features unless
1189otherwise specified.
1190<Break/>
1191To add a new format command, fill out the information as explained above and
1192click "Add Format". The new format command appears in the list of "Currently
1193Assigned Format Commands". Only one format command can be assigned to each
1194feature/component combination.
1195<Break/>
1196To remove a format command, select it from the list and click "Remove Format".
1197<Break/>
1198To change a format command, select it from the list, modify the settings, and
1199click "Replace Format".
1200<Break/>
1201For more information about variables and the feature components, read Chapter 2
1202of the Greenstone Developer's Guide.
1203 <Anchor name="advanced">Advanced Instructions:</Anchor>
1204If 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.
1205 </Section>
1206 <Section name="translatetext">
1207 <Title>Translate Text</Title>
1208This section describes the translation view, where you can define
1209language-specific text fragments for parts of the collection's interface.
1210Under "Design Sections", click "Translate Text".
1211 <Contents>
1212 <ContentsGroup linkto="simple">
1213 <ContentsItem>
1214 Add translation
1215 </ContentsItem>
1216 <ContentsItem>
1217 Remove translation
1218 </ContentsItem>
1219 <ContentsItem>
1220 Update translation
1221 </ContentsItem>
1222 </ContentsGroup>
1223 </Contents>
1224 <Anchor name="simple">Simple Instructions:</Anchor>
1225First choose the an entry from the "Features" list. The language-specific
1226strings associated with this feature appear below. Use the "Language of
1227translation" pull-down list to select the target language, and type the
1228translated text into the text area, referring to the "Initial Text Fragment" if
1229necessary. Click "Add Translation" when finished.
1230<Break/>
1231To remove an existing translation, select it in the "Assigned Translations"
1232table and click "Remove Translation".
1233<Break/>
1234To edit a translation, select it, edit it in the "Translated Text" text
1235area, and click "Replace Translation".
1236 </Section>
1237 <Section name="metadatasets">
1238 <Title>Metadata Sets</Title>
1239This section explains the metadata set review panel.
1240Under "Design Sections", click "Metadata Sets".
1241 <Contents>
1242 <ContentsGroup linkto="simple">
1243 <ContentsItem>
1244 Available metadata sets
1245 </ContentsItem>
1246 <ContentsItem>
1247 {6.11.contents.1}
1248 </ContentsItem>
1249 <ContentsItem>
1250 {6.11.contents.2}
1251 </ContentsItem>
1252 <ContentsItem>
1253 {6.11.contents.3}
1254 </ContentsItem>
1255 </ContentsGroup>
1256 </Contents>
1257 <Anchor name="simple">Simple Instructions:</Anchor>
1258This view is used to review the metadata sets that the collection uses, and the
1259elements that are available within each set. Choose from the list of "Available
1260Metadata Sets" in order to see details of their elements.
1261<Break/>
1262{6.11.adding}
1263<Break/>
1264{6.11.editing}
1265<Break/>
1266{6.11.removing}
1267 </Section>
1268 </Section>
1269
1270 <Section name="producingthecollection">
1271 <Title>Producing Your Collection</Title>
1272Having collected the documents for the collection, annotated them with
1273metadata, and designed how the collection will appear, you can now produce the
1274collection using Greenstone. This section explains how.
1275 <Section name="thecreateview">
1276 <Title>The Create View</Title>
1277<ObviousSentence>This section explains the Create view used to produce a collection.</ObviousSentence>
1278 <Contents>
1279 <ContentsGroup linkto="simple">
1280 <ContentsItem>
1281 Building the collection
1282 </ContentsItem>
1283 <ContentsItem>
1284 Previewing the collection
1285 </ContentsItem>
1286 </ContentsGroup>
1287 <ContentsGroup linkto="advanced">
1288 <ContentsItem>
1289 Message log
1290 </ContentsItem>
1291 </ContentsGroup>
1292 </Contents>
1293 <Anchor name="simple">Simple Instructions:</Anchor>
1294The Create view is used to create the collection by running Greenstone
1295collection-building scripts on the information you have provided.
1296Clicking "Build Collection" initiates the collection building process. The time
1297this takes depends on the size of the collection and the number of indexes
1298being created (for huge collections it can be hours). {7.1.progressbar} To cancel the process at
1299any time, click "Cancel Build".
1300<Break/>
1301<!-- added -->
1302Once the collection has successfully built, clicking "Preview Collection" will launch a web browser showing the home page of the collection.
1303 <Anchor name="advanced">Advanced Instructions:</Anchor>
1304{7.1.messagelog} Select the log you want by clicking on the desired date in the "Log History" list.
1305 </Section>
1306 <Section name="buildsettings">
1307 <Title>Import and Build Settings</Title>
1308This section explains how to access the various import and build settings.
1309For more information of importing and building read Chapter 1 of the Greenstone
1310Developer's Guide -- Understanding the collection-building process.
1311 <Contents>
1312 <ContentsGroup linkto="simple">
1313 <ContentsItem>
1314 General settings
1315 </ContentsItem>
1316 <ContentsItem>
1317 Import settings
1318 </ContentsItem>
1319 <ContentsItem>
1320 Build settings
1321 </ContentsItem>
1322 </ContentsGroup>
1323 </Contents>
1324 <Anchor name="simple">Simple Instructions:</Anchor>
1325Controlling the various settings is done in a similar way to the
1326"Configuring Arguments" window described in the <Reference target="plugins">Document Plugins</Reference> section. Some
1327fields require numeric arguments, and you can either type these in or use the
1328up and down arrows to increase or decrease the current value (in some cases,
1329the interface restricts the range you can enter). Others are enabled by
1330clicking a checkbox (click again to disable).
1331 </Section>
1332 </Section>
1333
1334 <Section name="miscellaneous">
1335 <Title>Miscellaneous</Title>
1336This section describes features of the Librarian Interface that are not associated
1337with any particular view.
1338 <Section name="preferences">
1339 <Title>Preferences</Title>
1340This section explains the preferences dialog, accessed by opening "File" -> "Preferences".
1341 <Contents>
1342 <ContentsGroup linkto="simple">
1343 <ContentsItem>
1344 General
1345 </ContentsItem>
1346 <ContentsItem>
1347 Mode
1348 </ContentsItem>
1349 <ContentsItem>
1350 Workflow
1351 </ContentsItem>
1352 <ContentsItem>
1353 Connection
1354 </ContentsItem>
1355 <ContentsItem>
1356 Warnings
1357 </ContentsItem>
1358 </ContentsGroup>
1359 </Contents>
1360 <Anchor name="simple">Simple Instructions:</Anchor>
1361{8.1.usersemail} {8.1.languages} If you change the dictionary by choosing one from the list, you must
1362restart the Librarian Interface in order to load the new language strings from
1363the dictionary.
1364<Break/>
1365If "View Extracted Metadata" is checked, the
1366various controls dealing with metadata always show all metadata that has been
1367extracted automatically from documents. Deselecting it hides this metadata
1368(although it is still available during collection design, and within the
1369final 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.
1370<Break/>
1371The "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.
1372<Break/>
1373The Librarian Interface can support different workflows by determining which of
1374the various view tabs are visible. Use the "Workflow" tab to customise what
1375views are available by checking the boxes next to the views that you want to be
1376available. Alternatively, use the pull-down list at the bottom to select
1377predetermined configurations. Closing the preferences dialog establishes these
1378workflow settings. These settings are stored with the collection, not in the
1379Librarian Interface configuration file.
1380<Break/>
1381The "Connection" tab lets you alter the path to the locally-running Greenstone library server, which is used when Previewing collections. {8.1.proxies}
1382<Break/>
1383During the course of a session the Librarian Interface may give warning
1384messages which inform you of possibly unforeseen consequences of an action. You
1385can disable the messages by checking the "Do not show this warning again" box.
1386You can re-enable warning messages using the "Warnings" tab. Check the box
1387next to warning messages you want to see again.
1388 </Section>
1389 <Section name="fileassociations">
1390 <Title>File Associations</Title>
1391The Librarian Interface uses particular application programs to open particular
1392file types. This section explains how to assign and edit these file
1393associations.
1394 <Contents>
1395 <ContentsGroup linkto="simple">
1396 <ContentsItem>
1397 Add association
1398 </ContentsItem>
1399 <ContentsItem>
1400 Edit association
1401 </ContentsItem>
1402 <ContentsItem>
1403 Remove association
1404 </ContentsItem>
1405 </ContentsGroup>
1406 </Contents>
1407 <Anchor name="simple">Simple Instructions:</Anchor>
1408To alter file associations open the "File" menu and click "File
1409Associations...".
1410<Break/>
1411To add an association, select the target file extension from the pull-down
1412list, or type in a new extension (do not include the "."). Next either type
1413command that launches the desired application in the appropriate field, or
1414choose the application from the "Browse" dialog. "%1" can be used in the launch
1415command to insert the name of the file being opened. Once these are filled out,
1416"Add Association" is enabled and can be clicked to add the association.
1417<Break/>
1418To edit an association, select an existing file extension. Any existing
1419associated command is shown in the launch command field. Edit it, and then
1420click "Replace Association".
1421<Break/>
1422To remove an association, select an existing file extension and click "Remove Association".
1423(The file extension remains in the "For Files Ending" pull-down list.)
1424<Break/>
1425File associations are stored in the Librarian Interface's main folder, in a file
1426called "associations.xml".
1427 </Section>
1428 <Section name="exportingcollections">
1429 <Title>Exporting Collections to CD-ROM</Title>
1430
1431This section describes how to export collections to a self-installing
1432Greenstone CD-ROM.
1433 <Contents>
1434 <ContentsGroup linkto="simple">
1435 <ContentsItem>
1436 How to export
1437 </ContentsItem>
1438 </ContentsGroup>
1439 </Contents>
1440 <Anchor name="simple">Simple Instructions:</Anchor>
1441Greenstone can export one or more collections to a self-installing
1442CD-ROM for Windows. To do so, Greenstone's "Export to CD-ROM" package
1443must be installed. This is not included by default, so you may need to
1444modify your installation to include it.
1445<Break/>
1446To export a collection, open the "File" menu and choose "Export to
1447CD-ROM". A list of Greenstone collections appears; click on any one to
1448see its description. Tick the check boxes of the collections to export.
1449You can enter the CD-ROM's name in the box: this is what will appear in
1450the Start menu when the CD-ROM has been installed. Then click "Export".
1451The process involves copying many files and may take a few minutes.
1452<Break/>
1453Upon completion, Greenstone will show the name of a folder containing
1454the exported collections. Use a CD writer to copy its contents to a
1455blank CD-ROM.
1456 </Section>
1457 </Section>
1458</Document>
Note: See TracBrowser for help on using the repository browser.