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

- old
+ new

@@ -31,32 +31,74 @@ <div id="main"> <h1>zcc</h1> <div id="version" class="clickable" onclick='document.location = "http://rubyforge.org/projects/zcc"; return false'> <p>Get Version</p> - <a href="http://rubyforge.org/projects/zcc" class="numbers">0.0.2</a> + <a href="http://rubyforge.org/projects/zcc" class="numbers">0.0.3</a> </div> <h1>&#x2192; &#8216;zcc&#8217;</h1> <h2>What</h2> <p>Z Copy Cataloging is a command line tool written in Ruby to make your <span class="caps">MARC</span> record copy cataloging faster and more accurate. The &#8216;Z&#8217; may stand for Zippy if you really want it to.</p> <h1><strong>THIS IS <em>alpha</em> SOFTWARE. <span class="caps">IT MIGHT MANGLE YOUR MARC AND CORRUPT YOUR CATALOG</span>.</strong></h1> - <h2>Installing</h2> + <h2>Requirements</h2> -<pre syntax="ruby">sudo gem install zcc</pre> + <p><a href="http://ruby-lang.org/">Ruby</a> 1.8</p> + + + <p><a href="http://www.indexdata.dk/yaz/">YAZ</a> I suggest adding the indexdata repositories for your distro (Debian or Redhat) and installing that way. <del>From a footnote to ruby-zoom: If you build from source, make sure you pass the&#8212;enable-shared option to the configure script before building <span class="caps">YAZ</span>, by default it does not build shared libraries required by Ruby/ZOOM.</del></p> + + + <h3>Gems</h3> + +<pre syntax="ruby">sudo gem install zcc marc zoom unicode highline</pre> + <p><a href="http://www.textualize.com/ruby_marc">ruby-marc</a></p> + + + <p><strong>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&#8217;m willing to try to make it work if there is enough interest.</p> + + + <p>The gems bin folder must be added to your <span class="caps">PATH</span>. For me it is /var/lib/gems/1.8.bin</p> + + <h2>Repository</h2> - <p>svn co svn://208.78.97.122/zcc</p> + <p>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.</p> + <p>To make sure you have all the dependencies needed to build the gem:</p> + + +<pre syntax="ruby">$ sudo gem install newgem --include-dependencies</pre> + <p>Grab the latest from the svn repository:</p> + + +<pre syntax="ruby">$ svn co svn://208.78.97.122/zcc</pre> + <p>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: <a href="http://www.gratisoft.us/sudo/man/sudoers.html">Sudoers Manual</a></p> + + + <p>You can add the following lines using visudo:</p> + + +<pre syntax="ruby">Cmnd_Alias GEM=/usr/bin/gem +user ALL=GEM</pre> + <p>Now as a user you can build and install the gem on your own system:</p> + + +<pre syntax="ruby">$ cd zcc +$ rake local_deploy</pre> + <p>For more tasks take a look at the output of:</p> + + +<pre syntax="ruby">$ rake -T </pre> <h2>Features</h2> - <p><strong>Z39.50 search for records.</strong> 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.</p> + <p></strong><span class="caps">Z39</span>.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.</p> <p><strong>Search by Title or <span class="caps">ISBN</span></strong> Currently two searches are supported. From the same prompt you may search either by Title or <span class="caps">ISBN</span>. For a search of the Library of Congress you may also search by Library of Congress Card Number.</p> @@ -79,10 +121,13 @@ <p><strong>Output to <span class="caps">CSV</span> file.</strong> Want to print labels or keep statistics? Zcc allows you to choose which subfields you would like to export into a <span class="caps">CSV</span> file. Programs like glabels can accept <span class="caps">CSV</span> files for custom labelmaking. <span class="caps">CSV</span> 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.</p> + <p><strong>Light editing of subfields</strong> 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 <span class="caps">MARC</span> editor, but for copy cataloging probably good enough in many cases. Still lacking some features like timestamp change.</p> + + <h2>Configuration</h2> <p>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.</p> @@ -90,11 +135,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&#8217;s what I do. - <p>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.</p> + <p>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.</p> <h2>Use</h2> <p>$ zcc</p> @@ -107,22 +152,25 @@ <li>rset.length is the number of results found in the target. Depending on configuration you may not be presented with all results.</li> <li>Next to each shown result is a number. Numbering starts with zero. Use that number in the following way:</li> <li>Zcc command line<ul> <li>Key in a number and hit Enter to select a record into your own set.</li> <li>Key &#8217;s&#8217; followed by a number to see the result. For instance &#8216;s3&#8217; would show you the full <span class="caps">MARC</span> for the 3rd record.</li> - <li>To compare two records enter &#8216;c#-#&#8217;. For instance &#8216;c5-3&#8217; would compare record 5 to record 3. Matches are shown with &#8216;m&#8217; at the beginning of a line.</li> + <li>To compare two records enter &#8216;c#&#8211;#&#8217;. For instance &#8216;c5&#8211;3&#8217; would compare record 5 to record 3. Matches are shown with &#8216;m&#8217; at the beginning of a line. The first record is denoted with a &#8217;+&#8217; and the second with a minus sign.</li> <li>Enter &#8216;n&#8217; to go to the next ztarget.</li> - <li>Enter &#8216;d&#8217; if you are done selecting records. This will skip all</li> + <li>Enter &#8216;d&#8217; if you are done selecting records. This will skip the rest of the ztargets.</li> + <li>If you have the linter turned on (and Perl modules instaled) &#8216;l#&#8217; will give any <span class="caps">USMARC</span> errors such as incorrect indicators for a particular field.</li> + <li>Once you select a final records it goes through scripting and csv creation if those are turned on.</li> + <li>You are then prompted to conduct a new search.</li> </ul></li> </ol> <h2>TODO</h2> - <p><strong>Smart character set conversion</strong> 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.</p> + <p><del><strong>Smart character set conversion</strong> Currently incoming records are assumed to be marc8 and are converted to utf8. This is complex. Let me know what you need here.</del> v. 0.0.3 checks leader byte 9 for character encoding and either keeps it as <span class="caps">UTF8</span> or convert from <span class="caps">MARC8</span> to <span class="caps">UTF8</span></p> - <p><strong>TUI</strong> If there is interest in this script, I&#8217;m hoping to make a nice Text User Interface with curses or ncurses. Currently everything just scrolls up the terminal.</p> + <p><strong>TUI</strong> If there is interest in this script, I&#8217;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 <span class="caps">TUI</span> elements like highlighting</p> <p><strong>Automatic retrieval of authority records.</strong> I already have a separate script in the works that can retrieve authority records for names (not subjects). I&#8217;d like to work that as an option into the main script.</p> @@ -139,30 +187,10 @@ <p>Create full <strong>rdoc documentation</strong>.</p> - <h2>Requirements</h2> - - <p><a href="http://ruby-lang.org/">Ruby</a> 1.8+ I&#8217;m not completely sure what versions of Ruby will work.</p> - - - <p><a href="http://www.indexdata.dk/yaz/">YAZ</a> 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&#8212;enable-shared option to the configure script before building <span class="caps">YAZ</span>, by default it does not build shared libraries required by Ruby/ZOOM.</p> - - - <p><a href="http://ruby-zoom.rubyforge.org/">ruby-zoom</a> Follow the instructions to install. Hopefully there will be a gem soon. To compile ruby1.8-dev must be installed.</p> - - - <p><a href="http://www.textualize.com/ruby_marc">ruby-marc</a> This one&#8217;s easy. As long as you have rubygems installed just issue the command: gem install marc</p> - - - <p>*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&#8217;m willing to try to make it work if there is interest.</p> - - - <p>gem install unicode</p> - - - <p>The gems bin folder must be added to your <span class="caps">PATH</span>. For me it is /var/lib/gems/1.8.bin</p> + <p><strong>Subfield Editing</strong> <del>Allow subfield editing to take place in vim buffer?</del> 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.</p> <h2>Suggestions</h2> <p>Perl and <span class="caps">MARC</span>::Lint To have error checking of records turned on you must also have Perl and <span class="caps">MARC</span>::Lint installed.</p>