Author: ben
Date: 2007-08-30 15:35:20 -0700 (Thu, 30 Aug 2007)
New Revision: 6295
Added:
openlaszlo/branches/wafflecone/docs/src/reference/navbuilder/
openlaszlo/branches/wafflecone/docs/src/reference/navbuilder/index-frames.html
openlaszlo/branches/wafflecone/docs/src/reference/navbuilder/index-generated.html
openlaszlo/branches/wafflecone/docs/src/reference/navbuilder/navbuilder.rb
Modified:
openlaszlo/branches/wafflecone/docs/src/build.xml
Log:
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
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
Modified: openlaszlo/branches/wafflecone/docs/src/build.xml
===================================================================
--- openlaszlo/branches/wafflecone/docs/src/build.xml 2007-08-30 21:56:47 UTC
(rev 6294)
+++ openlaszlo/branches/wafflecone/docs/src/build.xml 2007-08-30 22:35:20 UTC
(rev 6295)
@@ -707,22 +707,26 @@
<param name="localdir" value="docs/reference/"/>
</antcall>
+
</target>
<target name="reference.resources"
depends="init,reference.preprocess,components.resources.generate"
unless="reference.skip">
+ <ant target="reference.frameset.generate" />
+
<mkdir dir="${contribref.build.dir}"/>
<antcall target="book.resources.generate" inheritAll="true">
<param name="local.input.dir" value="${reference.src.dir}"/>
<param name="local.build.dir" value="${reference.build.dir}"/>
<param name="local.output.dir" value="${reference.output.dir}"/>
</antcall>
+
</target>
<target name="reference" description="Build the reference"
- depends="init,reference.resources,reference.html.generate"
+
depends="init,reference.resources,reference.html.generate,reference.frameset.generate"
unless="reference.skip">
</target>
@@ -747,6 +751,15 @@
</apply>
</target>
+ <target name="reference.frameset.generate" depends="init"
+ description="Copy a hand-generated html index for the reference into the
output directory.">
+ <echo message="***gonna copy in reference frameset ***" />
+ <!-- To actually build or update the index-generated.html, see
navbuilder/navbuilder.rb -->
+ <copy todir="${reference.output.dir}">
+ <fileset dir="${reference.src.dir}/navbuilder"
includes="index*.html"/>
+ </copy>
+ </target>
+
<!-- CONTRIBUTORS GUIDE -->
<target name="contribref.dbk.build"
depends="init,reference.js2doc.build,docbook.catalog.generate"
Added:
openlaszlo/branches/wafflecone/docs/src/reference/navbuilder/index-frames.html
Property changes on:
openlaszlo/branches/wafflecone/docs/src/reference/navbuilder/index-frames.html
___________________________________________________________________
Name: svn:mime-type
+ text/html
Name: svn:eol-style
+ native
Added:
openlaszlo/branches/wafflecone/docs/src/reference/navbuilder/index-generated.html
Property changes on:
openlaszlo/branches/wafflecone/docs/src/reference/navbuilder/index-generated.html
___________________________________________________________________
Name: svn:mime-type
+ text/html
Name: svn:eol-style
+ native
Added:
openlaszlo/branches/wafflecone/docs/src/reference/navbuilder/navbuilder.rb
Property changes on:
openlaszlo/branches/wafflecone/docs/src/reference/navbuilder/navbuilder.rb
___________________________________________________________________
Name: svn:mime-type
+ text/plain
Name: svn:eol-style
+ native
_______________________________________________
Laszlo-checkins mailing list
[email protected]
http://www.openlaszlo.org/mailman/listinfo/laszlo-checkins
