Changeset 10150


Ignore:
Timestamp:
2005-06-22T11:36:03+12:00 (19 years ago)
Author:
kjdon
Message:

oai config now kept in oai.cfg not main.cfg, so (belatedly) updated this README

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/gsdl/src/oaiservr/README.txt

    r8182 r10150  
    77   This allows the OAI client to obtain information on the maintainer of
    88   the server, etc.  See the OAI documentation for further information on
    9    the Identify verb.  These configurations are kept in gsdl/etc/main.cfg.
     9   the Identify verb.  These configurations are kept in gsdl/etc/oai.cfg.
    1010
    11112) Configuring collections to be 'active' OAI collections; just as collections
    … …  
    1313   'visible' or 'invisible' to OAI.  By default, collections are NOT served
    1414   via OAI - you have to enable them by adding each collection's name to a
    15    list in gsdl/etc/main.cfg.
     15   list in gsdl/etc/oai.cfg.
    1616
    17173) Mapping your collection metadata to a "Namespace" supported by OAI.  At
    … …  
    1919   and metadata fields in a Greenstone collection must be mapped into the
    2020   Dublin Core namespace.  This configuration can be done either server-wide,
    21    for all collections, in gsdl/etc/oaiconfig.cfg or in the etc/collec.cfg of
     21   for all collections, in gsdl/etc/oai.cfg or in the etc/collect.cfg of
    2222   each individual collection.
    2323
    … …  
    3838    purpose, size, origins, etc.
    3939
    40 These items are kept in the following items of gsdl/etc/main.cfg.  The syntax rules for these configuration items are the same as for main.cfg -  e.g. strings containing spaces should be enclosed in quotation marks.  See the main Greenstone configuration documentation for further information.
     40These items are kept in the following items of gsdl/etc/oai.cfg.  The syntax rules for these configuration items are the same as for gsdl/etc/main.cfg -  e.g. strings containing spaces should be enclosed in quotation marks.  See the main Greenstone configuration documentation for further information.
    4141
    4242  * repositoryName
    … …  
    4545       One item only, as a valid email address
    4646  * httpdomain
    47        NB: in the gsdlsite.cfg file, NOT main.cfg
     47       NB: in the gsdlsite.cfg file, NOT oai.cfg
    4848       Should not require specific configuration if your Greenstone install
    4949       is already operational through your web server.
    … …  
    5555          oaiinfo sponsor "The Big Cheese Corporation"
    5656
    57 Sample items are already provided in the default main.cfg file - please ensure that you complete these in your preferred text editor.
     57Sample items are already provided in the default oai.cfg file - please ensure that you complete these in your preferred text editor.
    5858
    5959
    … …  
    6161----------------------------
    6262
    63 In addition to the items above, one further sort of item needs to be added to gsdl/etc/ - a list of the collections that should be made available to OAI clients.  This list is supplied in one or more lines in gsdl/etc/main.cfg in the form:
     63In addition to the items above, one further sort of item needs to be added to gsdl/etc/oai.cfg - a list of the collections that should be made available to OAI clients.  This list is supplied in one or more lines in gsdl/etc/oai.cfg in the form:
    6464
    6565  oaicollection OAIDemo HDL
    … …  
    6767The first item in each line should be the same - "oaicollection" - followed by one or more collection names.  Each collection name should be the name of the folder/directory in the gsdl/collect directory which holds the collection.
    6868
    69 Once these items have been added to gsdl/etc/main.cfg, the final stage of the OAI configuration can begin: mapping from a collection's own metdata fields into the Dublin Core metadata fields used by OAI.  This will be detailed in the folloowing section of this document.
     69Once these items have been added to gsdl/etc/oai.cfg, the final stage of the OAI configuration can begin: mapping from a collection's own metdata fields into the Dublin Core metadata fields used by OAI.  This will be detailed in the folloowing section of this document.
    7070
    7171
    … …  
    8585The Dublin Core fieldsname should be given in the form "DC:<fieldname>", as OAI can support other metadata formats, and thus we use "DC:" to be clear that we are mapping to Dublin Core.  The fieldnames available for Dublin Core can be found on the central Dublin Core website at http://www.dublincore.org/.
    8686
    87 The Greenstone fieldname can be in two formats.  The simpler one is simply the name of the field to map from.  The more complex one has the name of the collection placed in front of the field name, followed by a colon.  e.g. "demo:Title" would mean the metadata field "Title" in the collection called "demo".  Using this, all mappings can be stored in the central gsdl/etc/main.cfg file if you wish, and we recommend this approach.
     87The Greenstone fieldname can be in two formats.  The simpler one is simply the name of the field to map from.  The more complex one has the name of the collection placed in front of the field name, followed by a colon.  e.g. "demo:Title" would mean the metadata field "Title" in the collection called "demo".  Using this, all mappings can be stored in the central gsdl/etc/oai.cfg file if you wish, and we recommend this approach.
    8888
    89 Let us recap at this point with a few example items for a gsdl/etc/main.cfg:
     89Let us recap at this point with a few example items for a gsdl/etc/oai.cfg:
    9090
    91 oaimapping Author DC:Creator
    92 oaimapping title  DC:Title
    93 oaimapping Photos:fileformat DC:Format
     91oaimapping Author dc.Creator
     92oaimapping dls.Title  dc.Title
     93oaimapping Photos:fileformat dc.Format
    9494
    95 The first item maps any occurrence of 'Author' in any collection to the Dublin Core 'Creator' field (there is no 'Author' field in DC).  The second is a straightforward linking of 'title' in any collection to DC:Title. Finally, in the specific collection 'Photos', we will map the unique metadata field 'fileformat' to the Dublin Core 'Format' field.
     95The first item maps any occurrence of 'Author' in any collection to the Dublin Core 'Creator' field (there is no 'Author' field in DC).  The second item maps 'dls.Title' to 'dc.Title'. Finally, in the specific collection 'Photos', we will map the unique metadata field 'fileformat' to the Dublin Core 'Format' field.
    9696
    9797
Note: See TracChangeset for help on using the changeset viewer.