From 3ae6d1b4225265e3bfbb411b0eef554ceae6d477 Mon Sep 17 00:00:00 2001 From: Norman Walsh Date: Thu, 6 Mar 2008 13:59:06 +0000 Subject: [PATCH] Updated to use new OASIS template --- docbook/relaxng/docbook/spec/Makefile | 3 +- .../OASIS_Specification_Template_v1-0.css | 324 +++ docbook/relaxng/docbook/spec/bibliography.xml | 70 + docbook/relaxng/docbook/spec/docbook.xml | 2295 ++++++++--------- docbook/relaxng/docbook/spec/html.xsl | 545 ++-- 5 files changed, 1893 insertions(+), 1344 deletions(-) create mode 100644 docbook/relaxng/docbook/spec/OASIS_Specification_Template_v1-0.css create mode 100644 docbook/relaxng/docbook/spec/bibliography.xml diff --git a/docbook/relaxng/docbook/spec/Makefile b/docbook/relaxng/docbook/spec/Makefile index 13ef1d8a4..0b4c06d07 100644 --- a/docbook/relaxng/docbook/spec/Makefile +++ b/docbook/relaxng/docbook/spec/Makefile @@ -7,6 +7,7 @@ FOSTYLE=fo.xsl XML2RFC=/share/doctypes/ietf/xml2rfc/xml2rfc.tcl RFCBASE=draft-walsh-app-docbook-xml- RFCVERSION=00 +TIDY=tidy XSLPARAM= @@ -15,7 +16,7 @@ all: docbook.html docbook.pdf docbook.html: docbook.xml html.xsl jing ../docbook.rng $< $(XSLT) $< $(HTMLSTYLE) $@ $(XSLPARAM) - tidy -q -utf8 -mn -asxml $@ + $(TIDY) -q -utf8 -mn -asxml $@ docbook.fo: docbook.xml fo.xsl jing ../docbook.rng $< diff --git a/docbook/relaxng/docbook/spec/OASIS_Specification_Template_v1-0.css b/docbook/relaxng/docbook/spec/OASIS_Specification_Template_v1-0.css new file mode 100644 index 000000000..5a3dda91e --- /dev/null +++ b/docbook/relaxng/docbook/spec/OASIS_Specification_Template_v1-0.css @@ -0,0 +1,324 @@ +.abstract { + position: relative; + font-family: Arial, Helvetica, sans-serif; + font-size: 10pt; + margin-left: 25px; + display: block; +} +.appendixheading1 { + font-family: Arial, Helvetica, sans-serif; + font-size: 18pt; + font-weight: bold; + list-style-type: upper-alpha; + color: #66116D; +} +.appendixheading2 { + font-family: Arial, Helvetica, sans-serif; + font-size: 14pt; + font-weight: bold; + list-style-type: decimal; + color: #66116D; +} +.appendixheading3 { + font-family: Arial, Helvetica, sans-serif; + font-size: 12pt; + font-weight: bold; + list-style-type: decimal; + color: #66116D; +} +.attribute { + font-family: "Courier New", Courier, mono; + font-size: 10pt; +} +.codelisting { + font-family: "Courier New", Courier, mono; + font-size: 9pt; + background-color: #9999FF; + margin-left: 10%; + margin-right: 10%; + border-top-style: solid; + border-right-style: none; + border-bottom-style: solid; + border-left-style: none; + border-top-color: #000000; + border-right-color: #000000; + border-bottom-color: #000000; + border-left-color: #000000; + white-space: pre; +} +.codelistingsmall { + font-family: "Courier New", Courier, mono; + font-size: 8pt; + background-color: #9999FF; + margin-right: 10%; + border-top-style: solid; + border-right-style: none; + border-bottom-style: solid; + border-left-style: none; + border-top-color: #000000; + border-right-color: #000000; + border-bottom-color: #000000; + border-left-color: #000000; + margin-left: 10%; + white-space: pre; +} +.codetemp { + font-family: "Courier New", Courier, mono; + font-size: 10pt; +} +.contributor { + font-family: Arial, Helvetica, sans-serif; + font-size: 10pt; + text-indent: 25px; +} +.datatype { + font-family: "Courier New", Courier, mono; + font-size: 10pt; +} +.definition { + font-family: Arial, Helvetica, sans-serif; + font-size: 10pt; + text-indent: 25px; +} +.definitionterm { + font-family: Arial, Helvetica, sans-serif; + font-size: 10pt; + font-weight: bold; +} +.element { + font-family: "Courier New", Courier, mono; + font-size: 10pt; +} +.emphasis { + font-family: Arial, Helvetica, sans-serif; + font-size: 10pt; + font-style: italic; +} +.example { + font-family: "Courier New", Courier, mono; + font-size: 9pt; + background-color: #9999FF; + margin-right: 25px; + margin-left: 25px; +} +.examplesmall { + font-family: "Courier New", Courier, mono; + font-size: 8pt; + margin-right: 25px; + margin-left: 25px; + background-color: #9999FF; +} +h1, +.heading1 { + font-family: Arial, Helvetica, sans-serif; + font-size: 18pt; + font-weight: bold; + list-style-type: decimal; + color: #66116D; +} +h2, +.heading2 { + font-family: Arial, Helvetica, sans-serif; + font-size: 14pt; + font-weight: bold; + list-style-type: decimal; + color: #66116D; +} +h3, +.heading3 { + font-family: Arial, Helvetica, sans-serif; + font-size: 13pt; + font-weight: bold; + list-style-type: decimal; + color: #66116D; +} +h4, +.heading4 { + font-family: Arial, Helvetica, sans-serif; + font-size: 12pt; + font-weight: bold; + list-style-type: decimal; + color: #66116D; +} +h5, +.heading5 { + font-family: Arial, Helvetica, sans-serif; + font-size: 11pt; + font-weight: bold; + list-style-type: decimal; + color: #66116D; +} +h6, +.heading6 { + font-family: Arial, Helvetica, sans-serif; + font-size: 10pt; + font-weight: bold; + list-style-type: decimal; + color: #66116D; +} +.keyword { + font-family: "Courier New", Courier, mono; + font-size: 10pt; + font-style: normal; +} +.listbullet { + font-family: Arial, Helvetica, sans-serif; + font-size: 10pt; + list-style-type: disc; +} +.listbullet2 { + font-family: Arial, Helvetica, sans-serif; + font-size: 10pt; + text-indent: 25px; + list-style-type: circle; +} +.listcontinue { + font-family: Arial, Helvetica, sans-serif; + font-size: 10pt; + text-indent: 25px; + margin-bottom: 0px; +} +.listcontinue2 { + font-family: Arial, Helvetica, sans-serif; + font-size: 10pt; + text-indent: 50px; +} +.normal { + font-family: Arial, Helvetica, sans-serif; + font-size: 10pt; + margin-top: 0px; +} +.note { + font-family: Arial, Helvetica, sans-serif; + font-size: 10pt; + margin-left: 50px; + margin-right: 50px; +} +.notices { + font-family: Arial, Helvetica, sans-serif; + font-size: 18pt; + font-weight: bold; + color: #66116D; +} +.ref { + font-family: Arial, Helvetica, sans-serif; + font-size: 10pt; + margin-left: 125px; + margin-top: 0px; +} +.refterm { + font-family: Arial, Helvetica, sans-serif; + font-size: 10pt; + font-weight: bold; + margin-bottom: 0px; + color: #66116D; +} +.relatedwork { + font-family: Arial, Helvetica, sans-serif; + font-size: 10pt; + text-indent: 50px; + list-style-type: disc; + list-style-position: outside; + display: list-item; + margin-top: 0px; + margin-bottom: 0px; +} +.subtitle { + font-family: Arial, Helvetica, sans-serif; + font-size: 18pt; + font-weight: bold; + color: #66116D; +} +.title { + font-family: Arial, Helvetica, sans-serif; + font-size: 24pt; + font-weight: bold; + color: #66116D; +} +.titlepageinfo { + font-family: Arial, Helvetica, sans-serif; + font-size: 10pt; + font-weight: bold; + color: #66116D; + margin-bottom: 0px; +} +.titlepageinfodescription { + font-family: Arial, Helvetica, sans-serif; + font-size: 10pt; + text-indent: 25px; + margin-top: 0px; + margin-bottom: 0px; + font-style: normal; +} +.variable { + font-family: Arial, Helvetica, sans-serif; + font-size: 10pt; + font-style: italic; +} + +/* ============================================================ */ +.head { + font-family: Arial, Helvetica, sans-serif; + font-size: 10pt; + color: #66116D; +} + +.head h1 { + font-size: 24pt; + font-weight: bold; +} + +.head h2 { + font-size: 18pt; + font-weight: bold; +} + +.head h3 { + font-weight: bold; +} + +.head dt { + margin-top: 1em; + font-weight: bold; +} + +.head dd { + color: black; + margin-left: 25px; +} + +.head p { + color: black; +} + +.head div h3 { + font-size: 10pt; +} + +.head .abstract h3 { + margin-left: -25px !important; +} + +.head .status { + margin-left: 25px; +} + +.head .status h3 { + margin-left: -25px; +} + +.head .notices { + font-size: 10pt; + font-weight: normal; +} + +.table-wrapper .title { + font-size: 12pt; + color: #66116D; +} + +.itemizedlist .title { + font-size: 12pt; + color: #66116D; +} + diff --git a/docbook/relaxng/docbook/spec/bibliography.xml b/docbook/relaxng/docbook/spec/bibliography.xml new file mode 100644 index 000000000..00538c722 --- /dev/null +++ b/docbook/relaxng/docbook/spec/bibliography.xml @@ -0,0 +1,70 @@ + + +References + + + +RELAX NGJames Clark, editor. +RELAX NG Specification (Committee Specification). OASIS. 2001. + + +XMLTim 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. + + +XLink11Steven DeRose, Eve Maler, +David Orchard, Norman Walsh, editors. +XML Linking Language (XLink) +Version 1.1. +World Wide Web Consortium, 2005. + + +RFC 2119IETF +(Internet Engineering Task Force). +RFC 2119: +Key words for use in RFCs to Indicate Requirement Levels. +S. Bradner. 1997. + +RFC 3023IETF +(Internet Engineering Task Force). +RFC 3023: XML +Media Types. +M. Murata, S. St. Laurent, D. Kohn. 2001. + + +DocBook: TDG5 +Norman Walsh and Leonard Meullner. +DocBook 5.0: +The Definitive Guide. + + +SGMLJTC 1, SC 34. +ISO 8879:1986 +Information processing -- Text and office systems -- +Standard Generalized Markup Language (SGML). 1986. + + +W3C XML SchemaHenry S. Thompson, +David Beech, Murray Maloney, et. al., editors. +XML Schema Part 1: Structures. +World Wide Web Consortium, 2000. + + +W3C XML DatatypesPaul V. Biron +and Ashok Malhotra, editors. +XML Schema Part 2: Datatypes. +World Wide Web Consortium, 2000. + + +SchematronRick Jelliffe, editor. +The Schematron Assertion Language 1.5. Rick Jelliffe and +Acedemia Sinica Computing Centre. 2001, 2001. + + + diff --git a/docbook/relaxng/docbook/spec/docbook.xml b/docbook/relaxng/docbook/spec/docbook.xml index a8d3b7190..f45970edd 100644 --- a/docbook/relaxng/docbook/spec/docbook.xml +++ b/docbook/relaxng/docbook/spec/docbook.xml @@ -18,7 +18,7 @@ $Id$ 5.0 cd - 01 + 02 @@ -26,6 +26,23 @@ $Id$ The DocBook Schema + + OASIS + OASIS DocBook Technical Committee + + + + + Norman + Walsh + + + Sun + Sun Microsystems, Inc. +
Norman.Walsh@Sun.COM
+ + + @@ -42,6 +59,14 @@ $Id$ 2008-02-06 +http://docbook.org/ns/docbook + + + + + 200120022003 200420052006 @@ -68,18 +93,19 @@ XML DTD, but the RELAX NG Schema is now the normative schema. - + Please send comments on this specification to the docbook@lists.oasis-open.org list. To subscribe, please @@ -91,6 +117,79 @@ Manager. . + + +Copyright © OASIS® 2008. 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 + +for above guidance. +
@@ -127,10 +226,7 @@ Old RFEs, from a previous legacy tracking system, are archived for reference. -
-
Terminology - The key words must, must not, required, shall, shall not, @@ -140,11 +236,35 @@ not, required, interpreted as described in . Note that for reasons of style, these words are not capitalized in this document. +
+ +
+Normative References + + + + + + + + + +
+ +
+Non-Normative References + + + + + + +
-The DocBook RELAX NG Schema V5.0 +The DocBook RELAX NG Schema The DocBook RELAX NG Schema is distributed @@ -155,1395 +275,1212 @@ DocBook is also available from the mirror on . - - -
-Changes in DocBook V5.0 - -There are no user-visible changes in 5.0 (Public Review Draft 1). + +enforces as many constraints as possible in the schema. Some additional +constraints are expressed with Schematron rules. - -This version of DocBook V5.0 will become the official Committee -Specification version of DocBook V5.0 as soon as the Technical Committee -balloting process is finished. -
- -
-Changes in DocBook V5.0CR7 - -There are no user-visible changes in 5.0CR7. Some of the sources -we reorganized to make future customization easier. - -If no bug reports are received before the November 7, 2007 -DocBook TC meeting, this version will become the official DocBook V5.0 -release. -
- -
-Changes in DocBook V5.0CR6 - -This release contains a few bug fixes and improvements over V5.0CR5. - - - -Fixed RFE 1759782: -Allow uri anywhere email occurs. - -Fixed RFE 1784312: -Allow book to be completely empty; allow personblurb -and titleabbrev in bibliographic contexts. + +cleans up the content models. + - -Fixed RFE 1795884: -Allow MathML in inlineequation. + +gives users the flexibility to extend or subset the schema in an +easy and straightforward way. + - -Fixed RFE 1800916: -Allow keycap (and friends) in userinput. + +can be used to generate XML DTD and W3C XML Schema versions of DocBook. + -
- -
-Changes in DocBook V5.0CR5 -There are no user-visible changes in DocBook V5.0CR5. -
+Under the ordinary operating rules of DocBook evolution, the +only backwards incompatible changes that could be made in DocBook V5.0 +were those announced in DocBook V4.0. In light of the fact that this +is a complete rewrite, the Technical Committee gave itself the freedom +to make unannounced backwards-incompatible changes for +this one release. -
-Changes in DocBook V5.0CR4 +
+Removing Legacy Elements -This release contains a few improvements over V5.0CR3. +A number of elements have been removed from DocBook. Many of +these have been replaced by simpler, more versatile alternatives. +Others have simply been removed because they are not believed to be +widely used: - - -Fixed RFE 1708032: -Fixed pattern naming inconsistency; changed -db.href.attribute to -db.href.attributes. + +DocBook Element Changes + +articleinfo, bookinfoinfo, …, +*info + +Replaced by info, see +. - -Fixed RFE 1700154: -Added sortas to -termdef. + + + +authorblurb + +Replaced by personblurb. This more general +name better reflects the fact that it is available in elements other +than author (e.g., editor). - -Fixed RFE 1686919: -Added an NVDL rules file. + + + +collabname, corpauthor, corpcredit +corpname + +Replaced by orgname and the updated +content models of author, editor, +and othercredit. - -Fixed RFE 1705596: -Aded db.programming.inlines -(classname, -exceptionname, -function, -initializer, -interfacename, -methodname, -modifier, -ooclass, -ooexception, -oointerface, -parameter, -returnvalue, -type, and -varname) -to the content model of code. + + + +graphic, graphicco, inlinegraphic +mediaobjectco + +Removed in favor of mediaobject and +inlinemediaobject. - -Fixed RFE 1689228: -Fixed typo in Schematron assertion. + + + +isbn, issn, pubsnumber + +Replaced by biblioid. - -
- -
-Changes in DocBook V5.0CR3 - -This release contains a few improvements over V5.0CR2. + - - -Fixed RFE 1679775: -Changed semantics of termdef. A -firstterm is now required (instead of a glossterm as -in previous releases). - - -Fixed RFE 1673820: -Adopted “http://docbook.org/xlink/role/olink” -as an XLink role value (xlink:role) to -identify OLinks expressed using XLink attributes. - - -Allow info in HTML tables. + +lot, +lotentry, +tocback, +tocchap, +tocfront, +toclevel1, +toclevel2, +toclevel3, +toclevel4, +toclevel5, +tocpart + +Replaced by simpler tocdiv element. + - -Fixed RFE 1682917: -Added pgwide attribute to -example. + + + +ulink + +Replaced by ubiquitous linking, see +. + - -Fixed RFE 1644553: -Added label attribute to CALS and -HTML tables. + + + +sgmltag + +Replaced by tag. + - -Fixed RFE 1588693: -Added an acknowledgements element, peer to -dedication, replacing ackno which had only -been available at the end of article. + + + +action, +beginpage, +highlights, +interface, +invpartnumber, +medialabel, +modespec, +structfield, +structname + +Removed. + - + +
-
-Changes in DocBook V5.0CR2 +
+Smaller Content Models -This release contains a few improvements over V5.0CR1 and a -few bug fixes. +The content models of many inlines have been reduced, sometimes +drastically. The parameter entity customization of DocBook V4.x and +previous versions resulted in very broad content models for some +inlines. - - -Fixed RFE 1630203: -Allow empty glossary. - - -Fixed RFE 1627845: -Allow optional caption on CALS table and -informaltable. - - -Related to RFE 1627845: -Allow inlines in HTML table caption. - - -Fixed RFE 1589139 -(and RFE 1621178): -Allow title and titleabbrev on qandaentry. - - - -Fixed RFE 1675932: -Restore localname, prefix -and namespace as class -attribute values on tag. - - - -Fixed RFE 1669465: -Schematron rules should refer to @xml:id, not @id. - - - -
+Consider, for example, +command in DocBook V4.4: -
-Changes in DocBook V5.0CR1 +command ::= + (#PCDATA|link|olink|ulink|action|application|classname|methodname| + interfacename|exceptionname|ooclass|oointerface|ooexception| + command|computeroutput|database|email|envar|errorcode|errorname| + errortype|errortext|filename|function|guibutton|guiicon|guilabel| + guimenu|guimenuitem|guisubmenu|hardware|interface|keycap|keycode| + keycombo|keysym|literal|code|constant|markup|medialabel| + menuchoice|mousebutton|option|optional|parameter|prompt|property| + replaceable|returnvalue|sgmltag|structfield|structname|symbol| + systemitem|uri|token|type|userinput|varname|nonterminal|anchor| + remark|subscript|superscript|inlinegraphic|inlinemediaobject| + indexterm|beginpage)* -This release contains a few improvements over V5.0b9 and a -few bug fixes. +In DocBook V5.0, command has a much smaller, more +rational content model: - - -Made the content model of blockquote broader. It was -restricted too far in the transition to 5.0. - - -Fixed RFE 1575537: -Allow markup from other namespaces in info. - - -Fix the content model of ackno so that it's the same -as DocBook 4.x. - - -Fix bug where caption was accidentally allowed in -CALS tables. - - +command ::= + + * Zero or more of: + o text + o alt + o anchor + o annotation + o biblioref + o indexterm + o inlinemediaobject + o link + o phrase + o remark + o replaceable + o subscript + o superscript + o xref + +DocBook V5.0 may be overzealous in its simplification of content +models. The Technical Committee expects to adjust these simplifications +during user testing. Users are encouraged to report places where formally +valid documents can no longer be made valid because content models have +been reduced.
-
-Changes in DocBook V5.0b9 +
+Uniform Info Elements -This release contains several improvements over V5.0b8. +DocBook V4.x has setinfo, +bookinfo, chapterinfo, +appendixinfo, sectioninfo, etc. +DocBook would be smaller and simpler if it had a single +info element in all these places. - - -Fixed RFE 1537424: -Allow jobtitle inline. - - -Fixed typo; titles are now required on task, -consistent with DocBook V4.x. - - -Fixed RFE 1554914: -Make targetdoc attribute on olink -optional. - - -Fixed RFE 1568417: -Don't generate duplicate Schematron rules. - - - -Fixed RFE 1568419: -Inverted Schematron assertion for termdef. - - - +There’s an historical reason for the large number of unique +names: customizers might very well want to adjust the content models +of info elements at different levels. For example, a copyright +statement might be required at the book level, or an author +forbidden at the sub-section level. In DTDs, there’s only one content +model allowed per element name, so in order to support independent +customization, each info element must have a different name. + +In RELAX NG, no such limitation exists. We can use patterns to +achieve both a single info element while still allowing +customizers to change its content model in different contexts. In light +of this functionality, we've replaced all the various flavors of info +with a single element name.
-
-Changes in DocBook V5.0b8 +
+Required Titles -This release contains several improvements over V5.0b7. +DocBook V5.0 enforces the constraint that titles are required on +articles and other large structures where they are +effectively optional in DocBook V4.x. (They are optional only in the sense +that DTDs are unable to enforce the constraint that they be present, the +documentation has always made it clear that titles were required.) - - -Fixed RFE 1535166: -Improve the data types of attributes in DocBook. - +
- -Fixed RFE 1549632: -The inlineequation element should use -inlinemediaobject not mediaobject. - +
+Required Version - -A number of small documentation improvements in the area of -attribute and attribute enumerations. - - -
+In DocBook V4.x and earlier, the presence of a document type declaration +served as a mechanism for identifying the DocBook version of a document. +Although the declaration was not actually required, it was present in the +vast majority of DocBook documents. -
-Changes in DocBook V5.0b7 +In RELAX NG, no similar declaration exists. Although a document type +declaration might still be present, it seems likely that this will not usually +be the case. -This release contains several improvements over V5.0b6. +Nevertheless, downstream processors may benefit from some indication +of the version of DocBook being used. As a result DocBook V5.0 adds a new +version attribute which +must be present on the document element of a DocBook +document. + +Mixing versions is explicitly allowed and the version attribute +may be used on other elements as well. This might be the case, for +example, in a compound document constructed from multiple documents each +with its own version. - - -Fixed RFE 1520074: -Define separate patterns for all the effectivity attributes to make -customization easier. - - -Attempted to address -RFE 1512505: -Added an audience effectivity attribute. - - - -Rename audience, -origin, and level -on simplemsgentry to msgaud, -msgorig, and msglevel, -respectively. This is a better parallel with the descendent elements of -msgentry and avoids a conflict with the newly introduced -audience effectivity attribute. - - -Added startinglinenumber attribute -to orderedlist. - - - -Fixed bug where one of fileref or -entityref was required on -imagedata even when the content was inline MathML or SVG. - - -
-
-Changes in DocBook V5.0b6 +
+Co-Constraints -This release contains several improvements over V5.0b5. +DocBook V5.0 enforces attribute co-constraints such as the +class/otherclass +attributes on biblioid. - - -Fixed RFE 1434294: -Allow MathML and SVG in imagedata. Note: SVG is no longer -allowed as an alternative to imagedata. -The alignment, scaling, and other presentational attributes are on -imagedata so it seems more reasonable to allow SVG and MathML -inside it. - +
- -Fixed RFE 1468921: -Add person element. Added person and org. - - +
+Improved HTML and CALS Table Support - -Fixed RFE 1306027: -Support for aspect-oriented programming. Allow modifier to -appear in more places, and allow xml:space -on modifier. - - +In DocBook V5.0, HTML tables and CALS tables are independently specified. +Where the DTD of DocBook V4.x allows for incoherent mixing of the two +models, DocBook V5.0 forbids such mixtures. - -Added db.publishing.inlines to -db.bibliographic.elements so that, for example, -foreignphrase can be used in bibliomixed. - - -
-
-Changes in DocBook V5.0b5 - -This release contains several improvements over V5.0b4. +
+Data Types - - -Restored the class attribute on -refmiscinfo (removing the type -attribute introduced in -V5.0b4). The class -attribute is now an enumerated list with the standard -otherclass extension point. - +DocBook V5.0 adds a few simple data types. For example, the +cols attribute on tgroup +must be a positive integer. - -Added parameter to db.technical.inlines. -This allows parameter to occur in places like -userinput and computeroutput. +Some of these constraints, such as the requirement that elements +like pubdate include a proper date-time type, may +prove controversial. Users are encouraged to report places where formally +valid documents can no longer be made valid because data types have been +introduced. - +
- -Allow XInclude elements in info elements (in the -docbookxi schemas). - - +
+Universal Linking - -Fixed bugs in the build process that resulted in broken DTD versions -of beta 4 and earlier betas. - - +Starting with DocBook V5.0, the +linkend and +xlink:href attributes are available on +almost all elements. -
-
-Changes in DocBook V5.0b4 +The linkend attribute provides an +ID/IDREF link within the document. The +xlink:href attribute provides a URI-based +link. -This release contains several improvements over V5.0b3. +The ulink element has been removed from +DocBook as URI-based links can now be achieved directly from +the appropriate inline (such as productname or +command). For instances where no specific semantic +inline is needed, link is still available. Where +link used to be limited to ID/IDREF linking, it now +sports an xlink:href attribute as +well. - - -Fixed RFE 1416903: -Added a cover element to hold additional material for -document covers. Updated reference documentation. - - +Support for +extended links +are provided through the +extendedlink, arc, and +locator elements. - -Corrected a typo in the list of values allowed on the -class attribute of biblioid: -changed “pubnumber” to “pubsnumber” (note the “s”). This is consistent -with its use as a replacement for the pubsnumber tag that -has been removed in DocBook V5.0. - +
- -Fixed a bug in the content model of the various “info” -elements. In previous beta releases, the title-related elements -(title, titleabbrev, and subtitle) -were erroneously required to appear first. The requirement is only that -they appear exactly or at most once, depending on the context. - +
+Improved Accessibility - -Renamed the “sgmlcomment” attribute -value of the class attribute of -tag. There's no significant difference between XML and -SGML comments and the “SGML” name implies that there ought to be -an “xmlcomment” value, which there is not. -The new value is simply “comment”. - - +Accessibility is improved by allowing both inline and block +annotations in most context. The alt element is now +allowed in most places for inline annotations, the new element +annotation supports block annotations. - -Renamed the “class” attribute of -refmiscinfo. The DocBook semantics of class attributes is -that they have enumerated values. This attribute should always have -been called “type” as it is now. - - +
- -Updated renderas on -bridgehead and class on -othercredit to have “attribute/otherattribute” co-constraints. -(In other words, if you select “other” for -renderas on bridgehead -or class on othercredit, -you have to also provide a value for otherrenderas -or othercredit, respectively. - +
+Simplified Table of Contents Markup - -Changed width attribute in media objects -to be “text” instead of “xs:integer”. - - +The DocBook V4.x markup for Tables of Contents, or more generally for +Lists of Titles, was complex and had not evolved quite in step with the +rest of DocBook. In DocBook V5.0, it has all been replaced by a quite +simple, recursive +toc/tocdiv/tocentry +structure. - -Fixed bug in the build process that resulted in unusable XML -Schema versions of beta 2 and beta 3. - - +While most Tables of Contents and Lists of Titles are generated +automatically and authors never have to produce markup for them by +hand, this simplified content model should make it easier for authors +to generate them when necessary. One possible application of hand-authored +toc markup is to generate custom hierarchies which +can be assembled on-the-fly from a library of topics marked up in +DocBook. +
- -Improved reference documentation for attributes on many elements. - - - +
+Extra-Grammatical Constraints + +Grammar based validation technologies (like RELAX NG) and rule based +validation technologies (like Schematron) are naturally complementary. Mixing +them allows us to play to the strengths of each without stretching either +to enforce constraints that they aren’t readily designed to enforce. + +For example, DocBook NG requires that the root element of a +document have an explicit version attribute. Because there are a great +many elements that can be root elements in DocBook, and because they +can almost all appear as descendants of a root element as well, it +would be tedious to express this constraint in RELAX NG. But it is +easy in a rule-based schema language. +DocBook V5.0 uses Schematron where appropriate.
-
-Changes in DocBook V5.0b3 +
+Customization -This release contains several small improvements over V5.0b2. +From the very beginning, one of the goals of DocBook has been +that users should be able to produce customizations that are either +subsets of extensions of DocBook. - - -Fixed RFE 1358844: -allow multiple imageobjects inside an -imageobjectco. Updated reference documentation. - - +Customization is possible in DocBook V4.x, but because of the +intricacies of XML DTD syntax and the complex and highly stylized +patterns of parameter entitiy usage in DocBook, it's not as easy as we +would like it to be. - -Restored default values to the -type attribute on simplelist -and the choice and -rep attributes on -methodparam, -arg, and -group. Fixed a bug in paramdef where -plain was accidentally allowed as a -choice. These defaults are reflected in the -generated XML DTD as well. - +In DocBook V5.0, we hope to take advantage of RELAX NGs more +robust design (and it's lack of pernicious determinism rules) to make +customization easier. - -Reduced the content model of blockquote which seemed -way too broad. - +Three schema design patterns get us most of the way there. - -Improved reference documentation for attributes on many elements. - - - +
+Logical Groupings + +DocBook elements, particularly the inlines, can be divided into +broad classes: general purpose, technical, error-related, operating-system +related, bibliographic, publishing, etc. In DocBook V5.0, these are collected +together in named patterns. + +To add a new inline, endpoint for example, +to the list of technical inlines, one need only extend the appropriate +pattern. If an element should appear in several classes, they can all +be extended in the same way: + +db.technical.inlines |= endpoint +db.programming.inlines |= endpoint +db.os.inlines |= endpoint +Much the same concept was used in DocBook V4.x, where instead of +patterns we had parameter entities. However, the constraints of DTD +validation severely limit the circumstances under which an element can +appear twice in a content model. That meant that adding an element to +one parameter entity might make it an error to add it to another. Such +constraints do not exist in RELAX NG which greatly simplifies the +customization.
-
-Changes in DocBook V5.0b2 -This release addresses several bugs identified in V5.0b1. +
+Element Definitions - - -When SVG or MathML are used, allow more than one element from the -respective namespace to be used in the appropriate location. - - - -Fixed RFE 1356238: -the xrefstyle attribute on -olink is now “text” rather than -“xsd:IDREF”. - - - -Fixed RFE 1380477: -Make xml:id optional on -areas within areaset; allow linking attributes on -areaset; establish the semantics that an area -inside an areaset inherits its linking attributes from the -areaset if it doesn't have linking attributes of its own. - - -Allow alt inside equation, -informalequation, and inlineequation. - - - -Fixed RFE 1356254: -dbforms.rnc schema now supports the HTML form elements. - - - +Each element in DocBook V5.0 is defined by its own pattern. To +change the content model of an element, only that pattern need be +redefined. To remove an element from DocBook, that pattern can be +redefined as notAllowed.
-
-Changes in DocBook V5.0 -In V5.0, DocBook has been rewritten as a native RELAX NG -grammar. The goals of this redesign were to produce a schema -that: +
+Attribute Definitions - - -“feels like” DocBook. Most existing documents should still be -valid or it should be possible to transform them in simple, mechanical -ways into valid documents. - - - -enforces as many constraints as possible in the schema. Some additional -constraints are expressed with Schematron rules. - - - -cleans up the content models. - - - -gives users the flexibility to extend or subset the schema in an -easy and straightforward way. - - - -can be used to generate XML DTD and W3C XML Schema versions of DocBook. - - - +Each attribute list in DocBook V5.0 is defined by its own +pattern. To change the list of attributes available on an element, +only that pattern need be redefined. To remove all the attributes, +that pattern can be redefined as +empty. -Under the ordinary operating rules of DocBook evolution, the -only backwards incompatible changes that could be made in DocBook V5.0 -were those announced in DocBook V4.0. In light of the fact that this -is a complete rewrite, the Technical Committee gave itself the freedom -to make unannounced backwards-incompatible changes for -this one release. +
+
-
-Removing Legacy Elements +
+Conversion -A number of elements have been removed from DocBook. Many of -these have been replaced by simpler, more versatile alternatives. -Others have simply been removed because they are not believed to be -widely used. +There’s an XSLT 1.0 stylesheet for performing conversion from +DocBook V4.x to DocBook V5.0. Presented with a valid DocBook V4.x document, +it attempts to produce a valid DocBook V5.0 document. - -DocBook Element Changes - - - - Element(s) - Explanation - - - - - -articleinfo -bookinfoinfo -… -*info - -Replaced by info, see -. - - - - - -authorblurb - -Replaced by personblurb. This more general -name better reflects the fact that it is available in elements other -than author (e.g., editor). - - - - - -collabname -corpauthor -corpcredit -corpname - -Replaced by orgname and the updated -content models of author, editor, -and othercredit. - - - - - -graphic -graphicco -inlinegraphic -mediaobjectco - -Removed in favor of mediaobject and -inlinemediaobject. - - - - - -isbn -issn -pubsnumber - -Replaced by biblioid. - - - - - -lot -lotentry -tocback -tocchap -tocfront -toclevel1 -toclevel2 -toclevel3 -toclevel4 -toclevel5 -tocpart - -Replaced by simpler tocdiv element. - - - - - -ulink - -Replaced by ubiquitous linking, see -. - - - - - -sgmltag - -Replaced by tag. - - - - - -action -beginpage -highlights -interface -invpartnumber -medialabel -modespec -structfield -structname - -Removed. - - - - -
+It succeeds entirely automatically for the most part, though human +intervention is suggested for constructs that might have multiple +interpretations (and therefore multiple possible transformations). +Users are encouraged to report documents that are not +successfully transformed by the stylesheet, especially those which do +have valid DocBook V5.0 representations. + +
-
-Smaller Content Models +
+Release Notes -The content models of many inlines have been reduced, sometimes -drastically. The parameter entity customization of DocBook V4.x and -previous versions resulted in very broad content models for some -inlines. +See 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. -Consider, for example, -command in DocBook V4.4: +
-command ::= - (#PCDATA|link|olink|ulink|action|application|classname|methodname| - interfacename|exceptionname|ooclass|oointerface|ooexception| - command|computeroutput|database|email|envar|errorcode|errorname| - errortype|errortext|filename|function|guibutton|guiicon|guilabel| - guimenu|guimenuitem|guisubmenu|hardware|interface|keycap|keycode| - keycombo|keysym|literal|code|constant|markup|medialabel| - menuchoice|mousebutton|option|optional|parameter|prompt|property| - replaceable|returnvalue|sgmltag|structfield|structname|symbol| - systemitem|uri|token|type|userinput|varname|nonterminal|anchor| - remark|subscript|superscript|inlinegraphic|inlinemediaobject| - indexterm|beginpage)* + +The DocBook Media Type -In DocBook V5.0, command has a much smaller, more -rational content model: +This appendix registers a new MIME media type, +application/docbook+xml. -command ::= +
+Registration of MIME media type application/docbook+xml - * Zero or more of: - o text - o alt - o anchor - o annotation - o biblioref - o indexterm - o inlinemediaobject - o link - o phrase - o remark - o replaceable - o subscript - o superscript - o xref + + +MIME media type name: + +application + + + -DocBook V5.0 may be overzealous in its simplification of content -models. The Technical Committee expects to adjust these simplifications -during user testing. Users are encouraged to report places where formally -valid documents can no longer be made valid because content models have -been reduced. -
+ +MIME subtype name: + +docbook+xml + + + -
-Uniform Info Elements + +Required parameters: + +None. + + + -DocBook V4.x has setinfo, -bookinfo, chapterinfo, -appendixinfo, sectioninfo, etc. -DocBook would be smaller and simpler if it had a single -info element in all these places. + +Optional parameters: + + + + charset + -There’s an historical reason for the large number of unique -names: customizers might very well want to adjust the content models -of info elements at different levels. For example, a copyright -statement might be required at the book level, or an author -forbidden at the sub-section level. In DTDs, there’s only one content -model allowed per element name, so in order to support independent -customization, each info element must have a different name. + This parameter has identical semantics to the charset +parameter of the application/xml media type as +specified in or its successors. + + + + + + -In RELAX NG, no such limitation exists. We can use patterns to -achieve both a single info element while still allowing -customizers to change its content model in different contexts. In light -of this functionality, we've replaced all the various flavors of info -with a single element name. -
+ +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 , Section 3.2. + + + -
-Required Titles + +Security considerations: + +Several DocBook elements may refer to arbitrary URIs. +In this case, the security issues of RFC 2396, section 7, +should be considered. + + -DocBook V5.0 enforces the constraint that titles are required on -articles and other large structures where they are -effectively optional in DocBook V4.x. (They are optional only in the sense -that DTDs are unable to enforce the constraint that they be present, the -documentation has always made it clear that titles were required.) + +Interoperability considerations: + +None. + + -
+ +Published specification: + +This media type registration is for DocBook documents as described by +. + + -
-Required Version + +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. + + + -In DocBook V4.x and earlier, the presence of a document type declaration -served as a mechanism for identifying the DocBook version of a document. -Although the declaration was not actually required, it was present in the -vast majority of DocBook documents. + +Additional information: + + + + Magic number(s): -In RELAX NG, no similar declaration exists. Although a document type -declaration might still be present, it seems likely that this will not usually -be the case. + + There is no single initial octet sequence that is always present in +DocBook documents. + + + -Nevertheless, downstream processors may benefit from some indication -of the version of DocBook being used. As a result DocBook V5.0 adds a new -version attribute which -must be present on the document element of a DocBook -document. + + File extension(s): + + DocBook documents are most often identified with the extension +.xml. + + + -Mixing versions is explicitly allowed and the version attribute -may be used on other elements as well. This might be the case, for -example, in a compound document constructed from multiple documents each -with its own version. + + Macintosh File Type Code(s): + + TEXT + + + + + -
+ +Person & email address to contact for further information: + +Norman Walsh, ndw@nwalsh.com. + + -
-Co-Constraints + +Intended usage: + +COMMON + + -DocBook V5.0 enforces attribute co-constraints such as the -class/otherclass -attributes on biblioid. + +Author/Change controller: + +The DocBook specification is a work product of the DocBook +Technical Committee at OASIS. + + + +
+ +
+Fragment Identifiers +For documents labeled as +application/docbook+xml, +the fragment +identifier notation is exactly that for +application/xml, +as specified in or its successors.
+ -
-Improved HTML and CALS Table Support + +Acknowledgements -In DocBook V5.0, HTML tables and CALS tables are independently specified. -Where the DTD of DocBook V4.x allows for incoherent mixing of the two -models, DocBook V5.0 forbids such mixtures. +The following individuals have participated in the creation of +this specification and are gratefully acknowledged: -
+ +Participants +Steve Cogorno, Sun Microsystems +Gary Cornelius, Individual +Adam Di Carlo, Debian +Paul Grosso, Arbortext +Dick Hamilton, Individual +Nancy Harrison, IBM +Scott Hudson, Individual +Mark Johnson, Debian +Gershon Joseph, Tech-Tav Documentation Ltd. +Jirka Kosek, Individual +Larry Rowland, Hewlett-Packard +Michael Smith, Individual +Robert Stayton, Individual (Secretary) +Norman Walsh, Sun Microsystems (Chair, Editor) + + -
-Data Types + +Revision History -DocBook V5.0 adds a few simple data types. For example, the -cols attribute on tgroup -must be a positive integer. + -The ulink element has been removed from -DocBook as URI-based links can now be achieved directly from -the appropriate inline (such as productname or -command). For instances where no specific semantic -inline is needed, link is still available. Where -link used to be limited to ID/IDREF linking, it now -sports an xlink:href attribute as -well. +
+Changes in DocBook V5.0 -Support for -extended links -are provided through the -extendedlink, arc, and -locator elements. +There are no user-visible changes in 5.0 (Public Review Draft 1). + +This version of DocBook V5.0 will become the official Committee +Specification version of DocBook V5.0 as soon as the Technical Committee +balloting process is finished.
-
-Improved Accessibility +
+Changes in DocBook V5.0CR7 -Accessibility is improved by allowing both inline and block -annotations in most context. The alt element is now -allowed in most places for inline annotations, the new element -annotation supports block annotations. +There are no user-visible changes in 5.0CR7. Some of the sources +we reorganized to make future customization easier. +If no bug reports are received before the November 7, 2007 +DocBook TC meeting, this version will become the official DocBook V5.0 +release.
-
-Simplified Table of Contents Markup +
+Changes in DocBook V5.0CR6 -The DocBook V4.x markup for Tables of Contents, or more generally for -Lists of Titles, was complex and had not evolved quite in step with the -rest of DocBook. In DocBook V5.0, it has all been replaced by a quite -simple, recursive -toc/tocdiv/tocentry -structure. +This release contains a few bug fixes and improvements over V5.0CR5. -While most Tables of Contents and Lists of Titles are generated -automatically and authors never have to produce markup for them by -hand, this simplified content model should make it easier for authors -to generate them when necessary. One possible application of hand-authored -toc markup is to generate custom hierarchies which -can be assembled on-the-fly from a library of topics marked up in -DocBook. + + +Fixed RFE 1759782: +Allow uri anywhere email occurs. + + +Fixed RFE 1784312: +Allow book to be completely empty; allow personblurb +and titleabbrev in bibliographic contexts. + + +Fixed RFE 1795884: +Allow MathML in inlineequation. + + +Fixed RFE 1800916: +Allow keycap (and friends) in userinput. + +
-
-Extra-Grammatical Constraints - -Grammar based validation technologies (like RELAX NG) and rule based -validation technologies (like Schematron) are naturally complementary. Mixing -them allows us to play to the strengths of each without stretching either -to enforce constraints that they aren’t readily designed to enforce. - -For example, DocBook NG requires that the root element of a -document have an explicit version attribute. Because there are a great -many elements that can be root elements in DocBook, and because they -can almost all appear as descendants of a root element as well, it -would be tedious to express this constraint in RELAX NG. But it is -easy in a rule-based schema language. +
+Changes in DocBook V5.0CR5 -DocBook V5.0 uses Schematron where appropriate. +There are no user-visible changes in DocBook V5.0CR5.
-
-Customization - -From the very beginning, one of the goals of DocBook has been -that users should be able to produce customizations that are either -subsets of extensions of DocBook. +
+Changes in DocBook V5.0CR4 -Customization is possible in DocBook V4.x, but because of the -intricacies of XML DTD syntax and the complex and highly stylized -patterns of parameter entitiy usage in DocBook, it's not as easy as we -would like it to be. +This release contains a few improvements over V5.0CR3. -In DocBook V5.0, we hope to take advantage of RELAX NGs more -robust design (and it's lack of pernicious determinism rules) to make -customization easier. + + +Fixed RFE 1708032: +Fixed pattern naming inconsistency; changed +db.href.attribute to +db.href.attributes. + + + +Fixed RFE 1700154: +Added sortas to +termdef. + + + +Fixed RFE 1686919: +Added an NVDL rules file. + + + +Fixed RFE 1705596: +Aded db.programming.inlines +(classname, +exceptionname, +function, +initializer, +interfacename, +methodname, +modifier, +ooclass, +ooexception, +oointerface, +parameter, +returnvalue, +type, and +varname) +to the content model of code. + + + +Fixed RFE 1689228: +Fixed typo in Schematron assertion. + + + +
-Three schema design patterns get us most of the way there. +
+Changes in DocBook V5.0CR3 -
-Logical Groupings +This release contains a few improvements over V5.0CR2. -DocBook elements, particularly the inlines, can be divided into -broad classes: general purpose, technical, error-related, operating-system -related, bibliographic, publishing, etc. In DocBook V5.0, these are collected -together in named patterns. + + +Fixed RFE 1679775: +Changed semantics of termdef. A +firstterm is now required (instead of a glossterm as +in previous releases). + + +Fixed RFE 1673820: +Adopted “http://docbook.org/xlink/role/olink” +as an XLink role value (xlink:role) to +identify OLinks expressed using XLink attributes. + + +Allow info in HTML tables. + + +Fixed RFE 1682917: +Added pgwide attribute to +example. + + +Fixed RFE 1644553: +Added label attribute to CALS and +HTML tables. + + +Fixed RFE 1588693: +Added an acknowledgements element, peer to +dedication, replacing ackno which had only +been available at the end of article. + + +
-To add a new inline, endpoint for example, -to the list of technical inlines, one need only extend the appropriate -pattern. If an element should appear in several classes, they can all -be extended in the same way: +
+Changes in DocBook V5.0CR2 -db.technical.inlines |= endpoint -db.programming.inlines |= endpoint -db.os.inlines |= endpoint - +This release contains a few improvements over V5.0CR1 and a +few bug fixes. -Much the same concept was used in DocBook V4.x, where instead of -patterns we had parameter entities. However, the constraints of DTD -validation severely limit the circumstances under which an element can -appear twice in a content model. That meant that adding an element to -one parameter entity might make it an error to add it to another. Such -constraints do not exist in RELAX NG which greatly simplifies the -customization. + + +Fixed RFE 1630203: +Allow empty glossary. + + +Fixed RFE 1627845: +Allow optional caption on CALS table and +informaltable. + + +Related to RFE 1627845: +Allow inlines in HTML table caption. + + +Fixed RFE 1589139 +(and RFE 1621178): +Allow title and titleabbrev on qandaentry. + + + +Fixed RFE 1675932: +Restore localname, prefix +and namespace as class +attribute values on tag. + + + +Fixed RFE 1669465: +Schematron rules should refer to @xml:id, not @id. + + +
-
-Element Definitions +
+Changes in DocBook V5.0CR1 -Each element in DocBook V5.0 is defined by its own pattern. To -change the content model of an element, only that pattern need be -redefined. To remove an element from DocBook, that pattern can be -redefined as notAllowed. +This release contains a few improvements over V5.0b9 and a +few bug fixes. + + +Made the content model of blockquote broader. It was +restricted too far in the transition to 5.0. + + +Fixed RFE 1575537: +Allow markup from other namespaces in info. + + +Fix the content model of ackno so that it's the same +as DocBook 4.x. + + +Fix bug where caption was accidentally allowed in +CALS tables. + +
-
-Attribute Definitions +
+Changes in DocBook V5.0b9 -Each attribute list in DocBook V5.0 is defined by its own -pattern. To change the list of attributes available on an element, -only that pattern need be redefined. To remove all the attributes, -that pattern can be redefined as -empty. +This release contains several improvements over V5.0b8. + + +Fixed RFE 1537424: +Allow jobtitle inline. + + +Fixed typo; titles are now required on task, +consistent with DocBook V4.x. + + +Fixed RFE 1554914: +Make targetdoc attribute on olink +optional. + + +Fixed RFE 1568417: +Don't generate duplicate Schematron rules. + + + +Fixed RFE 1568419: +Inverted Schematron assertion for termdef. + + +
-
- -
-Conversion - -There’s an XSLT 1.0 stylesheet for performing conversion from -DocBook V4.x to DocBook V5.0. Presented with a valid DocBook V4.x document, -it attempts to produce a valid DocBook V5.0 document. -It succeeds entirely automatically for the most part, though human -intervention is suggested for constructs that might have multiple -interpretations (and therefore multiple possible transformations). +
+Changes in DocBook V5.0b8 -Users are encouraged to report documents that are not -successfully transformed by the stylesheet, especially those which do -have valid DocBook V5.0 representations. - -
-
-
+This release contains several improvements over V5.0b7. -
-Release Notes + + +Fixed RFE 1535166: +Improve the data types of attributes in DocBook. + -See 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. + +Fixed RFE 1549632: +The inlineequation element should use +inlinemediaobject not mediaobject. + + +A number of small documentation improvements in the area of +attribute and attribute enumerations. + +
- -The DocBook Media Type - -This appendix registers a new MIME media type, -application/docbook+xml. +
+Changes in DocBook V5.0b7 -
-Registration of MIME media type application/docbook+xml +This release contains several improvements over V5.0b6. - - -MIME media type name: - -application - + + +Fixed RFE 1520074: +Define separate patterns for all the effectivity attributes to make +customization easier. - - - -MIME subtype name: - -docbook+xml + +Attempted to address +RFE 1512505: +Added an audience effectivity attribute. - - - -Required parameters: - -None. - + +Rename audience, +origin, and level +on simplemsgentry to msgaud, +msgorig, and msglevel, +respectively. This is a better parallel with the descendent elements of +msgentry and avoids a conflict with the newly introduced +audience effectivity attribute. - - - -Optional parameters: - - - - charset - - - This parameter has identical semantics to the charset -parameter of the application/xml media type as -specified in or its successors. + +Added startinglinenumber attribute +to orderedlist. - - - - - - -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 , Section 3.2. + +Fixed bug where one of fileref or +entityref was required on +imagedata even when the content was inline MathML or SVG. - + +
- -Security considerations: - -Several DocBook elements may refer to arbitrary URIs. -In this case, the security issues of RFC 2396, section 7, -should be considered. - - +
+Changes in DocBook V5.0b6 - -Interoperability considerations: - -None. +This release contains several improvements over V5.0b5. + + + +Fixed RFE 1434294: +Allow MathML and SVG in imagedata. Note: SVG is no longer +allowed as an alternative to imagedata. +The alignment, scaling, and other presentational attributes are on +imagedata so it seems more reasonable to allow SVG and MathML +inside it. - - -Published specification: - -This media type registration is for DocBook documents as described by -. + +Fixed RFE 1468921: +Add person element. Added person and org. + - - -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. + +Fixed RFE 1306027: +Support for aspect-oriented programming. Allow modifier to +appear in more places, and allow xml:space +on modifier. - - -Additional information: - - - - Magic number(s): + +Added db.publishing.inlines to +db.bibliographic.elements so that, for example, +foreignphrase can be used in bibliomixed. + + + +
- - There is no single initial octet sequence that is always present in -DocBook documents. - - - +
+Changes in DocBook V5.0b5 - - File extension(s): - - DocBook documents are most often identified with the extension -.xml. - - - +This release contains several improvements over V5.0b4. - - Macintosh File Type Code(s): - - TEXT - - - + + +Restored the class attribute on +refmiscinfo (removing the type +attribute introduced in +V5.0b4). The class +attribute is now an enumerated list with the standard +otherclass extension point. - - -Person & email address to contact for further information: - -Norman Walsh, ndw@nwalsh.com. + +Added parameter to db.technical.inlines. +This allows parameter to occur in places like +userinput and computeroutput. + - - -Intended usage: - -COMMON + +Allow XInclude elements in info elements (in the +docbookxi schemas). + - - -Author/Change controller: - -The DocBook specification is a work product of the DocBook -Technical Committee at OASIS. + +Fixed bugs in the build process that resulted in broken DTD versions +of beta 4 and earlier betas. - - + +
+
+Changes in DocBook V5.0b4 -
-Fragment Identifiers +This release contains several improvements over V5.0b3. -For documents labeled as -application/docbook+xml, -the fragment -identifier notation is exactly that for -application/xml, -as specified in or its successors. -
- + + +Fixed RFE 1416903: +Added a cover element to hold additional material for +document covers. Updated reference documentation. + + - -OASIS DocBook Technical Committee + +Corrected a typo in the list of values allowed on the +class attribute of biblioid: +changed “pubnumber” to “pubsnumber” (note the “s”). This is consistent +with its use as a replacement for the pubsnumber tag that +has been removed in DocBook V5.0. + -The following individuals were members of the committee during -the formulation of this &standard;: + +Fixed a bug in the content model of the various “info” +elements. In previous beta releases, the title-related elements +(title, titleabbrev, and subtitle) +were erroneously required to appear first. The requirement is only that +they appear exactly or at most once, depending on the context. + - -Steve Cogorno, Sun Microsystems -Gary Cornelius, Individual -Adam Di Carlo, Debian -Paul Grosso, Arbortext -Dick Hamilton, Individual -Nancy Harrison, IBM -Scott Hudson, Individual -Mark Johnson, Debian -Gershon Joseph, Tech-Tav Documentation Ltd. -Jirka Kosek, Individual -Larry Rowland, Hewlett-Packard -Michael Smith, Individual -Robert Stayton, Individual (Secretary) -Norman Walsh, Sun Microsystems (Chair, Editor) - - + +Renamed the “sgmlcomment” attribute +value of the class attribute of +tag. There's no significant difference between XML and +SGML comments and the “SGML” name implies that there ought to be +an “xmlcomment” value, which there is not. +The new value is simply “comment”. + + - -Notices - -Copyright © The Organization for the Advancement of -Structured Information Standards [OASIS] 2001, 2002, 2003, 2004, 2005. -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. + +Renamed the “class” attribute of +refmiscinfo. The DocBook semantics of class attributes is +that they have enumerated values. This attribute should always have +been called “type” as it is now. + + - + +Updated renderas on +bridgehead and class on +othercredit to have “attribute/otherattribute” co-constraints. +(In other words, if you select “other” for +renderas on bridgehead +or class on othercredit, +you have to also provide a value for otherrenderas +or othercredit, respectively. + - -Intellectual Property Rights + +Changed width attribute in media objects +to be “text” instead of “xs:integer”. + + -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 DocBook web page -() + +Fixed bug in the build process that resulted in unusable XML +Schema versions of beta 2 and beta 3. + - + +Improved reference documentation for attributes on many elements. + + + - -Revision History +
- - - - Committee Draft “Public Review Draft 1” - 6 February 2008 - - - Working Draft “Candidate Release 7” - 28 September 2007 - - - Working Draft “Candidate Release 6” - 27 September 2007 - - - Working Draft “Candidate Release 1” - 21 December 2006 - - - Working Draft “Beta 9” - 26 October 2006 - - - Working Draft “Beta 8” - 26 September 2006 - - - Working Draft “Beta 7” - 21 July 2006 - - - Working Draft “Beta 6” - 2 June 2006 - - - Working Draft “Beta 5” - 16 April 2006 - - - Working Draft “Beta 4” - 9 March 2006 - - - Working Draft “Beta 3” - 1 February 2006 - - - Working Draft “Beta 2” - 12 January 2006 - - - Working Draft “Beta 1” - 27 October 2005 - - - Working Draft “Alpha 1” - 26 June 2005 - - - +
+Changes in DocBook V5.0b3 - +This release contains several small improvements over V5.0b2. -References + + +Fixed RFE 1358844: +allow multiple imageobjects inside an +imageobjectco. Updated reference documentation. + + -Normative + +Restored default values to the +type attribute on simplelist +and the choice and +rep attributes on +methodparam, +arg, and +group. Fixed a bug in paramdef where +plain was accidentally allowed as a +choice. These defaults are reflected in the +generated XML DTD as well. + - - - - - - + +Reduced the content model of blockquote which seemed +way too broad. + - + +Improved reference documentation for attributes on many elements. + + + -Non-Normative +
+
+Changes in DocBook V5.0b2 - - - - +This release addresses several bugs identified in V5.0b1. - + + +When SVG or MathML are used, allow more than one element from the +respective namespace to be used in the appropriate location. + + + +Fixed RFE 1356238: +the xrefstyle attribute on +olink is now “text” rather than +“xsd:IDREF”. + + + +Fixed RFE 1380477: +Make xml:id optional on +areas within areaset; allow linking attributes on +areaset; establish the semantics that an area +inside an areaset inherits its linking attributes from the +areaset if it doesn't have linking attributes of its own. + + +Allow alt inside equation, +informalequation, and inlineequation. + + + +Fixed RFE 1356254: +dbforms.rnc schema now supports the HTML form elements. + + + - +
+ diff --git a/docbook/relaxng/docbook/spec/html.xsl b/docbook/relaxng/docbook/spec/html.xsl index c6208d9b0..e715857d4 100644 --- a/docbook/relaxng/docbook/spec/html.xsl +++ b/docbook/relaxng/docbook/spec/html.xsl @@ -1,193 +1,410 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - oasis-wd.css - oasis-cd.css - oasis-pr.css - oasis-cs.css - oasis-os.css - - - Unrecognized stage: ' - - '; styling as Working Draft. - - oasis-wd.css - - + xmlns:xs='http://www.w3.org/2001/XMLSchema' + exclude-result-prefixes="db f h m t xlink xs" + version="2.0"> + + + + + + - - + + + + + + + + + + + + + + + - - - - - - - + + + + + - -
- + + + +

+ OASIS logo +

+ + + + + + + + + + + + + + - + +
+

+ + Version + +

- - Working Draft - Committee Draft - Public Review Draft - Committee Specification - OASIS Standard - - - Unrecognized stage: ' - - '; labeling as Working Draft. - - Working Draft - - - ,  - - -   - - - - January - February - March - April - May - June - July - August - September - October - November - December - - -   - +

-
-
Document identifier:
-
-

+

+ +

+ + + + - + + - + + - + + - + + + - + + + + +
+

Specification URIs:

+
+
This Version:
+
+ http://docs.oasis-open.org/docbook/specs/ + + .html +
+
+ http://docs.oasis-open.org/docbook/specs/ - ( - .xml - , - .html - , - .pdf - ) -

-
- -
Location:
-
-

- - - -

-
- -
- + .pdf +
+
+
+ +
+
+
Technical Committee:
+ +
+ + + +
+ + +
+ Chair + + s + +
+ +
+ +
+ + + +
Editor - + s - : - -
-
- -

- -

+ + +
+ +
- -
Abstract:
-
- -
+ + + + + +
Related Work:
+
+
+ +
This specification replaces or supersedes:
+ +
+ +
+ + + +
This specification is related to:
+ +
+ +
+ + +
+
+ +
+
+ + +
+
+
+ Declared XML Namespace + s +
+ +
+ +
+ +
+
+ -
Status:
-
- -
- +
+

Abstract:

+ +
- +
+

Status:

+ +
+ +
+

Notices:

+ +
-
+ + + + + + + + + + + + + + + + + + + + -- 2.40.0