db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Andrew McIntyre (JIRA)" <derby-...@db.apache.org>
Subject [jira] Commented: (DERBY-408) Fix formatting of manuals in PDF output
Date Sat, 02 Sep 2006 04:00:23 GMT
    [ http://issues.apache.org/jira/browse/DERBY-408?page=comments#action_12432270 ] 
Andrew McIntyre commented on DERBY-408:

The first problem mentioned in this issue, that the syntax boxes in the PDFs print one word
per line and have multiple empty lines, is due to the fact that they are specified as <codeblock>
in the DITA files, and the default behavior for <codeblock>s is to preserve whitespace,
including linebreaks, inside them. While the DITA files themselves do not contain linebreaks,
the transformation from DITA to XSL-FO introduces a linebreak every time the style changes
between bold, italic, or bolditalic.

I now think this is a fairly serious problem, because while I was reviewing some of the documentation,
it made understanding the syntax diagrams certainly tedious and occasionally outright confusing.

There are two possible remedies: the hardest but preferable solution is to attempt to preserve
the whitespace characteristics of the <codeblock>s during their transformation from
XML to XSL-FO. Another, significantly less desirable option would be to modify the transformation
to XSL-FO so that the containing <fo:block> doesn't have the  linefeed-treatment="preserve"
space, and then insert <br> elements whereever necessary. A last resort would be to
use a different containing element for code snippets and syntax diagrams which doesn't preserve

The second problem in this issue, and less serious, is that the table numbers in the HTML
Books and PDFs are not correctly numbered sequentially. I think this is due to this bad line
of XSL in dita2fo-titles.xsl:

<xsl:number count="*/table/title" level="multiple"/> <!-- was ANY-->

which is probably not the correct XPath construct for a count of the tables in the merged
XML file that is transformed to XSL-FO. It should probably be something more along the lines
of the HTML version:

<xsl:number count="*/*[contains(@class,' topic/table ')]/*[contains(@class,' topic/title
')]" level="any"/> 

I will attempt to address both of these issues early next week.

> Fix formatting of manuals in PDF output
> ---------------------------------------
>                 Key: DERBY-408
>                 URL: http://issues.apache.org/jira/browse/DERBY-408
>             Project: Derby
>          Issue Type: Bug
>          Components: Documentation
>         Environment: all
>            Reporter: Jeff Levitt
>         Assigned To: Andrew McIntyre
>            Priority: Minor
>             Fix For:
> 1.  The syntax boxes in many of the Derby manuals seem to output with extra End-of-line
feeds in the PDF's.  Some syntax boxes print one word per line.   For example:
> http://incubator.apache.org/derby/docs/tools/tools-single.html#rtoolsijpropref10135
> This might be a bug with the DITA toolkit, because the DITA source files dont have these
End-of-line feeds in them.
> This bug was originally reported in the doc reviews for version 10.1:
> http://issues.apache.org/jira/browse/DERBY-383
> (see Myrna's comments)
> 2.  Based on http://issues.apache.org/jira/browse/DERBY-384 comments to the doc review
(see Sunitha's comments), we need to figure out how to et the table numbers to ascend.  Currently,
they all output as table 1.

This message is automatically generated by JIRA.
If you think it was sent incorrectly contact one of the administrators: http://issues.apache.org/jira/secure/Administrators.jspa
For more information on JIRA, see: http://www.atlassian.com/software/jira


View raw message