ZedAI MODS Metadata

From zedwiki

Jump to: navigation, search

Contents

Background

The Z39.86-AI specification has taken a versatile approach to metadata by allowing records of varying types to be attached to documents. Because of its importance to the IFLA global library initiative, the Meta Data Object Description Schema (or MODS) is one of the primary formats recommended for attaching bibliographic metadata to documents.

The MODS standard provides a comprehensive set of bibliographic metadata elements, and is a product of the MARC bibliographic standard used for cataloguing documents.

Attaching Records

Metadata records are typically stored in separate xml files from the Z39.86-AI documents that reference them. Although the Z39.86-AI specification makes use of the familiar meta element for attaching records to documents inside their head element, this meta element should not be confused with its HTML counterpart from versions past. A set of RDF attributes instead allows for an explicit association between the document and its metadata counterparts. For example:

<head>
  …
  <meta rel="z3986:meta-record" resource="daisy-z2011-exemplar-01-mods.xml">
    <meta property="z3986:meta-record-type" about="daisy-z2011-exemplar-01-mods.xml" content="z3986:mods" />
    <meta property="z3986:meta-record-version" about="daisy-z2011-exemplar-01-mods.xml" content="3.3" />
  </meta>   
  …    
</head>

To break this example down, the outermost meta tag declares that a metadata record is being attached by setting the rel attribute to the value z3986:meta-record. The resource attribute indicates, in this case, the local file containing the metadata record:

 <meta rel="z3986:meta-record" resource="daisy-z2011-exemplar-01-mods.xml">
   …
 </meta>

The z3986: prefix and the meta-record property are both defined by the Z39.86-2011 Metadata Instance Vocabulary. Although it is recommended that this document be reviewed, adding a meta tag with this rel value never changes when attaching metadata. The resource attribute typically does change to point to the new location of the metadata resource (it can point to more than just files), but refer to the Z39.86-AI specification and primers for more information.

What we have declared in the file at this point is that our metadata record can be found in a file named daisy-z2011-exemplar-01-mods.xml. That's not terrible helpful, as a program looking to process our document has no idea what it's going to find inside the file, a vital piece of information to prevent unnecessary read attempts on all the attached records to determine which one is needed (appending a suffix like "-mods" is helpful for human identification, but cannot be relied on by a program).

The next step in attaching a metadata record, as you might reasonably assume at this point, is to specify the record type as well as its version number (if one exists).

In our starting example, you will probably have noticed that there were two meta elements contained inside (children of) the meta tag we just described as indicating where our metadata record can be found:

    <meta property="z3986:meta-record-type" about="daisy-z2011-exemplar-01-mods.xml" content="z3986:mods" />
    <meta property="z3986:meta-record-version" about="daisy-z2011-exemplar-01-mods.xml" content="3.3" />

The property values here again are static. The first, z3986:meta-record-type indicates that this meta tag provides information about the type of record. This is consequently where we declare that we're using MODS, as evidenced in the value of content attribute (z3986:mods is a pre-defined value for all MODS records):

   <meta property="z3986:meta-record-type" about="daisy-z2011-exemplar-01-mods.xml" content="z3986:mods" />

You'll also notice that this meta tag contains an about attribute that once again provides the name of the metadata file. Z39.86-AI metadata information is based on the RDF standard, so to create a proper triple you need to include this information (don't worry if this doesn't make a lot of sense, as you don't need to understand the RDF specification, only that each child meta must include an about attribute repeating the value).

The second child meta tag is very similar to the first in that it describes the property it is going to set in the property tag (the version of the metadata standard) and gives its value in the content attribute (MODS 3.3):

   <meta property="z3986:meta-record-version" about="daisy-z2011-exemplar-01-mods.xml" content="3.3" />

And that encompasses the whole process of attaching your MODS metadata record inside your Z39.86-AI document. You can copy and paste this example from document to document only having to change the resource and about attributes to point to the new metadata file (until you upgrade to a new version of the MODS standard, of course, and have to update your version number!).

MODS XML

This guide only covers key MODS elements that have been identified as commonly occurring in bibliographic records for Z39.86-AI documents. When creating metadata records, the complete set of MODS elements can be used. For more information, please refer to the MODS 3.3 user guidelines.

All MODS records must conform to the official MODS 3.3 schema maintained by the Library of Congress. Successful Z39.86-AI document validation is not an indicator of the compliance of any attached metadata record.

In the case of any discrepancies between the information presented in this guide and the MODS schemas, the official MODS specification shall be taken as authoritative.

A complete sample of a MODS record can be found at the end of this document.

mods

All MODS records have a mods element at their root. This element is the container for the bibliographic information about a document.

There are two attributes that should always be included on the root mods element: the xmlns attribute indicating the MODS namespace and the version attribute for specifying that the record conforms to version 3.3 of the standard:

	<mods xmlns="http://www.loc.gov/mods/v3" version="3.3">
		<!-- bibliographic record -->
	</mods>

If your XML editor provides automatic validation and/or code completion, the MODS 3.3 schema location can be attached to the root element:

	<mods
		xmlns="http://www.loc.gov/mods/v3"
		version="3.3"
                xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
		xsi:schemaLocation="http://www.loc.gov/mods/v3 http://www.loc.gov/standards/mods/v3/mods-3-3.xsd">
		<!-- bibliographic record -->
	</mods>

originInfo

As many producers of DAISY documents are not the original publishers of the documents, one of the primary metadata needs is to represent and separate these two entities. The originInfo element serves this dual function.

When the publisher and producer of a document are the same entity, only a single originInfo element needs to be included in a document's metadata. The presence of a single element assumes this relationship.

For example:

	<originInfo>
		<!-- publisher == producer -->
	</originInfo>


To serve the dual function of specifying separate producer and publisher information, however, requires that a relatedItem element (detailed below) wrap the original publisher's information.

The relatedItem element has a type attribute that allows the value original, which, when set, indicates all of its child elements relate to the original creator of the document (the publisher, in the DAISY context). The originInfo element at the root of the MODS record now identifies the producer of the document and the originInfo element inside the relatedItem element identifies the publisher:

	<originInfo>
		<!-- producer -->
	</originInfo>
	<relatedItem type="original">
		<originInfo>
			<!-- publisher -->
		</originInfo>
	</relatedItem>

The originInfo element can contain any of the properties outlined in the following subsections.


publisher

The name of the producer/publisher of the document:

	<publisher>DAISY Consortium</publisher>

place

The physical location of the producer/publisher of the document:

	<place>Zurich, Switzerland</place>

edition

The edition/version of the book/document:

	<edition>2nd Edition</edition>


dateCreated

The date the document was created:

	<dateCreated scheme="iso-8601">2009-12-11</dateCreated>

Dates should conform to the ISO-8601 standard.


copyrightDate

The copyright date of the document:

	<copyrightDate>Copyright &copy 2009</copyrightDate>


dateIssued

The date on which the document was released:

	<dateIssued scheme="iso-8601">2009-04-01</dateIssued>

Dates should conform to the ISO-8601 standard.


dateValid

Date after which the content of the document should no longer be considered valid:

	<dateValid scheme="iso-8601">2020-01-01</dateValid>

Dates should conform to the ISO-8601 standard.

dateModified

The last modification date of the document:

	<dateModified scheme="iso-8601">2009-04-01</dateModified>

Dates should conform to the ISO-8601 standard.


issuance

The issuance element can be set to the value continuous to indicate that the document is a periodical:

	<issuance>continuous</issuance>


frequency

For periodicals, the frequency element can be added to indicate the release interval:

	<frequency>monthly</frequency>

titleInfo

The titleInfo element, as its name suggests, contains meta information about the title of the document.

	<titleInfo>
		<!-- title information -->
	</titleInfo>

When including more than one titleInfo element, the type attribute is used to indicate the type of title. The value of this attribute can any be one of: abbreviated, translated, alternative or uniform:

	<titleInfo type="translated">
		<!-- title information -->
	</titleInfo>

The primary title of the document must never include a type attribute on its titleInfo element.

The titleInfo element can contain any of the elements outlined in the following subsections.


title

The title of the document:

	<title>Dr. Strangelove</title>


subTitle

The subtitle of the document:

	<subtitle>Or how I learned to stop worrying...</subtitle>


partNumber

When reproducing a piece of a larger work, the part number:

	<partNumber>43.2</partNumber>


partName

When reproducing a piece of a larger work, the part name:

	<partName>Quantum Theory Basics</partName>

name

The name element is a container element that identifies each creator of a document:

	<name>
		<!-- name information -->
	</name>

The element can occur multiple times within a record, as a result.

The name element can contain the elements outlined in the following subsections.


namePart

Name can be used to include the complete name of a person:

	<namePart>William Blake</namePart>

It can also be used to identify the component pieces of a name using by attaching a type attribute with one of the following values: family, given, termsOfAddress or date.

	<namePart type="family">Blake</namePart>
	<namePart type="given">William</namePart>
	<namePart type="termsOfAddress">Dr.</namePart>


displayForm

The displayForm element can be used to retain the person's name as it appeared in the work, if different from the representation in their namePart element:

	<displayForm>The Abominable Dr. Phibes</displayForm>

affiliation

Any affiliations to which the person belonged at the time the document was written:

	<affiliation>Stonecutter</affiliation>


role

The role element is used to impart the specific function that person played in the creation, such as author, editor, illustrator, etc.

Each role must contain at least one child roleTerm element that specifies the textual or coded version of the person's function:

	<role>
		<roleTerm type="text">author</roleTerm>
		<roleTerm type="code">aut<roleTerm>
	</role>


description

Allows the addition of a textual description to further distinguish the name:

	<description>Romantic poet</description>

language

The language the document is written in:

	<language scheme="iso639-3">fr-ca</language>

Languages must conform to either ISO 639-3 or RFC 3066.

Note that the language of the document is not the same as the encoding of the Z39.96-AI xml file.

identifier

The identifier element can be used to provide identifiers for the document:

	<identifier type="isbn13">9761012989743</identifier>

A record may contain more than one identifier element; each element should have a unique type value, however.

The MODS specification does not include a controlled set of values for the type attribute, but does provide a list of suggested values.

physicalDescription

The physicalDescription element contains information about the original format of the document, if it has been converted from another media:

	<physicalDescription>
		<!-- information about the document -->
	</physicalDescription>

The physicalDescription element can contain the elements outlined in the following subsections.


internetMediaType

MIME type of the original document:

	<internetMediaType>application/xml</internetMediaType>


extent

Page range of the original document:

	<extent>i-xl and 1-392</extent>

note

A textual note about the document or its contents:

	<note>Translated from Russian.</note>

A type attribute can be used to include more specific information about the type of note:

	<note type="biographical">He lived; he died.</note>

Although there is not a controlled list of values for the type property, a list of common values has been compiled by the MODS maintainers.

relatedItem

The relatedItem element is an encapsulating element which can wrap any of the elements mentioned above. The purpose of the relatedItem element is to allow producers to include repeated, but differing, information.

	<relatedItem type="original">
		<!-- related information -->
	</relatedItem>

The most common use of this element in the DAISY context will be to differentiate publisher from producer information, as outlined in the originInfo section.


	<relatedItem type="original">
		<originInfo>
			<publisher>Random House</publisher>
		</originInfo>
	</relatedItem>

A type must be included on each relatedItem element. The type attribute must have one of the following values: original, preceding, succeeding, host, constituent, series, otherVersion, otherFormat or isReferencedBy.

Meta Data Example

A metadata record for the World Cultures and Geography textbook has been presented below. For comparison purposes, following it is the same metadata as originally expressed in a Z39.86-2005 document.


MODS XML

A Z39.86-AI document declares the location of the metadata record as well as the standard it conforms to:

<head>
  …
  <meta rel="z3986:meta-record" resource="daisy-z2011-exemplar-01-mods.xml">
    <meta property="z3986:meta-record-type" about="daisy-z2011-exemplar-01-mods.xml" content="z3986:mods" />
    <meta property="z3986:meta-record-version" about="daisy-z2011-exemplar-01-mods.xml" content="3.3" />
  </meta>   
  …    
</head>

The metadata record can then exist in its native format in a separate file:

<mods xmlns="http://www.loc.gov/mods/v3" version="3.3">
	<titleInfo>
		<title>World Cultures and Geography</title>
	</titleInfo>
	
	<name>
		<namePart>Sarah Witham Bednarz</namePart>
		<role>
			<roleTerm type="text">author</roleTerm>
		</role>
	</name>
	
	<name>
		<namePart>Inés M. Miyares</namePart>
		<role>
			<roleTerm type="text">author</roleTerm>
		</role>
	</name>
	
	<name>
		<namePart>Mark C. Schug</namePart>
		<role>
			<roleTerm type="text">author</roleTerm>
		</role>
	</name>
	
	<name>
		<namePart>Charles S. White</namePart>
		<role>
			<roleTerm type="text">author</roleTerm>
		</role>
	</name>
	
	<originInfo>
		<publisher>DAISY Consortium</publisher>
		<dateCreated>2005-01-14</dateCreated>
		<version>3</version>
		<dateModified>2005-07-27</dateModified>
	</originInfo>
	
	<relatedItem type="original">
		<originInfo>
			<publisher>McDougal Littell</publisher>
			<place>Evanston, Illinois</place>
			<dateCreated>2003</dateCreated>
		<originInfo>
	</relatedItem>
	
	<identifier type="uid">daisy-z2011-exemplar-01</identifier>
	<identifier type="isbn10">0618168419</identifier>
	
	<typeOfResource>text</typeOfResource>
	
	<physicalDescription>
		<form>Hardcover print</form>
	</physicalDescription>
	
	<subject>Geography</subject>
	
	<language>en</language>
	
	<note type="description">Culture and geography textbook for highschool</note>
	
</mods>

DAISY/NISO Z39.86-2005

The World Cultures and Geography metadata declared inline in the head element of a DAISY/NISO Z39.86-2005 document:


<head>

	<meta name="dc:Title" content="World Cultures and Geography" />

	<meta name="dc:Creator" content="Sarah Witham Bednarz" />

	<meta name="dc:Creator" content="Inés M. Miyares" />

	<meta name="dc:Creator" content="Mark C. Schug" />

	<meta name="dc:Creator" content="Charles S. White" />

	<meta name="dc:Subject" content="Geography" />

	<meta name="dc:Description" content="Culture and geography textbook for highschool" />

	<meta name="dc:Publisher" content="DAISY Consortium" />

	<meta name="dc:Date" content="2005-01-14" />

	<meta name="dc:Type" content="Text" />

	<meta name="dc:Identifier" content="daisy-dtbook2005-exemplar-01" />

	<meta name="dc:Source" scheme="ISBN" content="0618168419" />

	<meta name="dc:Language" content="en" />

	<meta name="dtb:sourceDate" content="2003" />

	<meta name="dtb:sourceEdition" content="Hardcover print" />

	<meta name="dtb:sourcePublisher" content="McDougal Littell, Evanston, Illinois" />

	<meta name="dtb:revision" content="3" />

	<meta name="dtb:revisionDate" content="2005-07-27" />

</head>

Personal tools