hydra-pbcore 0.1.0 → 1.0.0

data/README.md

@@ -1,7 +1,7 @@
 # HydraPbcore
 
 A Hydra gem that offers PBCore datastream definitions using OM, as well as some other convenience
-methods such as inserting xml templates into existing docments and reording your PBCore xml 
+methods such as inserting xml templates into existing documents and reordering your PBCore xml 
 elements so that you can export complete, valid PBCore documents.
 
 ## Installation
@@ -20,7 +20,31 @@ Or install it yourself as:
 
 ## Usage
 
-Use this with your hydra head.
+Use this with your hydra head to define a datastream in Fedora that will contain Pbcore xml.  Ex:
+
+    MyModel < ActiveFedora::Base
+
+      has_metadata :name => "descMetadata", :type => HydraPbcore::Datastream::Document
+
+    end
+
+Your descMetadata datastream will now have all the pbcore terms defined in HydraPbcore::Datastream::Document.
+There are also two additional datastream definitions:
+
+* HydraPbcore::Datastream::DigitalDocument
+* HydraPbcore::Datastream::Instantiation
+
+DigitalDocument datastreams have the exact same terms as Document, except that there is no default physical 
+pbcoreInstantiation.  The Document datastreams comes with a single instantiation that represents a tape
+or other physical entity.  DigitalDocument datastreams assume born-digital content and must have added
+instantiations.  These instantiations are defined in the Instantiation datastream.
+
+### Additional Methods
+
+HydraPbcore comes with a couple of additional features such as ordering your xml nodes so that your xml will 
+validate against the PBCore XML v.2 schema.  Additionally, there are several template methods that can be used
+to insert additional terms into your xml documents, such as contributors, publishers, as well as next and previous
+fields that specify which files come before and after one another in a multi-part born-digital video.
 
 ## Contributing
 

data/lib/hydra-pbcore/templates.rb

@@ -18,21 +18,21 @@ module HydraPbcore::Templates
         }
       end
 
-      define_template :previous do |xml, pid|
+      define_template :previous do |xml, file|
         xml.instantiationRelation {
           xml.instantiationRelationType(:annotation=>"One of a multi-part instantiation") {
             xml.text "Follows in Sequence"
           }
-          xml.instantiationRelationIdentifier(pid, :source=>"Rock and Roll Hall of Fame and Museum")
+          xml.instantiationRelationIdentifier(file, :source=>"Rock and Roll Hall of Fame and Museum")
         }
       end
 
-      define_template :next do |xml, pid|
+      define_template :next do |xml, file|
         xml.instantiationRelation {
           xml.instantiationRelationType(:annotation=>"One of a multi-part instantiation") {
             xml.text "Precedes in Sequence"
           }
-          xml.instantiationRelationIdentifier(pid, :source=>"Rock and Roll Hall of Fame and Museum")
+          xml.instantiationRelationIdentifier(file, :source=>"Rock and Roll Hall of Fame and Museum")
         }
       end
 
@@ -47,12 +47,12 @@ module HydraPbcore::Templates
     add_child_node(ng_xml.root, :publisher, publisher, role)
   end
 
-  def insert_next(pid)
-    add_child_node(find_by_terms(:pbcoreInstantiation).first, :next, pid)
+  def insert_next(file)
+    add_child_node(find_by_terms(:pbcoreInstantiation).first, :next, file)
   end
 
-  def insert_previous(pid)
-    add_child_node(find_by_terms(:pbcoreInstantiation).first, :previous, pid)
+  def insert_previous(file)
+    add_child_node(find_by_terms(:pbcoreInstantiation).first, :previous, file)
   end
 
 end

data/lib/hydra-pbcore/version.rb

@@ -1,3 +1,3 @@
 module HydraPbcore
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: hydra-pbcore
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-11-14 00:00:00.000000000 Z
+date: 2012-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri