oasis

The DocBook Schema Version 5.0 Errata 01

Committee Specification Draft 01 /
Public Review Draft 01

10 January 2018

Specification URIs

This version:

http://docs.oasis-open.org/docbook/specs/docbook-5.0-spec-errata01-csprd01.docx (Authoritative)

http://docs.oasis-open.org/docbook/specs/docbook-5.0-spec-errata01-csprd01.html

http://docs.oasis-open.org/docbook/specs/docbook-5.0-spec-errata01-csprd01.pdf

Previous version:

N/A

Latest version:

http://docs.oasis-open.org/docbook/specs/docbook-5.0-spec-errata01.docx (Authoritative)

http://docs.oasis-open.org/docbook/specs/docbook-5.0-spec-errata01.html

http://docs.oasis-open.org/docbook/specs/docbook-5.0-spec-errata01.pdf

Technical Committee:

OASIS DocBook TC

Chair:

Robert Stayton (bobs@sagehill.net), Individual

Editor:

Robert Stayton (bobs@sagehill.net), Individual

Related work:

This specification lists errata for:

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

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:

This document lists errata for the OASIS Standard The DocBook Schema Version 5.0.

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 Committee Specification Public Review Draft 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-5.0-Errata01]

The DocBook Schema Version 5.0 Errata 01. Edited by Robert Stayton. 10 January 2018. Committee Specification Draft 01 / Public Review Draft 01. http://docs.oasis-open.org/docbook/specs/docbook-5.0-spec-errata01-csprd01.html. Latest version: http://docs.oasis-open.org/docbook/specs/docbook-5.0-spec-errata01.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

2        Schematron rule change. 6

3        Conformance. 7

Appendix A. Acknowledgments. 8

Appendix B. Revision History. 9

 

 


1      Introduction

[All text is normative unless otherwise labeled]

1.1 IPR Policy

This Committee Specification Public Review Draft 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].

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

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

2      Schematron rule change

The DocBook RelaxNG schema utilizes embedded Schematron [Schematron] assertions to express certain constraints that cannot be expressed in RelaxNG syntax. After DocBook 5.0 [Docbook-5.0] was released, the standard syntax of one Schematron rule that DocBook 5.0 used was changed, so that the DocBook 5.0 RelaxNG schema no longer parses properly with updated Schematron validators.

The updated standard Schematron syntax replaced the @name attribute with an <s:title> element that serves the same purpose.  So every instance of the DocBook Schematron patterns that used @name has been updated 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:

      <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 10 Schematron patterns in DocBook 5.0:

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

 

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 standard is unchanged.

Appendix A. Acknowledgments

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

Participants:

Norman Walsh, MarkLogic, Individual
Robert Stayton, Sagehill Enterprises, Individual

Jirka Kosek, Individual

 

Appendix B. Revision History

Revision

Date

Editor

Changes Made