Mention metaproxy RPM explicitly
[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 Installation
11 ------------
12
13 Before these files can used, Metaproxy and the XQuery module must be
14 installed.
15
16 Metaproxy and XQuery package depend on other packages: libmetaproxy6,
17 libyaz5, zorba, etc.
18
19 These packages can be auto-fetched by adding the Index Data YUM repository.
20 Refer to http://ftp.indexdata.dk/pub/yaz/redhat/centos/6/README
21 for more information.
22
23 When this repository is enabled, the following command should suffice:
24   sudo yum install mp-xquery metaproxy
25
26
27 config.xml
28 ----------
29
30 config.xml is a complete Metaproxy configuration file. It includes
31 a standalone configuration that makes Metaproxy offer Z39.50 and SRU support
32 on port 9070. The modules in use are http_file (to serve XSL files),
33 sru_z3950 (SRU service), cql_rpn (CQL to RPN conversion), xquery (to convert
34 MARCXML to BIBFRAME), record_transform (to convert MARC21 to MARCXML), virt_db
35 (for database rewrite), log (to perform backend logging) and, finally,
36 z3950_client to interface a Z39.50 target.
37
38 It is important that the "xquery" module comes before the "record_transform"
39 so that the "xquery" moduel sees XML _only_ and not ISO2709-records. If it
40 does, they will be ignored (passed through) by the "xquery" module.
41
42 The xquery'module script name points to the full path of zorba3-0.xqy part
43 of marc2bibframe . Do not move zorba3-0.xqy from its place within the
44 marc2bibframe directory as other files are referred to and their relative
45 location must be preserved.
46
47 cql2pqf.txt
48 -----------
49 Contains a simple DC/CQL profile for driving a CQL to RPN conversion.
50 It is referred to from the cql_rpn filter in config.xml .
51
52 explain.xml
53 -----------
54
55 SRU explain sample configuration. It is referred to from the sru_z3950
56 filter in config.xml .
57
58 xsl/..
59 ------
60
61 Client side XSL for brief - and full display. These must be located
62 so that the http_file filter can fetch them. For example, if these
63 files are located in /usr/share/bibframe/xsl , then http_file would hold
64
65       <filter type="http_file">
66         <area>
67           <documentroot>/usr/share/bibframe/xsl</documentroot>
68           <prefix></prefix>
69           <passthru>true</passthru>
70         </area>
71       </filter>
72