Metadata Collections & QA

Documentation: Annotation framework version 0.1.01

  • Graphical overview, content examples, cataloging best practices
  • A description of each metadata field including occurrences, obligation, data types, terms and definitions

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

Annotation record Content Context
Contributor Contributor list Date - contribution
Date - created Date - item Date - modified
Date - service Date - status Department - (when describing a person)
Department - (when describing an organization) Description Email - (when describing a person)
Email - (when describing an organization) ID - item - resource being annotated ID - record - library catalog number
Item Name - first Name - last
Name - middle Name - service Name - title - contributor
Organization Organization name - (when describing a person) Organization name - (when describing an organization)
Pathway Person Position - (when describing an organization)
Role Status Status info
Title Type Url - annotation content
Url - organization

 

Top

Annotation record

xpath - /annotationRecord/service
Framework version - 0.1.01

Definition - information about the annotation service and metadata record, namely the service name, catalog record number and the metadata record creation date
Obligation - required
Minimum occurrences - 1
Maximum occurrences - 1
Child elements - name, recordID, date
Data types - complex
Domain - the children elements are the domain
Domain example - <name>, <recordID>

Cataloging best practices

Things to do

  • Complete the subfields of name, record ID and date. These are required fields in order to make a complete record.

Top

Content

xpath - /annotationRecord/item/content
Framework version - 0.1.01

Definition - the content of or a pointer to the annotation
Obligation - required
Minimum occurrences - 1
Maximum occurrences - 1
Child elements - url, description
Data types - complex
Domain - the children elements are the domain
Domain example - <url>, <description>

Cataloging best practices

Things to do

  • Complete the subfield of url or description. One of these fields is required in order to make a complete record.

Top

Context

xpath - /annotationRecord/item/context
Framework version - 0.1.01

Definition - a page within a resource 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.

Things to avoid

  • Do not use this field if the page being referenced is the same as the resource being annotated.

Top

Contributor

xpath - /annotationRecord/item/contributors/contributor
Framework version - 0.1.01

Definition - the person or organization making the annotation
Obligation - required metadata if parent tag is present
Minimum occurrences - 0
Maximum occurrences - unbounded
Attributes - role, 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 or publishers.

Cataloging best practices

Things to do

  • date
  • Complete either the person subfield or the organization subfield.

Things to avoid

  • Do not include webmasters as contributors.

Top

Contributor list

xpath - /annotationRecord/item/contributors
Framework version - 0.1.01

Definition - a list of organizations or persons responsible for making the annotation
Obligation - optional
Minimum occurrences - 0
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 or publishers.

Cataloging best practices

Things to do

  • Complete the contributor subfield.

Top

Date - contribution

xpath - /annotationRecord/item/contributors/contributor/@date
Framework version - 0.1.01

Definition - the date of a contributor's contribution
Obligation - required metadata if parent tag is present
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 - 0.1.01

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 - item

xpath - /annotationRecord/item/date
Framework version - 0.1.01

Definition - the date of the annotation
Obligation - required
Minimum occurrences - 1
Maximum occurrences - 1
Data types - date, gYear, gYearMonth
Domain - numerical date format
Domain example - 2004-10-15, 2004-10, 2004
Other occurrences in framework - true

Notes

  • The field also occurs with the following XPATH: /annotationRecord/service/date

Cataloging best practices

Things to do

  • Enter a date to signify when an annotation is made.
  • 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: 2004.
  • Year and month: 2004-12.
  • Year, month and day: 2004-12-27.

Top

Date - modified

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

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 - 0.1.01

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
Other occurrences in framework - true

Notes

  • The field also occurs with the following XPATH: /annotationRecord/item/date

Cataloging best practices

Things to do

  • Complete the subfield of created.

Top

Date - status

xpath - /annotationRecord/item/statusOf/@date
Framework version - 0.1.01

Definition - the date of the annotation status assignment
Obligation - required metadata if parent tag is present
Minimum occurrences - 1
Maximum occurrences - 1
Data types - date
Domain - numerical date format
Domain example - 2004-07-04

Cataloging best practices

Things to do

  • Enter a date to signify whenever an annotation status is assigned.
  • 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

Department - (when describing a person)

xpath - /annotationRecord/item/contributors/contributor/person/instDept
Framework version - 0.1.01

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

  • The field also occurs with the following XPATH: /annotationRecord/item/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 - (when describing an organization)

xpath - /annotationRecord/item/contributors/contributor/organization/instDept
Framework version - 0.1.01

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

  • The field also occurs with the following XPATH: /annotationRecord/item/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/item/content/description
Framework version - 0.1.01

Definition - the full or partial content of the annotation in the form of textual information
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 the name of persons or organizations making the annotation in the contributors field.
  • To use special characters like ampersands, copyright symbols, double quotes, single quotes, tilde, etc. read the want to use special characters section.

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.

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 - (when describing a person)

xpath - /annotationRecord/item/contributors/contributor/person/emailPrimary
Framework version - 0.1.01

Definition - the primary email address of a person
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 - (when describing an organization)

xpath - /annotationRecord/item/contributors/contributor/organization/instEmail
Framework version - 0.1.01

Definition - the contact email address of an organization
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

ID - item - resource being annotated

xpath - /annotationRecord/item/itemID
Framework version - 0.1.01

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

  • Use the DLESE website at dlese.org to determine the catalog id number of the resource to be annotated. Catalog id numbers are found on the full description pages.

Things to avoid

  • Do not use web address like URLs.

Top

ID - record - library catalog number

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

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 numbers are being generated automatically.

Things to avoid

  • Do not use the prefix of DLESE. It is already in use.
  • If using a DLESE cataloging tool, do not try to change this number.

Top

Item

xpath - /annotationRecord/item
Framework version - 0.1.01

Definition - information about the resource being annotated that includes its type, content, date and possibly status, contributors and title
Obligation - required
Minimum occurrences - 1
Maximum occurrences - 1
Child elements - itemID, title, pathway, type, date, content, context, contributors, statusOf
Data types - complex
Domain - the children elements are the domain
Domain example - <content>, <type>

Cataloging best practices

Things to do

  • Complete the subfields of item ID, type, date and content. These are required fields in order to make a complete record.

Top

Name - first

xpath - /annotationRecord/item/contributors/contributor/person/nameFirst
Framework version - 0.1.01

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/item/contributors/contributor/person/nameLast
Framework version - 0.1.01

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 the 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/item/contributors/contributor/person/nameMiddle
Framework version - 0.1.01

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 - 0.1.01

Definition - the name of the annotation service creating the metadata record
Obligation - required
Minimum occurrences - 1
Maximum occurrences - 1
Data types - string
Domain - free text
Domain example - Community Review System (CRS)

Cataloging best practices

Things to do

  • Spell out acronyms.

Things to avoid

  • Do not use the name of an individual person.

Examples

  • Community Review System (CRS)

Top

Name - title - contributor

xpath - /annotationRecord/item/contributors/contributor/person/nameTitle
Framework version - 0.1.01

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/item/contributors/contributor/organization
Framework version - 0.1.01

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, instUrl, instEmail
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.
  • The required fields for organization are instName (Organization name - (when describing an organization)).

Cataloging best practices

Things to do

  • Complete at least the subfield of name.

Top

Organization name - (when describing a person)

xpath - /annotationRecord/item/contributors/contributor/person/instName
Framework version - 0.1.01

Definition - the formal name of an organization to which a person is affiliated
Obligation - optional
Minimum occurrences - 0
Maximum occurrences - 1
Data types - string
Domain - free text
Domain example - American Geophysical Union (AGU), Rolling Meadows High School, Digital Library for Earth System Education (DLESE) Program Center (DPC), The Weather Channel
Other occurrences in framework - true

Notes

  • The field also occurs with the following XPATH: /annotationRecord/item/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 field instead.

Examples

  • American Geophysical Union (AGU)
  • Digital Library for Earth System Education (DLESE)
  • Digital Library for Earth System Education (DLESE) Program Center (DPC)
  • Accuweather
  • Rolling Meadows High School
  • The Weather Channel
  • earthscience.com

Top

Organization name - (when describing an organization)

xpath - /annotationRecord/item/contributors/contributor/organization/instName
Framework version - 0.1.01

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, Digital Library for Earth System Education (DLESE) Program Center (DPC), The Weather Channel
Other occurrences in framework - true

Notes

  • The field also occurs with the following XPATH: /annotationRecord/item/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 field instead.

Examples

  • American Geophysical Union (AGU)
  • Digital Library for Earth System Education (DLESE)
  • Digital Library for Earth System Education (DLESE) Program Center (DPC)
  • Accuweather
  • Rolling Meadows High School
  • The Weather Channel
  • earthscience.com

Top

Pathway

xpath - /annotationRecord/item/pathway
Framework version - 0.1.01

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

Cataloging best practices

Things to do

  • Us this field if making annotations for the DLESE Reviewed Collection (DRC). Such pathways must be approved by the Collections Accessioning Taskforce.

Things to avoid

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

Top

Person

xpath - /annotationRecord/item/contributors/contributor/person
Framework version - 0.1.01

Definition - information about a person, namely their name but may also include affiliation and email address
Obligation - choice
Minimum occurrences - 1 or 0
Maximum occurrences - 1
Child elements - nameTitle, nameFirst, nameMiddle, nameLast, instName, instPosition, emailPrimary
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.
  • The required fields for person are nameFirst (Name -first), nameLast (Name - last), instName (Organization name - (when describing a person)), email (Email - (when describing a person)).

Cataloging best practices

Things to do

  • Complete at least the subfields of first name, last name.

Things to avoid

  • Do not include webmasters as contributors.

Top

Position - (when describing an organization)

xpath - /annotationRecord/item/contributors/contributor/organization/instPosition
Framework version - 0.1.01

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

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

Role

xpath - /annotationRecord/item/contributors/contributor/@role
Framework version - 0.1.01

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

Controlled vocabulary information

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

Term and definitions

  • Author - a person or organization who creates content
  • 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
  • Editor - a person or organization who performs quality control
  • Educator - a person or organization with primary teaching responsibilities
  • Evaluator - a person or organization with primary evaluation responsibilities
  • Publisher - an organization who makes content accessible

Cataloging best practices

Things to do

  • Choose a rating from the term list.

Top

Status

xpath - /annotationRecord/item/statusOf/@status
Framework version - 0.1.01

Definition - an indication of the completeness of an annotation
Obligation - required metadata if parent tag is present
Minimum occurrences - 1
Maximum occurrences - 1
Data types - string
Domain - controlled vocabulary
Domain example - Text annotation completed

Controlled vocabulary information

  • Number of levels - 1
  • Level 1 is Status - an indication of the completeness of an annotation

Term and definitions

  • Audio annotation completed - the annotation is audio in nature and is complete
  • Audio annotation in progress - the annotation is audio in nature and is not complete
  • Graphical annotation completed - the annotation is a graphic and is complete
  • Graphical annotation in progress - the annotation is a graphic and is not complete
  • Text annotation completed - the annotation is textual in nature and is complete
  • Text annotation in progress - the annotation is textual in nature and is not complete

Cataloging best practices

Things to do

  • Choose a status term.

Top

Status info

xpath - /annotationRecord/item/statusOf
Framework version - 0.1.01

Definition - the status of an annotation and the date the status is assigned
Obligation - optional
Minimum occurrences - 0
Maximum occurrences - 1
Attributes - status, date
Data types - complex
Domain - the attribute elements are the domain
Domain example - no example provided

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, complete the subfields of status and date.

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/item/title
Framework version - 0.1.01

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

  • When annotating a resource with an existing metadata record, if possible, use the title from the metadata record as part of annotation title.
  • Titles displayed on screen to the user are preferred over titles in a browser's title bar.
  • 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

  • If a metadata record exists with the title of Down the Drain, then the title of an annotation may be: Teaching Tip for Down the Drain or Editor's Summary for Down the Drain.

No title? Do this:

  • If an appropriate title is not displayed on screen for the user, 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/item/type
Framework version - 0.1.01

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

  • Advice - a suggestion for working with the resource
  • Annotation - additional information about a resource expressed in any manner
  • Average scores of aggregated indices - a numerical representation of quantitative information about a resource
  • Bias - an indication that resource content may have any of the following: (1) factual (e.g. not just scientific) errors, (2) be in conflict with generally accepted scientific thought, (3) seems self-promoting or (4) seems to have a political, social or religious agenda
  • Change - an annotation that documents or proposes change to a source document
  • Comment - remarks about a resource that express opinions or attitudes
  • Editor's summary - an annotation that results from the summary of several pieces of evaluation information 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
  • Explanation - information for understanding the resource, especially within its context of use but does not generally express opinions or attitudes
  • Information on challenging teaching and learning situations - information for using the resource within challenging or non-typical teaching or learning environments
  • Question - an indication of any of the following: (1) a request for further information, (2) an asking of why something was done or (3) the raising of a point of discussion
  • Review - a formal or informal evaluation of a resource
  • See also - a reference to another resource
  • Teaching tip - information for using the resource within a certain teaching or learning environment but generally not challenging or non-typical 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.

Top

Url - annotation content

xpath - /annotationRecord/item/content/url
Framework version - 0.1.01

Definition - a web page that presents the content of the annotation
Obligation - choice
Minimum occurrences - 1 or 0
Maximum occurrences - 1
Data types - string
Domain - free text
Domain example - http://url.tothe.annotation/content.html

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 fine.
  • Enter the URL which links directly to the annotation.

Things to avoid

  • Generally, avoid URLs with spaces.

Top

Url - organization

xpath - /annotationRecord/item/contributors/contributor/organization/instUrl
Framework version - 0.1.01

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

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 fine.
  • Enter the URL which links directly to the annotation.

Things to avoid

  • Generally, avoid URLs with spaces.

Top

Last updated: 2006-08-09