X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Fzoom.xml;h=09c8afe2f8b37608798b2347daa016105c919c26;hb=7d8e39aae55965682ae039a4e689c3c7c7b0414d;hp=8797de14330dff3bfe33002dcc81d17c2974bb9b;hpb=7f3c867e9614a9a7c617522da5b6299284100236;p=metaproxy-moved-to-github.git
diff --git a/doc/zoom.xml b/doc/zoom.xml
index 8797de1..09c8afe 100644
--- a/doc/zoom.xml
+++ b/doc/zoom.xml
@@ -56,9 +56,10 @@
CONFIGURATION
- The configuration consists of five parts: torus,
+ The configuration consists of six parts: torus,
fieldmap, cclmap,
- contentProxy and log.
+ contentProxy, log
+ and zoom.
torus
@@ -71,15 +72,34 @@
attribute url
- URL of Web service to be used to fetch target profile
- for a given database (udb). The special sequence
- %db of the URL is replaced by the
- actual database specified as part of Search.
+ URL of Web service to be used when fetch target profiles from
+ a remote service (Torus normally).
+
+
+ The sequence %query is replaced with a CQL
+ query for the Torus search.
The special sequence %realm is replaced by value
of attribute realm or by realm DATABASE argument.
+
+ The special sequence %db is replaced with
+ a single database while searching. Note that this sequence
+ is no longer needed, because the %query can already
+ query for a single database by using CQL query
+ udb==....
+
+
+
+
+ attribute content_url
+
+
+ URL of Web service to be used to fetch target profile
+ for a given database (udb) of type content. Semantics otherwise like
+ url attribute above.
+
@@ -134,6 +154,25 @@
+ attribute explain_xsl
+
+
+ Specifies a stylesheet that converts one or more Torus records
+ to ZeeExplain records. The content of recordData is assumed to be
+ holding each Explain record.
+
+
+
+
+ attribute record_xsl
+
+
+ Specifies a stylesheet that converts retrieval records after
+ transform/literal operations.
+
+
+
+ element records
@@ -234,6 +273,26 @@
+
+
+ zoom
+
+ The zoom element controls settings for the
+ ZOOM.
+
+
+
+ attribute timeout
+
+
+ Is an integer that specifies, in seconds, how long an operation
+ may take before ZOOM gives up. Default value is 40.
+
+
+
+
+
+
QUERY HANDLING
@@ -470,6 +529,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
@@ -495,19 +564,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
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.
@@ -572,12 +642,12 @@
proxy
- Specifies proxy to be for backend. If this parameters is
+ Specifies one or more proxies for backend. If this parameter is
omitted, the proxy will be taken from TARGET profile setting
- cfProxy
-
- .
+ cfProxy.
+ The parameter is a list of comma-separated host:port entries.
+ Bost host and port must be given for each proxy.
@@ -591,6 +661,15 @@
+ nocproxy
+
+
+ If this parameter is specified, content-proyxing is disabled
+ for the search.
+
+
+
+ realm
@@ -628,7 +707,7 @@
@@ -644,6 +723,7 @@
+
]]>