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