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

Last change on this file since 14119 was 11774, checked in by kjdon, 18 years ago

added in some help about resumptiontokens

  • 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?verb=Identify
7# ....cgi-bin/oaiserver?verb=ListSets
8# ....cgi-bin/oaiserver?verb=ListIdentifiers&set=xxx (1.1 only)
9# ....cgi-bin/oaiserver?verb=ListIdentifiers&set=xxx&metadataPrefix=oai_dc (2.0 only)
10# ....cgi-bin/oaiserver?verb=ListRecords&set=xxx&metadataPrefix=oai_dc
11# ....cgi-bin/oaiserver?verb=GetRecord&identifier=xxx&metadataPrefix=oai_dc
12
13#The List verbs (ListSets, ListIdentifiers, ListRecords) all return a
14#sequence of items. The 'resumeafter' paramter below indicates how many
15#records to return - if this number is less than the number matching the
16#request, then a resumption token is returned. To use this to get the
17#next set of documents, you need to issue the same request again, with
18#an additional parameter: resumptionToken=xxx
19#For example,
20# ....cgi-bin/oaiserver?verb=ListRecords&set=demo&metadataPrefix=oai_dc&resumptionToken=gsdloai:demo,,11-
21
22# For more information about the OAI-PMH protocol, see
23# http://www.openarchives.org/
24
25# Strings containing spaces should be enclosed in double quotes ""
26
27# The OAI repository name - human readable
28repositoryName ""
29
30# The central administrative email address for the repository.
31maintainer ""
32
33# Which version of OAI the repository supports, 1.1 or 2.0
34# (The server supports both)
35oaiversion "2.0"
36
37# How many records to output before needing a resumption token
38# A value of -1 will return all records for a request
39resumeafter -1
40
41# Other free text items describing the repository. There is no restriction
42# on the number of items, or item names
43# The format is like the following:
44# oaiinfo "item name" "item value"
45# Examples may include sponsor, purpose, size...
46
47# A list of collections that should be made available to OAI clients. By
48# default, collections are not available.
49# There can be more than one line: each line must start with oaicollection,
50# and this is followed by one or more collection names. The collection name
51# is the name of the collection's folder in the collect directory.
52oaicollection demo oai-e
53
54# Metadata mapping information. At present, Greenstone's OAI server only
55# supports the Dublin Core metadata format. Metadata in other formats must
56# be mapped to Dublin Core. This can be done in this file, or for a
57# particular collection, in its collect.cfg file.
58
59# The format is like
60# oaimapping <greenstone fieldname> <oaifieldname>
61
62# As Greenstone's OAI server only supports Dublin Core, the oai fieldnames
63# should be like dc.Title, dc.Subject etc.
64# The Greenstone field names can be unqualified (Title, Subject) or
65# qualified by a namespace (dc.Title, dls.Subject). These mapping rules
66# will apply to the entire repository. Collection specific rules can also
67# be specified in this file using a collection name qualifier. This is
68# the collection name followed by a colon (demo:Title, demo:dls.Title).
69# Mappings specified in a collect.cfg file do not need the collection
70# qualifier.
71
72# Details about the Dublin Core metadata format can be found at
73# http://dublincore.org/
74# Elements include Title, Creator, Subject, Description, Publisher,
75# Contributor, Date, Type, Format, Identifier, Source, Language,
76# Relation, Coverage, Rights
77
78# mappings for the demo collection
79oaimapping demo:dls.Title dc.Title
80oaimapping demo:dls.Subject dc.Subject
81oaimapping demo:dls.Language dc.Language
82oaimapping demo:dls.Organization dc.Publisher
83
84# mappings for the oai-e collection
85oaimapping oai-e:Title dc.Title
86oaimapping oai-e:Creator dc.Creator
87oaimapping oai-e:Subject dc.Subject
88oaimapping oai-e:Description dc.Description
89oaimapping oai-e:Publisher dc.Publisher
90oaimapping oai-e:Date dc.Date
91oaimapping oai-e:Type dc.Type
92oaimapping oai-e:Format dc.Format
93oaimapping oai-e:Language dc.Language
94oaimapping oai-e:Rights dc.Rights
Note: See TracBrowser for help on using the repository browser.