- Timestamp:
- 2007-02-07T13:54:54+13:00 (17 years ago)
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
trunk/gsdl-documentation/manuals/xml-source/en/User_en.xml
r13781 r13869 1 1 <?xml version="1.0" encoding="UTF-8"?> 2 3 <!DOCTYPE Manual [ 4 <!ENTITY chap_gli SYSTEM "help-en.xml"> 5 ]> 6 2 7 <Manual id="User" lang="en"> 3 8 <Heading> … … 150 155 <Text id="51">Experiment! Choose common words like âtheâ and âandâ to search forâthat should evoke some responses, and nothing will break.</Text> 151 156 <Text id="52">Greenstone digital library systems usually comprise several separate collectionsâfor example, computer science technical reports, literary works, internet FAQs, magazines. There will be a home page for the digital library system which allows you to access any publicly-accessible collection; in addition, each collection has its own âaboutâ page that gives you information about how the collection is organized and the principles governing what is included in it. To get back to the âaboutâ page at any time, just click on the âcollectionâ icon that appears at the top left side of all searching and browsing pages.</Text> 152 <Text id="53">Figure 1 shows a screenshot of the âDemoâ collection supplied with the Greenstone software, which is a very small subset of the Development Library collection; we will use it as an example to describe the different ways of finding information. (If you can't find the Demo collection, use the Development Library instead; it looks just the same.) First, almost all icons are clickable. Several icons appear at the top of almost every page; Table 1shows you what they mean.</Text>157 <Text id="53">Figure <CrossRef target="Figure" ref="using_the_demo_collection"/> shows a screenshot of the âDemoâ collection supplied with the Greenstone software, which is a very small subset of the Development Library collection; we will use it as an example to describe the different ways of finding information. (If you can't find the Demo collection, use the Development Library instead; it looks just the same.) First, almost all icons are clickable. Several icons appear at the top of almost every page; Table <CrossRef target="Table" ref="what_the_icons_at_the_top_of_each_page_mean"/> shows you what they mean.</Text> 153 158 <Figure id="using_the_demo_collection"> 154 159 <Title> … … 202 207 </Title> 203 208 <Content> 204 <Text id="62">Table 2shows the five ways to find information in the Demo collection.</Text>209 <Text id="62">Table <CrossRef target="Table" ref="table_icons_on_the_search_browse_bar"/> shows the five ways to find information in the Demo collection.</Text> 205 210 <Table id="table_icons_on_the_search_browse_bar"> 206 211 <Title> … … 250 255 </TableContent> 251 256 </Table> 252 <Text id="69">You can <i>search for particular words</i> that appear in the text from the âsearchâ page. (This is just like the âaboutâ page shown in Figure 1, except that it doesn't contain the <i>about this collection</i> text.) The search page can be reached from other pages by pressing the <i>search</i> button. You can <i>access publications by subject</i> by pressing the <i>subjects</i> button. This brings up a list of subjects, represented by bookshelves that can be further expanded by clicking on them. You can <i>access publications by title</i> by pressing the <i>titles a-z</i> button. This brings up a list of books in alphabetic order. You can <i>access publications by organization</i> by pressing the <i>organization</i> button. This brings up a list of organizations. You can <i>access publications by how to listing</i> by pressing the <i>how to</i> button. This brings up a list of âhow toâ hints. All these buttons are visible in Figure 1.</Text>257 <Text id="69">You can <i>search for particular words</i> that appear in the text from the âsearchâ page. (This is just like the âaboutâ page shown in Figure <CrossRef target="Figure" ref="using_the_demo_collection"/>, except that it doesn't contain the <i>about this collection</i> text.) The search page can be reached from other pages by pressing the <i>search</i> button. You can <i>access publications by subject</i> by pressing the <i>subjects</i> button. This brings up a list of subjects, represented by bookshelves that can be further expanded by clicking on them. You can <i>access publications by title</i> by pressing the <i>titles a-z</i> button. This brings up a list of books in alphabetic order. You can <i>access publications by organization</i> by pressing the <i>organization</i> button. This brings up a list of organizations. You can <i>access publications by how to listing</i> by pressing the <i>how to</i> button. This brings up a list of âhow toâ hints. All these buttons are visible in Figure <CrossRef target="Figure" ref="using_the_demo_collection"/>.</Text> 253 258 </Content> 254 259 </Subsection> … … 258 263 </Title> 259 264 <Content> 260 <Text id="71">In the Demo collection, you can tell when you have arrived at an individual book because there is a photograph of its front cover (Figure 2). Beside the photograph is a table of contents: the entry in bold face marks where you are, in this case <i>Introduction and Summary</i> âSection 1 of the chosen book. This table is expandable: click on the folders to open them or close them. Click on the open book at the top to close it.</Text>265 <Text id="71">In the Demo collection, you can tell when you have arrived at an individual book because there is a photograph of its front cover (Figure <CrossRef target="Figure" ref="a_book_in_the_demo_collection"/>). Beside the photograph is a table of contents: the entry in bold face marks where you are, in this case <i>Introduction and Summary</i> âSection 1 of the chosen book. This table is expandable: click on the folders to open them or close them. Click on the open book at the top to close it.</Text> 261 266 <Text id="72">Underneath is the text of the current section (âThe international demand for tropical butterflies âŠâ in the example, beginning at the very bottom of the illustration). When you have read through it, there are arrows at the end to take you on to the next section or back to the previous one.</Text> 262 267 <Text id="73">Below the photograph are four buttons. Click on <i>detach</i> to make a new browser window for this book. (This is useful if you want to compare books, or read two at once.) If you have reached this book through a search, the search terms will be highlighted: the <i>no highlighting</i> button turns this off. Click on <i>expand text</i> to expand out the whole text of the current section, or book. Click on <i>expand contents</i> to expand out the whole table of contents so that you can see the titles of all chapters and subsections.</Text> … … 275 280 </Title> 276 281 <Content> 277 <Text id="77">When you are browsing around the collection, you will encounter the items shown in Table 3.</Text>282 <Text id="77">When you are browsing around the collection, you will encounter the items shown in Table <CrossRef target="Table" ref="table_icons_that_you_will_encounter_when_browsing"/>.</Text> 278 283 </Content> 279 284 </Subsection> … … 354 359 <tr> 355 360 <th width="123"> 356 <File width="32" height="17" url="images/User_Icon_16. png"/>361 <File width="32" height="17" url="images/User_Icon_16.gif"/> 357 362 </th> 358 363 <th width="407"> … … 362 367 <tr> 363 368 <th width="123"> 364 <File width="32" height="17" url="images/User_Icon_17. png"/>369 <File width="32" height="17" url="images/User_Icon_17.gif"/> 365 370 </th> 366 371 <th width="407"> … … 523 528 <File width="394" height="439" url="images/User_Fig_3.png"/> 524 529 </Figure> 525 <Text id="143">When you click the <i>preferences</i> button at the top of the page you will be able to change some features of the interface to suit your own requirements. The preferences depend on the collection; an example is shown in Figure 3. When you adjust your search preferences, you should press the <i>set preferences</i> button shown in Figure 3. After setting preferences, do not use your browser's âbackâ buttonâthat would unset them! Instead, click one of the buttons on the access bar near the top of the page.</Text>530 <Text id="143">When you click the <i>preferences</i> button at the top of the page you will be able to change some features of the interface to suit your own requirements. The preferences depend on the collection; an example is shown in Figure <CrossRef target="Figure" ref="the_preferences_page"/>. When you adjust your search preferences, you should press the <i>set preferences</i> button shown in Figure <CrossRef target="Figure" ref="the_preferences_page"/>. After setting preferences, do not use your browser's âbackâ buttonâthat would unset them! Instead, click one of the buttons on the access bar near the top of the page.</Text> 526 531 <Subsection id="collection_preferences"> 527 532 <Title> … … 553 558 </Title> 554 559 <Content> 555 <Text id="151">Under <i>Search preferences</i> in Figure 3, the first pair of buttons allows you to get a large query box, so that you can easily do paragraph-sized searching. In Greenstone, it is surprisingly quick to search for large amounts of text. The next two pairs of buttons control the kind of text matching in the searches that you make. The first set (labeled âcase differencesâ) controls whether upper and lower case must match. The second (âword endingsâ) controls whether to ignore word endings or not.</Text>556 <Text id="152">Using the next button pair you can switch to the âadvancedâ query mode described above, which allows you to specify more precise queries by combining terms using AND (&), OR (|), and NOT (!). You can turn the search history feature, described above, on and off. Finally, you can control the number of hits returned, and the number presented on each screenful, through the last entry in Figure 3.</Text>560 <Text id="151">Under <i>Search preferences</i> in Figure <CrossRef target="Figure" ref="the_preferences_page"/>, the first pair of buttons allows you to get a large query box, so that you can easily do paragraph-sized searching. In Greenstone, it is surprisingly quick to search for large amounts of text. The next two pairs of buttons control the kind of text matching in the searches that you make. The first set (labeled âcase differencesâ) controls whether upper and lower case must match. The second (âword endingsâ) controls whether to ignore word endings or not.</Text> 561 <Text id="152">Using the next button pair you can switch to the âadvancedâ query mode described above, which allows you to specify more precise queries by combining terms using AND (&), OR (|), and NOT (!). You can turn the search history feature, described above, on and off. Finally, you can control the number of hits returned, and the number presented on each screenful, through the last entry in Figure <CrossRef target="Figure" ref="the_preferences_page"/>.</Text> 557 562 </Content> 558 563 </Subsection> … … 592 597 </Title> 593 598 <Content> 594 <Text id="164">To convey the operation of Greenstone's librarian interface, we work through a simple example. Figures 4 to 15are screen snapshots at various points during the interaction. This example uses documents in the Development Library Subset (DLS) collection, which is distributed with Greenstone. For expository purposes, the walkthrough takes the form of a single pass through the steps listed above. A more realistic pattern of use, however, is for users to switch back and forth through the various stages as the task proceeds.</Text>599 <Text id="164">To convey the operation of Greenstone's librarian interface, we work through a simple example. Figures <CrossRef target="Figure" ref="starting_a_new_collection"/> to <CrossRef target="Figure" ref="previewing_the_newly_built_collection"/> are screen snapshots at various points during the interaction. This example uses documents in the Development Library Subset (DLS) collection, which is distributed with Greenstone. For expository purposes, the walkthrough takes the form of a single pass through the steps listed above. A more realistic pattern of use, however, is for users to switch back and forth through the various stages as the task proceeds.</Text> 595 600 <Text id="165">The librarian interface can be run in one of four modes: Librarian Assistant, Librarian, Library Systems Specialist, and Expert. Modes control the level of detail within the interface, and can be changed through 'Preferences' in the 'File' menu. The walkthrough in this section assumes that the librarian interface is operating in the default mode, Librarian.</Text> 596 601 <Subsection id="getting_started"> … … 603 608 <CodeLine>cd gli</CodeLine> 604 609 <CodeLine>./gli.sh</CodeLine> 605 <Text id="168">where <i>~/gsdl</i> is the directory containing your Greenstone system. To begin, you must either open an existing collection or start a new one. Figure 4shows the user in the process of starting a new collection. She has selected <i>New</i> from the file menu and begun to fill out general information about the collectionâits title, the E-mail address of the person responsible for it, and a brief description of the contentâin the popup window. The collection title is a short phrase used throughout the digital library to identify the collection's content: existing collections have names like <i>Food and Nutrition Library</i>, <i>World Environmental Library</i>, and so on. When you type the title, the system assigns a unique mnemonic identifier, the collection ânameâ, for internal use (you can change it if you like). The E-mail address specifies the first point of contact for any problems encountered with the collection.</Text>610 <Text id="168">where <i>~/gsdl</i> is the directory containing your Greenstone system. To begin, you must either open an existing collection or start a new one. Figure <CrossRef target="Figure" ref="starting_a_new_collection"/> shows the user in the process of starting a new collection. She has selected <i>New</i> from the file menu and begun to fill out general information about the collectionâits title, the E-mail address of the person responsible for it, and a brief description of the contentâin the popup window. The collection title is a short phrase used throughout the digital library to identify the collection's content: existing collections have names like <i>Food and Nutrition Library</i>, <i>World Environmental Library</i>, and so on. When you type the title, the system assigns a unique mnemonic identifier, the collection ânameâ, for internal use (you can change it if you like). The E-mail address specifies the first point of contact for any problems encountered with the collection.</Text> 606 611 <Text id="169">The brief description is a statement describing the principles that govern what is included in the collection. It appears under the heading <i>About this collection</i> on the collection's initial page.</Text> 607 612 <Figure id="starting_a_new_collection"> … … 617 622 <File width="407" height="318" url="images/User_Fig_5.png"/> 618 623 </Figure> 619 <Text id="172">At this point, the user decides whether to base the new collection on the same structure as an existing collection, or to build an entirely new kind of collection. In Figure 4she has chosen to base it on the <i>Development Library Subset</i> collection. This implies that the âDLSâ metadata set which is used in this collection will be used for the new collection. (In fact, this metadata set has been used to build several Greenstone collections that share a common structure and organization but with different content, including the <i>Development Library Subset</i> and <i>Demo</i> collections delivered as samples with Greenstone.)</Text>624 <Text id="172">At this point, the user decides whether to base the new collection on the same structure as an existing collection, or to build an entirely new kind of collection. In Figure <CrossRef target="Figure" ref="starting_a_new_collection"/> she has chosen to base it on the <i>Development Library Subset</i> collection. This implies that the âDLSâ metadata set which is used in this collection will be used for the new collection. (In fact, this metadata set has been used to build several Greenstone collections that share a common structure and organization but with different content, including the <i>Development Library Subset</i> and <i>Demo</i> collections delivered as samples with Greenstone.)</Text> 620 625 <Text id="173">The DLS metadata set contains these items:</Text> 621 626 <BulletList> … … 646 651 </Title> 647 652 <Content> 648 <Text id="183">After clicking the <i>OK</i> button on the ânew collectionâ popup, the remaining parts of the interface, which were grayed out before, become active. The <i>Gather</i> panel, selected by the eponymous tab near the top of Figure 4, is displayed initially. This allows the user to explore the local file space and existing collections, gathering up selected documents for the new collection. The panel is divided into two sections, the left for browsing existing structures and the right for the documents in the collection.</Text>653 <Text id="183">After clicking the <i>OK</i> button on the ânew collectionâ popup, the remaining parts of the interface, which were grayed out before, become active. The <i>Gather</i> panel, selected by the eponymous tab near the top of Figure <CrossRef target="Figure" ref="starting_a_new_collection"/>, is displayed initially. This allows the user to explore the local file space and existing collections, gathering up selected documents for the new collection. The panel is divided into two sections, the left for browsing existing structures and the right for the documents in the collection.</Text> 649 654 <Text id="184">Operations available at this stage include:</Text> 650 655 <BulletList> … … 675 680 </BulletList> 676 681 <Text id="193">Care is taken to deal appropriately with name clashes when files of the same name in different parts of the computer's directory structure are copied into the same folder of the collection.</Text> 677 <Text id="194">In Figure 5the user is using the interactive file tree display to explore the local file system. At this stage, the collection on the right is empty; the user populates it by dragging and dropping files of interest from the left to the right panel. Such files are âcopiedâ rather than âmovedâ: so as not to disturb the original file system. The usual techniques for multiple selection, dragging and dropping, structuring the new collection by creating subdirectories (âfoldersâ), and deleting files from it by moving them to a trashcan, are all available.</Text>678 <Text id="195">Existing collections are represented by a subdirectory on the left called âGreenstone Collections,â which can be opened and explored like any other directory. However, the documents therein differ from ordinary files because they already have metadata attached, and this is preserved when they are moved into the new collection. Conflicts may arise because their metadata may have been assigned using a different metadata set from the one in use for the new collection, and the user must resolve these. In Figure 6the user has selected some documents from an existing collection and dragged them into the new one. The popup window explains that the metadata element <i>Organization</i> cannot be automatically imported, and asks the user to either select a metadata set and press <i>Add</i> to add the metadata element to that set,<FootnoteRef id="1"/>or choose a metadata set, then an element, and press <i>Merge</i> to effectively rename the old metadata element to the new one by merging the two. Metadata in subsequent documents from the same collection will automatically be handled in the same way.</Text>682 <Text id="194">In Figure <CrossRef target="Figure" ref="exploring_the_local_file_space"/> the user is using the interactive file tree display to explore the local file system. At this stage, the collection on the right is empty; the user populates it by dragging and dropping files of interest from the left to the right panel. Such files are âcopiedâ rather than âmovedâ: so as not to disturb the original file system. The usual techniques for multiple selection, dragging and dropping, structuring the new collection by creating subdirectories (âfoldersâ), and deleting files from it by moving them to a trashcan, are all available.</Text> 683 <Text id="195">Existing collections are represented by a subdirectory on the left called âGreenstone Collections,â which can be opened and explored like any other directory. However, the documents therein differ from ordinary files because they already have metadata attached, and this is preserved when they are moved into the new collection. Conflicts may arise because their metadata may have been assigned using a different metadata set from the one in use for the new collection, and the user must resolve these. In Figure <CrossRef target="Figure" ref="importing_existing_metadata"/> the user has selected some documents from an existing collection and dragged them into the new one. The popup window explains that the metadata element <i>Organization</i> cannot be automatically imported, and asks the user to either select a metadata set and press <i>Add</i> to add the metadata element to that set,<FootnoteRef id="1"/>or choose a metadata set, then an element, and press <i>Merge</i> to effectively rename the old metadata element to the new one by merging the two. Metadata in subsequent documents from the same collection will automatically be handled in the same way.</Text> 679 684 <Text id="196">When large file sets are selected, dragged, and dropped into the new collection, the copying operation may take some timeâparticularly if metadata conversion is involved. To indicate progress, the interface shows which file is being copied and what percentage of files has been processed.</Text> 680 <Text id="197">Special facilities are provided for dealing with large file sets. For example, the user can choose to filter the file tree to show only certain files, using a dropdown menu of file types displayed underneath the trees. In Figure 7, only the HTM and HTML files are being shown (and only these files will be copied by drag and drop).</Text>685 <Text id="197">Special facilities are provided for dealing with large file sets. For example, the user can choose to filter the file tree to show only certain files, using a dropdown menu of file types displayed underneath the trees. In Figure <CrossRef target="Figure" ref="filtering_the_file_trees"/>, only the HTM and HTML files are being shown (and only these files will be copied by drag and drop).</Text> 681 686 </Content> 682 687 </Subsection> … … 686 691 </Title> 687 692 <Content> 688 <Text id="199">The next phase in collection building is to enrich the documents by adding metadata. The <i>Enrich</i> tab brings up a new panel of information (Figure 8), which shows the document tree representing the collection on the left and on the right allows metadata to be added to individual documents, or groups of documents.</Text>689 <Text id="200">Documents that are copied during the first step come with any applicable metadata attached. If a document is part of a Greenstone collection, previously defined metadata is carried over to the new collection. Of course, this new collection may have a different metadata set, or perhaps just a subset of the defined metadata, and only metadata that pertains to the new collection's set is carried over. Resolution of such conflicts may require user intervention via a supplementary dialog (Figure 6). Any choices made are remembered for subsequent file copies.</Text>693 <Text id="199">The next phase in collection building is to enrich the documents by adding metadata. The <i>Enrich</i> tab brings up a new panel of information (Figure <CrossRef target="Figure" ref="assigning_metadata_using_enrich_view"/>), which shows the document tree representing the collection on the left and on the right allows metadata to be added to individual documents, or groups of documents.</Text> 694 <Text id="200">Documents that are copied during the first step come with any applicable metadata attached. If a document is part of a Greenstone collection, previously defined metadata is carried over to the new collection. Of course, this new collection may have a different metadata set, or perhaps just a subset of the defined metadata, and only metadata that pertains to the new collection's set is carried over. Resolution of such conflicts may require user intervention via a supplementary dialog (Figure <CrossRef target="Figure" ref="importing_existing_metadata"/>). Any choices made are remembered for subsequent file copies.</Text> 690 695 <Text id="201">The <i>Enrich</i> panel allows metadata values to be assigned to documents in the collection. For example, new values can be added to the set of existing values for an element. If the element's values have a hierarchical structure, the hierarchy can be extended in the same way.</Text> 691 696 <Figure id="importing_existing_metadata"> … … 735 740 </Bullet> 736 741 </BulletList> 737 <Text id="214">For our walkthrough example, in Figure 8the user has selected the folder <i>ec121e</i> and assigned âEC Courierâ as its <i>Organization</i> metadata. The buttons for updating and removing metadata become active depending on what selections have been made.</Text>738 <Text id="215">During the enrichment phase, or indeed at any other time, the user can choose to view all the metadata that has been assigned to documents in the collection. This is done by selecting a set of documents and choosing <i>Assigned Metadata</i> from the metadata sets menu, which brings up a popup window like that in Figure 9that shows the metadata in spreadsheet form. For large collections it is useful to be able to view the metadata associated with certain document types only, and if the user has specified a file filter as mentioned above, only the selected documents are shown in the metadata display.</Text>739 <Text id="216">The panel in Figure 10allows the user to edit metadata sets. Here, the user is looking at the <i>Subject</i> element of the DLS set. The values of this element form a hierarchy, and the user is examining, and perhaps changing, the list of values assigned to it. The same panel also allows you to change the âprofileâ for mapping elements of one metadata set to another. This profile is created when importing documents from collections that have pre-assigned metadata.</Text>742 <Text id="214">For our walkthrough example, in Figure <CrossRef target="Figure" ref="assigning_metadata_using_enrich_view"/> the user has selected the folder <i>ec121e</i> and assigned âEC Courierâ as its <i>Organization</i> metadata. The buttons for updating and removing metadata become active depending on what selections have been made.</Text> 743 <Text id="215">During the enrichment phase, or indeed at any other time, the user can choose to view all the metadata that has been assigned to documents in the collection. This is done by selecting a set of documents and choosing <i>Assigned Metadata</i> from the metadata sets menu, which brings up a popup window like that in Figure <CrossRef target="Figure" ref="viewing_all_metadata_for_selected_files"/> that shows the metadata in spreadsheet form. For large collections it is useful to be able to view the metadata associated with certain document types only, and if the user has specified a file filter as mentioned above, only the selected documents are shown in the metadata display.</Text> 744 <Text id="216">The panel in Figure <CrossRef target="Figure" ref="editing_the_metadata_set"/> allows the user to edit metadata sets. Here, the user is looking at the <i>Subject</i> element of the DLS set. The values of this element form a hierarchy, and the user is examining, and perhaps changing, the list of values assigned to it. The same panel also allows you to change the âprofileâ for mapping elements of one metadata set to another. This profile is created when importing documents from collections that have pre-assigned metadata.</Text> 740 745 <Figure id="editing_the_metadata_set"> 741 746 <Title> … … 769 774 </Title> 770 775 <Content> 771 <Text id="222">The <i>Design</i> panel (Figures 11â13) allows one to specify the structure, organization, and presentation of the collection being created. As noted earlier, the result of this process is recorded in a âcollection configuration file,â which is Greenstone's way of expressing the facilities that a collection requires. This step involves a series of separate interaction screens, each dealing with one aspect of the collection design. In effect, it serves as a graphical equivalent to the usual process of editing the configuration file manually.</Text>776 <Text id="222">The <i>Design</i> panel (Figures <CrossRef target="Figure" ref="designing_the_collection"/>â<CrossRef target="Figure" ref="configuring_arguments_to_a_plug-in"/>) allows one to specify the structure, organization, and presentation of the collection being created. As noted earlier, the result of this process is recorded in a âcollection configuration file,â which is Greenstone's way of expressing the facilities that a collection requires. This step involves a series of separate interaction screens, each dealing with one aspect of the collection design. In effect, it serves as a graphical equivalent to the usual process of editing the configuration file manually.</Text> 772 777 <Text id="223">Operations include:</Text> 773 778 <BulletList> … … 803 808 </Bullet> 804 809 </BulletList> 805 <Text id="234">In Figure 11 the user has clicked the <i>Design</i> tab and is reviewing the general information about the collection, entered when the new collection was created. On the left are listed the various facets that the user can configure: General, Document Plug-ins, Search Types, Search Indexes, Partition Indexes, Cross-Collection Search, Browsing Classifiers, Format Features, Translate Text, Metadata Sets. Appearance and functionality varies between these. For example, clicking the <i>Plug-in</i> button brings up the screen shown in Figure 12, which allows you to add, remove or configure plug-ins, and change the order in which the plug-ins are applied to documents.</Text>806 <Text id="235">Plug-ins and classifiers have many different arguments or âoptionsâ that the user can supply. The dialog box in Figure 13shows the user specifying arguments to some of the plug-ins. The grayed-out fields become active when the user adds the option by clicking the tick-box beside it. Because Greenstone is a continually growing open-source system, the number of options tends to increase as developers add new facilities. To help cope with this, Greenstone has a âplug-in informationâ utility program that lists the options available for each plug-in, and the librarian interface automatically invokes this to determine what options to show. This allows the interactive user interface to automatically keep pace with developments in the software.</Text>810 <Text id="234">In Figure <CrossRef target="Figure" ref="designing_the_collection"/> the user has clicked the <i>Design</i> tab and is reviewing the general information about the collection, entered when the new collection was created. On the left are listed the various facets that the user can configure: General, Document Plug-ins, Search Types, Search Indexes, Partition Indexes, Cross-Collection Search, Browsing Classifiers, Format Features, Translate Text, Metadata Sets. Appearance and functionality varies between these. For example, clicking the <i>Plug-in</i> button brings up the screen shown in Figure <CrossRef target="Figure" ref="specifying_which_plug-ins_to_use"/>, which allows you to add, remove or configure plug-ins, and change the order in which the plug-ins are applied to documents.</Text> 811 <Text id="235">Plug-ins and classifiers have many different arguments or âoptionsâ that the user can supply. The dialog box in Figure <CrossRef target="Figure" ref="configuring_arguments_to_a_plug-in"/> shows the user specifying arguments to some of the plug-ins. The grayed-out fields become active when the user adds the option by clicking the tick-box beside it. Because Greenstone is a continually growing open-source system, the number of options tends to increase as developers add new facilities. To help cope with this, Greenstone has a âplug-in informationâ utility program that lists the options available for each plug-in, and the librarian interface automatically invokes this to determine what options to show. This allows the interactive user interface to automatically keep pace with developments in the software.</Text> 807 812 <Figure id="getting_ready_to_create_new_collection"> 808 813 <Title> … … 824 829 </Title> 825 830 <Content> 826 <Text id="239">The <i>Create</i> panel (Figure 14) is used to construct a collection based on the documents and assigned metadata. The brunt of this work is borne by the Greenstone code itself. The user controls this external process through a series of separate interaction screens, each dealing with the arguments provided to a certain stage of the creation process.</Text>831 <Text id="239">The <i>Create</i> panel (Figure <CrossRef target="Figure" ref="getting_ready_to_create_new_collection"/>) is used to construct a collection based on the documents and assigned metadata. The brunt of this work is borne by the Greenstone code itself. The user controls this external process through a series of separate interaction screens, each dealing with the arguments provided to a certain stage of the creation process.</Text> 827 832 <Text id="240">The user observes the building process though a window that shows not only the text output generated by Greenstone's importing and index-building scripts, but also progress bars that indicate the overall degree of completion of each script.</Text> 828 <Text id="241">Figure 14shows the <i>Create</i> view. At the top are shown some options that can be applied during the creation process. The user selects appropriate values for the options. This figure illustrates a popup âtool tipâ that is available throughout the interface to explain the function of each argument.</Text>833 <Text id="241">Figure <CrossRef target="Figure" ref="getting_ready_to_create_new_collection"/> shows the <i>Create</i> view. At the top are shown some options that can be applied during the creation process. The user selects appropriate values for the options. This figure illustrates a popup âtool tipâ that is available throughout the interface to explain the function of each argument.</Text> 829 834 <Text id="242">When satisfied with the arguments, the user clicks <i>Build Collection</i>. Greenstone continually prints text that indicates progress, and this is shown along with a more informative progress bar.</Text> 830 835 </Content> … … 835 840 </Title> 836 841 <Content> 837 <Text id="244">The <i>Preview Collection</i> button (Figure 14) is used to view the collection that has been built. Clicking this button launches a web browser showing the home page of the collection (Figure 15). In practice, previewing often shows up deficiencies in the collection design, or in the individual metadata values, and the user frequently returns to earlier stages to correct these. This button becomes active once the collection has been created. The newly created collection will also have been installed on your Greenstone home page as one of the regular collections.</Text>842 <Text id="244">The <i>Preview Collection</i> button (Figure <CrossRef target="Figure" ref="getting_ready_to_create_new_collection"/>) is used to view the collection that has been built. Clicking this button launches a web browser showing the home page of the collection (Figure <CrossRef target="Figure" ref="previewing_the_newly_built_collection"/>). In practice, previewing often shows up deficiencies in the collection design, or in the individual metadata values, and the user frequently returns to earlier stages to correct these. This button becomes active once the collection has been created. The newly created collection will also have been installed on your Greenstone home page as one of the regular collections.</Text> 838 843 </Content> 839 844 </Subsection> … … 843 848 </Title> 844 849 <Content> 845 <Text id="246">On-line help is always available, and is invoked using the <i>Help</i> item at the right of the main menu bar at the top of each of the Figures. This opens up a hierarchically structured file of help text, and account is taken of the user's current context to highlight the section that is appropriate to the present stage of the interaction. Furthermore, as noted above, whenever the mouse is held still over any interactive object a small window pops up to give a textual âtool tip,â as illustrated near the bottom of Figure 14.</Text>850 <Text id="246">On-line help is always available, and is invoked using the <i>Help</i> item at the right of the main menu bar at the top of each of the Figures. This opens up a hierarchically structured file of help text, and account is taken of the user's current context to highlight the section that is appropriate to the present stage of the interaction. Furthermore, as noted above, whenever the mouse is held still over any interactive object a small window pops up to give a textual âtool tip,â as illustrated near the bottom of Figure <CrossRef target="Figure" ref="getting_ready_to_create_new_collection"/>.</Text> 846 851 </Content> 847 852 </Subsection> … … 853 858 </Title> 854 859 <Content> 855 <Subsection id="starting_off"> 856 <Title> 857 <Text id="248">Starting Off</Text> 858 </Title> 859 <Content> 860 <Text id="249">This section covers how to create, load, save and delete collections.</Text> 861 <Part id="creating_a_new_collection"> 862 <Title> 863 <Text id="250">Creating a New Collection</Text> 864 </Title> 865 <Content> 866 <Text id="251">To create a new collection, open the "File" menu and choose "New". Several fields need to be filled out -- but you can change their values later if you need to, in the design view.</Text> 867 <Text id="252">"Collection title" is the text displayed at the top of your collection's home page. It can be any length.</Text> 868 <Text id="253">"Description of content" should describe, in as much detail as possible, what the collection is about. Use the [Enter] key to break it into paragraphs.</Text> 869 <Text id="254">Finally you must specify whether the new collection will have the same appearance and metadata sets as an existing collection, or whether to start a default "New Collection".</Text> 870 <Text id="255">Click "OK" to create the collection. If you chose "New Collection" you are prompted for the metadata sets to use in it. You can choose more than one, and you can add others later.</Text> 871 <Text id="256">Clicking "Cancel" returns you to the main screen immediately.</Text> 872 </Content> 873 </Part> 874 <Part id="saving_the_collection"> 875 <Title> 876 <Text id="257">Saving the Collection</Text> 877 </Title> 878 <Content> 879 <Text id="258">Save your work regularly by opening the "File" menu and choosing "Save". Saving a collection is not the same as making it ready for use in Greenstone (see Producing Your Collection).</Text> 880 <Text id="259">The Librarian Interface protects your work by saving it whenever you exit the program or load another collection.</Text> 881 <Text id="260">Saved collections are written to a file named for the collection and with file extension ".col", located in a folder of the same name within your Greenstone installation's "collect" folder.</Text> 882 </Content> 883 </Part> 884 <Part id="opening_an_existing_collection"> 885 <Title> 886 <Text id="261">Opening an Existing Collection</Text> 887 </Title> 888 <Content> 889 <Text id="262">To open an existing collection, choose "Open" from the "File" menu to get the Open Collection prompt. A list of your Greenstone collections appears. Select one to see its description, and click "Open" to load it. If you seek a collection that resides outside Greenstone's "collect" folder, click "Browse" for a file system browsing dialog.</Text> 890 <Text id="263">In case more than one Greenstone Librarian Interface program is running concurrently, the relevant directories are "locked" to prevent interference. On opening a collection, a small temporary lock file is created in its folder. Before opening a collection, the Librarian Interface checks to ensure that no lock file already exists. You can tell whether a collection is locked by the colour of its icon: green for a normal collection, red for a locked one. However, when the Librarian Interface is exited prematurely the lock file is sometimes left in place. When you open such a collection, the Librarian asks if you want to "steal" control of it. Never steal a collection that someone else is currently working on.</Text> 891 <Text id="264">When you open a collection that the Greenstone Librarian Interface did not create, you will be asked to select a metadata set (or sets). If none are selected, any existing metadata will be ignored. Otherwise, metadata will be imported just as it is when you drag in files with existing metadata. The process is described in the Importing Previously Assigned Metadata section.</Text> 892 </Content> 893 </Part> 894 <Part id="deleting_collections"> 895 <Title> 896 <Text id="265">Deleting Collections</Text> 897 </Title> 898 <Content> 899 <Text id="266">To permanently delete collections from your Greenstone installation, choose "Delete..." from the "File" menu. A list of your Greenstone collections appears. Select one to see its description, then tick the box at the bottom of the dialog and click "Delete" to delete the collection. This action is irreversible, so check carefully that you no longer need the collection before proceeding!</Text> 900 </Content> 901 </Part> 902 </Content> 903 </Subsection> 904 <Subsection id="downloading_files_from_the_internet"> 905 <Title> 906 <Text id="267">Downloading Files From the Internet</Text> 907 </Title> 908 <Content> 909 <Text id="268">The "Download" view helps you download resources from the internet. This section explains the Librarian Interface's mirroring process.</Text> 910 <Part id="the_download_view"> 911 <Title> 912 <Text id="269">The Download view</Text> 913 </Title> 914 <Content> 915 <Text id="270">This section describes how to configure a download task and control the downloading process. Access the "Download" view by clicking its tab. The top half of the screen shows the downloading controls. The bottom half is initially empty, but will show a list of pending and completed downloading jobs.</Text> 916 <Text id="271">Files are downloaded into a folder in the workspace called "Downloaded Files" (only present when mirroring is enabled), and can be used in all collections built with the Librarian Interface. Files in this area are named by their full web URL. A new folder is created for each host, followed by others for each part of the path. This ensures that each file is distinct.</Text> 917 <Text id="272">Use the first of the download configuration controls, "Source URL", to enter the URL of a target resource. Use the "Download Depth" control to limit how many hyperlinks to follow when downloading: Set this to 0 to download a single web page; set it to 1 to download a page and all the pages it points to. The depth limit is ignored when downloading media other than html pages. Next, there are several checkbox controls which can be set to turn on the specified feature for a specific download. Once the configuration is set up, click "Download" to start the new download job. There are two other button controls: "Preferences", which links to the connection section of the Preferences where proxy settings can be edited; and "Clear Cache", which deletes all previously downloaded files.</Text> 918 <Text id="273">The download list has an entry for each web page download. Each entry has a text region that gives details of the task along with a progress bar showing current activity. Three buttons appear to the left of each entry. "Pause" is used for pausing a currently downloading task. "View Log" opens a window showing the download log file. "Close" terminates the download and removes the task from the list.</Text> 919 <Text id="274">The Preferences section describes how to establish an Internet connection via a proxy. If authentication is needed, the proxy server prompts for identification and password. The Librarian Interface does not store passwords between sessions.</Text> 920 </Content> 921 </Part> 922 </Content> 923 </Subsection> 924 <Subsection id="collecting_files_for_your_collection"> 925 <Title> 926 <Text id="275">Collecting Files for Your Collection</Text> 927 </Title> 928 <Content> 929 <Text id="276">Once you have a new collection you need to get some files into it. These may come from your ordinary file space, or from other Greenstone collections. Some may already have attached metadata. This section describes how to import files.</Text> 930 <Part id="the_gather_view"> 931 <Title> 932 <Text id="277">The Gather View</Text> 933 </Title> 934 <Content> 935 <Text id="278">This section introduces the Gather area that you use to select what files to include in the collection you are building. The Librarian Interface starts with the Gather view. To return to this view later, click the "Gather" tab directly below the menu bar.</Text> 936 <Text id="279">The two large areas titled "Workspace" and "Collection" are used to move files into your collection. They contain "file trees", graphical structures that represent files and folders.</Text> 937 <Text id="280">Select an item in the tree by clicking it. (There are other ways; see below.) Double-click a folder, or single-click the switch symbol beside it, to expand (or collapse) its contents. Double-click a file to open it using its associated application program (see File Associations).</Text> 938 <Text id="281">The Workspace file tree shows the sources of data available to the Librarian Interface -- the local file system (including disk and CD-ROM drives), the contents of existing Greenstone collections, and the cache of downloaded files. You can copy and view these files but you cannot move, delete, or edit them, with the exception of the downloaded files, which can be deleted. Navigate this space to find the files you want to include in the collection.</Text> 939 <Text id="282">The Collection file tree represents the contents of the collection so far. Initially, it is empty.</Text> 940 <Text id="283">You can resize the spaces by mousing over the grey bar that separates the trees (the shape of the pointer changes) and dragging.</Text> 941 <Text id="284">At the bottom of the window is a status area that shows the progress of actions involving files (copying, moving and deleting). These can take some time to complete. The "Stop" button stops any action that is currently in progress.</Text> 942 <Text id="285">Two large buttons occupy the lower right corner of the screen. "New Folder", with a picture of a folder, creates new folders (see Creating folders). "Delete", with a garbage can, removes files. Clicking the Delete button will remove any selected files from the Collection file tree. Alternatively, files can be deleted by dragging them onto the Delete button.</Text> 943 <Text id="286">To select several sequential items, select the first and then hold down [Shift] and click on the last -- the selection will encompass all intervening items. Select non-sequential files by holding down [Ctrl] while clicking. Use these two methods together to select groups of non-adjacent items.</Text> 944 <Text id="287">Certain folders -- such as the one containing your own web pages -- sometimes have special significance. The Librarian Interface can map such folders to the first level of the file tree. To do this, right-click the desired folder. Select "Create Shortcut", and enter a name for the folder. To remove an item, right-click the mapped folder and select "Remove Shortcut".</Text> 945 </Content> 946 </Part> 947 <Part id="creating_folders"> 948 <Title> 949 <Text id="288">Creating Folders</Text> 950 </Title> 951 <Content> 952 <Text id="289">Use folders in the Collection file tree to group files together and make them easier to find. Folders can be placed inside folders. There is virtually no limit to how many folders you can have or how deeply they can be nested.</Text> 953 <Text id="290">To create a new folder, optionally select an existing folder in the Collection Tree and click the New Folder button. The new folder appears within the selected one, or at the top level if none is selected. You are prompted for the folder's name (default "New Folder").</Text> 954 <Text id="291">Folders can also be created by right-clicking over a folder, choosing "New Folder" and proceeding as above.</Text> 955 </Content> 956 </Part> 957 <Part id="adding_files"> 958 <Title> 959 <Text id="292">Adding Files</Text> 960 </Title> 961 <Content> 962 <Text id="293">Files can be copied into the collection by dragging and dropping. The mouse pointer becomes a ghost of the selected item (or, if more than one is selected, the number of them). Drop the selection into the Collection Tree to copy the files there (if the source was the Workspace Tree) or move them around within the collection (if the source was the Collection Tree).</Text> 963 <Text id="294">When copying multiple files, they are all placed in the target folder at the same level, irrespective of the folder structure they occupied originally. When you copy a second file with the same name into the same folder, you are asked whether to overwrite the first one. Respond "No" and the file will not be copied, but the others will be. To cancel all remaining copy actions, click the "stop" button.</Text> 964 <Text id="295">Only the "highest" items in a selection are moved. A folder is higher than its children. You cannot select files within a folder and also the folder itself.</Text> 965 <Text id="296">When you add a file, the Librarian Interface searches through the source folders for auxiliary files containing metadata previously assigned to the added file and, if it finds one, begins to import this metadata. As the operation proceeds, you may be prompted (perhaps several times) for extra information to match the imported metadata to the metadata sets in your collection. This process involves many different prompts, described in the Importing Previously Assigned Metadata section. For a more detailed explanation of associating metadata with files read Chapter 2 of the Greenstone Developer's Guide -- Getting the most out of your documents.</Text> 966 </Content> 967 </Part> 968 <Part id="removing_files"> 969 <Title> 970 <Text id="297">Removing Files</Text> 971 </Title> 972 <Content> 973 <Text id="298">There are several methods for removing files and folders. You must first indicate what items to remove by selecting one or more files and folders as described in The Gather View.</Text> 974 <Text id="299">Once files have been selected, click the "delete" button to remove them, or press the [Delete] key on your keyboard, or drag them from the collection to the delete button and drop them there.</Text> 975 </Content> 976 </Part> 977 <Part id="filtering_the_tree"> 978 <Title> 979 <Text id="300">Filtering the Tree</Text> 980 </Title> 981 <Content> 982 <Text id="301">"Filtering" the collection tree allows you to narrow down the search for particular files.</Text> 983 <Text id="302">The "Show Files" pull-down menu underneath each tree shows a list of predefined filters, such as "Images". Choosing this temporarily hides all other files in the tree. To restore the tree, change the filter back to "All Files". These operations do not alter the collection, nor do they affect the folders in the tree.</Text> 984 <Text id="303">You can specify a custom filter by typing in a pattern to match files against (Librarian Systems Specialist and Expert modes only). Use standard file system abbreviations such as "*.*" or "*.doc" ("*" matches any characters).</Text> 985 </Content> 986 </Part> 987 </Content> 988 </Subsection> 989 <Subsection id="enriching_the_collection_with_metadata"> 990 <Title> 991 <Text id="304">Enriching the Collection with Metadata</Text> 992 </Title> 993 <Content> 994 <Text id="305">Having gathered several files into the collection, now enrich them with additional information called "metadata". This section explains how metadata is created, edited, assigned and retrieved, and how to use external metadata sources (also see Chapter 2 of the Greenstone Developer's Guide -- Getting the most out of your documents).</Text> 995 <Part id="the_enrich_view"> 996 <Title> 997 <Text id="306">The Enrich View</Text> 998 </Title> 999 <Content> 1000 <Text id="307">Use the Enrich view to assign metadata to the documents in the collection. Metadata is data about data -- typically title, author, creation date, and so on. Each metadata item has two parts: "element" tells what kind of item it is (such as author), and "value" gives the value of that metadata element (such as the author's name).</Text> 1001 <Text id="308">On the left of the "Enrich" view is the Collection Tree. To the right is the Metadata Table, which shows metadata for any selected files or folders in the Collection Tree. Columns are named in grey at the top, and can be resized by dragging the separating line. If several files are selected, black text indicates that the value is common to all of the selected files, while grey text indicates that it is not. Black values may be updated or removed, while grey ones can be removed from those that have it, or appended to the others.</Text> 1002 <Text id="309">A folder icon may appear beside some metadata entries. This indicates that the values are inherited from a parent (or ancestor) folder. Inherited metadata cannot be edited or removed, only appended to or overwritten. Click on the folder icon to go immediately to the folder where the metadata is assigned.</Text> 1003 <Text id="310">Clicking on a metadata element in the table will display the existing values for that element in the "Existing values for..." area below the table. The Value Tree expands and collapses. Usually it is a list that shows all values entered previously for the selected element. Clicking an entry automatically places it into the value field. Conversely, typing in the text field selects the Value Tree entry that starts with the characters you have typed. Pressing [Tab] auto-completes the typing with the selected value.</Text> 1004 <Text id="311">Metadata values can be organised into a hierarchy. This is shown in the Value Tree using folders for internal levels. Hierarchical values can be entered using the character "|" to separate the levels. For example, "Cards|Red|Diamonds|Seven" might be used in a hierarchy that represents a pack of playing cards. This enables values to be grouped together. Groups can also be assigned as metadata to files.</Text> 1005 <Text id="312">Greenstone extracts metadata automatically from documents into a metadata set whose elements are prefixed by "ex.". This has no value tree and cannot be edited.</Text> 1006 </Content> 1007 </Part> 1008 <Part id="selecting_metadata_sets"> 1009 <Title> 1010 <Text id="313">Selecting Metadata Sets</Text> 1011 </Title> 1012 <Content> 1013 <Text id="314">Sets of predefined metadata elements are known as "metadata sets". An example is the Dublin Core metadata set. When you add a metadata set to your collection, its elements become available for selection. You can have more than one set; to prevent name clashes a short identifier that identifies the metadata set is pre-pended to the element name. For instance the Dublin Core element Creator becomes "dc.Creator". Metadata sets are stored in the Librarian Interface's metadata folder and have the suffix ".mds".</Text> 1014 <Text id="315">To control the metadata sets used in a collection, use the "Metadata Sets" entry on the Design view.</Text> 1015 </Content> 1016 </Part> 1017 <Part id="appending_new_metadata"> 1018 <Title> 1019 <Text id="316">Appending New Metadata</Text> 1020 </Title> 1021 <Content> 1022 <Text id="317">We now add a metadata item -- both element and value -- to a file. First select the file from the Collection file tree on the left. The action causes any metadata previously assigned to this file to appear in the table at the right.</Text> 1023 <Text id="318">Next select the metadata element you want to add by clicking its row in the table.</Text> 1024 <Text id="319">Type the value into the value field. Use the "|" character to add structure, as described in The Enrich View. Pressing the [Up] or [Down] arrow keys will save the metadata value and move the selection appropriately. Pressing [Enter] will save the metadata value and create a new empty entry for the metadata element, allowing you to assign multiple values to a metadata element.</Text> 1025 <Text id="320">You can also add metadata to a folder, or to several multiply selected files at once. It is added to all files within the folder or selection, and to child folders. Keep in mind that if you assign metadata to a folder, any new files in it automatically inherit the folder's values.</Text> 1026 </Content> 1027 </Part> 1028 <Part id="adding_previously_defined_metadata"> 1029 <Title> 1030 <Text id="321">Adding Previously Defined Metadata</Text> 1031 </Title> 1032 <Content> 1033 <Text id="322">To add metadata that has an existing value, first select the file, then select the required value from the value tree, expanding hierarchy folders as necessary. The value of the selected entry automatically appears in the Value field (alternatively, use the value tree's auto-select and auto-complete features).</Text> 1034 <Text id="323">The process of adding metadata with already-existing values to folders or multiple files is just the same.</Text> 1035 </Content> 1036 </Part> 1037 <Part id="editing_or_removing_metadata"> 1038 <Title> 1039 <Text id="324">Editing or Removing Metadata</Text> 1040 </Title> 1041 <Content> 1042 <Text id="325">To edit or remove a piece of metadata, first select the appropriate file, and then the metadata value from the table. Edit the value field, deleting all text if you wish to remove the metadata.</Text> 1043 <Text id="326">The process is the same when updating a folder with child folders or multiple files, but you can only update metadata that is common to all files/folders selected.</Text> 1044 <Text id="327">The value tree shows all currently assigned values as well as previous values for the current session, so changed or deleted values will remain in the tree. Closing the collection and then re-opening it will remove the values which are no longer assigned.</Text> 1045 </Content> 1046 </Part> 1047 <Part id="reviewing_assigned_metadata"> 1048 <Title> 1049 <Text id="328">Reviewing Assigned Metadata</Text> 1050 </Title> 1051 <Content> 1052 <Text id="329">Sometimes you need to see the metadata assigned to many or all files at once -- for instance, to determine how many files are left to work on, or to get some idea of the spread of dates.</Text> 1053 <Text id="330">Select the files you wish to examine, then right-click and choose "Assigned Metadata...". A window called "All Metadata", dominated by a large table with many columns, appears. The first column shows file names; the rows show all metadata values assigned to those files.</Text> 1054 <Text id="331">Drawing the table can take some time if many files are selected. You can continue to use the Librarian Interface while the "All Metadata" window is open.</Text> 1055 <Text id="332">When it gets too large, you can filter the "All Metadata" table by applying filters to the columns. As new filters are added, only those rows that match them remain visible. To set, modify or clear a filter, click on the "funnel" icon at the top of a column. You are prompted for information about the filter. Once a filter is set, the column header changes colour.</Text> 1056 <Text id="333">The prompt has a "Simple" and an "Advanced" tab. The Simple version filters columns so that they only show rows that contain a certain metadata value ("*" matches all values). You can select metadata values from the pull-down list. The Advanced version allows different matching operations: must start with, does not contain, alphabetically less than and is equal to. The value to be matched can be edited to be any string (including "*"), and you can choose whether the matching should be case insensitive. Finally, you can specify a second matching condition that you can use to specify a range of values (by selecting AND) or alternative values (by selecting OR). Below this area is a box that allows you to change the sort order (ascending or descending). Once you have finished, click "Set Filter" to apply the new filter to the column. Click "Clear Filter" to remove a current filter. Note that the filter details are retained even when the filter is cleared.</Text> 1057 <Text id="334">For example, to sort the "All Metadata" table, choose a column, select the default filter setting (a Simple filter on "*"), and choose ascending or descending ordering.</Text> 1058 </Content> 1059 </Part> 1060 <Part id="importing_previously_assigned_metadata"> 1061 <Title> 1062 <Text id="335">Importing Previously Assigned Metadata</Text> 1063 </Title> 1064 <Content> 1065 <Text id="336">This section describes how to import previously assigned metadata: metadata assigned to documents before they were added to the collection.</Text> 1066 <Text id="337">If metadata in a form recognized by the Librarian Interface has been previously assigned to a file -- for example, when you choose documents from an existing Greenstone collection -- it is imported automatically when you add the file. To do this, the metadata must be mapped to the metadata sets available in the collection.</Text> 1067 <Text id="338">The Librarian Interface prompts for the necessary information. The prompt gives brief instructions and then shows the name of the metadata element that is being imported, just as it appears in the source file. This field cannot be edited or changed. Next you choose what metadata set the new element should map to, and then the appropriate metadata element in that set. The system automatically selects the closest match, in terms of set and element, for the new metadata.</Text> 1068 <Text id="339">Having checked the mapping, you can choose "Add" to add the new metadata element to the chosen metadata set. (This is only enabled if there is no element of the same name within the chosen set.) "Merge" maps the new element to the one chosen by the user. Finally, "Ignore" does not import any metadata with this element name. Once you have specified how to import a certain piece of metadata, the mapping information is retained for the collection's lifetime.</Text> 1069 <Text id="340">For details on the metadata.xml files which Greenstone uses to store the metadata, see Chapter 2 of the Greenstone Developer's Guide -- Getting the most out of your documents.</Text> 1070 </Content> 1071 </Part> 1072 </Content> 1073 </Subsection> 1074 <Subsection id="designing_your_collection_appearance"> 1075 <Title> 1076 <Text id="341">Designing Your Collection's Appearance</Text> 1077 </Title> 1078 <Content> 1079 <Text id="342">Once your files are marked up with metadata, you next decide how it should appear to users as a Greenstone collection. What kind of information is searchable? What ways are provided to browse through the documents? What languages are supported? Where do the buttons appear on the page? These things can be customized; this section describes how to do it.</Text> 1080 <Part id="the_design_view"> 1081 <Title> 1082 <Text id="343">The Design View</Text> 1083 </Title> 1084 <Content> 1085 <Text id="344">This section introduces you to the design view and explains how to navigate between the various views within this pane.</Text> 1086 <Text id="345">With the Librarian Interface, you can configure how the collection appears to the user. The configuration options are divided into different sections, each associated with a particular stage of navigating or presenting information.</Text> 1087 <Text id="346">On the left is a list of different views, and on the right are the controls associated with the current one. To change to a different view, click its name in the list.</Text> 1088 <Text id="347">To understand the stages and terms involved in designing a collection, first read Chapters 1 and 2 of the Greenstone Developer's Guide.</Text> 1089 </Content> 1090 </Part> 1091 <Part id="general"> 1092 <Title> 1093 <Text id="348">General</Text> 1094 </Title> 1095 <Content> 1096 <Text id="349">This section explains how to review and alter the general settings associated with your collection. First, under "Design Sections", click "General".</Text> 1097 <Text id="350">Here the values provided during collection creation can be modified.</Text> 1098 <Text id="351">First are the contact emails of the collection's creator and maintainer. The following field allows you to change the collection title. The folder that the collection is stored in is shown next, but this cannot be edited. The next one specifies (in the form of a URL) the icon to show at the top left of the collection's "About" page, and the next is the icon used in the Greenstone library page to link to the collection. Then, a checkbox controls whether the collection should be publicly accessible. Finally comes the "Collection Description" text area as described in Creating A New Collection.</Text> 1099 </Content> 1100 </Part> 1101 <Part id="document_plugins"> 1102 <Title> 1103 <Text id="352">Document Plugins</Text> 1104 </Title> 1105 <Content> 1106 <Text id="353">This section describes how to configure the document plugins the collection uses. It explains how you specify what plugins to use, what parameters to pass to them, and in what order they occur. Under "Design Sections", click "Document Plugins".</Text> 1107 <Text id="354">To add a plugin, select it using the "Select plugin to add" pull-down list near the bottom and then click "Add Plugin". A window appears entitled "Configuring Arguments"; it is described later. Once you have configured the new plugin, it is added to the end of the "Currently Assigned Plugins" list. Note that, except for UnknownPlug, each plugin may only occur once in the list.</Text> 1108 <Text id="355">To remove a plugin, select it in the list and click "Remove Plugin".</Text> 1109 <Text id="356">Plugins are configured by providing arguments. To alter them, select the plugin from the list and click "Configure Plugin" (or double-click the plugin). A "Configuring Arguments" dialog appears with various controls for specifying arguments.</Text> 1110 <Text id="357">There are different kinds of controls. Some are checkboxes, and clicking one adds the appropriate option to the plugin. Others are text strings, with a checkbox and a text field. Click the box to enable the argument, then type appropriate text (regular expression, file path etc) in the box. Others are pull-down menus from which you can select from a given set of values. To learn what an argument does, let the mouse hover over its name for a moment and a description will appear.</Text> 1111 <Text id="358">When you have changed the configuration, click "OK" to commit the changes and close the dialog, or "Cancel" to close the dialog without changing any plugin arguments.</Text> 1112 <Text id="359">The plugins in the list are executed in order, and the ordering is sometimes important. The order of the plugins can be changed in Library Systems Specialist and Expert modes only (see Preferences).</Text> 1113 </Content> 1114 </Part> 1115 <Part id="search_types"> 1116 <Title> 1117 <Text id="360">Search Types</Text> 1118 </Title> 1119 <Content> 1120 <Text id="361">This section explains how to modify a new design feature in Greenstone, Search Types, which allow fielded searching. The search types specify what kind of search interface should be provided: form, for fielded searching, and/or plain for regular searching. Under "Design Sections", click "Search Types".</Text> 1121 <Text id="362">When you enter the Search Types view, first check "Enable Advanced Searches", which activates the other controls. This changes the collection to use an indexing mechanism that allows fielded searching. Index specification is slightly different in this mode. (When switching between standard and advanced searching, the GLI does its best to convert the index specification, but may not get it completely right.)</Text> 1122 <Text id="363">To add a search type, select it from the "Search Types" list and click "Add Search Type". Each type can only appear in the list once. The first search type will be the default, and will appear on the search page of the built collection. Any others will be selectable from the preferences page.</Text> 1123 <Text id="364">To remove a search type, select it from the "Currently Assigned Search Types" list and click "Remove Search Type". The list must contain at least one search type.</Text> 1124 </Content> 1125 </Part> 1126 <Part id="search_indexes"> 1127 <Title> 1128 <Text id="365">Search Indexes</Text> 1129 </Title> 1130 <Content> 1131 <Text id="366">Indexes specify what parts of the collection are searchable. This section explains how to add and remove indexes, and set a default index. Under "Design Sections", click "Search Indexes".</Text> 1132 <Text id="367">To add an index, type a name for it into the "Index Name" field. Select which of the possible information sources to index by clicking the checkboxes beside them. The list shows all the assigned metadata elements, as well the full text. Having selected the data sources, choose the granularity of the index, using the "At the level" menu. Once these details are complete, "Add Index" becomes active (unless there is an existing index with the same settings). Click it to add the new index.</Text> 1133 <Text id="368">To edit an index, select it and change the index details, then click "Replace Index".</Text> 1134 <Text id="369">To remove an index, select it from the list of assigned indexes and click "Remove Index".</Text> 1135 <Text id="370">To create an index covering text and all metadata, click "Add All".</Text> 1136 <Text id="371">The default index, the one used on the collection's search page, is tagged with "[Default Index]" in the "Assigned Indexes" list. To set it, select an index from the list and click "Set Default".</Text> 1137 <Text id="372">If advanced searching is enabled (via the Search Types view), the index controls are different. There is a new pseudo-data source "allfields" which provides searching across all specified indexes at once. Levels are not assigned to a specific index, but apply across all indexes: thus indexes and levels are added separately. "Add All" creates a separate index for each metadata field in this mode.</Text> 1138 <Text id="373">The name of each index will default to the source name. To change the name, select an index, change its details, and click "Replace Index".</Text> 1139 </Content> 1140 </Part> 1141 <Part id="partition_indexes"> 1142 <Title> 1143 <Text id="374">Partition Indexes</Text> 1144 </Title> 1145 <Content> 1146 <Text id="375">Indexes are built on particular text or metadata sources. The search space can be further controlled by partitioning the index, either by language or by a predetermined filter. This section describes how to do this. Under "Design Sections", click "Partition Indexes".</Text> 1147 <Text id="376">The "Partition Indexes" view has three tabs; "Define Filters", "Assign Partitions" and "Assign Languages". To learn more about partitions read about subcollections and subindexes in Chapter 2 of the Greenstone Developer's Guide.</Text> 1148 <Text id="377">The Partition Indexes screen is only enables in Library Systems Specialist and Expert modes (see Preferences). Note that the total number of partitions generated is a combination of all indexes, subcollection filters and languages chosen. Two indexes with two subcollection filters in two languages would yield eight index partitions.</Text> 1149 </Content> 1150 </Part> 1151 <Part id="define_filters"> 1152 <Title> 1153 <Text id="378">Define Filters</Text> 1154 </Title> 1155 <Content> 1156 <Text id="379">Filters allow you to group together into a subcollection all documents in an index for which a metadata value matches a given pattern.</Text> 1157 <Text id="380">To create a filter, click the "Define Filters" tab and enter a name for the new filter into the "Subcollection filter name:" field. Next choose a document attribute to match against, either a metadata element or the name of the file in question. Enter a regular expression to use during the matching. You can toggle between "Including" documents that match the filter, or "Excluding" them. Finally, you can specify any of the standard PERL regular expression flags to use when matching (e.g. "i" for case-insensitive matching). Finally, click "Add Filter" to add the filter to the "Defined Subcollection Filters" list.</Text> 1158 <Text id="381">To remove a filter, select it from the list and click "Remove Filter".</Text> 1159 <Text id="382">To alter a filter, select it from the list, change any of the values that appear in the editing controls and click "Replace Filter" to commit the changes.</Text> 1160 </Content> 1161 </Part> 1162 <Part id="assign_partitions"> 1163 <Title> 1164 <Text id="383">Assign Partitions</Text> 1165 </Title> 1166 <Content> 1167 <Text id="384">Having defined a subcollection filter, use the "Assign Partitions" tab to build indexes for it (or for a group of filters). Select the desired filter (or filters) from the "Defined Subcollection Filters" list, enter a name for your partition in the "Partition Name" field, and click "Add Partition".</Text> 1168 <Text id="385">To remove a partition, select it from the list and click "Remove Partition".</Text> 1169 <Text id="386">To make a partition the default one, select it from the list and click "Set Default".</Text> 1170 </Content> 1171 </Part> 1172 <Part id="assign_languages"> 1173 <Title> 1174 <Text id="387">Assign Languages</Text> 1175 </Title> 1176 <Content> 1177 <Text id="388">This section details how to restrict search indexes to particular languages. You do this by generating a partition using the "Assign Languages" tab of the "Partition Indexes" view.</Text> 1178 <Text id="389">To add a new language to partition by, use the "Assign Languages" tab to build an index for it. Select the desired language from the "Language to add" pull-down list and click "Add Language".</Text> 1179 <Text id="390">To remove a language, select it from the "Language Selection" list and click "Remove Language".</Text> 1180 <Text id="391">To set the default language, select it from the list and click "Set Default".</Text> 1181 </Content> 1182 </Part> 1183 <Part id="cross-collection_search"> 1184 <Title> 1185 <Text id="392">Cross-Collection Search</Text> 1186 </Title> 1187 <Content> 1188 <Text id="393">Greenstone can search across several different collections as though they were one. This is done by specifying a list of other collections to be searched along with the current one. Under "Design Sections", click "Cross-Collection Search".</Text> 1189 <Text id="394">The Cross-Collection Search view shows a checklist of available collections. The current collection is ticked and cannot be deselected. To add another collection to be searched in parallel, click it in the list (click again to remove it). If only one collection is selected, there is no cross-collection searching.</Text> 1190 <Text id="395">If the individual collections do not have the same indexes (including subcollection partitions and language partitions) as each other, cross-collection searching will not work properly. The user will only be able to search using indexes common to all collections.</Text> 1191 <Text id="396">For further details, see Chapter 1 of the Greenstone Developer's Guide.</Text> 1192 </Content> 1193 </Part> 1194 <Part id="browsing_classifiers"> 1195 <Title> 1196 <Text id="397">Browsing Classifiers</Text> 1197 </Title> 1198 <Content> 1199 <Text id="398">This section explains how to assign "classifiers", which are used for browsing, to the collection. Under "Design Sections", click "Browsing Classifiers".</Text> 1200 <Text id="399">To add a classifier, select it using the "Select classifier to add" pull-down list near the bottom and then click "Add Classifier". A window appears entitled "Configuring Arguments"; instructions for this dialog are just the same as for plugins (see Document Plugins). Once you have configured the new classifier, it is added to the end of the "Currently Assigned Classifiers" list.</Text> 1201 <Text id="400">To remove a classifier, select it from the list and click "Remove Classifier".</Text> 1202 <Text id="401">To change the arguments a classifier, select it from the list and click "Configure Classifier" (or double-click on the classifier in the list).</Text> 1203 <Text id="402">The ordering of classifiers in the collection's navigation bar is reflected in their order here. To change it, select the classifier you want to move and click "Move Up" or "Move Down".</Text> 1204 <Text id="403">For further information on classifiers read Chapter 2, Greenstone Developer's Guide -- Getting the most out of your documents.</Text> 1205 </Content> 1206 </Part> 1207 <Part id="format_features"> 1208 <Title> 1209 <Text id="404">Format Features</Text> 1210 </Title> 1211 <Content> 1212 <Text id="405">The web pages you see when using Greenstone are not pre-stored but are generated 'on the fly' as they are needed. Format commands are used to change the appearance of these generated pages. They affect such things as where buttons appear when a document is shown, and what links are displayed by the DateList classifier. Format commands are not easy to develop, and you should read Chapter 2 of the Greenstone Developer's Guide. This section discusses the format settings, and how the Librarian Interface gives access to them. Under "Design Sections", click "Format Features".</Text> 1213 <Text id="406">You can apply a format command to anything in the "Choose Feature" pull-down list, which includes each classifier and a predefined list of features. When you select a feature, there are two types of control. Some features are simply enabled or disabled, and this is controlled by a checkbox. Others require a format string to be specified. For these there is a pull-down list ("Affected Component") for selecting which part of the feature the string applies to (if necessary), a text area ("HTML Format String") for entering the string, and a selection of predefined "Variables". To insert a variable into the current position in the format string, select it from the pull-down list and click "Insert".</Text> 1214 <Text id="407">You can specify a default format for a particular component by selecting the blank feature. This format is then applied to all applicable features unless otherwise specified.</Text> 1215 <Text id="408">To add a new format command, fill out the information as explained above and click "Add Format". The new format command appears in the list of "Currently Assigned Format Commands". Only one format command can be assigned to each feature/component combination.</Text> 1216 <Text id="409">To remove a format command, select it from the list and click "Remove Format".</Text> 1217 <Text id="410">To change a format command, select it from the list, modify the settings, and click "Replace Format".</Text> 1218 <Text id="411">For more information about variables and the feature components, read Chapter 2 of the Greenstone Developer's Guide.</Text> 1219 <Text id="412">If the "Allow Extended Options" checkbox is ticked, some advanced formatting options are enabled. The list of features that can be formatted is changed slightly, and more variables are available to be used in the format command, providing greater control over the page layout.</Text> 1220 </Content> 1221 </Part> 1222 <Part id="translate_text"> 1223 <Title> 1224 <Text id="413">Translate Text</Text> 1225 </Title> 1226 <Content> 1227 <Text id="414">This section describes the translation view, where you can define language-specific text fragments for parts of the collection's interface. Under "Design Sections", click "Translate Text".</Text> 1228 <Text id="415">First choose an entry from the "Features" list. The language-specific strings associated with this feature appear below. Use the "Language of translation" pull-down list to select the target language, and type the translated text into the text area, referring to the "Initial Text Fragment" if necessary. Click "Add Translation" when finished.</Text> 1229 <Text id="416">To remove an existing translation, select it in the "Assigned Translations" table and click "Remove Translation".</Text> 1230 <Text id="417">To edit a translation, select it, edit it in the "Translated Text" text area, and click "Replace Translation".</Text> 1231 </Content> 1232 </Part> 1233 <Part id="metadata_sets"> 1234 <Title> 1235 <Text id="418">Metadata Sets</Text> 1236 </Title> 1237 <Content> 1238 <Text id="419">This section explains the metadata set review panel. Under "Design Sections", click "Metadata Sets".</Text> 1239 <Text id="420">This view is used to review the metadata sets that the collection uses, and the elements that are available within each set. Choose from the list of "Available Metadata Sets" in order to see details of their elements.</Text> 1240 <Text id="421">To use another metadata set with the loaded collection, click "Add Metadata Set" and select the metadata set file (.mds) for the new metadata set.</Text> 1241 <Text id="422">Editing metadata sets is done with the Greenstone Editor for Metadata Sets (GEMS). Clicking the "Edit Metadata Set" button provides information on how to run the GEMS.</Text> 1242 <Text id="423">If you no longer need a metadata set, select it and press "Remove Metadata Set" to remove it. If you have assigned any metadata to elements in the removed set you will be asked how to deal with this metadata when you next open the collection.</Text> 1243 </Content> 1244 </Part> 1245 </Content> 1246 </Subsection> 1247 <Subsection id="producing_your_collection"> 1248 <Title> 1249 <Text id="424">Producing Your Collection</Text> 1250 </Title> 1251 <Content> 1252 <Text id="425">Having collected the documents for the collection, annotated them with metadata, and designed how the collection will appear, you can now produce the collection using Greenstone. This section explains how.</Text> 1253 <Part id="the_create_view"> 1254 <Title> 1255 <Text id="426">The Create View</Text> 1256 </Title> 1257 <Content> 1258 <Text id="427">The Create view is used to create the collection by running Greenstone collection-building scripts on the information you have provided. Clicking "Build Collection" initiates the collection building process. The time this takes depends on the size of the collection and the number of indexes being created (for huge collections it can be hours). A progress bar indicates how much of the process has been completed. To cancel the process at any time, click "Cancel Build".</Text> 1259 <Text id="428">Once the collection has successfully built, clicking "Preview Collection" will launch a web browser showing the home page of the collection.</Text> 1260 <Text id="429">In Expert mode, you can use the "Message Log" entry at the left to review previous attempts to build the collection, whether successful or not. Select the log you want by clicking on the desired date in the "Log History" list.</Text> 1261 </Content> 1262 </Part> 1263 <Part id="import_and_build_settings"> 1264 <Title> 1265 <Text id="430">Import and Build Settings</Text> 1266 </Title> 1267 <Content> 1268 <Text id="431">This section explains how to access the various import and build settings. For more information of importing and building read Chapter 1 of the Greenstone Developer's Guide -- Understanding the collection-building process.</Text> 1269 <Text id="432">Controlling the various settings is done in a similar way to the "Configuring Arguments" window described in the Document Plugins section. Some fields require numeric arguments, and you can either type these in or use the up and down arrows to increase or decrease the current value (in some cases, the interface restricts the range you can enter). Others are enabled by clicking a checkbox (click again to disable).</Text> 1270 </Content> 1271 </Part> 1272 </Content> 1273 </Subsection> 1274 <Subsection id="miscellaneous"> 1275 <Title> 1276 <Text id="433">Miscellaneous</Text> 1277 </Title> 1278 <Content> 1279 <Text id="434">This section describes features of the Librarian Interface that are not associated with any particular view.</Text> 1280 <Part id="preferences"> 1281 <Title> 1282 <Text id="435">Preferences</Text> 1283 </Title> 1284 <Content> 1285 <Text id="436">This section explains the preferences dialog, accessed by opening "File" -> "Preferences".</Text> 1286 <Text id="437">The first "General" option is a text field for entering your e-mail address. This will be used for the "creator" and "maintainer" collection metadata items. The next option is a pull-down list of the languages in which the Librarian Interface can be presented. If you change the dictionary by choosing one from the list, you must restart the Librarian Interface in order to load the new language strings from the dictionary.</Text> 1287 <Text id="438">If "View Extracted Metadata" is checked, the various controls dealing with metadata always show all metadata that has been extracted automatically from documents. Deselecting it hides this metadata (although it is still available during collection design, and within the final Greenstone collection). If "Show file sizes" is checked, the file size is shown next to each file in the Workspace and Collection file trees in the Gather and Enrich views.</Text> 1288 <Text id="439">The "Mode" panel is used to control the level of detail within the interface. At its lowest setting, "Library Assistant", the design view is disabled, arguments requiring regular expressions are hidden and the collection building produces a minimal log of events. In contrast the highest setting, "Expert", provides access to all of the features of design, including plugin positioning and regular expression arguments, and also allows the full output from the collection building to be recorded in the logs. To change or review modes, click the radio button next to the mode you are interested in. You can quickly review what mode you are in by looking at the Librarian Interface's title bar.</Text> 1289 <Text id="440">The Librarian Interface can support different workflows by determining which of the various view tabs are visible. Use the "Workflow" tab to customise what views are available by checking the boxes next to the views that you want to be available. Alternatively, use the pull-down list at the bottom to select predetermined configurations. Closing the preferences dialog establishes these workflow settings. These settings are stored with the collection, not in the Librarian Interface configuration file.</Text> 1290 <Text id="441">The "Connection" tab lets you alter the path to the locally-running Greenstone library server, which is used when Previewing collections. It also lets you set proxy information for connecting to the Internet (e.g. when downloading files; see the Downloading Files From the Internet section for details). Check the box to enable proxy connection and supply details of the proxy host address and port number. The proxy connection is established when you close the Preferences dialog.</Text> 1291 <Text id="442">During the course of a session the Librarian Interface may give warning messages which inform you of possibly unforeseen consequences of an action. You can disable the messages by checking the "Do not show this warning again" box. You can re-enable warning messages using the "Warnings" tab. Check the box next to warning messages you want to see again.</Text> 1292 </Content> 1293 </Part> 1294 <Part id="file_associations"> 1295 <Title> 1296 <Text id="443">File Associations</Text> 1297 </Title> 1298 <Content> 1299 <Text id="444">The Librarian Interface uses particular application programs to open particular file types. To alter file associations open the "File" menu and click "File Associations...".</Text> 1300 <Text id="445">To add an association, select the target file extension from the pull-down list, or type in a new extension (do not include the "."). Next either type command that launches the desired application in the appropriate field, or choose the application from the "Browse" dialog. "%1" can be used in the launch command to insert the name of the file being opened. Once these are filled out, "Add" is enabled and can be clicked to add the association.</Text> 1301 <Text id="446">To edit an association, select an existing file extension. Any existing associated command is shown in the launch command field. Edit it, and then click "Replace".</Text> 1302 <Text id="447">To remove an association, select an existing file extension and click "Remove". (The file extension remains in the "For Files Ending" pull-down list.)</Text> 1303 <Text id="448">File associations are stored in the Librarian Interface's main folder, in a file called "associations.xml".</Text> 1304 </Content> 1305 </Part> 1306 <Part id="exporting_collections_to_cddvd"> 1307 <Title> 1308 <Text id="449">Exporting Collections to CD/DVD</Text> 1309 </Title> 1310 <Content> 1311 <Text id="450">Greenstone can export one or more collections to a self-installing CD/DVD for Windows. To do so, Greenstone's "Export to CD-ROM" package must be installed. This is not included by default, so you may need to modify your installation to include it.</Text> 1312 <Text id="451">To export a collection, open the "File" menu and choose "Write CD/DVD Image". A list of Greenstone collections appears; click on any one to see its description. Tick the check boxes of the collections to export. You can enter the CD/DVD's name in the box: this is what will appear in the Start menu when the CD/DVD has been installed. Then click "Export". The process involves copying many files and may take a few minutes.</Text> 1313 <Text id="452">Upon completion, Greenstone will show the name of a folder containing the exported collections. Use a CD/DVD writer to copy its contents to a blank CD/DVD.</Text> 1314 </Content> 1315 </Part> 1316 </Content> 1317 </Subsection> 860 &chap_gli; 1318 861 </Content> 1319 862 </Section> … … 1385 928 </Title> 1386 929 <Content> 1387 <Text id="468">The Collector is a facility that helps you create new collections, modify or add to existing ones, or delete collections. To do this you will be guided through a sequence of web pages which request the information that is needed. The sequence is self-explanatory: this section takes you through it. As an alternative to using the Collector, you can also build collections from the command lineâthe first few pages of the Developer's Guide give a detailed walk-through of how to do this. The Collector predates the librarian interface described in Section 3.1, and for most practical purposes the librarian interface should be used instead of the Collector.</Text>930 <Text id="468">The Collector is a facility that helps you create new collections, modify or add to existing ones, or delete collections. To do this you will be guided through a sequence of web pages which request the information that is needed. The sequence is self-explanatory: this section takes you through it. As an alternative to using the Collector, you can also build collections from the command lineâthe first few pages of the Developer's Guide give a detailed walk-through of how to do this. The Collector predates the librarian interface described in Section <CrossRef target="Section" ref="the_librarian_interface"/>, and for most practical purposes the librarian interface should be used instead of the Collector.</Text> 1388 931 <Text id="469">Building and distributing information collections carries responsibilities that you should reflect on before you begin. There are legal issues of copyright: being able to access documents doesn't mean you can necessarily give them to others. There are social issues: collections should respect the customs of the community out of which the documents arise. And there are ethical issues: some things simply should not be made available to others. The pen is mightier than the sword!âbe sensitive to the power of information and use it wisely.</Text> 1389 932 <Text id="470">To access the Collector, click the appropriate link on the digital library home page.</Text> … … 1410 953 </NumberedItem> 1411 954 </NumberedList> 1412 <Text id="479">Figure 16 shows the Collector being used to create a new collection, in this case from a set of html files stored locally. You must first decide whether to work with an existing collection or build a new one. The former case covers options 1 and 2 above; the latter covers options 3â6. In Figure 16a, the user opts to create a new collection.</Text>955 <Text id="479">Figure <CrossRef target="Figure" ref="using_the_collector_to_build_a_new_collection"/> shows the Collector being used to create a new collection, in this case from a set of html files stored locally. You must first decide whether to work with an existing collection or build a new one. The former case covers options 1 and 2 above; the latter covers options 3â6. In Figure <CrossRef target="Figure" ref="using_the_collector_to_build_a_new_collection"/>, the user opts to create a new collection.</Text> 1413 956 <Figure id="using_the_collector_to_build_a_new_collection"> 1414 957 <Title> … … 1442 985 <File width="369" height="435" url="images/User_Fig_16b.png"/> 1443 986 </Figure> 1444 <Text id="487">Upon completion of login, the page in Figure 16bappears. This shows the sequence of steps that are involved in collection building. They are:</Text>987 <Text id="487">Upon completion of login, the page in Figure <CrossRef target="Figure" ref="using_the_collector_to_build_a_new_collection_1"/> appears. This shows the sequence of steps that are involved in collection building. They are:</Text> 1445 988 <NumberedList> 1446 989 <NumberedItem> … … 1461 1004 </NumberedList> 1462 1005 <Text id="493">The first step is to specify the collection's name and associated information. The second is to say where the source data is to come from. The third is to adjust the configuration options, a step that becomes more useful as you gain experience with Greenstone. The fourth step is where all the (computer's) work is done. During the âbuildingâ process the system makes all the indexes and gathers together any other information that is required to make the collection operate. The fifth step is to view the collection that has been created.</Text> 1463 <Text id="494">These five steps are displayed as a linear sequence of gray buttons at the bottom of the screen in Figure 16b, and at the bottom of all other pages generated by the Collector. This display helps users keep track of where they are in the process. The button that should be clicked to continue the sequence is shown in green (<i>collection information</i> in Figure 16b). The gray buttons (all the others, in Figure 16b) are inactive. The buttons change to yellow as you proceed through the sequence, and the user can return to an earlier step by clicking the corresponding yellow button in the diagram. This display is modeled after the âwizardsâ that are widely used in commercial software to guide users through the steps involved in installing new software.</Text>1006 <Text id="494">These five steps are displayed as a linear sequence of gray buttons at the bottom of the screen in Figure <CrossRef target="Figure" ref="using_the_collector_to_build_a_new_collection_1"/>, and at the bottom of all other pages generated by the Collector. This display helps users keep track of where they are in the process. The button that should be clicked to continue the sequence is shown in green (<i>collection information</i> in Figure <CrossRef target="Figure" ref="using_the_collector_to_build_a_new_collection_1"/>). The gray buttons (all the others, in Figure <CrossRef target="Figure" ref="using_the_collector_to_build_a_new_collection_1"/>) are inactive. The buttons change to yellow as you proceed through the sequence, and the user can return to an earlier step by clicking the corresponding yellow button in the diagram. This display is modeled after the âwizardsâ that are widely used in commercial software to guide users through the steps involved in installing new software.</Text> 1464 1007 </Content> 1465 1008 </Subsection> … … 1478 1021 <File width="369" height="504" url="images/User_Fig_16c.png"/> 1479 1022 </Figure> 1480 <Text id="498">The next step in the sequence, collection information, is shown in Figure 16c. When creating a new collection, it is necessary to enter some information about it:</Text>1023 <Text id="498">The next step in the sequence, collection information, is shown in Figure <CrossRef target="Figure" ref="using_the_collector_to_build_a_new_collection_2"/>. When creating a new collection, it is necessary to enter some information about it:</Text> 1481 1024 <BulletList> 1482 1025 <Bullet> … … 1491 1034 </BulletList> 1492 1035 <Text id="502">The collection title is a short phrase used through the digital library to identify the content of the collection. Example titles include <i>Food and Nutrition Library</i>, <i>World Environmental Library</i>, <i>Development Library</i>, and so on. The E-mail address specifies the first point of contact for any problems encountered with the collection. If the Greenstone software detects a problem, a diagnostic report may be sent to this address. Finally, the brief description is a statement describing the principles that govern what is included in the collection. It appears under the heading <i>About this collection</i> on the first page when the collection is presented.</Text> 1493 <Text id="503">The user's current position in the collection-building sequence is indicated by an arrow that appears in the display at the bottom of each screenâin this case, as Figure 16c shows, the collection information stage. The user proceeds to Figure 16dby clicking the green source data button.</Text>1036 <Text id="503">The user's current position in the collection-building sequence is indicated by an arrow that appears in the display at the bottom of each screenâin this case, as Figure <CrossRef target="Figure" ref="using_the_collector_to_build_a_new_collection_2"/> shows, the collection information stage. The user proceeds to Figure <CrossRef target="Figure" ref="using_the_collector_to_build_a_new_collection_3"/> by clicking the green source data button.</Text> 1494 1037 </Content> 1495 1038 </Subsection> … … 1508 1051 <File width="368" height="532" url="images/User_Fig_16d.png"/> 1509 1052 </Figure> 1510 <Text id="507">Figure 16dis the point where the user specifies the source text that comprises the collection. You may either base your collection on a default structure that is provided, or on the structure of an existing collection.</Text>1053 <Text id="507">Figure <CrossRef target="Figure" ref="using_the_collector_to_build_a_new_collection_3"/> is the point where the user specifies the source text that comprises the collection. You may either base your collection on a default structure that is provided, or on the structure of an existing collection.</Text> 1511 1054 <Text id="508">If you opt for the default structure, the new collection may contain html documents (files ending in <i>.htm, .html</i>), or plain text documents (files ending in <i>.txt, .text</i>), Microsoft Word documents (files ending in <i>.doc</i>), PDF documents (files ending in <i>.pdf</i>) or E-mail documents (files ending in <i>.email</i>). More information about the different document formats that can be accommodated is given in the section on âDocument formatsâ below.</Text> 1512 1055 <Text id="509">If you base your new collection on an existing one, the files in the new collection must be exactly the same type as those used to build the existing one. Note that some collections use non-standard input file formats, while others use metadata specified in auxiliary files. If your new input lacks this information, some browsing facilities may not work properly. For example, if you clone the Demo collection you may find that the <i>subjects</i>, <i>organization</i>, and <i>how to</i> buttons don't work.</Text> 1513 <Text id="510">Boxes are provided to indicate where the source documents are located: up to three separate input sources can be specified in Figure 16d. If you need more, just click the button marked âmore sources.â</Text>1056 <Text id="510">Boxes are provided to indicate where the source documents are located: up to three separate input sources can be specified in Figure <CrossRef target="Figure" ref="using_the_collector_to_build_a_new_collection_3"/>. If you need more, just click the button marked âmore sources.â</Text> 1514 1057 <Text id="511">There are three kinds of specification:</Text> 1515 1058 <BulletList> … … 1528 1071 <Text id="517">If you use <i>file://</i> or <i>ftp://</i> to specify a folder or directory, or give a <i>http://</i> URL that leads to a list of files, everything in the folder and all its subfolders will be included in the collection.</Text> 1529 1072 <Text id="518">You can specify sources of more than one type.</Text> 1530 <Text id="519">In this case (Figure 16d) the new collection will contain documents taken from a local file system as well as a remote web site, which will be mirrored during the building process.</Text>1531 <Text id="520">When you click the <i>configure collection</i> button to proceed to the next stage of building, the Collector checks that all the sources of input you specified can be reached. This might take a few seconds, or even a few minutes if you have specified several sources. If one or more of the input sources you specified is unavailable, you will be presented with a page like that in Figure 16e, where the unavailable sources are marked (both of them in this case).</Text>1073 <Text id="519">In this case (Figure <CrossRef target="Figure" ref="using_the_collector_to_build_a_new_collection_3"/>) the new collection will contain documents taken from a local file system as well as a remote web site, which will be mirrored during the building process.</Text> 1074 <Text id="520">When you click the <i>configure collection</i> button to proceed to the next stage of building, the Collector checks that all the sources of input you specified can be reached. This might take a few seconds, or even a few minutes if you have specified several sources. If one or more of the input sources you specified is unavailable, you will be presented with a page like that in Figure <CrossRef target="Figure" ref="using_the_collector_to_build_a_new_collection_4"/>, where the unavailable sources are marked (both of them in this case).</Text> 1532 1075 <Figure id="using_the_collector_to_build_a_new_collection_4"> 1533 1076 <Title> … … 1568 1111 <File width="369" height="467" url="images/User_Fig_16f.png"/> 1569 1112 </Figure> 1570 <Text id="531">Figure 16f shows the next stage. The construction and presentation of all collections is controlled by specifications in a special collection configuration file (see below). Advanced users may use this page to alter the configuration settings. Most, however, will proceed directly to the final stage. Indeed, in Figure 16dboth the <i>configure collection</i> and the <i>build collection</i> buttons are displayed in green, signifying that step 3 can be bypassed completely.</Text>1113 <Text id="531">Figure <CrossRef target="Figure" ref="using_the_collector_to_build_a_new_collection_5"/> shows the next stage. The construction and presentation of all collections is controlled by specifications in a special collection configuration file (see below). Advanced users may use this page to alter the configuration settings. Most, however, will proceed directly to the final stage. Indeed, in Figure <CrossRef target="Figure" ref="using_the_collector_to_build_a_new_collection_3"/> both the <i>configure collection</i> and the <i>build collection</i> buttons are displayed in green, signifying that step 3 can be bypassed completely.</Text> 1571 1114 <Text id="532">In our example the user has made a small modification to the default configuration file by including the <i>file_is_url</i> flag with the html plugin. This flag causes URL metadata to be inserted in each document, based on the filename convention that is adopted by the mirroring package. This metadata is used in the collection to allow readers to refer to the original source material, rather than to a local copy.</Text> 1572 1115 </Content> … … 1586 1129 <File width="369" height="304" url="images/User_Fig_16g.png"/> 1587 1130 </Figure> 1588 <Text id="536">Figure 16gshows the âbuildingâ stage. Up until now, the responses to the dialog have merely been recorded in a temporary file. The building stage is where the action takes place.</Text>1131 <Text id="536">Figure <CrossRef target="Figure" ref="using_the_collector_to_build_a_new_collection_6"/> shows the âbuildingâ stage. Up until now, the responses to the dialog have merely been recorded in a temporary file. The building stage is where the action takes place.</Text> 1589 1132 <Text id="537">During building, indexes for both browsing and searching are constructed according to instructions in the collection configuration file. The building process takes some time: minutes to hours, depending on the size of the collection and the speed of your computer. Some very large collections take a day or more to build.</Text> 1590 <Text id="538">When you reach this stage in the interaction, a status line at the bottom of the web page gives feedback on how the operation is progressing, updated every five seconds. The message visible in Figure 16findicates that when the snapshot was taken, Title metadata was being extracted from an input file.</Text>1133 <Text id="538">When you reach this stage in the interaction, a status line at the bottom of the web page gives feedback on how the operation is progressing, updated every five seconds. The message visible in Figure <CrossRef target="Figure" ref="using_the_collector_to_build_a_new_collection_5"/> indicates that when the snapshot was taken, Title metadata was being extracted from an input file.</Text> 1591 1134 <Text id="539">Warnings are written if input files or URLs are requested that do not exist, or exist but there is no plugin that can process them, or the plugin cannot find an associated file, such as an image file embedded in a html document. The intention is that you will monitor progress by keeping this window open in your browser. If any errors cause the process to terminate, they are recorded in this status area.</Text> 1592 <Text id="540">You can stop the building process at any time by clicking on the <i>stop building</i> button in Figure 16g. If you leave the web page (and have not cancelled the building process with the <i>stop building</i> button), the building operation will continue, and the new collection will be installed when the operation completes.</Text>1135 <Text id="540">You can stop the building process at any time by clicking on the <i>stop building</i> button in Figure <CrossRef target="Figure" ref="using_the_collector_to_build_a_new_collection_6"/>. If you leave the web page (and have not cancelled the building process with the <i>stop building</i> button), the building operation will continue, and the new collection will be installed when the operation completes.</Text> 1593 1136 </Content> 1594 1137 </Subsection> … … 1598 1141 </Title> 1599 1142 <Content> 1600 <Text id="542">When the collection is built and installed, the sequence of buttons visible at the bottom of Figures 16bâf appears at the bottom of Figure 16g, with the View collection button active. This takes the user directly to the newly built collection.</Text>1143 <Text id="542">When the collection is built and installed, the sequence of buttons visible at the bottom of Figures <CrossRef target="Figure" ref="using_the_collector_to_build_a_new_collection_1"/>â<CrossRef target="Figure" ref="using_the_collector_to_build_a_new_collection_5"/> appears at the bottom of Figure <CrossRef target="Figure" ref="using_the_collector_to_build_a_new_collection_6"/>, with the View collection button active. This takes the user directly to the newly built collection.</Text> 1601 1144 <Text id="543">Finally, there is a facility for E-mail to be sent to the collection's contact E-mail address, and to the system's administrator, whenever a collection is created (or modified.) This allows those responsible to check when changes occur, and monitor what is happening on the system. The facility is disabled by default but can be enabled by editing the <i>main.cfg</i> configuration file (see the <i>Greenstone Digital Library Developer's Guide</i>, Section <CrossRef target="Chapter" external="Develop" lang="en" ref="configuring_your_greenstone_site"/>).</Text> 1602 1145 </Content> … … 1737 1280 <Content> 1738 1281 <Text id="582">An âadministrativeâ facility is included with every Greenstone installation.To access this facility, click the appropriate link on the front page.</Text> 1739 <Text id="583">The entry page, shown in Figure 17, gives information about each of the collections offered by the system. Note that <i>all</i> collections are includedâfor there may be âprivateâ ones that do not appear on the Greenstone home page. With each is given its short name, full name, whether it is publicly displayed, and whether or not it is running. Clicking a particular collection's abbreviation (the first column of links in Figure 17) brings up information about that collection, gathered from its collection configuration file and from other internal structures created for that collection. If the collection is both public and running, clicking the collection's full name (the second link) takes you to the collection itself.</Text>1740 <Text id="584">A collection named <i>wohiex</i>, for <i>Women's History Excerpt</i>, is visible near the bottom of Figure 17. Figure 18shows the information that is displayed when this link is clicked. The first section gives some information from the configuration file, and the size of the collection (about 1000 documents, about a million words, over 6 Mb). The next sections contain internal information related to the communication protocol through which collections are accessed. For example, the filter options for âQueryFilterâ show the options and possible values that can be used when querying the collection.</Text>1741 <Text id="585">The administrative facility also presents configuration information about the installation and allows it to be modified. It facilitates examination of the error logs that record internal errors, and the user logs that record usage. It enables a specified user (or users) to authorize others to build collections and add new material to existing ones. All these facilities are accessed interactively from the menu items at the left-hand side of Figure 17.</Text>1282 <Text id="583">The entry page, shown in Figure <CrossRef target="Figure" ref="greenstone_administration_facility"/>, gives information about each of the collections offered by the system. Note that <i>all</i> collections are includedâfor there may be âprivateâ ones that do not appear on the Greenstone home page. With each is given its short name, full name, whether it is publicly displayed, and whether or not it is running. Clicking a particular collection's abbreviation (the first column of links in Figure <CrossRef target="Figure" ref="greenstone_administration_facility"/>) brings up information about that collection, gathered from its collection configuration file and from other internal structures created for that collection. If the collection is both public and running, clicking the collection's full name (the second link) takes you to the collection itself.</Text> 1283 <Text id="584">A collection named <i>wohiex</i>, for <i>Women's History Excerpt</i>, is visible near the bottom of Figure <CrossRef target="Figure" ref="greenstone_administration_facility"/>. Figure <CrossRef target="Figure" ref="information_about_the_womens_history_excerpt_collection"/> shows the information that is displayed when this link is clicked. The first section gives some information from the configuration file, and the size of the collection (about 1000 documents, about a million words, over 6 Mb). The next sections contain internal information related to the communication protocol through which collections are accessed. For example, the filter options for âQueryFilterâ show the options and possible values that can be used when querying the collection.</Text> 1284 <Text id="585">The administrative facility also presents configuration information about the installation and allows it to be modified. It facilitates examination of the error logs that record internal errors, and the user logs that record usage. It enables a specified user (or users) to authorize others to build collections and add new material to existing ones. All these facilities are accessed interactively from the menu items at the left-hand side of Figure <CrossRef target="Figure" ref="greenstone_administration_facility"/>.</Text> 1742 1285 <Figure id="greenstone_administration_facility"> 1743 1286 <Title> … … 1779 1322 <CodeLine>(d) âMozilla/4.08 [en] (Win95; I ;Nav)â</CodeLine> 1780 1323 <Text id="597">The last CGI argument, âzâ, is an identification code or âcookieâ generated by the user's browser: it comprises the user's IP number followed by the timestamp when they first accessed the digital library.</Text> 1781 <Text id="598">The log file <i>usage.txt</i> is placed in the <i>etc</i> directoryin the Greenstone file structure (see the <i>Greenstone Digital Library Developer's Guide</i>).When logging is enabled, every action by every user is logged. However, only the last 100 entries in the log file are displayed by the <i>usage log</i> link in Figure 17.</Text>1324 <Text id="598">The log file <i>usage.txt</i> is placed in the <i>etc</i> directoryin the Greenstone file structure (see the <i>Greenstone Digital Library Developer's Guide</i>).When logging is enabled, every action by every user is logged. However, only the last 100 entries in the log file are displayed by the <i>usage log</i> link in Figure <CrossRef target="Figure" ref="greenstone_administration_facility"/>.</Text> 1782 1325 </Content> 1783 1326 </Section> … … 1787 1330 </Title> 1788 1331 <Content> 1789 <Text id="600">Greenstone incorporates an authentication scheme which can be used to control access to certain facilities. At the moment this is only used to restrict the people who are allowed to enter the Collectorand certain administration functions. If, for a particular collection, it were necessary to authenticate users before returning information to them, this is possible tooâfor example, documents could be protected on an individual basis so that they can only be accessed by registered users on presentation of a password. However, no current collections use this facility). Authentication is done by requesting a user name and password, as illustrated in Figure 16a.</Text>1332 <Text id="600">Greenstone incorporates an authentication scheme which can be used to control access to certain facilities. At the moment this is only used to restrict the people who are allowed to enter the Collectorand certain administration functions. If, for a particular collection, it were necessary to authenticate users before returning information to them, this is possible tooâfor example, documents could be protected on an individual basis so that they can only be accessed by registered users on presentation of a password. However, no current collections use this facility). Authentication is done by requesting a user name and password, as illustrated in Figure <CrossRef target="Figure" ref="using_the_collector_to_build_a_new_collection"/>.</Text> 1790 1333 <Text id="601">From the administration page users can be listed, new ones added, and old ones deleted. The ability to do this is of course also protected: only users who have administrative privileges can add new users. It is also possible for each user to belong to different âgroupsâ. At present, the only extant groups are âadministratorâ and âcolbuilderâ. Members of the first group can add and remove users, and change their groups. Members of the second can access the facilities described above to build new collections and alter (and delete) existing ones.</Text> 1791 1334 <Text id="602">When Greenstone is installed, there is one user called <i>admin</i> who belongs to both groups. The password for this user is set during the installation process. This user can create new names and passwords for users who belong just to the <i>colbuilder</i> group, which is the recommended way of giving other users the ability to build collections. User information is recorded in two databases that are placed in the Greenstone file structure (see the <i>Greenstone Digital Library Developer's Guide</i>).</Text>
Note:
See TracChangeset
for help on using the changeset viewer.
