Schematron tools do not work with DocBook 5.1. This DocBook 5.1.1 specification is updated with the new Schematron rules so users can continue using DocBook 5.1 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 stage” 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.

Key words:

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

Citation format:

When referencing this document, the following citation format should be used:

[DocBook-v5.1.1]

The DocBook Schema Version 5.1.1. Edited by Robert Stayton. 09 June 2021. OASIS Committee Specification Draft 01. https://docs.oasis-open.org/docbook/docbook/v5.1.1/csd01/docbook-v5.1.1-csd01.html. Latest stage: https://docs.oasis-open.org/docbook/docbook/v5.1.1/docbook-v5.1.1.html.

Notices:

Distributed under the terms of the OASIS IPR Policy, [https://www.oasis-open.org/policies-guidelines/ipr]. For complete copyright information please see the Notices section in the Appendix.

Table of Contents

1 Introduction. 4

2 Schematron changes. 5

2.1 Add correct namespace prefix to Schematron title elements. 5

3 Conformance. 6

Appendix A. References. 7

A.1 Normative References. 7

A.2 Informative References. 7

Appendix B. Security and Privacy Considerations. 8

Appendix C. Acknowledgments. 9

C.1 Special Thanks. 9

C.2 Participants. 9

Appendix D. Revision History. 10

Appendix E. Notices. 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. DocBook Version 5.1 [DocBook-5.1] was released as a Committee Specification on 11 November 2015.

The most recent Schematron tools do not work with [DocBook-5.1]. This DocBook 5.1.1 specification is updated with the new Schematron rules so users can continue using DocBook 5.1 if they need to use newer Schematron tools. No changes were made to DocBook elements, attributes, or content models. So any document that conformed to DocBook 5.1 will still conform to DocBook 5.1.1.

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

2 Schematron changes

Certain title elements in the Schematron rules in [DocBook-5.1] had the wrong namespace prefix. This update fixes those elements to use the correct namespace.

2.1 Add correct namespace prefix to Schematron title elements

In the RelaxNG files such as docbook.rnc, there are 119 instances of a Schematron rule to ensure that a DocBook element used as a root element in a document has a version attribute. In [DocBook-5.1] those rules used the wrong namespace prefix rng: for the Schematron title element:

rng:title [ "Root must have version" ]

In all 119 instances, these were changed in this updated version to the correct s: namespace prefix :

s:title [ "Root must have version" ]

3 Conformance

Since the <s:title> in Schematron assertions is not 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.1 [DocBook-5.1] standard is unchanged.

Appendix A. References

This appendix contains the normative and informative references that are used in this document. Normative references are specific (identified by date of publication and/or edition number or Version number) and Informative references are either specific or non-specific.

While any hyperlinks included in this appendix were valid at the time of publication, OASIS cannot guarantee their long term validity.

A.1 Normative References

The following documents are referenced in such a way that some or all of their content constitutes requirements of this document.

[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

[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.

A.2 Informative References

The following referenced documents are not required for the application of this document but may assist the reader with regard to a particular subject area.

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

Appendix B. Security and Privacy Considerations

There are no security or privacy considerations in this update.

Appendix C. Acknowledgments

C.1 Special Thanks

Substantial assistance to this document from the following individuals is gratefully acknowledged:

Norman Walsh, non-TC member.

C.2 Participants

The following individuals were members of this Technical Committee during the creation of this document and their contributions are gratefully acknowledged:

Robert Stayton, Individual Member.
Scott Hudson, ServiceNow.

Appendix D. Revision History

Revisions made since the initial stage of this numbered Version of this document may be tracked here.

Revision	Date	Editor	Changes Made
[Rev number]	[Rev Date]	[Modified By]	[Summary of Changes]

Appendix E. Notices

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: [https://www.oasis-open.org/policies-guidelines/ipr].

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 AND ITS MEMBERS WILL NOT BE LIABLE FOR ANY DIRECT, INDIRECT, SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF ANY USE OF THIS DOCUMENT OR ANY PART THEREOF.

As stated in the OASIS IPR Policy, the following three paragraphs in brackets apply to OASIS Standards Final Deliverable documents (Committee Specifications, OASIS Standards, or Approved Errata).

[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 Standards Final Deliverable, 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 deliverable.]

[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 OASIS Standards Final Deliverable 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 OASIS Standards Final Deliverable. 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 OASIS Standards Final Deliverable 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 Standards Final Deliverable, 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 document, and should be used only to refer to the organization and its official outputs. OASIS welcomes reference to, and implementation and use of, documents, while reserving the right to enforce its marks against misleading uses. Please see https://www.oasis-open.org/policies-guidelines/trademark for above guidance.