X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=doc%2Fbook.xml;h=6b4c3f3d3aa4b7c25f9c456d75f74accdb360183;hp=462cb7f424a21d0a305b6a5e4573d9046fc135a1;hb=f332be40c2edee783d37633597b4f7ac3b22fc3e;hpb=80d0b86c41a5934878cb51657e92060909f320f4
diff --git a/doc/book.xml b/doc/book.xml
index 462cb7f..6b4c3f3 100644
--- a/doc/book.xml
+++ b/doc/book.xml
@@ -78,7 +78,7 @@
Supports
- Solr Web Service version 1.4.x
+ Apache Solr Web Service version 1.4.x
(client side only)
@@ -138,14 +138,14 @@
Reading this Manual
Most implementors only need to read a fraction of the
- material in thie manual, so a quick walkthrough of the chapters
+ material in this manual, so a quick walkthrough of the chapters
is in order.
contains installation
- instructions for &yaz;. You don't need reading this
+ instructions for &yaz;. You don't need to read this
if you expect to download &yaz; binaries.
However, the chapter contains information about how
to make your application link
@@ -155,7 +155,7 @@
describes the ZOOM API of &yaz;.
- This is definitely worth a read if you wish to develop a Z39.50/SRU
+ This is definitely worth reading if you wish to develop a Z39.50/SRU
client.
@@ -169,7 +169,7 @@
describes how to use the &yaz; Z39.50
- client. If you're developer and wish to test your server
+ client. If you're a developer and wish to test your server
or a server from another party, you might find this chapter
useful.
@@ -202,7 +202,7 @@
goes through the details of the
ODR module which is the work horse that encodes and decodes
BER packages. Implementors using ZOOM only, do not
- need reading this.
+ need to read this.
Most other Z39.50 implementors only need to read the first two
sections ( and
).
@@ -244,7 +244,7 @@
level APIs of &yaz;.
- The YAZ toolkit modules is shown in figure .
+ The YAZ toolkit modules are shown in figure .
YAZ layers
@@ -325,7 +325,7 @@
If you are using the premade definitions of the &asn; module, and you
- are not adding new protocol of your own, the only parts of &odr; that you
+ are not adding a new protocol of your own, the only parts of &odr; that you
need to worry about are documented in
.
@@ -496,7 +496,7 @@
Automake and
Libtool
are used to generate Makefiles and configure &yaz; for the system.
- You do not these tools unless you're using the
+ You do not need these tools unless you're using the
Git version of &yaz;.
@@ -508,7 +508,7 @@
&yaz; includes a tiny ASN.1 compiler. This compiler is
written in Tcl.
But as for Bison you do not need it unless you're using Git
- version of &yaz; or you're using the compiler to built own codecs
+ version of &yaz; or you're using the compiler to build your own codecs
for private ASN.1.
@@ -612,7 +612,7 @@
prefix. By default configure will
search for iconv on the system. Use this option if it
doesn't find iconv. Alternatively,
- --without-iconv, can be uset to force &yaz;
+ --without-iconv, can be used to force &yaz;
not to use iconv.
@@ -627,7 +627,7 @@
prefix.
Use this option if you want XSLT and XML support.
By default, configure will
- search for libxslt on the system. Use this option if it
+ search for libxslt on the system. Use this option if
libxslt is not found automatically. Alternatively,
--without-xslt, can be used to force &yaz;
not to use libxslt.
@@ -644,7 +644,7 @@
prefix.
Use this option if you want &yaz; to use XML and support SRU/Solr.
By default, configure will
- search for libxml2 on the system. Use this option if it
+ search for libxml2 on the system. Use this option if
libxml2 is not found automatically. Alternatively,
--without-xml2, can be used to force &yaz;
not to use libxml2.
@@ -857,7 +857,7 @@
This section describes how to compile - and link your own
applications using the &yaz; toolkit.
If you're used to Makefiles this shouldn't be hard. As for
- other libraries you have used before, you have to set a proper include
+ other libraries you have used before, you need to set a proper include
path for your C/C++ compiler and specify the location of
&yaz; libraries. You can do it by hand, but generally we suggest
you use the yaz-config that is generated
@@ -1026,7 +1026,7 @@
- libxslt depends libxml2.
+ libxslt depends on libxml2.
@@ -1138,7 +1138,7 @@
bin/yaz-icu.exeThis program exposes the ICU wrapper library if that
is enabled for YAZ. Only if ICU is available this program is
- build.
+ built.
@@ -1154,7 +1154,7 @@
bin/zoomtst1.exe,
bin/zoomtst2.exe, ..
- Several small applications that demonstrates the ZOOM API.
+ Several small applications that demonstrate the ZOOM API.
@@ -1221,14 +1221,21 @@
nmake install
+
+
+ There's an error in configure.js for Libxml2 2.9.2.
+ Line 17 should be assigned to configure.ac
+ rather than configure.in.
+
+
For Libxslt it is similar. We must ensure that compilation of
Libxslt links against the already installed libxml2.
cd win32
cscript configure.js prefix=c:\libxslt-1.1.28.win32 iconv=no \
- lib=c:\libxmlt-2.9.2.win32\lib \
- include=c:\libxmlt-2.9.2.win32\include\libxml2
+ lib=c:\libxml2-2.9.2.win32\lib \
+ include=c:\libxml2-2.9.2.win32\include\libxml2
nmake
nmake install
@@ -1530,6 +1537,11 @@
first operation), holds the negotiated version with the server
(same or lower version).
1.2
+
+ extraArgs
+ Extra arguments for SRU/Solr URLs. The value must be
+ URL encoded already.
+
facets
Requested or recommend facets may be given before a search is sent.
@@ -2563,6 +2575,37 @@
The type specifies the actual extended service
package type to be sent.
+
+ Extended Service Type
+
+
+
+
+
+ Type
+ Description
+
+
+
+
+ itemorderItem Order
+
+
+ updateRecord Update
+
+
+ createDatabase Create
+
+
+ dropDatabase Drop
+
+
+ commitCommit Operation
+
+
+
+
+
Extended Service Common Options
@@ -2620,7 +2663,8 @@
Item Order
- For Item Order, type must be set to itemorder in
+ For Item Order, type must be set to
+ itemorder in
ZOOM_package_send.
@@ -2654,6 +2698,11 @@
none
+ itemorder-setname
+ Name of result set for record
+ default
+
+ itemorder-itemPosition for item (record) requested. An integer1
@@ -2661,11 +2710,113 @@
+
+ There are two variants of item order: ILL-variant and
+ XML document variant. In order to use the XML variant the setting
+ doc must hold the XML item order document. If that
+ setting is unset, the ILL-variant is used.
+
+
+
Record Update
- For Record Update, type must be set to update in
+ For Record Update, type must be set to
+ update in
ZOOM_package_send.
@@ -2771,7 +2922,8 @@
Database Create
- For Database Create, type must be set to create in
+ For Database Create, type must be set to
+ create in
ZOOM_package_send.
@@ -2801,7 +2953,8 @@
Database Drop
- For Database Drop, type must be set to drop in
+ For Database Drop, type must be set to
+ drop in
ZOOM_package_send.
@@ -2830,7 +2983,8 @@
Commit Operation
- For Commit, type must be set to commit in
+ For Commit, type must be set to
+ commit in
ZOOM_package_send.
@@ -5730,6 +5884,12 @@ typedef struct {
in YAZ 4.2.38.
+ s=sl
+
+ Tokens are split into sub-phrases of all combinations - in order.
+ This facility appeared in YAZ 5.14.0.
+
+ r=o
Allows ranges and the operators greather-than, less-than, ...