X-Git-Url: http://jsfdemo.indexdata.com/?a=blobdiff_plain;f=doc%2Fzoom.xml;h=50a468221cd25ac7aec0ea7b39a1569887d8e04b;hb=bf6a5858e2c8839a5f8a4bdf087bcb94c54084bb;hp=4835356f403cc899992c3abd9d5a394a977bf1d3;hpb=db7203a455f748966f4fa6c906bf2b0a859cf87c;p=metaproxy-moved-to-github.git
diff --git a/doc/zoom.xml b/doc/zoom.xml
index 4835356..50a4682 100644
--- a/doc/zoom.xml
+++ b/doc/zoom.xml
@@ -76,9 +76,22 @@
%db of the URL is replaced by the
actual database specified as part of Search.
+
+ The special sequence %realm is replaced by value
+ of attribute realm or by realm DATABASE argument.
+
+ attribute realm
+
+
+ The default realm value. Used for %realm in URL, unless
+ specified in DATABASE argument.
+
+
+
+ attribute proxy
@@ -287,11 +300,12 @@
- authentication
+ authentication
Authentication parameters to be sent to the target. For
Z39.50 targets, this will be sent as part of the
- Init Request.
+ Init Request. Authentication consists of two components: username
+ and password, separated by a slash.
If this value is omitted or empty no authentication information is sent.
@@ -323,7 +337,7 @@
- cfProxy
+ cfProxy
Specifies HTTP proxy for the target in the form
host:port.
@@ -332,14 +346,14 @@
- cfSubDb
+ cfSubDB
Specifies sub database for a Connector Framework based target.
-
+ contentConnector
Specifies a database for content-based proxy'ing.
@@ -456,6 +470,16 @@
+ sruVersion
+
+ Specifies the SRU version to use. It unset, version 1.2 will be
+ used. Some servers do not support this version, in which case
+ version 1.1 or even 1.0 could be set it.
+
+
+
+
+ transform
Specifies a XSL stylesheet filename to be used if record
@@ -481,19 +505,20 @@
The value of this field is a string that generates a dynamic link
based on record content. If the resulting string is non-zero in length
a new field, metadata with attribute
- type="generated-url".
+ type="generated-url" is generated.
The contents of this field is the result of the URL recipe conversion.
The urlRecipe value may refer to an existing metadata element by
${field[pattern/result/flags]}, which will take content
of field and perform a regular expression conversion using the pattern
given. For example: ${md-title[\s+/+/g]} takes
- metadadata element title and converts one or more
+ metadata element title and converts one or more
spaces to a plus character.
- If the contentConnector
+ If the contentConnector
setting also defined, the resulting value is
- augmented with a session string as well as the content proxy server.
+ augmented with a session string as well as host name of the
+ content proxy server.
@@ -510,6 +535,94 @@
+ DATABASE parameters
+
+ Extra information may be carried in the Z39.50 Database or SRU path,
+ such as authentication to be passed to backend etc. Some of
+ the parameters override TARGET profile values. The format is
+
+
+ udb,parm1=value1&parm2=value2&...
+
+
+ Where udb is the unique database recognised by the backend and parm1,
+ value1, .. are parameters to be passed. The following describes the
+ supported parameters. Like form values in HTTP the parameters and
+ values are URL encoded. The separator, though, between udb and parameters
+ is a comma rather than a question mark. What follows question mark are
+ HTTP arguments (in this case SRU arguments).
+
+
+
+ user
+
+
+ Specifies user to be passed to backend. If this parameter is
+ omitted, the user will be taken from TARGET profile setting
+
+ authentication
+
+ .
+
+
+
+
+ password
+
+
+ Specifies password to be passed to backend. If this parameters is
+ omitted, the password will be taken from TARGET profile setting
+
+ authentication
+
+ .
+
+
+
+
+ proxy
+
+
+ Specifies proxy to be for backend. If this parameters is
+ omitted, the proxy will be taken from TARGET profile setting
+
+ cfProxy
+
+ .
+
+
+
+
+ cproxysession
+
+
+ Session ID for content proxy. This parameter is, generally,
+ not used by anything but the content proxy itself.
+
+
+
+
+ realm
+
+
+ Session realm to be used for this target, changed the resulting
+ URL to be used for getting a target profile, by changing the
+ value that gets substituted for the %realm string.
+
+
+
+
+ x-parm
+
+
+ All parameters that has prefix x, dash are passed verbatim
+ to the backend.
+
+
+
+
+
+ SCHEMA