X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Freference.xml;h=2ef809c4f7706bbfa77a921930d1063e69c11788;hb=998f61ee781572d924d22fa9669554dc2192be50;hp=aa5fe2b355ac2bc40fc1fd348b48b75d76c85a57;hpb=1e2e736eef09428424ada345008ae45b34c5441f;p=yazproxy-moved-to-github.git
diff --git a/doc/reference.xml b/doc/reference.xml
index aa5fe2b..2ef809c 100644
--- a/doc/reference.xml
+++ b/doc/reference.xml
@@ -32,7 +32,7 @@
usual YAZ address format (typically
tcp:hostname:port)
as described in
- the Addresses section of the YAZ manual.
@@ -58,14 +58,13 @@
- If the proxy receives an SRW/SRU request, the following rules are used.
+ If the proxy receives an SRU request, the following rules are used.
If default target has Explain information with a
database that matches the path of the
- HTTP request of SRW/SRU that backend server is used for
- SRW/SRU operation.
-
+ HTTP request of SRU that backend server is used for SRU operation.
+
@@ -74,13 +73,6 @@
-
-
- We know it is stupid to only check for explain in default target.
- It means that it is only possible to offer one SRW/SRU server.
- We expect to improve that in the next version of the YAZ proxy.
-
-
Keep-alive Facility
@@ -199,8 +191,8 @@
The config file is XML based. The YAZ proxy must be compiled
- with libxml2 and
- libXSLT support in
+ with libxml2 and
+ libXSLT support in
order for the config file facility to be enabled.
@@ -221,13 +213,13 @@
The proxy config file must have a root element called
proxy and scoped within namespace
- xmlns="http://indexdata.dk/yazproxy/schema/0.8/.
+ xmlns="http://indexdata.dk/yazproxy/schema/0.9/".
All information except an optional XML header must be stored
within the proxy element.
<?xml version="1.0"?>
- <proxy xmlns="http://indexdata.dk/yazproxy/schema/0.8/">
+ <proxy xmlns="http://indexdata.dk/yazproxy/schema/0.9/">
<!-- content here .. -->
</proxy>
@@ -245,16 +237,17 @@
equivalent to command line option -t.
-
- <?xml version="1.0"?>
- <proxy xmlns="http://indexdata.dk/yazproxy/schema/0.9/">
- <target name="server1" default="1">
- <!-- description of server1 .. -->
- </target>
- <target name="server2">
- <!-- description of server2 .. -->
- </target>
- </proxy>
+
+
+
+
+
+
+
+
+
+ ]]>
@@ -299,6 +292,16 @@
+
+ max-sockets
+
+ The element max-sockets is the child of element
+ target and specifies the maximum number of sockets
+ to use for the target for all sessions using it. In other words: maximum
+ number of Z39.50 session to the target.
+
+
+
keepalive
The keepalive element holds information about
@@ -420,7 +423,8 @@
syntax
The syntax element specifies accept or reject
- or a particular record syntax request from the client.
+ or a particular record syntax request from the client. It also
+ allows record conversion of XML records via XSLT.
The syntax has one required attribute:
@@ -446,10 +450,30 @@
record to OPACXML.
+ When marcxml is used, yazproxy assumes
+ that records retrieved from the backend are encoded in the
+ MARC-8 character set.
+ This is correct for most MARC21 based systems, but not for
+ other MARC variants or UTF-8 based MARC21 systems.
+ The backendcharset attribute specifies
+ the character set of the MARC records to be converted.
+
+
If attribute backendtype is given, that holds the
record syntax to be transmitted to backend.
+ If attribute backendelementset is given, that holds
+ elementset to be transmitted to backend. An empty value of
+ backendelementset has the effect of omitting
+ any Comp-Spec (and elementset) sent to backend.
+
+ If backendelementset is omitted, the element
+ set from client is used, except if marcxml is used.
+ In that case (using marcxml), no Comp-Spec and no
+ elementset is sent to backend.
+
+
If attribute stylesheet is given, the proxy
will convert XML record from server via XSLT. It is important
that the content from server is XML. If used in conjunction with
@@ -458,12 +482,12 @@
If attribute identifier is given that is the
- SRW/SRU record schema identifier for the resulting output record (after
+ SRU record schema identifier for the resulting output record (after
MARCXML and/or XSLT conversion).
If sub element title is given (as child element
- of syntax, then that is the official SRW/SRU
+ of syntax, then that is the official SRU
name of the resulting record schema.
@@ -504,7 +528,7 @@
explain
The explain element includes Explain information
- for SRW/SRU about the server in the target section. This
+ for SRU about the server in the target section. This
information must have a serverInfo element
with a database that this target must be available as (URL path).
For example,
@@ -519,7 +543,7 @@
]]>
- In the above case, the SRW/SRU service is available as
+ In the above case, the SRU service is available as
http://myhost.org:8000/mydatabase.
@@ -531,14 +555,14 @@
The content of the cql2rpn element specifies
the path from the working directory to a CQL-to-RPN conversion
file for the server in the target section. This element
- is required for SRW/SRU searches to operate against Z39.50
+ is required for SRU searches to operate against Z39.50
servers that don't support CQL. Most Z39.50 servers only support
Type-1/RPN so this is usually required.
See YAZ documentation for more information about the
- CQL
- to PQF conversion. See also the
+ CQL to PQF conversion.
+ See also the
pqf.properties in the etc
(or prefix/share/yazproxy)
directory of the YAZ proxy distribution.
@@ -614,7 +638,7 @@
If this is specified the proxy will act as a Z39.50 server
- supporting character set negotiation. And in SRW/SRU mode
+ supporting character set negotiation. And in SRU mode
it will convert from UTF-8 (UNICODE) to this native character
set (if possible).
@@ -638,8 +662,8 @@
- Using the
- bash shell, you can set the limit with
+ Using the bash shell, you can set
+ the limit with
ulimit -nno.
Use ulimit -a to display limits.
@@ -824,7 +848,7 @@
The categoryTypeId is either
OID 1.2.840.10003.10.1000.81.1, 1.2.840.10003.10.1000.81.2
for proxy target and proxy cookie respectively. The
- integer element category is set to 0.
+ categoryValue is set to 1.
The value proxy and cookie is stored in element
characterInfo of the information
choice.
@@ -840,7 +864,6 @@
+
@@ -888,6 +912,7 @@
+
@@ -958,6 +983,7 @@
+