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