source: main/trunk/greenstone2/etc/oai.cfg@ 23222

Last change on this file since 23222 was 23222, checked in by kjdon, 13 years ago

corrected a typo

  • Property svn:keywords set to Author Date Id Revision
File size: 7.0 KB
Line 
1# OAI Server Configuration
2
3# This is the main configuration file for configuring your Greenstone oai server.
4# The server is a cgi program called oaiserver (oaiserver.exe on Windows).
5# Some basic commands that you can send it are:
6# ....cgi-bin/oaiserver.cgi?verb=Identify
7# ....cgi-bin/oaiserver.cgi?verb=ListSets
8# ....cgi-bin/oaiserver.cgi?verb=ListMetadataFormats
9# ....cgi-bin/oaiserver.cgi?verb=ListIdentifiers&set=xxx (1.1 only)
10# ....cgi-bin/oaiserver.cgi?verb=ListIdentifiers&set=xxx&metadataPrefix=oai_dc (2.0 only)
11# ....cgi-bin/oaiserver.cgi?verb=ListRecords&set=xxx&metadataPrefix=oai_dc
12# ....cgi-bin/oaiserver.cgi?verb=GetRecord&identifier=xxx&metadataPrefix=oai_dc
13
14#The List verbs (ListSets, ListIdentifiers, ListRecords) all return a
15#sequence of items. The 'resumeafter' paramter below indicates how many
16#records to return - if this number is less than the number matching the
17#request, then a resumption token is returned. To use this to get the
18#next set of documents, you need to issue the same request again, with
19#an additional parameter: resumptionToken=xxx
20#For example,
21# ....cgi-bin/oaiserver.cgi?verb=ListRecords&set=demo&metadataPrefix=oai_dc&resumptionToken=gsdloai:demo,,11-
22
23# For more information about the OAI-PMH protocol, see
24# http://www.openarchives.org/
25
26# Strings containing spaces should be enclosed in double quotes ""
27
28#the baseURL used by the oaiserver
29#Example: baseURL "http://your-domain-name/cgi-bin/oaiserver.cgi"
30baseURL "your-own-baseURL-goes-here"
31
32# the base URL used by the Greenstone library
33#Example: baseLibraryURL "http://your-domain-name/cgi-bin/library.cgi"
34baseLibraryURL "your-own-base-Library-URL-goes-here"
35
36# the base address of gsdl directory
37#Example: baseDocRoot "http://your-domain-name/gsdl"
38baseDocRoot "your-own-base-document-root-goes-here"
39
40# The OAI repository name - human readable
41repositoryName ""
42
43# The OAI repository domain name or unique identifier - used for generating
44# the document identifiers, which will be like:
45# oai:reposId:coll:oid
46repositoryId ""
47
48# version is which oai id scheme is used for ids. Can be 1.1 or 2.0.
49# 1.1 uses a unique id, while 2.0 uses a domain name
50repositoryIdVersion "1.1"
51
52# The central administrative email address for the repository.
53maintainer ""
54
55# Which version of OAI the repository supports, 1.1 or 2.0
56# (The server supports both)
57oaiversion "2.0"
58
59# How many records to output before needing a resumption token
60# A value of -1 will return all records for a request
61resumeafter 250
62
63# Other free text items describing the repository. There is no restriction
64# on the number of items, or item names
65# The format is like the following:
66# oaiinfo "item name" "item value"
67# Examples may include sponsor, purpose, size...
68
69# A list of collections that should be made available to OAI clients. By
70# default, collections are not available.
71# There can be more than one line: each line must start with oaicollection,
72# and this is followed by one or more collection names. The collection name
73# is the name of the collection's folder in the collect directory.
74oaicollection demo documented-examples/oai-e
75
76# Optional, set name and description for each collection
77# collname is the same collection name as in the above oaicollection line
78# The format is like the following:
79# oaisetname collname "Name of Collection"
80# oaisetdescription collname "Collection description"
81
82# Set name and description can also be added for classifiers. Specify this like
83# oaisetname demo:CL1 "Titles set for Demo collection"
84
85# These can also be specified in a collection's collect.cfg. The collection
86# name is not needed, so lines will look like
87# oaisetname "demo collection"
88# oaisetname CL1 "Titles set for demo collection"
89
90# Metadata mapping information. At present, Greenstone's OAI server
91# supports the following metadata formats.
92# oai_dc (OAI standard for Dublin Core)
93# gsdl_qdc (Greenstone format for Qualified Dublin Core)
94# rfc1807 (OAI standard for RFC 1807 format)
95
96# the list of metadata formats this server should support (Choose from the
97# above list)
98oaimetadata oai_dc gsdl_qdc
99
100#### Metadata Mapping Rules ####
101################################
102
103# Metadata in other formats must be mapped to the formats specified above.
104# This can be done in this file, or, for a particular collection, in its
105# collect.cfg file.
106
107# The format is like
108# oaimapping <greenstone fieldname> <metadataPrefix.fieldname>
109
110# The Greenstone field names can be unqualified (Title, Subject) or
111# qualified by a namespace (dc.Title, dls.Subject). Capitalization must match
112# that used by Greenstone.
113# OAI field names must start with the metadataPrefix name (e.g. oai_dc.) and
114# capitalization must match that used by the appropriate schema. Valid elements
115# for each schema are listed below. Only valid elements will be included in
116# the output
117
118# OAI Dublin Core metadata schema:
119# http://www.openarchives.org/OAI/2.0/oai_dc.xsd
120# metadataPrefix: oai_dc
121# Valid elements:
122# contributor coverage creator date description format identifier language
123# publisher relation rights source subject title type
124
125# Greenstone's OAI Qualified Dublin Core metadata schema:
126# http://www.greenstone.org/namespace/gsdl_qdc/1.0/gsdl_qdc.xsd
127# metadataPrefix: gsdl_qdc
128# Valid elements:
129# title creator subject description publisher contributor date type format
130# identifier source language relation coverage rights alternative
131# tableOfContents abstract created valid available issued modified
132# dateAccepted dateCopyrighted dateSubmitted extent medium isVersionOf
133# hasVersion isReplacedBy replaces isRequiredBy requires isPartOf hasPart
134# isReferencedBy references isFormatOf hasFormat conformsTo spatial
135# temporal audience accrualMethod accrualPeriodicity accrualPolicy
136# instructionalMethod provenance rightsHolder mediator educationLevel
137# accessRights license bibliographicCitation
138
139# OAI RFC 1807 metadata schema
140# http://www.openarchives.org/OAI/1.1/rfc1807.xsd
141# metadataPrefix: rfc1807
142# Valid elements:
143# bib-version id entry organization title type revision withdraw author
144# corp-author contact date pages copyright handle other_access retrieval
145# keyword cr-category period series monitoring funding contract grant
146# language notes abstract
147
148# mappings for the dls metadata set
149# for dublin core (oai_dc metadata prefix)
150oaimapping dls.Title oai_dc.title
151oaimapping dls.Subject oai_dc.subject
152oaimapping dls.Language oai_dc.language
153oaimapping dls.Organization oai_dc.publisher
154# for qualified dublin core (gsdl_qdc metadata prefix)
155oaimapping dls.Title gsdl_qdc.title
156oaimapping dls.Subject gsdl_qdc.subject
157oaimapping dls.Language gsdl_qdc.language
158oaimapping dls.Organization gsdl_qdc.publisher
159
160
161# These mapping rules will apply to the entire repository.
162
163# Collection specific rules can also be specified in this file using a
164# collection name qualifier with the greenstone field name. This is the
165# collection name followed by a colon (demo:Title, demo:dls.Title).
166# oaimapping demo:dls.Title oai_dc.title
167# Mappings specified in a collect.cfg file do not need the collection
168# qualifier.
169
Note: See TracBrowser for help on using the repository browser.