the docbook publishers schema - oasis be used only to refer to the organization and its official...

The DocBook Publishers SchemaEdited by Scott Hudson

Scott HudsonFlatironsFlatirons Solutions Corporation

<[email protected]>

$Id: docbook.xml 7996 2008-04-09 19:40:26Z nwalsh $

wd

http://docs.oasis-open.org/docbook/specs

Copyright © 2008 The Organization for the Advancement of Structured Information Standards [OASIS]. AllRights Reserved.

This is a Committee Draft. It was approved by the OASIS DocBook Publishers subcommittee, butit does not necessarily represent the consensus of the OASIS DocBook Technical Committee.

Please send comments on this specification to the<[email protected]> list. To subscribe, please use theOASIS Subscription Manager.

The errata page for this specification is at http://docs.oasis-open.org/docbook/specs/publishers-er-rata.html.

Copyright © OASIS® 2008. All Rights Reserved.

All capitalized terms in the following text have the meanings assigned to them in the OASIS Intel-lectual Property Rights Policy (the "OASIS IPR Policy"). The full Policy may be found at theOASIS website.

This document and translations of it may be copied and furnished to others, and derivative worksthat comment on or otherwise explain it or assist in its implementation may be prepared, copied,published, and distributed, in whole or in part, without restriction of any kind, provided that theabove copyright notice and this section are included on all such copies and derivative works. However,this document itself may not be modified in any way, including by removing the copyright noticeor references to OASIS, except as needed for the purpose of developing any document or deliverableproduced by an OASIS Technical Committee (in which case the rules applicable to copyrights, asset forth in the OASIS IPR Policy, must be followed) or as required to translate it into languagesother than English.

The limited permissions granted above are perpetual and will not be revoked by OASIS or its suc-cessors or assigns.

This document and the information contained herein is provided on an "AS IS" basis and OASISDISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITEDTO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT IN-FRINGE ANY OWNERSHIP RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTAB-ILITY OR FITNESS FOR A PARTICULAR PURPOSE.

OASIS requests that any OASIS Party or any other party that believes it has patent claims that wouldnecessarily be infringed by implementations of this OASIS Committee Specification or OASISStandard, to notify OASIS TC Administrator and provide an indication of its willingness to grant

1

http://lists.oasis-open.org/ob/adm.pl

http://docs.oasis-open.org/docbook/specs/publishers-errata.html

http://docs.oasis-open.org/docbook/specs/publishers-errata.html

patent licenses to such patent claims in a manner consistent with the IPR Mode of the OASIS Tech-nical Committee that produced this specification.

OASIS invites any party to contact the OASIS TC Administrator if it is aware of a claim of ownershipof any patent claims that would necessarily be infringed by implementations of this specification bya patent holder that is not willing to provide a license to such patent claims in a manner consistentwith the IPR Mode of the OASIS Technical Committee that produced this specification. OASIS mayinclude such claims on its website, but disclaims any obligation to do so.

OASIS takes no position regarding the validity or scope of any intellectual property or other rightsthat might be claimed to pertain to the implementation or use of the technology described in thisdocument or the extent to which any license under such rights might or might not be available; neitherdoes it represent that it has made any effort to identify any such rights. Information on OASIS' pro-cedures with respect to rights in any document or deliverable produced by an OASIS TechnicalCommittee can be found on the OASIS website. Copies of claims of rights made available for pub-lication and any assurances of licenses to be made available, or the result of an attempt made to obtaina general license or permission for the use of such proprietary rights by implementers or users ofthis OASIS Committee Specification or OASIS Standard, can be obtained from the OASIS TC Ad-ministrator. OASIS makes no representation that any information or list of intellectual property rightswill at any time be complete, or that any claims in such list are, in fact, Essential Claims.

The name "OASIS" is a trademark of OASIS, the owner and developer of this specification, andshould be used only to refer to the organization and its official outputs. OASIS welcomes referenceto, and implementation and use of, specifications, while reserving the right to enforce its marksagainst misleading uses. Please see http://www.oasis-open.org/who/trademark.php for above guidance.

Published 2008-06-05

Abstract

For more than a decade, DocBook has provided a structured markup vocabulary for hardware andsoftware documentation. DocBook is now widely used in both commercial and Open Source envir-onments. DocBook has a very broad element set, and applies to much more than just technical doc-umentation. The DocBook TC is engaged in evolving the suite of DocBook specifications. Thecommunity benefits from having a standard, open, interchangeable vocabulary in which to writestructured content. DocBook has been, and will continue to be, designed to satisfy this requirement.

The OASIS DocBook SubCommittee for Publishers is chartered to develop and maintain officialvariants of DocBook in support of the publishing industry. Specifically, the subcommittee will focuson schema and stylesheet customizations to support: periodicals as regularly published technicalnotes or journals, book publishing (such as business, legal, medical, and other non-technical domains),educational textbooks and other document types as appropriate for this industry.

The DocBook Publishers Schema is based on DocBook 5.0, and delivered in the normative RelaxNGSchema format.

Table of ContentsIntroduction ........................................................................................................................ 3

Terminology ............................................................................................................... 3Normative References .................................................................................................. 3Non-Normative References ............................................................................................ 4

The DocBook Publshers RELAX NG Schema ........................................................................... 4

2

The DocBook Publishers Schema

http://www.oasis-open.org/who/trademark.php

Explicit support for Dublin Core metadata ................................................................................ 4New Element Definitions ...................................................................................................... 6Re-Defined DocBook Content Models ..................................................................................... 6Included DocBook Element Definitions ................................................................................... 8Excluded DocBook Element Definitions ................................................................................. 18Attribute Definitions ........................................................................................................... 25A. Acknowledgements ........................................................................................................ 25B. Revision History ............................................................................................................ 26

IntroductionFor more than a decade, DocBook has provided a structured markup vocabulary for hardware and softwaredocumentation. DocBook is now widely used in both commercial and Open Source environments. DocBookhas a very broad element set, and applies to much more than just technical documentation. The DocBookTC is engaged in evolving the suite of DocBook specifications. The community benefits from having astandard, open, interchangeable vocabulary in which to write structured content. DocBook has been, andwill continue to be, designed to satisfy this requirement.

The OASIS DocBook SubCommittee for Publishers is chartered to develop and maintain official variantsof DocBook in support of the publishing industry. Specifically, the subcommittee will focus on schemaand stylesheet customizations to support: periodicals as regularly published technical notes or journals,book publishing (such as business, legal, medical, and other non-technical domains), educational textbooksand other document types as appropriate for this industry.

The DocBook Publishers subcommittee maintains the DocBook Publishers schema. Based on DocBookV5.0, the DocBook Publishers schema is normatively available as a [RELAX NG] Schema (with someadditional Schematron assertions).

The DocBook Technical Committee welcomes bug reports and requests for enhancement (RFEs) from theuser community. The current list of outstanding requests is available through the SourceForge tracker in-terface. This is also the preferred mechanism for submitting new requests.

TerminologyThe key words must, must not, required, shall, shall not, should, should not, recommended, may, and op-tional in this Committee Draft are to be interpreted as described in [RFC 2119]. Note that for reasons ofstyle, these words are not capitalized in this document.

Normative References

[RELAX NG] James Clark, editor. RELAX NG Specification (Committee Specification). OASIS. 2001.

[XML] Tim Bray, Jean Paoli, C. M. Sperberg-McQueen, et. al., editors. Extensible Markup Language (XML) 1.0(Fourth Edition). World Wide Web Consortium, 16 August 2006.

[XLink11] Steven DeRose, Eve Maler, David Orchard, Norman Walsh, editors. XML Linking Language (XLink) Version1.1. World Wide Web Consortium, 2005.

[RFC 2119] IETF (Internet Engineering Task Force). RFC 2119: Key words for use in RFCs to Indicate RequirementLevels. S. Bradner. 1997.

[RFC 3023] IETF (Internet Engineering Task Force). RFC 3023: XML Media Types. M. Murata, S. St. Laurent, D.Kohn. 2001.

3


mailto:[email protected]

http://sourceforge.net/

http://sourceforge.net/tracker/?atid=1037852&group_id=21935&func=browse

http://www.oasis-open.org/committees/relax-ng/spec-20010811.html

http://www.w3.org/TR/REC-xml

http://www.w3.org/TR/REC-xml

http://www.w3.org/TR/xlink11

http://www.w3.org/TR/xlink11

http://www.ietf.org/rfc/rfc2119.txt



[DocBook: TDG5] Norman Walsh and Leonard Meullner. DocBook 5.0: The Definitive Guide.

Non-Normative References

[SGML] JTC 1, SC 34. ISO 8879:1986 Information processing -- Text and office systems -- Standard GeneralizedMarkup Language (SGML). 1986.

[W3C XML Schema] Henry S. Thompson, David Beech, Murray Maloney, et. al., editors. XML Schema Part 1:Structures. World Wide Web Consortium, 2000.

[W3C XML Datatypes] Paul V. Biron and Ashok Malhotra, editors. XML Schema Part 2: Datatypes. World WideWeb Consortium, 2000.

[Schematron] Rick Jelliffe, editor. The Schematron Assertion Language 1.5. Rick Jelliffe and Acedemia Sinica Com-puting Centre. 2001, 2001.

The DocBook Publshers RELAX NG SchemaThe DocBook Publishers RELAX NG Schema is distributed from the DocBook site at OASIS. DocBookis also available from the mirror on http://docbook.org/.

This subcommittee will submit additional enhancements back to the full DocBook standard as appropriate.The scope of this DocBook Publishers schema is publishing industry content. Broadly, this includes books,journals and other related publications. The DocBook Publishers schema has been written as a native RELAXNG grammar, based on DocBook V5.0. This effort delivers on the following goals:

1. Build official DocBook variant, based against the DocBook v5.0 schemas.

2. Address issues and enhancement requests that have arisen from experience with real-world DocBookimplementations.

3. Add support for features specific to the publishing industry.

Explicit support for Dublin Core metadataWhile DocBook already includes many of the elements that are defined by the Dublin Core, it is not inher-ently interoperable with DC metadata. The Publisher's SC has decided to formally adopt Dublin Coremetadata as a formal metadata model for info elements. The Publishers schema will continue to supportthe base DocBook info metadata, but will allow Dublin Core elements as an alternative for capturingmetadata in this widely adopted schema.

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 con-tribute the dc.rnc, dcterms.rnc, and dcmitypes.rnc back to the Dublin Core standard.

The following Dublin Core elements have been defined and included in the Publishers schema:

db.dublincore.elements = dc.title | dc.creator | dc.subject | dc.description

4


http://docbook.org/tdg5/en/

http://www.w3.org/TR/xmlschema-1/



http://www.ascc.net/xml/resource/schematron/Schematron2000.html

http://docs.oasis-open.org/docbook/rng/

http://www.oasis-open.org/docbook/

http://www.oasis-open.org/

http://docbook.org/

New Element DefinitionsThe following elements have been added to support the needs of publishers:

Table 1. New Publishers Elements

Content ModelDefined InElement

db.speaker.attlist, ( db.person | text)*db.speakerspeaker

db.line.attlist, (db.all.inlines | text)+db.lineline

db.linegroup.attlist, db.speaker*, (db.line|db.all.blocks)+db.linegrouplinegroup

db.poe t ry.a t t l i s t , db.poe t ry. in fo? , (db.mediaob-ject|db.linegroup|db.line|db.all.blocks)+

db.poetrypoetry

db.dialogue.attlist, db.dialogue.info?, (db.mediaob-ject|db.linegroup|db.line|db.all.blocks)+

db.dialoguedialogue

Re-Defined DocBook Content ModelsThe following patterns have been re-defined in the Publishers schema:

6


Table 2.

RationaleRevised DefinitionOriginal DefinitionP a t t e r nName

Several publishers demon-strated a need to have nestedsections within a sidebar.

db.sidebar.attlist, db.side-bar.info, db.all.blocks+, db.re-cursive.sections*

db.sidebar.attlist, db.side-bar.info, db.all.blocks+

db.sidebar

While not appropriate in tech-nical documentation, severalpublishers requested this RFEto allow media objects (such asphotos) associated with a per-son.

db.person.attlist, db.person-name, (db.address|db.affili-ation|db.email|db.uri|db.person-blurb|db.mediaobject)*

db.person.attlist, db.person-name, ( db.address | db.af-filiation | db.email | db.uri|

db.person

While not appropriate in tech-nical documentation, severalpublishers requested this RFEto allow media objects (such aslogos) associated with an org.

db.org.attlist, db.orgname,( d b . a d d r e s s | d b . a f fi l i -ation|db.email|db.uri|db.org-div|db.mediaobject)*

db.org.attlist, db.orgname,( db.address | db.affiliation| db.email | db.uri | db.org-div )*

db.org

db.parameter is included incore.rnc, but was not needed forthe Publishers schema.

d b. p a r a m e t e r. a t t l i s t ,db._text

db.parameter

Modified to allow DocBookmetadata OR Dublin Coremetadata.

db.info.attlist, ( db._title &(db.info.elements*|db.dublin-core.elements*) )

( db._title, db.titleforbid-den.info? ) | db.info?

db.info


db.titleforbidden.info.attlist,(db.info.elements*|db.dublin-core.elements*)

db.titleforbidden.info.attl-ist, db.info.elements*

db.titleforbid-den.info


db.titleonly.info.attlist, (db._title.only & (db.info.ele-ments*|db.dublincore.ele-ments*) )

db.titleonly.info.attlist, (db._ t i t le .only &db.info.elements* )

d b . t i t l e -only.info


db.titleonlyreq.info.attlist, (db._ti t le.onlyreq &(db.info.elements*|db.dublin-core.elements*) )

db.titleonlyreq.info.attlist,( db._title.onlyreq &db.info.elements* )

db. t i t leon-lyreq.info


db.titlereq.info.attlist, (db._title.req & (db.info.ele-ments*|db.dublincore.ele-ments*) )

db.titlereq.info.attlist, (db._title.req & db.info.ele-ments* )

d b . t i t l e -req.info


(db.info.elements*|db.dublin-core.elements*) | db.publish-ing.inlines | db.citerefentry |db.citetitle | db.citebiblioid |db.person | db.personblurb |db.personname | db.subtitle |db.title | db.titleabbrev

db.info.elements | db.pub-l i sh ing . in l ines |db.citerefentry | db.citetitle| db.citebiblioid | db.person| db.personblurb | db.person-name | db.subtitle | db.title| db.titleabbrev

d b. b i b l i o -graphic.ele-ments

Modified to allow db.dialogueand db.poetry in all block levelpatterns.

db.dialogue | db.poetryd b . e x t e n -sion.blocks

7


Included DocBook Element DefinitionsEach element in DocBook V5.0 is defined by its own pattern. To change the content model of an element,only that pattern need be redefined. To remove an element from DocBook, that pattern can be redefinedas “notAllowed”.

The following elements from full DocBook have been included:

8


Table 3. Included DocBook elements

DescriptionModuleGroupDefinitionElement Name

An abbreviation, especially onefollowed by a period

pool.rncdb.publishing.in-lines

db.abbrevabbrev

A summarypool.rncdb.info.elementsdb.abstractabstract

Acknowledgements of a bookor other component

hier.rncdb.componentsdb.acknowledge-ments

acknowledge-ments

An often pronounceable wordmade from the initial (or selec-ted) letters of a name or phrase


db.acronymacronym

A real-world address, generallya postal address

pool.rncd b . p u b l i s h -ing.blocks

db.addressaddress

The institutional affiliation ofan individual

pool.rncd b . p e r s o n . a u -thor.contentmodel

db.affiliationaffiliation

A text-only annotation, oftenused for accessibility

pool.rncdb.ubiq.inlinesdb.altalt

A spot in the documentpool.rncdb.link.inlinesdb.anchoranchor

An answer to a question posedin a QandASet

qandaset.rncdb.qandaentrydb.answeranswer

An appendix in a Book or Art-icle

hier.rncdb.componentsdb.appendixappendix

A region defined for a Calloutin a graphic or code example

callouts.rncdb.areaspecdb.areaarea

A region defined for a Calloutin a graphic or code example

callouts.rncdb.areasetdb.area.inareasetarea

A set of related areas in agraphic or code example

callouts.rncdb.areaspecdb.areasetareaset

A collection of regions in agraphic or code example

callouts.rncdb.programlist-ingco

db.areaspecareaspec

An articlehier.rncdb.componentsdb.articlearticle

The page numbers of an articleas published

pool.rncdb.info.elementsdb.artpagenumsartpagenums

The source of a block quote orepigraph

pool.rncdb.blockquotedb.attributionattribution

Pointer to external audio datapool.rncdb.audioobjectdb.audiodataaudiodata

A wrapper for audio data and itsassociated meta-information

pool.rncd b . m e d i a o b -ject.content

db.audioobjectaudioobject

The name of an individual au-thor

pool.rncdb.bibliography.in-lines

db.authorauthor

Wrapper for author informationwhen a document has multipleauthors or collabarators

pool.rncdb.info.elementsdb.authorgroupauthorgroup

The initials or other short identi-fier for an author

pool.rncdb.info.elementsdb.authorinitialsauthorinitials

9


The spatial or temporal cover-age of a document

pool.rncdb.info.elementsdb.bibliocoveragebibliocoverage

A section of a Bibliographybibliography.rncdb.bibliographydb.bibliodivbibliodiv

An entry in a Bibliographybibliography.rncdb.bibliographydb.biblioentrybiblioentry

A bibliographybibliography.rncdb.navigation.com-ponents

db.bibliographybibliography

An identifier for a documentpool.rncdb.info.elementsdb.biblioidbiblioid

A wrapper for a list of biblio-graphy entries

bibliography.rncdb.list.blocksdb.bibliolistbibliolist

Untyped bibliographic informa-tion

bibliography.rncdb.info.elementsdb.bibliomiscbibliomisc

An entry in a Bibliographybibliography.rncdb.bibliographydb.bibliomixedbibliomixed

A cooked container for relatedbibliographic information

bibliography.rncdb.info.elementsdb.bibliomsetbibliomset

A cross-reference to a biblio-graphic entry

bibliography.rncdb.link.inlinesdb.bibliorefbiblioref

The relationship of a documentto another

pool.rncdb.info.elementsdb.bibliorelationbibliorelation

A raw container for related bib-liographic information

bibliography.rncdb.info.elementsdb.bibliosetbiblioset

The source of a documentpool.rncdb.info.elementsdb.bibliosourcebibliosource

A quotation set off from themain text


db.blockquoteblockquote

A bookhier.rncdb.set.componentsdb.bookbook

A free-floating headingpool.rncdb.nopara.blocksdb.bridgeheadbridgehead

A called out description of amarked Area

callouts.rncdb.calloutlistdb.calloutcallout

A list of calloutscallouts.rncdb.list.blocksdb.calloutlistcalloutlist

A captionpool.rncdb.exampledb.captioncaption

An HTML table captionhtmltbl.rncdb.html.table.mod-el

db.html.captioncaption

A chapter, as of a bookhier.rncdb.componentsdb.chapterchapter

An inline bibliographic refer-ence to another published work


db.citationcitation

A citation of a bibliographicidentifier


db.citebiblioidcitebiblioid

The title of a cited workpool.rncdb.bibliography.in-lines

db.citetitlecitetitle

The name of a city in an addresspool.rncdb.addressdb.citycity

The location of a callout embed-ded in text

callouts.rncdb.verbatim.inlinesdb.coco

Identifies a collaboratorpool.rncdb.info.elementsdb.collabcollab

10


Text at the back of a book de-scribing facts about its produc-tion

hier.rncdb.componentsdb.colophoncolophon

Specifications for a column ina table

calstbl.rncdb.tgroupdb.colspeccolspec

The dates of a conference forwhich a document was written

pool.rncdb.confgroupdb.confdatesconfdates

A wrapper for document meta-information about a conference

pool.rncdb.info.elementsdb.confgroupconfgroup

An identifier, frequently numer-ical, associated with a confer-ence for which a document waswritten

pool.rncdb.confgroupdb.confnumconfnum

The sponsor of a conference forwhich a document was written

pool.rncdb.confgroupdb.confsponsorconfsponsor

The title of a conference forwhich a document was written

pool.rncdb.confgroupdb.conftitleconftitle

The contract number of a docu-ment

pool.rncdb.info.elementsdb.contractnumcontractnum

The sponsor of a contractpool.rncdb.info.elementsdb.contractspon-sor

contractsponsor

A summary of the contributionsmade to a document by a cred-ited source


db.contribcontrib

Copyright information about adocument

pool.rncdb.info.elementsdb.copyrightcopyright

A cross reference to a cocallouts.rncdb.publishing.in-lines

db.corefcoref

The name of a countrypool.rncdb.addressdb.countrycountry

Additional content for the coverof a publication

pool.rncdb.info.elementsdb.covercover

The date of publication or revi-sion of a document


db.datedate

The dedication of a book orother component

hier.rncdb.componentsdb.dedicationdedication

The name or number of an edi-tion of a document

pool.rncdb.info.elementsdb.editionedition

The name of the editor of adocument


db.editoreditor

An email addresspool.rncdb.markup.inlinesdb.emailemail

A limited span of emphasizedtext

pool.rncdb._emphasisdb._emphasisemphasis

Emphasized textpool.rncdb.publishing.in-lines

db.emphasisemphasis

A cell in a tablecalstbl.rncdb.rowdb.entryentry

11


A subtable appearing in placeof an Entry in a table

calstbl.rncdb.rowdb.entrytblentrytbl

A short inscription at the begin-ning of a document or compon-ent


db.epigraphepigraph

A displayed mathematicalequation

math.rncdb.formal.blocksdb.equationequation

A formal example, with a titlepool.rncdb.formal.blocksdb.exampleexample

A fax numberpool.rncdb.addressdb.faxfax

A formal figure, generally an il-lustration, with a title

pool.rncdb.formal.blocksdb.figurefigure

The first name of a personpool.rncdb.personnamedb.firstnamefirstname

The first occurrence of a termglossary.rncdb.glossary.inlinesdb.firsttermfirstterm

A footnotepool.rncdb.publishing.in-lines

db.footnotefootnote

A cross reference to a footnote(a footnote mark)


db.footnotereffootnoteref

A word or phrase in a languageother than the primary languageof the document


db.foreignphraseforeignphrase

A paragraph with a titlepool.rncdb.para.blocksdb.formalparaformalpara

A glossaryglossary.rncdb.navigation.com-ponents

db.glossaryglossary

A definition in a GlossEntryglossary.rncdb.glossentrydb.glossdefglossdef

A division in a Glossaryglossary.rncdb.glossarydb.glossdivglossdiv

An entry in a Glossary orGlossList

glossary.rncdb.glosslistdb.glossentryglossentry

A wrapper for a list of glossaryentries

glossary.rncdb.list.blocksdb.glosslistglosslist

A cross-reference from oneglossentry to another

glossary.rncdb.glossentrydb.glossseeglosssee

A cross-reference from oneGlossEntry to another

glossary.rncdb.glossdefdb.glossseealsoglossseealso

A glossary termglossary.rncdb.glossary.inlinesdb.glosstermglossterm

The name of the individual ororganization that holds a copy-right

pool.rncdb.copyrightdb.holderholder

The title of a personpool.rncdb.personnamedb.honorifichonorific

Pointer to external image datapool.rncd b . i m a g e o b -ject.content

db.imagedataimagedata

An SVG drawing in a mediaobject

svg.rncd b . i m a g e o b -ject.content

db.imagedata.svgimagedata

A MathML expression in a me-dia object

mathml.rncd b . i m a g e o b -ject.content

d b . i m -agedata.mathml

imagedata

12


A wrapper for image data andits associated meta-information

pool.rncd b . m e d i a o b -ject.content

db.imageobjectimageobject

A wrapper for an image objectwith callouts

callouts.rncd b . m e d i a o b -ject.content

db.imageobjectcoimageobjectco

An index to a book or part of abook

index.rncdb.navigation.com-ponents

db.indexindex

Identifies the end of a range as-sociated with an indexed term

index.rncdb.indextermdb.indexterm.endo-frange

indexterm

A wrapper for an indexed termthat covers a range

index.rncdb.indextermdb.indexterm.star-tofrange

indexterm

A wrapper for an indexed termindex.rncdb.itermsetdb.indexterm.sin-gular

indexterm

A wrapper for information abouta component or other block withonly a title

pool.rncdb._info.title.onlydb.titleonly.infoinfo

A wrapper for information abouta component or other block

pool.rncdb._infodb.infoinfo

A wrapper for information abouta component or other block witha required title

pool.rncdb._info.title.reqdb.titlereq.infoinfo

A wrapper for information abouta component or other blockwithout a title

pool.rncdb._infodb. t i t l e fo rb id -den.info

info

A wrapper for information abouta component or other block withonly a required title

pool.rncdb._info.title.on-lyreq

d b . t i t l e o n -lyreq.info

info

A displayed mathematicalequation without a title

math.rncdb.informal.blocksdb.informalequa-tion

informalequa-tion

A displayed example without atitle

pool.rncdb.informal.blocksd b . i n f o r m a l -example

i n f o r m a l -example

A untitled figurepool.rncdb.informal.blocksdb.informalfigureinformalfigure

A table without a titlecalstbl.rncd b . i n f o r m a l t -able.choice

db.cals.informalt-able

informaltable

A mathematical equation or ex-pression occurring inline

math.rncdb.math.inlinesdb.inlineequationinlineequation

An inline media object (video,audio, image, and so on)

pool.rncdb.ubiq.inlinesdb.inlinemediaob-ject

inlinemediaob-ject

The number of an issue of ajournal

pool.rncdb.info.elementsdb.issuenumissuenum

A list in which each entry ismarked with a bullet or otherdingbat

pool.rncdb.list.blocksdb.itemizedlistitemizedlist

A set of index terms in themeta-information of a document

index.rncdb.info.elementsdb.itermsetitermset

The title of an individual in anorganization


db.jobtitlejobtitle

13


One of a set of keywords de-scribing the content of a docu-ment

pool.rncdb.keywordsetdb.keywordkeyword

A set of keywords describingthe content of a document

pool.rncdb.info.elementsdb.keywordsetkeywordset

A label on a Question or An-swer

qandaset.rncdb.questiondb.labellabel

A statement of legal obligationsor requirements

pool.rncdb.info.elementsdb.legalnoticelegalnotice

The portion of a person's nameindicating a relationship to an-cestors

pool.rncdb.personnamedb.lineagelineage

A hypertext linkpool.rncdb.link.inlinesdb.linklink

A wrapper for the elements of alist item

pool.rncdb.itemizedlistdb.listitemlistitem

Inline text that is some literalvalue

markup.rncdb.markup.inlinesdb.literalliteral

A block of text in which linebreaks and white space are to bereproduced faithfully

pool.rncdb.verbatim.blocksdb.literallayoutliterallayout

A mathematical phrase, an ex-pression that can be representedwith ordinary text and a smallamount of markup

math.rncdb.equation.con-tent

db.mathphrasemathphrase

A displayed media object(video, audio, image, etc.)

pool.rncdb.graphic.blocksdb.mediaobjectmediaobject

An element of a simple listpool.rncdb.simplelistdb.membermember

A message set off from the textpool.rncd b . a d m o n i -tion.blocks

db.notenote

A link that addresses its targetindirectly

pool.rncdb.link.inlinesdb.olinkolink

Optional informationtechnical.rncdb.technical.in-lines

db.optionaloptional

A list in which each entry ismarked with a sequentially incre-mented label

pool.rncdb.list.blocksdb.orderedlistorderedlist

An organization and associatedmetadata


db.orgorg

A division of an organizationpool.rncdb.affiliationdb.orgdivorgdiv

The name of an organizationother than a corporation


db.orgnameorgname

Uncategorized information inaddress

pool.rncdb.addressdb.otheraddrotheraddr

A person or entity, other than anauthor or editor, credited in adocument

pool.rncdb.info.elementsdb.othercreditothercredit

14


A component of a persons namethat is not a first name, surname,or lineage

pool.rncdb.personnamedb.othernameothername

The numbers of the pages in abook, for use in a bibliographicentry

pool.rncdb.info.elementsdb.pagenumspagenums

A paragraphpool.rncdb.para.blocksdb.parapara

A division in a bookhier.rncdb.divisionsdb.partpart

An introduction to the contentsof a part

hier.rncdb.partdb.partintropartintro

A person and associatedmetadata


db.personperson

A short description or noteabout a person


db.personblurbpersonblurb

The personal name of an indi-vidual


db.personnamepersonname

A telephone numberpool.rncdb.addressdb.phonephone

A span of textpool.rncdb.publishing.in-lines

db.phrasephrase

A limited span of textpool.rncdb._textdb._phrasephrase

A post office box in an addresspool.rncdb.addressdb.pobpob

A postal code in an addresspool.rncdb.addressdb.postcodepostcode

Introductory matter precedingthe first chapter of a book

hier.rncdb.componentsdb.prefacepreface

The primary word or phrase un-der which an index term shouldbe sorted

index.rncdb.indexterm.con-tentmodel

db.primaryprimary

The printing history of a docu-ment

pool.rncdb.info.elementsdb.printhistoryprinthistory

A list of operations to be per-formed in a well-defined se-quence

pool.rncdb.technical.blocksdb.procedureprocedure

The formal name of a productpool.rncdb.product.inlinesdb.productnameproductname

A number assigned to a productpool.rncdb.product.inlinesdb.productnumberproductnumber

The date of publication of adocument

pool.rncdb.info.elementsdb.pubdatepubdate

The publisher of a documentpool.rncdb.info.elementsdb.publisherpublisher

The name of the publisher of adocument

pool.rncdb.info.elementsdb.publishernamepublishername

A titled division in a QandASetqandaset.rncdb.qandasetdb.qandadivqandadiv

A question/answer set within aQandASet

qandaset.rncdb.qandasetdb.qandaentryqandaentry

A question-and-answer setqandaset.rncdb.list.blocksdb.qandasetqandaset

A question in a QandASetqandaset.rncdb.qandaentrydb.questionquestion

15


An inline quotationpool.rncdb.publishing.in-lines

db.quotequote

pool.rncdb.releaseinforeleaseinfo

A remark (or comment) inten-ded for presentation in a draftmanuscript

pool.rncremarkremark

pool.rncrevdescriptionrevdescription

pool.rncrevhistoryrevhistory

pool.rncrevisionrevision

pool.rncrevnumberrevnumber

pool.rncrevremarkrevremark

calstbl.rncrowrow

index.rncsecondarysecondary

index.rncsecondaryiesecondaryie

hier.rncdb.sectionsection

index.rncseesee

index.rncseealsoseealso

pool.rncseriesvolnumsseriesvolnums

hier.rncsetset

index.rncsetindexsetindex

pool.rncshortaffilshortaffil

A portion of a document that isisolated from the main narrativeflow

pool.rncsidebarsidebar

A paragraph that contains onlytext and inline markup, no blockelements

pool.rncsimparasimpara

An undecorated list of singlewords or short phrases

pool.rncsimplelistsimplelist

A section of a document withno subdivisions

hier.rncsimplesectsimplesect

calstbl.rncspanspecspanspec

statestate

A unit of action in a procedurepool.rncstepstep

Alternative steps in a procedurepool.rncstepalternativesstepalternatives

pool.rncstreetstreet

One of a group of terms describ-ing the subject matter of a docu-ment

pool.rncsubjectsubject

A set of terms describing thesubject matter of a document

pool.rncsubjectsetsubjectset

16


A term in a group of terms de-scribing the subject matter of adocument

pool.rncsubjecttermsubjectterm

pool.rncsubscriptsubscript

A wrapper for steps that occurwithin steps in a procedure

pool.rncsubstepssubsteps

The subtitle of a documentpool.rncsubtitlesubtitle

pool.rncsuperscriptsuperscript

pool.rncsurnamesurname

calstbl.rnctabletable

A task to be completedtasks.rnctasktask

The prerequisites for a tasktasks.rnctaskprerequisitestaskprerequis-ites

Information related to a tasktasks.rnctaskrelatedtaskrelated

A summary of a tasktasks.rnctasksummarytasksummary

calstbl.rnctbodytbody

The word or phrase beingdefined or described in a vari-able list

pool.rnctermterm

An inline definition of a termglossary.rncdb.termdeftermdef

index.rnctertiarytertiary

Pointer to external text datapool.rnctextdatatextdata

A wrapper for a text descriptionof an object and its associatedmeta-information

pool.rnctextobjecttextobject

calstbl.rnctfoottfoot

A wrapper for the main contentof a table, or part of a table

calstbl.rnctgrouptgroup

calstbl.rnctheadthead

The text of the title of a sectionof a document or of a formalblock-level element

pool.rnctitletitle

The abbreviation of a titlepool.rnctitleabbrevtitleabbrev

A table of contentstoc.rnctoctoc

pool.rnctrademarktrademark

pool.rncuriuri

A list in which each entry iscomposed of a set of one ormore terms and an associateddescription

pool.rncvariablelistvariablelist

A wrapper for a set of terms andthe associated description in avariable list

pool.rncvarlistentryvarlistentry

Pointer to external video datapool.rncvideodatavideodata

17


A wrapper for video data and itsassociated meta-information

pool.rncvideoobjectvideoobject

pool.rncvolumenumvolumenum

pool.rncdb.wordaswordwordasword

pool.rncxrefxref

pool.rncyearyear

Any element from almost anynamespace

pool.rncdb._anydb._any*.*

Excluded DocBook Element DefinitionsThe following elements from full DocBook have been excluded from the Publishers schema:

Note

Because the Publishers schema is written in RelaxNG Compact syntax, it is very easy to addelements back into a customization of the Publishers schema. For example, if the elements in theprogramming module were needed, it is very simple to use an include statement for the program-ming.rnc file from the source DocBook distribution.

18


Table 4. Excluded DocBook elements

DescriptionModuleGroupDefinitionElement Name

A graphical user interface(GUI) keyboard shortcut

keyboard.rncdb.keyboard.inlinesdb.accelaccel

An annotationannotations.rncdb.ubiq.inlinesdb.annotationannotation

The name of a software pro-gram

product.rncdb.product.inlinesdb.applicationapplication

An XLink arc in an extended-link

xlink.rncdb.extendedlinkdb.arcarc

An argument in a CmdSynop-sis

programming.rncdb.cmdsynopsisdb.argarg

A note of cautionadmonitions.rncd b . a d m o n i -tion.blocks

db.cautioncaution

A citation to a reference pagerefentry.rncdb.bibliography.in-lines

db.citerefentryciterefentry

The name of a class, in theobject-oriented programmingsense

programming.rncdb.programming.in-lines

db.classnameclassname

The syntax summary for aclass definition

programming.rncdb.synopsis.blocksdb.classsynopsisclasssynopsis

Information supplementing thecontents of a ClassSynopsis

programming.rncdb.classsynopsisdb.classsynop-sisinfo

c l a s s s y n o p -sisinfo

A syntax summary for a soft-ware command

programming.rncdb.synopsis.blocksdb.cmdsynopsiscmdsynopsis

An inline code fragmentmarkup.rncdb.markup.inlinesdb.codecode

Specifications for a column inan HTML table

htmltbl.rncdb.html.table.mod-el

db.html.colcol

A group of columns in anHTML table

htmltbl.rncdb.html.table.mod-el

db.html.colgroupcolgroup

The name of an executableprogram or other softwarecommand

os.rncdb.os.inlinesdb.commandcommand

Data, generally text, displayedor presented by a computer

os.rncdb.os.inlinesdb.computerout-put

computeroutput

A programming or systemconstant

markup.rncdb.markup.inlinesdb.constantconstant

A constraint in an EBNF pro-duction

ebnf.rncdb.productiondb.constraintconstraint

The definition of a constraintin an EBNF production

ebnf.rncdb.technical.blocksdb.constraintdefconstraintdef

A syntax summary for a con-structor

programming.rncdb.synopsis.blocksdb.constructorsyn-opsis

constructorsyn-opsis

The name of a database, orpart of a database

product.rncdb.product.inlinesdb.databasedatabase

19


A syntax summary for a de-structor

programming.rncdb.synopsis.blocksdb.destructorsyn-opsis

destructorsynop-sis

A software environment vari-able

os.rncdb.os.inlinesdb.envarenvar

An error codeerror.rncdb.error.inlinesdb.errorcodeerrorcode

An error nameerror.rncdb.error.inlinesdb.errornameerrorname

An error message.error.rncdb.error.inlinesdb.errortexterrortext

The classification of an errormessage

error.rncdb.error.inlinesdb.errortypeerrortype

The name of an exceptionprogramming.rncdb.programming.in-lines

db.exceptionnameexceptionname

An XLink extended linkxlink.rncdb.info.elementsdb.extendedlinkextendedlink

The name of a field in a classdefinition

programming.rncdb.synopsis.blocksdb.fieldsynopsisfieldsynopsis

The name of a fileos.rncdb.os.inlinesdb.filenamefilename

A function (subroutine) nameand its return type

programming.rncdb.funcprototypedb.funcdeffuncdef

Parameters for a function refer-enced through a functionpointer in a synopsis

programming.rncdb.paramdefdb.funcparamsfuncparams

The prototype of a functionprogramming.rncdb.funcsynopsisdb.funcprototypefuncprototype

The syntax summary for afunction definition

programming.rncdb.synopsis.blocksdb.funcsynopsisfuncsynopsis

Information supplementing theFuncDefs of a FuncSynopsis

programming.rncdb.funcsynopsisdb. funcsynop-sisinfo

f u n c s y n o p -sisinfo

The name of a function orsubroutine, as in a program-ming language


db.functionfunction

A group of elements in a Cmd-Synopsis

programming.rncdb.cmdsynopsisdb.groupgroup

The text on a button in a GUIgui.rncdb.gui.inlinesdb.guibuttonguibutton

Graphic and/or text appearingas a icon in a GUI

gui.rncdb.gui.inlinesdb.guiiconguiicon

The text of a label in a GUIgui.rncdb.gui.inlinesdb.guilabelguilabel

The name of a menu in a GUIgui.rncdb.gui.inlinesdb.guimenuguimenu

The name of a terminal menuitem in a GUI

gui.rncdb.gui.inlinesdb.guimenuitemguimenuitem

The name of a submenu in aGUI

gui.rncdb.gui.inlinesdb.guisubmenuguisubmenu

A physical part of a computersystem

product.rncdb.product.inlinesdb.hardwarehardware

An admonition set off from thetext

admonitions.rncd b . a d m o n i -tion.blocks

db.importantimportant

A division in an indexindex.rncdb.indexdb.indexdivindexdiv

20


An entry in an indexindex.rncdb.indexdb.indexentryindexentry

An HTML table without a titlehtmltbl.rncd b . i n f o r m a l t -able.choice

db.html.informalt-able

informaltable

The initializer for a FieldSyn-opsis


db.initializerinitializer

The name of an interfaceprogramming.rncdb.programming.in-lines

db.interfacenameinterfacename

The text printed on a key on akeyboard

keyboard.rncdb.keyboard.inlinesdb.keycapkeycap

The internal, frequently numer-ic, identifier for a key on akeyboard

keyboard.rncdb.keyboard.inlinesdb.keycodekeycode

A combination of input actionskeyboard.rncdb.keyboard.inlinesdb.keycombokeycombo

The symbolic name of a keyon a keyboard

keyboard.rncdb.keyboard.inlinesdb.keysymkeysym

The left-hand side of an EBNFproduction

ebnf.rncdb.productiondb.lhslhs

An XLink locator in an ex-tendedlink

xlink.rncdb.extendedlinkdb.locatorlocator

A reference volume numberrefentry.rncdb.citerefentrydb.manvolnummanvolnum

A string of formatting markupin text that is to be representedliterally

markup.rncdb.markup.inlinesdb.markupmarkup

A comment on a line in a ver-batim listing

programming.rncdb.verbatim.inlinesdb.lineannotationlineannotation

A selection or series of selec-tions from a menu

gui.rncdb.gui.inlinesdb.menuchoicemenuchoice

The name of a methodprogramming.rncdb.programming.in-lines

db.methodnamemethodname

Parameters to a methodprogramming.rncdb.constructorsyn-opsis

db.methodparammethodparam

A syntax summary for amethod

programming.rncdb.synopsis.blocksdb.methodsynop-sis

methodsynopsis

Modifiers in a synopsisprogramming.rncdb.programming.in-lines

db.modifiermodifier

The conventional name of amouse button

gui.rncdb.gui.inlinesdb.mousebuttonmousebutton

A message in a message setmsgset.rncdb.msgentrydb.msgmsg

The audience to which a mes-sage in a message set is relev-ant

msgset.rncdb.msginfodb.msgaudmsgaud

A wrapper for an entry in amessage set

msgset.rncdb.msgsetdb.msgentrymsgentry

Explanatory material relatingto a message in a message set

msgset.rncdb.msgentrydb.msgexplanmsgexplan

21


Information about a messagein a message set

msgset.rncdb.msgentrydb.msginfomsginfo

The level of importance orseverity of a message in amessage set

msgset.rncdb.msginfodb.msglevelmsglevel

The primary component of amessage in a message set

msgset.rncdb.msgdb.msgmainmsgmain

The origin of a message in amessage set

msgset.rncdb.msginfodb.msgorigmsgorig

A related component of amessage in a message set

msgset.rncdb.msgdb.msgrelmsgrel

A detailed set of messages,usually error messages

msgset.rncdb.technical.blocksdb.msgsetmsgset

A subcomponent of a messagein a message set

msgset.rncdb.msgdb.msgsubmsgsub

The actual text of a messagecomponent in a message set

msgset.rncdb.simplemsgentrydb.msgtextmsgtext

A non-terminal in an EBNFproduction

ebnf.rncdb.technical.inlinesdb.nonterminalnonterminal

A class in an object-orientedprogramming language

programming.rncdb.oo.inlinesdb.ooclassooclass

An exception in an object-ori-ented programming language

programming.rncdb.oo.inlinesdb.ooexceptionooexception

An interface in an object-ori-ented programming language

programming.rncdb.oo.inlinesdb.oointerfaceoointerface

An option for a software com-mand

technical.rncdb.technical.inlinesdb.optionoption

A software or applicationpackage

technical.rncdb.technical.inlinesdb.packagepackage

Information about a functionparameter in a programminglanguage

programming.rncdb.funcprototypedb.paramdefparamdef

A value or a symbolic refer-ence to a value

programming.rncdb.technical.inlinesdb.parameterparameter

A primary term in an indexentry, not in the text

index.rncdb.indexentrydb.primaryieprimaryie

A production in a set of EBNFproductions

ebnf.rncdb.productionsetdb.productionproduction

A cross-reference to an EBNFproduction

ebnf.rncdb.productionsetdb.productionre-cap

productionrecap

A set of EBNF productionsebnf.rncdb.technical.blocksdb.productionsetproductionset

A literal listing of all or partof a program

programming.rncdb.verbatim.blocksdb.programlistingprogramlisting

A program listing with associ-ated areas used in callouts

callouts.rncdb.verbatim.blocksdb.programlist-ingco

programl i s t -ingco

22


A character or string indicatingthe start of an input field in acomputer display

os.rncdb.os.inlinesdb.promptprompt

A unit of data associated withsome part of a computer sys-tem

technical.rncdb.technical.inlinesdb.propertyproperty

The scope or other indicationof applicability of a referenceentry

refentry.rncdb.refnamedivdb.refclassrefclass

A description of the topic of areference page

refentry.rncdb.refnamedivdb.refdescriptorrefdescriptor

A reference page (originally aUNIX man-style referencepage)

refentry.rncdb.toplevel.sec-tions

db.refentryrefentry

The title of a reference pagerefentry.rncdb.citerefentrydb.refentrytitlerefentrytitle

A collection of referenceentries

refentry.rncdb.divisionsdb.referencereference

Meta-information for a refer-ence entry

refentry.rncdb.refentrydb.refmetarefmeta

Meta-information for a refer-ence entry other than the titleand volume number

refentry.rncdb.refmetadb.refmiscinforefmiscinfo

The name of (one of) the sub-ject(s) of a reference page

refentry.rncdb.refnamedivdb.refnamerefname

The name, purpose, and classi-fication of a reference page

refentry.rncdb.refentrydb.refnamedivrefnamediv

A short (one sentence) synop-sis of the topic of a referencepage

refentry.rncdb.refnamedivdb.refpurposerefpurpose

A major subsection of a refer-ence entry

refsect1.rncdb.toplevel.sec-tions

db.refsect1refsect1

A subsection of a refsect1refsect1.rncdb.secondlevel.ref-section

db.refsect2refsect2

A subsection of a refsect2refsect1.rncdb.refsect2.sectionsdb.refsect3refsect3

A recursive section in arefentry

refentry.rncdb.toplevel.refsec-tion

db.refsectionrefsection

A syntactic synopsis of thesubject of the reference page

refentry.rncdb.refentrydb.refsynopsisdivrefsynopsisdiv

technical.rncdb.technical.inlinesreplaceablereplaceable


db.returnvaluereturnvalue

ebnf.rncdb.productiondb.rhsrhs

programming.rncdb.sbrsbr

Text that a user sees or mightsee on a computer screen

technical.rncdb.screenscreen

23


A screen with associated areasused in callouts

callouts.rncdb.verbatim.blocksdb.screencoscreenco

A representation of what theuser sees or might see on acomputer screen

technical.rncdb.screenshotscreenshot

A top-level section of the doc-ument

sect1.rncdb.toplevel.sec-tions

db.sect1sect1

A subsection within a Sect1sect1.rncdb.sect1.sectionsdb.sect2sect2




A "See also" ] " entry in an in-dex, rather than in the text

index.rncseealsoieseealsoie

A "See" entry in an index,rather than in the text

index.rncseeieseeie

An element of a list item in asegmented list

markup.rncdb.segseg

A list item in a segmented listmarkup.rncdb.seglistitemseglistitem

A segmented list, a list of setsof elements

markup.rncdb.segmentedlistsegmentedlist

The title of an element of a listitem in a segmented list

markup.rncdb.segtitlesegtitle

keyboard.rncdb.shortcutshortcut

msgset.rncdb.msgsetd b . s i m p l e m s -gentry

simplemsgentry

A name that is replaced by avalue before processing

markup.rncdb.markup.inlinessymbolsymbol

programming.rncdb.synopfragmentsynopfragment

programming.rncdb.synopfragmen-tref

synopfragmen-tref

A general-purpose element forrepresenting the syntax ofcommands or functions

programming.rncdb.synopsissynopsis

technical.rncdb.technical.inlinesdb.systemitemsystemitem

A component of XML (orSGML) markup

markup.rncdb.markup.inlinesdb.tagtag

htmltbl.rncdb.html.informalt-able

td

index.rnctertiaryietertiaryie


th

admonitions.rnctiptip

A division in a table of con-tents

toc.rnctocdiv

24


A component title in a table ofcontents

toc.rnctocentry

A unit of informationmarkup.rncdb.markup.inlinesdb.tokentoken


tr


db.typetype

os.rncdb.os.inlinesdb.userinputuserinput

programming.rncvarargsvarargs


varnamevarname

programming.rncdb.voidvoid

admonitions.rncdb.warningwarning

Attribute DefinitionsEach attribute list in DocBook V5.0 is defined by its own pattern. To change the list of attributes availableon an element, only that pattern need be redefined. To remove all the attributes, that pattern can be redefinedas “empty”.

The following attribute definitions have been added to the Publishers schema:

Table 5. Publishers Attribute Pattern Definitions

Attribute pattern definitionAttribute pattern name

attribute role { text }db.speaker.role.attribute

db.speaker.role.attribute? & db.common.attributes & db.common.linking.at-tributes

db.speaker.attlist

attribute role { text }db.line.role.attribute

db.line.role.attribute? & db.common.attributes & db.common.linking.attributesdb.line.attlist

attribute role { text }db.linegroup.role.attribute

db.linegroup.role.attribute? & db.common.attributes & db.common.linking.at-tributes

db.linegroup.attlist

attribute role { text }db.dialogue.role.attribute

db.dialogue.role.attribute? & db.common.attributes & db.common.linking.at-tributes

db.dialogue.attlist

attribute role { text }db.poetry.role.attribute

db.poetry.role.attribute? & db.common.attributes & db.common.linking.attrib-utes

db.poetry.attlist

A. AcknowledgementsThe following individuals have participated in the creation of this specification and are gratefully acknow-ledged:

25


Participants

• Jim Earley, Flatirons Solutions• Dick Hamilton, Individual• John Hanratty, Reed Elsevier• Gary Hoffman, Individual• Dave Pawson, Royal National Institute of the Blind (RNIB)• John Pederson, John Wiley & Sons, Inc.• Norm Walsh, Mark Logic Corporation• Keith Fahlgren, O'Reilly Media (Secretary)• Scott Hudson, Flatirons Solutions (Chair, Editor)

B. Revision HistoryInitial Draft. 11 June 2008.

26


the docbook publishers schema - oasis be used only to refer to the organization and its official...

Documents