mockobjects-java-dev

[MO-java-dev] Web site generation question

[Vincent M. <vm...@pi...>]

Hi,

I've been trying the web site generation by going in doc/ and typing
"ant -f site.xml site".

However, I was surprised to find that the generated HTML in out/ does
not come from the xdocs but from static HTML files in doc/html

Could someone tell me what's the status and where the project is going
for web site generation?

Would you like to move to Maven for building the mockobjects project in
the future? If so, I can very quickly migrate the doc generation to
Maven and produce a site which looks like (http://maven.apache.org).

Thanks
-Vincent

Re: [MO-java-dev] Web site generation question

[Jeff M. <jef...@mk...>]

On Wed, 2003-05-14 at 16:11, Vincent Massol wrote:
> Hi,
>=20
> I've been trying the web site generation by going in doc/ and typing
> "ant -f site.xml site".
>=20
> However, I was surprised to find that the generated HTML in out/ does
> not come from the xdocs but from static HTML files in doc/html
>=20
> Could someone tell me what's the status and where the project is going
> for web site generation?

Basically we ran into problems with the xdocs stuff. As far as I know
style book has never had an official release and there was several
different incompatible version floating around at one time. This made it
very difficult for someone to just checkout the project and build the
website.

People were also saying they where put off editing the docs because of
the unfamiliar syntax.

Since all you really need for most of the site is a template to wrap the
menus around the pages it seemed fairly easy to use very simple html
pages and a little bit of java to wrap them in the template.

This way we get away from the external dependencies & people can use any
old html editor to edit the pages.

>=20
> Would you like to move to Maven for building the mockobjects project in
> the future? If so, I can very quickly migrate the doc generation to
> Maven and produce a site which looks like (http://maven.apache.org).
>=20

Don't have to much of a problem with this if you want to do it. Though
I'm getting lazy these days and resent having to install anything I
can't just get from www.jpackage.org (can't see maven there yet), and
I've looked on the maven site and can't see any mention of how you
manage adhoc pages within the site or what syntax is used. You've
probably got a much better handle on this than me.

--=20

jeff martin
information technologist
mkodo limited

mobile: 44 (0) 78 55 478 331
phone: 44 (0) 20 77 29 45 45
email: jef...@mk...

www.mkodo.com

73 Leonard St, London, EC2A 4QS. U.K

RE: [MO-java-dev] Web site generation question

[Vincent M. <vm...@pi...>]

> -----Original Message-----
> From: moc...@li...
> [mailto:moc...@li...] On Behalf Of
> Jeff Martin
> Sent: 14 May 2003 18:15
> To: 'Mockobjects-Java-Dev'
> Subject: Re: [MO-java-dev] Web site generation question
> 
> On Wed, 2003-05-14 at 16:11, Vincent Massol wrote:
> > Hi,
> >
> > I've been trying the web site generation by going in doc/ and typing
> > "ant -f site.xml site".
> >
> > However, I was surprised to find that the generated HTML in out/
does
> > not come from the xdocs but from static HTML files in doc/html
> >
> > Could someone tell me what's the status and where the project is
going
> > for web site generation?
> 
> Basically we ran into problems with the xdocs stuff. As far as I know
> style book has never had an official release and there was several
> different incompatible version floating around at one time. This made
it
> very difficult for someone to just checkout the project and build the
> website.

Yes, stylebook is dead. But that shouldn't have been an issue. Just put
the stylebook jar in the project lib.

> 
> People were also saying they where put off editing the docs because of
> the unfamiliar syntax.

Never heard that one yet... :-) I'm surprised any jakarta project gets
any doc written at all in this case... :-)

> 
> Since all you really need for most of the site is a template to wrap
the
> menus around the pages it seemed fairly easy to use very simple html
> pages and a little bit of java to wrap them in the template.

Yes, that's the point of the xdocs... :-) They use a simplified HTML
syntax that has not style in it ;-)

As for the java part, are we reinventing XSL? :-) 

Over on Cactus land, we have a simple XSL stylesheet to transform our
xdocs to HTML and it works very nicely (check:
http://jakarta.apache.org/cactus). If you're interested in could make
our xdocs works with it?

> 
> This way we get away from the external dependencies & people can use
any
> old html editor to edit the pages.

Fine, but HMTL editors will almost always add lots of style elements and
are usually not able to conform to a given DTD... Better use a good XML
editor.

> 
> >
> > Would you like to move to Maven for building the mockobjects project
in
> > the future? If so, I can very quickly migrate the doc generation to
> > Maven and produce a site which looks like (http://maven.apache.org).
> >
> 
> Don't have to much of a problem with this if you want to do it. Though
> I'm getting lazy these days and resent having to install anything I
> can't just get from www.jpackage.org (can't see maven there yet), and
> I've looked on the maven site and can't see any mention of how you
> manage adhoc pages within the site or what syntax is used. You've
> probably got a much better handle on this than me.

Ok, what I can do if you're interested is simply bring the Cactus
stylesheets and adapt the xdocs to match.

Thanks Jeff for the explanation! Now we need to know what we want:
- remove the xdocs from CVS altogether?
- or continue to use the xdocs (which are really simplified HTML) and
simply perform a simple XSLT transform (using the Ant <style> task)?

Thanks
-Vincent

> 
> --
> 
> jeff martin
> information technologist
> mkodo limited
> 
> mobile: 44 (0) 78 55 478 331
> phone: 44 (0) 20 77 29 45 45
> email: jef...@mk...
> 
> www.mkodo.com
> 
> 73 Leonard St, London, EC2A 4QS. U.K

Re: [MO-java-dev] Web site generation question

[Steve F. <st...@m3...>]

Vincent Massol wrote:
> Thanks Jeff for the explanation! Now we need to know what we want:
> - remove the xdocs from CVS altogether?
> - or continue to use the xdocs (which are really simplified HTML) and
> simply perform a simple XSLT transform (using the Ant <style> task)?

There's a further issue. Joe has kindly set us up with a project wiki 
which should reduce some of the pain of keeping the site up to date.

My suggestion is to do whichever option is easiest for now, just to get 
the release out, and then think about what to do next.

Part of the problem is that I don't think anyone's active in any of the 
jakarta projects, so there's a (small) learning curve for working with 
the tools that, frankly, we haven't had time to climb. I'm also all for 
reducing dependencies on other infrastructure, given that it's such a 
small project.

S.

RE: [MO-java-dev] Web site generation question

[Vincent M. <vm...@pi...>]

> -----Original Message-----
> From: Steve Freeman [mailto:st...@m3...]
> Sent: 15 May 2003 03:43
> To: Vincent Massol
> Cc: 'Jeff Martin'; 'Mockobjects-Java-Dev'
> Subject: Re: [MO-java-dev] Web site generation question
> 
> Vincent Massol wrote:
> > Thanks Jeff for the explanation! Now we need to know what we want:
> > - remove the xdocs from CVS altogether?
> > - or continue to use the xdocs (which are really simplified HTML)
and
> > simply perform a simple XSLT transform (using the Ant <style> task)?
> 
> There's a further issue. Joe has kindly set us up with a project wiki
> which should reduce some of the pain of keeping the site up to date.

Oh ok. That's cool. What's the URL? Let's move all our stuff on the wiki
if we all agree then.

> 
> My suggestion is to do whichever option is easiest for now, just to
get
> the release out, and then think about what to do next.
> 
> Part of the problem is that I don't think anyone's active in any of
the
> jakarta projects, so there's a (small) learning curve for working with
> the tools that, frankly, we haven't had time to climb. I'm also all
for
> reducing dependencies on other infrastructure, given that it's such a
> small project.

Ok. I just needed to know what we should use because I have been
updating the xdocs files and found that when generating the web site,
our build wasn't processing them any more! So I have done some work for
nothing...

I'd like to get the wiki URL, quickly move all our stuff and remove all
the doc/ directory from our CVS (I'd still be in the Attic though in
case we need to go back to it in the future).

Is that ok?

Thanks
-Vincent

> 
> S.
> 

Re: [MO-java-dev] Web site generation question

[Joe W. <jo...@tr...>]

>
>
>Oh ok. That's cool. What's the URL? Let's move all our stuff on the wiki
>if we all agree then.
>
http://wiki.truemesh.com/mockobjects/

It's naked at the moment but easy to grow. If you setup user preferences 
you can be notified of any changes via email by using the .* regexp.

-joe

Re: [MO-java-dev] Web site generation question

[Steve F. <st...@m3...>]

Once you think it's ready, we can flip the home page on mockobjects.com

S.

Joe Walnes wrote:
>>
>>
>> Oh ok. That's cool. What's the URL? Let's move all our stuff on the wiki
>> if we all agree then.
>>
> http://wiki.truemesh.com/mockobjects/
> 
> It's naked at the moment but easy to grow. If you setup user preferences 
> you can be notified of any changes via email by using the .* regexp.
> 
> -joe

RE: [MO-java-dev] Web site generation question

[Vincent M. <vm...@pi...>]

Can we all work together to transfer what we have in CVS to this wiki.
I'll start working on that too tonight. Then tomorrow night I'll remove
our doc/ directory from CVS and perform the 0.08 release. Steve can
perform the DNS change tomorrow night too.

Is that ok?

Thanks
-Vincent

> -----Original Message-----
> From: Steve Freeman [mailto:st...@m3...]
> Sent: 15 May 2003 19:32
> To: Vincent Massol
> Cc: 'Mockobjects-Java-Dev'
> Subject: Re: [MO-java-dev] Web site generation question
> 
> Once you think it's ready, we can flip the home page on
mockobjects.com
> 
> S.
> 
> Joe Walnes wrote:
> >>
> >>
> >> Oh ok. That's cool. What's the URL? Let's move all our stuff on the
> wiki
> >> if we all agree then.
> >>
> > http://wiki.truemesh.com/mockobjects/
> >
> > It's naked at the moment but easy to grow. If you setup user
preferences
> > you can be notified of any changes via email by using the .* regexp.
> >
> > -joe