X-Git-Url: http://sru.miketaylor.org.uk/?a=blobdiff_plain;ds=sidebyside;f=doc%2Freference.xml;h=79a2ec012dc188d2f57187fdba141cd417be4702;hb=0b8981d26c4dc8c2302fd9ed0a006f195300c0ee;hp=4c36259de7676c42c41ac0f5c8054f3281848ab4;hpb=a567a103ae463d43d0d9a4b52e19c5a60f41a13c;p=yazproxy-moved-to-github.git
diff --git a/doc/reference.xml b/doc/reference.xml
index 4c36259..79a2ec0 100644
--- a/doc/reference.xml
+++ b/doc/reference.xml
@@ -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
@@ -221,7 +213,7 @@
The proxy config file must have a root element called
proxy and scoped within namespace
- xmlns="http://indexdata.dk/yazproxy/schema/0.9/.
+ xmlns="http://indexdata.dk/yazproxy/schema/0.9/".
All information except an optional XML header must be stored
within the proxy element.
@@ -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,6 +450,15 @@
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.
@@ -458,12 +471,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 +517,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 +532,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,7 +544,7 @@
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.
@@ -614,7 +627,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).
@@ -824,7 +837,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 +853,6 @@
+
@@ -888,6 +901,7 @@
+