Document bug fixes
[idzebra-moved-to-github.git] / NEWS
1
2 Fixed bug in record management. Releasing blocks could result in
3 partial read.
4
5 Fixed bug in isam:b. A tree split could result in a lost item.
6
7 Remove isamd. It's not been in use for a long time and isamb is better
8 in most cases.
9
10 Change SYSNO to be zint. Change pointers in isamc and isamb to zint.
11 Change block number in bfile/cfile to zint. zint is a long integer
12 (64-bit). This change practially removes register limits for Zebra.
13
14 Implement int-list encoding for ISAMs.
15
16 Added facility to make attibutes in grs.regx and grs.tcl filter using the
17 data command with argument -attribute <name> . The content of data is
18 the value of the attribute. This command should be used inside a
19 begin element , end element section.
20
21 Update zebra.nsi to NSIS 2.
22
23 Added a new 'cut' directive to charmaps (.chr files) which specifies that
24 only characters after the cutting char should be indexed.
25
26 Update Perl internals so that it matches the current Zebra API.
27 The recordGroup structure is no longer available. A group of resources
28 can still be referenced by setting groupName=>..  in various methods.
29
30 Maximum number of records to be sorted in a result set can be
31 specified by setting "sortmax". Default is 1000.
32
33 Allow use of string use attributes for regular attribute sets. The
34 name matches the name given in the attribute set file. All strings
35 starting with / are considered X-Path as usual.
36
37 Fixed bug in grs.regx. filter . 'end element' could pop off top tag
38 element for XML tree. It may only pop off if -record is given.
39
40 Added grs.danbib filter - for Danish Bibliographic Centre.
41
42 Rename CHANGELOG to NEWS.
43
44 For text filter, return only header if elementSetName=H . elementSetName=R
45 returns contents only. Other elementSetName returns both header+content.
46
47 Added test for charmap and rusmarc.
48
49 Added feature charmaps (.chr) so that characters may be specified in
50 \LXXXX HEX notation.
51
52 Fixed problem with encoding directive for charmap(.chr) files.
53
54 Allow Remote insert/delete/replace/update with record, recordIdNumber
55 (sysno) and/or recordIdOpaque(user supplied record Id). If both
56 IDs are omitted internal record ID match is assumed (recordId: - in
57 zebra cfg).
58
59 --- 1.3.15 2004/01/15
60
61 Fix bug. X-Path attribute expressions with spaces in them now works.
62
63 Fix base address for MARC output.
64
65 --- 1.3.14 2003/11/29
66
67 Fix bug with shadow and result set handling.
68
69 Implement MARCXML to ISO2709 conversion.
70
71 --- 1.3.13 2003/09/26
72
73 Add missing examples for Windows install.
74
75 Fix bug in regx filter to make it "greedy" again. This bug appeared
76 in version 1.3.12.
77
78 Fix a few tests.
79
80 --- 1.3.12 2003/09/08
81
82 Fix XML error handling. Stop XML parse immediately if XML parse error
83 occur (i.e.  produce one error only).
84
85 Zebra ignores "unsupported use attribute" for individual databases
86 when search multiple databases (unless all databases fail).
87
88 New filter grs.marcxml which works like grs.marc but produces MARCXML.
89
90 Added support for database deletion. It is possible to create/drop
91 a database from zebraidx utility. Note: only for isam:b.
92
93 Write zebrasrv.pid to lockdir.
94
95 Bug fix: result sets were not recovered correctly. Had to
96 add ODR handle for zebra_search_RPN in order to make it work.
97
98 Fixed a bug in regx filters that didn't do anchors (^) correctly.
99
100 Fixed a bug in searches with X-Path searches sometimes giving "extra"
101 hits.
102
103 Zebra server checks for zebrasrv.pid and refuses to start if it is already
104 locked by another (running) zebrasrv.
105
106 Fixed a bug with text being chunked in pieces for the grs.xml filter.
107
108 --- 1.3.11 2003/04/25
109
110 xelm code updates. xelm works regardless state of 'xpath enable/disable'
111 Avoid -L/usr/lib since that is already default library path.
112
113 Allow multiple updates within one transaction.
114
115 Fixed a bug with >2GB files (overflow in integer expression).
116
117 --- 1.3.10 2003/04/01
118
119 Fix linker error for Perl module.
120
121 Fix bug in and operation which in some cases could result in "extra"
122 hits. Bug was introduced in 1.3.5.
123
124 Fix bug in handling of schema conversion when producing numeric tags.
125
126 --- 1.3.9 2003/03/27
127
128 Zvrank updates. 
129
130 Add missing files doc/zvrank.txt and doc/marc_indexing.xml.
131
132 --- 1.3.8 2003/03/26
133
134 Zvrank: an experimental ranking algorithm. See doc/zvrank.txt and
135 source in index/zvrank.c. Enable this by using rank: zvrank in zebra.cfg.
136 Contributed by Johannes Leveling <Johannes.Leveling at fernuni-hagen.de>
137
138 livrank: another experimental ranking algorithm. Source in livcode.c.
139 Enable this by using rank: livrank in zebra.cfg and use -DLIV_CODE=1
140 for CFLAGS.
141 Contributed by Pete Mallinson, University of Liverpool. 
142
143 Advanced MARC indexing. See doc/marc_indexing.xml
144  Oleg Kolobov <oleg at lib.tpu.ru>
145
146 Perl API updates and fixes. 
147  Peter Popovics <pop at technomat.hu>
148
149 Fixed 'zebraidx delete'.
150
151 Implemented 'zebraidx clean'.
152
153 64-bit offsets for register files on WIN32 (no 2 GB limit).
154
155 Fixed a few memory leaks WRT sorting.
156
157 --- 1.3.7 2003/02/27
158
159 Fixed error handling : error code was not properly returned.
160
161 Support Truncation 104 (CCL).
162
163 --- 1.3.6 2003/02/25
164
165 Added missing source files for perl extension.
166
167 --- 1.3.5 2003/02/23
168
169 Implemented xelm directive.
170
171 Updated for newer version of YAZ (introduction of string schema).
172
173 Directory examples/zthes now part of distribution (was missing
174 in previous release).
175
176 New .abs directive, systag, that control where to put retrieval
177 information. The directive takes two arguments: system tag, element name.
178 System tag is one of : rank, sysno, size.
179
180 --- 1.3.4 2002/11/26
181
182 Perl Filter and Perl API. By Peter Popovics.
183
184 For zebra.cfg, if no profilePath is specified, directory
185  (prefix)/share/idzebra/tab
186 is used.
187
188 Zebra Examples in examples . Zebra tests in test.
189
190 Bug fix: sort index was not properly modified on 
191 record updates/deletes.
192
193 Fix handling of character entities for sgml filter.
194
195 Move data1 to Zebra (used to be part of YAZ).
196
197 --- 1.3.3 2002/10/05
198
199 Fix character encoding of scan response terms.
200
201 Fix character decoding of scan request terms.
202
203 Fix ESpec handling (requires YAZ 1.9.1)
204
205 Fix searches for complete fields.
206
207 --- 1.3.2 2002/09/09
208
209 When name zebra is used in a filename or directory 'idzebra' is used
210 instead to avoid confusion with GNU zebra (routing software).
211
212 Zebra server stops with a fatal error if config file cannot be read.
213
214 New config setting, followLinks, that controls whether update of files
215 should follow symbolic. Set it to 1 (for enable) or 0 (to disable).
216 By default symbolic links are followed.
217
218 Fix MARC transfer . MARC fields had wrong data for multiple fields.
219
220 XML record reader moved from YAZ to Zebra, to make YAZ less 
221 dependant on external libraries.
222
223 Zebra uses yaz_iconv which is mini iconv library supporting UTF-8,
224 UCS4, ISO-8859-1. This means that Zebra does UNICODE even
225 on systems that doesn't offer iconv.
226
227 XML record reader supports external system entities.
228
229 --- 1.3.1 2002/08/20
230
231 New .abs-directive "xpath" that takes one argument: "enable"
232 or "disable" to enable and disable XPath -indexing. If no "xpath"
233 direcive is found in .abs-file , XPath-indexing is disabled to ensure
234 backwards compatibility. For missing .abs-files XPath-indexing is
235 enabled so that such records are searchable.
236
237 Zebra warns about missing .abs-file only once (for each type).
238
239 Fixed a bug in file update where already-inserted files could
240 be treated as "new".
241
242 --- 1.3.0 2002/08/05
243
244 Zebra license changed to GNU GPL.
245
246 XPath-like queries used when RPN string attributes are used, eg.
247    @attr 1=/portal/title sometitle
248    @attr 1=/portal/title[@xml:lang=da] danishtitle
249    @attr 1=/portal/title/@xml:lang da
250    @attr 1=//title sometitle
251
252 Zebra uses UTF-8 internally:
253 1) New setting "encoding" for zebra.cfg that specifies encoding for
254 OCTET terms in queries and record encoding for most transfer syntaxes
255 (except those that use International Strings, such as GRS-1).
256 2) The encoding of International strings is UTF-8 by default. It
257 may be changed by character set negotiation. If character set
258 negotiation is in effect and if records are selected for conversion
259 these'll be converted to the selected character set - thus overriding
260 the encoding setting in zebra.cfg.
261 3) New directive "encoding" in .abs-files. This specifies the external
262 character encoding for files indexed by zebra. However, if records
263 themselves have an XML header that specifies and encoding that'll be used
264 instead.
265
266 XML filter (-t grs.xml).
267
268 Multiple registers. New setting in resource 'root' that holds base
269 directory for register(s). A group a databases may be put in separate
270 register in directory root/reg by using db name 'reg/db1' ... 'reg/dbN'.
271
272 --- 1.1.1 2002/03/21
273
274 Fixes for Digital Unix
275
276 Implemented hits per term using USR:SearchResult-1.
277
278 New Zebra API. Locking system re-implemented.
279
280 --- 1.1.stable 2002/02/20
281
282 Rank weight can be controlled with attribute type 9. Default
283 value is 34. Recommended values between 1-36.
284
285 --- 1.1 2001/10/25
286
287 Updated for YAZ version 1.8.
288
289 Added support for termsets - a result set of terms matching
290 a given query. For @attr 8=<set> creates termset named <set>.
291
292 Added support for raw retrieval. Element Set Name R forces the
293 text filter which returns the record in its original form.
294
295 Added numerical sort - triggered by structure=numeric (4=109).
296
297 Remote record import using Z39.50 Extended Services and Segments.
298
299 Fixed bug where updating a database with user-defined attributes
300 could corrupt the register (bad storeKeys).
301
302 Multi-threaded version.
303
304 Fixed bug regarding proximity.
305
306 Documentation updates.
307
308 Fixed bug in record retrieval module that occured on 64-bit OSF 
309 architectures.
310
311 --- 1.0.1 2000/2/10
312
313 Fixed bug in makefile for WIN32.
314
315 Fixed bug in configure script - used bash-specific features.
316
317 --- 1.0 1999/12/10
318
319 Added support for multiple records in one file for filter grs.sgml.
320
321 Changed record index structure. New layout is incompatible with
322 previous releases. Added setting "recordcompression" to control
323 compression of records. Possible values are "none" (no
324 compression) and bzip2 (compression using libbz2).
325
326 Added XML transfer syntax support for retrieval of structured records.
327 Schema in CompSpec is recognised in retrieval of structured records.
328
329 Changed Tcl record filter so that it attemps to read  <filt>.tflt. If
330 that fails, the filter reads the file <filt>.flt (regx style filter).
331
332 Implemented new Tcl record filter -  use grs.tcl.<filter> to enable it.
333 Zebra's configure script automatically attempts to locate Tcl. For
334 manual Tcl configuration use option --with-tclconfig=<path> to specify
335 where Tcl's library files are located.
336
337 Implemented "compression" of Dictionary and ISAM system. Dictionary
338 format HAS changed.
339
340 Added "tagsysno" directive to zebra.cfg to control under which tag the
341 system ID is placed. Use tagsysno: 0 to disable Zebra's system number
342 entirely.
343
344 Added "tagrank" as above.
345
346 Changed file naming scheme for register files from <name>.mf.<no> to
347 <name>-<no>.mf.
348
349 Implemented "position"-flag for register type (as defined in
350 default.idx). When set to zero no position (or seqence number) is
351 saved in register for each word occurrence, thus saving some register
352 space.
353
354 Implemented database mapping. Using mapdb one can specify a database
355 to be mapped to one or more physical databases. Usage:
356 mapdb <fromdb> <todb> ..
357
358 Added SOIF-filter. Thanks to Peter Valkenburg.
359
360 For the regx-filter "end element -record" may trigger a mark-of-record
361 if outer level is reached.
362
363 Tag sets may be typed in the reference to it. From the .abs-file the
364 "tagset" directive takes a third optional integer type for the tag set
365 referenced. From a .tag-file the "include" directive takes a third
366 optional type as well. The old "type" directive in the tag set itself
367 is still recognized but acts as the default type for the tag set.
368  
369 Zebra supports the specification of arbitrary attributes sets, schemas
370 and tag sets, because of the change in YAZ' OID management system.
371
372 Fixed bug in Sort that caused it NOT to use character mapping as it
373 should.
374
375 Zebra now uses GNU configure to generate Makefile(s).
376
377 Added un-optimised support for left and left/right truncation attributes.
378
379 Added support for relational operators on text when using RPN queries.
380
381 Added support for sort specifications in RPN queries. Type 7 specifies
382 'sort' where value 1=ascending, value 2=descending. The use attribute
383 specifies the field criteria as usual.  The term specifies priority
384 where 0=first, 1=second, ...
385
386 Changed the way use attributes are specified in the recordId
387 specification.
388
389 Maximum number of databases in one Zebra register increased.
390
391 New setting, databasePath, which specifies that first directory during
392 update traversal is the database name (instead of a fixed one).
393
394 New setting, explainDatabase, which specifies that databases are
395 EXPLAIN aware.
396
397 Modified Zebra so that it works with ASN.1 compiled code for YAZ.
398
399 Implemented EXPLAIN database maintenance. Zebra automatically
400 generate - and update CategoryList, TargetInfo, DatabaseInfo,
401 AttributeSetInfo and AttributeDetails records at this stage. The
402 records may be transferred as GRS-1, SUTRS or Explain.
403
404 Fixed register spec so that colon isn't treated as size separator
405 unless followed by [0-9+-] in order to allow DOS drive specifications.
406
407 Fixed two bugs in ISAMC system.
408
409 Changed the way Zebra keeps its maintenance information about attribute
410 sets, available attributes, etc.. Records in "SGML" notation using an
411 EXPLAIN schema is now used when appropriate.
412
413 Bug fix: Index didn't handle update/insert/delete of the same record
414 (i.e. same recordId) in one run (one invocation of zebraidx). Only the
415 first occurence of a record is considered.
416
417 Most searches now return correct number of hits.
418
419 New modular ranking system. Interested programmers are encouraged to
420 inspect rank1.c and improve the algorithm.
421
422 Bug fix: Lock files weren't removed as they should on NT.
423
424 Implemented Z39.50 Sort. Zebra's sort handler uses use attributes to
425 specify a "sort register". Refer to the gils sample records which refer
426 to index type "s" which is specified as "sort" in the default.idx file.
427 Each sort criteria can either be Ascending or Descending and at most
428 three sort elements can be specified.  
429
430 Bug fix: Character mapping didn't work for text files.
431
432 --- 1.0b1 1998/1/29
433
434 Simple ranked searches now return correct number of hits.
435
436 The test option (-s) only makes a read-lock on the index as well
437 as using read-only operations anywhere.
438
439 Moved towards generic character mapping. Configuration file default.idx
440 specifies character map files for register types w, p, u, etc.
441
442 Implemented "begin variant" for the sgml.regx - filter.
443
444 Fixed a few memory leaks.
445
446 Added support for C++, headers uses extern "C" for public definitions.
447
448 Bug fix: The show records facility (-s) only displayed information for
449 the first record in a file (and not for every record in the file).
450
451 Added option "-f <n>" to limit the logging of record operations. After
452 <n> records has been processed no logging is performed (unless errors
453 occur).
454
455 Bug fix: the compressed ISAM system didn't handle update operations
456 correctly.
457
458 Added setting, "maxResultSetSize", to hold the number of records to 
459 save in a result set.
460
461 Bug fix: Complete phrase did't work for search operations.
462
463 Bug fix: temporary result sets weren't deleted.
464
465 Reduced disk space for saved keys (storeKeys = 1).
466
467 Added optional, physical ANY (key replication)
468
469 Implemented proximity operator in search.
470
471 Bug fix: the path name buffers used by file match traversal routines
472 have been extended to support long file names.
473
474 New C(ompressed) ISAM system. To enable it, specify "isam: c" in the
475 configuration file. The resulting register without "storeKeys" is about
476 half the size, and the memory used by zebraidx during phase 2 (merge) is
477 reduced to a minimum.
478
479 Reworked the way Regexp-2 queries with error tolerance are handled and
480 specified. The documentation has been updated accordingly.
481
482 Bug fix: Zebrasrv didn't search correctly when queries contained masking
483 characters. This bug was introduced in 1.0a8.
484
485 Zebrasrv now tag records with the proper database name.
486
487 New settings, memMax and keyTmpDir.
488
489 Changed name of setting lockDir (previously called lockPath) and
490 setTmpDir (previously called tempSetPath).
491
492 Generalized and changed record type specifications. In short, there are:
493        text                plain SUTRS
494        grs.sgml            structured, "SGML-like" syntax
495        grs.regx.<filter>   structured, Regular expression filter
496        grs.marc.<abs>      Reads *MARC records in the ISO2709 format. <abs>
497                            is the name of an abstract syntax file.                           
498 Bug fix: Result sets weren't sorted in operations involving boolean
499 operations with "ranked" operands.
500
501 --- 1.0a8 1996/6/6
502
503 Added national character-handling subsystem.
504
505 Various fixes.
506
507 Small modifications to input filters and profiles.
508
509 Added support for SOIF syntax (with private OID).
510
511 --- 1.0a7 1996/5/16
512
513 Fixed buffer-size problem in indexing.
514
515 Added compression to temporary files for updating.
516
517 Added phrase registers.
518
519 Added dynamic mapping of search attribute to multiple termlists (ANY).
520
521 Scan support in multiple databases/registers.
522
523 Configuration settings are case-insensitive and single dash (-)
524 characters are ignored in comparisons.
525
526 The index processing ignores empty files - warning given.
527
528 New option to zebraidx (-V) displays version information.
529
530 --- 1.0a6 1996/2/24
531
532 Fixed problem in file-update system.
533
534 Fixed problem in shadow system; register was sometimes corrupted after
535 a commit operation.
536
537 --- 1.0a5 1996/2/10
538
539 Fixed problems in the ISAM subsystem. Caused difficulties when updating
540 existing registers.
541
542 Fixed small problem in SUTRS-filter. A newline was sometimes inserted before
543 the rank and record number.
544
545 Fixed bug in the isam subsystem - caused a malfunction when accessing
546 words which occurred more than 10000 times.
547
548 Distribution should now include YAZ (Z39.50 protocol stack) to simplify
549 installation.
550
551 Server can now run under inetd. Use option -i, and -w <directory> to
552 set working directory to desired location.
553
554 New zebraidx command: clean - removes temporary shadow files.
555
556 Fixed bug in ISAM system. Occurred rarely during register updates.
557
558 Logging during index merge phase is improved. The remaining running
559 time is estimated.
560
561 Temporary files generated by zebraidx are removed after each run.
562
563 Bug fix: Dictionary didn't handle 8-bit characters correctly; was obvious
564 when doing scan operations in dictionaries with European characters.
565
566 --- 1.0a4 1996/01/11
567
568 A whole slew of updates, to make the first publicized release. Get the doc
569 and check it out.
570
571 --- 1.0a3 1995/12/06
572
573 Memory-problems in ISAM fixed. More blocktypes added to the default setup
574 to increase performance on larger databases.
575
576 Various minor changes in data management system.
577
578 --- 1.0a2 1995/12/05
579
580 A couple of portability-problems resolved.
581
582 Changed some malloc() to xmalloc().
583
584 --- 1.0a1 1995/11/28
585
586 First release.