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