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