
| Key: |
LPP-4534
|
| Type: |
Task
|
| Status: |
Closed
|
| Resolution: |
Fixed
|
| Priority: |
P1
|
| Assignee: |
Unassigned
|
| Reporter: |
Benjamin Shine
|
| Votes: |
0
|
| Watchers: |
0
|
|
If you were logged in you would be able to see more operations.
|
|
|
| Severity: |
Minor
|
| Fixed in Change#: |
6,295
|
| Runtime: |
N/A
|
| Fix in hand: |
False
|
|
Make a left-pane navigator for the OL4 reference.
|
|
Description
|
Make a left-pane navigator for the OL4 reference. |
Show » |
|
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-4534Make a left-nav index navigator for OL 4 docsTechnical 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