Skip to content

contentdm_maps_more

Benjamin Riesenberg edited this page Apr 22, 2024 · 15 revisions

more notes: contentdm_maps

🚧🚧🚧

NOTE
The schemasProject and contentdm_maps repositories must be placed within the same directory in your filesystem

| ...
| schemasProject/
| contentdm_maps/
| ...

creating metadata guidance documents

Creating metadata guidance documents for publication at uwlib-mig.github.io/contentdm_maps/ requires:

  • An XML MAP document, as defined by xsd/xml_maps.xsd
  • Default or custom metadata-creation guidance, example values, and field configuration details entered in schemasProject/properties-files, each corresponding to a metadata field which will be implemented for the collection.
  • The stylesheet xml_map_properties_files_to_html.xsl and stylesheets from contentdm_maps and webviews which it includes.

Create an XML MAP document - contentdm_maps/xml/*

Enter section data

contentdm_maps metadata guidance documents have one or more sections. In each section, metadata-creation guidance (instructions) and example values are provided for a set of objects which:

  1. Are grouped together for the purpose of creating metadata by a common genre/form term, or grouped together using a general category term such as 'default'
  2. Have the same CONTENTdm object type--that is, are either:
    • standalone items
    • compound objects, including both compound object (or containers) and the compound-object items (files) which each compound object contains
  3. Depending on the number of sections and the type of CONTENTdm objects to be used for a given category of resources, may also include:
    • Indication of properties, if any, which will not be used to describe objects
    • In the case of CONTENTdm compound objects:
      • Indication of properties, if any, which will not be used to describe compound objects
      • Indication of properties which will be used to describe compound-object items
genre_form
  • For each category represented in the MAP, select, or add and use, an enumeration from schemasProject/xsd/genre_form.xsd
  • The enumerations in schemasProject/xsd/genre_form.xsd constrain allowable values in contentdm_maps/xml/ XML MAP file genre_form elements, and also in properties_files/ XML property file @genre_form attributes
  • Note that while metadata-creation documents may categorize resources in a collection by very broad or uncontrolled genre/form terms such as 'text', metadata creators may use fields such as genreFormLcgft to assign more specific, controlled terms for search and discovery.
cdm_object_type
  • For each category represented in the MAP, indicate whether resources will be presented as compound objects (use value 'compound_object') or standalone items (use value 'standalone_item')
  • Allowable values are here are fewer than for @co attributes in properties-files (...)
For sections with cdm_object_type = standalone_item

exclude_for_genre_form

  • Select, if any, properties which will not be used to describe this category, as in the following examples:
    • In MAPs with only one category, all properties have been selected for use with all resources and this element will not be needed
    • In maps with multiple categories, some properties may be needed for only some categories
  • Specify by 'p-number'
  • Order does not matter
  • Validated by regex
    • Required prefix for each p-number: '^'
    • Required suffix for each p-number: '$'
    • Required delimiter between each p-number: '|'
For sections with cdm_object_type = compound_object

exclude_for_co

  • Select, if any, properties which will not be used to describe compound objects in this category
  • Specify by 'p-number'
  • Order does not matter
  • Validated by regex
    • Required prefix for each p-number: '^'
    • Required suffix for each p-number: '$'
    • Required delimiter between each p-number: '|'

include_for_co_item

  • Select the properties which will be used to describe the compound-object items in this category
  • Specify by 'p-number'
  • Order does not matter
  • Validated by regex
    • Required prefix for each p-number: '^'
    • Required suffix for each p-number: '$'
    • Required delimiter between each p-number: '|'

Select properties

  • (...if you don't put a property in the list it won't appear in the map!!...)

notes

  • Schema annotations in xsd/xml_maps.xsd provide some further informationi
  • XML documents in contentdm_maps/xml/ with file name _[map name]-dd.xml have not been updated to conform to xsd/xml_maps.xsd and function as described heree

Reference tool - xsl/properties_in_xml_map.xsl

May be helpful when editing XML map exclude_for_co, exclude_for_genre_form, and include_for_co_items element values, see guidance for XML MAPs > exclude_for_co, exclude_for_genre_form, and include_for_co_items elements.

  • Configure transformation scenario (...)

xsl/xml_map_properties_files_to_html.xsl

Clone this wiki locally