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