traject_horizon 0.0.1 → 0.9.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- data/README.md +13 -9
- data/lib/traject_horizon/version.rb +1 -1
- metadata +1 -1
data/README.md
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
Export MARC records directly from a Horizon ILS rdbms, either as serialized MARC,
|
|
4
4
|
or to then index to Solr.
|
|
5
5
|
|
|
6
|
-
|
|
6
|
+
traject_horizon is a plugin for [traject](http://github.com/jrochkind/traject), and
|
|
7
7
|
requires jruby to be installed.
|
|
8
8
|
|
|
9
9
|
Supports embedding copy/item holdings information in exported MARC.
|
|
@@ -15,12 +15,16 @@ yet further with more development of multi-threaded processing.
|
|
|
15
15
|
|
|
16
16
|
## Installation
|
|
17
17
|
|
|
18
|
-
traject_horizon is a plugin for [traject](http://github.com/jrochkind/traject),
|
|
19
|
-
|
|
18
|
+
traject_horizon is a plugin for [traject](http://github.com/jrochkind/traject), which
|
|
19
|
+
needs to run under jruby. We recommend [chruby](https://github.com/postmodern/chruby)
|
|
20
|
+
for managing multiple ruby versions, see it's instructions for installing jruby.
|
|
21
|
+
|
|
22
|
+
Then, with jruby active (`$ chruby jruby`), you can install both `traject`
|
|
23
|
+
and `traject_horizon` with:
|
|
20
24
|
|
|
21
25
|
$ gem install traject traject_horizon
|
|
22
26
|
|
|
23
|
-
### Or, if using a Gemfile with your traject project
|
|
27
|
+
### Or, if using a bundler Gemfile with your traject project
|
|
24
28
|
|
|
25
29
|
Add this line to your [traject project's Gemfile](https://github.com/jrochkind/traject/blob/master/doc/extending.md#or-with-bundler):
|
|
26
30
|
|
|
@@ -72,7 +76,7 @@ There are a variety of additional settings that apply to the HorizonReader,
|
|
|
72
76
|
especially settings for customizing the item/copy holdings information
|
|
73
77
|
included. See [HorizonReader] inline comment docs.
|
|
74
78
|
|
|
75
|
-
Note by default
|
|
79
|
+
Note by default 'staff-only' records are _not_ included in the export,
|
|
76
80
|
but this can be changed in settings.
|
|
77
81
|
|
|
78
82
|
As with all traject settings, string-valued settings can also be supplied
|
|
@@ -102,7 +106,7 @@ using standard traject `-x marcout` functionality:
|
|
|
102
106
|
|
|
103
107
|
### Indexing records to solr
|
|
104
108
|
|
|
105
|
-
Traject is primarily a tool for indexing to solr. You can use `
|
|
109
|
+
Traject is primarily a tool for indexing to solr. You can use `traject_horizon` to
|
|
106
110
|
export from Horizon and send directly through the indexing pipeline, without
|
|
107
111
|
having to serialize MARC to disk first.
|
|
108
112
|
|
|
@@ -116,9 +120,9 @@ Then, simply:
|
|
|
116
120
|
|
|
117
121
|
## Note on character encodings
|
|
118
122
|
|
|
119
|
-
By default,
|
|
123
|
+
By default, traject_horizon assumes the data in your Horizon database is stored
|
|
120
124
|
in the Marc8 encoding. (I think this is true of all Horizon databases?). And by
|
|
121
|
-
default,
|
|
125
|
+
default, traject_horizon will transcode it to UTF-8, marking leader byte 9 in any
|
|
122
126
|
exported MARC appropriately (Using the Marc4J AnselConverter class).
|
|
123
127
|
|
|
124
128
|
If you'd like traject to avoid this transcode, you can set the traject
|
|
@@ -145,7 +149,7 @@ and it may not be possible to output them in Marc8. Sorry.
|
|
|
145
149
|
## Challenges
|
|
146
150
|
|
|
147
151
|
I had to reverse engineer the Horizon database to figure out how to turn it into
|
|
148
|
-
MARC records. I believe I have been succesful, and
|
|
152
|
+
MARC records. I believe I have been succesful, and traject_horizon seems to produce
|
|
149
153
|
the same output as Horizon's own marcout.
|
|
150
154
|
|
|
151
155
|
Hopefully this will remain true in future Horizon versions, I don't think relevant
|