X-Git-Url: http://sru.miketaylor.org.uk/?a=blobdiff_plain;ds=sidebyside;f=doc%2Freference.xml;h=2ef809c4f7706bbfa77a921930d1063e69c11788;hb=237ba2cb352a9abdfd3558c1987ac73ce4c2d0b1;hp=5fa71468c7bebc4a358c103dfb2efa2116d48c16;hpb=6a72b9b6d8f8b540bc6f400e2e9791122fec8cf9;p=yazproxy-moved-to-github.git
diff --git a/doc/reference.xml b/doc/reference.xml
index 5fa7146..2ef809c 100644
--- a/doc/reference.xml
+++ b/doc/reference.xml
@@ -213,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.
@@ -237,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>
+
+
+
+
+
+
+
+
+
+ ]]>
@@ -291,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
@@ -412,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:
@@ -438,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
@@ -832,7 +864,6 @@
+
@@ -880,6 +912,7 @@
+
@@ -950,6 +983,7 @@
+