Change 20070829-ben-D by [EMAIL PROTECTED] on 2007-08-29 18:33:48 PDT
    in /Users/ben/src/svn/openlaszlo/branches/wafflecone
    for http://svn.openlaszlo.org/openlaszlo/branches/wafflecone

Summary: A simple HTML left-nav for OL4 reference

New Features:

Bugs Fixed: LPP-4534 Make a left-nav index navigator for OL 4 docs

Technical Reviewer: max (pending)
QA Reviewer: frisco (pending)
Doc Reviewer: frisco

Documentation:
The script navbuilder.rb (built with ruby 1.8.6) generates
index-generated.html, which is itself source controlled. To
update the contents of the generated index, see
docs/src/reference/navbuilder/navbuilder.rb
In a nutshell, it's
$ ruby navbuilder.rb > index-generated.html
then check in modified index-generated.html

The ant scripts for building the reference copy two html
files into the reference output directory; once there,
access at http://localhost:8080/docs/reference/index-frames.html

Release Notes:

Details:
navbuilder.rb is a one-off; it probably shouldn't be
used much in the future for index generation. We should
probably make the index the "right" way with docbook.
On the other hand, this script executes in approximately
no time at all, and the doc build takes around an hour.

This index is not linked in from anywhere yet. I'm not
sure it should be; we'll wait to see what the team
wants to do with it.


Tests:
http://localhost:8080/wafflecone/docs/reference/index-frames.html

Files:
M      docs/src/build.xml
A      docs/src/reference/navbuilder
A      docs/src/reference/navbuilder/index-frames.html
A      docs/src/reference/navbuilder/index-generated.html
A      docs/src/reference/navbuilder/navbuilder.rb

Changeset: http://svn.openlaszlo.org/openlaszlo/patches/20070829-ben- D.tar

Reply via email to