Changes

Release 0.2.7

  • The XRef implementation is competely refactored to work with the common DocBook Project stylesheets version 1.72. The goal is to support the DocBook Project xreftyle and olink capabilities. In normal use, the changes should be transparent.

  • Dblatex accepts input data from standard input. Therefore, the result of some pre-processing (like profiling) can be piped to dblatex.

  • Several user stylesheets (option -p) can be passed. Note that each stylesheet is imported (not included) which have significant impact on precedence or overriding behaviour.

  • Other minor improvements and a number of bug fixes.

Release 0.2.6

Bug fix release.

  • It is possible to number and/or put the preface, dedication, and colophon sections in the TOC and bookmarks.

  • Add a draft watermark when the document is in draft mode. Moreover, the draft mode can be deduced from the document status attribute.

  • Some other minor improvements and bug fixes.

Release 0.2.5

Contains some deep changes even if the list of changes is small.

  • Basic support for Chinese, Japanese, and Korean (CJK) languages. The CJK package must be installed, as well as the cyberbit fonts, to have this feature available.

  • Support native UTF8 latex compilation, thanks to the ucs package.

  • Preamble code refactored. The expected benefit is to make dblatex more customizable.

  • Some other minor improvements and bug fixes.

Release 0.2.4

A bug fix release.

  • A step towards DocBook 5 support by reusing the DocBook Project namespace stripping templates.

  • More consistent console output (use of logging python module).

  • Some bug fixes, including:

    • Fix PostScript output bug introduced in 0.2.3.

    • Use of subprocess to handle correctly the latex compilation.

    • A general parser/encoding mechanism is added, allowing to encode programlisting characters to Latin1.

Release 0.2.3

This is mainly a bug fix release.

  • Experimental annotation support (DocBook 5) enabled when the annotation.support paramater is set to 1. The annotation support is only for PDF output.

  • Some setup.py improvements and bug fixes, thanks to Max Horn's feedbacks (Fink packager).

  • Some minor improvements (doc.toc.show and draft.mode parameters added).

  • A number of bug fixes.

Release 0.2.2

  • BibTeX support added. See the section called “Using BibTeX Databases” for more details.

  • A better bibliography support, and natbib citation styles can be used (see the section called “Natbib Citations”).

  • Some table improvements:

    • Formal tables accross several pages are possible when setting the table.in.float parameter to 0. The limitation is that the caption must be on the top of the table.

    • Automatic table width allowed when setting the newtbl.autowidth parameter to default or all.

    • Footnotes in tables are possible.

    • Basic programlisting/screen support in tables.

  • A number of bug fixes.

Release 0.2.1

  • Better unicode support. Now the XML output is encoded in UTF-8, and Python uses the codecs to decode to ISO-Latin1 and replace the unsupported characters to some latex equivalent.

  • Several XSLT processors can be used. The first port is for 4suite because it is fully written in Python and is quite a good tool. The processors are loaded as plugins, so that it can be easily extended to any other XSLT processor.

    The processor to use is specified from the command line with the -m xslt option, where xslt is the name of the plugin to load (actually the name of the dynamically loaded Python module).

  • The XSL code is more conformant. It has been checked by using the 4suite XSLT processor as an alternative to xsltproc.

  • Possibility to have some configuration files stored under $HOME/.dblatex or under /etc/dblatex for system-wide configurations. Some extra paths can be specified by using the DBLATEX_CONFIG_FILES environment variable.

  • The remarks and comments are rendered as PDF text annotations when pdflatex is used. Otherwise, the comments are suppressed.

  • Some other minor improvements:

    • The parameters pdf.annot.options, latex.class.book, and latex.class.article are added.

    • An hexadecimal color like <?dblatex bgcolor="#cceeff"?> is supported, and a named color like <?dblatex bgcolor="blue"?> is supported too (in the previous release named colors had to be enclosed in curly braces "{}").

    • Some cleaner locale handling is provided, and new latex commands are given to allow the user to customize the babel setup.

    • The cross-references now use key() instead of id(). It prevents from some bugs and makes writing a document easier, especially in modular parts.

  • Some bug fixes.

Release 0.2

  • Better osx integration. The SDATA entities are translated to the equivalent Unicode characters.

  • Better Windows compatibility thanks to Nicolas Pernetty for his patches and feedbacks.

  • Better table support:

    • Putting some verbatim text (literallayout, address, synopsis, classsynopsis) in tables now works.

    • Nesting some informaltables is possible.

    • Basic entrytbl support.

    • Better valign attribute support.

    • The columns, rows and entries can be coloured by using some special Processing Instructions like <?dblatex bgcolor="..."?>.

    • The table floatstyle attribute can be used to specify the float placement rules (like "[htbp]").

  • A few imageobject improvements:

    • Like for the official DocBook XSL stylesheets, you can use the role attribute in imageobject to specify the image to use by dblatex. Set role to 'dblatex' to select the image used by dblatex.

    • Alternative imageobjects can be put in a mediaobjectco (DocBook 5).

  • Some cleanups and a number of bug fixes.

Release 0.2pre

Major release. All the code to transform SGML, call the XSLT, convert the figures and finally compile with LaTeX has been re-written from scratch in Python, removing Perl and GNU make dependencies. The LaTeX compilation relies on a subset of the Rubber package. The new implementation is more robust, more consistent, and gives the possibility to integrates new features. Some other small improvements are included too:

  • Some list attributes like continuation, numeration and spacing are now supported.

  • The filename.as.url parameter is added to avoid forced hyphenation with spurious '-' characters.

  • Some bug fixes.

Release 0.1.10

Bug fix release.

  • Images can now have their default dimension limited to a specified maximum dimension (can be lower than the page bounderies).

  • the following parameter is added:

    glossterm.auto.link

    Makes glossterms link to their glossary definition.

  • A number of bug fixes.

Release 0.1.9

Few changes.

  • The newtbl implementation now handles some tricky row spanning cells. Moreover it becomes the default table implementation used.

  • Equations without title are now latex equations (not formula in a float).

  • Xref to varlistentry or term is possible.

  • the following parameters are added:

    make.year.ranges, make.single.year.ranges,

    Change the rendering of year ranges in a copyright.

  • A number of bug fixes.

Release 0.1.8

This is mainly a bug fix release.

  • Better programlisting and screen support: inlinegraphic[@format='linespecific'] is handled.

  • Better newtbl support: the case colwidth="1in+5*" is now correctly handled.

  • GIF images are converted on the fly to PDF.

  • Bibliolist support.

  • Minor improvements:

    • DBLaTeX does not convert images when output is latex only.

    • Emphasis with role="underline" is supported.

    • Trademark with class="service" is supported.

    • Xref to refnamediv is now possible.

    • Automatic biblioentry abbreviation used if abbrev and @id reference are not defined.

  • the following parameters are added:

    titleabbrev.in.toc

    When set to 1 the titleabbrev content is put in the TOC instead of the title. Set to 1 by default.

    set.book.num

    When the document root element is a set this parameter can be used to select the book to print. Set to 1 by default.

    doc.lot.show

    It specifies which Lists of Titles should be printed after the Table of Content. The value is a comma separated list of the LoTs to print. The supported LoTs are "figure", "table", "equation", and "example". The list order represents the LoTs order in the output document.

    qandaset.defaultlabel

    It defines the default label to use in a qandadet when the defaultlabel attribute is not specified. Set to "number" by default.

    imagedata.file.check

    Set to 1, it checks if the referenced image file exists. If not, the mediaobject alternative (textobject) is used. Set to 1 by default.

    doc.alignment

    It defines the text alignment for the whole document. The valid values are: "left", "center", "right", "justify". By default the parameter is empty, which is equivalent to "justify".

  • A number of bug fixes.

Release 0.1.7

  • Callouts are now supported:

    • Embedded callout markups cos are supported.

    • The coref markups are supported.

    • Callouts markups defined with areas in a programlistingco or screenco are supported.

    • Callouts on external text files (referenced by textdata or imagedata elements) are supported.

    • Mediaobjectcos is supported.

    • The calloutlists are rendered as description lists where the terms are the callout markups.

    • The links between the callout markups (defined via areas or cos) and the calloutlist items (linkends attributes) are handled properly.

  • Programlisting and screen improved: external text files referenced via textdata or imagedata are now supported.

  • An abstract in an article is now printed.

  • The legalnotices are now printed in the native docbook style.

  • Better xref support. You can now make a cross-reference to an itemizedlist with title, and to a refentry.

  • Hyphenation is forced for text using a typewriter font, and the font is smaller.

  • Running dblatex on a root element different from a book or article does not fail anymore, except for set. The root element is now wrapped into a book or an article.

  • Minor improvements:

    • A DBLaTeX logo can be put on the cover page.

    • The PDF information section can tell that the creator of the document is dblatex.

  • the following parameters are added:

    co.linkends.show

    Next to a callout markup the links to the corresponding calloutlist items are shown if the parameter is set to 1. Set by default to 1.

    callout.markup.circled

    The callouts referenced in the callout list have the same rendering than the markups in the listing (or graphic), that is, white numbers in black circles. Set to 0 the references are simple numbers. Set to 1 by default.

    callout.linkends.hot

    The callouts referenced in the callout list are hot links if the parameter is set to 1. Then, the references are in red such like any other cross-reference link in the document. Set to 1 by default.

    term.breakline

    Set to 1, the item following a term in a variable list is put on the next line. Set to 0 by default.

    doc.pdfcreator.show

    Set to 1, the creator field of the PDF information section says that dblatex is the creator. Set to 1 by default.

    doc.publisher.show

    Set to 1, the dblatex logo is printed on the cover page of the native docbook style. Set to 0 by default.

    literal.lines.showall

    Set to 1, all the lines in a verbatim environment like programlisting or screen are printed, even if they are empty. Set to 0, the last empty lines are not printed. It is set to 1 by default.

  • Some bug fixes.

Release 0.1.6

  • Better figure and informalfigure rendering:

    • Caption and title are printed separately, in a consistent way.

    • Default image scaling is possible.

  • Better programlisting and screen rendering:

    • All the attributes are supported

    • A default verbatim layout is provided. The text is put in a framed box with a yellow background color.

    • Long lines are wrapped.

  • Minor improvements:

    • A breakline is forced after a term when it is immediately followed by a list.

  • the following parameters are added:

    imagedata.default.scale

    It defines the default scaling rule to apply on every imagedata that contains no scaling attribute.

    By default the parameter is set to 'pagebound', that is the images keep their natural size up to the page boundaries.

    figure.title.top

    Set to 1 it specifies to put the title above the image. By default it is set to 0 (title below).

    Note

    This parameter has no effect if an explicit float style is used for the figures (e.g. ruled style), since the title position is then fixed by the chosen style.

    mediaobject.caption.style

    Font style applied to the caption text. Default is slanted.

    literal.width.ignore

    Set to 1 the programlisting and screen width attribute is ignored.

    literal.layout.options

    Overwrite the default verbatim layout options.

    seg.item.separator

    Defines the separator to use between several segitems.

  • Some bug fixes.

Release 0.1.5

  • dblatex supports the new option -T target_style. It specifies which latex style to use for formatting the output. See the section called “Output Formatting Style” for more details.

  • The configure script can select the default latex style to use with the option --target. Example:

      ./configure --prefix=/where/to/install --target=db2latex
    
  • The use of make instead of gmake is now detected by configure.

  • Any document language should be well supported, since babel is now included for the related language.

  • New table support, completely re-written by David Hedley. It is very good and no Perl parsing is needed. One can use this new XSL table code by setting the parameter newtbl.use=1.

  • The following XSL parameters are added:

    latex.babel.use

    Set to 1 the babel package corresponding to the document language is included. Set to 0 no babel package is included whatever the document language is. Default is 1.

    latex.babel.language

    Empty by default, this parameter forces the use of the specified babel language whatever the document language is.

    newtbl.use

    Set to 1, use the David Hedley table support. By default it is set to 0.

    figure.note

    Figure to use to render a note block. This parameter is added to allow new latex styles to use their own figures in admonitions.

    figure.tip

    Figure to use to render a tip block. This parameter is added to allow new latex styles to use their own figures in admonitions.

    figure.important

    Figure to use to render a important block. This parameter is added to allow new latex styles to use their own figures in admonitions.

    figure.warning

    Figure to use to render a warning block. This parameter is added to allow new latex styles to use their own figures in admonitions.

    figure.caution

    Figure to use to render a caution block. This parameter is added to allow new latex styles to use their own figures in admonitions.

  • XML source files with any extension are correctly handled. Previously one needed to give XML files with extension .xml.

  • Better footnote support: it can be used in section titles and in terms.

  • Some latex rendering aspects are removed from the XSL stylesheets (they should never have been in these stylesheets): \parindent value, \parskip value, \thispagestyle{fancy} for pages containing chapters.

  • Bug fixes.

Release 0.1.4.1

  • Significant imagedata improvement: almost all the attributes (align, valign, depth, width, scale, scalefit, contentdepth, contentwidth) are correctly managed. However percentage used for both contentdepth and contentwidth is not managed (only contentwidth percentage is then applied).

  • Dblatex tries to automatically detect the image file formats of the included graphics, and convert them if necessary (and if possible) to be compatible with the TeX backend driver. It is usefull when several image formats are used within the same document, in which case the -f fig_format cannot be used.

  • The dblatex option -P param=value is added. One can then set XSL parameter values directly from the command line. This is an alternative to the -p custom.xsl option.

  • The align attribute is now managed for table cells spanned on several columns (i.e. row entries with nameend or spanname attributes).

Release 0.1.4

  • Deep code cleanup.

  • Better table support

    • Multicolumn support (use of the attributes namest, nameend, spanname).

    • Better frame, rowsep, colsep attributes inheritance.

  • Better bibliography support

    • Bibliography can be nested under any section.

    • Biblioset support.

    • Basic bibliomixed support.

  • Indexterm sortas and class attributes support added.

  • Imagedata width, depth, scale attributes support improved. In previous releases, scale was used instead of width. Now, you should use width or scale properly.

  • Programlisting linenumbering attribute support added.

  • Basic glossary support added.

  • Better reference support. Refnamediv title is no more hard-coded (use of $refnamediv.title if not empty, or name automatically generated according to the lang).

  • Qandaset improved. Qandadiv can be nested under any section.

  • Better xref support. Now xreflabel and endterm work.

  • The latex hyperref package is now automatically included in the dbk_core package. A customized LaTeX style package shouldn't include hyperref anymore.

  • Link now works.

  • Trademark class attribute managed (except class='service').

  • A keyword is not displayed but is inserted in the index entries.

  • Some bug fixes.