[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Ozone Doc Project



Per Nyfelt wrote:
> 
> > Hi All,
> > Was wondering how people felt about having an install for the docs.
> I think it works fine the way it is now.
Yes it works fine now.

> 
> > I'm not an ANT expert but here is my idea.
> >
> > 1. Zip up the contents of the style sheet as they change often.
> Wouldn't this mean a lot of work when a change is made (the zip file has to
> be updated every time a change is made)?
> > 2. Zip up the contents of the docbook dtd.
> > 3. Include both of these in CVS.
> >
> > Create a target to use the jar task to unzip these either as a separate
> > target or as part of a depends. If the target removes the zip file after
> > uncompressing we could have a little installed target that looks for the
> > zips and recommends to do the install if it is not installed yet.
> >
> > Is this a good idea?
> Maybe. What is the problem you like to solve by doing this?

The stylesheets that are included are being worked on frantically by
Norm Walsh and are on version 1.39 and I think that we include 1.29.
Since this is constantly changing it would make more sense to checkin
the zip file for this and the docbook DTDs that I'd like to include
also. I have a basic install worked out. It errors out if the zip file
is found and asks you to run 'ant install'. This way we could save time
on the one file download versus all the pieces and make it easy to
upgrade the stylesheets.

For people without constant access to the net, the dtd included could
help people be disconnected and still work since xalan wants the dtd
from the doctype prolog.

This is why I'd like to add these two zips and modify the build. BTW,
how do you build the new howto doc? Did you make a buch of new targets? 
> 
> >
> > What is the cvs command to ci binary files? cvs -kb add?
> yes, cvs add -kb <filename>
> 
> >
> > I'm still working on the Doc How to.
> 
> I am too :) Lets sync our different suggestions. I just put what i did in
> CVS src/howto/ozone-documentation-howto.xml and also a licence text as
> src/howto/ozone-documentation-licence.xml. I saw some problems that i tried
> to solve in this suggestion. As far as i can tell there is no legal body
> that holds Ozone copyright other than SMB so I put SMB as the copyright
> holder for the document and propose we do the same for everything else
> coming, that is if SMB agrees ;) Another possibility would be to use the GNU
> documentation licence. As you'll see this is a very rough and thin draft but
> i hope we can merge our versions and maybe spawn off some good discussion in
> the process :)

Okay, I was working on the tools and the process but I'll check it out.

> 
> > One other thing. Do we want to add one target for each document?
> > Somebody who has more ant experience may want to look at this. There is
> > a call task that could be used. The added target would just set some
> > variables for the in and out file and then call the target that does the
> > transform. I wanted to use the pattern task but couldn't get it to work.
> 
> I was thinking the same. The build would go through all XML files under src
> and process them with same style sheet using the patters of whatever.xml
> into whatever.html and whatever.pdf but i could not find a good way to
> traverse unspecified subdirectories. Take a look at build.xml in
> ozone-modules/ozoneXML - maybe you find some useful ideas there?

Okay, I will. I know we can use the antcall and set properties for the
file names. This means three small targets for each doc and the depends
lines change but if we only have a few docs this would work until we
find a better way or ant gets better.

Eric