Version 1.4.0
[pazpar2-moved-to-github.git] / NEWS
1 --- 1.4.0 2010/03/29
2
3 Pazpar2 may operate in threaded mode. Enabled by element threads in
4 the configuration. See pazpar2_conf for details.
5
6 New setting setting: pz:max_connections. Setting pz:max_connections is
7 a limit of number of sockets to a host. When this limit is reached,
8 Pazpar2 will wait up to 5 seconds for a connection to becomes available.
9 The client will be marked Client_Error when it can not be searched
10 (other clients in a session may work). If pz:max_connections is not set
11 for a target, a value of 30 will be used. Note: the pz:max_connections
12 will only work in threaded mode.
13
14 pz2.js: JSON support for show.
15
16 Debian package: Enable default service, default.xml, before starting
17 Pazpar2 only if there is no service already in /etc/pazpar2/services-enabled.
18
19 --- 1.3.0 2010/01/25
20
21 Debian version depends on on libyaz4. Note that Pazpar2 will still
22 compile from source with YAZ 3.
23
24 Split services into separate files. The example configuration file
25 pazpar2.cfg.dist now includes a default service default.xml (part of
26 etc). And default.xml includes settings/edu.xml. The default.xml file,
27 not to be confused with settings/defaults.xml, is a template for jsdemo
28 and other services. The Debian package installs /etc/pazpar2/server.xml
29 which is now the main pazpar2 configuration (used to be called pazpar2.cfg).
30 server.xml includes services from /etc/pazpar2/services-enabled/*.xml .
31 The default.xml (from etc) is installed in /etc/pazpar2/services-available
32 and a symlink to it is created from services-enabled. The default.xml
33 service is unnamed and, thus, will be used by jsdemo and test1.
34
35 New setting pz:negotiation_charset. Patch from Andrei V. Toutoukine. The
36 new setting pz:negotiation_charset specifies character set for Z39.50 Init.  
37
38 --- 1.2.4 2010/01/15
39
40 Support for additional fields in cf.xsl and pazpar2.conf.dist:
41 publisher, available, due, location (=locallocation), callno
42 (=callnumber), thumburl and score.
43
44 Describe pz:xslt and the auto setting.
45
46 Move mergekey definition away from the normalization stylesheets and
47 define a mergekey common for all target types in pazpar2.cfg.
48
49 Code update: Use the Odr_int type for hit counts. This is part of
50 YAZ 3.0.47 and later and so configure checks for that.
51
52 --- 1.2.3 2009/11/24
53
54 Metadata attribute 'skiparticle' also works for ICU based
55 normalization. (was only working for the non-ICU/ASCII before).
56
57 Command bytarget with argument settings=1 will show settings per
58 target.. This is to be able to verify correct settings and be able to
59 test that they are correct. The database settings array size is now
60 also stored..  Problems with database settings array is that if not
61 careful it will be too small (smaller than dictionary per-service
62 in settings).
63
64 Make record list sorting stable by comparing mergekey for records if
65 relevance/title or other sorting criteria all match. This is merely to
66 ensure that our regressions tests works (reproducible output).
67
68 Relevance calculation changes: use a different denominator (length) for
69 per-field relevance scoring.. Instead of length of all ranked fields we
70 now use length of individual fields (as if they were individual "free"
71 text fields). This will ensure that documents with a long field with no
72 match (say description) will not "hurt" a title match.
73
74 Diagnostic member was not set on connection error. Fixed
75
76 --- 1.2.2 2009/10/13
77
78 Command search takes two optional parameters, startecs and maxrecs,
79 that specifies the start offset (0, 1, ...) and maximum number of records
80 to fetch for each target.
81
82 XSLTs + MARC maps are cached within a session so we don't re-parse
83 them over and over again. Even for a session with a single search
84 there's much to be gained because many targets use the same
85 transformation.
86
87 The metadata attribute 'mergekey' now takes one of three values 'no',
88 'required', 'optional' .  And the resulting mergekey from metadata
89 is now ordered in the same way as metadata in the service definition.
90 Older Pazpar2 version use the order in which metadata appeared in a
91 record instance.
92
93 The search argument 'filter' now offers a new operator ~ which does a 
94 substring match. The = operator works as before: string match for
95 anything but pz:id, or target match for pz:id.
96
97 New setting pz:recordfilter. The value of this setting takes the
98 form name[~value]. This setting makes Pazpar2 ignore all retrieved
99 records that do not have the metadata element name with value substring
100 (if given).
101
102 Pazpar2 allows YAZ log level to be set (option -v).
103
104 --- 1.2.1 2009/10/05
105
106 For WS responses Pazpar2 creates XML header. Exception: raw record.
107
108 Setting XML files are now stored in etc/settings instead of etc. This
109 reflects the layout with the Debian package layout.
110
111 Settings may be posted for command=settings. The POSTed settings must
112 have root element 'settings' like regular setting files. In order to be
113 recognized, the POST request must use Content-Type=text/xml.
114
115 A service may be posted for command=init. This service will be used
116 during the session. The service may have its own target settings,
117 ICU config, timeout, etc. In order to be recognized, the POST request
118 must use Content-Type=text/xml.
119
120 Timeout values may be given per-service. That's element 'timeout' 
121 which takes three attribute values (a subset may be given): 'session',
122 'z3950_operation', 'z3950_session'. Option -T is no longer supported
123 - used to specify session timeout.
124
125 Option -t tests the Pazpar2 configuration and returns exit code
126 (0=success, non-zero=failure). In previous version of Pazpar2, -t
127 specified local settings.
128
129 In version 1.2.0 the configuration file - after include processing -
130 was dumped to stdout. Now, the configuration is only dumped to the
131 yaz log file if option -d is given.
132
133 --- 1.2.0 2009/09/10
134
135 Configuration may now have multiple server areas. This means that a
136 Pazpar2 instance may listen on multiple ports. Virtual hosting is not
137 yet supported - on a server basis. Configuration may also have multiple
138 services .. That is repeating service elements inside a server. Each
139 has an attribute 'id' which serves as service ID. This ID in turn may
140 be used in a Pazpar2 session, by specifying parameter service=ID for
141 command init. There can be at most one unnamed service inside a server
142 which can be referred to by not specifying an service ID for command
143 init (backwards compatible). In order to partition multiple servers and
144 services a new include directive has been added. This takes an attribute
145 'src' which specifies one or more sub-files. For example to include
146 service files, one might use:
147   <server >.. <include src=/"etc/pazpar2/conf.d/*.xml"/> .. </server>.
148 It is the intention that that completely makes the settings directive
149 redundant.
150
151 Fix problem where the record command would wait forever if there were
152 no targets to wait for (activeclients == 0).
153
154 --- 1.1.1 2009/08/28
155
156 One result set is created per session (last search) rather than for
157 each connection which happen to be shared (bug #3009).
158
159 marc21 stylesheets changed for efficiency.
160
161 --- 1.1.0 2009/08/19
162
163 Session timeout may be specified on the command-line as option -T.
164
165 Pazpar2 may now be operated in a no-merged mode for records.. All records
166 will be considered unique. This mode is enabled if no mergekey is
167 generated by the normalization stylesheet (pz:xslt). 
168
169 Pazpar2 caches original records from each target and the 'record' command
170 with offset returns the original record if 'syntax' and 'esn' are NOT
171 specified. This speeds up retrieval of original records but also means
172 that Pazpar2 uses more memory. The cached records will be freed when the
173 session terminates or a new search is executed.
174
175 Pazpar2 no longer uses its own ICU wrapper. Instead the ICU wrapper
176 library part of YAZ is used.
177
178 Added SRU client support.
179
180 Automatically computes pz:nativesyntax if not provided. Works for XML and
181 MARC.
182
183 --- 1.0.13 2008/11/24
184
185 Command bytarget returns name of target (if defined).
186
187 --- 1.0.12 2008/11/04
188
189 Fixed bug #2021.. location now holds all brief elements.
190
191 --- 1.0.11 2008/10/15
192
193 Fixed check for application/x-www-form-urlencoded parameters.
194
195 --- 1.0.10 2008/10/14
196
197 Fixes for IE in pz2.js.
198
199 Fixed bug #2021: non-merged, brief meta data NOT included for command=show.
200
201 --- 1.0.9 2008/05/23
202
203 Changed the JS library pz2.js to use POST for long URL (+ params).
204
205 Added installation instructions for Windows. Note: NT services is
206 NOT available until we make a new release of YAZ.
207
208 Preserve order of repeated metadata fields (they were reversed before).
209
210 More MARC21 information extracted for metadata.
211
212 --- 1.0.8 2008/04/22
213
214 Fixed bug #1162: HTML entities are not escaped properly.
215
216 Native Windows port of Pazpar2. Makefile for Visual Studio provided.
217
218 --- 1.0.7 2008/04/14
219
220 Marc21 stylesheet updated to reflect multiple full text fields
221
222 --- 1.0.6 2008/03/12
223
224 Fixed bug in pz2.js WRT DOMElement attributes on IE.
225
226 Fixed bug 2100: Database wildcards not working
227
228 --- 1.0.5 2007/11/09
229
230 Added support for retrieval of records in binary.
231
232 Fixed bug 1794: Pazpar2 does not return valid XML.
233
234 Deal with ICU not returning sortkey (resulted in SEGV before).
235
236 --- 1.0.4 2007/09/28
237
238 JavaScript library pzw2.js throws error if WS response (from Pazpar2 or
239 other) is malformed (non-wellformed XML or missing Pazpar2 OK status).
240
241 Improved diagnostics when Pazpar2 HTTP decoding fails.
242
243 Pazpar2 requests may be POSTed as using Content-Type
244 application/x-www-form-urlencoded.
245
246 Pazpar2 honors LF in HTTP headers.
247
248 Handle targets that handle negative hit counts (should not happen, but it
249 does).
250
251 --- 1.0.3 2007/09/19
252
253 ICU is used for tokenization and normalization of the following: mergekey,
254 sorting, relevance terms.
255
256 Debian package now enables ICU tokenization and normalization by default.
257
258 --- 1.0.2 2007/08/22
259
260 Exposed user setting values (i.e. non-pz: names) to the record systems in two
261 ways: Either as parameters to the normalization stylesheets (which would allow the
262 programmer to postprocess or use the values in any way) or after the normalization
263 step, in which case values are made part of the normalized record (and available for
264 sorting, termlists, display, or other interface-related use.
265
266 Implemented sorting by year.
267
268 Option -d dumps records to the current log file instead of stderr.
269
270 Fixes for compilation on cygwin.
271
272 Z39.50 client code uses pz:elements. pz:elements was recognized in
273 earlier Pazpar2 versions but it was not used for anything.
274
275 icu_chain_test is using fgets instead of getline - fixes compilation
276 on MacOSX .
277
278 Loosen the CCL query parsing so that Pazpar2 only returns error if _all_
279 query conversions fail (rather than _any_). This means targets that do
280 not support some fields are ignored in a search.
281
282 --- 1.0.1 2007/07/03
283
284 Improved handling of socket timeout for Z39.50 connections. 
285
286 Misc documentation updates and spell fixes.
287
288 Debian package pazpar2 creates log rotate entry.
289
290 Debian package pazpar2-apache2 reloads Apache2.
291
292 jsdemo included in distribution. It illustrates the use of the js/pz2.js
293 JavaScript library.
294
295 --- 1.0.0 2007/06/20
296
297 First public release.
298