You are viewing a plain text version of this content. The canonical link for it is here.
Posted to kato-dev@incubator.apache.org by Steve Poole <sp...@googlemail.com> on 2009/07/12 10:38:38 UTC
Specification building
I've now got a trial process going which results in a pdf of the API
javadoc + a cover sheet. Its available here
http://hudson.zones.apache.org/hudson/view/Kato/job/org.apache.kato/org.apache.kato$kato.api/ws/target/site/spec/spec.pdf
The front sheet is not pretty (not sure why there are no margins) but I'm
sure its fixable, It relies on using a javadoc doclet from
http://aurigadoclet.sourceforge.net/ Once you've downloaded
aurigadoclet to your local environment you need to add a property to your
maven settings file like
<kato.aurigadoclet.jar>/home/spoole/aurigadoclet/bin/AurigaDoclet.jar</kato.aurigadoclet.jar>
I haven't figured out how to get the spec added to the hudson archived
artifacts list and we should determine how we want to publish it anyway -
off hudson or (I prefer) off the kato website.
Cheers
Re: Specification building
Posted by Steve Poole <sp...@googlemail.com>.
Just commited changes to replace the doc generation with an new process
using docbkx. Its a lot better , more flexible and produces a more
professional result. Not easy though - I had to write a doclet to spit out
javadoc as xml , added some xslt to convert to docbook and then use the
docbkx plugin to create the pdf. When the docbook is not well formed
docbkx blows up with minimal errors and you have to look at the intermediate
xsl:fo to figure out what happened.
Now need to ammend the xml doclet etc to get the resultant doc meaningful
and pretty.
On Fri, Jul 17, 2009 at 3:36 PM, Steve Poole <sp...@googlemail.com>wrote:
>
>
> On Fri, Jul 17, 2009 at 10:11 AM, ant elder <an...@apache.org> wrote:
>
>> On Tue, Jul 14, 2009 at 9:30 AM, Steve Poole<sp...@googlemail.com>
>> wrote:
>> > On Tue, Jul 14, 2009 at 9:21 AM, ant elder <an...@gmail.com> wrote:
>> >
>> >> On Sun, Jul 12, 2009 at 11:38 AM, Steve Poole<spoole167@googlemail.com
>> >
>> >> wrote:
>> >> > I've now got a trial process going which results in a pdf of the API
>> >> > javadoc + a cover sheet. Its available here
>> >> >
>> >>
>> http://hudson.zones.apache.org/hudson/view/Kato/job/org.apache.kato/org.apache.kato$kato.api/ws/target/site/spec/spec.pdf
>> >> >
>> >> > The front sheet is not pretty (not sure why there are no margins)
>> but
>> >> I'm
>> >> > sure its fixable, It relies on using a javadoc doclet from
>> >> > http://aurigadoclet.sourceforge.net/ Once you've downloaded
>> >> > aurigadoclet to your local environment you need to add a property to
>> your
>> >> > maven settings file like
>> >> >
>> >>
>> >> Could you explain a bit more about how aurigadoclet is being used? Its
>> >> license is GPL which is a dependency license that can't be used by ASF
>> >> projects, that may not be a problem depending how its being used but
>> >> i'm not sure i quite grok that yet. Is this generation of the javadoc
>> >> going to be part of the regular build or distribution process?
>> >>
>> >
>> > Aurigadoclet currently is used to produce the PDF file directly from the
>> > javadoc. I am looking into a way to replace it with a non GPL
>> version.
>> > I would like to have the spec document generated as part of the
>> regular
>> > build process.
>> >
>> >
>>
>> How about the Maven Docbkx plugin -
>> http://docs.codehaus.org/display/MAVENUSER/Docbkx+Maven+Plugin, don't
>> know if it does what you need but its quite flexible so could be worth
>> a look.
>>
>
> That's amazing Ant, just found it myself! -I've been playing with it to
> see what can do.
>
>
>>
>> ...ant
>>
>
>
Re: Specification building
Posted by Steve Poole <sp...@googlemail.com>.
On Fri, Jul 17, 2009 at 10:11 AM, ant elder <an...@apache.org> wrote:
> On Tue, Jul 14, 2009 at 9:30 AM, Steve Poole<sp...@googlemail.com>
> wrote:
> > On Tue, Jul 14, 2009 at 9:21 AM, ant elder <an...@gmail.com> wrote:
> >
> >> On Sun, Jul 12, 2009 at 11:38 AM, Steve Poole<sp...@googlemail.com>
> >> wrote:
> >> > I've now got a trial process going which results in a pdf of the API
> >> > javadoc + a cover sheet. Its available here
> >> >
> >>
> http://hudson.zones.apache.org/hudson/view/Kato/job/org.apache.kato/org.apache.kato$kato.api/ws/target/site/spec/spec.pdf
> >> >
> >> > The front sheet is not pretty (not sure why there are no margins) but
> >> I'm
> >> > sure its fixable, It relies on using a javadoc doclet from
> >> > http://aurigadoclet.sourceforge.net/ Once you've downloaded
> >> > aurigadoclet to your local environment you need to add a property to
> your
> >> > maven settings file like
> >> >
> >>
> >> Could you explain a bit more about how aurigadoclet is being used? Its
> >> license is GPL which is a dependency license that can't be used by ASF
> >> projects, that may not be a problem depending how its being used but
> >> i'm not sure i quite grok that yet. Is this generation of the javadoc
> >> going to be part of the regular build or distribution process?
> >>
> >
> > Aurigadoclet currently is used to produce the PDF file directly from the
> > javadoc. I am looking into a way to replace it with a non GPL version.
> > I would like to have the spec document generated as part of the regular
> > build process.
> >
> >
>
> How about the Maven Docbkx plugin -
> http://docs.codehaus.org/display/MAVENUSER/Docbkx+Maven+Plugin, don't
> know if it does what you need but its quite flexible so could be worth
> a look.
>
That's amazing Ant, just found it myself! -I've been playing with it to see
what can do.
>
> ...ant
>
Re: Specification building
Posted by ant elder <an...@apache.org>.
On Tue, Jul 14, 2009 at 9:30 AM, Steve Poole<sp...@googlemail.com> wrote:
> On Tue, Jul 14, 2009 at 9:21 AM, ant elder <an...@gmail.com> wrote:
>
>> On Sun, Jul 12, 2009 at 11:38 AM, Steve Poole<sp...@googlemail.com>
>> wrote:
>> > I've now got a trial process going which results in a pdf of the API
>> > javadoc + a cover sheet. Its available here
>> >
>> http://hudson.zones.apache.org/hudson/view/Kato/job/org.apache.kato/org.apache.kato$kato.api/ws/target/site/spec/spec.pdf
>> >
>> > The front sheet is not pretty (not sure why there are no margins) but
>> I'm
>> > sure its fixable, It relies on using a javadoc doclet from
>> > http://aurigadoclet.sourceforge.net/ Once you've downloaded
>> > aurigadoclet to your local environment you need to add a property to your
>> > maven settings file like
>> >
>>
>> Could you explain a bit more about how aurigadoclet is being used? Its
>> license is GPL which is a dependency license that can't be used by ASF
>> projects, that may not be a problem depending how its being used but
>> i'm not sure i quite grok that yet. Is this generation of the javadoc
>> going to be part of the regular build or distribution process?
>>
>
> Aurigadoclet currently is used to produce the PDF file directly from the
> javadoc. I am looking into a way to replace it with a non GPL version.
> I would like to have the spec document generated as part of the regular
> build process.
>
>
How about the Maven Docbkx plugin -
http://docs.codehaus.org/display/MAVENUSER/Docbkx+Maven+Plugin, don't
know if it does what you need but its quite flexible so could be worth
a look.
...ant
Re: Specification building
Posted by Steve Poole <sp...@googlemail.com>.
On Tue, Jul 14, 2009 at 9:21 AM, ant elder <an...@gmail.com> wrote:
> On Sun, Jul 12, 2009 at 11:38 AM, Steve Poole<sp...@googlemail.com>
> wrote:
> > I've now got a trial process going which results in a pdf of the API
> > javadoc + a cover sheet. Its available here
> >
> http://hudson.zones.apache.org/hudson/view/Kato/job/org.apache.kato/org.apache.kato$kato.api/ws/target/site/spec/spec.pdf
> >
> > The front sheet is not pretty (not sure why there are no margins) but
> I'm
> > sure its fixable, It relies on using a javadoc doclet from
> > http://aurigadoclet.sourceforge.net/ Once you've downloaded
> > aurigadoclet to your local environment you need to add a property to your
> > maven settings file like
> >
>
> Could you explain a bit more about how aurigadoclet is being used? Its
> license is GPL which is a dependency license that can't be used by ASF
> projects, that may not be a problem depending how its being used but
> i'm not sure i quite grok that yet. Is this generation of the javadoc
> going to be part of the regular build or distribution process?
>
Aurigadoclet currently is used to produce the PDF file directly from the
javadoc. I am looking into a way to replace it with a non GPL version.
I would like to have the spec document generated as part of the regular
build process.
>
> ...ant
>
Re: Specification building
Posted by ant elder <an...@gmail.com>.
On Sun, Jul 12, 2009 at 11:38 AM, Steve Poole<sp...@googlemail.com> wrote:
> I've now got a trial process going which results in a pdf of the API
> javadoc + a cover sheet. Its available here
> http://hudson.zones.apache.org/hudson/view/Kato/job/org.apache.kato/org.apache.kato$kato.api/ws/target/site/spec/spec.pdf
>
> The front sheet is not pretty (not sure why there are no margins) but I'm
> sure its fixable, It relies on using a javadoc doclet from
> http://aurigadoclet.sourceforge.net/ Once you've downloaded
> aurigadoclet to your local environment you need to add a property to your
> maven settings file like
>
Could you explain a bit more about how aurigadoclet is being used? Its
license is GPL which is a dependency license that can't be used by ASF
projects, that may not be a problem depending how its being used but
i'm not sure i quite grok that yet. Is this generation of the javadoc
going to be part of the regular build or distribution process?
...ant
Re: Specification building
Posted by Steve Poole <sp...@googlemail.com>.
Thanks for pointing that out Adam - doc is now available of the wiki
http://cwiki.apache.org/confluence/display/KATO/JSR326Specification
On Sun, Jul 12, 2009 at 8:08 PM, Adam Pilkington <
pilkington.adam@googlemail.com> wrote:
> When I try and look at the spec I'm prompted for a user name and
> password - I'm not sure that I have one for the Hudson server and this
> may well be true for other people who want to take a look. Are you
> able to manually publish it to the kato website in the meantime (and I
> agree that ultimately this is where it should be automatically
> published in the future) ?
>
> 2009/7/12 Steve Poole <sp...@googlemail.com>:
> > I've now got a trial process going which results in a pdf of the API
> > javadoc + a cover sheet. Its available here
> >
> http://hudson.zones.apache.org/hudson/view/Kato/job/org.apache.kato/org.apache.kato$kato.api/ws/target/site/spec/spec.pdf
> >
> > The front sheet is not pretty (not sure why there are no margins) but
> I'm
> > sure its fixable, It relies on using a javadoc doclet from
> > http://aurigadoclet.sourceforge.net/ Once you've downloaded
> > aurigadoclet to your local environment you need to add a property to your
> > maven settings file like
> >
> >
> <kato.aurigadoclet.jar>/home/spoole/aurigadoclet/bin/AurigaDoclet.jar</kato.aurigadoclet.jar>
> >
> >
> > I haven't figured out how to get the spec added to the hudson archived
> > artifacts list and we should determine how we want to publish it anyway
> -
> > off hudson or (I prefer) off the kato website.
> >
> > Cheers
> >
>
>
>
> --
> Regards
>
> Adam Pilkington
>
Re: Specification building
Posted by Adam Pilkington <pi...@googlemail.com>.
When I try and look at the spec I'm prompted for a user name and
password - I'm not sure that I have one for the Hudson server and this
may well be true for other people who want to take a look. Are you
able to manually publish it to the kato website in the meantime (and I
agree that ultimately this is where it should be automatically
published in the future) ?
2009/7/12 Steve Poole <sp...@googlemail.com>:
> I've now got a trial process going which results in a pdf of the API
> javadoc + a cover sheet. Its available here
> http://hudson.zones.apache.org/hudson/view/Kato/job/org.apache.kato/org.apache.kato$kato.api/ws/target/site/spec/spec.pdf
>
> The front sheet is not pretty (not sure why there are no margins) but I'm
> sure its fixable, It relies on using a javadoc doclet from
> http://aurigadoclet.sourceforge.net/ Once you've downloaded
> aurigadoclet to your local environment you need to add a property to your
> maven settings file like
>
> <kato.aurigadoclet.jar>/home/spoole/aurigadoclet/bin/AurigaDoclet.jar</kato.aurigadoclet.jar>
>
>
> I haven't figured out how to get the spec added to the hudson archived
> artifacts list and we should determine how we want to publish it anyway -
> off hudson or (I prefer) off the kato website.
>
> Cheers
>
--
Regards
Adam Pilkington