scooby_snacks 0.3

data/examples/example_config_1/shared_schema.yml

@@ -0,0 +1,93 @@
+
+#-------------------
+# Shared Metadata Model
+# Property Settings
+#-------------------
+#
+# This section defines every metadata property that can be used 
+# in the system. Individual work types may override some settings 
+# defined here. Predicates for each property should be defined
+# here, and cannot be overridden once defined.
+
+properties:
+
+  default:
+    definition: "This property has not yet been documented."
+    required: false
+    multiple: true
+    primary: false
+    hidden: false
+    work_title: false
+    input: scalar
+    range: RDF:Literal
+
+  title:
+    definition: "The title of the resource."
+    usage_note: "Multiple titles are allowed, but discouraged. In some contexts it cannot be predicted which title will be displayed."
+    predicate: "DC:title"
+    label: "Title"
+    range: "rdfs:Literal"
+    required: true
+    primary: true
+    work_title: true
+
+  creator:
+    definition: "A person or organization responsible for creating the resource."
+    usage_note: "We plan to use a controlled vocabulary for this field in the future. It is encouraged to use names corresponding exactly to names from the LCSH names directory."
+    predicate: "DC:creator"
+    primary: true
+    required: true
+    facet: true
+
+  contributor:
+    definition: "A person or organization responsible for making contributions to the resource."
+    usage_note: "We plan to use a controlled vocabulary for this field in the future. It is encouraged to use names corresponding exactly to names from the LCSH names directory."
+    predicate: "DC:contributor"
+    facet: true
+
+  publisher:
+    definition: "An entity responsible for making the resource available."
+    usage_note: "We plan to use a controlled vocabulary for this field in the future. It is encouraged to use names corresponding exactly to names from the LCSH names directory."
+    predicate: "DC:publisher"
+    facet: true
+
+  description:
+    definition: "A summary or account of the resource."
+    predicate: "DC:description"
+    range: "rdfs:Literal"
+    primary: true
+
+  subject:
+    definition: "The topic of the resource."
+    usage_note: "We plan to use a controlled vocabulary for this field in the future. It is encouraged to use names corresponding exactly to names from the LCSH vocabulary."
+    predicate: "DC:subject"
+    facet: true
+    primary: true
+
+  date_created: 
+    definition: "Date of creation of the resource."
+    predicate: "DC:created"
+    range: "edm:TimeSpan"
+    label: "Date Created"
+    primary: true
+    required: true
+
+  language:
+    definition: "A language of the resource."
+    predicate: "DC:language"
+    range: skos:concept
+
+  source:
+    definition: "Use to record and previous publication information, e.g., the place of publication and publisher name for a physical resource."
+    predicate: "DC:source"
+
+  call_number:
+    definition: "A call number identifier for the resource."
+    predicate: "Bibframe:classification"
+    multiple: false
+
+  copyright_statement:
+    definition: "Information about rights held in and over the resource."
+    predicate: "DC:rights"
+    primary: true
+    required: true

data/examples/example_config_2/README.md

@@ -0,0 +1,10 @@
+# configuration example 2
+
+This example is more complex. The user incorporates two shared metadata profiles and extensive local customizations. The different sections of the metadata schema are broken up into different files to make it easier to find things.
+
+As usual, the metadata.yml file is the only one that is automatically loaded. This file explicitly lists which other files to load and in which order. The shared schema files are loaded first. Local customizations are loaded afterward, overwriting shared settings where appropriate. 
+
+
+# DISCLAIMER: NOT AN ACTUAL SCHEMA
+
+This is an example of how one might specify a metadata schema using ScoobySnacks. It does not reflect any schema that UCSC has ever used or planned to use. Our developer made this up to demonstrate how the schema configuration files might work.

data/examples/example_config_2/metadata.yml

@@ -0,0 +1,20 @@
+#-------------------
+# Other Schema Files
+#-------------------
+# This section specifies other configuration files that contain
+# metadata information. Files are loaded in order, and the 
+# directives in this file are loaded last. 
+# File paths are specified relative to the application's 'config' directory. 
+# Schema information from all files are merged together. Some options
+# may be overridden in files loaded later. 
+# Other options must be defined only once per property
+# and cannot be overwritten. These include "predicate" and "definition". 
+
+schema_files:
+  - metadata/shared/uc/properties.yml
+  - metadata/shared/uc/classes.yml
+  - metadata/shared/samvera/geospatial_properties.yml
+  - metadata/local/properties.yml
+  - metadata/local/namespaces.yml
+  - metadata/local/work_types.yml
+  - metadata/local/classes.yml

data/examples/example_config_2/metadata/local/classes.yml

@@ -0,0 +1,25 @@
+#-------------------
+# Local Class Settings
+# EXAMPLE - NOT A REAL SCHEMA
+#-------------------
+# This sections defines classes of RDF objects 
+# that are persisted in fedora but are not PCDM works. 
+# These may correspond to objects in external authorities
+# about which we want to ammend keep our own local metadata.
+# Here, we define which properties are available to each Class,
+# among other class properties. .
+
+classes:
+
+  Link:
+    properties:
+      "label":
+        definition: "The title of this resource to be displayed publicly"
+        predicate: "skos:prefLabel"
+      "linked_resource_type":
+        definition: "The human-readable type of linked resource (e.g. finding aid)."
+        predicate: "ucsd:relatedType"
+      url:
+        definition: "The address of the resource to link to"
+        predicate: "schema:url"
+        range: "xsd:anyURI"

data/examples/example_config_2/metadata/local/namespaces.yml

@@ -0,0 +1,10 @@
+#-------------------
+# RDF Namespaces
+# EXAMPLE - NOT A REAL SCHEMA
+#-------------------
+# This section defines additional namespaces for rdf predicates.
+# The most common namespaces are predefined by the system, but
+# we can define others here.
+
+namespaces:
+  edm: "http://www.europeana.eu/schemas/edm/"

data/examples/example_config_2/metadata/local/properties.yml

@@ -0,0 +1,61 @@
+#-------------------
+# Local Property Settings
+# EXAMPLE - NOT A REAL SCHEMA
+#-------------------
+# This section defines every metadata property that can be used 
+# in the system. Individual work types may override some settings 
+# defined here. Predicates for each property should be defined
+# here, and cannot be overridden once defined.
+
+properties:
+
+  default:
+    definition: "This property has not yet been documented."
+    usage_note: "This is the default usage note for a metadata property. If you are seeing this in an active application, you need to define a usage note for your property."
+    usage_warning: 
+    required: false
+    multiple: true
+    primary: false
+    hidden: false
+    work_title: false
+    input: scalar
+    range: RDF:Literal
+
+  title_alternative:
+    label: "Other titles"
+
+  accession_number:
+    definition: "An archival accession number for the resource."
+    predicate: "DC:identifier"
+    range: "rdfs:Literal"
+    multiple: false
+
+  call_number:
+    definition: "A call number identifier for the resource."
+    predicate: "Bibframe:classification"
+    multiple: false
+
+  donor_provenance:
+    definition: "A statement of any changes in ownership and custody of the resource since its creation that are significant for its authenticity, integrity, and interpretation."
+    predicate: "DC:provenance"
+    range: "rdf:Object"
+
+  box_folder:
+    definition: "Location in the holding agency where the item is shelved or stored."
+    predicate: "BF2:physicalLocation"
+  rights_holder:
+    definition: "A person or organization owning or managing rights over the resource."
+    predicate: "DC:rightsHolder"
+    range: "rdf:Object"
+
+  dcmi_type:
+    definition: "General nature or type of the resource (e.g., image, text, etc.). Does not capture aboutness."
+    predicate: "DC:type"
+    range: "skos:concept"
+    facet: true
+
+  scale:
+    definition: "Ratio of the dimensions of a form contained or embodied in a resource to the dimensions of the entity it represents, e.g., for images or cartographic resources."
+    predicate: "Bibframe:cartographicScale"
+    range: "rdfs:Literal"
+

data/examples/example_config_2/metadata/local/work_types.yml

@@ -0,0 +1,25 @@
+#-------------------
+# Work Type Settings
+# EXAMPLE - NOT A REAL SCHEMA
+#-------------------
+# Here we define metadata settings based on work type.
+# This section specifies which properties (defined above)
+# may be applied to each work type, and may specify display
+# settings such as "required" or "hidden".
+# 
+# In the future, this may be extended to actually define 
+# the work types for the application here.
+
+work_types:
+  work:
+    properties:
+      title:
+      description:
+        required: true
+      creator:
+      contributor:
+      physical_extent:
+      rights_license:
+  lecture:
+  course:
+  gdao_work:

data/examples/example_config_2/metadata/shared/geospatial_properties.yml

@@ -0,0 +1,17 @@
+#-------------------
+# Shared Geospatial Property Settings
+# EXAMPLE - NOT AN ACTUAL SCHEMA
+#-------------------
+# This section defines every metadata property that can be used 
+# in the system. Individual work types may override some settings 
+# defined here. Predicates for each property should be defined
+# here, and cannot be overridden once defined.
+
+properties:
+
+  coordinates:
+    definition: Spatial characteristics of the resource.
+    predicate: "DC:spatial"
+
+# obviously this would be more complicated in an actual schema, but hopefully you get the idea of how it might work
+

data/examples/example_config_2/metadata/shared/uc/classes.yml

@@ -0,0 +1,32 @@
+#-------------------
+# Shared Class Settings
+# EXAMPLE - NOT A REAL SCHEMA
+#-------------------
+# This sections defines classes of RDF objects 
+# that are persisted in fedora but are not PCDM works. 
+# These may correspond to objects in external authorities
+# about which we want to ammend keep our own local metadata.
+# Here, we define which properties are available to each Class,
+# among other class properties. .
+
+  Agent:
+    parent: "ActiveTripes::Resource"
+    rdf_label: "::RDF::Vocab::FOAF.Agent"
+    properties: 
+      local_label:
+        definition: "If set, this is a local label for this agent to be indexed and displayed instead of any label fetched from remote authority"
+        predicate: 'skos:altLabel'
+
+  Timespan:
+    parent: "ActiveTripes::Resource"
+    rdf_label: "::RDF::Vocab::FOAF.Agent"
+    properties:
+      label:
+        definition: "A name or label for this timespan"
+        predicate: "skos:prefLabel"
+      begin:
+        definition: "The time when a time period began or commenced."
+        predicate: "edm:begin"
+      end:
+        definition: "The time when a time period ended."
+        predicate: "edm:end"

data/examples/example_config_2/metadata/shared/uc/properties.yml

@@ -0,0 +1,133 @@
+#-------------------
+# Shared Property Settings
+# EXAMPLE - NOT AN ACTUAL SCHEMA
+#-------------------
+# This section defines every metadata property that can be used 
+# in the system. Individual work types may override some settings 
+# defined here. Predicates for each property should be defined
+# here, and cannot be overridden once defined.
+
+properties: 
+
+  default:
+    multiple: true
+    required: false
+    primary: false
+    hidden: false
+    work_title: false
+    display_type: false
+    range: "rdfs:Literal"
+    facet: false
+
+  title:
+    definition: "The title of the resource."
+    usage note: "Use this only for the primary title of the resource. Other titles are put in title_alternative."
+    predicate: "DC:title"
+    label: "Title"
+    required: true
+    primary: true
+    multiple: false
+    work_title: true
+
+  title_alternative:
+    definition: "An alternative title for the resource."
+    usage note: "All titles other than the primary display title should be here"
+    predicate: "DC:alternative"
+    range: "rdfs:Literal"
+
+  creator:
+    definition: "A person or organization responsible for creating the resource."
+    usage note: "Every creator must have a name in a name authority. We have a local name authority for creators that are not in any recognized authority. Please check NAF and ULAN thoroughly before creating a new name entry in our local name authority."
+    predicate: "DC:creator"
+    range: "Agent"
+    vocabularies: "NAF, ULAN, Local"
+    primary: true
+    required: true
+    facet: true
+
+  contributor:
+    definition: "A person or organization responsible for making contributions to the resource."
+    predicate: "DC:contributor"
+    range: "Agent"
+    vocabularies: "NAF, ULAN, Local"
+    facet: true
+
+  publisher:
+    definition: "An entity responsible for making the resource available."
+    predicate: "DC:publisher"
+    range: "Agent"
+    facet: true
+
+  description:
+    definition: "A summary of the resource."
+    predicate: "DC:description"
+
+  description_contents:
+    definition: "A list of subunits of the resource."
+    predicate: "DC:tableOfContents"
+
+
+  subject:
+    definition: "The topic of the resource."
+    predicate: "DC:subject"
+    range: "skos:Concept"
+#    vocabularies: LCSH, NAF, ULAN, GNIS, AAT, Local
+    facet: true
+    primary: true
+
+  genre_form:
+    definition: "The genre, form, and/or physical characteristics of the resource being described. The material or physical carrier of the resource. Does not capture aboutness."
+    usage_note: "We only accept genre_forms in the getty Art and Architecture Thesaurus"
+    predicate: "DC:medium"
+    range: "skos:Concept"
+    vocabularies: AAT
+    facet: true
+
+  date_created: 
+    definition: "Date of creation of the resource."
+    predicate: "DC:created"
+    range: "edm:TimeSpan"
+    label: "Date Created"
+    primary: true
+    required: true
+
+  date_published:
+    definition: "Date of formal issuance (e.g., publication) of the resource."
+    predicate: "DC:issued"
+    range: "edm:TimeSpan"
+    label: "Date Published"
+
+  language:
+    definition: "A language of the resource."
+    predicate: "DC:language"
+    range: skos:concept
+
+  source:
+    definition: "Use to record and previous publication information, e.g., the place of publication and publisher name for a physical resource."
+    predicate: "DC:source"
+
+  physical_extent:
+    definition: "Physical dimensions of the source resource."
+    predicate: "DC:extent"
+
+  rights_copyright_statement:
+    definition: "Information about rights held in and over the resource."
+    predicate: "DC:rights"
+    primary: true
+    required: true
+
+  rights_status:
+    definition: "Information about who can access the resource or an indication of its security status."
+    predicate: "DC:accessRights"
+    primary: true
+    required: true
+    facet: true
+
+  rights_license:
+    definition: "An associated license for the object (i.e. Creative Commons license, software licenses, etc.)."
+    predicate: "DC:license"
+
+  related_resource:
+    definition: "A resource related to this resource in a publicly visible way"
+    predicate: "DC:relation"
+    range: RelatedResource

data/lib/generators/scooby_snacks/install/templates/metadata.yml

@@ -0,0 +1,251 @@
+#-------------------
+# Metadata Field Settings
+#-------------------
+# This section defines every metadata property that can be used 
+# in the system. Individual work types may override some settings 
+# defined here. Predicates for each property should be defined
+# here, and cannot be overridden once defined.
+#
+# Any attribute that is not specified will default to the value
+# in the 'default' section
+
+fields:
+
+  default:
+    definition: "This property has not yet been documented."
+    required: false
+    multiple: true
+    display_group: secondary
+    hidden: false
+    core: false
+    work_title: false
+    input: textbox
+    data_type: text
+    facet_limit: 5
+    facet: false
+    searchable: false
+    stored_in_solr: true
+    full_text_searchable: false
+    sortable: false
+
+  title:
+    definition: "The title of the resource."
+    usage_note: "Enter only the primary title of the resource. All other titles should be entered under Alternative Title."
+    predicate: "DC:title"
+    label: "Title"
+    required: true
+    display_groups: 
+      - primary
+      - search_result
+    index_itemprop: name
+    work_title: true
+    searchable: true
+    full_text_searchable: true
+    OAI: DC:title
+
+  accessionNumber:
+    definition: "An archival accession number for the resource."
+    label: "Accession Number"
+    display_groups: 
+      - admin_only
+      - editor_primary
+    predicate: "DC:identifier"
+    data_type: string
+    multiple: false
+
+  titleAlternative:
+    definition: "An alternative title for the resource."
+    usage_note: "All titles for this work other than the primary title should be listed here"
+    label: "Variant Title"
+    predicate: "DC:alternative"
+    display_groups: 
+      - primary
+      - search_result
+    searchable: true
+    full_text_searchable: true
+
+  creator:
+    definition: "A person or organization responsible for creating the resource."
+    label: Creator
+    predicate: "DC:creator"
+    vocabularies: 
+      - authority: loc
+        subauthority: names
+      - authority: getty
+        subauthority: ulan
+      - authority: local
+        subauthority: agents
+    searchable: true
+    full_text_searchable: true
+    index_itemprop: creator
+    display_groups:
+      - primary
+      - search_result
+    facet: true
+    input: textbox_autosuggest
+    OAI: DC:creator
+
+  resourceType:
+    definition: 'General nature or type of the resource (e.g., image, text, etc.). Does not capture aboutness. '
+    label: Type
+    searchable: true
+    predicate: DC:type
+    display_groups: 
+      - secondary
+      - search_result
+    vocabulary: 
+      authority: local
+      subauthority: dcmi_types
+    facet: true
+    input: dropdown
+    OAI: DC:type
+    multiple: false
+
+  rightsStatement:
+    definition: Information about rights held in and over the resource expressed in general terms (i.e. boilerplate statements).
+    label: Copyright Statement
+    predicate: DC:rights
+    required: 'true'
+    display-groups:
+      - secondary
+      - editor-primary
+    OAI: DC:rights
+  
+  rightsHolder:
+    definition: A person or organization owning or managing rights over the resource.
+    label: Copyright Holder
+    predicate: DC:rightsHolder
+    display_groups:
+      - secondary
+      - editor_primary
+    vocabularies: 
+      - authority: loc
+        subauthority: names
+      - authority: local
+        subauthority: agents
+    input: textbox_autosuggest
+    OAI: DC:rights
+
+  staffNote:
+    definition: Textual information about the resource. This property is used when no type is specified. 
+    label: Staff Note
+    display_group: admin_only
+    predicate: MODS:note
+    stored_in_solr: false
+  
+  subjectName:
+    definition: A name of the person that the resource is about.
+    label: Subject (People)
+    predicate: FOAF:name
+    vocabularies:
+      - authority: loc
+        subauthority: names
+      - authority: getty
+        subauthority: ulan 
+      - authority: local
+        subauthority: agents
+    facet: true        
+    searchable: true
+    full_text_searchable: true
+    input: textbox_autosuggest
+    display_groups:
+      - secondary
+      - editor_primary
+      - search_result
+    OAI: DC:subject
+  
+  
+  subjectTopic:
+    definition: The topic of the resource.
+    label: Subject (Topic)
+    predicate: DC:subject
+    vocabularies: 
+      - authority: loc
+        subauthority: subjects
+      - authority: local
+        subauthority: topics
+    facet: true
+    searchable: true
+    full_text_searchable: true
+    index_itemprop: about
+    input: textbox_autosuggest
+    display_groups:
+      - secondary
+      - editor_primary
+      - search_result
+    OAI: DC:subject
+
+  
+  dateCreated:
+    definition: Date of creation of the original resource.
+    encoding: W3CDTF
+    label: 'Date Created'
+    predicate: DC:date
+    data_type: date
+    index_itemprop: dateCreated
+    input: date
+    display_groups:
+      - secondary
+      - editor_primary
+      - search_result   
+    OAI: DC:date
+
+  datePublished:
+    definition: Date of formal issuance (e.g., publication) of the resource.
+    encoding: W3CDTF
+    label: 'Date Published'
+    index_itemprop: datePublished
+    predicate: DC:issued
+    input: date
+    data_type: date
+  
+  description:
+    definition: An account of the resource.
+    label: Description
+    predicate: DC:description
+    display_groups: 
+      - primary
+      - search_result
+    index_itemprop: description
+    searchable: true
+    full_text_serachable: true
+    OAI: dc:description
+
+  keyword:
+    definition: Keywords (i.e. non-standard terms) assigned to the resource.
+    label: Keyword
+    predicate: schema:keywords
+    index_itemprop: keyword
+    display_groups:
+      - secondary
+      - search_result
+    facet: true
+    searchable: true
+    full_text_searchable: true
+  
+  language:
+    definition: A language of the resource.
+    label: Language
+    predicate: DC:language
+    vocabularies:
+      - authority: loc
+        subauthority: languages
+    index_itemprop: inLanguage
+    input: textbox_autosuggest
+    display_groups:
+      - secondary
+      - editor_primary
+    OAI: DC:language
+
+#-------------------
+# RDF Namespaces
+#-------------------
+# Here we can define additional namespaces for rdf predicates.
+# The most common namespaces are predefined by the system, but
+# this allows us to define more.
+
+namespaces:
+  edm: "http://www.europeana.eu/schemas/edm/"
+  opaque: "http://opaquenamespace.org/ns/"
+  schema: "http://schema.org/"
+  purlOnt: "http://purl.org/ontology/"