website/zcc.txt in zcc-0.0.2 vs website/zcc.txt in zcc-0.0.3

- old
+ new

@@ -6,18 +6,56 @@ Z Copy Cataloging is a command line tool written in Ruby to make your MARC record copy cataloging faster and more accurate. The 'Z' may stand for Zippy if you really want it to. h1. *THIS IS _alpha_ SOFTWARE. IT MIGHT MANGLE YOUR MARC AND CORRUPT YOUR CATALOG.* -h2. Installing +h2. Requirements -<pre syntax="ruby">sudo gem install zcc</pre> +"Ruby":http://ruby-lang.org/ 1.8 +"YAZ":http://www.indexdata.dk/yaz/ I suggest adding the indexdata repositories for your distro (Debian or Redhat) and installing that way. -From a footnote to ruby-zoom: If you build from source, make sure you pass the --enable-shared option to the configure script before building YAZ, by default it does not build shared libraries required by Ruby/ZOOM.- + +h3. Gems + +<pre syntax="ruby">sudo gem install zcc marc zoom unicode highline</pre> + +"ruby-marc":http://www.textualize.com/ruby_marc + +*nix? Zcc has only been tested on Linux (Debian Etch). It may work under other operating systems. Feedback is appreciated on how it functions under other operating systems. I'm willing to try to make it work if there is enough interest. + +The gems bin folder must be added to your PATH. For me it is /var/lib/gems/1.8.bin + + h2. Repository -svn co svn://208.78.97.122/zcc +A new gem is super easy to release to rubyforge, so expect that the gem on rubyforge is up-to-date for working features, though not necessarily for small changes. If you want to build the gem yourself, it will also be super easy once you set things up. +To make sure you have all the dependencies needed to build the gem: + +<pre syntax="ruby">$ sudo gem install newgem --include-dependencies</pre> + +Grab the latest from the svn repository: + +<pre syntax="ruby">$ svn co svn://208.78.97.122/zcc</pre> + +To build and install the gem as a user most easily, the user must be added to the sudoers list. On my system I do this by running visudo as root. For more information on sudoers and possible settings that may be more secure consult: "Sudoers Manual":http://www.gratisoft.us/sudo/man/sudoers.html + +You can add the following lines using visudo: + +<pre syntax="ruby">Cmnd_Alias GEM=/usr/bin/gem +user ALL=GEM</pre> + +Now as a user you can build and install the gem on your own system: + +<pre syntax="ruby">$ cd zcc +$ rake local_deploy</pre> + +For more tasks take a look at the output of: + +<pre syntax="ruby">$ rake -T </pre> + + h2. Features *Z39.50 search for records.* Configure Zcc for as many targets as you like in order of preference. A relatively current list of targets is provided based on the targettest list. If you find the perfect record with the first target other targets do not have to be searched. *Search by Title or ISBN* Currently two searches are supported. From the same prompt you may search either by Title or ISBN. For a search of the Library of Congress you may also search by Library of Congress Card Number. @@ -34,10 +72,12 @@ *Scripted changes to records.* Zcc is highly configurable for making scripted changes to each record like macros. Want to delete all 900 or 9XX fields from a record before importing into your library system? Zcc can do that and more. Add fields and subfields with pre-determined information or prompt for information. The previous examples are easy to configure. With a little Ruby scripting you can make more complex changes. A few sample scripts are provided that do things like take the dewey call number from the 082a field and copy it to the fields Koha uses for call numbers, and if there is no 082a field it prompts for the proper call number parts. Don't need the feature? Just turn it off. *Output to CSV file.* Want to print labels or keep statistics? Zcc allows you to choose which subfields you would like to export into a CSV file. Programs like glabels can accept CSV files for custom labelmaking. CSV files can also be imported into spreadsheet programs like OpenOffice Calc or Excel. If a value is not found for a particular field Zcc will prompt the user for input, which can be blank. +*Light editing of subfields* Since version 0.0.3 there is a facility for editing subfields. Have you found a good record but one or two subfields are different than the item you have in hand? You can still accept the record and make small edits of existing subfields. It allows you to pick the subfield you want to edit when there are repeatable fields and subfields. Not a replacement for a MARC editor, but for copy cataloging probably good enough in many cases. Still lacking some features like timestamp change. + h2. Configuration Because of all the scripting and csv features zcc requires a lot of configuration. Currently the configuration files are my own. I use them and they work for my purposes, but they will not work for yours. Once you have configured zcc, though, you should be copy cataloging much faster. @@ -45,11 +85,11 @@ <pre syntax="ruby">cp /var/lib/gems/1.8/gems/zcc-0.0.1/examples/zcc.yaml ~/.zcc/zcc.yaml</pre> One line; that's what I do. -To get the program running right away also create a file called zoomer-iterator.txt and place that in .zcc as well. I use this to create item numbers and barcodes. +To get the program running right away also create a file called zoomer-iterator.txt, put any number in it, and place the file in .zcc as well. I use this to create item numbers and barcodes. h2. Use $ zcc @@ -60,19 +100,22 @@ # Next to each shown result is a number. Numbering starts with zero. Use that number in the following way: # Zcc command line * Key in a number and hit Enter to select a record into your own set. * Key 's' followed by a number to see the result. For instance 's3' would show you the full MARC for the 3rd record. - * To compare two records enter 'c#-#'. For instance 'c5-3' would compare record 5 to record 3. Matches are shown with 'm' at the beginning of a line. + * To compare two records enter 'c#&#8211;#'. For instance 'c5&#8211;3' would compare record 5 to record 3. Matches are shown with 'm' at the beginning of a line. The first record is denoted with a '+' and the second with a minus sign. * Enter 'n' to go to the next ztarget. - * Enter 'd' if you are done selecting records. This will skip all + * Enter 'd' if you are done selecting records. This will skip the rest of the ztargets. + * If you have the linter turned on (and Perl modules instaled) 'l#' will give any USMARC errors such as incorrect indicators for a particular field. + * Once you select a final records it goes through scripting and csv creation if those are turned on. + * You are then prompted to conduct a new search. h2. TODO -*Smart character set conversion* Currently incoming records are assumed to be marc-8 and are converted to utf-8. This is complex. Let me know what you need here. +-*Smart character set conversion* Currently incoming records are assumed to be marc8 and are converted to utf8. This is complex. Let me know what you need here.- v. 0.0.3 checks leader byte 9 for character encoding and either keeps it as UTF8 or convert from MARC8 to UTF8 -*TUI* If there is interest in this script, I'm hoping to make a nice Text User Interface with curses or ncurses. Currently everything just scrolls up the terminal. +*TUI* If there is interest in this script, I'm hoping to make a nice Text User Interface with curses or ncurses. Currently everything just scrolls up the terminal. Since v. 0.0.3 there are some nicer TUI elements like highlighting *Automatic retrieval of authority records.* I already have a separate script in the works that can retrieve authority records for names (not subjects). I'd like to work that as an option into the main script. *Unit Testing.* While I've tested the script in my own work, I need to do more formal testing of the methods. @@ -82,24 +125,10 @@ -Move all configuration to YAML file. Currently some configuration is made in the main script and some in the YAML file.- v. 0.0.2 Create full *rdoc documentation*. -h2. Requirements - -"Ruby":http://ruby-lang.org/ 1.8+ I'm not completely sure what versions of Ruby will work. - -"YAZ":http://www.indexdata.dk/yaz/ I suggest adding the indexdata repositories for your distro (Debian or Redhat) and installing that way. From a footnote to ruby-zoom: If you build from source, make sure you pass the --enable-shared option to the configure script before building YAZ, by default it does not build shared libraries required by Ruby/ZOOM. - -"ruby-zoom":http://ruby-zoom.rubyforge.org/ Follow the instructions to install. Hopefully there will be a gem soon. To compile ruby1.8-dev must be installed. - -"ruby-marc":http://www.textualize.com/ruby_marc This one's easy. As long as you have rubygems installed just issue the command: gem install marc - -*nix? Zcc has only been tested on Linux (Debian Etch). It may work under other operating systems. Feedback is appreciated on how it functions under other operating systems. I'm willing to try to make it work if there is interest. - -gem install unicode - -The gems bin folder must be added to your PATH. For me it is /var/lib/gems/1.8.bin +*Subfield Editing* -Allow subfield editing to take place in vim buffer?- As of 0.0.3 subfield editing is available though not well tested. Readline allows for nice editing. Still to do: Change the timestamp automatically and allow for adding subfields like 040d upon modification. h2. Suggestions Perl and MARC::Lint To have error checking of records turned on you must also have Perl and MARC::Lint installed.