Bug 8280: Add koha set and item fields to pqf.properties
[koha.git] / etc / z3950 / pqf.properties
1 #
2 # Propeties file to drive org.z3950.zing.cql.CQLNode's toPQF()
3 # back-end and the YAZ CQL-to-PQF converter.  This specifies the
4 # interpretation of various CQL indexes, relations, etc. in terms
5 # of Type-1 query attributes.
6 #
7 # This configuration file generates queries using BIB-1 attributes.
8 # See http://www.loc.gov/z3950/agency/zing/cql/dc-indexes.html
9 # for the Maintenance Agency's work-in-progress mapping of Dublin Core
10 # indexes to Attribute Architecture (util, XD and BIB-2)
11 # attributes.
12
13 # Identifiers for prefixes used in this file. (index.*)
14 set.cql     = info:srw/cql-context-set/1/cql-v1.1
15 set.rec     = info:srw/cql-context-set/2/rec-1.0
16 set.dc      = info:srw/cql-context-set/1/dc-v1.1
17 set.bath    = http://zing.z3950.org/cql/bath/2.0/
18 set.koha    = https://wiki.koha-community.org/wiki/Making_more_indexes_searchable_with_Zebra_SRU
19
20 # default set (in query)
21 set     = info:srw/cql-context-set/1/dc-v1.1
22
23 # The default access point and result-set references
24 index.cql.serverChoice = 1=1016
25     # srw.serverChoice is deprecated in favour of cql.serverChoice
26     # BIB-1 "any"
27
28 index.rec.id                = 1=12
29 index.dc.identifier         = 1=1007
30 index.dc.title              = 1=4
31 index.dc.subject            = 1=21
32 index.dc.creator            = 1=1003
33 index.dc.author             = 1=1003
34 index.dc.itemtype           = 1=1031
35 index.dc.barcode            = 1=1028
36 index.dc.branch             = 1=1033
37 index.dc.isbn               = 1=7
38 index.dc.issn               = 1=8
39 index.dc.any                = 1=1016
40 index.dc.note               = 1=63
41
42 # personal name experimental
43 index.dc.pname  = 1=1
44     ### Unofficial synonym for "creator"
45 index.dc.editor             = 1=1020
46 index.dc.publisher          = 1=1018
47 index.dc.description        = 1=62
48     # "abstract"
49 index.dc.date               = 1=30
50 index.dc.resourceType       = 1=1031
51     # guesswork: "Material-type"
52 index.dc.format             = 1=1034
53     # guesswork: "Content-type"
54 index.dc.resourceIdentifier = 1=12
55     # "Local number"
56 #index.dc.source                = 1=1019
57     # "Record-source"
58 index.dc.language           = 1=54
59     # "Code--language"
60
61 index.dc.Place-publication  = 1=59
62     # "Place-publication"
63
64 #index.dc.relation           = 1=?
65     ### No idea how to represent this
66 #index.dc.coverage           = 1=?
67     ### No idea how to represent this
68 #index.dc.rights             = 1=?
69     ### No idea how to represent this
70
71 # Relation attributes are selected according to the CQL relation by
72 # looking up the "relation.<relation>" property:
73 #
74 relation.<                  = 2=1
75 relation.le                 = 2=2
76 relation.eq                 = 2=3
77 relation.exact              = 2=3
78 relation.ge                 = 2=4
79 relation.>                  = 2=5
80 relation.<>                 = 2=6
81
82 ### These two are not really right:
83 relation.all                = 2=3
84 relation.any                = 2=3
85
86 # BIB-1 doesn't have a server choice relation, so we just make the
87 # choice here, and use equality (which is clearly correct).
88 relation.scr                = 2=3
89
90 # Relation modifiers.
91 #
92 relationModifier.relevant   = 2=102
93 relationModifier.fuzzy      = 5=103
94     ### 100 is "phonetic", which is not quite the same thing
95 relationModifier.stem       = 2=101
96 relationModifier.phonetic   = 2=100
97
98 # Position attributes may be specified for anchored terms (those
99 # beginning with "^", which is stripped) and unanchored (those not
100 # beginning with "^").  This may change when we get a BIB-1 truncation
101 # attribute that says "do what CQL does".
102 #
103 position.first              = 3=1 6=1
104     # "first in field"
105 position.any                = 3=3 6=1
106     # "any position in field"
107 position.last               = 3=4 6=1
108     # not a standard BIB-1 attribute
109 position.firstAndLast       = 3=3 6=3
110     # search term is anchored to be complete field
111
112 # Structure attributes may be specified for individual relations; a
113 # default structure attribute my be specified by the pseudo-relation
114 # "*", to be used whenever a relation not listed here occurs.
115 #
116 structure.exact             = 4=108
117     # string
118 structure.all               = 4=2
119 structure.any               = 4=2
120 structure.*                 = 4=1
121     # phrase
122
123 # Truncation attributes used to implement CQL wildcard patterns.  The
124 # simpler forms, left, right- and both-truncation will be used for the
125 # simplest patterns, so that we produce PQF queries that conform more
126 # closely to the Bath Profile.  However, when a more complex pattern
127 # such as "foo*bar" is used, we fall back on Z39.58-style masking.
128 #
129 truncation.right            = 5=1
130 truncation.left             = 5=2
131 truncation.both             = 5=3
132 truncation.none             = 5=100
133 truncation.z3958            = 5=104
134
135 # Finally, any additional attributes that should always be included
136 # with each term can be specified in the "always" property.
137 #
138 always                      = 6=1
139 # 6=1: completeness = incomplete subfield
140
141
142 # Bath Profile support, added Thu Dec 18 13:06:20 GMT 2003
143 # See the Bath Profile for SRW at
144 #   http://zing.z3950.org/cql/bath.html
145 # including the Bath Context Set defined within that document.
146 #
147 # In this file, we only map index-names to BIB-1 use attributes, doing
148 # so in accordance with the specifications of the Z39.50 Bath Profile,
149 # and leaving the relations, wildcards, etc. to fend for themselves.
150
151 index.bath.keyTitle         = 1=33
152 index.bath.possessingInstitution    = 1=1044
153 index.bath.name             = 1=1002
154 index.bath.personalName     = 1=1
155 index.bath.corporateName    = 1=2
156 index.bath.conferenceName   = 1=3
157 index.bath.uniformTitle     = 1=6
158 index.bath.isbn             = 1=7
159 index.bath.issn             = 1=8
160 index.bath.geographicName   = 1=58
161 index.bath.notes            = 1=63
162 index.bath.topicalSubject   = 1=1079
163 index.bath.genreForm        = 1=1075
164
165 # Koha specific indexes
166
167 index.koha.withdrawn             = 1=8001
168 index.koha.lost                  = 1=8002
169 index.koha.classification-soruce = 1=8003
170 index.koha.materials-specified   = 1=8004
171 index.koha.damaged               = 1=8005
172 index.koha.restricted            = 1=8006
173 index.koha.cn-sort               = 1=8007
174 index.koha.notforloan            = 1=8008
175 index.koha.ccode                 = 1=8009
176 index.koha.itemnumber            = 1=8010
177 index.koha.homebranch            = 1=8011
178 index.koha.holdingbranch         = 1=8012
179 index.koha.location              = 1=8013
180 index.koha.barcode               = 1=8023
181 index.koha.onloan                = 1=8024
182 index.koha.itemtype              = 1=8031