3 Rank algorithm details may be printed as part of show reseponse in
4 element <relevance_info>.. This is only printed if <rank debug="yes"/>
7 Record as returned by show/record command have a minimal indentation
8 which makes things human-readable.
12 Rank algorithm skips strings that gets normalized to empty string.
13 For example, & and ! could map to the empty string. The weight for
14 those terms is now 0 (as if they were not part of the query).
16 Rank algorithm does not use CCL from limitmap; only from the query
17 parameter (user query).
23 Rank algorithm configurable by 'rank' element inside service. So far
24 only, attribute 'cluster' is recognized. If cluster="yes", multiple
25 records inside a cluster boosts higher than single records. This
26 is default behavior and existing behavior. cluster="no" takes the
27 average score of each record in a cluster.
31 Fix bad re-use of connections (connections with changing proxy should not
36 Fix a bug introduce in 1.6.15 around the position sorting. It resetted the
37 resultset and sorting when the sort order is position. However this will be done on
38 every client poll, which will make pazpar2 continuing reset and fetching.
39 It should only be done on FIRST request where the sort order change.
41 Fix an issue on suggestion option: Also disable suggestions on empty string.
43 Clean up in turbo marc stylesheet.
45 Remove the hardcoded size of termlists.
49 New facility: ccldirective may be given in service definition. Allows
50 CCL parsing to be customized a bit, such as defining names of operators
53 New facility: raw record by checksum, rather than offset. The record
54 command optionally takes checksum which identifies certain record from
57 New facility: per field ranking. Rank may be given as M [F N] where
58 M is default rank and N is rank for CCL terms from field F.
62 Fix for IE7/8 in pz.js
64 Applied patch from Giannis Kosmas on keepAlive, which also adds keepAlive to init response.
66 Lower log level some places.
68 Remove some invalid test results.
72 Introducing a version=2 parameter for show, termlist and bytarget commands.
73 This enables pazpar2 to return approximation on hit and count count when
74 doing record filtering using the limit parameter on search and a
75 limitmap with a value of "local:"
77 Setting pz:xslt may embed local XSLT as an alternative to referring
79 Value is not CDATA but XML nodes embedded, so escaping is not necessary
80 but a root element *must* be present. For example:
81 <settings target="target="z3950.indexdata.com/marc">
90 Metadata field rank may given by XML internal document (pz:xslt
91 result). If rank is not given, the rank from service description is
94 Metadata field can now configured a default limitmap and facetmap.
95 Setting limitmap to "local:" would work for all kind of targets, but would
96 prob. not be the optimal solution. But at least better than the default behavior
97 of pazpar2 where no filtering is done.
99 A service definition can now also contains <set/> that defines service-wide
100 settings. These will override server-wide sets and will be overridded by
103 New setting, pz:present_chunk, that specifies number of records to fetch
104 at a time. Zero will disable chunkation; will fetch max_records at once.
106 --- 1.6.12 2012/03/14
108 Revert the format change in termlist response, that could break
109 some clients / UIs since they were expecting an (empty) element
110 if no facet values was found.
112 --- 1.6.11 2012/03/07
114 Revert the behavior of returning errors when unable to block
115 on termlist, bytarget and search, when unable to block due to
116 other block. The client will now receive a regular response,
117 but it will be logged in the server. A parameter (report) is
118 added to change behavior to return error response or WARNING
119 status message. Consider this "API" as private, as it is mostly
120 untested and could be changed in future releases.
122 Fix spell error in pz2.js fix in 1.6.10.
124 New Marc2TurboMarc.xsl (contribution from Sven Porst).
125 Can solve the missing marc21.xsl updates in some cases.
127 tmarc.xsl: Simplify the 6xx to subject-long and fix 1-based
128 substring (contribtion from Sven Porst)
130 marc21.xsl: fix 1-based substring call
132 tmarc.xsl and marc21.xsl: use 856$a as last option for electronic-text.
134 Add test_termlist_block to test suite
136 --- 1.6.10 2012/02/23
138 Fix SEGV for invalid PQFs and SRU/SOLR targets
139 Also refactor a bit the code that converts from PQF to SRU/SOLR queries.
141 Fix pz2.js: "null object" due to change in in bytarget result XML.
143 Fixes in tmarc.xsl: Subject-long shorten for extra commas only.
144 Added this normalization to the other subject-long fields (d6xx),
145 where it was missing.
147 Fixes in marc21.xsl: Updated with most of the new tmarc.xsl.
148 Still differences around medium and holdings. marc21.xsl is not
149 longer active used by Index Data, and should be considered unsupported.
150 Use tmarc.xsl instead.
154 Fix SEGV that could occur for failed connections.
158 Fix bug for command sort that could return no results for active clients
159 (from previous search). This bug was present in 1.6.6-1.6.7.
161 Fix bug in results that could include results that should have been
162 filtered out. This bug was present in 1.6.6-1.6.7.
166 Fix bug introduced in 1.6.6 where a connection re-use could stall
169 Local filtering may now specify a local metadata field, eg.
170 pz:limitmap:somefield[t]=local:otherfield
174 For search, when limit and or filtering is in place and search
175 is identical to previous search, the result set is re-used and the
176 target is not searched.
178 Limits may work perform local filtering as well, by using "local:"
183 Updated bytarget command to contain a suggestions element with misspelled
184 words and suggestions to these. pz2.js has been updated to deliver this
185 onwards as well. Only target that currently delivers this is the solr
186 client in YAZ 4.2.18.
190 New service definition element, xslt, that allows an embedded stylesheet
191 to be defined. This can be referred to from pz:xslt as an alternative to
194 New pz:sortmap:field setting for specifying hints on how to make
195 a target natively sort on a field. This is used for command=show in
196 conjunction with sort.
198 New pz:url setting for specifying the actual URL for a target. When
199 this is used the target ID is not used as URL anymore and the target ID
200 may be almost any string (not including []).
202 command=termlist without name parameter returns all termlists/facets.
203 Previously if name parameter was omitted, only "subject" was returned.
207 Make termlist sorting stable. Terms with same frequency are now sorted by
208 their display name. This makes a pretty display and improves our
209 regression test because qsort is not a stable sort.
211 New sort parameter value 'position'. The 'position' sorts merged records
212 by their original position from the remote target. This is primarily useful
213 for debugging and may be used for targets that already perform some kind
214 of relevance ranking. Note that sort by default is decreasing; so to get
215 records in their original order sort=position:1 must be used.
219 tmarc.xsl: yet another 773$g fix. Was broken in 1.6.1 as well.
221 Facility to change working directory for pazpar2 daemon. Option -wdir
222 sets working directory to dir. This facility is useful if core dumps
223 must be saved. In this case, the current working directory must be
224 writable by the running user, such as "nobody".
228 New configuration element <icu_chain> for <server>/<service> which
229 allows a named ICU rule (chain) to be defined. The names relevance,
230 sort, mergekey and facet are used for those operations. The definition
231 <icu_chain id="sort" locale="en"> .. </icu_chain>
233 <sort> <icu_chain locale="en> ... </icu_chain> </sort>
234 And so on.. for relevance, mergekey and facet as well. The latter
235 style is deprecated. The facet terms are normalized by the facet
236 rule by default. This may be changed on a metadata field basis by
237 defining the new attribute 'facetrule' for the metadata element.
239 <icu_chain id="myrule" locale="en"> ... </icu_chain>
240 <metadata name="author" termlist="yes" facetrule="myrule"/>
242 Preserve rorder for merged metadata. Fixes issue as reported by Sven
243 Porst: http://lists.indexdata.dk/pipermail/yazlist/2011-July/003230.html
245 tmarc.xsl: set journal-subpart to 773$ only.
249 Modify the behavior for the limit parameter (first defined in 1.5.7).
250 Mapping of limit searches are now defined by the new configuration item
251 pz:limitmap. Fix a dead-lock problem with the limit parameter.
253 Extend tmarc.xsl to extract 773$g data (OpenURL).
257 ICU default maps remove backquote (`).
259 Command 'search' takes limit parameter (optional). The limit parameter
260 allows a search to be limited one or more facets and the corresponding
261 values. This is for server side filtering.
263 Configure tweak: Use -lm for log(3) if needed
267 Fix a problem with skiparticle sortkey that could be completely
268 ignored (and reduced to "").
270 Fix dependency problem in pazpar2 RPM package (did not require
271 libyaz4 as it should).
275 Fix memory leak that occurred for command=termlist&name=xtargets .
277 Pazpar2 may save HTTP requests. Enabled by option -R.
281 Experimental support for DTIC DADS target. New dads-pz2.xsl.
283 Support for query_syntax (overrides the default for SRU | Z39.50)
285 Support for extraArgs (ZOOM "extraArgs" option) for targets
287 New commands: status-server and status-session
291 Fix for threaded runs: Client now have a copy of the database URL,
292 which can used after the database has been release from the client.
293 This makes the logging in the connection idle timeout of the client nicer (no NOURL) and should be thread-safe.
295 tmarc.xsl: Add journal-title-abbrev and full text.
297 cf.xsl: new fields: isbn, issn, journaltitle, volume, issue
299 Fix for cmd=record before search.
301 Session Logging clean up.
303 Fix wrong termlist factor when maxrecs is different from 100.
307 Fix missing pz:termlist_term_factor in settings.c messed up pz:preferred.
308 Term factor is default enabled but can be diseabled by
309 pz:termlist_term_factor=0
313 Add scaling of facet count. Currently always enabled, needs fixing.
314 Allow user-defined info for target suffix. This has no meaning in
315 Pazpar2 except to distinguish targets from each other. The suffix
316 data begins with #. For example z3950.indexdata.com/gils#Mydata
318 Added exact-match recordfilter; format name=value
322 SOLR support. Pazpar2 may operate as web service client for SOLR.
326 Fix for show command and block=1 (dead lock). Bug was introduced in
331 New RPM packages: pazpar2, pazpar2-js, pazpar2-doc. These have been
332 tested on CentOS 5.5 only.
336 Fix problem with result sets being removed from a client session
337 if the connection for it was resused by another session. Bug #3489.
339 New iphone UI for Pazpar2 (www/iphone).
343 Fixes for threaded operation.
345 New stylesheets for TurboMARC: tmarc.xsl and opac_turbomarc.xsl.
347 New example services in etc/services in source. In the Debian packages
348 these are located in /etc/pazpar2/services-available
350 Threaded mode operational on Windows. Requires Windows 7 or Windows
353 Default value of setting pz:max_connections is 0 which means that there
354 is no limit on number of connections.
358 Pazpar2 may operate in threaded mode. Enabled by element threads in
359 the configuration. See pazpar2_conf for details.
361 New setting setting: pz:max_connections. Setting pz:max_connections is
362 a limit of number of sockets to a host. When this limit is reached,
363 Pazpar2 will wait up to 5 seconds for a connection to becomes available.
364 The client will be marked Client_Error when it can not be searched
365 (other clients in a session may work). If pz:max_connections is not set
366 for a target, a value of 30 will be used. Note: the pz:max_connections
367 will only work in threaded mode.
369 pz2.js: JSON support for show.
371 Debian package: Enable default service, default.xml, before starting
372 Pazpar2 only if there is no service already in /etc/pazpar2/services-enabled.
376 Debian version depends on on libyaz4. Note that Pazpar2 will still
377 compile from source with YAZ 3.
379 Split services into separate files. The example configuration file
380 pazpar2.cfg.dist now includes a default service default.xml (part of
381 etc). And default.xml includes settings/edu.xml. The default.xml file,
382 not to be confused with settings/defaults.xml, is a template for jsdemo
383 and other services. The Debian package installs /etc/pazpar2/server.xml
384 which is now the main pazpar2 configuration (used to be called pazpar2.cfg).
385 server.xml includes services from /etc/pazpar2/services-enabled/*.xml .
386 The default.xml (from etc) is installed in /etc/pazpar2/services-available
387 and a symlink to it is created from services-enabled. The default.xml
388 service is unnamed and, thus, will be used by jsdemo and test1.
390 New setting pz:negotiation_charset. Patch from Andrei V. Toutoukine. The
391 new setting pz:negotiation_charset specifies character set for Z39.50 Init.
395 Support for additional fields in cf.xsl and pazpar2.conf.dist:
396 publisher, available, due, location (=locallocation), callno
397 (=callnumber), thumburl and score.
399 Describe pz:xslt and the auto setting.
401 Move mergekey definition away from the normalization stylesheets and
402 define a mergekey common for all target types in pazpar2.cfg.
404 Code update: Use the Odr_int type for hit counts. This is part of
405 YAZ 3.0.47 and later and so configure checks for that.
409 Metadata attribute 'skiparticle' also works for ICU based
410 normalization. (was only working for the non-ICU/ASCII before).
412 Command bytarget with argument settings=1 will show settings per
413 target.. This is to be able to verify correct settings and be able to
414 test that they are correct. The database settings array size is now
415 also stored.. Problems with database settings array is that if not
416 careful it will be too small (smaller than dictionary per-service
419 Make record list sorting stable by comparing mergekey for records if
420 relevance/title or other sorting criteria all match. This is merely to
421 ensure that our regressions tests works (reproducible output).
423 Relevance calculation changes: use a different denominator (length) for
424 per-field relevance scoring.. Instead of length of all ranked fields we
425 now use length of individual fields (as if they were individual "free"
426 text fields). This will ensure that documents with a long field with no
427 match (say description) will not "hurt" a title match.
429 Diagnostic member was not set on connection error. Fixed
433 Command search takes two optional parameters, startecs and maxrecs,
434 that specifies the start offset (0, 1, ...) and maximum number of records
435 to fetch for each target.
437 XSLTs + MARC maps are cached within a session so we don't re-parse
438 them over and over again. Even for a session with a single search
439 there's much to be gained because many targets use the same
442 The metadata attribute 'mergekey' now takes one of three values 'no',
443 'required', 'optional' . And the resulting mergekey from metadata
444 is now ordered in the same way as metadata in the service definition.
445 Older Pazpar2 version use the order in which metadata appeared in a
448 The search argument 'filter' now offers a new operator ~ which does a
449 substring match. The = operator works as before: string match for
450 anything but pz:id, or target match for pz:id.
452 New setting pz:recordfilter. The value of this setting takes the
453 form name[~value]. This setting makes Pazpar2 ignore all retrieved
454 records that do not have the metadata element name with value substring
457 Pazpar2 allows YAZ log level to be set (option -v).
461 For WS responses Pazpar2 creates XML header. Exception: raw record.
463 Setting XML files are now stored in etc/settings instead of etc. This
464 reflects the layout with the Debian package layout.
466 Settings may be posted for command=settings. The POSTed settings must
467 have root element 'settings' like regular setting files. In order to be
468 recognized, the POST request must use Content-Type=text/xml.
470 A service may be posted for command=init. This service will be used
471 during the session. The service may have its own target settings,
472 ICU config, timeout, etc. In order to be recognized, the POST request
473 must use Content-Type=text/xml.
475 Timeout values may be given per-service. That's element 'timeout'
476 which takes three attribute values (a subset may be given): 'session',
477 'z3950_operation', 'z3950_session'. Option -T is no longer supported
478 - used to specify session timeout.
480 Option -t tests the Pazpar2 configuration and returns exit code
481 (0=success, non-zero=failure). In previous version of Pazpar2, -t
482 specified local settings.
484 In version 1.2.0 the configuration file - after include processing -
485 was dumped to stdout. Now, the configuration is only dumped to the
486 yaz log file if option -d is given.
490 Configuration may now have multiple server areas. This means that a
491 Pazpar2 instance may listen on multiple ports. Virtual hosting is not
492 yet supported - on a server basis. Configuration may also have multiple
493 services .. That is repeating service elements inside a server. Each
494 has an attribute 'id' which serves as service ID. This ID in turn may
495 be used in a Pazpar2 session, by specifying parameter service=ID for
496 command init. There can be at most one unnamed service inside a server
497 which can be referred to by not specifying an service ID for command
498 init (backwards compatible). In order to partition multiple servers and
499 services a new include directive has been added. This takes an attribute
500 'src' which specifies one or more sub-files. For example to include
501 service files, one might use:
502 <server >.. <include src=/"etc/pazpar2/conf.d/*.xml"/> .. </server>.
503 It is the intention that that completely makes the settings directive
506 Fix problem where the record command would wait forever if there were
507 no targets to wait for (activeclients == 0).
511 One result set is created per session (last search) rather than for
512 each connection which happen to be shared (bug #3009).
514 marc21 stylesheets changed for efficiency.
518 Session timeout may be specified on the command-line as option -T.
520 Pazpar2 may now be operated in a no-merged mode for records.. All records
521 will be considered unique. This mode is enabled if no mergekey is
522 generated by the normalization stylesheet (pz:xslt).
524 Pazpar2 caches original records from each target and the 'record' command
525 with offset returns the original record if 'syntax' and 'esn' are NOT
526 specified. This speeds up retrieval of original records but also means
527 that Pazpar2 uses more memory. The cached records will be freed when the
528 session terminates or a new search is executed.
530 Pazpar2 no longer uses its own ICU wrapper. Instead the ICU wrapper
531 library part of YAZ is used.
533 Added SRU client support.
535 Automatically computes pz:nativesyntax if not provided. Works for XML and
538 --- 1.0.13 2008/11/24
540 Command bytarget returns name of target (if defined).
542 --- 1.0.12 2008/11/04
544 Fixed bug #2021.. location now holds all brief elements.
546 --- 1.0.11 2008/10/15
548 Fixed check for application/x-www-form-urlencoded parameters.
550 --- 1.0.10 2008/10/14
552 Fixes for IE in pz2.js.
554 Fixed bug #2021: non-merged, brief meta data NOT included for command=show.
558 Changed the JS library pz2.js to use POST for long URL (+ params).
560 Added installation instructions for Windows. Note: NT services is
561 NOT available until we make a new release of YAZ.
563 Preserve order of repeated metadata fields (they were reversed before).
565 More MARC21 information extracted for metadata.
569 Fixed bug #1162: HTML entities are not escaped properly.
571 Native Windows port of Pazpar2. Makefile for Visual Studio provided.
575 Marc21 stylesheet updated to reflect multiple full text fields
579 Fixed bug in pz2.js WRT DOMElement attributes on IE.
581 Fixed bug 2100: Database wildcards not working
585 Added support for retrieval of records in binary.
587 Fixed bug 1794: Pazpar2 does not return valid XML.
589 Deal with ICU not returning sortkey (resulted in SEGV before).
593 JavaScript library pzw2.js throws error if WS response (from Pazpar2 or
594 other) is malformed (non-wellformed XML or missing Pazpar2 OK status).
596 Improved diagnostics when Pazpar2 HTTP decoding fails.
598 Pazpar2 requests may be POSTed as using Content-Type
599 application/x-www-form-urlencoded.
601 Pazpar2 honors LF in HTTP headers.
603 Handle targets that handle negative hit counts (should not happen, but it
608 ICU is used for tokenization and normalization of the following: mergekey,
609 sorting, relevance terms.
611 Debian package now enables ICU tokenization and normalization by default.
615 Exposed user setting values (i.e. non-pz: names) to the record systems in two
616 ways: Either as parameters to the normalization stylesheets (which would allow the
617 programmer to postprocess or use the values in any way) or after the normalization
618 step, in which case values are made part of the normalized record (and available for
619 sorting, termlists, display, or other interface-related use.
621 Implemented sorting by year.
623 Option -d dumps records to the current log file instead of stderr.
625 Fixes for compilation on cygwin.
627 Z39.50 client code uses pz:elements. pz:elements was recognized in
628 earlier Pazpar2 versions but it was not used for anything.
630 icu_chain_test is using fgets instead of getline - fixes compilation
633 Loosen the CCL query parsing so that Pazpar2 only returns error if _all_
634 query conversions fail (rather than _any_). This means targets that do
635 not support some fields are ignored in a search.
639 Improved handling of socket timeout for Z39.50 connections.
641 Misc documentation updates and spell fixes.
643 Debian package pazpar2 creates log rotate entry.
645 Debian package pazpar2-apache2 reloads Apache2.
647 jsdemo included in distribution. It illustrates the use of the js/pz2.js
652 First public release.