FYI -- no review necessary at this time.
Change 20071015-ben-y by [EMAIL PROTECTED] on 2007-10-15 16:25:23 PDT
in /Users/ben/src/svn/openlaszlo/branches/paperpie/docs/src
for http://svn.openlaszlo.org/openlaszlo/branches/paperpie/docs/src
Summary: Add left nav for reference
New Features: left nav for reference
Documentation:
This change reinstates the lzx app, nav.lzx, which was the left-frame
nav in the 3.4 reference.
nav/nav.lzx is the original lzx app from 3.4.
nav/toc.xml is a standin for a real table of contents, which will
have to be
either hand-generated or generated with tools that know what
topics each
reference page belongs in. (js2doc annotates each class with
what topic
it should be part of, but the new toolchain is not yet aware of
that
information. However, the TOC is relatively static, so it won't
hurt
much to generate and maintain this by hand, until the tools are
smartified.)
nav/classes.xml, and nav/tags.xml are generated contents lists
for nav.lzx. They are generated by navxmlbuilder.rb, a ruby
script which only needs to be run by a developer when updating
the classes.xml and tags.xml. This script just looks at
filenames in directories; it is not js2doc-aware.
(The addition of this script does not make the developer
build require ruby; the entire project will build and
run without even trying to execute this script.)
docs/src/build.xml copies the files necessary for the live nav
app to run into the reference directory,. It overwrites
the docbook-generated index.html; while this goes against
100% pure docbook philosophy, I've decided that it's
more appropriate to design and maintain our own table
of contents and home page, than to convince docbook to do
it for us.
welcome.html is the welcome page from the 3.4 reference, with
just the tiniest tweaking to make sense for 4.1. This page
will definitely require careful editorial review. The links
on this page are probably broken.
Release Notes:
nav.lzx does not currently work in dhtml; this needs to be investigated.
The layout of nav.lzx is not quite right since we no longer have
the lztahoe8 font.
Details:
Tests:
ant clean doc
http://localhost:8080/paperpie/docs/reference/
Note that the left-nav app is back. Click on any
of the tabs or any of the entries in the tab, notice
that the associated reference page appears in the
right-hand frame.
Files:
A nav
A nav/nav.lzx
A nav/toc.xml
A nav/classes.xml
A nav/tags.xml
M build.xml
M reference/navbuilder/index-frames.html
A reference/navbuilder/navxmlbuilder.rb
A + reference/welcome.html
Changeset: http://svn.openlaszlo.org/openlaszlo/patches/20071015-ben-
y.tar
