DocBook 5.2 Candidate Release 1

To the DocBook community:

I'm pleased to announce a new candidate release of the DocBook schema.  
The DocBook Technical Committee has completed its work on this version 
and we are making DocBook 5.2 Candidate Release 1 available for review 
by the DocBook community before submitting it to OASIS as an OASIS 
Standard.  You can download the release from the Github site:

https://github.com/docbook/docbook/releases/tag/5.2CR1

We plan to have a 60 day review period for DocBook 5.2 CR1 to give 
everyone a chance to try it out and identify any problems that need 
correction.  Please send us feedback by 11 July 2022 on your experience 
with this version.  Send any feedback to this DocBook mailing list:

[email protected]

If you find a bug that needs tracking, you can submit a new issue on the 
DocBook Github site if you have an account there:

https://github.com/docbook/docbook/issues

The Release Notes below provide a summary and all the details of the 
changes made since DocBook 5.1.  In future releases the Release Notes 
will be included in the distribution.  I have also attached the PDF 
version of the Release Notes.

The DocBook Definitive Guide by Norm Walsh has been updated for version 
5.2, although he points out that there are a few last minute changes 
that will be incorporated soon:

https://tdg.docbook.org/tdg/5.2/

So if you have feedback on how The Definitive Guide documents version 
5.2, please submit that also.

We appreciate you taking the time to review and provide feedback on this 
release.  Your real world testing is most valuable to us.

Robert Stayton
Chair, DocBook Technical Committee

---------------------------------------------------------------------------------------------------------------------------------------------

DocBook 5.2 CR1 Release Notes

14 April 2022

Background

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 
[https://www.oasis-open.org/committees/docbook/] at OASIS Open maintains 
the DocBook schema. Starting with V5.0, DocBook is normatively available 
as a RELAX NG Schema (with some additional Schematron assertions). 
DocBook builds on existing XML technologies: it uses XLink for linking, 
W3C XML Datatypes for atomic data types, and supports the use of 
XInclude for transclusion.

*Note*

DocBook has been under active maintenance for more than 20 years, it 
began life as an SGML document type definition.

The current DocBook released standard is version 5.1The version 
described here is DocBook version 5.2 Candidate Release 1.Before 
submission to the OASIS standards process, the DocBook Technical 
Committee is making it available to the DocBook user community for 
review and testing.

The DocBook Technical Committee welcomes bug reports from the user 
community. Please send comments and requests for enhancement to the 
DocBook comments list, [email protected] mailing 
list. Outstanding requests can be seen in the archives as well as in the 
issues tracker on Github[https://github.com/docbook/docbook/issues] 
interface.


    Significant differences in 5.2

·Many new synopsis elements for programming languages.

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


    Changes from DocBook 5.1 to DocBook 5.2 CR1

The following lists describe all the changes in 5.2.For details about 
elements, attributes, and content models, please refer to the online 
documentation for the DocBook 5.2 schema in /DocBook 5.2: The Definitive 
Guide/ [https://tdg.docbook.org/tdg/5.2/] which has been updated to 
include all these changes.


      New Elements

Added new element buildtarget.

Added new element danger.

Added new element enumidentifier.

Added new element enumitem.

Added new element enumitemdescription.

Added new element enunname.

Added new element enumsynopsis.

Added new element enumvalue.

Added new element formalgroup as multiples of figure, table, example, 
equation (but not mixed).

Added new element macrodef.

Added new element macroname.

Added new element macroprototype.

Added new element macrosynopsis.

Added new element meta.

Added new element packagesynopsis.

Added new element specializedtemplate.

Added new element synopsisinfo with verbatim content model.

Added new element template.

Added new element templatename.

Added new element typedefname.

Added new element typedefsynopsis.

Added new element union.

Added new element unionname.

Added new element unionsynopsis.


      New Attributes

Added db.trans.idfixup.attribute = "none|suffix|auto".

Added db.trans.suffix.attribute as "text" with a Schematron rule to 
force idfixup attribute if suffix used.

Added db.trans.linkscope.attribute = "user|local|near|global"

Added trans:idfixup, trans:suffix, and trans:linkscope to common attributes.

Added pubwork attribute = 
"article|bbs|book|cdrom|chapter|dvd|emailmessage|gopher|journal|manuscript|newsposting|part| 
refentry|section|series|set|webpage|wiki|other" to biblioentry and 
bibliomixed

Added otherpubwork attribute for when pubwork="other" specified, but no 
Schematron to enforce it.

Added optional type attribute (text) to procedure element.

Added optional type attribute to example, informalexample, figure, 
informalfigure elements.

Added fgstyle attribute, used in formalgroup only.

Added enumerated class attribute to section as "legal | other"

Added class attribute = "legal|other" to sect1 through sect5.

Added otherclass attribute to section to support other values.

Added "other" to existing article class attribute enumeration.

Added otherclass attribute to article.

Added a type attribute to table and informaltable elements (CALS and 
HTML table syntax).

Added a type attribute to equation and informalequation.

Added class attribute with enumerated values "union|intersection" to 
type element.

Added Schematron rule to exclude danger element as descendant of 
admonitions.

Added packageref attributeto cmdsynopsis, funcsynopsis, classsynopsis, 
fieldsynopsis, constructorsynopsis, destructorsynopsis, methodsynopsis, 
macrosynopsis, unionsynopsis, enumsynopsis, typedefsynopsis, 
packagesynopsis.


      Content Model Changes

Added db.programmingsynopsis element to db.synopsis.blocks.

Changed db._any to remove html: reference.

Added db.revnumber to db.publishing.inlines

Added db.wrapper.blocks to db.nopara.blocks.

Added meta element to info set. Can be empty or block and inline content.

Changed abstract content from db.para.blocks+ to db.all.blocks+ to 
expand its content model.

Added Schematron rule to footnote to exclude danger element (similar to 
other admonitions).

Added Schematron rule to caption to exclude danger element (similar to 
other admonitions).

Added Schematron rule to exclude danger element as descendant of 
admonitions.

Added optional info child to listitem element.

Added multimediaparam children to imagedata element (already allowed on 
audiodata and videodata).

Allowed refentry in sect1 through sect5 (already allowed in section).

Added elements buildtarget, templatename, macroname, unionname, 
enumname, enumvalue, enumidentifier, typedefname to the list of 
programming inlines.

Added elements enumsynopsis, typedefsynopsis, packagesynopsis, 
macrosynopsis, unionsynopsis, enumsynopsis, typedefsynopsis to the list 
in db.synopsis.blocks.

Added packagesynopsis, macrosynopsis, typedefsynopsis, and enumsynopsis 
to the db.programmingsynopsis set.

Added elements templatename and void to funcdef content model.

Added elements templatename and modifier to paramdef content model.

Added elements info, templatename, template, and ooexception to 
classsynopsis content model.

Added element info, synopsisinfo to constructorsynopsis content model.

Added element info, synopsisinfo to destructorsynopsis content model.

Added elements info, synopsisinfo, and templatename to fieldsynopsis 
content model.

Added elements info, synopsisinfo, and templatename to methodsynopsis 
content model.

Added element templatename to methodparam content model.

Added programming inlines to type element.

Allow optional element to nest in optional element.


      Other Changes

Added trans namespace declarations for transclusion.

Added 10 s: schematron namespace declarations.

Added db.wrapper.blocks to "start" set.

Defined db.wrapper.blocks as db.formalgroup.

Deleted db.programmingsynopsis named pattern (only used in start, now 
handled by db.synopsis.blocks).

Removed unnecessary \x{a} whitespace from Schematron rules.

Added a Schematron rule to callout element so @arearefs must point to 
areaset, area, or co.

Added a Schematron rule to EBNF production constraint element so its 
@linkend must point to a constraintdef.

Added a Schematron rule to EBNF production productionrecap element so 
its @linkend must point to a production element.


---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]