From: Michael Smith Date: Sun, 22 Jul 2007 17:07:18 +0000 (+0000) Subject: Updated for 1.73.0 release X-Git-Tag: release/1.79.1~6^2~1886 X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=073971ec8ec0f26ea955b74109a478c75188f234;p=docbook-dsssl Updated for 1.73.0 release --- diff --git a/xsl/RELEASE-NOTES.xml b/xsl/RELEASE-NOTES.xml index 67ad5bbd7..ae6e68dc2 100644 --- a/xsl/RELEASE-NOTES.xml +++ b/xsl/RELEASE-NOTES.xml @@ -1,8 +1,8 @@
+ xmlns:xlink="http://www.w3.org/1999/xlink" + xmlns:xi="http://www.w3.org/2001/XInclude" + xml:lang="en" xml:id="releasenotes" + version="5.0"> Release Notes DocBook Project XSL Stylesheets @@ -11,30 +11,739 @@ DocBook Project Development Team - - - - - - - - - -This is a pre-release “snapshot” of the DocBook XSL -Stylesheets. The change information in the first section of this -file (for “”) is -auto-generated from change descriptions stored in the project -source-code repository. - -That means the first section contains descriptions both of bug -fixes and of feature changes. The remaning sections are manually -edited changelog subsets that exclude bug-fix descriptions – that -is, trimmed down to just those those descriptions that document -enhancements and changes to the public APIs (user-configurable -parameters). - - +These are the release notes for the DocBook XSL Stylesheets +distribution. This document provides an (incomplete) per-release list +of enhancements and changes to the stylesheets’ public APIs +(user-configurable parameters) and generally excludes descriptions of +bug fixes. For a complete list of all changes (including all bug +fixes) that have been made since the previous release, see the +separate NEWS (plain text) or NEWS.html files. + +As with all DocBook Project dot-zero +releases, this is an experimental release. It will be followed shortly +by a stable release. + + + + + + + + + + + + + + + + + + +Release: 1.73.0 +This release includes important bug fixes and adds the following +significant feature changes: + + + New localizations and localization updates + + We added two new localizations: Latvian and + Esperanto, and made updates to the Czech, Chinese + Simplified, Mongolian, Serbian, Italian, and Ukrainian + localizations. + + + + ISO690 citation style for bibliography output. + + Set the + bibliography.style parameter to + iso690 to use ISO690 style. + + + + New documentation for processing instructions (PI) + + The reference documentation that ships with the + release now includes documentation on all PIs that you can use to + control output from the stylesheets. + + + + New profiling parameters for audience and wordsize + + You can now do profiling based on the values of the + audience and + wordsize attributes. + + + + Changes to man-page output + + The manpages stylesheet now supports single-pass + profiling and single-pass DocBook 5 namespace stripping + (just as the HTML and FO stylesheets also do). Also, added + handling for mediaobject & + inlinemediaobject. (Each imagedata, + audiodata, or videodata element + within a mediaobject or inline + mediaobject is now treated as a "notesource" + and so handled in much the same way as links and + annotation/alt/footnote + are in manpages output.) And added the + man.authors.section.enabled and + man.copyright.section.enabled + parameters to enable control over whether output includes + auto-generated AUTHORS and + COPYRIGHT sections. + + + + Highlighting support for C + + The highlighting mechanism for generating + syntax-highlighted code snippets in output now supports C + code listings (along with Java, PHP, XSLT, and others). + + + + Experimental docbook-xsl-update script + + We added an experimental docbook-xsl-update + script, the purpose of which is to facilitate + easy sync-up to the latest docbook-xsl snapshot (by means + of rsync). + + + + + + +Gentext +The following changes have been made to the +gentext code +since the 1.72.0 release. + + +Michael(tm) Smith: locale/lv.xml; MakefileAdded Latvian localization file, from Girts Ziemelis. + + +Dongsheng Song: locale/zh_cn.xmlBrought up to date with en.xml in terms of items. A few strings marked for translation. + + +Jirka Kosek: locale/cs.xmlAdded missing translations + + +Robert Stayton: locale/eo.xmlNew locale for Esperanto. + + +Robert Stayton: locale/mn.xmlUpdate from Ganbold Tsagaankhuu. + + +Jirka Kosek: locale/en.xml; locale/cs.xmlRules for normalizing glossary entries before they are sorted can be now different for each language. + + +Michael(tm) Smith: locale/sr_Latn.xml; locale/sr.xmlCommitted changes from Miloš Komarčević to Serbian files. + + +Robert Stayton: locale/ja.xmlFix chapter in context xref-number-and-title + + +Robert Stayton: locale/it.xmlImproved version from contributor. + + +Mauritz Jeanson: locale/uk.xmlApplied patch 1592083. + + + + +Common +The following changes have been made to the +common code +since the 1.72.0 release. + + +Michael(tm) Smith: labels.xslChanged handling of reference auto-labeling such that reference +(when it appears at the component level) is now affected by the +label.from.part param, just as preface, chapter, and appendix. + + +Michael(tm) Smith: common.xslAdded support to the HTML stylesheets for proper processing of +orgname as a child of author. + + +Michael(tm) Smith: refentry.xslRefined logging output of refentry metadata-gathering template; +for some cases of "missing" elements (refmiscinfo stuff, etc.), +the log messages now include URL to corresponding page in the +Definitive Guide (TDG). + + +Robert Stayton: titles.xslAdd refsection/info/title support. + + +Michael(tm) Smith: titles.xslAdded support for correct handling of xref to elements that +contain info/title descendants but no title children. + +This should be further refined so that it handles any *info +elements. And there are probably some other places where similar +handling for *info/title should be added. + + +Mauritz Jeanson: pi.xslModified <xsl:when> in datetime.format template to work +around Xalan bug. + + + + +FO +The following changes have been made to the +fo code +since the 1.72.0 release. + + +Robert Stayton: component.xslAdd parameters to the page.sequence utility template. + + +Mauritz Jeanson: xref.xslAdded template for xref to area/areaset. +Part of fix for bug #1675513 (xref to area broken). + + +Michael(tm) Smith: inline.xslAdded template match for person element to fo stylesheet. + + +Robert Stayton: lists.xslAdded support for spacing="compact" in variablelist, per bug report #1722540. + + +Robert Stayton: table.xsltable pgwide="1" should also use pgwide.properties attribute-set. + + +Mauritz Jeanson: inline.xslMake citations numbered if bibliography.numbered != 0. + + +Robert Stayton: param.xweb; param.entAdd new profiling parameters for audience and wordsize. + + +Robert Stayton: param.xweb; param.entAdded callout.icon.size parameter. + + +Robert Stayton: inline.xsl; xref.xslAdd support for xlink as olink. + + +Robert Stayton: autotoc.xsl; param.xweb; param.entAdd support for qanda.in.toc to fo TOC. + + +Robert Stayton: component.xslImproved the page.sequence utility template for use with book. + + +Robert Stayton: division.xslRefactored the big book template into smaller pieces. +Used the "page.sequence" utility template in +component.xsl to shorten the toc piece. +Added placeholder templates for front.cover and back.cover. + + +Robert Stayton: param.xweb; param.ent; sections.xslAdd section.container.element parameter to enable +pgwide spans inside sections. + + +Robert Stayton: param.xweb; param.ent; component.xslAdd component.titlepage.properties attribute-set to +support span="all" and other properties. + + +Robert Stayton: htmltbl.xsl; table.xslApply table.row.properties template to html tr rows too. +Add keep-with-next to table.row.properties when row is in thead. + + +Robert Stayton: table.xslAdd support for default.table.frame parameter. +Fix bug 1575446 rowsep last check for @morerows. + + +Robert Stayton: refentry.xslAdd support for info/title in refsections. + + +David Cramer: qandaset.xslMake fo questions and answers behave the same way as html + + +Jirka Kosek: lists.xslAdded missing attribute set for procedure + + +Jirka Kosek: param.xweb; biblio.xsl; docbook.xsl; param.ent; biblio-iso690.xslAdded support for formatting biblioentries according to ISO690 citation style. +New bibliography style can be turned on by setting parameter bibliography.style to "iso690" +The code was provided by Jana Dvorakova + + +Robert Stayton: param.xweb; param.ent; pagesetup.xslAdd header.table.properties and footer.table.properties attribute-sets. + + +Robert Stayton: inline.xslAdd fop1.extensions for menuchoice arrow handling exception. + + + + +HTML +The following changes have been made to the + html code + since the 1.72.0 release. + + +Mauritz Jeanson: param.xweb; param.entMoved declaration and documentation of javahelp.encoding from javahelp.xsl to the +regular "parameter machinery". + + +Michael(tm) Smith: admon.xslChanged handling of titles for note, warning, caution, important, +tip admonitions: We now output and HTML h3 head only if +admon.textlabel is non-zero or if the admonition actually contains +a title; otherwise, we don't output an h3 head at all. +(Previously, we were outputting an empty h3 if the admon.textlabel +was zero and if the admonition had no title.) + + +Mauritz Jeanson: xref.xslAdded template for xref to area/areaset. +Part of fix for bug #1675513 (xref to area broken). + + +Mauritz Jeanson: titlepage.xsl; component.xsl; division.xsl; sections.xslAdded fixes to avoid duplicate ids when generate.id.attributes = 1. +This (hopefully) closes bug #1671052. + + +Michael(tm) Smith: formal.xsl; pi.xslMade the dbfunclist PI work as intended. Also added doc for +dbfunclist and dbcmdlist PIs. + + +Michael(tm) Smith: pi.xsl; synop.xslMade the dbcmdlist work the way it appears to have been intended +to work. Restored dbhtml-dir template back to pi.xsl. + + +Michael(tm) Smith: titlepage.xsl; param.xweb; param.entAdded new param abstract.notitle.enabled. +If non-zero, in output of the abstract element on titlepages, +display of the abstract title is suppressed. +Because sometimes you really don't want or need that title +there... + + +Michael(tm) Smith: chunk-code.xsl; graphics.xslWhen we are chunking long descriptions for mediaobject instances +into separate HTML output files, and use.id.as.filename is +non-zero, if a mediaobject has an ID, use that ID as the basename +for the long-description file (otherwise, we generate an ID for it +and use that ID as the basename for the file). +The parallels the recent change made to cause IDs for legalnotice +instances to be used as basenames for legalnotice chunks. +Also, made some minor refinements to the recent changes for +legalnotice chunk handling. + + +Michael(tm) Smith: titlepage.xslAdded support to the HTML stylesheets for proper processing of +orgname as a child of author. + + +Michael(tm) Smith: chunk-code.xslWhen $generate.legalnotice.link is non-zero and +$use.id.as.filename is also non-zero, if a legalnotice has an ID, +then instead of assigning the "ln-<generatedID>" basename to the +output file for that legalnotice, just use its real ID as the +basename for the file -- as we do when chunking other elements +that have IDs. + + +David Cramer: xref.xslHandle alt text on xrefs to steps when the step doesn't have a title. + + +David Cramer: lists.xslAdded <p> element around term in variablelist when formatted as table to avoid misalignment of term and listitem in xhtml (non-quirks mode) output + + +David Cramer: qandaset.xslAdded <p> element around question and answer labels to avoid misalignment of label and listitem in xhtml (non-quirks mode) output + + +David Cramer: lists.xslAdded <p> element around callouts to avoid misalignment of callout and listitem in xhtml (non-quirks mode) output + + +Mauritz Jeanson: inline.xslMake citations numbered if bibliography.numbered != 0. + + +Robert Stayton: param.xweb; param.entAdd support for new profiling attributes audience and wordsize. + + +Robert Stayton: inline.xsl; xref.xslAdd support for xlink olinks. + + +Jirka Kosek: glossary.xslRules for normalizing glossary entries before they are sorted can be now different for each language. + + +Robert Stayton: chunk-common.xsl; chunk-code.xsl; manifest.xsl; chunk.xslRefactored the chunking modules to move all named templates to +chunk-common.xsl and all match templates to chunk-code.xsl, in +order to enable better chunk customization. +See the comments in chunk.xsl for more details. + + +Robert Stayton: lists.xslAdd anchor for xml:id for listitem in varlistentry. + + +Robert Stayton: refentry.xslAdd support for info/title in refsections for db5. + + +Jirka Kosek: param.xweb; biblio.xsl; docbook.xsl; param.ent; biblio-iso690.xslAdded support for formatting biblioentries according to ISO690 citation style. +New bibliography style can be turned on by setting parameter bibliography.style to "iso690" +The code was provided by Jana Dvorakova + + +Robert Stayton: inline.xsl; xref.xslAdd call to class.attribute to <a> output elements so they can +have a class value too. + + +Mauritz Jeanson: glossary.xslFixed bug #1644881: +* Added curly braces around all $language attribute values. +* Moved declaration of language variable to top level of stylesheet. +Tested with Xalan, Saxon, and xsltproc. + + + + +Manpages +The following changes have been made to the + manpages code + since the 1.72.0 release. + + +Michael(tm) Smith: param.xweb; docbook.xsl; param.entAdded the man.authors.section.enabled and +man.copyright.section.enabled parameters. Set those to zero when +you want to suppress display of the auto-generated AUTHORS and +COPYRIGHT sections. Closes request #1467806. Thanks to Daniel +Leidert. + + +Michael(tm) Smith: docbook.xslTook the test that the manpages stylesheet does to see if there +are any Refentry chilren in current doc, and made it +namespace-agnostic. Reason for that is because the test otherwise +won't work when it is copied over into the generated +profile-docbook.xsl stylesheet. + + +Michael(tm) Smith: MakefileAdded a manpages/profile-docbook.xsl file to enable single-pass +profiling for manpages output. + + +Michael(tm) Smith: info.xslOutput copyright and legalnotice in man-page output in whatever +place they are in in document order. Closes #1690539. Thanks to +Daniel Leidert for reporting. + + +Michael(tm) Smith: docbook.xslRestored support for single-pass namespace stripping to manpages +stylesheet. + + +Michael(tm) Smith: synop.xsl; block.xsl; info.xsl; inline.xsl; lists.xsl; endnotes.xsl; ut⋯Changed handling of bold and italic/underline output in manpages +output. Should be transparent to users, but... + +This touches handling of all bold and italic/underline output. The +exact change is that the mode="bold" and mode="italic" utility +templates were changed to named templates. (I think maybe I've +changed it back and forth from mode to named before, so this is +maybe re-reverting it yet again). + +Anyway, the reason for the change is that the templates are +sometimes call on dynamically node-sets, and using modes to format +those doesn't allow passing info about the current/real context +node from the source (not the node-set created by the stylesheet) +to that formatting stage. + +The named templates allow the context to be passed in as a +parameter, so that the bold/ital formatting template can use +context-aware condition checking. + +This was basically necessary in order to suppress bold formatting +in titles, which otherwise gets screwed up because of the numbnut +way that roff handles nested bold/ital. + +Closes #1674534). Much thanks to Daniel Leidert, whose in his +docbook-xsl bug-finding kung-fu has achieved Grand Master status. + + +Michael(tm) Smith: block.xslFixed handling of example instances by adding the example element +to the same template we use for processing figure. Closes +#1674538. Thanks to Daniel Leidert. + + +Michael(tm) Smith: utility.xslDon't include lang in manpages filename/pathname if lang=en (that +is, only generate lang-qualified file-/pathnames for non-English). + + +Michael(tm) Smith: endnotes.xslIn manpages output, emit warnings for notesources (footnote, etc.) +that have something other than para as a child. + +The numbered-with-hanging-indent formatting that's used for +rendering endnotes in the NOTES section of man pages places some +limits/assumptions on how the DocBook source is marked up; namely, +for notesources (footnote, annotation, etc.) that can contain +block-level children, if the they have a block-level child such as +a table or itemizedlist or orderedlist that is the first child of +a footnote, we have no way of rendering/indenting its content +properly in the endnotes list. + +Thus, the manpages stylesheet not emits a warning message for that +case, and suggests the "fix" (which is to wrap the table or +itemizedlist or whatever in a para that has some preferatory text. + + +Michael(tm) Smith: utility.xslAdded support to mixed-block template for handling tables in +mixed-blocks (e.g., as child of para) correctly. + + +Michael(tm) Smith: table.xsl; synop.xsl; block.xsl; info.xsl; lists.xsl; refentry.xsl; end⋯Reverted necessary escaping of backslash, dot, and dash +out of the well-intentioned (but it now appears, +misguided) "marker" mechanism (introduced in the 1.72.0 +release) -- which made use of alternative "marker" +characters as internal representations of those +characters, and then replaced them just prior to +serialization -- and back into what's basically the +system that was used prior to the 1.69.0 release; that +is, into a part of stylesheet code that gets executed +at the beginning of processing -- before any other roff +markup up is. This change obviates the need for the +marker system. It also requires a lot less RAM during +processing (for large files, the marker mechanism +ending up requiring gigabytes of memory). + +Closes bug #1661177. Thanks to Scott Smedley for +providing a test case (the fvwm man page) that exposed +the problem with the marker mechanism. + +Also moved the mechanism for converting non-breaking +spaces back into the same area of the stylesheet code. + + +Michael(tm) Smith: lists.xslFixed problem with incorrect formatting of nested variablelist. +Closes bug #1650931. Thanks to Daniel "Eagle Eye" Leidert. + + +Michael(tm) Smith: lists.xslMake sure that all listitems in itemizedlist and orderedlist are +preceded by a blank line. This fixes a regression that occurred +when instances of the TP macro that were use in a previous +versions of the list-handling code were switched to RS/RE (because +TP doesn't support nesting). TP automatically generates a blank +line, but RS doesn't. So I added a .sp before each .RS + + +Michael(tm) Smith: block.xsl; inline.xsl; param.xweb; docbook.xsl; links.xsl; param.entMade a number of changes related to elements with +out-of-line content: + +- Added handling for mediaobject & inlinemediaobject. + Each imagedata, audiodata, or videodata element + within a mediaobject or inline mediaobject is now + treated as a "notesource" and so handled in much the + same way as links and annotation/alt/footnotes. + + That means a numbered marker is generated inline to + mark the place in the main flow where the imagedata, + audiodata, or videodata element occurs, and a + corresponding numbered endnote for it is generated in + the endnotes list at the end of the man page; the + endnote contains the URL from the fileref attribute + of the imagedata, audiodata, or videodata element. + + For mediobject and inlinemediaobject instances that + have a textobject child, the textobject is displayed + within the main text flow. + +- Renamed several man.link.* params to man.endnotes.*, + to reflect that fact that the endnotes list now + contains more than just links. Also did similar + renaming for a number of stylesheet-internal vars. + +- Added support for xlink:href (along with existing + support for the legacy ulink element). + +- Cleaned up and streamlined the endnotes-handling + code. It's still messy and klunky and the basic + mechanism it uses is very inefficent for documents + that contain a lot of notesources, but at least it's + a bit better than it was. + + + + +Eclipse +The following changes have been made to the + eclipse code + since the 1.72.0 release. + + +Mauritz Jeanson: MakefileFixed bug #1715093: Makefile for creating profiled version of eclipse.xsl added. + + +David Cramer: eclipse.xslAdded normalize-space around to avoid leading whitespace from appearing in the output if there's extra leading whitespace (e.g. <title> Foo</title>) in the source + + + + +JavaHelp +The following changes have been made to the + javahelp code + since the 1.72.0 release. + + +Mauritz Jeanson: javahelp.xslImplemented FR #1230233 (sorted index in javahelp). + + +Mauritz Jeanson: javahelp.xslAdded normalize-space() around titles and index entries to work around whitespace problems. +Added support for glossary and bibliography in toc and map files. + + + + +Roundtrip +The following changes have been made to the + roundtrip code + since the 1.72.0 release. + + +Steve Ball: blocks2dbk.xsl; wordml2normalise.xsl; normalise2sections.xsl; sections2blocks.⋯new stylesheets for better word processor support and easier maintenance + + +Steve Ball: template-pages.xml; dbk2wp.xsl; sections-spec.xmlfixed bugs + + + + +Params +The following changes have been made to the + params code + since the 1.72.0 release. + + +Mauritz Jeanson: htmlhelp.button.back.xml; htmlhelp.button.forward.xml; htmlhelp.button.zo⋯Modified refpurpose text. + + +Mauritz Jeanson: htmlhelp.map.file.xml; htmlhelp.force.map.and.alias.xml; htmlhelp.alias.f⋯Fixed typos, made some small changes. + + +Mauritz Jeanson: javahelp.encoding.xmlMoved declaration and documentation of javahelp.encoding from javahelp.xsl to the +regular "parameter machinery". + + +Mauritz Jeanson: generate.id.attributes.xmlAdded refpurpose text. + + +Mauritz Jeanson: annotation.js.xml; annotation.graphic.open.xml; annotation.graphic.close.⋯Added better refpurpose texts. + + +Michael(tm) Smith: chunker.output.cdata-section-elements.xml; chunker.output.standalone.xm⋯Fixed some broken formatting in source files for chunker.* params, +as pointed out by Dave Pawson. + + +Michael(tm) Smith: label.from.part.xmlChanged handling of reference auto-labeling such that reference +(when it appears at the component level) is now affected by the +label.from.part param, just as preface, chapter, and appendix. + + +Mauritz Jeanson: callout.graphics.extension.xmlClarified that 'extension' refers to file names. + + +Michael(tm) Smith: abstract.notitle.enabled.xmlAdded new param abstract.notitle.enabled. +If non-zero, in output of the abstract element on titlepages, +display of the abstract title is suppressed. +Because sometimes you really don't want or need that title +there... + + +Michael(tm) Smith: man.string.subst.map.xmlUpdated manpages string-substitute map to reflect fact that +because of another recent change to suppress bold markup in .SH +output, we no longer need to add a workaround for the accidental +uppercasing of roff escapes that occurred previously. + + +Jirka Kosek: margin.note.float.type.xml; title.font.family.xml; table.frame.border.color.x⋯Improved parameter metadata + + +Robert Stayton: profile.wordsize.xml; profile.audience.xmlAdd support for profiling on new attributes audience and wordsize. + + +Robert Stayton: callout.graphics.number.limit.xml; callout.graphics.extension.xmlAdded SVG graphics for fo output. + + +Robert Stayton: callout.icon.size.xmlSet size of callout graphics. + + +Jirka Kosek: default.units.xml; chunker.output.method.xml; toc.list.type.xml; output.inden⋯Updated parameter metadata to the new format. + + +Jirka Kosek: man.output.quietly.xml; title.font.family.xml; footnote.sep.leader.properties⋯Added type annotations into parameter definition files. + + +Robert Stayton: section.container.element.xmlSupport spans in sections for certain processors. + + +Robert Stayton: component.titlepage.properties.xmlEmpty attribute set for top level component titlepage block. +Allows setting a span on title info. + + +Jirka Kosek: bibliography.style.xmlAdded link to WiKi page with description of special markup needed for ISO690 biblioentries + + +Robert Stayton: make.year.ranges.xmlClarify that multiple year elements are required. + + +Robert Stayton: id.warnings.xmlTurn off id.warnings by default. + + +Jirka Kosek: bibliography.style.xmlAdded support for formatting biblioentries according to ISO690 citation style. +New bibliography style can be turned on by setting parameter bibliography.style to "iso690" +The code was provided by Jana Dvorakova + + +Robert Stayton: header.table.properties.xml; footer.table.properties.xmlSupport adding table properties to header and footer tables. + + + + +Highlighting +The following changes have been made to the + highlighting code + since the 1.72.0 release. + + +Jirka Kosek: c-hl.xml; xslthl-config.xmlAdded support for C language. Provided by Bruno Guegan. + + + + +Profiling +The following changes have been made to the + profiling code + since the 1.72.0 release. + + +Robert Stayton: profile-mode.xslAdd support for new profiling attributes audience and wordsize. + + + + +Lib +The following changes have been made to the + lib code + since the 1.72.0 release. + + +Michael(tm) Smith: lib.xwebChanged name of prepend-pad template to pad-string and twheeked so +it can do both right/left padding. + + + + +Tools +The following changes have been made to the + tools code + since the 1.72.0 release. + + +Michael(tm) Smith: bin; bin/docbook-xsl-updateDid some cleanup to the install.sh source and added a +docbook-xsl-update script to the docbook-xsl distro, the purpose +of which is to facilitate easy sync-up to the latest docbook-xsl +snapshot (by means of rsync). + + + + Release: 1.72.0