Documentation changes for 3.0.0 and port to Forrest

[Boris Kolpackov <bo...@codesynthesis.com>]

Hi Jason,

Jason Stewart <ja...@gmail.com> writes:

> So you're needing to know that whatever solution we choose it will
> meet the needs of the web site, and that we don't tie any release of
> Xerces with a website redesign, and that we work out a good migration
> plan for the site?

Yes, something along these lines.


> I think what I can do is migrate the existing information to forrest,
> and let everyone look it over. Then you all can give feedback.

Sounds good. There is another thing that we probably need to
take into account in this effort. I think it will be a good
idea to have online documentation (build instructions, API
references, etc.) for both 2.8.0 and 3.0.0. The reason for
this is that 3.0.0 introduces a number of backwards-
incompatible changes and I expect a sizable chunk of the
user base to stick to 2.x.y for some time.

My idea on how to do this is to have two sets of "menu links"
in the left "menu bar". One for 2.8.0 and one for 3.0.0 (some
links, e.g., "Charter", "Release Info", "Feedback", etc.) are
common for both releases and won't be in the release-specific
sections. In other words, the menu will look like this:

* Readme
* Charter
* Release Info

--------------
2.8.0:

* Installation
* Download
* Build Instructions

* Programming Guide
* Samples
* FAQs

* API Reference
* DOM C++ Binding
* Migration Guide

-----------------
3.0.0:

* Installation
* Download
* Build Instructions

* Programming Guide
* Samples
* FAQs

* API Reference
* DOM C++ Binding
* Migration Guide

-----------------

* Feedback
* Bug Reporting
* Mailing Lists

* Source Repository
* Applications


For this to work we will need to "divorce" the website source
from the library source itself (which is a good idea on its own)
as well as to figure out how to add some kind of labels (for
2.8.0 and 3.0.0) to the menu bar.

BTW, the way this menu bar is constructed is really brain-dead:
each menu entry is actually an image that is created by the
script. Do you think you can change this to something more
sane? Perhaps we could "steal" some ideas from other Apache
projects that are using Forrest for their website?

Supporting both releases in the existing documentation system
is not going to be easy so if Forrest can address the above
issues for us then I personally will become a very strong
supporter ;-).

Any thoughts?

Boris

---------------------------------------------------------------------
To unsubscribe, e-mail: c-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: c-dev-help@xerces.apache.org

Re: Documentation changes for 3.0.0 and port to Forrest

[Justin Dearing <zi...@gmail.com>]

Hi Boris,

Thanks I saw the jira ticker get resolved and I had a quick look at
the website. It all looks good. Later today I'll do a svn diff on the
machine I wrote the changes on just to double check.

Best regards,

Justin Dearing

On Nov 18, 2007 9:43 AM, Boris Kolpackov <bo...@codesynthesis.com> wrote:
> Hi Justin,
>
> Justin Dearing <zi...@gmail.com> writes:
>
> > On a side note, do you plan on reviewing my Jira patch for inclusion,
>
> Sorry, I've been swamped with other work for the last couple of weeks.
> I've reviewed and committed your patch with minor modifications. The
> regenerated docs are online. Let me know if you see anything missing.
>
> Thanks for writing the MinGW instructions!
>
>
> Boris
>
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: c-dev-unsubscribe@xerces.apache.org
> For additional commands, e-mail: c-dev-help@xerces.apache.org
>
>

---------------------------------------------------------------------
To unsubscribe, e-mail: c-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: c-dev-help@xerces.apache.org

Re: Documentation changes for 3.0.0 and port to Forrest

[Boris Kolpackov <bo...@codesynthesis.com>]

Hi Justin,

Justin Dearing <zi...@gmail.com> writes:

> On a side note, do you plan on reviewing my Jira patch for inclusion,

Sorry, I've been swamped with other work for the last couple of weeks.
I've reviewed and committed your patch with minor modifications. The
regenerated docs are online. Let me know if you see anything missing.

Thanks for writing the MinGW instructions!

Boris


---------------------------------------------------------------------
To unsubscribe, e-mail: c-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: c-dev-help@xerces.apache.org

Re: Documentation changes for 3.0.0 and port to Forrest

[Justin Dearing <zi...@gmail.com>]

Hi Boris,

On Nov 16, 2007 2:11 PM, Boris Kolpackov <bo...@codesynthesis.com> wrote:
> Any thoughts?

I think splitting the documentation off is a good idea. You can
probably use svn symlinks to distribute a version of the documentation
with the source code that when built only deals with that version.

On a side note, do you plan on reviewing my Jira patch for inclusion,
or do you think a migration to Forrest should be performed first.

Regards,

Justin Dearing

---------------------------------------------------------------------
To unsubscribe, e-mail: c-dev-unsubscribe@xerces.apache.org
For additional commands, e-mail: c-dev-help@xerces.apache.org