Suggestion for the packaging structure of Xalan 1.6

[Dmitry Hayes <dm...@ca.ibm.com>]

Dear XalanC developers/users !

I'd  suggest to build 3 types of packages for the upcoming XalanC version
1.6 :

1. Source package (for potential developers)
      Contains:
            The result of checking out  from CVS  ( the code source + the
docs source)

2. Binary package (for customers)
      Contains:
            "Source package" + binaries ( executable files , libs, dlls,
.so files ) + result of compilation of the docs (html files)

3. Docs package
      Contains:
            "Result of compilation of the docs", html files


"Source of the docs" are  XML files from "xml-xalan/c/xdocs" directory .

"The result of compilation of docs" are  HTML files from "xml-xalan/c/docs"
directory .

Any opinions, comments and additions are very welcome.

Dmitry Hayes
XSLT Development

RE: Suggestion for the packaging structure of Xalan 1.6

[Don McClimans <dm...@IntiElectronics.com>]

I'm not sure what the protocol is here.  I have replied to both lists (as
the original message was posted). I only subscribe to the xalan-c-users
list, not the xalan-dev list.

I agree this would be nice packaging.

In addition, if anyone has the energy, it would be nice if the windows
binary distribution turned on the options in Doxygen to build a compiled
HTMLHelp (chm) file for the API documentation.

For windows users, the chm file has advantages -- it's much smaller, it's
only one file to move around, and it contains an index and the ability to
search. All of this is automatically generated by Doxygen (and the HTMLHelp
compiler).

Another benefit is that you can avoid (hide actually) the very long file
names generated by Doxygen, which are a problem if you try to burn the xalan
doc directories to CDR or DVD, because the filenames are too long for CD
formats (even with "relaxed restrictions"). I notice this because xalan is
in my directory tree that gets backed up, and I'm using DVD to back up these
days. :)

As I recall you have to use a later version of doxygen than is currently
being used (based on the doxyfile) to generate chm files, but everything
worked OK when I did this. If anyone cares I could dig out my notes on what
I did to create this.

I would then suggest including just the chm file (not the html files) in the
windows binary distribution, and I would provide two Docs packages, one just
the chm file (for windows users), the other the html files (for anyone).

I realize this is more work, so understand if it doesn't happen. Though once
you've got it set up, it's hardly any work at all. In particular, you can
put the doc build into the make files (that is, vc dsp and dsw files).
Anyway, if this doesn't happen, and anyone is interested in the chm file,
I'd be happy to provide it, or post it where it can be downloaded. I've
currently got the chm file built from a 1.5 interim snapshot, but I'll be
moving to 1.6 when that is released.

Don


-----Original Message-----
From: Dmitry Hayes [mailto:dmitryh@ca.ibm.com]
Sent: Tuesday, July 22, 2003 10:53 AM
To: xalan-dev@xml.apache.org
Cc: xalan-c-users
Subject: Suggestion for the packaging structure of Xalan 1.6






Dear XalanC developers/users !

I'd  suggest to build 3 types of packages for the upcoming XalanC version
1.6 :

1. Source package (for potential developers)
      Contains:
            The result of checking out  from CVS  ( the code source + the
docs source)

2. Binary package (for customers)
      Contains:
            "Source package" + binaries ( executable files , libs, dlls,
.so files ) + result of compilation of the docs (html files)

3. Docs package
      Contains:
            "Result of compilation of the docs", html files


"Source of the docs" are  XML files from "xml-xalan/c/xdocs" directory .

"The result of compilation of docs" are  HTML files from "xml-xalan/c/docs"
directory .

Any opinions, comments and additions are very welcome.

Dmitry Hayes
XSLT Development