[dbdoclet] Re: dbdoclet 1.7 DocBook-XML Problems and PDF lines too long

Hello Michael,

you're right about the disabled option "fully qualified names" and I fully 
agree to your statement about not to consider certain output media for the 
DocBook generation. Nonetheless I need a solution which generates readable PDF 
files.
To demonstrate my point I've build a small sample in the attached ZIP file. 
Except for some sources the ZIP also includes the generated DocBook and the 
generated PDF (generated with JDK 1.6). To reproduce this you need to adjust 
some path values in the ANT build file and in dbdoclet.properties.

The outcome:

1) The <title> elements are 'good'. For instance:
<sect2 id="CONSTRUCTOR-2-1" 
xreflabel="SomeClass(java.util.List&lt;com.wincornixdorf.sample.temp.DataClass&gt;,
 java.util.Map&lt;java.lang.String, 
com.wincornixdorf.sample.temp.DataClass&gt;)">
  <title>SomeClass(List&lt;DataClass&gt;, Map&lt;String, DataClass&gt;)
    <indexterm>
      <primary>SomeClass</primary>
    </indexterm>
    <indexterm>
      <primary>Methods</primary>
      <secondary>SomeClass</secondary>
    </indexterm>
  </title>

so the title text is
  SomeClass(List<DataClass>, Map<String, DataClass>)
which easily fits in a single print line.

2) The problem occurs in the <type> element of some synopsis:

<constructorsynopsis language="java">
  <modifier>public</modifier>
  <methodname>SomeClass</methodname>
  <methodparam>
    <type>java.util.List&lt;com.wincornixdorf.sample.temp.DataClass&gt;</type>
    <parameter>listOfValues</parameter>
  </methodparam>
  <methodparam>
    <type>java.util.Map&lt;java.lang.String, 
com.wincornixdorf.sample.temp.DataClass&gt;</type>
    <parameter>mapOfValues</parameter>
  </methodparam>
</constructorsynopsis>   

i.e. the <type> element always uses fully qualified class names, which are then 
used to generate the synopses. 

Therefore:

If there is a requirement from DocBook or JavaDoc or somewhere else to provide 
fully qualified package names in class, field, and method synopses then I must 
look for XSLT or FOP options to reduce the length of these lines. If there is 
no such requirement I'ld kindly ask for a DbDoclet option to use reduced 
package names in the synopses, similar or identical to what is currently done 
in "title" elements.

Thanks for your attention and thanks again for your prompt response.
Regards,
Udo Hempel
 


------------------------------------------------------
WINCOR NIXDORF International GmbH
Sitz der Gesellschaft: Paderborn
Registergericht Paderborn HRB 3507
Geschäftsführer: Eckard Heidloff (Vorsitzender), Stefan Auerbach, Jürgen Wilde, 
Dr. Jürgen Wunram
Vorsitzender des Aufsichtsrats: Karl-Heinz Stiller 
Steuernummer: 339/5884/0031
Ust-ID Nr.: DE812927716
WEEE-Reg.-Nr. DE44477193

-----Original Message-----
From: dbdoclet-bounce@xxxxxxxxxxxxx [mailto:dbdoclet-bounce@xxxxxxxxxxxxx] On 
Behalf Of Michael Fuchs
Sent: Wednesday, April 18, 2007 11:17 PM
To: dbdoclet@xxxxxxxxxxxxx
Subject: [dbdoclet] Re: dbdoclet 1.7 DocBook-XML Problems and PDF lines too long

Hello Udo,

thank you for using dbdoclet and your report.

1) I will fix this in version 1.8
2) I wii fix this in version 1.8
3) I will have a look at this, but because dbdoclet produces DocBook
XML, it can't (and don't want to ) consider certain output media.
I suppose you disabled the option "Full Qualified Names". If there are
any remaining full qualified names int the output, please send me the
detailed location.
I will fix them as soon as possible.

Regards
Michael

Other related posts: