Metadata Collections & QA
Skip navigation Digital Library for Earth System Education
Digital Library for Earth System Education
Search tips

Documentation: Annotation framework version 1.0.00

This metadata framework documentation provides:

  • Graphical overview, content examples, cataloging best practiaphical overview, content examples, cataloging best practices
  • A description of each maphical overview, content examples, cataloging best practices
  • A description of each metadata field including occurrences, obligation, data types, terms and definitions
  • Bolded items represent controlled vocabulary terms or the name of individual metadata fields

The table below organizes the metadata fields in alphabetical order across and then down:

Annotation Annotation record Content
Context Contributor Contributor list
Date - contribution Date - created Date - modified
Date - service Department - individual contributor Department - organizational contributor
Description Email - alternate Email - individual contributor
Email - organizational contributor Format ID - item - resource being annotated
ID - record - library catalog number Info Name - first
Name - last Name - middle Name - service
Name - title - contributor Organization Organization name - individual contributor
Organization name - organizational contributor Pathway Person
Position - individual contributor Position - organizational contributor Rating
Role Service Share
Status Title Type
Url - annotation content Url - organization

 

Top

Annotation

xpath - /annotationRecord/annotation
Framework version - 1.0.00

Definition - information about the annotation including the annotation itself, the contributor of the annotation, its status, format, type, and title
Obligation - required
Minimum occurrences - 1
Maximum occurrences - 1
Child elements - title, type, format, status, content, context, contributors
Data types - complex
Domain - the children elements are the domain
Domain example - <content>, <type>

Cataloging best practices

Things to do

  • Complete the required subfields of type, content and contributors.

Top

Annotation record

xpath - /annotationRecord
Framework version - 1.0.00

Definition - the root element of the annotation metadata record
Obligation - required
Minimum occurrences - 1
Maximum occurrences - 1
Child elements - service, itemID, annotation
Data types - complex
Domain - the children elements are the domain
Domain example - <service>, <itemID>, <annotation>

Cataloging best practices

Things to do

  • Complete the required subfields of service, item ID and annotation.

Top

Content

xpath - /annotationRecord/annotation/content
Framework version - 1.0.00

Definition - a description, rating or web page that augments user interaction with the resource being annotated; this may include supportive or contextual material or actual content of an annotation
Obligation - required
Minimum occurrences - 1
Maximum occurrences - 1
Child elements - url, description, rating
Data types - complex
Domain - the children elements are the domain
Domain example - <url>, <description>, <rating>

Cataloging best practices

Things to do

  • Complete at least one of the required subfields of url, description or rating.

Top

Context

xpath - /annotationRecord/annotation/context
Framework version - 1.0.00

Definition - a page within the resource being annotated to which the annotation most directly applies
Obligation - optional
Minimum occurrences - 0
Maximum occurrences - 1
Data types - string
Domain - free text
Domain example - http://www.resource.org/lesson1/page2.html

Cataloging best practices

Things to do

  • Use this field to when connecting comments or annotations to a specific page in a large resource.
  • Begin URLs with the proper Internet scheme like http://
  • URLs with ampersands, percent 20's, equal signs, underscores and question marks are okay.

Things to avoid

  • Do not use this field if the page being referenced is the primary URL of the resource being annotated.

Top

Contributor

xpath - /annotationRecord/annotation/contributors/contributor
Framework version - 1.0.00

Definition - the person or organization making the annotation
Obligation - required
Minimum occurrences - 1
Maximum occurrences - unbounded
Attributes - role, share, date
Child elements - organization, person
Data types - complex
Domain - the attributes and child elements; date formats and the controlled vocabularies for role and share
Domain example - <organization>, <person>, 2004-10-26

Notes

  • Organizations or people include authors, contacts, editors, publishers, educators or students.

Cataloging best practices

Things to do

  • Complete the required subfields of role and date.
  • Complete either the person subfield or the organization subfield. One of them is required.
  • Complete the share field to indicate whether name, email and organizational information can be shared.

Things to avoid

  • Do not include webmasters as contributors.

Top

Contributor list

xpath - /annotationRecord/annotation/contributors
Framework version - 1.0.00

Definition - a list of organizations or persons responsible for making or publishing the annotation
Obligation - required
Minimum occurrences - 1
Maximum occurrences - 1
Child elements - contributor
Data types - complex
Domain - the children elements are the domain
Domain example - <contributor>

Notes

  • The list of organizations or people include authors, contacts, editors, publishers, educators, students

Cataloging best practices

Things to do

  • Complete the required contributor subfield.

Top

Date - contribution

xpath - /annotationRecord/annotation/contributors/contributor/@date
Framework version - 1.0.00

Definition - the date of a contributor's contribution to the annotation
Obligation - required
Minimum occurrences - 1
Maximum occurrences - 1
Data types - date, gYearMonth, gYear
Domain - numerical date format
Domain example - 2004-10-15, 2004-10, 2004

Notes

  • This field is an attribute on the contributor field.

Cataloging best practices

Things to do

  • Enter a date to signify when a important contribution has been made.
  • Use a date format of YYYY-MM-DD, e.g. 2004-12-27.
  • Enter a year for every date entered.

Things to avoid

  • Do not enter days of the week.
  • Do not enter just months or days.

Examples

  • Year: 2004.
  • Year and month: 2004-12.
  • Year, month and day: 2004-12-27.

Top

Date - created

xpath - /annotationRecord/service/date/@created
Framework version - 1.0.00

Definition - the creation date of the annotation metadata record
Obligation - required
Minimum occurrences - 1
Maximum occurrences - 1
Data types - date
Domain - numerical date format
Domain example - 2005-04-11

Notes

  • This field is an attribute on the date - service field.

Cataloging best practices

Things to do

  • Enter a date to signify when the annotation metadata record is created.
  • Use a date format of YYYY-MM-DD, e.g. 2004-12-27.

Things to avoid

  • Do not enter days of the week.
  • Do not enter just months or days.

Examples

  • Year, month and day: 2004-12-27.

Top

Date - modified

xpath - /annotationRecord/service/date/@modified
Framework version - 1.0.00

Definition - the modification date of the annotation metadata record
Obligation - optional
Minimum occurrences - 0
Maximum occurrences - 1
Data types - date
Domain - numerical date format
Domain example - 2005-04-11

Notes

  • This field is an attribute on the date - service field.

Cataloging best practices

Things to do

  • Enter a date to signify when the annotation metadata record is modified.
  • Use a date format of YYYY-MM-DD, e.g. 2004-12-27.

Things to avoid

  • Do not enter days of the week.
  • Do not enter just months or days.

Examples

  • Year, month and day: 2004-12-27.

Top

Date - service

xpath - /annotationRecord/service/date
Framework version - 1.0.00

Definition - the creation or modification date information of the annotation metadata record
Obligation - required
Minimum occurrences - 1
Maximum occurrences - 1
Attributes - created, modified
Data types - complex
Domain - the attribute elements are the domain
Domain example - created=2002-08-03

Cataloging best practices

Things to do

  • Complete the required subfield of created.

Top

Department - individual contributor

xpath - /annotationRecord/annotation/contributors/contributor/person/instDept
Framework version - 1.0.00

Definition - the name of the department to which a person is affiliated
Obligation - optional
Minimum occurrences - 0
Maximum occurrences - 1
Data types - string
Domain - free text
Domain example - Department of Geosciences
Other occurrences in framework - true

Notes

  • Other XPATH: /annotationRecord/annotation/contributors/contributor/organization/instDept

Cataloging best practices

Things to do

  • If the specific department (and sub-department) is known, enter the full name of the department.
  • Spell out acronyms.
  • The department name should be the formal name of an entity, not a person.

Things to avoid

  • Do not use this field if the information is unknown or is suspect.

Top

Department - organizational contributor

xpath - /annotationRecord/annotation/contributors/contributor/organization/instDept
Framework version - 1.0.00

Definition - the name of a department within an organization
Obligation - optional
Minimum occurrences - 0
Maximum occurrences - 1
Data types - string
Domain - free text
Domain example - Department of Geosciences
Other occurrences in framework - true

Notes

  • Other XPATH: /annotationRecord/contributors/contributor/person/instDept

Cataloging best practices

Things to do

  • If the specific department (and sub-department) is known, enter the full name of the department.
  • Spell out acronyms.
  • The department name should be the formal name of an entity, not a person.

Things to avoid

  • Do not use this field if the information is unknown or is suspect.

Top

Description

xpath - /annotationRecord/annotation/content/description
Framework version - 1.0.00

Definition - full or partial content of an annotation in the form of textual information or information regarding supportive or contextual material for a resource
Obligation - choice
Minimum occurrences - 1 or 0
Maximum occurrences - 1
Data types - string
Domain - free text
Domain example - The visuals of this resource really help students understand the interactions of wind (speed and direction), moisture, ocean surface temperature and latitude in hurricane generation.

Cataloging best practices

Things to do

  • Include information that would be helpful to users in using or interacting with the resource.
  • Use complete sentences in a voice that does not imply the user is at the resource.
  • Put names of persons or organizations making the annotation in the contributor field.
  • To use special characters like ampersands, copyright symbols, double quotes, single quotes, tilde, etc. read the want to use special characters section below.

Things to avoid

  • Avoid using quotes and ampersands. This allows for easier reading.
  • Avoid using lots of capitalized words. Lowercase words to make the description easier to read.

Examples

  • The visuals of this resource really help students understand the interactions of wind (speed and direction), moisture, ocean surface temperature and latitude in hurricane generation.

Want to use special characters like ©, é, ñ or ê? Do this:

  • Enter special characters and symbols using their entity references numbers. For the copyright symbol this means entering an ampersand symbol followed by the pound sign followed by the number 169 followed by a semicolon.

Top

Email - alternate

xpath - /annotationRecord/annotation/contributors/contributor/person/emailAlt
Framework version - 1.0.00

Definition - an alternate email address to use as a point of contact
Obligation - optional
Minimum occurrences - 0
Maximum occurrences - 1
Data types - string
Domain - free text
Domain example - name@something.org

Cataloging best practices

Things to do

  • Enter email addresses in the following format: name@something.org
  • When copying email addresses from web sites, double check them for accuracy and remove trailing periods.

Things to avoid

  • Do not use this field if the information is unknown or suspect.

Top

Email - individual contributor

xpath - /annotationRecord/annotation/contributors/contributor/person/email
Framework version - 1.0.00

Definition - the primary email address to use as a point of contact
Obligation - required metadata if parent tag is present
Minimum occurrences - 1
Maximum occurrences - 1
Data types - string
Domain - free text
Domain example - name@something.org
Other occurrences in framework - true

Notes

  • Other XPATH: /annotationRecord/annotation/contributors/contributor/organization/email

Cataloging best practices

Things to do

  • Enter email addresses in the following format: name@something.org
  • When copying email addresses from web sites, double check them for accuracy and remove trailing periods.

Things to avoid

  • Do not use this field if the information is unknown or suspect.

Top

Email - organizational contributor

xpath - /annotationRecord/annotation/contributors/contributor/organization/email
Framework version - 1.0.00

Definition - the primary email address to use as a point of contact
Obligation - optional
Minimum occurrences - 0
Maximum occurrences - 1
Data types - string
Domain - free text
Domain example - name@something.org
Other occurrences in framework - true

Notes

  • Other XPATH: /annotationRecord/annotation/contributors/contributor/person/email

Cataloging best practices

Things to do

  • Enter email addresses in the following format: name@something.org
  • When copying email addresses from web sites, double check them for accuracy and remove trailing periods.

Things to avoid

  • Do not use this field if the information is unknown or suspect.

Top

Format

xpath - /annotationRecord/annotation/format
Framework version - 1.0.00

Definition - the format of the content of annotation
Obligation - optional
Minimum occurrences - 0
Maximum occurrences - 1
Data types - string
Domain - controlled vocabulary
Domain example - Text

Controlled vocabulary information

  • Number of levels - 1
  • Level 1 is Format - the format of the content of annotation

Term and definitions

  • Audio - the content of the annotation is primarily sound to be heard
  • Graphical - the content of the annotation is primarily an image or graphic to view or overlay
  • Text - the content of the annotation is primarily text to be read
  • Video - the content of the annotation is primarily sound and pictures

Cataloging best practices

Things to do

  • Choose a format from the term list.
  • Use this field when the format of the annotation is something other than Text.
  • Only a single format is allowed. Choose the format that best presents the annotation.

Top

ID - item - resource being annotated

xpath - /annotationRecord/itemID
Framework version - 1.0.00

Definition - the catalog identification number of the annotated resource
Obligation - required
Minimum occurrences - 1
Maximum occurrences - 1
Data types - string
Domain - free text
Domain example - CURL-123

Cataloging best practices

Things to do

  • If annotating a resource in DLESE, use www.dlese.org to determine the record ID - library catalog number of the resource to which a relationship is being created. Record ID numbers are found on full description pages. Use this record ID information as content for this field.
  • If annotating a resource that is not in DLESE, use record ID information from the catalog/library/repository the resource to be annotated resides in.

Things to avoid

  • Generally avoid spaces, apostrophes, quotes, slashes, less than or greater than signs, question marks, equal signs or URLs as part of record ID numbers.
  • If using a DLESE cataloging tool, do not use spaces, apostrophes, quotes, slashes, less than or greater than signs, question marks, equal signs or URLs as part of record ID numbers.

Examples

  • DLESE-000-000-000-123
  • ABC-000-000-000-123

Top

ID - record - library catalog number

xpath - /annotationRecord/service/recordID
Framework version - 1.0.00

Definition - the catalog identification number of the metadata file being created
Obligation - required
Minimum occurrences - 1
Maximum occurrences - 1
Data types - string
Domain - free text
Domain example - ANNO-000-000-000-123

Notes

  • These are the metadata record identification numbers.

Cataloging best practices

Things to do

  • Use automated means to generate record ID numbers.
  • If using a DLESE cataloging tool, record ID number generate automatically.
  • Use unique text strings.

Things to avoid

  • If using a DLESE cataloging tool, do not change automatically generated record ID numbers.
  • Do not repeat record ID numbers with a collection.
  • Generally avoid spaces, apostrophes, quotes, slashes, less than or greater than signs, question marks, equal signs or URLs as part of record ID numbers.
  • If using a DLESE cataloging tool, do not use spaces, apostrophes, quotes, slashes, less than or greater than signs, question marks, equal signs or URLs as part of record ID numbers.
  • Do not use just numbers; rather include a text label with a string of numbers. See examples below.

Examples

  • DLESE-000-000-000-123
  • ABC-000-000-000-123

Top

Info

xpath - /annotationRecord/moreInfo
Framework version - 1.0.00

Definition - more information provided in the form of single or multiple XML documents
Obligation - optional
Minimum occurrences - 0
Maximum occurrences - 1
Data types - complex
Domain - well-formed XML documents
Domain example - <ab>Hello world.</ab>

Cataloging best practices

Things to do

  • Provide XML documents only. They may or may not be schema or DTD based.
  • Enter only well-formed XML.

Things to avoid

  • Do not enter plain text.
  • Do not include the XML line of <?xml version="1.0" encoding="UTF-8"?>

Top

Name - first

xpath - /annotationRecord/annotation/contributors/contributor/person/nameFirst
Framework version - 1.0.00

Definition - the first name of a person
Obligation - required metadata if parent tag is present
Minimum occurrences - 1
Maximum occurrences - 1
Data types - string
Domain - free text
Domain example - Jane, J.

Cataloging best practices

Things to do

  • Enter complete names, if possible.
  • If only an initial is known, add a period.

Things to avoid

  • Do not enter last or family names.

Examples

  • Anne
  • A.

Want to use special characters like ©, é, ñ or ê? Do this:

  • Enter special characters and symbols using their entity references numbers. For the copyright symbol this means entering an ampersand symbol followed by the pound sign followed by the number 169 followed by a semicolon.

Top

Name - last

xpath - /annotationRecord/annotation/contributors/contributor/person/nameLast
Framework version - 1.0.00

Definition - the last or family name of a person
Obligation - required metadata if parent tag is present
Minimum occurrences - 1
Maximum occurrences - 1
Data types - string
Domain - free text
Domain example - Doe

Cataloging best practices

Things to do

  • Enter complete names.

Things to avoid

  • Do not use just an initial for the last name.

No last name? Do this:

  • If the last name is unknown, do not enter a person as a contributor. If possible, enter an organization as the contributor instead.

Want to use special characters like ©, é, ñ or ê? Do this:

  • Enter special characters and symbols using their entity references numbers. For the copyright symbol this means entering an ampersand symbol followed by the pound sign followed by the number 169 followed by a semicolon.

Top

Name - middle

xpath - /annotationRecord/annotation/contributors/contributor/person/nameMiddle
Framework version - 1.0.00

Definition - the middle name of a person
Obligation - optional
Minimum occurrences - 0
Maximum occurrences - 1
Data types - string
Domain - free text
Domain example - Anne, A.

Cataloging best practices

Things to do

  • Enter complete names, if possible.
  • If only an initial is known, add a period.

Things to avoid

  • Do not enter last or family names.

Examples

  • Anne
  • A.

Want to use special characters like ©, é, ñ or ê? Do this:

  • Enter special characters and symbols using their entity references numbers. For the copyright symbol this means entering an ampersand symbol followed by the pound sign followed by the number 169 followed by a semicolon.

Top

Name - service

xpath - /annotationRecord/service/name
Framework version - 1.0.00

Definition - the name of the organization creating the metadata record
Obligation - required
Minimum occurrences - 1
Maximum occurrences - 1
Data types - string
Domain - free text
Domain example - Columbia University

Cataloging best practices

Things to do

  • Spell out acronyms.
  • The organization name should be a formal name of the institution or entity.

Things to avoid

  • Do not use the name of an individual person.

Examples

  • Columbia University
  • America Geological Institute (AGI)

Top

Name - title - contributor

xpath - /annotationRecord/annotation/contributors/contributor/person/nameTitle
Framework version - 1.0.00

Definition - the form of address for an individual
Obligation - optional
Minimum occurrences - 0
Maximum occurrences - 1
Data types - string
Domain - controlled vocabulary
Domain example - Dr, Prof, Mr

Controlled vocabulary information

  • Number of levels - 1
  • Level 1 is Name title - the form of address for an individual

Term and definitions

  • Dr - self-explanatory
  • Miss - self-explanatory
  • Mr - self-explanatory
  • Mrs - self-explanatory
  • Ms - self-explanatory
  • Prof - self-explanatory

Cataloging best practices

Things to do

  • Choose a form of address from the term list.

Top

Organization

xpath - /annotationRecord/annotation/contributors/contributor/organization
Framework version - 1.0.00

Definition - information about an institution that includes its name and possibly a contact email address, department, position or URL
Obligation - choice
Minimum occurrences - 1 or 0
Maximum occurrences - 1
Child elements - instName, instDept, instPosition, url, email
Data types - complex
Domain - the child elements
Domain example - <instName>

Notes

  • Organization is part of a choice. That is, a child element of either organization or person is required as part of the contributor element.

Cataloging best practices

Things to do

  • Complete the required subfield of organization name - organizational contributor.

Top

Organization name - individual contributor

xpath - /annotationRecord/annotation/contributors/contributor/person/instName
Framework version - 1.0.00

Definition - the formal name of an organization to which a person is affiliated
Obligation - required metadata if parent tag is present
Minimum occurrences - 1
Maximum occurrences - 1
Data types - string
Domain - free text
Domain example - American Geophysical Union (AGU), Rolling Meadows High School, The Weather Channel
Other occurrences in framework - true

Notes

  • Other XPATH: /annotationRecord/annotation/contributors/contributor/organization/instName

Cataloging best practices

Things to do

  • Spell out acronyms.
  • The institutional name should be a formal name of an organization or entity and not a person or a position.
  • If the organization contains .com as part of its name, include the .com part in the name of the organization.

Things to avoid

  • Do not enter departmental information. Use the department - individual contributor field instead.

Examples

  • American Geophysical Union (AGU)
  • Accuweather
  • Rolling Meadows High School
  • The Weather Channel
  • earthscience.com

Top

Organization name - organizational contributor

xpath - /annotationRecord/annotation/contributors/contributor/organization/instName
Framework version - 1.0.00

Definition - the formal name of an organization
Obligation - required metadata if parent tag is present
Minimum occurrences - 1
Maximum occurrences - 1
Data types - string
Domain - free text
Domain example - American Geophysical Union (AGU), Rolling Meadows High School, The Weather Channel
Other occurrences in framework - true

Notes

  • Other XPATH: /annotationRecord/annotation/contributors/contributor/person/instName

Cataloging best practices

Things to do

  • Spell out acronyms.
  • The institutional name should be a formal name of an organization or entity and not a person or a position.
  • If the organization contains .com as part of its name, include the .com part in the name of the organization.

Things to avoid

  • Do not enter departmental information. Use the department - organizational contributor field instead.

Examples

  • American Geophysical Union (AGU)
  • Accuweather
  • Rolling Meadows High School
  • The Weather Channel
  • earthscience.com

Top

Pathway

xpath - /annotationRecord/service/pathway
Framework version - 1.0.00

Definition - the name of a group that enters resources directly into the DLESE Reviewed Collection (DRC)
Obligation - optional
Minimum occurrences - 0
Maximum occurrences - 1
Data types - string
Domain - controlled vocabulary
Domain example - Community Review System (CRS)

Controlled vocabulary information

  • Number of levels - 1
  • Level 1 is Pathway - the name of a group that enters resources directly into the DLESE Reviewed Collection (DRC)

Term and definitions

  • CRS (Community Review System) - self-explanatory
  • DWEL (Digital Water Education Library) - self-explanatory
  • ESEEREV (NASA Earth Science Enterprise Education Review System) - self-explanatory
  • JESSE (Journal of Earth System Science Education) - self-explanatory
  • MY NASA DATA (Mentoring and inquirY using NASA Data on Atmospheric and earth science for Teachers and Amateurs) - self-explanatory

Cataloging best practices

Things to do

  • Use this field if making annotations for the DLESE Reviewed Collection (DRC). Such pathways must be approved by the DLESE Collections Accessioning Taskforce (email support@dlese.org).

Things to avoid

  • Do not use this field if making annotations that do not pertain to the DLESE Reviewed Collection.

Top

Person

xpath - /annotationRecord/annotation/contributors/contributor/person
Framework version - 1.0.00

Definition - information about a person, namely their name, affiliation and email address but may also include department and position
Obligation - choice
Minimum occurrences - 1 or 0
Maximum occurrences - 1
Child elements - nameTitle, nameFirst, nameMiddle, nameLast, instName, instDept, instPosition, email, emailAlt
Data types - complex
Domain - the child elements
Domain example - <nameLast>, <nameFirst>, <instName>

Notes

  • Person is part of a choice. That is, a child element of either organization or person is required as part of the contributor element.

Cataloging best practices

Things to do

  • Complete the required subfields of name - first, name - last, organization name - individual contributor and email - individual contributor.

Things to avoid

  • Do not include webmasters as contributors.

Top

Position - individual contributor

xpath - /annotationRecord/annotation/contributors/contributor/person/instPosition
Framework version - 1.0.00

Definition - a professional or functional position of a person within an organization
Obligation - optional
Minimum occurrences - 0
Maximum occurrences - 1
Data types - string
Domain - free text
Domain example - Outreach coordinator, Librarian
Other occurrences in framework - true

Notes

  • Other XPATH: /annotationRecord/annotation/contributors/contributor/organization/instPosition

Cataloging best practices

Things to do

  • Use a word or short phrase to identify the job position.
  • Capitalize first words (Outreach coordinator).
  • Spell out acronyms (e.g. WCM is Warning Coordination Meteorologist).

Things to avoid

  • Do not use the name of a person.

Examples

  • Outreach coordinator
  • Warning Coordination Meteorologist
  • DLESE (Digital Library for Earth System education) collections committee chair
  • Librarian
  • Instructional designer

Top

Position - organizational contributor

xpath - /annotationRecord/annotation/contributors/contributor/organization/instPosition
Framework version - 1.0.00

Definition - a professional or functional position within an organization
Obligation - optional
Minimum occurrences - 0
Maximum occurrences - 1
Data types - string
Domain - free text
Domain example - Outreach coordinator, Librarian

Notes

  • Other XPATH: /annotationRecord/annotation/contributors/contributor/person/instPosition

Cataloging best practices

Things to do

  • Use a word or short phrase to identify the job position.
  • Capitalize first words (Outreach coordinator).
  • Spell out acronyms (e.g. WCM is Warning Coordination Meteorologist).

Things to avoid

  • Do not use the name of a person.

Examples

  • Outreach coordinator
  • Warning Coordination Meteorologist
  • DLESE (Digital Library for Earth System education) collections committee chair
  • Librarian
  • Instructional designer

Top

Rating

xpath - /annotationRecord/annotation/content/rating
Framework version - 1.0.00

Definition - a specific judgment about a resource that is defined by a collection
Obligation - choice
Minimum occurrences - 1 or 0
Maximum occurrences - 1
Data types - string
Domain - controlled vocabulary
Domain example - One star, Two star

Controlled vocabulary information

  • Number of levels - 1
  • Level 1 is Rating - a specific judgment about a resource that is defined by a collection

Term and definitions

  • One star - definition is collection specific and provided by the collection builder
  • Two star - definition is collection specific and provided by the collection builder
  • Three star - definition is collection specific and provided by the collection builder
  • Four star - definition is collection specific and provided by the collection builder
  • Five star - definition is collection specific and provided by the collection builder

Cataloging best practices

Things to do

  • Use this field only if the collection has defined the meaning of the controlled vocabulary. See ratings use in annotations.
  • The term One star is always lower/worse than the term Five star.
  • Choose a single rating from the term list.
  • Use rating to indicate meaningful information like how a resource performs in terms of usability, content, pedagogy and relevance.

Top

Role

xpath - /annotationRecord/annotation/contributors/contributor/@role
Framework version - 1.0.00

Definition - the role of a person or organization in making the annotation
Obligation - required
Minimum occurrences - 1
Maximum occurrences - 1
Data types - string
Domain - controlled vocabulary
Domain example - Publisher, Student, Educator

Controlled vocabulary information

  • Number of levels - 1
  • Level 1 is Role - the role of a person or organization in making the annotation

Term and definitions

  • Author - a person or organization who creates content
  • College educator - a person with teaching responsibilities at the university level
  • Contact - a person or organization who can provide more information
  • Contributor - a person or organization who provides content or information but not as the primary author
  • Educator - a person or organization with primary teaching responsibilities
  • Elementary educator - a person with teaching responsibilities at the elementary level
  • Evaluator - a person or organization with primary evaluation responsibilities
  • High school educator - a person with teaching responsibilities at the secondary education level
  • Librarian - a person with expertise library management
  • Middle school educator - a person with teaching responsibilities at the middle school level
  • Publisher - an organization who makes content accessible
  • Scientist - a person with expertise in a specific area of science
  • Student - a student at any educational level

Cataloging best practices

Things to do

  • Choose a single role from the term list.

Top

Service

xpath - /annotationRecord/service
Framework version - 1.0.00

Definition - the organization responsible in providing the annotation and making the metadata record, namely a name, catalog record number and the metadata record creation date and if appropriate, pathway information
Obligation - required
Minimum occurrences - 1
Maximum occurrences - 1
Child elements - name, recordID, date, pathway
Data types - complex
Domain - the children elements are the domain
Domain example - <name>, <recordID>

Cataloging best practices

Things to do

  • Complete the required subfields of name, record ID and date.
  • If appropriate, complete the subfield of pathway.

Top

Share

xpath - /annotationRecord/annotation/contributors/contributor/@share
Framework version - 1.0.00

Definition - a boolean value that indicates whether a contributor's name, email address and organization is shared in systems and services
Obligation - optional
Minimum occurrences - 0
Maximum occurrences - 1
Data types - boolean
Domain - controlled vocabulary with an XML schema defined default value of false
Domain example - false

Notes

  • This field is an attribute of the contributor field.

Controlled vocabulary information

  • Number of levels - 1
  • Level 1 is Share - a boolean value that indicates whether a contributor's name, email address and organization is shared in systems and services

Term and definitions

  • true - yes, the name, email address and organization of the contributor can be shared or exposed in systems and services
  • false - no, the name, email address and organization of the contributor cannot be shared or exposed in systems and services

Cataloging best practices

Things to do

  • Choose True to indicate that it is okay to use a contributor's name, email address and organization in systems and services.
  • Choose False to indicate that it is not okay to use a contributor's name, email address and organization in systems and services.

Top

Status

xpath - /annotationRecord/annotation/status
Framework version - 1.0.00

Definition - an indication of the state of an annotation
Obligation - optional
Minimum occurrences - 0
Maximum occurrences - 1
Data types - string
Domain - controlled vocabulary
Domain example - Completed, In progress, Retired

Controlled vocabulary information

  • Number of levels - 1
  • Level 1 is Status - an indication of the state of an annotation, not the metadata record

Term and definitions

  • Completed - the annotation is complete
  • In progress - the annotation is not complete
  • Retired - the annotation is no longer valid

Cataloging best practices

Things to do

  • Use this field if a status needs to be associated with an annotation.
  • If a status needs to be assigned to an annotation, choose a status term.

Things to avoid

  • If no status information needs to be associated with an annotation, do not use this field. The assumption is the annotation is complete.

Top

Title

xpath - /annotationRecord/annotation/title
Framework version - 1.0.00

Definition - the name of the annotation
Obligation - optional
Minimum occurrences - 0
Maximum occurrences - 1
Data types - string
Domain - free text
Domain example - Teaching Tip for Down the Drain

Cataloging best practices

Things to do

  • Be sure to use title when the content of the annotation is on its own unique web page. The value of title should then be the title displayed on the web page and not in a browser's title bar. This applies when using the URL field.
  • If the content of the annotation is not on its own unique web page (i.e. the rating or description field is being used), an appropriate value of title is 'Annotation for X' where X is the title of the resource being annotated.
  • Make titles short and concise for easy reading.
  • If a title is long, edit if necessary.
  • Capitalize words of the title excluding prepositions, articles and pronouns.
  • If a title has an acronym, use the acronym.

Things to avoid

  • Avoid the use of subtitles.
  • Do not include subpage names in title. This makes title too long.
  • Do not include phrases like "by Joe Smith" in title.
  • Do not include phrases like "Welcome to the " in title.

Examples

  • A title for an annotation that is the content of an annotation: Teaching Tip for Down the Drain or Editor's Summary for Down the Drain.
  • A title for an annotation that is supportive or contextual material: How to Teach with Data: Describing and Analyzing Graphs.

No title for the resource being annotated? Do this:

  • If an appropriate title for the resource being annotated cannot be determined, title can be left blank or create a title to describe the overall content.

Want to use special characters like ©, é, ñ or ê? Do this:

  • Enter special characters and symbols using their entity references numbers. For the copyright symbol this means entering an ampersand symbol followed by the pound sign followed by the number 169 followed by a semicolon.

Top

Type

xpath - /annotationRecord/annotation/type
Framework version - 1.0.00

Definition - the kind of annotation
Obligation - required
Minimum occurrences - 1
Maximum occurrences - 1
Data types - string
Domain - controlled vocabulary
Domain example - Teaching tip, Review, Comment

Controlled vocabulary information

  • Number of levels - 1
  • Level 1 is Type - the kind of annotation

Term and definitions

  • Assessment strategy - information intended to help educators deploy effective strategies to assess learning
  • Bias - an indication that resource content may have: (1) factual (e.g. not just scientific) errors, (2) conflicts with generally accepted scientific thought, (3) a self-promoting emphasis or (4) a political, social or religious agenda
  • Challenging audience - information about the effectiveness of a resource with a specific audience
  • Comment - a remark, explanation, advice, opinion, attitude, fact, proposed change, question or additional resource information
  • Editor's summary - a summary of evaluative information (qualitative or quantitative) that may describe the strengths, weaknesses, pedagogical effectiveness, best uses for or general characteristics of a resource
  • Educational standard - an indication that the resource meets, supports or aligns with an educational standard, that is, a level of achievement determined by a professional group to which learners are expected to aspire too
  • Example - a description or link to another resource that illustrates the resource content in a demonstrative way
  • Misconception - information intended to help educators anticipate, detect and overcome common student misconceptions
  • Quantitative information - numerical information about a resource
  • Review - a formal or informal evaluation of a resource
  • See also - a reference to another resource
  • Skill - information intended to help educators foster a student skill needed for optimal resource use
  • Teaching tip - information for using or modifying the resource within teaching or learning environments

Cataloging best practices

Things to do

  • Choose an annotation type term.
  • If multiple annotations need to be associated with a resource, make multiple annotation metadata records.
  • When providing a rating, use the annotation type of Review.

Top

Url - annotation content

xpath - /annotationRecord/annotation/content/url
Framework version - 1.0.00

Definition - a web page that augments user interaction with the resource being annotated
Obligation - choice
Minimum occurrences - 1 or 0
Maximum occurrences - 1
Data types - string
Domain - free text
Domain example - http://url.tothe.annotation/content.html
Other occurrences in framework - true

Notes

  • Other XPATH: /annotationRecord/annotation/contributors/contributor/organization/url

Cataloging best practices

Things to do

  • Use to present the content of the annotation.
  • Use to provide contextual or supportive information for interacting with or using the resource.
  • Begin URLs with the proper Internet scheme like http://
  • URLs with ampersands, percent 20's, equal signs, underscores and question marks are okay.
  • Enter a URL which links directly to the annotation.

Examples

Top

Url - organization

xpath - /annotationRecord/annotation/contributors/contributor/organization/url
Framework version - 1.0.00

Definition - a web page of an organization, mostly likely the home page
Obligation - optional
Minimum occurrences - 0
Maximum occurrences - 1
Data types - string
Domain - free text
Domain example - http://url.tothe.organization/home.html
Other occurrences in framework - true

Notes

  • Other XPATH: /annotationRecord/annotation/content/url

Cataloging best practices

Things to do

  • Begin URLs with the proper Internet scheme like http://
  • URLs with ampersands, percent 20's, equal signs, underscores and question marks are okay.
  • Enter the URL which links directly to the annotation.

Top

Last updated: 2006-09-21
Maintained by: Katy Ginger (support@dlese.org), DLESE Metadata