Forum OpenACS Development: Re: Installing Oracle 8.1.7 on Redhat 8.0

Collapse
Posted by Dan Wickstrom on
Well obviously, I'm not using Debian, so getting DocBook working was trial and error.  First, I searched for and installed all of the docbook rpms that I had on my install disk (actually iso images that I downloaded).  This also included installing all of the dependencies for docbook.  Next I played around tried to generate a single html file, but I kept getting an error on a undefined symbols (VERSION in this case).  Finally, I noticed the makefile and ran that, but it turned up a bunch of errors because the path names to the style sheets were wrong.  I then searched for the style sheets that were giving me errors and created symbolic links to match the paths in the error messages.  I was then able to run the makefile, and it worked, but it regenerated all of the html in acs-core-docs. Not wanting to checkin all of the these unchanged docs, I moved the acs-core-docs directory aside and  checked it out anew.  I then copied the .xml and .html files that I modified from my original directory to the newly checked out directory and checked them in.

Obviously, I've never used docbook before, but it seems that the bar for creating and updating documentation should be lower.  Something that should have taken me 30 seconds, took at least a half-hour or more.  What do we really get from using docbook other than the ablity to generate documents in other formats?  And do we really need to generate those other formats when html docs are so accessible?

Collapse
Posted by Jeff Davis on
It works pretty much out of the box on redhat 7.3. You do have to download the docbook xsl stuff but xsltproc and all the other dependencies are satisfied with a vanilla install (although there are some inconsistencies with the latest version of openacs.xsl and docbook). Maybe we should have a tarball of the docbook stuff and some clearer instructions on how to make things work. Also, I don't think anyone will fault you for making the change in the xml and just telling Roberto or Vinod about it...
Collapse
Posted by Dan Wickstrom on
For redhat 8.0, I used a vanilla install (I think they called it workstation install), and  while xsltproc was installed none of the docbook stuff was installed.  I was able to find the correct style sheets, but the rpm install puts them in a different location than expected by the current documentation build process.  A tarball with clearer instructions would probably go a long way to making it easier to update the docs.

I can't see passing all of the doc updates off to Roberto and Vinod, as that creates a bottleneck.  Not that I'm impugning their work, but I think it's better if any developer can easily update the documentation on their own.  After all, just recently, Roberto suggested we should halt all development work to fix the documentation.  Making the documentation easier to update, might help in making it so such extreme measures are not necessary.