legacy:manuals:en:user:making_greenstone_collections
Differences
This shows you the differences between two versions of the page.
Next revision | Previous revision | ||
legacy:manuals:en:user:making_greenstone_collections [2013/10/16 22:44] – external edit 127.0.0.1 | legacy:manuals:en:user:making_greenstone_collections [2023/03/13 01:46] (current) – external edit 127.0.0.1 | ||
---|---|---|---|
Line 1: | Line 1: | ||
- | ====== <!-- id:153 --> | ||
- | <!-- id:154 -->The simplest way to build new collections is to use Greenstone' | ||
- | - <!-- id:155 -->Copy documents from the computer' | ||
- | - <!-- id:156 --> | ||
- | - <!-- id:157 --> | ||
- | - <!-- id:158 -->Build the collection using Greenstone. | ||
- | - <!-- id:159 --> | ||
- | <!-- id:160 -->The librarian interface allows you to add what people call “external” metadata to documents, metadata that pertains to the document as a whole. But documents often need to be structured into sections and subsections, | + | ====== Making |
- | <!-- id:161 --> | + | The simplest |
- | <!-- id: | + | |
+ | | ||
+ | - Design the collection by determining its appearance and the access facilities that it will support. | ||
+ | - Build the collection using Greenstone. | ||
+ | - Preview the newly created collection, which will have been installed on your Greenstone home page as one of the regular collections. | ||
- | ===== <!-- id:163 -->The librarian' | + | The librarian interface |
- | <!-- id:164 -->To convey | + | Finally, an alternative way of building collections is provided by the Collector, which helps you create new collections, modify or add to existing ones, or delete collections. It predates |
- | < | + | To harness the full power of Greenstone to build advanced collections, |
- | ==== <!-- id:166 --> | + | ===== The librarian' |
- | <!-- id:167 -->Launch the librarian interface under Windows by selecting // | + | To convey the operation of Greenstone' |
+ | |||
+ | 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 ' | ||
+ | |||
+ | ==== Getting started ==== | ||
+ | |||
+ | Launch the librarian interface under Windows by selecting // | ||
< | < | ||
Line 31: | Line 34: | ||
</ | </ | ||
- | <!-- id:168 -->where //~/gsdl// is the directory containing your Greenstone system. To begin, you must either open an existing collection or start a new one. Figure <imgref figure_starting_a_new_collection> | + | where //~/gsdl// is the directory containing your Greenstone system. To begin, you must either open an existing collection or start a new one. Figure <imgref figure_starting_a_new_collection> |
- | <!-- id:169 -->The brief description is a statement describing the principles that govern what is included in the collection. It appears under the heading //About this collection// | + | The brief description is a statement describing the principles that govern what is included in the collection. It appears under the heading //About this collection// |
< | < | ||
Line 41: | Line 44: | ||
{{..: | {{..: | ||
- | <!-- 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 <imgref figure_starting_a_new_collection> | + | 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 <imgref figure_starting_a_new_collection> |
- | <!-- id:173 -->The DLS metadata set contains these items: | + | The DLS metadata set contains these items: |
- | * <!-- id:174 -->Title | + | * Title |
- | * <!-- id:175 -->Subject | + | * Subject |
- | * <!-- id:176 -->Language | + | * Language |
- | * <!-- id:177 -->Organization | + | * Organization |
- | * <!-- id:178 -->Keyword (i.e.”Howto”). | + | * Keyword (i.e.”Howto”). |
- | <!-- id:179 -->(There is, in addition, a metadata item called //AZList// which is used to determine which bucket of the alphabetic list contains the document' | + | (There is, in addition, a metadata item called //AZList// which is used to determine which bucket of the alphabetic list contains the document' |
- | <!-- id:180 -->If, instead, the user had chosen “New Collection” at this point, she would have been asked to select what metadata sets should be used in the new collection. Three standard sets are pre-supplied: | + | If, instead, the user had chosen “New Collection” at this point, she would have been asked to select what metadata sets should be used in the new collection. Three standard sets are pre-supplied: |
- | <!-- id:181 -->Several different metadata sets can be associated with the same collection; the system keeps them distinct (so that, for example, documents can have both a Dublin Core //Title// and a DLS //Title//). The different sets are clearly distinguished in the interface. Behind the scenes, metadata sets are represented in XML. | + | Several different metadata sets can be associated with the same collection; the system keeps them distinct (so that, for example, documents can have both a Dublin Core //Title// and a DLS //Title//). The different sets are clearly distinguished in the interface. Behind the scenes, metadata sets are represented in XML. |
- | ==== <!-- id:182 -->Assembling the source material ==== | + | ==== Assembling the source material ==== |
- | <!-- id:183 -->After clicking the //OK// button on the “new collection” popup, the remaining parts of the interface, which were grayed out before, become active. The //Gather// panel, selected by the eponymous tab near the top of Figure <imgref figure_starting_a_new_collection>, | + | After clicking the //OK// button on the “new collection” popup, the remaining parts of the interface, which were grayed out before, become active. The //Gather// panel, selected by the eponymous tab near the top of Figure <imgref figure_starting_a_new_collection>, |
- | <!-- id:184 -->Operations available at this stage include: | + | Operations available at this stage include: |
- | * <!-- id:185 -->Navigating the existing file structure hierarchy, and the one being created, in the usual way. | + | * Navigating the existing file structure hierarchy, and the one being created, in the usual way. |
- | * <!-- id:186 -->Dragging and dropping files into the new collection. | + | * Dragging and dropping files into the new collection. |
- | * <!-- id:187 -->Multiple selection of files. | + | * Multiple selection of files. |
- | * <!-- id:188 -->Dragging and dropping entire sub-hierarchies. | + | * Dragging and dropping entire sub-hierarchies. |
- | * <!-- id:189 -->Deleting documents from the nascent collection. | + | * Deleting documents from the nascent collection. |
- | * <!-- id:190 -->Creating new sub-hierarchies within the collection. | + | * Creating new sub-hierarchies within the collection. |
- | * <!-- id:191 -->Filtering the files that are visible, in both the local file system and the collection, based on predetermined groups or on standard file matching terms. | + | * Filtering the files that are visible, in both the local file system and the collection, based on predetermined groups or on standard file matching terms. |
- | * <!-- id:192 -->Invoking the appropriate program to display the contents of a selected file, by double-clicking it. | + | * Invoking the appropriate program to display the contents of a selected file, by double-clicking it. |
- | <!-- id:193 -->Care is taken to deal appropriately with name clashes when files of the same name in different parts of the computer' | + | Care is taken to deal appropriately with name clashes when files of the same name in different parts of the computer' |
- | <!-- id:194 -->In Figure <imgref figure_exploring_the_local_file_space> | + | In Figure <imgref figure_exploring_the_local_file_space> |
- | <!-- id:195 -->Existing collections are represented by a subdirectory on the left called “Greenstone Collections, | + | Existing collections are represented by a subdirectory on the left called “Greenstone Collections, |
- | <!-- 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. | + | 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. |
- | <!-- 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 <imgref figure_filtering_the_file_trees>, | + | 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 <imgref figure_filtering_the_file_trees>, |
- | ==== <!-- id:198 -->Enriching the documents ==== | + | ==== Enriching the documents ==== |
- | <!-- id:199 -->The next phase in collection building is to enrich the documents by adding metadata. The //Enrich// tab brings up a new panel of information (Figure <imgref figure_assigning_metadata_using_enrich_view> | + | The next phase in collection building is to enrich the documents by adding metadata. The //Enrich// tab brings up a new panel of information (Figure <imgref figure_assigning_metadata_using_enrich_view> |
- | <!-- 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' | + | 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' |
- | <!-- id:201 -->The //Enrich// 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' | + | The //Enrich// 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' |
< | < | ||
Line 102: | Line 105: | ||
{{..: | {{..: | ||
- | <!-- id:206 -->Metadata values can also be assigned to folders, in just the same way. Documents in these folders for which this metadata is unspecified inherit the metadata values. However, they can subsequently be overridden by supplying different ones for the document itself. | + | Metadata values can also be assigned to folders, in just the same way. Documents in these folders for which this metadata is unspecified inherit the metadata values. However, they can subsequently be overridden by supplying different ones for the document itself. |
- | <!-- id:207 -->Operations at this stage include: | + | Operations at this stage include: |
- | * <!-- id:208 -->Assigning new and existing metadata values to documents. | + | * Assigning new and existing metadata values to documents. |
- | * <!-- id:209 -->Assigning metadata to an individual document. | + | * Assigning metadata to an individual document. |
- | * <!-- id:210 -->Assigning metadata to a folder (this is inherited by all documentsin the folder, including those in nested folders). | + | * Assigning metadata to a folder (this is inherited by all documentsin the folder, including those in nested folders). |
- | * <!-- id:211 -->Assigning hierarchical metadata, whose structure can be dynamically updated if required. | + | * Assigning hierarchical metadata, whose structure can be dynamically updated if required. |
- | * <!-- id:212 -->Editing or updating assigned metadata. | + | * Editing or updating assigned metadata. |
- | * <!-- id:213 -->Reviewing the metadata assigned to a selection of files and directories. | + | * Reviewing the metadata assigned to a selection of files and directories. |
- | <!-- id:214 -->For our walkthrough example, in Figure <imgref figure_assigning_metadata_using_enrich_view> | + | For our walkthrough example, in Figure <imgref figure_assigning_metadata_using_enrich_view> |
- | <!-- 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 //Assigned Metadata// from the metadata sets menu, which brings up a popup window like that in Figure <imgref figure_viewing_all_metadata_for_selected_files> | + | 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 //Assigned Metadata// from the metadata sets menu, which brings up a popup window like that in Figure <imgref figure_viewing_all_metadata_for_selected_files> |
- | <!-- id:216 -->The panel in Figure <imgref figure_editing_the_metadata_set> | + | The panel in Figure <imgref figure_editing_the_metadata_set> |
< | < | ||
Line 131: | Line 134: | ||
{{..: | {{..: | ||
- | ==== <!-- sid: | + | ==== Designing the collection ==== |
- | <!-- id:222 -->The //Design// panel (Figures <imgref figure_designing_the_collection> | + | The //Design// panel (Figures <imgref figure_designing_the_collection> |
- | <!-- id:223 -->Operations include: | + | Operations include: |
- | * <!-- id:224 -->Reviewing and editing collection-level metadata such as title, author and public availability of the collection. | + | * Reviewing and editing collection-level metadata such as title, author and public availability of the collection. |
- | * <!-- id:225 -->Defining what full-text indexes are to be built. | + | * Defining what full-text indexes are to be built. |
- | * <!-- id:226 -->Creating sub-collections and having indexes built for them. | + | * Creating sub-collections and having indexes built for them. |
- | * <!-- id:227 -->Adding or removing support for predefined interface languages. | + | * Adding or removing support for predefined interface languages. |
- | * <!-- id:228 -->Constructing a list of plug-ins to be used, and their arguments. | + | * Constructing a list of plug-ins to be used, and their arguments. |
- | * <!-- id:229 -->Presenting the list to the user for review and modification. | + | * Presenting the list to the user for review and modification. |
- | * <!-- id:230 -->Configuring individual plug-ins. | + | * Configuring individual plug-ins. |
- | * <!-- id:231 -->Constructing a list of “classifiers, | + | * Constructing a list of “classifiers, |
- | * <!-- id:232 -->Assigning formatting strings to various controls within the collection, thus altering its appearance. | + | * Assigning formatting strings to various controls within the collection, thus altering its appearance. |
- | * <!-- id:233 -->Reviewing the metadata sets, and their elements, used in the collection. | + | * Reviewing the metadata sets, and their elements, used in the collection. |
- | <!-- id:234 -->In Figure <imgref figure_designing_the_collection> | + | In Figure <imgref figure_designing_the_collection> |
- | <!-- id:235 -->Plug-ins and classifiers have many different arguments or “options” that the user can supply. The dialog box in Figure <imgref figure_configuring_arguments_to_a_plug-in> | + | Plug-ins and classifiers have many different arguments or “options” that the user can supply. The dialog box in Figure <imgref figure_configuring_arguments_to_a_plug-in> |
< | < | ||
Line 158: | Line 161: | ||
{{..: | {{..: | ||
- | ==== <!-- id:238 -->Building the collection ==== | + | ==== Building the collection ==== |
- | <!-- id:239 -->The //Create// panel (Figure <imgref figure_getting_ready_to_create_new_collection> | + | The //Create// panel (Figure <imgref figure_getting_ready_to_create_new_collection> |
- | <!-- id:240 -->The user observes the building process though a window that shows not only the text output generated by Greenstone' | + | The user observes the building process though a window that shows not only the text output generated by Greenstone' |
- | <!-- id:241 -->Figure <imgref figure_getting_ready_to_create_new_collection> | + | Figure <imgref figure_getting_ready_to_create_new_collection> |
- | <!-- id:242 -->When satisfied with the arguments, the user clicks //Build Collection// | + | When satisfied with the arguments, the user clicks //Build Collection// |
- | ==== <!-- id:243 -->Previewing ==== | + | ==== Previewing ==== |
- | <!-- id:244 -->The //Preview Collection// | + | The //Preview Collection// |
- | ==== <!-- id:245 -->Help ==== | + | ==== Help ==== |
- | <!-- id:246 -->On-line help is always available, and is invoked using the //Help// 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, | + | On-line help is always available, and is invoked using the //Help// 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, |
- | ===== <!-- id:247 -->Librarian Interface user guide ===== | + | ===== Librarian Interface user guide ===== |
& | & | ||
- | ===== <!-- id:453 -->Tagging document files ===== | + | ===== Tagging document files ===== |
- | <!-- id:454 -->Source documents often need to be structured into sections and subsections, | + | Source documents often need to be structured into sections and subsections, |
- | <!-- id:455 -->The source documents from an OCR process are typically a set of word processor files, including images. If these are represented as MicrosoftWord files, they can be input into Greenstone using the Word plugin. Alternatively, | + | The source documents from an OCR process are typically a set of word processor files, including images. If these are represented as MicrosoftWord files, they can be input into Greenstone using the Word plugin. Alternatively, |
- | <!-- id:456 -->In either case, the hierarchical structure of a document may be indicated by inserting tags in the text as follows: | + | In either case, the hierarchical structure of a document may be indicated by inserting tags in the text as follows: |
< | < | ||
Line 191: | Line 194: | ||
< | < | ||
< | < | ||
- | <!-- id:457 -->< | + | < |
</ | </ | ||
--> | --> | ||
</ | </ | ||
- | <!-- id:458 -->//(text of section goes here)// | + | //(text of section goes here)// |
< | < | ||
Line 204: | Line 207: | ||
</ | </ | ||
- | <!-- id:459 -->The %!-- ... --% markers are used because they indicate comments in HTML; thus these section tags will not affect document formatting. You must include these markers around your section tags, even if the document you are working with is not HTML (e.g. if it's a Microsoft Word file). | + | The %!-- ... --% markers are used because they indicate comments in HTML; thus these section tags will not affect document formatting. You must include these markers around your section tags, even if the document you are working with is not HTML (e.g. if it's a Microsoft Word file). |
- | <!-- id:460 -->In the Description part (between the < | + | In the Description part (between the < |
- | <!-- id:461 -->It is important to remember that you are creating a hierarchical table of contents when you insert section tags into your document. This means that sections can be nested within other sections. In fact, all sections must be nested within a single enclosing section that encompasses the entire document. | + | It is important to remember that you are creating a hierarchical table of contents when you insert section tags into your document. This means that sections can be nested within other sections. In fact, all sections must be nested within a single enclosing section that encompasses the entire document. |
- | <!-- id:462 -->The following example demonstrates a document with two chapters, the second of which contains two subsections. For real examples of sourcedocuments tagged in this way, look at the source documents for the Demo or DLS collections. | + | The following example demonstrates a document with two chapters, the second of which contains two subsections. For real examples of sourcedocuments tagged in this way, look at the source documents for the Demo or DLS collections. |
< | < | ||
Line 223: | Line 226: | ||
</ | </ | ||
--> | --> | ||
- | <!-- id:463 -->(text of chapter 1 goes here) | + | (text of chapter 1 goes here) |
<!-- | <!-- | ||
</ | </ | ||
Line 235: | Line 238: | ||
</ | </ | ||
--> | --> | ||
- | <!-- id:464 -->(text of sub-section 1 goes here) | + | (text of sub-section 1 goes here) |
<!-- | <!-- | ||
</ | </ | ||
Line 243: | Line 246: | ||
</ | </ | ||
--> | --> | ||
- | <!-- id:465 -->(text of sub-section 2 goes here) | + | (text of sub-section 2 goes here) |
<!-- | <!-- | ||
</ | </ | ||
Line 251: | Line 254: | ||
</ | </ | ||
- | <!-- id:466 -->Note that metadata assigned from within a section tag in a source document takes precedence over that assigned to the document as a whole. This means that you should not explicitly specify Title metadata for the top-level section within a source document unless you want it to override the title you gave it when specifying metadata. In the above example, unless you want to override the document' | + | Note that metadata assigned from within a section tag in a source document takes precedence over that assigned to the document as a whole. This means that you should not explicitly specify Title metadata for the top-level section within a source document unless you want it to override the title you gave it when specifying metadata. In the above example, unless you want to override the document' |
< | < | ||
Line 257: | Line 260: | ||
</ | </ | ||
- | ===== <!-- id:467 -->The Collector ===== | + | ===== The Collector ===== |
- | <!-- id:468 -->The Collector is a facility that helps you create new collections, | + | The Collector is a facility that helps you create new collections, |
- | <!-- 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' | + | 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' |
- | <!-- id:470 -->To access the Collector, click the appropriate link on the digital library home page. | + | To access the Collector, click the appropriate link on the digital library home page. |
- | <!-- id:471 -->In Greenstone, the structure of a particular collection is determined when the collection is set up. This includes such things as the format of the source documents, how they should be displayed on the screen, the source of metadata, what browsing facilities should be provided, what full-text search indexes should be provided, and how the search results should be displayed. Once the collection is in place, it is easy to add new documents to it—so long as they have the same format as the existing documents, and the same type of metadata is provided, in exactly the same way. | + | In Greenstone, the structure of a particular collection is determined when the collection is set up. This includes such things as the format of the source documents, how they should be displayed on the screen, the source of metadata, what browsing facilities should be provided, what full-text search indexes should be provided, and how the search results should be displayed. Once the collection is in place, it is easy to add new documents to it—so long as they have the same format as the existing documents, and the same type of metadata is provided, in exactly the same way. |
- | <!-- id:472 -->The Collector has the following basic functions: | + | The Collector has the following basic functions: |
- | - <!-- id:473 -->create a new collection with the same structure as an existing one; | + | - create a new collection with the same structure as an existing one; |
- | - <!-- id:474 -->create a new collection with a different structure from existing ones; | + | - create a new collection with a different structure from existing ones; |
- | - <!-- id:475 -->add new material to an existing collection; | + | - add new material to an existing collection; |
- | - <!-- id:476 -->modify the structure of an existing collection; | + | - modify the structure of an existing collection; |
- | - <!-- id:477 -->delete a collection; and | + | - delete a collection; and |
- | - <!-- id:478 -->write an existing collection to a self-contained, | + | - write an existing collection to a self-contained, |
- | <!-- id:479 -->Figure <imgref figure_using_the_collector_to_build_a_new_collection> | + | Figure <imgref figure_using_the_collector_to_build_a_new_collection> |
< | < | ||
{{..: | {{..: | ||
- | ==== <!-- id:482 -->Logging in ==== | + | ==== Logging in ==== |
- | <!-- id:483 -->Either way it is necessary to log in before proceeding. Note that in general, people use their web browser to access the collection-building facility on a remote computer, and build the collection on that server. Of course, we cannot allow arbitrary people to build collections (for reasons of propriety if nothing else), so Greenstone contains a security system which forces people who want to build collections to log in first. This allows a central system to offer a service to those wishing to build information collections and use that server to make them available to others. Alternatively, | + | Either way it is necessary to log in before proceeding. Note that in general, people use their web browser to access the collection-building facility on a remote computer, and build the collection on that server. Of course, we cannot allow arbitrary people to build collections (for reasons of propriety if nothing else), so Greenstone contains a security system which forces people who want to build collections to log in first. This allows a central system to offer a service to those wishing to build information collections and use that server to make them available to others. Alternatively, |
- | ==== <!-- id:484 -->Dialog structure ==== | + | ==== Dialog structure ==== |
< | < | ||
{{..: | {{..: | ||
- | <!-- id:487 -->Upon completion of login, the page in Figure <imgref figure_using_the_collector_to_build_a_new_collection_1> | + | Upon completion of login, the page in Figure <imgref figure_using_the_collector_to_build_a_new_collection_1> |
- | - <!-- id:488 -->Collection information | + | - Collection information |
- | - <!-- id:489 -->Source data | + | - Source data |
- | - <!-- id:490 -->Configuring the collection | + | - Configuring the collection |
- | - <!-- id:491 -->Building the collection | + | - Building the collection |
- | - <!-- id:492 -->Viewing the collection. | + | - Viewing the collection. |
- | <!-- id:493 -->The first step is to specify the collection' | + | The first step is to specify the collection' |
- | <!-- id:494 -->These five steps are displayed as a linear sequence of gray buttons at the bottom of the screen in Figure <imgref figure_using_the_collector_to_build_a_new_collection_1>, | + | These five steps are displayed as a linear sequence of gray buttons at the bottom of the screen in Figure <imgref figure_using_the_collector_to_build_a_new_collection_1>, |
- | ==== <!-- id:495 -->Collection information ==== | + | ==== Collection information ==== |
< | < | ||
{{..: | {{..: | ||
- | <!-- id:498 -->The next step in the sequence, collection information, | + | The next step in the sequence, collection information, |
- | * <!-- id:499 -->title, | + | * title, |
- | * <!-- id:500 -->contact E-mail address, and | + | * contact E-mail address, and |
- | * <!-- id:501 -->brief description. | + | * brief description. |
- | <!-- id:502 -->The collection title is a short phrase used through the digital library to identify the content of the collection. Example titles include //Food and Nutrition Library//, //World Environmental Library//, // | + | The collection title is a short phrase used through the digital library to identify the content of the collection. Example titles include //Food and Nutrition Library//, //World Environmental Library//, // |
- | <!-- 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 <imgref figure_using_the_collector_to_build_a_new_collection_2> | + | 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 <imgref figure_using_the_collector_to_build_a_new_collection_2> |
- | ==== <!-- id:504 -->Source data ==== | + | ==== Source data ==== |
< | < | ||
{{..: | {{..: | ||
- | <!-- id:507 -->Figure <imgref figure_using_the_collector_to_build_a_new_collection_3> | + | Figure <imgref figure_using_the_collector_to_build_a_new_collection_3> |
- | <!-- id:508 -->If you opt for the default structure, the new collection may contain html documents (files ending in //.htm, .html//), or plain text documents (files ending in //.txt, .text//), Microsoft Word documents (files ending in //.doc//), PDF documents (files ending in //.pdf//) or E-mail documents (files ending in // | + | If you opt for the default structure, the new collection may contain html documents (files ending in //.htm, .html//), or plain text documents (files ending in //.txt, .text//), Microsoft Word documents (files ending in //.doc//), PDF documents (files ending in //.pdf//) or E-mail documents (files ending in // |
- | <!-- 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, | + | 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, |
- | <!-- id:510 -->Boxes are provided to indicate where the source documents are located: up to three separate input sources can be specified in Figure <imgref figure_using_the_collector_to_build_a_new_collection_3> | + | Boxes are provided to indicate where the source documents are located: up to three separate input sources can be specified in Figure <imgref figure_using_the_collector_to_build_a_new_collection_3> |
- | <!-- id:511 -->There are three kinds of specification: | + | There are three kinds of specification: |
- | * <!-- id:512 -->a directory name on the Greenstone server system (beginning with “file: | + | * a directory name on the Greenstone server system (beginning with “file: |
- | * <!-- id:513 -->an address beginning with “http: | + | * an address beginning with “http: |
- | * <!-- id:514 -->an address beginning with “ftp: | + | * an address beginning with “ftp: |
- | <!-- id:515 -->If you use // | + | If you use // |
- | <!-- id:516 -->If you use // | + | If you use // |
- | <!-- id:517 -->If you use // | + | If you use // |
- | <!-- id:518 -->You can specify sources of more than one type. | + | You can specify sources of more than one type. |
- | <!-- id:519 -->In this case (Figure <imgref figure_using_the_collector_to_build_a_new_collection_3> | + | In this case (Figure <imgref figure_using_the_collector_to_build_a_new_collection_3> |
- | <!-- id:520 -->When you click the //configure collection// | + | When you click the //configure collection// |
< | < | ||
{{..: | {{..: | ||
- | <!-- id:523 -->Sources might be unavailable because | + | Sources might be unavailable because |
- | * <!-- id:524 -->the file, FTP site or URL does not exist; | + | * the file, FTP site or URL does not exist; |
- | * <!-- id:525 -->you need to dial up your ISP first; | + | * you need to dial up your ISP first; |
- | * <!-- id:526 -->you are trying to access a URL from behind a firewall. | + | * you are trying to access a URL from behind a firewall. |
- | <!-- id:527 -->The last case is potentially the most mysterious. It occurs if you normally have to present a username and password to access the Internet Sometimes it happens that you can see the page from your Web browser if you enter the URL, but the Collector claims that it is unavailable. The explanation is that the page in your browser may be coming from a locally cached copy. Unfortunately, | + | The last case is potentially the most mysterious. It occurs if you normally have to present a username and password to access the Internet Sometimes it happens that you can see the page from your Web browser if you enter the URL, but the Collector claims that it is unavailable. The explanation is that the page in your browser may be coming from a locally cached copy. Unfortunately, |
- | ==== <!-- id:528 -->Configuring the collection ==== | + | ==== Configuring the collection ==== |
< | < | ||
{{..: | {{..: | ||
- | <!-- id:531 -->Figure <imgref figure_using_the_collector_to_build_a_new_collection_5> | + | Figure <imgref figure_using_the_collector_to_build_a_new_collection_5> |
- | <!-- id:532 -->In our example the user has made a small modification to the default configuration file by including the // | + | In our example the user has made a small modification to the default configuration file by including the // |
- | ==== <!-- id:533 -->Building the collection ==== | + | ==== Building the collection ==== |
< | < | ||
{{..: | {{..: | ||
- | <!-- id:536 -->Figure <imgref figure_using_the_collector_to_build_a_new_collection_6> | + | Figure <imgref figure_using_the_collector_to_build_a_new_collection_6> |
- | <!-- 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. | + | 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. |
- | <!-- id:538 -->When you reach this stage in the interaction, | + | When you reach this stage in the interaction, |
- | <!-- 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. | + | 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. |
- | <!-- id:540 -->You can stop the building process at any time by clicking on the //stop building// button in Figure <imgref figure_using_the_collector_to_build_a_new_collection_6> | + | You can stop the building process at any time by clicking on the //stop building// button in Figure <imgref figure_using_the_collector_to_build_a_new_collection_6> |
- | ==== <!-- id:541 -->Viewing the collection ==== | + | ==== Viewing the collection ==== |
- | <!-- id:542 -->When the collection is built and installed, the sequence of buttons visible at the bottom of Figures <imgref figure_using_the_collector_to_build_a_new_collection_1> | + | When the collection is built and installed, the sequence of buttons visible at the bottom of Figures <imgref figure_using_the_collector_to_build_a_new_collection_1> |
- | <!-- id:543 -->Finally, there is a facility for E-mail to be sent to the collection' | + | Finally, there is a facility for E-mail to be sent to the collection' |
- | ==== <!-- id:544 -->Working with existing collections ==== | + | ==== Working with existing collections ==== |
- | <!-- id:545 -->When you enter the Collector you have to specify whether you want to create an entirely new collection or work with an existing one, adding data to it or deleting it. By creating all searching and browsing structures automatically from the documents themselves Greenstone makes it easy to add new information to existing collections. Because no links are inserted by hand, when new documents in the same format become available they can be merged into the collection automatically. | + | When you enter the Collector you have to specify whether you want to create an entirely new collection or work with an existing one, adding data to it or deleting it. By creating all searching and browsing structures automatically from the documents themselves Greenstone makes it easy to add new information to existing collections. Because no links are inserted by hand, when new documents in the same format become available they can be merged into the collection automatically. |
- | <!-- id:546 -->To work with an existing collection, you first select the collection from a list that is provided. Some collections are “write protected” and cannot be altered: these ones don't appear in the selection list. With the collection, you can | + | To work with an existing collection, you first select the collection from a list that is provided. Some collections are “write protected” and cannot be altered: these ones don't appear in the selection list. With the collection, you can |
- | * <!-- id:547 -->Add more data and rebuild the collection | + | * Add more data and rebuild the collection |
- | * <!-- id:548 -->Edit the collection configuration file | + | * Edit the collection configuration file |
- | * <!-- id:549 -->Delete the collection entirely | + | * Delete the collection entirely |
- | * <!-- id:550 -->Export the collection to CD-ROM. | + | * Export the collection to CD-ROM. |
- | === <!-- id:551 -->Add new data === | + | === Add new data === |
- | <!-- id:552 -->The files that you specify will be added to the collection. Make sure that you do not re-specify files that are already in the collection—otherwise two copies will be included. Files are identified by their full pathname, web pages by their absolute web address. You specify directories and files just as you do when building a new collection. | + | The files that you specify will be added to the collection. Make sure that you do not re-specify files that are already in the collection—otherwise two copies will be included. Files are identified by their full pathname, web pages by their absolute web address. You specify directories and files just as you do when building a new collection. |
- | <!-- id:553 -->If you add data to a collection and for some reason the building process fails, the old version of the collection remains unchanged. | + | If you add data to a collection and for some reason the building process fails, the old version of the collection remains unchanged. |
- | === <!-- id:554 -->Edit configuration file === | + | === Edit configuration file === |
- | <!-- id:555 -->Advanced users can edit the collection configuration file, just as they can when a new collection is built. | + | Advanced users can edit the collection configuration file, just as they can when a new collection is built. |
- | === <!-- id:556 -->Delete the collection === | + | === Delete the collection === |
- | <!-- id:557 -->You will be asked to confirm whether you really want to delete the collection. Once deleted, Greenstone can not bring the collection back! | + | You will be asked to confirm whether you really want to delete the collection. Once deleted, Greenstone can not bring the collection back! |
- | === <!-- id:558 -->Export the collection === | + | === Export the collection === |
- | <!-- id:559 -->You can export the collection in a form that allows it to be written to a self-contained, | + | You can export the collection in a form that allows it to be written to a self-contained, |
- | <!-- id:560 -->When you export the collection, the dialogue informs you of the directory name in which the result has been placed. The entire contents of the directory should be written on to CD-ROM using a standard CD-writing utility. | + | When you export the collection, the dialogue informs you of the directory name in which the result has been placed. The entire contents of the directory should be written on to CD-ROM using a standard CD-writing utility. |
- | <!-- id:561 -->The immense variety of different possible Windows configurations has made it difficult for us to test and debug the Greenstone installer under all possible conditions. Although the installer produces CD-ROMs that operate on most Windows systems, it is still under development. If you experience problems and you possess a commercial installation package (e.g. InstallShield), | + | The immense variety of different possible Windows configurations has made it difficult for us to test and debug the Greenstone installer under all possible conditions. Although the installer produces CD-ROMs that operate on most Windows systems, it is still under development. If you experience problems and you possess a commercial installation package (e.g. InstallShield), |
- | ==== <!-- id:562 -->Document formats ==== | + | ==== Document formats ==== |
- | <!-- id:563 -->When building collections, | + | When building collections, |
- | <!-- id:564 -->Here is a summary of the plugins that are available for widely-used document formats. More detail about these plugins, and additional plugins for less commonly-used formats, can be found in the // | + | Here is a summary of the plugins that are available for widely-used document formats. More detail about these plugins, and additional plugins for less commonly-used formats, can be found in the // |
- | === <!-- id:565 -->TEXTPlug (*.txt, *.text) === | + | === TEXTPlug (*.txt, *.text) === |
- | <!-- id:566 -->TEXTPlug interprets a plain text file as a simple document. It adds //title// metadata based on the first line of the file. | + | TEXTPlug interprets a plain text file as a simple document. It adds //title// metadata based on the first line of the file. |
- | === <!-- id:567 -->HTMLPlug (*.htm, *.html; also .shtml, .shm, .asp, .php, .cgi) === | + | === HTMLPlug (*.htm, *.html; also .shtml, .shm, .asp, .php, .cgi) === |
- | <!-- id:568 -->HTMLPlug processes html files. It extracts //title// metadata based on the < | + | HTMLPlug processes html files. It extracts //title// metadata based on the < |
- | === <!-- id:569 -->WORDPlug (*.doc) === | + | === WORDPlug (*.doc) === |
- | <!-- id:570 -->WORDPlug imports Microsoft Word documents. There are many different variants on the Word format—and even Microsoft programs frequently make conversion errors. Greenstone uses independent programs to convert Word files to html. For some older Word formats the system resorts to a simple extraction algorithm that finds all text strings in the input file. | + | WORDPlug imports Microsoft Word documents. There are many different variants on the Word format—and even Microsoft programs frequently make conversion errors. Greenstone uses independent programs to convert Word files to html. For some older Word formats the system resorts to a simple extraction algorithm that finds all text strings in the input file. |
- | === <!-- id:571 -->PDFPlug (*.pdf) === | + | === PDFPlug (*.pdf) === |
- | <!-- id:572 -->PDFPlug imports documents in PDF Adobe' | + | PDFPlug imports documents in PDF Adobe' |
- | <!-- id:573 -->As with WORDPlug, by default collections will display the html equivalent of the file when the user clicks the // | + | As with WORDPlug, by default collections will display the html equivalent of the file when the user clicks the // |
- | <!-- id:574 -->The // | + | The // |
- | === <!-- id:575 -->PSPlug (*.ps) === | + | === PSPlug (*.ps) === |
- | <!-- id:576 -->PSPlug imports documents in PostScript. It works best if a standard Linux program, called // | + | PSPlug imports documents in PostScript. It works best if a standard Linux program, called // |
- | === <!-- id:577 -->EMAILPlug (*.email) === | + | === EMAILPlug (*.email) === |
- | <!-- id:578 -->EMAILPlug imports files containing E-mail, and deals with common E-mail formats such as are used by the Netscape, Eudora, and Unix mail readers. Each source document is examined to see if it contains an E-mail, or several E-mails joined together in one file, and if so its contents are processed. The plugin extracts // | + | EMAILPlug imports files containing E-mail, and deals with common E-mail formats such as are used by the Netscape, Eudora, and Unix mail readers. Each source document is examined to see if it contains an E-mail, or several E-mails joined together in one file, and if so its contents are processed. The plugin extracts // |
- | === <!-- id:579 -->ZIPPlug (.gz, .z, .tgz, .taz, .bz, .zip, .tar) === | + | === ZIPPlug (.gz, .z, .tgz, .taz, .bz, .zip, .tar) === |
- | <!-- id:580 -->ZIPPlug plugin handles the following compressed and/or archived input formats : gzip (.//gz//, .//z//, .//tgz//, .//taz//) , bzip (.//bz//) , zip (.//zip//, .//jar//) , and tar (.//tar//). It relies on the programs //gunzip//, //bunzip//, //unzip//, and //tar//, which are standard Linux utilities. ZIPPlug is disabled on Windows computers. | + | ZIPPlug plugin handles the following compressed and/or archived input formats : gzip (.//gz//, .//z//, .//tgz//, .//taz//) , bzip (.//bz//) , zip (.//zip//, .//jar//) , and tar (.//tar//). It relies on the programs //gunzip//, //bunzip//, //unzip//, and //tar//, which are standard Linux utilities. ZIPPlug is disabled on Windows computers. |
- | ===== <!-- id:d001 -->The Depositor ===== | + | ===== The Depositor ===== |
- | <!-- id:d002 -->The Depositor is another means of adding new content to a digital library. Derived from the [[# | + | The Depositor is another means of adding new content to a digital library. Derived from the [[# |
- | * <!-- id:d003 -->The collection must use Lucene as the indexer | + | * The collection must use Lucene as the indexer |
- | * <!-- id:d004 -->You must have already created the collection via the [[# | + | * You must have already created the collection via the [[# |
- | * <!-- id:d005 -->You must be serving your collection using Apache or similar web-server (Greenstone' | + | * You must be serving your collection using Apache or similar web-server (Greenstone' |
- | <!-- id:d006 -->Lucene is required for the indexer so as to provide incremental rebuilding ability - where just the newly uploaded document is added and indexed in the collection. | + | Lucene is required for the indexer so as to provide incremental rebuilding ability - where just the newly uploaded document is added and indexed in the collection. |
- | ==== <!-- id:d007 -->Enable the Depositor ==== | + | ==== Enable the Depositor ==== |
- | <!-- id:d008 -->To enable the Depositor tool modify '' | + | To enable the Depositor tool modify '' |
- | <!-- id:d009 -->Note: | + | Note: |
- | * <!-- id:d010 -->You might need to change file permissions for the '' | + | * You might need to change file permissions for the '' |
- | * <!-- id:d011 -->You need to be in the ''' | + | * You need to be in the ''' |
- | * <!-- id:d012 -->Remember, the Depositor only works with the Web server, not the local server | + | * Remember, the Depositor only works with the Web server, not the local server |
- | ==== <!-- id:d013 -->Use the Depositor ==== | + | ==== Use the Depositor ==== |
- | - <!-- id:d014 -->Go to the Greenstone' | + | - Go to the Greenstone' |
- | - <!-- id:d015 -->Sign in to the page | + | - Sign in to the page |
- | - <!-- id:d016 -->Select a collection from the collection list | + | - Select a collection from the collection list |
- | - <!-- id:d017 -->Fill in the metadata fields | + | - Fill in the metadata fields |
- | - <!-- id:d018 -->Click the " | + | - Click the " |
- | - <!-- id:d019 -->Select the file you want to deposit, then click the " | + | - Select the file you want to deposit, then click the " |
- | - <!-- id:d020 -->Click the " | + | - Click the " |
- | - <!-- id:d021 -->Try the newly built collection | + | - Try the newly built collection |
- | <!-- id:d022 -->Notes: | + | Notes: |
- | * <!-- id:d023 -->The Depositor uses the Dublin Core metadata set by default. So if the target collection doesn' | + | * The Depositor uses the Dublin Core metadata set by default. So if the target collection doesn' |
- | * <!-- id:d024 -->If you want to upload more than one file at a time, zip them first. Don't forget to include ZipPlug in your collection' | + | * If you want to upload more than one file at a time, zip them first. Don't forget to include ZipPlug in your collection' |
- | * <!-- id:d025 -->You will see " | + | * You will see " |
- | ==== <!-- id:d026 -->Configure the Depositor ==== | + | ==== Configure the Depositor ==== |
- | <!-- id:d027 -->Modify '' | + | Modify '' |
- | <!-- id:d028 -->To make the depositor deposit the item in the collection but not import/ | + | To make the depositor deposit the item in the collection but not import/ |
- | == <!-- id:d029 -->Configure the Metadata Fields == | + | === Configure the Metadata Fields |
- | <!-- id:d030 -->By default, the Depositor uses three fields (Title, Creator and Description) from the Dublin Core metadata set, but you can easily customize this in the GLI Format panel (from Greenstone version 2.81) | + | By default, the Depositor uses three fields (Title, Creator and Description) from the Dublin Core metadata set, but you can easily customize this in the GLI Format panel (from Greenstone version 2.81) |
- | - <!-- id:d031 -->Launch GLI, open the collection you want to customize with. Go to the Format Panel, click the " | + | - Launch GLI, open the collection you want to customize with. Go to the Format Panel, click the " |
- | - <!-- id:d032 -->Select fields that you want to be used in the Depositor. A drop-down list will appear right after the selected element, which is used to specify the text input type for that element in the web page: " | + | - Select fields that you want to be used in the Depositor. A drop-down list will appear right after the selected element, which is used to specify the text input type for that element in the web page: " |
- | * <!-- id:d033 -->It is recommended to select metadata fields that have been used to build classifiers, | + | * It is recommended to select metadata fields that have been used to build classifiers, |
- | * <!-- id:d034 -->Please note that at least one metadata element must be selected. If there is only one element left selected in the list, de-select the element will fail and pop up a warning message. | + | * Please note that at least one metadata element must be selected. If there is only one element left selected in the list, de-select the element will fail and pop up a warning message. |
legacy/manuals/en/user/making_greenstone_collections.1381963446.txt.gz · Last modified: 2018/06/11 22:19 (external edit)