remove patch for zorba3-0.xqy; no longer necessary
[mp-xquery-moved-to-github.git] / bibframe / README
1 BIBFRAME demo
2
3 This directory includes files for using the XQuery module to convert
4 MARCXML to BIBFRAME records within Metaproxy.
5
6 In order for this to work, metaproxy and the mp-xquery software modules
7 must be installed. The conversion uses the marc2bibframe software available
8 from here: https://github.com/lcnetdev/marc2bibframe
9
10 config.xml
11 ----------
12
13 config.xml is a complete Metaproxy configuration file. It includes
14 a standalone configuration that makes Metaproxy offer Z39.50 and SRU support
15 on port 9070. The modules in use are http_file (to serve XSL files),
16 sru_z3950 (SRU service), cql_rpn (CQL to RPN conversion), xquery (to convert
17 MARCXML to BIBFRAME), record_transform (to convert MARC21 to MARCXML), virt_db
18 (for database rewrite), log (to perform backend logging) and, finally,
19 z3950_client to interface a Z39.50 target.
20
21 It is important that the "xquery" module comes before the "record_transform"
22 so that the "xquery" moduel sees XML _only_ and not ISO2709-records. If it
23 does, they will be ignored (passed through) by the "xquery" module.
24
25 The xquery'module script name points to the full path of zorba3-0.xqy part
26 of marc2bibframe . Do not move zorba3-0.xqy from its place within the
27 marc2bibframe directory as other files are referred to and their relative
28 location must be preserved.
29
30 cql2pqf.txt
31 -----------
32 Contains a simple DC/CQL profile for driving a CQL to RPN conversion.
33 It is referred to from the cql_rpn filter in config.xml .
34
35 explain.xml
36 -----------
37
38 SRU explain sample configuration. It is referred to from the sru_z3950
39 filter in config.xml .
40
41 xsl/..
42 ------
43
44 Client side XSL for brief - and full display. These must be located
45 so that the http_file filter can fetch them. For example, if these
46 files are located in /usr/share/bibframe/xsl , then http_file would hold
47
48       <filter type="http_file">
49         <area>
50           <documentroot>/usr/share/bibframe/xsl</documentroot>
51           <prefix></prefix>
52           <passthru>true</passthru>
53         </area>
54       </filter>
55