OASIS logo

The DocBook Schema Version 5.0.1

Committee Specification Draft 01

09 July 2018

Specification URIs

This version:

http://docs.oasis-open.org/docbook/docbook/v5.0.1/csd01/docbook-v5.0.1-csd01.docx (Authoritative)

http://docs.oasis-open.org/docbook/docbook/v5.0.1/csd01/docbook-v5.0.1-csd01.html

http://docs.oasis-open.org/docbook/docbook/v5.0.1/csd01/docbook-v5.0.1-csd01.pdf

Previous version:

N/A

Latest version:

http://docs.oasis-open.org/docbook/docbook/v5.0.1/docbook-v5.0.1.docx (Authoritative)

http://docs.oasis-open.org/docbook/docbook/v5.0.1/docbook-v5.0.1.html

http://docs.oasis-open.org/docbook/docbook/v5.0.1/docbook-v5.0.1.pdf

Technical Committee:

OASIS DocBook TC

Chair:

Robert Stayton (bobs@sagehill.net), Individual

Editor:

Robert Stayton (bobs@sagehill.net), Individual

Additional artifacts:

This prose specification is one component of a Work Product that also includes:

·         Relax NG schemas: http://docs.oasis-open.org/docbook/docbook/v5.0.1/csd01/schemas/rng/

·         Schematron schema: http://docs.oasis-open.org/docbook/docbook/v5.0.1/csd01/schemas/sch/

·         DTD schema: http://docs.oasis-open.org/docbook/docbook/v5.0.1/csd01/schemas/dtd/

·         XML schemas: http://docs.oasis-open.org/docbook/docbook/v5.0.1/csd01/schemas/xsd/

·         http://docs.oasis-open.org/docbook/docbook/v5.0.1/csd01/schemas/catalog.xml

·         http://docs.oasis-open.org/docbook/docbook/v5.0.1/csd01/schemas/docbook.nvdl

Related work:

This specification replaces or supersedes:

·         The DocBook Schema Version 5.0. Edited by Norman Walsh. 1 November 2009. OASIS Standard. http://docs.oasis-open.org/docbook/specs/docbook-5.0-spec-os.html.

·         The DocBook Schema Version 5.0 Errata 01. Edited by Robert Stayton. 29 March 2018. OASIS Approved Errata. http://docs.oasis-open.org/docbook/specs/docbook-5.0-spec-errata01-os.html.

Note that The DocBook Schema Version 5.0 has been superseded by:

·         DocBook Version 5.1. Edited by Norman Walsh. 22 November 2016. OASIS Standard. http://docs.oasis-open.org/docbook/docbook/v5.1/os/docbook-v5.1-os.html. Latest version: http://docs.oasis-open.org/docbook/docbook/v5.1/docbook-v5.1.html.

Abstract:

The Schematron rules changed after DocBook 5.0 was released, so some Schematron tools do not work with DocBook 5.0. The DocBook 5.0.1 spec is updated with the new Schematron rules so users can continue using DocBook 5.0 if they need to use newer Schematron tools.

Status:

This document was last revised or approved by the OASIS DocBook TC on the above date. The level of approval is also listed above. Check the “Latest version” location noted above for possible later revisions of this document. Any other numbered Versions and other technical work produced by the Technical Committee (TC) are listed at https://www.oasis-open.org/committees/tc_home.php?wg_abbrev=docbook#technical.

TC members should send comments on this specification to the TC's email list. Others should send comments to the TC by using the "Send A Comment" button on the TC's web page at https://www.oasis-open.org/committees/docbook/.

This specification is provided under the RF on Limited Terms Mode of the OASIS IPR Policy, the mode chosen when the Technical Committee was established. For information on whether any patents have been disclosed that may be essential to implementing this specification, and any offers of patent licensing terms, please refer to the Intellectual Property Rights section of the TC's web page (https://www.oasis-open.org/committees/docbook/ipr.php).

Note that any machine-readable content (Computer Language Definitions) declared Normative for this Work Product is provided in separate plain text files. In the event of a discrepancy between any such plain text file and display content in the Work Product's prose narrative document(s), the content in the separate plain text file prevails.

Citation format:

When referencing this specification the following citation format should be used:

[DocBook-v5.0.1]

The DocBook Schema Version 5.0.1. Edited by Robert Stayton. 09 July 2018. OASIS Committee Specification Draft 01. http://docs.oasis-open.org/docbook/docbook/v5.0.1/csd01/docbook-v5.0.1-csd01.html. Latest version: http://docs.oasis-open.org/docbook/docbook/v5.0.1/docbook-v5.0.1.html.

Notices

Copyright © OASIS Open 2018. All Rights Reserved.

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

This document and translations of it may be copied and furnished to others, and derivative works that 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 the above 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 notice or references to OASIS, except as needed for the purpose of developing any document or deliverable produced by an OASIS Technical Committee (in which case the rules applicable to copyrights, as set forth in the OASIS IPR Policy, must be followed) or as required to translate it into languages other than English.

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

This document and the information contained herein is provided on an "AS IS" basis and OASIS DISCLAIMS ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY OWNERSHIP RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.

OASIS requests that any OASIS Party or any other party that believes it has patent claims that would necessarily be infringed by implementations of this OASIS Committee Specification or OASIS Standard, to notify OASIS TC Administrator and provide an indication of its willingness to grant patent licenses to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification.

OASIS invites any party to contact the OASIS TC Administrator if it is aware of a claim of ownership of any patent claims that would necessarily be infringed by implementations of this specification by a patent holder that is not willing to provide a license to such patent claims in a manner consistent with the IPR Mode of the OASIS Technical Committee that produced this specification. OASIS may include 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 rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; neither does it represent that it has made any effort to identify any such rights. Information on OASIS' procedures with respect to rights in any document or deliverable produced by an OASIS Technical Committee can be found on the OASIS website. Copies of claims of rights made available for publication and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this OASIS Committee Specification or OASIS Standard, can be obtained from the OASIS TC Administrator. OASIS makes no representation that any information or list of intellectual property rights will 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, and should be used only to refer to the organization and its official outputs. OASIS welcomes reference to, and implementation and use of, specifications, while reserving the right to enforce its marks against misleading uses. Please see https://www.oasis-open.org/policies-guidelines/trademark for above guidance.

Table of Contents

1        Introduction. 5

1.1 IPR Policy. 5

1.2 Terminology. 5

1.3 Normative References. 5

1.4 Non-Normative References. 6

2        Schematron rule change. 7

2.1 Replace @name with <s:title>. 7

2.2 New Schematron namespace. 8

2.2.1 Namespace change in <grammar> element 8

2.2.2 Namespace change in <s:ns> element 8

3        Conformance. 9

Appendix A. Acknowledgments. 10

Appendix B. Revision History. 11

 

 


1      Introduction

DocBook is a general purpose XML schema particularly well suited to books and papers about computer hardware and software (although it is by no means limited to these applications).

The DocBook Technical Committee [DocBookTC] maintains the DocBook schema. Starting with V5.0, DocBook is normatively available as a [Relax NG] Schema with some additional Schematron assertions.

After [DocBook 5.0] was released as an OASIS Committee Standard in 2009, the Schematron standard was changed.  After various tools that work with Schematron were updated, the DocBook 5.0 schema would no longer parse without error because it did not conform to the new Schematron syntax.

DocBook Version 5.0.1 is a minor update of DocBook 5.0 to bring its Schematron rules into conformance  with the latest version of Schematron. No changes were made to DocBook elements, attributes, or content models. So any document that conformed to DocBook 5.0 will stil conform to DocBook 5.0.1. This will allow users of DocBook 5.0 to make use of updated Schematron rules without having to upgrade their documents to DocBook Version 5.1 [DocBook-5.1].

This document describes only the changes that were made to DocBook Version 5.0 to bring it into conformance with the new Schematron version. For other information about DocBook Version 5.0 and how it differs from previous versions, see the OASIS Standards document for [DocBook-5.0].

1.1 IPR Policy

This specification is provided under the RF on Limited Terms Mode of the OASIS IPR Policy, the mode chosen when the Technical Committee was established. For information on whether any patents have been disclosed that may be essential to implementing this specification, and any offers of patent licensing terms, please refer to the Intellectual Property Rights section of the TC's web page (https://www.oasis-open.org/committees/docbook/ipr.php).

1.2 Terminology

The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in [RFC2119] and [RFC8174] when, and only when, they appear in all capitals, as shown here.

1.3 Normative References

[RFC2119]               Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, DOI 10.17487/RFC2119, March 1997, <http://www.rfc-editor.org/info/rfc2119>.

[RFC8174]               Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words", BCP 14, RFC 8174, DOI 10.17487/RFC8174, May 2017, <http://www.rfc-editor.org/info/rfc8174>.

[Docbook-5.0]         The DocBook Schema Version 5.0. Edited by Norman Walsh. 1 November 2009, OASIS Standard. http://docs.oasis-open.org/docbook/specs/docbook-5.0-spec-os.html

[DocBook-5.1]         DocBook Version 5.1. Edited by Normal Walsh. 22 November 2016, OASIS Standard. http://docs.oasis-open.org/docbook/docbook/v5.1/os/docbook-v5.1-os.html

[Schematron2006]  ISO/IEC 19757-3:2006 Information Technology—Document Schema Definition Language (DSDL)—Part 3: Rule-based validation—Schematron http://www.iso.org/iso/home/store/catalogue_tc/catalogue_detail.htm?csnumber=40833] Publicly available at: http://standards.iso.org/ittf/PubliclyAvailableStandards/c040833_ISO_IEC_19757-3_2006(E).zip.

[Schematron2016]  ISO/IEC 19757-3:2016 Information Technology—Document Schema Definition Language (DSDL)—Part 3: Rule-based validation—Schematron Publicly available at: http://standards.iso.org/ittf/PubliclyAvailableStandards/c055982_ISO_IEC_19757-3_2016.zip.

[RelaxNG]               ISO/IEC 19757-2:2008 Information Technology—Document Schema Definition Language (DSDL)—Part 2: Regular-grammar-based validation—RELAX NG [http://www.iso.org/iso/home/store/catalogue_tc/catalogue_detail.htm?csnumber=52348]. Publicly available at: http://standards.iso.org/ittf/PubliclyAvailableStandards/c052348_ISO_IEC_19757-2_2008(E).zip.

1.4 Non-Normative References

[DocBookTC]          OASIS Open DocBook Technical Committee, https://www.oasis-open.org/committees/docbook/.

2      Schematron rule change

The DocBook 5.0 [DocBook-5.0] RelaxNG schema utilized embedded Schematron [Schematron2006] assertions to express certain constraints that cannot be expressed in RelaxNG syntax. After DocBook 5.0  was released, a new version of Schematron [Schematron2016] was released that made two changes that affected DocBook 5.0.  The two changes were:

1.     The updated standard Schematron syntax replaced the @name attribute with an <s:title> element that serves the same purpose. 

2.     The Schematron namespace was changed from "http://www.ascc.net/xml/schematron" to "http://purl.oclc.org/dsdl/schematron".

 

The result of these changes was that the DocBook 5.0 RelaxNG schema no longer parsed properly with updated Schematron validators.

2.1 Replace @name with <s:title>

In DocBook 5.0.1, every instance of the DocBook Schematron patterns that used @name has been updated in DocBook 5.0.1 to use an <s:title> element instead.

For example, the original syntax for this pattern:

    <s:pattern name="Cardinality of segments and titles">

      <s:rule context="db:seglistitem">

         <s:assert test="count(db:seg) = count(../db:segtitle)">The number of seg elements must be the same as the number of segtitle elements in the parent segmentedlist</s:assert>

      </s:rule>

   </s:pattern>

 

was replaced with (changes highlighted in boldface):

   <s:pattern>

      <s:title>Cardinality of segments and titles</s:title>

      <s:rule context="db:seglistitem">

         <s:assert test="count(db:seg) = count(../db:segtitle)">The number of seg elements must be the same as the number of segtitle elements in the parent segmentedlist</s:assert>

      </s:rule>

   </s:pattern>

 

Note that the only change is to replace the @name attribute with an <s:title> element with the same content.  This change was applied to Schematron patterns in DocBook 5.0 with the following names:

   <s:pattern name="Glossary 'firstterm' type constraint">

   <s:pattern name="Footnote reference type constraint">

   <s:pattern name="Glossary 'glossterm' type constraint">

   <s:pattern name="Synopsis fragment type constraint">

   <s:pattern name="Glosssary 'see' type constraint">

   <s:pattern name="Glossary 'seealso' type constraint">

   <s:pattern name="Glossary term definition constraint">

   <s:pattern name="Cardinality of segments and titles">

   <s:pattern name="Root must have version">

   <s:pattern name="Element exclusion">

2.2 New Schematron namespace

The Schematron namespace was declared in two places in the DocBook, the <grammar> element and one <s:ns> element.

2.2.1 Namespace change in <grammar> element

The DocBook 5.0 RNG schema's <grammar> element was changed from:

 

  <grammar xmlns:s="http://www.ascc.net/xml/schematron" ...

 

to:

 

  <grammar xmlns:s="http://purl.oclc.org/dsdl/schematron" ...

2.2.2 Namespace change in <s:ns> element

The DocBook 5.0 RNG schema contains several rules in the Schematron namespace that declare namespaces used by the Schematron rules.  One of those declarations was for the Schematron namespace itself.  It was changed from:

 

  <s:ns prefix="s" uri="http://www.ascc.net/xml/schematron"/>

 

to:

 

  <s:ns prefix="s" uri="http://purl.oclc.org/dsdl/schematron"/>

3      Conformance

Since neither @name nor <s:title> in Schematron assertions is necessary for validating DocBook document instances, this change will not require any changes to the conformance rules for existing DocBook documents. So the Conformance section of the DocBook 5.0 [Docbook-5.0] standard is unchanged.

Appendix A. Acknowledgments

The following individuals have participated in the creation of this specification and are gratefully acknowledged:

Participants:

Robert Stayton, Sagehill Enterprises, Individual

Jirka Kosek, Individual

Appendix B. Revision History

Revision

Date

Editor

Changes Made

[Rev number]

[Rev Date]

[Modified By]

[Summary of Changes]