$Id: docbook.xml,v 1.17 2004/01/21 16:19:28 nwalsh Exp $ &name; &version; XML HTML PDF &root;specs NormanWalsh Sun Sun Microsystems, Inc.

Norman.Walsh@Sun.COM

21 Jan 2004 2001200220032004 The Organization for the Advancement of Structured Information Standards [OASIS]. All Rights Reserved. DocBook is general purpose and document type particularly well suited to books and papers about computer hardware and software (though it is by no means limited to these applications). The Version 4.3 release is a maintainance release. It introduces no backwards-incompatible changes. This &standard; was approved for publication by the OASIS DocBook Technical Committee. It represents the consensus of the committee. Please send comments on this specification to the docbook@lists.oasis-open.org list. To subscribe, send an email message to docbook-request@lists.oasis-open.org with the word subscribe as the body of the message. The errata page for this specification is at .

DocBook is general purpose XML and SGML document type 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. DocBook is officially available as a Document Type Definition (DTD) for both XML and SGML. It is unofficially available in other forms as well. The Version 4.2 release is a maintainance release. It introduces no backwards-incompatible changes. All valid DocBook 4.1 documents are also valid DocBook 4.2 documents. The DocBook Technical Committee welcomes bug reports and requests for enhancement (RFEs) from the user community. The current list of outstanding requests is available through the SourceForge tracker interface. This is also the preferred mechanism for submitting new requests. Old RFEs, from a previous legacy tracking system, are archived for reference.

The key words must, must not, required, shall, shall not, should, should not, recommended, may, and optional in this &standard; are to be interpreted as described in . Note that for reasons of style, these words are not capitalized in this document.

The DocBook document type is distributed for XML and SGML from the DocBook site at OASIS. DocBook is also available from the mirror on .

There are no backwards-incompatible changes in this release. Add floatstyle to table and informaltable per the November, 2002 meeting.

There are no backwards-incompatible changes in this release. If HTML tables are allowed, make sure that caption gets all of the HTML attributes. Refactored parameter entities for informaltable so that the initial textobject is allowed when (and only when) the CALS table model is used.

There are no backwards-incompatible changes in this release. Per the decision at the 19 Nov 2003 Technical Committee meeting, DocBook V4.3b5 is republished as DocBook V4.3CR1 (Candidate Release 1). There have been no technical changes since V4.3b5.

There are no backwards-incompatible changes in this release. Each of the changes made between DocBook V4.2b4 and DocBook XML V4.3b5 is summarized here. For complete details, consult the individual RFEs and the meeting minutes.

Made the content model of firstterm identical to glossterm.

There are no backwards-incompatible changes in this release. Each of the changes made between DocBook V4.2b3 and DocBook XML V4.3b4 is summarized here. For complete details, consult the individual RFEs and the meeting minutes.

RFE 518074: Added a number of new values to the class attribute of database. RFE 517604: Allow optional title on glosslist. RFE 507975: Revision should allow author or authorinitials. RFE 533734: Allow void to be optional on methodsynopsis, consstructorsynopsis, and destructorsynopsis. RFE 570068: Added emailmessage, webpage, and newsposting as pubwork values for citetitle. RFE 564776: Added process, service, server, and daemon to the class values of systemitem. RFE 573812: Allow blockinfo on blockquote. RFE 571998: Added initializer to paramdef. RFE 571996: Added prefix, namespace, and localname to class for sgmltag. Added StepAlternatives.

There are no backwards-incompatible changes in this release. Each of the changes made between DocBook V4.2b2 and DocBook XML V4.3b3 is summarized here. For complete details, consult the individual RFEs and the meeting minutes.

Added code inline with language attribute. Fixed oversights that removed blockinfo and textobject from CALS tables. RFE 615587: add xml:base to common attributes (2002 Nov) RFE 616216: Allow sets to be recursive. (2002 Nov) RFE 615473: Add floatstyle to figure informalfigure example informalexample equation informalequation . Fixed parameter entity declaration problems that resulted in duplicate attribute declarations for some table-related elements. Added type attribute to indexterm and index.

There are no backwards-incompatible changes in this release. Each of the changes made between DocBook V4.2 and DocBook XML V4.3b2 is summarized here. For complete details, consult the individual RFEs and the meeting minutes. There was no public beta 1 release.

Allow HTML table models in addition to CALS or SOEx table models (2003 Apr) Note: the editor has changed the content model of caption to support HTML tables with captions more directly. Support task markup (2003 Jun). Related to RFE 679316: add orgname to inlines (2003 Jul) Added function attribute to keycap for improved semantics (2003 Jul) RFE 705885: add namespace attribute to sgmltag (2003 May) RFE 691762: add language attribute to verbatim environments (2003 May) RFE 573419: add bidirectional text override (2003 Apr) RFE 565716: support for URI element (2003 Apr) RFE 660044: support continuation and startinglinenumber on verbatims (2003 Feb) RFE 655526: support modifier in funcprototype (2003 Feb) RFE 638456: support translators (2003 Feb) RFE 582822: paramdef and varargs on funcprototype (2003 Feb) RFE 473365: choice attribute for paramdef (2003 Feb) RFE 570068: new values for pubwork (2003 Jan) Added xrefstyle (2002 Dec)

This is a beta release by the editor. It has no normative status and may contain bugs.

The following backwards-incompatible changes were announced in DocBook V4.0, the DocBook Technical Committee expects to incorporate them into DocBook V5.0. Each of the changes proposed is summarized here. For complete details, consult the individual RFEs and the meeting minutes. DocBook V5.0 will be primarily an XML DTD. This will require a wide range of changes. As a result, DocBook V5.0 will more closely resemble The XML version of DocBook V4.x than the SGML version. Planned parameter entity reorganization may reduce some content models. The goal of this effort is to remove a large number of spurious elements that snuck into content models during the first parameter entity reorganization (circa DocBook 2.4). In practice the TC expects changes to have very little "real world" impact. The coords attribute will be removed from areaset. The articleinfo element will be removed from biblioentry. The contents attribute will be removed from bookinfo and setinfo. The indexdivcomponent.mix parameter entity will be restricted. Numbered figures and other elements inappropriate for an index or setindex will be removed. The revhistory element will be removed from glossterm. RFE 416415: The constant class will be removed from systemitem. The graphic and inlinegraphic elements will be removed. Tables will be restricted from full CALS Table Model to the OASIS Exchange model.

The DocBook Technical Committee expects to announce the following backwards-incompatible changes in DocBook V5.0, for eventual incorporation into DocBook V6.0. Each of the changes proposed is summarized here. For complete details, consult the individual RFEs and the meeting minutes. RFE 412476: The class attribute on productname will be #IMPLIED. RFE 482810: The content model of msgtext is far too broad. It will be reduced to the same mixture as example.mix. RFE 482811: The title element will be removed from bibliocomponent.mix (use citetitle instead). RFE 482812: The content model of citetitle will be reduced from para.char.mix to title.char.mix. RFE 482815: The synopsis element will be removed from para.char.mix. RFE 482818: Simplify the content model of toc. RFE 482819: The content models of the bibliography elements will be adjusted so that it is not possible to mix biblioset and bibliomset elements. RFE 482922: The msgtext element will be constrained to occur only inside msgset. See also RFE 482817. RFE 531851: Remove inline person name elements as proposed. RFE 531855: Remove corpname as proposed.

This appendix registers a new MIME media type, application/docbook+xml.

MIME media type name: application MIME subtype name: docbook+xml Required parameters: None. Optional parameters: charset This parameter has identical semantics to the charset parameter of the application/xml media type as specified in . Encoding considerations: By virtue of DocBook XML content being XML, it has the same considerations when sent as application/docbook+xml as does XML. See RFC 3023, Section 3.2. Security considerations: Several DocBook elements may refer to arbitrary URIs. In this case, the security issues of RFC 2396, section 7, should be considered. Interoperability considerations: None. Published specification: This media type registration is for DocBook documents as described by . Applications which use this media type: There is no experimental, vendor specific, or personal tree predecessor to application/docbook+xml, reflecting the fact that no applications currently recognize it. This new type is being registered in order to allow for the deployment of DocBook on the World Wide Web, as a first class XML application. Additional information: Magic number(s): There is no single initial octet sequence that is always present in DocBook documents. File extension(s): DocBook documents are most often identified with the extension .xml. Macintosh File Type Code(s): TEXT Person & email address to contact for further information: Norman Walsh, ndw@nwalsh.com. Intended usage: COMMON Author/Change controller: The DocBook specification is a work product of the DocBook Technical Committee at OASIS.

For documents labeled as application/docbook+xml, the fragment identifier notation is exactly that for application/xml, as specified in RFC 3023.

The following individuals were members of the committee during the formulation of this &standard;: Jeff Beal Steve Cogorno Paul Grosso Dick Hamilton Nancy Harrison Scott Hudson Mark Johnson Larry Rowland (prospective) Michael Smith Bob Stayton, Secretary Norman Walsh, Chair, Editor Copyright © The Organization for the Advancement of Structured Information Standards [OASIS] 2001, 2002, 2003, 2004. All Rights Reserved. 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's procedures with respect to rights in OASIS specifications can be found at 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 implementors or users of this specification, can be obtained from the OASIS Executive Director. OASIS invites any interested party to bring to its attention any copyrights, patents or patent applications, or other proprietary rights which may cover technology that may be required to implement this specification. Please address the information to the OASIS Executive Director. 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 paragraph are included on all such copies and derivative works. However, this document itself may not be modified in any way, such as by removing the copyright notice or references to OASIS, except as needed for the purpose of developing OASIS specifications, in which case the procedures for copyrights defined in the OASIS Intellectual Property Rights document 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 RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. OASIS has been notified of intellectual property rights claimed in regard to some or all of the contents of this specification. For more information consult the online list of claimed rights. For information on wether 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 DocBook web page () Working Draft “Candidate Release 3” 21 Jan 2004 Working Draft “Candidate Release 2” 21 Dec 2003 Working Draft “Candidate Release 1” 02 Dec 2003 Working Draft “Beta 5” 29 Oct 2003 Working Draft “Beta 4” 30 Sep 2003 Working Draft “Beta 3” 26 Sep 2003 Working Draft “Beta 2” (Beta 1 was never released.) 15 Aug 2003