History | Log In     View a printable version of the current page.  
Issue Details (XML | Word | Printable)

Key: LPP-4534
Type: Task Task
Status: Closed Closed
Resolution: Fixed
Priority: P1 P1
Assignee: Unassigned
Reporter: Benjamin Shine
Votes: 0
Watchers: 0
Operations

If you were logged in you would be able to see more operations.
OpenLaszlo

Make a left-nav index navigator for OL 4 docs

Created: 20/Aug/07 02:04 PM   Updated: 24/Oct/07 01:21 PM
Component/s: Doc Tools
Affects Version/s: 4.0.5WaffleCone
Fix Version/s: 4.0.5WaffleCone

Time Tracking:
Not Specified

Severity: Minor
Fixed in Change#: 6,295
Runtime: N/A
Fix in hand: False


 Description  « Hide
Make a left-pane navigator for the OL4 reference.

 All   Comments   Work Log   Change History      Sort Order: Ascending order - Click to sort in descending order
Benjamin Shine - 30/Aug/07 04:27 PM
Fixed in wafflecone in r6295:
r6295 | ben | 2007-08-30 15:35:20 -0700 (Thu, 30 Aug 2007) | 45 lines
Changed paths:
   M /openlaszlo/branches/wafflecone/docs/src/build.xml
   A /openlaszlo/branches/wafflecone/docs/src/reference/navbuilder
   A /openlaszlo/branches/wafflecone/docs/src/reference/navbuilder/index-frames.html
   A /openlaszlo/branches/wafflecone/docs/src/reference/navbuilder/index-generated.html
   A /openlaszlo/branches/wafflecone/docs/src/reference/navbuilder/navbuilder.rb

Change 20070829-ben-D by ben@slim.local 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
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

Mamye Kratt - 24/Oct/07 01:21 PM
(trunk build r6893)
navbar is there, not real pretty but there.