marc 0.1.4 → 0.1.5

data/lib/marc/datafield.rb

@@ -6,6 +6,16 @@ module MARC
   # MARC records contain data fields, each of which has a tag, 
   # indicators and subfields. Tags for data fields must be in
   # the range 010-999.
+  # Accessor attributes: tag ; indicator1 ; indicator2
+  # 
+  # DataField includes enumerable for access to it's constituent
+  # Subfield objects. For instance, if you have a DataField representing
+  # a 856 tag, and want to find all 'z' subfields:
+  # urltag.find_all { |subfield| subfield.code == 'z' }
+  #
+  # Also, the accessor 'subfields' is an array of MARC::Subfield objects
+  # which can be accessed or modified by the client directly if
+  # neccesary. 
 
   class DataField
     include Enumerable
@@ -85,7 +95,7 @@ module MARC
 
 
     # Add a subfield (MARC::Subfield) to the field
-    #    field.append(MARC::Subfield('a','Dave Thomas'))
+    #    field.append(MARC::Subfield.new('a','Dave Thomas'))
 
     def append(subfield)
       @subfields.push(subfield)

data/lib/marc/record.rb

@@ -1,8 +1,17 @@
 module MARC
 
   # A class that represents an individual MARC record. Every record
-  # is made up of a collection of MARC::Field objects. 
-
+  # is made up of a collection of MARC::DataField objects. 
+  #
+  # MARC::Record includes Enumerable for access to constituent
+  # DataFields. Eg, to return a list of all 650 DataFields:
+  # record.find_all { |field| field.tag == '650' }  
+  # 
+  # The accessor 'fields' is also an Array of MARC::DataField objects which
+  # the client can access or modifyi if neccesary.
+  # 
+  # Other accessor attribute: 'leader' for record leader as String
+ 
   class Record
     include Enumerable
 

data/lib/marc/subfield.rb

@@ -1,4 +1,9 @@
 module MARC
+  
+  # A class to represents a subfield within a DataField. 
+  # Accessor attributes: code (letter subfield code) ; value
+  # Both can be empty string, but should not be nil. 
+
 
   class Subfield
     attr_accessor :code, :value

data/lib/marc/xmlwriter.rb

@@ -3,7 +3,7 @@ require 'rexml/text'
 
 module MARC
   
-  # A class for writing MARC records as MARC21.
+  # A class for writing MARC records as MARCXML.
   
   class XMLWriter
     

metadata

@@ -1,10 +1,10 @@
 --- !ruby/object:Gem::Specification 
-rubygems_version: 0.9.0
+rubygems_version: 0.9.2
 specification_version: 1
 name: marc
 version: !ruby/object:Gem::Version 
-  version: 0.1.4
-date: 2007-01-02 00:00:00 -05:00
+  version: 0.1.5
+date: 2007-05-01 00:00:00 -04:00
 summary: A ruby library for working with Machine Readable Cataloging
 require_paths: 
 - lib
@@ -30,30 +30,30 @@ authors:
 - Ed Summers
 files: 
 - lib/marc
-- lib/marc.rb
-- lib/marc/constants.rb
 - lib/marc/controlfield.rb
 - lib/marc/datafield.rb
-- lib/marc/dublincore.rb
+- lib/marc/subfield.rb
+- lib/marc/xmlwriter.rb
 - lib/marc/exception.rb
-- lib/marc/reader.rb
 - lib/marc/record.rb
-- lib/marc/subfield.rb
-- lib/marc/writer.rb
+- lib/marc/reader.rb
 - lib/marc/xmlreader.rb
-- lib/marc/xmlwriter.rb
-- test/batch.dat
+- lib/marc/dublincore.rb
+- lib/marc/constants.rb
+- lib/marc/writer.rb
+- lib/marc.rb
+- test/tc_datafield.rb
 - test/batch.xml
-- test/one.dat
+- test/tc_writer.rb
 - test/tc_controlfield.rb
-- test/tc_datafield.rb
-- test/tc_dublincore.rb
-- test/tc_reader.rb
-- test/tc_record.rb
 - test/tc_subfield.rb
-- test/tc_writer.rb
+- test/tc_record.rb
+- test/batch.dat
+- test/one.dat
 - test/tc_xml.rb
+- test/tc_reader.rb
 - test/ts_marc.rb
+- test/tc_dublincore.rb
 test_files: 
 - test/ts_marc.rb
 rdoc_options: []