X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=doc%2Fbook.xml;h=6b4c3f3d3aa4b7c25f9c456d75f74accdb360183;hp=202518fee2ae27a7faf522c666075bd0fe13d327;hb=f332be40c2edee783d37633597b4f7ac3b22fc3e;hpb=7f79b3a521ea4d5d4e89f8659324019cecc0fe8a
diff --git a/doc/book.xml b/doc/book.xml
index 202518f..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 .
@@ -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
@@ -925,7 +925,7 @@
- WIN32
+ WindowsThe easiest way to install YAZ on Windows is by downloading
an installer from
here.
@@ -934,12 +934,12 @@
- Compiling from Source on WIN32
+ Compiling from Source on Windows
&yaz; is shipped with "makefiles" for the NMAKE tool that comes
with
Microsoft Visual Studio. It has been tested with
- Microsoft Visual Studio 2003/2005/2008.
+ Microsoft Visual Studio 2013.
Start a command prompt and switch the sub directory
@@ -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.
@@ -2126,28 +2138,37 @@
The type is a string of the format:
- format[;charset=from[/opacfrom][,to]][;format=v]
+ format[;charset=from[/opacfrom][,to]][;format=v][;base64=xpath]
- where format specifies the format of the
- returned record, from
+ If charset is given, then from
specifies the character set of the record in its original form
(as returned by the server), to specifies
- the output (returned)
- character set encoding.
- If to is omitted UTF-8 is assumed.
+ the output (returned) character set encoding.
+ If to is omitted, then UTF-8 is assumed.
If charset is not given, then no character set conversion takes place.
-
-
- OPAC records may be returned in a different
- set from the bibliographic MARC record. If this is this the case,
+ OPAC records may be returned in a different
+ set from the bibliographic MARC record. If this is this the case,
opacfrom should be set to the character set
of the OPAC record part.
+
+
+ The format is generic but can only be used to
+ specify XML indentation when the value v
+ is 1 (format=1).
+
+
+ The base64 allows a full record to be extracted
+ from base64-encoded string in an XML document.
+
Specifying the OPAC record character set requires YAZ 4.1.5 or later.
+
+ Specifying the base64 parameter requires YAZ 4.2.35 or later.
+
The format argument controls whether record data should be XML
@@ -2554,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
@@ -2611,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.
@@ -2645,6 +2698,11 @@
none
+ itemorder-setname
+ Name of result set for record
+ default
+
+ itemorder-itemPosition for item (record) requested. An integer1
@@ -2652,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.
@@ -2762,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.
@@ -2792,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.
@@ -2821,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.
@@ -5721,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, ...
@@ -7384,21 +7553,25 @@ int cql_transform_rpn2cql_wrbuf(cql_transform_t ct,
- xslt
+ select
- The xslt element specifies a conversion
- via &acro.xslt;. The following attributes may be specified:
+ The select selects one or more text nodes
+ and decodes them as XML.
+ The following attributes may be specified:
- stylesheet (REQUIRED)
+ path (REQUIRED)
- Stylesheet file.
+ X-Path expression for selecting text nodes.
+
+ This conversion is available in YAZ 5.8.0 and later.
+
@@ -7416,6 +7589,24 @@ int cql_transform_rpn2cql_wrbuf(cql_transform_t ct,
+
+ xslt
+
+
+ The xslt element specifies a conversion
+ via &acro.xslt;. The following attributes may be specified:
+
+ stylesheet (REQUIRED)
+
+
+ Stylesheet file.
+
+
+
+
+
+
+