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