afred

Samvera Connect 2018 - Documentation with Jekyll workshop

This page contains some exercises and discussion topics for using Jekyll to help build and maintain samvera.github.io, a documentation website for the Samvera community.

Expectation Management: We are not experts in Jekyll, but we're here to tell you what we know after playing around with it for the past year or so.

Get the latest code (3 min)

1. Go to https://github.com/samvera/samvera.github.io

afred

# Suppose DogBehavior and Dog are defined in a gem.
module DogBehavior
  def go_pee
    puts "i am now peeing"
  end
end

class Dog
  include DogBehavior
end

afred

Making better use of code generators in Hydra gems.

The problem:

• Code that is generated by a gem (configuration, templates, etc) is only guaranteed to work with the version of the gem that generated it.

• Upgrading the gem may cause the previously generated code to become obsolete.

afred

Handling pbcoreCreator, creator, and creatorRole

Example: creator name is a literal.

NOTE: All PBCore input is using PBCore 2.0 XML unless otherwise specified.
NOTE: All RDF output is in Turtle format unless otherwise specified.

PBCore input:

<pbcoreDescriptionDocument>

afred

Handling pbcoreContributor, contributor, and contributorRole

Example: Contributor name as a literal.

NOTE: All PBCore input is using PBCore 2.0 XML unless otherwise specified.
NOTE: All RDF output is in Turtle format unless otherwise specified.

PBCore input:

<pbcoreDescriptionDocument>

afred

app/models/generic_file.rb

class GenericFile < ActiveFedora::Base
  has_metadata 'descMetadata', type: MediaAnnotationDatastream
  has_attributes :title_attributes, datastream: 'descMetadata', multiple: true
  attr_accessible   :title_attributes     # <== needs to be changed to use strong params, yes?
end

app/models/datastream/media_annotation_datastream.rb

afred

class MyModel < ActiveFedora::Base
end

class MyDatastream < ActiveFedora::RDFDatastream
  property :foo, predicate: ActiveTriples:Resource.new('http://example.com#foo'), 
end

afred

class MyDatastream < ActiveFedora::RDFDatastream
  property :foo, predicate: ActiveTriples::Resource.new('http://example.com#foo'), class_name: 'Foo'
end

my_ds = MyDatastream.new

# I would expect this to whine.. but it doesn.
my_ds.foo = "this is definitely not a Foo"

afred

class MyDatastream < ActiveFedora::NTriplesRDFDatastream
end

afred

class MyDatastream < ActiveFedora::NTriplesRDFDatastream
end