Generating Site Documentation

View: New views
4 Messages — Rating Filter:   Alert me  

Generating Site Documentation

by Larry Hohm :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

Does Ivy support anything similar to the Maven site plugin, for easily
maintaining a project web site?  I am looking for a good alternative to
Maven, and I read with great interest the Ivy documentation, and blogs
comparing it to Maven.  I found brief references to publishing a project,
but no discussion of how to generate site documentation.

Larry Hohm

Re: Generating Site Documentation

by Mondain :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

As far as I know it does not, it is only concerned with repository handling.
I believe it has publish / deploy capabilities but I have no experience with
those features.

Good luck,
Paul

On Thu, Jul 10, 2008 at 1:31 PM, Larry Hohm <larry.hohm@...> wrote:

> Does Ivy support anything similar to the Maven site plugin, for easily
> maintaining a project web site?  I am looking for a good alternative to
> Maven, and I read with great interest the Ivy documentation, and blogs
> comparing it to Maven.  I found brief references to publishing a project,
> but no discussion of how to generate site documentation.
>
> Larry Hohm
>



--
http://gregoire.org/
http://osflash.org/red5

Re: Generating Site Documentation

by Tjeerd Verhagen :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

No Ivy does not have site generation capabilities.

You could use Maven for that, or Stylebook from Ant. Or one of the other
projects like (no particular order):
- cocoon
- velocity / anakia / DocBook framework
- forrest
- or some other
It really depens on what kind of information you want to document  /
generate, and how to present it. And in what source format (DocBook, Dita,
other) it is.

If it is written documentation (like, use cases, manuals, etc) you can use
one of the above frameworks. Or is it generated information like javadoc,
and reports like CPD, FundBugs, JDpend, etc.? Then you'll need to run the
ant task and generate one html page (could be done through echo) to create
an index page.

Succes,

Tjeerd

On Thu, Jul 10, 2008 at 10:31 PM, Larry Hohm <larry.hohm@...> wrote:

> Does Ivy support anything similar to the Maven site plugin, for easily
> maintaining a project web site?  I am looking for a good alternative to
> Maven, and I read with great interest the Ivy documentation, and blogs
> comparing it to Maven.  I found brief references to publishing a project,
> but no discussion of how to generate site documentation.
>
> Larry Hohm
>

Re: Generating Site Documentation

by Xavier Hanin :: Rate this Message:

Reply to Author | View Threaded | Show Only this Message

On Fri, Jul 11, 2008 at 9:26 AM, Tjeerd Verhagen <tjeerd.verhagen@...>
wrote:

> No Ivy does not have site generation capabilities.
>
> You could use Maven for that, or Stylebook from Ant. Or one of the other
> projects like (no particular order):
> - cocoon
> - velocity / anakia / DocBook framework
> - forrest
> - or some other

We use xooki to maintain Ivy documentation, it's an in browser documentation
engine, which makes it very easy to edit pages and still benefit from text
based documentation (merge, patches, ...)


> It really depens on what kind of information you want to document  /
> generate, and how to present it. And in what source format (DocBook, Dita,
> other) it is.
>
> If it is written documentation (like, use cases, manuals, etc) you can use
> one of the above frameworks. Or is it generated information like javadoc,
> and reports like CPD, FundBugs, JDpend, etc.? Then you'll need to run the
> ant task and generate one html page (could be done through echo) to create
> an index page.

To generate and gather various reports you can have a look at glean:
http://jbrugge.com/glean/

Xavier


>
>
> Succes,
>
> Tjeerd
>
> On Thu, Jul 10, 2008 at 10:31 PM, Larry Hohm <larry.hohm@...> wrote:
>
> > Does Ivy support anything similar to the Maven site plugin, for easily
> > maintaining a project web site?  I am looking for a good alternative to
> > Maven, and I read with great interest the Ivy documentation, and blogs
> > comparing it to Maven.  I found brief references to publishing a project,
> > but no discussion of how to generate site documentation.
> >
> > Larry Hohm
> >
>



--
Xavier Hanin - Independent Java Consultant
http://xhab.blogspot.com/
http://ant.apache.org/ivy/
http://www.xoocode.org/
LightInTheBox - Buy quality products at wholesale price