source: gsdl/trunk/etc/oai.cfg@ 18863

Last change on this file since 18863 was 18863, checked in by kjdon, 15 years ago

modified URLs to include .cgi. Added ListMetadataFormats example. Added keyword baseDocRoot

  • Property svn:keywords set to Author Date Id Revision
File size: 3.9 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 address of gsdl directory
33#Example: baseDocRoot "http://your-domain-name/gsdl"
34baseDocRoot "your-own-base-document-root-goes-here"
35
36# The OAI repository name - human readable
37repositoryName ""
38
39# The central administrative email address for the repository.
40maintainer ""
41
42# Which version of OAI the repository supports, 1.1 or 2.0
43# (The server supports both)
44oaiversion "2.0"
45
46# How many records to output before needing a resumption token
47# A value of -1 will return all records for a request
48resumeafter -1
49
50# Other free text items describing the repository. There is no restriction
51# on the number of items, or item names
52# The format is like the following:
53# oaiinfo "item name" "item value"
54# Examples may include sponsor, purpose, size...
55
56# A list of collections that should be made available to OAI clients. By
57# default, collections are not available.
58# There can be more than one line: each line must start with oaicollection,
59# and this is followed by one or more collection names. The collection name
60# is the name of the collection's folder in the collect directory.
61oaicollection demo oai-e
62
63# Metadata mapping information. At present, Greenstone's OAI server only
64# supports the Dublin Core metadata format. Metadata in other formats must
65# be mapped to Dublin Core. This can be done in this file, or for a
66# particular collection, in its collect.cfg file.
67
68# The format is like
69# oaimapping <greenstone fieldname> <oaifieldname>
70
71# As Greenstone's OAI server only supports Dublin Core, the oai fieldnames
72# should be like dc.Title, dc.Subject etc.
73# The Greenstone field names can be unqualified (Title, Subject) or
74# qualified by a namespace (dc.Title, dls.Subject). These mapping rules
75# will apply to the entire repository. Collection specific rules can also
76# be specified in this file using a collection name qualifier. This is
77# the collection name followed by a colon (demo:Title, demo:dls.Title).
78# Mappings specified in a collect.cfg file do not need the collection
79# qualifier.
80
81# Details about the Dublin Core metadata format can be found at
82# http://dublincore.org/
83# Elements include Title, Creator, Subject, Description, Publisher,
84# Contributor, Date, Type, Format, Identifier, Source, Language,
85# Relation, Coverage, Rights
86
87# mappings for the demo collection
88oaimapping demo:dls.Title dc.title
89oaimapping demo:dls.Subject dc.subject
90oaimapping demo:dls.Language dc.language
91oaimapping demo:dls.Organization dc.publisher
92
93
Note: See TracBrowser for help on using the repository browser.