X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=doc%2Frecord_transform.xml;h=c490d56d1d1b322161e2a9b504c931c10834b095;hb=032466d946405f08353f42c0049b523cfd1f4127;hp=6a96ec6469a4579360f78fe90533fe73c4624a9e;hpb=390f1824be469868bb060cdacd2d48aa184441a9;p=metaproxy-moved-to-github.git
diff --git a/doc/record_transform.xml b/doc/record_transform.xml
index 6a96ec6..c490d56 100644
--- a/doc/record_transform.xml
+++ b/doc/record_transform.xml
@@ -1,4 +1,4 @@
-
@@ -15,100 +15,106 @@
3mp
Metaproxy Module
-
+
record_transform
- Metaproxy Module that performs Z39.50 presentResponse record transformations
+ Metaproxy Module that performs record transformations
DESCRIPTION
- This filter acts only on Z3950 present requests, and let all
- other types of packages and requests pass untouched. It's use is
- twofold: blocking Z3950 present requests, which the backend
- server does not understand and can not honor, and transforming
- the present syntax and elementset name according to the rules
- specified, to fetch only existing record formats, and transform
- them on the fly to requested record syntaxes.
-
+ This filter acts on Z39.50 present requests and Z39.50 search requests,
+ and let all other types of packages and requests pass untouched. Its
+ use is twofold: blocking Z39.50 present/search requests that the backend
+ server does not understand or can not honor, and transforming the present
+ syntax and elementset name according to the rules specified, to fetch
+ only existing record formats, and transform them on the fly to requested
+ record syntaxes.
+
- The allowed record present syntax and
+ The allowed record present syntax and
element name are described in multiple
- <retrieval> elements inside the
+ <retrieval> elements inside the
<retrievalinfo>
element. The syntax attribute is mandatory, but
the name attribute
- may be omitted, in which case any
+ may be omitted, in which case any
element name is accepted. An additional
identifier attribute can be added to explicitly
- describe the Z3950 identifier string.
-
-
- Record transformations are invoked when the optional attributes
- backendsyntax and backendname
- as well as the <convert> element are specified.
- Record conversions come in two flavors:
- <marc> binary conversions between different
- binary MARC formats and MarcXML formats, and
- <xslt> stylesheet transformations performed
- on any kind of XML records. These conversions can be stacked in any
- order, and are performed linearly in file order.
+ describe the Z39.50 identifier string.
- The binary MARC record transformations
- <marc> are defined using the following
- attributes: inputformat, outputformat,
- inputcharset and outputcharset.
+ The <retrieval> element and the content
+ is described in the
+ Retrieval Facility section
+ of the YAZ manual.
- XML <xslt> transformation instructions
- accept only one mandatory stylesheet attribute,
- which is either an absolute path, or a relative path from the
- working directory of metaproxy to the location
- of the requested XSLT stylesheet.
+ From Metaproxy version 1.3.26 and onwards the backend conversion ma
+ also use USEMARCON.
+ If USEMARCON is enabled, the backend may include
+ a usemarcon element with two attributes:
+ stage1 and stage2 that points to
+ conversion files as interpreted by USEMARCON. One or both must be given.
-
+
+ SCHEMA
+
+ Schema is in two parts.. One for the filter itself and one for the
+ retrieval info.
+
+
+
+
+
+
+
+
+
EXAMPLES
A typical configuration looks like this:
-
-
-
-
-
-
+
+
+
+
-
+
+
-
-
-
-
+
+
+
+
+
-
-
-
-
-
+
+
+
+
+
+
+
+
-
+
]]>
-
-
+
+
SEE ALSO
@@ -117,21 +123,13 @@
-
+
©right;