DocBook Publishers: The Definitive Guide  (Version 1.2.1 for DocBook 5.1)

Chapter 2. Additions to Core DocBook

The DocBook Publishers schema includes the following elements above and beyond those currently provided by the core DocBook standard. These are considered "official customizations".

2.1. Explicit support for Dublin Core metadata

While DocBook already includes many of the elements that are defined by the Dublin Core, it is not inherently interoperable with DC metadata. The Publisher's SC has decided to formally adopt Dublin Core metadata (issued 2008-01-14) as a formal metadata model for info elements. The Publishers schema will continue to support the base DocBook info metadata, but will allow Dublin Core elements as an alternative for capturing metadata in this widely adopted schema. In info, authors will be allowed to use either the standard DocBook elements or Dublin Core elements, and info may not contain a mix of the two element sets.

As the Dublin Core standard does not provide a RelaxNG or RelaxNG Compact version of their schema, the Publishers SC has endeavored to create Dublin Core in RNC format. The Publishers SC plans to contribute the dcterms.rnc, and dcmitypes.rnc back to the Dublin Core standard.

The following Dublin Core elements from the http://purl.org/dc/terms/ namespace have been defined and included in the Publishers schema:

title

A name given to the resource.

creator

An entity primarily responsible for making the resource. Examples of a Creator include a person, an organization, or a service. Typically, the name of a Creator should be used to indicate the entity.

subject

The topic of the resource. Typically, the subject will be represented using keywords, key phrases, or classification codes. Recommended best practice is to use a controlled vocabulary. To describe the spatial or temporal topic of the resource, use the Coverage element.

description

An account of the resource. Description may include but is not limited to: an abstract, a table of contents, a graphical representation, or a free-text account of the resource.

publisher

An entity responsible for making the resource available. Examples of a Publisher include a person, an organization, or a service. Typically, the name of a Publisher should be used to indicate the entity.

contributor

An entity responsible for making contributions to the resource. Examples of a Contributor include a person, an organization, or a service. Typically, the name of a Contributor should be used to indicate the entity.

date

A point or period of time associated with an event in the lifecycle of the resource. Date may be used to express temporal information at any level of granularity. Recommended best practice is to use an encoding scheme, such as the W3CDTF profile of ISO 8601 [W3CDTF].

type

The nature or genre of the resource. Recommended best practice is to use a controlled vocabulary such as the DCMI Type Vocabulary [DCMITYPE]. To describe the file format, physical medium, or dimensions of the resource, use the Format element.

format

The file format, physical medium, or dimensions of the resource. Examples of dimensions include size and duration. Recommended best practice is to use a controlled vocabulary such as the list of Internet Media Types [MIME].

identifier

An unambiguous reference to the resource within a given context. Recommended best practice is to identify the resource by means of a string conforming to a formal identification system.

source

A related resource from which the described resource is derived. The described resource may be derived from the related resource in whole or in part. Recommended best practice is to identify the related resource by means of a string conforming to a formal identification system.

language

A language of the resource. Recommended best practice is to use a controlled vocabulary such as RFC 4646 [RFC4646].

relation

A related resource. Recommended best practice is to identify the related resource by means of a string conforming to a formal identification system.

coverage

The spatial or temporal topic of the resource, the spatial applicability of the resource, or the jurisdiction under which the resource is relevant. Spatial topic and spatial applicability may be a named place or a location specified by its geographic coordinates. Temporal topic may be a named period, date, or date range. A jurisdiction may be a named administrative entity or a geographic place to which the resource applies. Recommended best practice is to use a controlled vocabulary such as the Thesaurus of Geographic Names [TGN]. Where appropriate, named places or time periods can be used in preference to numeric identifiers such as sets of coordinates or date ranges.

rights

Information about rights held in and over the resource. Typically, rights information includes a statement about various property rights associated with the resource, including intellectual property rights.

alternative

An alternative name for the resource. The distinction between titles and alternative titles is application-specific.

tableOfContents

A list of subunits of the resource.

abstract

A summary of the resource.

created

Date of creation of the resource.

valid

Date (often a range) of validity of a resource.

available

Date (often a range) that the resource became or will become available.

issued

Date of formal issuance (e.g., publication) of the resource.

modified

Date on which the resource was changed.

dateAccepted

Date of acceptance of the resource. Examples of resources to which a Date Accepted may be relevant are a thesis (accepted by a university department) or an article (accepted by a journal).

dateCopyrighted

Date of copyright.

dateSubmitted

Date of submission of the resource. Examples of resources to which a Date Submitted may be relevant are a thesis (submitted to a university department) or an article (submitted to a journal).

extent

The size or duration of the resource.

medium

The material or physical carrier of the resource.

isVersionOf

A related resource of which the described resource is a version, edition, or adaptation. Changes in version imply substantive changes in content rather than differences in format.

hasVersion

A related resource that is a version, edition, or adaptation of the described resource.

isReplacedBy

A related resource that supplants, displaces, or supersedes the described resource.

replaces

A related resource that is supplanted, displaced, or superseded by the described resource.

isRequiredBy

A related resource that requires the described resource to support its function, delivery, or coherence.

requires

A related resource that is required by the described resource to support its function, delivery, or coherence.

isPartOf

A related resource in which the described resource is physically or logically included.

hasPart

A related resource that is included either physically or logically in the described resource.

isReferencedBy

A related resource that references, cites, or otherwise points to the described resource.

references

A related resource that is referenced, cited, or otherwise pointed to by the described resource.

isFormatOf

A related resource that is substantially the same as the described resource, but in another format.

hasFormat

A related resource that is substantially the same as the pre-existing described resource, but in another format.

conformsTo

An established standard to which the described resource conforms.

spatial

Spatial characteristics of the resource.

temporal

Temporal characteristics of the resource.

audience

A class of entity for whom the resource is intended or useful.

accrualMethod

The method by which items are added to a collection.

accrualPeriodicity

The frequency with which items are added to a collection.

accrualPolicy

The policy governing the addition of items to a collection.

instructionalMethod

A process, used to engender knowledge, attitudes and skills, that the described resource is designed to support. Instructional Method will typically include ways of presenting instructional materials or conducting instructional activities, patterns of learner-to-learner and learner-to-instructor interactions, and mechanisms by which group and individual levels of learning are measured. Instructional methods include all aspects of the instruction and learning processes from planning and implementation through evaluation and feedback.

provenance

A statement of any changes in ownership and custody of the resource since its creation that are significant for its authenticity, integrity, and interpretation. The statement may include a description of any changes successive custodians made to the resource.

rightsHolder

A person or organization owning or managing rights over the resource.

mediator

An entity that mediates access to the resource and for whom the resource is intended or useful. In an educational context, a mediator might be a parent, teacher, teaching assistant, or care-giver.

educationLevel

A class of entity, defined in terms of progression through an educational or training context, for which the described resource is intended.

accessRights

Information about who can access the resource or an indication of its security status. Access Rights may include information regarding access or restrictions based on privacy, security, or other policies.

license

A legal document giving official permission to do something with the resource.

bibliographicCitation

A bibliographic reference for the resource. Recommended practice is to include sufficient bibliographic detail to identify the resource as unambiguously as possible.

The following table provides a comparison of the Dublin Core metadata elements and equivalent elements from core DocBook. As the Publishers schema provides for an "either-or" approach to metadata, authors will have to provide metadata in either Dublin Core or in DocBook, but not a mix of the two. In some cases, additional role attributes or other logic may be required to determine the best mapping for core DocBook elements.

Table 2.1. Comparison of Dublin Core and core DocBook metadata elements
Dublin Core elementCore DocBook element
titletitle
creatorauthor,editor,othercredit[a]
subjectkeywordset,subjectset
descriptionabstract
publisherpublisher,publishername
contributorauthor,editor,othercredit,collab
datedate,pubdate
typeDerived from document element and status attribute
formatbibliomisc with a role value of “format
identifierbiblioid
sourcebibliosource
languagelang or xml:lang attribute
relationbibliorelation
coveragebibliocoverage
rightscopyright,legalnotice
alternativetitleabbrev
tableOfContentsbibliomisc with a role value of “toc
abstractabstract
createddate with a role value of “created
validdate with a role value of “valid
availabledate with a role value of “available
issuedpubdate
modifieddate with a role value of “modified”,revhistory/revision
dateAccepteddate with a role value of “accepted
dateCopyrightedcopyright/year
dateSubmitteddate with a role value of “submitted
extentreleaseinfo
mediumbibliomisc with a role value of “medium
isVersionOfbibliorelation with a type value of “isversionof
hasVersionbibliorelation with a type value of “hasversion
isReplacedBybibliorelation with a type value of “isreplacedby
replacesbibliorelation with a type value of “replaces
isRequriedBybibliorelation with a type value of “isrequiredby
requiresbibliorelation with a type value of “requires
isPartOfbibliorelation with a type value of “ispartof
hasPartbibliorelation with a type value of “haspart
isReferencedBybibliorelation with a type value of “isreferencedby
referencesbibliorelation with a type value of “references
isFormatOfbibliorelation with a type value of “isformatof
hasFormatbibliorelation with a type value of “hasformat
conformsToversion attribute
spatialbibliocoverage with a spatial attribute.
temporalbibliocoverage with a temporal attribute.
audiencebibliomisc with a role value of “audience
accrualMethodbibliomisc with a role value of “accrualMethod
accrualPeriodicitybibliomisc with a role value of “accrualPeriodicity
instructionalMethodbibliomisc with a role value of “instructionalMethod
provenancecopyright/holder,publisher/publishername
rightsHoldercopyright/holder
mediatorbibliomisc with a role value of “mediator
educationLevelbibliomisc with a role value of “educationLevel
accessRightslegalnotice
licenselegalnotice
bibliographicCitationbibliomset,bibliomixed

[a] 

Best practice would be to only use author for creator. Use contributor for other roles.

2.1.1. New Element Definitions

The following elements have been added to support the needs of publishers:

speaker

Designates a person who is giving a speech or lecture.

line

A line of dialogue or other form of communication.

linegroup

A grouping of lines in dialogue or other form of communication.

poetry

A container for poetry.

dialogue

A container for speeches and other forms of communication involving dialogue.

drama

A container for plays and other forms of dramatic presentation.

Example 2.1. Example Drama

The following provides an example usage of the newly added elements:

<drama >
  <linegroup>
    <speaker>HAMLET</speaker>
    <line>To be, or not to be: that is the 
      question:</line>
    <line>Whether 'tis nobler in the mind to 
      suffer</line>
    <line>The slings and arrows of outrageous 
      fortune,</line>
    <line>Or to take arms against a sea of 
      troubles,</line>
    <line>And by opposing end them?
      </line>
  </linegroup>
</drama>
Example 2.2. Example Dialogue

The following provides an example usage of the newly added elements:

<dialogue >
  <linegroup>
    <speaker>President John F. 
      Kennedy</speaker>
    <line>And so, my fellow Americans, ask 
      not what your country can do for you; ask what you can 
      do for your country.</line>
    <line>My fellow citizens of the world, 
      ask not what America will do for you, but what together 
      we can do for the freedom of man.</line>
    <line>Finally, whether you are citizens 
      of America or citizens of the world, ask of us here the 
      same high standards of strength and sacrifice which we 
      ask of you. With a good conscience our only sure reward, 
      with history the final judge of our deeds, let us go 
      forth to lead the land we love, asking His blessing and 
      His help, but knowing that here on earth God's work must 
      truly be our own.</line>
  </linegroup>
</dialogue>
Example 2.3. Example Poetry

The following provides an example usage of the newly added elements:

<poetry>
  <title>Auld Lang Syne</title>
  <info>
    <creator xmlns="http://purl.org/dc/terms/">Robert 
      Burns</creator>
  </info>
  <linegroup>
    <line>Should auld acquaintance be 
      forgot,</line>
    <line>And never brought to mind?</line>
    <line>Should auld acquaintance be forgot,</line>
    <line>And auld lang syne?</line>
  </linegroup>                
  <linegroup>
    <line>For auld lang syne, my dear,</line>
    <line>For auld lang syne,</line>
    <line>We'll tak a cup o' kindness yet,</line>
    <line>For auld lang syne.</line>
  </linegroup>
</poetry>