Robert Stayton (firstname.lastname@example.org), Individual
Robert Stayton (email@example.com), Individual
This document is one component of a Work Product that also includes:
This document replaces or supersedes:
Update of the DocBook XML schema.
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.
Within the normative text of this document, the terms "shall", "shall not", "should", "should not", "may", "may not", "can", and "cannot" are to be interpreted as described in "Verbal forms for expressions of provisions", Clause 7 of [ISO/IEC Directives].
When referencing this document, the following citation format should be used:
The DocBook Schema Version 5.2. Edited by Robert Stayton. 19 July 2023. OASIS Committee Specification 01. https://docs.oasis-open.org/docbook/docbook/v5.2/cs01/docbook-v5.2-cs01.html. Latest stage: https://docs.oasis-open.org/docbook/docbook/v5.2/docbook-v5.2.html.
Copyright © OASIS Open 2023. All Rights Reserved.
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 Appendix E.
[All text is normative unless otherwise labeled]
DocBook is general purpose [XML] schema particularly well suited to books and papers about computer hardware and software (though it is by no means limited to these applications).
The DocBook Technical Committee maintains the DocBook schema. Starting with V5.0, DocBook is normatively available as a [RELAX NG] Schema (with some additional [Schematron] assertions).
This section provides a description of significant differences from previously published, differently numbered Versions of this specification, if any. (Detailed revision history of this numbered Version should be tracked in an Appendix.)
· Added these new synopsis elements for programming languages: enumsynopsis, macrosynopsis, packagesynopsis, typedefsynopsis, and unionsynopsis.
· New danger admonition element.
· New formalgroup element to support subfigures, etc.
· New transclusion fixup attributes.
· New class attribute on section et al to support legal sections.
· New meta element added to info.
· Added XInclude-enabled schema versions assemblyxi.rng and dbitsxi.rng.
The DocBook RELAX NG Schema is distributed with this specification at the locations described under “Additional Artifacts”. DocBook is also available from the mirror on http://docbook.org/.
DocBook 5.2 includes the following schemas:
· docbook, the main DocBook V5.2-csd01 schema.
· docbookxi, the DocBook XInclude V5.2-csd01 schema. (This schema allows XInclude elements in many places.)
· assembly, the DocBook Assembly V5.2-csd01 schema.
· assemblyxi, The DocBook Assembly XInclude V5.2-csd01 schema.
· dbits, The DocBook Internationalization Tag Set V5.2-csd01 schema.
· dbitsxi, The DocBook Internationalization Tag Set XInclude V5.2-csd01 schema.
Beginning with DocBook V5.1, topic-based authoring of documents was supported. This style of authoring creates independent units of documentation, often called topics, rather than a single narrative. In DocBook, topics can be written using the specific topic element as well as other hierarchical elements such as chapter, appendix, section, etc.
These topics can then be assembled into complete documents using the assembly schema. That schema allows the creation of an outline of references to content in other files. When the assembly is processed, the outline is filled in with the external content to form a valid DocBook document that can then be formated or otherwise processed.
The DocBook ITS schema adds elements and attributes from the Internationalization Tag Set [ITS] namespace (http://www.w3.org/2005/11/its) to provide support for internationalization and localization of DocBook documents.
The DocBook ITS schema components conform to the ITS 2.0 Recommendation produced by the World Wide Web Consortium (W3C).
Each of the DocBook schemas is available in a version that directly supports the [Xinclude] W3C Recommendation. This schema version allows the direct replacement of many DocBook elements with the xinclude element and still validate.
To ensure that a document is fully DocBook conformant, however, the document should be processed to resolve all the xinclude elements and then validated against the non-xinclude DocBook schema.
Historically, when DocBook was defined by a DTD, DocBook documents could be identified by the presence of standard public and/or system identifiers in the document type declaration. RELAX NG, the normative schema language for DocBook V5.0, does not provide any equivalent mechanism.
For systems that can make use of public identifiers, e.g., systems where the informative DTD is being used, the following public identifier should be used for DocBook V5.2: “-//OASIS//DTD DocBook V5.2//EN//XML”.
This specification normatively defines DocBook V5.2 with a RELAX NG grammar and a set of Schematron assertions. A conformant DocBook V5.2 document must be valid according to both the grammar and the assertions.
The reference documentation describes additional constraints and processing expectations. A conformant DocBook V5.2 document should respect those constraints and anticipate those processing expectations.
See http://www.relaxng.org/for a list of tools that can validate an XML document using RELAX NG. Note that not all products are capable of evaluating the Schematron assertions in the schema.
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.
The following documents are referenced in such a way that some or all of their content constitutes requirements of this document.
[ISO/IEC Directives] ISO/IEC Directives, Part 2 (Eighth edition) Principles and rules for the structure and drafting of ISO and IEC documents, International Organization for Standardization and International Electrotechnical Commission, 2018. https://www.iso.org/sites/directives/current/part2/index.xhtml.
[Xinclude] Jonathan Marsh, David Orchard, Daniel Veillard, editors. XML Inclusions (XInclude) Version 1.0 (Second Edition). World Wide Web Consortium, 15 November 2006.
[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) Version 1.1. World Wide Web Consortium, 2005.
[W3C XML Datatypes] Paul V. Biron and Ashok Malhotra, editors. XML Schema Part 2: Datatypes. World Wide Web Consortium, 2000.
[RFC 3023] IETF (Internet Engineering Task Force). RFC 3023: XML Media Types. M. Murata, S. St. Laurent, D. Kohn. 2001.
[DocBook 5: TDG] Norman Walsh. DocBook 5.0: The Definitive Guide. O'Reilly Media. April 2010.
[DocBook 5.1: TDG] Norman Walsh. DocBook 5.1: The Definitive Guide.
[DocBook 5.2: TDG] Norman Walsh. DocBook 5.2: The Definitive Guide.
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.
[DocBookXSL] Robert Stayton, DocBook XSL: The Complete Guide (Fourth Edition). Sagehill Enterprises, Santa Cruz CA, 2007.
[DocBookIssues] DocBook Issues Tracker is available on GitHub at https://github.com/docbook/docbook/issues
Several DocBook elements may refer to arbitrary URIs. In this case, consider the security issues of RFC 2396, section 7.
Substantial contributions to this document from the following individuals are gratefully acknowledged:
[Dick Hamilton, | Individual Member]
[Scott Hudson, ServiceNow, Inc. | Secretary]
[Jirka Kosek, | Individual Member]
[Larry Rowland, Hewlett Packard | Individual Member]
[Robert Stayton, Sagehill Enterprises | Chair]
[Norman Walsh | Individual Member]
[Summary of Changes]
Copyright © OASIS Open 2023. 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: [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.