Documentation problems and workaround

Because of the problems I was having using the documentation with Netscape on Linux (Java front end often freezes or crashes Netscape) I have made, and have been using an alternative index page. I have now updated it for the stable 3.0 release, and am making it publically available.

It has the following features:

  • Java not required
  • Does not use frames
  • Everything is on 1 page
  • Works with any browser
  • Allows bookmarking
  • Includes a page for browsing all the Open CASCADE header files.

    Everything is available for downloading here for anyone who is interested.

    This is only an alternative index page and header file index page. You still need to download the full documentation

    Feel free to send me any corrections or suggestions.

  • Douglas McCarthy's picture

    > Because of the problems I was having using
    > the documentation with Netscape on Linux
    > (Java front end often freezes or crashes
    > Netscape)

    In Netscape 4.7, this problem only occurs if you don't wait for the page to be fully displayed.

    I have made, and have been using
    > an alternative index page. I have now
    > updated it for the stable 3.0 release, and
    > am making it publically available. It has
    > the following features: Java not required
    > Does not use frames Everything is on 1
    > page Works with any browser Allows
    > bookmarking Includes a page for browsing
    > all the Open CASCADE header files.
    > Everything is available for downloading
    > here for anyone who is interested. This
    > is only an alternative index page and header
    > file index page. You still need to download
    > the full documentation Feel free to send
    > me any corrections or suggestions.

    Neither tar nor gunzip recognizes the format of your file.

    Could you check this please?

    Best regards,

    Douglas

    C R Johnson's picture

    > Neither tar nor gunzip recognizes the format
    > of your file.

    > Could you check this please?

    I just re-downloaded my file to check:

    zcat ../OCC-3.0-altindex-1.0.tar.gz | tar xvf -
    altindex.README
    altindex.htm
    allheaders3.0.htm
    anybrowser.gif

    Looks OK. zcat 1.2.4, tar (GNU tar) 1.13.17

    Um, maybe your ftp client used ascii mode?

    Robert Boehne's picture

    > It's clearly stated at the top of the
    > column, that you're in a TOC not an index.
    > In that context, gp is totally meaningless.

    > Obviously, an index is needed.
    > Unfortunately, this is a question of
    > resources, and these have been unavailable.

    If resources are unavailable, put the documentation in Open Source! It doesn't make much sense to have source code open sourced, then keep all the documentation locked away where only Matra can get at it.
    Everyone involved with Open CAS.CADE should read the short commentary on Netscape's failure with Mozilla (the open source version of Netscape Communicator) at http://www.jwz.org/gruntle/nomo.html
    It tells how Netscape made mistakes that doomed the project to failure. Hopefully it will tell us (Open Cascade developers) how to prevent our project from failing for the same reasons.

    Robert Boehne's picture

    > Given that everything has been published,
    > how can you talk about keeping anything
    > locked away?

    By 'locked away' I am referring to the fact that the source for the documentation is not part of the CVS repository, that none of your users outside of Matra have a clear and simple way to make improvements, additions or fix bugs in the documentation. If Matra maintains an iron fist on the source, not allowing others to contribute easily, Open CAS.CADE will eventually suffer from it.

    > Besides, the issue is a question of form,
    > not content, and I wrote that resources have
    > been unavailable, not that they are.