pdfdoclet-devel Mailing List for PDFDoclet

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 422-6466

I have recently created a version of this doclet for Maven 2 and Java
1.6.

I want to push the updates back to the community. 

Dear developer,
sorry if my question is out of place here, but I could not found any information somewhere else.

The problem is that I can not run Pdfdoclet from an ant file. If I try to do this from a command line, it works perfect.
This is the command, which works in command line:
javadoc 
-classpath C:\tomcat-6.0.13\lib\jsp-api.jar;C:\tomcat-6.0.13\lib\servlet-api.jar 
-doclet com.tarsec.javadoc.pdfdoclet.PDFDoclet 
-docletpath jar/pdfdoclet-1.0.2-all.jar -pdf result.pdf 
-config example/html/config_html.properties 
-sourcepath c:\Eclipse3.3EE\eclipse\workspace\DWCT\java    
-subpackages de:businesscode  

This is the ant file (should be the same as above):

<?xml version="1.0" encoding="ISO-8859-1"?>
<project name="DWCTDoc" default="run">
    <property name="src.dir" value="src"/>
    <property name="classes.dir" value="bin"/>
    <taskdef name="docTask" 
        classname="de.businesscode.doc.DocTask" 
        classpath="${classes.dir}"/>
    <taskdef name="jsdoctoolkit" 
        classname="uk.co.darrenhurley.ant.tasks.JsDocToolkit" 
        classpath="jsdoctoolkit-0.3.jar;jsdoc_toolkit-1.4.1/app/js..jar"/>

    <target name="run" description="run the Task">
         <javadoc doclet="com.tarsec.javadoc.pdfdoclet.PDFDoclet"
                docletpath="C:/Eclipse3.3EE/eclipse/workspace/DWCTDoc/pdfdoclet-1.0.2/jar/pdfdoclet-1.0.2-all.jar"
                packagenames="de.businesscode.**"
                additionalparam="-pdf result.pdf 
                -config C:/Eclipse3.3EE/eclipse/workspace/DWCTDoc/pdfdoclet-1.0..2/example/html/config_html.properties"
                private="no" includenosourcepackages="false" 
                failonerror="0" 
                classpath="C:\tomcat-6.0.13\lib\jsp-api.jar;C:\tomcat-6.0.13\lib\servlet-api.jar">
                <sourcepath>
                    <pathelement location="C:/Eclipse3.3EE/eclipse/workspace/DWCT/java"/>
                </sourcepath>
         </javadoc>
     </target>
</project>

Thanks for your support.

Kind Regards,

Vadim Filippov

      __________________________________________________________
Gesendet von Yahoo! Mail.
Dem pfiffigeren Posteingang.
http://de.overview.mail.yahoo.com
Dear Open Source developer

I am doing a research project on "Fun and Software Development" in which I kindly invite you to participate.
You will find the online survey under http://fasd.ethz.ch/qsf/. The questionnaire consists of 53 questions and you will need about 15 minutes to complete it.

With the FASD project (Fun and Software Development) we want to define the motivational significance of fun when software developers decide to engage in Open Source projects. What is special about our research project is that a similar survey is planned with software developers in commercial firms. This procedure allows the immediate comparison between the involved individuals and the conditions of production of these two development models. Thus we hope to obtain substantial new insights to the phenomenon of Open Source Development.

With many thanks for your participation,
Benno Luthiger

PS:
The results of the survey will be published under http://www.isu.unizh.ch/fuehrung/blprojects/FASD/.
We have set up the mailing list fa...@we... for this study. Please see http://fasd.ethz.ch/qsf/mailinglist_en.html for registration to this mailing list.

_______________________________________________________________________

Benno Luthiger
Swiss Federal Institute of Technology Zurich
8092 Zurich

Mail: benno.luthiger(at)id.ethz.ch
_______________________________________________________________________
I have a comment where I have added a <pre></pre> section and pdfdoclet =
seems to ignore it, printing the section literally.  This is the only =
html directive I have in the page, so it is not an issue of invalid html =
syntax. It also prints &lt; literally rather than as a '<' character. =
However, when I run this file through the standard Javadoc, it properly =
formats both the pre section and the '<' character.

Hello everybody,

I've made available the new PDFDoclet 0.7.0 beta for
testing. You may download the project tarball here:

http://www.poweredge.ch/schoen/download/pdfdoclet-0.7.0-beta.tar.gz

Just unpack it and run "ant test-pdf" and "ant
example" to check out the results. Or your own tests,
if you have some, of course.

I'd be happy for any feedback, good and bad so I know
if I can release it or if there are any new bugs to be
fixed first.

Changes, as described in the HISTORY file are:

- Made index more compact by printing all page numbers
  of members (methods, classes, fields) with same name

  on the same line (like: doSomething 23, 35, 88).
- Added link to title page in outline
- Fixed problem with doclet hanging if a file (usually
  an image) was not found due to an invalid path.
  Now the doclet just ignores the image in those cases
  and completes the rest of the javadoc.
- Fixed several open bugs (see HISTORY)

Furthermore, I did some massive refactorings to split
the code into smaller pieces. In class PDFUtil, I 
removed most "create..." methods which created
customized PDF elements by introducing the new package
"elements". It contains customized subclasses of iText
PDF elements, which is IMHO more OO-like and easier to
maintain. 

Apart from that, other reorganisations were made as
well; a new class "Util" for generic utility-methods
was added, all "..Util" classes are in a new "util"
package, some methods were moved from "PDFUtil" to
"JavadocUtil" (where they actually belonged).

A lot of code has also been factored out of
"PDFDoclet" 
into the new classes "Inherited", "Overview",
"Summary" 
etc. It's still over 1000 lines of code, but I think 
it's already an improvement.

Thanks for your support. Have fun!

Regards,
Marcel Schoen

__________________________________
Do you Yahoo!?
Yahoo! Hotjobs: Enter the "Signing Bonus" Sweepstakes
http://hotjobs.sweepstakes.yahoo.com/signingbonus

0.5.1

bug # 811384 	Array method arguments are missing
brackets (wasn't included in the release notes)

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

fixed:

bug # 833186	all parameters in summaries have the name
of the first param

__________________________________
Do you Yahoo!?
Yahoo! SiteBuilder - Free, easy-to-use web site design software
http://sitebuilder.yahoo.com

On Wed, Oct 29, 2003 at 03:30:08PM -0800, Marcel Schoen wrote:
> > 1. Is there a way to control the order of the
> > packages in the finished
> >    document?  
> 
> Well, there wasn't until about one hour ago. Because
> so far I didn't really care too much. But after
> receiving your mail, I thought I might look into it.
> Well, thanks to some late contributions of some other
> guy (which allowed to create javadoc for single
> classes as well), it was very easy to solve. I just
> had to change one single word in the sourcecode (from
> "HashMap" to "TreeMap" :-)) Now the packages are
> sorted alphabetically.

Sorted alphabetically is nice, but control is what I was really seeking.
It would be nice to be able to specify the order in which they're to be
displayed.  If you're using a TreeMap the addition might be as simple as
passing into the TreeMap constructor a customer comparitor like this:

new TreeMap(new Comparator() {
    public int compare(Object packageName1, Object packageName2) {
        String packageOrder = WhereEverYouGetSettings.get("sort.order")
            + ",";
        int retval = packageOrder.indexOf(packageName1 + ",",
            packageName2 + ",");
        return (retval != 0)
            ? retval
            : ((String)pacakgeName1).compareTo(pacakgeName2);
    }
});

Assuming a comma separated list of packages was available to specify
sort order, that would put the packages in the specified order if
they're present in the order speficification string or in alphabetical
order at the start of the list if they're not.  At least my quick 'n'
dirty mental email compiler tells me it would. :)

> > 2. My internal links aren't working and I can't
> > figure out why.  I've
> >    attached my build.xml and its output.  I'm pretty
> > sure the @see
> >    syntax is correct as the links work w/ Sun's
> > default doclet.
> 
> I think I'm missing something here. What do your @see
> tags look like, exactly? Maybe you can send me an
> example .java sourcefile. Or the entire source, if you
> want, so I can try to reproduce the problem.

I've attached a tarball which contains the source for two classes, the
resulting .pdf (from 0.5.1), and my configuration properties file.  It
looks to me that RangeSet's parse method should have a link to the Range
class in it's @see clause, but it's not showing up.  Did I do something
stupid and negelect to turn links on somewhere?  I'm invoking the doclet
with an ant call that looks like this:

      <javadoc
        docletpathref="dockletpath"
        classpathref="classes"
        doclet="com.tarsec.javadoc.pdfdoclet.PDFDoclet"
        additionalparam
          ="-pdf ../technical/UserGuides/WebRaidAPI.pdf -debug -config config-pdfdoclet.properties"
        public="true"
        protected="false"
        private="false"
      >
        <fileset dir="../../Common/src/" includesfile="include-src"/>
        <fileset dir="../../WebRAID/src/" includesfile="include-src"/>
        <fileset dir="../../WebRAIDUtil/src/" includesfile="include-src"/>
      </javadoc>
      <echo
        message="created Documentation/technical/UserGuides/WebRaidAPI.pdf"/>
    </target>

I know the config-pdfdoclet.properties file is getting read as the title
shows up correctly.

Lastly, I entered a bug wherein summary blocks have the same parameter
name for all parameters.
http://sourceforge.net/tracker/index.php?func=detail&aid=833186&group_id=55507&atid=477255

I might be able to help out with these this weekend if you decide that
explict package ordering is something good and/or are able to reproduce
that bug.

Thanks again for a great little app,

-- 
Ry4an Brase - http://ry4an.org                                    /~\
'If you're not a rebel when you're 20 you've got no heart; if     \ /
 you're not establishment when you're 30 you've got no brain.'     X
             Join the ASCII ribbon campaign against HTML email    / \

Hi Bryan,

Thanx for your feedback! It's always greatly
appreciated! 

> 1. Is there a way to control the order of the
> packages in the finished
>    document?  

Well, there wasn't until about one hour ago. Because
so far I didn't really care too much. But after
receiving your mail, I thought I might look into it.
Well, thanks to some late contributions of some other
guy (which allowed to create javadoc for single
classes as well), it was very easy to solve. I just
had to change one single word in the sourcecode (from
"HashMap" to "TreeMap" :-)) Now the packages are
sorted alphabetically.

It's in the new version 0.5.1 which I just released.
You may download it from the SourceForge files page.

> 2. My internal links aren't working and I can't
> figure out why.  I've
>    attached my build.xml and its output.  I'm pretty
> sure the @see
>    syntax is correct as the links work w/ Sun's
> default doclet.

I think I'm missing something here. What do your @see
tags look like, exactly? Maybe you can send me an
example .java sourcefile. Or the entire source, if you
want, so I can try to reproduce the problem.

Regards,
Marcel Schoen

__________________________________
Do you Yahoo!?
Exclusive Video Premiere - Britney Spears
http://launch.yahoo.com/promos/britneyspears/

Wow, pdfdoclet is just was I've been needing.  No more .MIF and all the
associated hassles.

There are just a few questions/problems I've got that I can't figure
out.  Any help would be appreciated.

1. Is there a way to control the order of the packages in the finished
   document?  I tried altering the order of the packagenames attribute,
   but it didn't have any effect.

2. My internal links aren't working and I can't figure out why.  I've
   pretty much copied the HTML example exactly but my @see's are
   finding their targets.  Is there something I'm missing?  I've
   attached my build.xml and its output.  I'm pretty sure the @see
   syntax is correct as the links work w/ Sun's default doclet.

Thanks in advance for any help you might be able to provide,

-- 
Ry4an Brase - http://ry4an.org                                    /~\
'If you're not a rebel when you're 20 you've got no heart; if     \ /
 you're not establishment when you're 30 you've got no brain.'     X
             Join the ASCII ribbon campaign against HTML email    / \

testing....

__________________________________
Do you Yahoo!?
Yahoo! SiteBuilder - Free, easy-to-use web site design software
http://sitebuilder.yahoo.com

hi guys..

i was able to implement the "All Known Implementing
Classes:" for interfaces.. check out cvs for the
latest code,,

thanks,

bryan

__________________________________
Do you Yahoo!?
Yahoo! SiteBuilder - Free, easy-to-use web site design software
http://sitebuilder.yahoo.com

Hi folks,

I am currently working on PDFDoclet 0.5.0. A binary package (not the
project package) build can be downloaded here:

http://files.poweredge.ch
login: pdfdoclet
password: test4me

Of course the changes are in the CVS as well. Apart from the usual
countless small things like javadoc fixes, there are some major issues:

- Refactored HTML parsing by replacing the old parsing code with JTidy
- Improved nesting of HTML tags a little bit more (lists and nested lists,
for example, can now have links in their items etc.)
- Support for Japanese language (Chinese and Korean coming later)
- Upgraded some of the libraries in "ext-lib" to newer versions

I'll have to put the changes somewhat more detailled in the history file
later. However, you may already have some feedback or additions about the
new version.

Check out the "test-pdf" ANT target to get a small PDF which gives a
better overview of the PDFDoclets capabilities. I'd also greatly
appreciate if this test pdf (its in the "src3" subdirectory in "examples")
would be enhanced in the future to build a good showcase for the
PDFDoclet.

If you have any questions, requests, critics or whatever, just mail me.

Regards,
Marcel Schoen

FYI

A nice guy (named Jacek Podkanski) has done
some work to make the very ugly PDFDoclet website
look considerably nicer. Maybe in the future we
will get rid of frames completely, but for now
it's just easier for editing the content.

I know that you are programmers and not web
designers, but still, you might have some
comments on what should additionally be included
or done in a different way.

You can see the preview of the site here:

http://www.poweredge.ch/jpo

Feedback is welcome. I'll redirect it to and
discuss it with Jacek.

Regards,
Marcel

-- 
Marcel Schoen
Senior Software Engineer

tetrade ag
Rautistrasse 12
Postfach
CH-8047 zuerich

Fon:    +41  1 496 61 11
Fax:    +41  1 496 61 99
Direct: +41  1 496 61 30
Mobile: +41 79 334 48 72
E-Mail: mar...@te...
Web:    www.tetrade.ch

Hello everyone,

While working on the inclusion of new code from 
Tomasz Stanczak, I decided to add two new things 
to the project. 

First, there is a new target "format", which uses 
the "jalopy" library to automatically format the 
whole sourcecode. I urge everyone working on the 
project to use it in the future. Just call "ant 
format" before commiting code to the CVS or sending 
it to me. This will reduce the possibility of large 
CVS diffs created by source-editors with different 
settings (tabs instead of blanks, different 
indentation settings etc.). Of course, if you have 
any feedback on jalopy, let me know. I hope it will 
be helpful.

Second, for easier and quicker manual / visual test 
and verification, I introduced a 3rd source tree in 
the "examples" folder, with only two sourcefiles. 
The new ANT target "test-pdf" uses it to create a 
very small PDF, but with all features activated 
(title page, overview, index, summary tables etc.). 
This will allow everyone to verify much faster if 
any changes he did are OK, and - more important - if 
they didn't break any of the old functionality.
If you want to implement a new feature like support 
for another HTML tag, please insert such a tag into 
one of these sourcefiles, so that we have a very 
compact collection of more or less all testcases in 
these two sourcefiles.

The other two examples were originally thought to be 
more like real-world javadoc examples, so we may let 
them be as they are.

Regards,
Marcel

__________________________________________________
Do you Yahoo!?
The New Yahoo! Search - Faster. Easier. Bingo
http://search.yahoo.com

Hello everybody,

A new member in the PDFDoclet developer community 
(who unfortunatly cannot access the CVS directly 
due to firewall restrictions) has done a lot of 
new work. I'm currently going through it, but 
here are some main infos about it:

- HTML-processing has been improved partly, 
and parsing of special characters in text 
has been done with the ORO regexp package 
from Jakarta. Since this seems to be the 
newer and more complete and mature regexp 
package of Jakarta, we decided to go with it. 
Sorry for the inconvenience (I was a bit too 
quick to add the other regexp package to the 
project).
- <img>-tags are now supported
- Internal links with {@link link 
description}
- "overview.html" is supported
- Some problems fixed (as usual)
- Upgrade to "iText" version 0.98 (no code 
changes)
- And more (more details will be in the 
HISTORY file)
The changes should all be available tomorrow 
in the CVS. I would be happy if anyone could 
check it out, see if everything compiles and 
works fine, and cross-check the example PDFs 
for any new problems / irregularities etc. 
before creating a new release.

Thanx and regards,
Marcel

__________________________________________________
Do you Yahoo!?
The New Yahoo! Search - Faster. Easier. Bingo
http://search.yahoo.com

hhmm.. didn't realized that :D

ok... i'll fix that problem.... i'm going for a
vacation.... i'll fixed it when i get home :D just go
on with the planned release date... 

thanks,

bryan 