website/index.txt in zcc-0.0.1 vs website/index.txt in zcc-0.0.2

- old
+ new

@@ -1,101 +1,18 @@ -h1. zcc +h1. zcc projects h1. &#x2192; 'zcc' h2. What -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. +*Zcc projects* is a collection of tools written in Ruby to help with copy cataloging. + h1. *THIS IS _alpha_ SOFTWARE. IT MIGHT MANGLE YOUR MARC AND CORRUPT YOUR CATALOG.* -h2. Installing +h1. zcc project releases so far -<pre syntax="ruby">sudo gem install zcc</pre> +"zcc":http://zcc.rubyforge.org/zcc.html zcc is the main copy cataloging script. -h2. Features +"wcid":http://zcc.rubyforge.org/wcid wcid is a library for handling WorldCat Identites -*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. - -*See the most important fields for copy cataloging when choosing correct records.* In the initial list view Zcc presents the user with the full 245 (title and statement of responsibility) and 300 (extent, which includes page numbers). This gives you a quick way to determine potential records. TODO: Make the fields displayed configurable, especially for other MARC flavors. - -*View the full MARC record before choosing.* Zcc allows you to see the full MARC record in a pretty line format. Zcc does not hide MARC from you, even as ugly as it can be. - -*Compare two records and choose the best.* Zcc compares field by field (ie line by line) for matched fields. You can quickly see what fields come from which record. The comparison is similar to the way diff works. Matches between records are denoted with an 'm' while one record is denoted with a plus-sign and the other with a minus-sign. TODO: a curses interface may allow for color coding differences. - -*Optional: Check the record for common errors.* If you have Perl's MARC::Lint installed you can see if all your indicators have proper values and only repeatable fields repeat. An added feature is determining what encoding level (ISBD, AACR2) the record is in. - -*Choose records from different targets and then choose among them to find the best record.* In the end you just want one record and you want the best one. All the same features available for each target are also available for all the records chosen from all targets, so users can pick the best record for their location. View the full records, compare two records, and optionally lint records. This allows you to choose possible records quickly from various targets and then make a final decision later on. - -*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 the 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. - -h2. Configuration - -Currently look for some configuration in the main script called 'zcc' in the bin directory of the gem. I'll be moving this to the yaml file soon. - -The rest of the configuration is looked for in the user's home directory in .zcc/zcc.yaml. An example zcc.yaml config file can be found in the examples directory of the gem. - -To get the program running right away also create a file called zoomer-iterator.txt and place that in .zcc as well. - -h2. Use - -$ zcc - -Enter an ISBN or title. Zcc should be smart enough to tell the difference. - -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. - -*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. - -*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. - -*Exception handling.* Currently there's not great exception handling in the script. This needs to change, but hasn't caused problems for me yet. - -*Internationalize* This can start by not hardcoding any fields and allowing them to be configurable. The initial display of fields on search of a target should show the relevant fields in the user's prefered MARC flavor. If there is interest, I'd be willing to try making other text translatable. - -*Move all configuration to YAML file.* Currently some configuration is made in the main script and some in the YAML file. - -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. - -"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 - -h2. Suggestions - -Perl and MARC::Lint To have error checking of records turned on you must also have Perl and MARC::Lint installed. - -h2. Help/paches - -email: "Jason Ronallo":mailto:jronallo+zcc@gmail.com - -h2. License - -Copyright (C) 2007 Jason Ronallo - -This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. - -This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. - -You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA - -h2. Contact - -Comments are welcome. Send an email to "Jason Ronallo":mailto:jronallo+zcc@gmail.com.