1 Introducing a version=2 parameter for show, termlist and bytarget commands.
2 This enables pazpar2 to return approximation on hit and count count when
3 doing record filtering using the limit parameter on search and a
4 limitmap with a value of "local:"
6 Setting pz:xslt may embed local XSLT as an alternative to referring
8 Value is not CDATA but XML nodes embedded, so escaping is not necessary
9 but a root element *must* be present. For example:
10 <settings target="target="z3950.indexdata.com/marc">
19 Metadata field rank may given by XML internal document (pz:xslt
20 result). If rank is not given, the rank from service description is
23 Metadata field can now configured a default limitmap and facetmap.
24 Setting limitmap to "local:" would work for all kind of targets, but would
25 prob. not be the optimal solution. But at least better than the default behavior
26 of pazpar2 where no filtering is done.
28 A service definition can now also contains <set/> that defines service-wide
29 settings. These will override server-wide sets and will be overridded by
32 New setting, pz:present_chunk, that specifies number of records to fetch
33 at a time. Zero will disable chunkation; will fetch max_records at once.
37 Revert the format change in termlist response, that could break
38 some clients / UIs since they were expecting an (empty) element
39 if no facet values was found.
43 Revert the behavior of returning errors when unable to block
44 on termlist, bytarget and search, when unable to block due to
45 other block. The client will now receive a regular response,
46 but it will be logged in the server. A parameter (report) is
47 added to change behavior to return error response or WARNING
48 status message. Consider this "API" as private, as it is mostly
49 untested and could be changed in future releases.
51 Fix spell error in pz2.js fix in 1.6.10.
53 New Marc2TurboMarc.xsl (contribution from Sven Porst).
54 Can solve the missing marc21.xsl updates in some cases.
56 tmarc.xsl: Simplify the 6xx to subject-long and fix 1-based
57 substring (contribtion from Sven Porst)
59 marc21.xsl: fix 1-based substring call
61 tmarc.xsl and marc21.xsl: use 856$a as last option for electronic-text.
63 Add test_termlist_block to test suite
67 Fix SEGV for invalid PQFs and SRU/SOLR targets
68 Also refactor a bit the code that converts from PQF to SRU/SOLR queries.
70 Fix pz2.js: "null object" due to change in in bytarget result XML.
72 Fixes in tmarc.xsl: Subject-long shorten for extra commas only.
73 Added this normalization to the other subject-long fields (d6xx),
76 Fixes in marc21.xsl: Updated with most of the new tmarc.xsl.
77 Still differences around medium and holdings. marc21.xsl is not
78 longer active used by Index Data, and should be considered unsupported.
79 Use tmarc.xsl instead.
83 Fix SEGV that could occur for failed connections.
87 Fix bug for command sort that could return no results for active clients
88 (from previous search). This bug was present in 1.6.6-1.6.7.
90 Fix bug in results that could include results that should have been
91 filtered out. This bug was present in 1.6.6-1.6.7.
95 Fix bug introduced in 1.6.6 where a connection re-use could stall
98 Local filtering may now specify a local metadata field, eg.
99 pz:limitmap:somefield[t]=local:otherfield
103 For search, when limit and or filtering is in place and search
104 is identical to previous search, the result set is re-used and the
105 target is not searched.
107 Limits may work perform local filtering as well, by using "local:"
112 Updated bytarget command to contain a suggestions element with misspelled
113 words and suggestions to these. pz2.js has been updated to deliver this
114 onwards as well. Only target that currently delivers this is the solr
115 client in YAZ 4.2.18.
119 New service definition element, xslt, that allows an embedded stylesheet
120 to be defined. This can be referred to from pz:xslt as an alternative to
123 New pz:sortmap:field setting for specifying hints on how to make
124 a target natively sort on a field. This is used for command=show in
125 conjunction with sort.
127 New pz:url setting for specifying the actual URL for a target. When
128 this is used the target ID is not used as URL anymore and the target ID
129 may be almost any string (not including []).
131 command=termlist without name parameter returns all termlists/facets.
132 Previously if name parameter was omitted, only "subject" was returned.
136 Make termlist sorting stable. Terms with same frequency are now sorted by
137 their display name. This makes a pretty display and improves our
138 regression test because qsort is not a stable sort.
140 New sort parameter value 'position'. The 'position' sorts merged records
141 by their original position from the remote target. This is primarily useful
142 for debugging and may be used for targets that already perform some kind
143 of relevance ranking. Note that sort by default is decreasing; so to get
144 records in their original order sort=position:1 must be used.
148 tmarc.xsl: yet another 773$g fix. Was broken in 1.6.1 as well.
150 Facility to change working directory for pazpar2 daemon. Option -wdir
151 sets working directory to dir. This facility is useful if core dumps
152 must be saved. In this case, the current working directory must be
153 writable by the running user, such as "nobody".
157 New configuration element <icu_chain> for <server>/<service> which
158 allows a named ICU rule (chain) to be defined. The names relevance,
159 sort, mergekey and facet are used for those operations. The definition
160 <icu_chain id="sort" locale="en"> .. </icu_chain>
162 <sort> <icu_chain locale="en> ... </icu_chain> </sort>
163 And so on.. for relevance, mergekey and facet as well. The latter
164 style is deprecated. The facet terms are normalized by the facet
165 rule by default. This may be changed on a metadata field basis by
166 defining the new attribute 'facetrule' for the metadata element.
168 <icu_chain id="myrule" locale="en"> ... </icu_chain>
169 <metadata name="author" termlist="yes" facetrule="myrule"/>
171 Preserve rorder for merged metadata. Fixes issue as reported by Sven
172 Porst: http://lists.indexdata.dk/pipermail/yazlist/2011-July/003230.html
174 tmarc.xsl: set journal-subpart to 773$ only.
178 Modify the behavior for the limit parameter (first defined in 1.5.7).
179 Mapping of limit searches are now defined by the new configuration item
180 pz:limitmap. Fix a dead-lock problem with the limit parameter.
182 Extend tmarc.xsl to extract 773$g data (OpenURL).
186 ICU default maps remove backquote (`).
188 Command 'search' takes limit parameter (optional). The limit parameter
189 allows a search to be limited one or more facets and the corresponding
190 values. This is for server side filtering.
192 Configure tweak: Use -lm for log(3) if needed
196 Fix a problem with skiparticle sortkey that could be completely
197 ignored (and reduced to "").
199 Fix dependency problem in pazpar2 RPM package (did not require
200 libyaz4 as it should).
204 Fix memory leak that occurred for command=termlist&name=xtargets .
206 Pazpar2 may save HTTP requests. Enabled by option -R.
210 Experimental support for DTIC DADS target. New dads-pz2.xsl.
212 Support for query_syntax (overrides the default for SRU | Z39.50)
214 Support for extraArgs (ZOOM "extraArgs" option) for targets
216 New commands: status-server and status-session
220 Fix for threaded runs: Client now have a copy of the database URL,
221 which can used after the database has been release from the client.
222 This makes the logging in the connection idle timeout of the client nicer (no NOURL) and should be thread-safe.
224 tmarc.xsl: Add journal-title-abbrev and full text.
226 cf.xsl: new fields: isbn, issn, journaltitle, volume, issue
228 Fix for cmd=record before search.
230 Session Logging clean up.
232 Fix wrong termlist factor when maxrecs is different from 100.
236 Fix missing pz:termlist_term_factor in settings.c messed up pz:preferred.
237 Term factor is default enabled but can be diseabled by
238 pz:termlist_term_factor=0
242 Add scaling of facet count. Currently always enabled, needs fixing.
243 Allow user-defined info for target suffix. This has no meaning in
244 Pazpar2 except to distinguish targets from each other. The suffix
245 data begins with #. For example z3950.indexdata.com/gils#Mydata
247 Added exact-match recordfilter; format name=value
251 SOLR support. Pazpar2 may operate as web service client for SOLR.
255 Fix for show command and block=1 (dead lock). Bug was introduced in
260 New RPM packages: pazpar2, pazpar2-js, pazpar2-doc. These have been
261 tested on CentOS 5.5 only.
265 Fix problem with result sets being removed from a client session
266 if the connection for it was resused by another session. Bug #3489.
268 New iphone UI for Pazpar2 (www/iphone).
272 Fixes for threaded operation.
274 New stylesheets for TurboMARC: tmarc.xsl and opac_turbomarc.xsl.
276 New example services in etc/services in source. In the Debian packages
277 these are located in /etc/pazpar2/services-available
279 Threaded mode operational on Windows. Requires Windows 7 or Windows
282 Default value of setting pz:max_connections is 0 which means that there
283 is no limit on number of connections.
287 Pazpar2 may operate in threaded mode. Enabled by element threads in
288 the configuration. See pazpar2_conf for details.
290 New setting setting: pz:max_connections. Setting pz:max_connections is
291 a limit of number of sockets to a host. When this limit is reached,
292 Pazpar2 will wait up to 5 seconds for a connection to becomes available.
293 The client will be marked Client_Error when it can not be searched
294 (other clients in a session may work). If pz:max_connections is not set
295 for a target, a value of 30 will be used. Note: the pz:max_connections
296 will only work in threaded mode.
298 pz2.js: JSON support for show.
300 Debian package: Enable default service, default.xml, before starting
301 Pazpar2 only if there is no service already in /etc/pazpar2/services-enabled.
305 Debian version depends on on libyaz4. Note that Pazpar2 will still
306 compile from source with YAZ 3.
308 Split services into separate files. The example configuration file
309 pazpar2.cfg.dist now includes a default service default.xml (part of
310 etc). And default.xml includes settings/edu.xml. The default.xml file,
311 not to be confused with settings/defaults.xml, is a template for jsdemo
312 and other services. The Debian package installs /etc/pazpar2/server.xml
313 which is now the main pazpar2 configuration (used to be called pazpar2.cfg).
314 server.xml includes services from /etc/pazpar2/services-enabled/*.xml .
315 The default.xml (from etc) is installed in /etc/pazpar2/services-available
316 and a symlink to it is created from services-enabled. The default.xml
317 service is unnamed and, thus, will be used by jsdemo and test1.
319 New setting pz:negotiation_charset. Patch from Andrei V. Toutoukine. The
320 new setting pz:negotiation_charset specifies character set for Z39.50 Init.
324 Support for additional fields in cf.xsl and pazpar2.conf.dist:
325 publisher, available, due, location (=locallocation), callno
326 (=callnumber), thumburl and score.
328 Describe pz:xslt and the auto setting.
330 Move mergekey definition away from the normalization stylesheets and
331 define a mergekey common for all target types in pazpar2.cfg.
333 Code update: Use the Odr_int type for hit counts. This is part of
334 YAZ 3.0.47 and later and so configure checks for that.
338 Metadata attribute 'skiparticle' also works for ICU based
339 normalization. (was only working for the non-ICU/ASCII before).
341 Command bytarget with argument settings=1 will show settings per
342 target.. This is to be able to verify correct settings and be able to
343 test that they are correct. The database settings array size is now
344 also stored.. Problems with database settings array is that if not
345 careful it will be too small (smaller than dictionary per-service
348 Make record list sorting stable by comparing mergekey for records if
349 relevance/title or other sorting criteria all match. This is merely to
350 ensure that our regressions tests works (reproducible output).
352 Relevance calculation changes: use a different denominator (length) for
353 per-field relevance scoring.. Instead of length of all ranked fields we
354 now use length of individual fields (as if they were individual "free"
355 text fields). This will ensure that documents with a long field with no
356 match (say description) will not "hurt" a title match.
358 Diagnostic member was not set on connection error. Fixed
362 Command search takes two optional parameters, startecs and maxrecs,
363 that specifies the start offset (0, 1, ...) and maximum number of records
364 to fetch for each target.
366 XSLTs + MARC maps are cached within a session so we don't re-parse
367 them over and over again. Even for a session with a single search
368 there's much to be gained because many targets use the same
371 The metadata attribute 'mergekey' now takes one of three values 'no',
372 'required', 'optional' . And the resulting mergekey from metadata
373 is now ordered in the same way as metadata in the service definition.
374 Older Pazpar2 version use the order in which metadata appeared in a
377 The search argument 'filter' now offers a new operator ~ which does a
378 substring match. The = operator works as before: string match for
379 anything but pz:id, or target match for pz:id.
381 New setting pz:recordfilter. The value of this setting takes the
382 form name[~value]. This setting makes Pazpar2 ignore all retrieved
383 records that do not have the metadata element name with value substring
386 Pazpar2 allows YAZ log level to be set (option -v).
390 For WS responses Pazpar2 creates XML header. Exception: raw record.
392 Setting XML files are now stored in etc/settings instead of etc. This
393 reflects the layout with the Debian package layout.
395 Settings may be posted for command=settings. The POSTed settings must
396 have root element 'settings' like regular setting files. In order to be
397 recognized, the POST request must use Content-Type=text/xml.
399 A service may be posted for command=init. This service will be used
400 during the session. The service may have its own target settings,
401 ICU config, timeout, etc. In order to be recognized, the POST request
402 must use Content-Type=text/xml.
404 Timeout values may be given per-service. That's element 'timeout'
405 which takes three attribute values (a subset may be given): 'session',
406 'z3950_operation', 'z3950_session'. Option -T is no longer supported
407 - used to specify session timeout.
409 Option -t tests the Pazpar2 configuration and returns exit code
410 (0=success, non-zero=failure). In previous version of Pazpar2, -t
411 specified local settings.
413 In version 1.2.0 the configuration file - after include processing -
414 was dumped to stdout. Now, the configuration is only dumped to the
415 yaz log file if option -d is given.
419 Configuration may now have multiple server areas. This means that a
420 Pazpar2 instance may listen on multiple ports. Virtual hosting is not
421 yet supported - on a server basis. Configuration may also have multiple
422 services .. That is repeating service elements inside a server. Each
423 has an attribute 'id' which serves as service ID. This ID in turn may
424 be used in a Pazpar2 session, by specifying parameter service=ID for
425 command init. There can be at most one unnamed service inside a server
426 which can be referred to by not specifying an service ID for command
427 init (backwards compatible). In order to partition multiple servers and
428 services a new include directive has been added. This takes an attribute
429 'src' which specifies one or more sub-files. For example to include
430 service files, one might use:
431 <server >.. <include src=/"etc/pazpar2/conf.d/*.xml"/> .. </server>.
432 It is the intention that that completely makes the settings directive
435 Fix problem where the record command would wait forever if there were
436 no targets to wait for (activeclients == 0).
440 One result set is created per session (last search) rather than for
441 each connection which happen to be shared (bug #3009).
443 marc21 stylesheets changed for efficiency.
447 Session timeout may be specified on the command-line as option -T.
449 Pazpar2 may now be operated in a no-merged mode for records.. All records
450 will be considered unique. This mode is enabled if no mergekey is
451 generated by the normalization stylesheet (pz:xslt).
453 Pazpar2 caches original records from each target and the 'record' command
454 with offset returns the original record if 'syntax' and 'esn' are NOT
455 specified. This speeds up retrieval of original records but also means
456 that Pazpar2 uses more memory. The cached records will be freed when the
457 session terminates or a new search is executed.
459 Pazpar2 no longer uses its own ICU wrapper. Instead the ICU wrapper
460 library part of YAZ is used.
462 Added SRU client support.
464 Automatically computes pz:nativesyntax if not provided. Works for XML and
467 --- 1.0.13 2008/11/24
469 Command bytarget returns name of target (if defined).
471 --- 1.0.12 2008/11/04
473 Fixed bug #2021.. location now holds all brief elements.
475 --- 1.0.11 2008/10/15
477 Fixed check for application/x-www-form-urlencoded parameters.
479 --- 1.0.10 2008/10/14
481 Fixes for IE in pz2.js.
483 Fixed bug #2021: non-merged, brief meta data NOT included for command=show.
487 Changed the JS library pz2.js to use POST for long URL (+ params).
489 Added installation instructions for Windows. Note: NT services is
490 NOT available until we make a new release of YAZ.
492 Preserve order of repeated metadata fields (they were reversed before).
494 More MARC21 information extracted for metadata.
498 Fixed bug #1162: HTML entities are not escaped properly.
500 Native Windows port of Pazpar2. Makefile for Visual Studio provided.
504 Marc21 stylesheet updated to reflect multiple full text fields
508 Fixed bug in pz2.js WRT DOMElement attributes on IE.
510 Fixed bug 2100: Database wildcards not working
514 Added support for retrieval of records in binary.
516 Fixed bug 1794: Pazpar2 does not return valid XML.
518 Deal with ICU not returning sortkey (resulted in SEGV before).
522 JavaScript library pzw2.js throws error if WS response (from Pazpar2 or
523 other) is malformed (non-wellformed XML or missing Pazpar2 OK status).
525 Improved diagnostics when Pazpar2 HTTP decoding fails.
527 Pazpar2 requests may be POSTed as using Content-Type
528 application/x-www-form-urlencoded.
530 Pazpar2 honors LF in HTTP headers.
532 Handle targets that handle negative hit counts (should not happen, but it
537 ICU is used for tokenization and normalization of the following: mergekey,
538 sorting, relevance terms.
540 Debian package now enables ICU tokenization and normalization by default.
544 Exposed user setting values (i.e. non-pz: names) to the record systems in two
545 ways: Either as parameters to the normalization stylesheets (which would allow the
546 programmer to postprocess or use the values in any way) or after the normalization
547 step, in which case values are made part of the normalized record (and available for
548 sorting, termlists, display, or other interface-related use.
550 Implemented sorting by year.
552 Option -d dumps records to the current log file instead of stderr.
554 Fixes for compilation on cygwin.
556 Z39.50 client code uses pz:elements. pz:elements was recognized in
557 earlier Pazpar2 versions but it was not used for anything.
559 icu_chain_test is using fgets instead of getline - fixes compilation
562 Loosen the CCL query parsing so that Pazpar2 only returns error if _all_
563 query conversions fail (rather than _any_). This means targets that do
564 not support some fields are ignored in a search.
568 Improved handling of socket timeout for Z39.50 connections.
570 Misc documentation updates and spell fixes.
572 Debian package pazpar2 creates log rotate entry.
574 Debian package pazpar2-apache2 reloads Apache2.
576 jsdemo included in distribution. It illustrates the use of the js/pz2.js
581 First public release.