Author: ben
Date: 2007-10-15 17:45:15 -0700 (Mon, 15 Oct 2007)
New Revision: 6853
Added:
openlaszlo/branches/paperpie/docs/src/nav/
openlaszlo/branches/paperpie/docs/src/nav/classes.xml
openlaszlo/branches/paperpie/docs/src/nav/nav.lzx
openlaszlo/branches/paperpie/docs/src/nav/tags.xml
openlaszlo/branches/paperpie/docs/src/nav/toc.xml
openlaszlo/branches/paperpie/docs/src/reference/navbuilder/navxmlbuilder.rb
openlaszlo/branches/paperpie/docs/src/reference/welcome.html
Modified:
openlaszlo/branches/paperpie/docs/src/build.xml
openlaszlo/branches/paperpie/docs/src/reference/navbuilder/index-frames.html
Log:
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.
Modified: openlaszlo/branches/paperpie/docs/src/build.xml
===================================================================
--- openlaszlo/branches/paperpie/docs/src/build.xml 2007-10-16 00:38:54 UTC
(rev 6852)
+++ openlaszlo/branches/paperpie/docs/src/build.xml 2007-10-16 00:45:15 UTC
(rev 6853)
@@ -445,7 +445,7 @@
<mkdir dir="${reference.build.dir}"/>
<property name="server.dir" value="${lps.server.dir}"/>
- <property name="js2doc.args" value="-v --dir ${reference.build.dir}
${LPS_HOME}/lps/includes/source/embednew.js" />
+ <property name="js2doc.args" value=" --dir ${reference.build.dir}
${LPS_HOME}/lps/includes/source/embednew.js" />
<ant dir="${server.dir}" target="js2doc" />
<jing rngfile="${server.dir}/lib/js2doc.rng">
@@ -465,7 +465,7 @@
</antcall>
<ant dir="${lps.server.dir}" target="js2doc" inheritAll="false">
- <property name="js2doc.args" value="-v --libraryid test --reprocess
--out ${reference.build.dir}/components.xml
${reference.build.dir}/components-raw.xml"/>
+ <property name="js2doc.args" value=" --libraryid test --reprocess --out
${reference.build.dir}/components.xml
${reference.build.dir}/components-raw.xml"/>
</ant>
</target>
@@ -481,7 +481,7 @@
</antcall>
<ant dir="${lps.server.dir}" target="js2doc" inheritAll="false">
- <property name="js2doc.args" value="-v --libraryid test --reprocess
--out ${reference.build.dir}/incubator.xml
${reference.build.dir}/incubator-raw.xml"/>
+ <property name="js2doc.args" value=" --libraryid test --reprocess --out
${reference.build.dir}/incubator.xml ${reference.build.dir}/incubator-raw.xml"/>
</ant>
</target>
@@ -706,16 +706,14 @@
<param name="local.worksheet" value="xsl/refguide-html.xsl"/>
<param name="localdir" value="docs/reference/"/>
</antcall>
+ <antcall target="reference.frameset.generate" />
-
</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}"/>
@@ -727,7 +725,7 @@
</target>
<target name="reference" description="Build the reference"
-
depends="init,reference.resources,reference.html.generate,reference.frameset.generate"
+ depends="init,reference.resources,reference.html.generate"
unless="reference.skip">
</target>
@@ -756,9 +754,22 @@
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
+ overwrite="true"
+ file="${reference.src.dir}/navbuilder/index-generated.html"
+ todir="${reference.output.dir}">
+ </copy>
+ <copy
+ overwrite="true"
+ file="${reference.src.dir}/navbuilder/index-frames.html"
+ tofile="${reference.output.dir}/index.html">
+ </copy>
+ <!-- Copy the nav.lzx app and the generated xml contents into the output
directory -->
<copy todir="${reference.output.dir}">
- <fileset dir="${reference.src.dir}/navbuilder"
includes="index*.html"/>
+ <fileset dir="nav" includes="*.*"/>
</copy>
+ <copy todir="${reference.output.dir}" file="reference/welcome.html" />
+
</target>
<!-- CONTRIBUTORS GUIDE -->
Added: openlaszlo/branches/paperpie/docs/src/nav/classes.xml
Property changes on: openlaszlo/branches/paperpie/docs/src/nav/classes.xml
___________________________________________________________________
Name: svn:mime-type
+ text/xml
Name: svn:eol-style
+ native
Added: openlaszlo/branches/paperpie/docs/src/nav/nav.lzx
Property changes on: openlaszlo/branches/paperpie/docs/src/nav/nav.lzx
___________________________________________________________________
Name: svn:mime-type
+ text/plain
Name: svn:eol-style
+ native
Added: openlaszlo/branches/paperpie/docs/src/nav/tags.xml
Property changes on: openlaszlo/branches/paperpie/docs/src/nav/tags.xml
___________________________________________________________________
Name: svn:mime-type
+ text/xml
Name: svn:eol-style
+ native
Added: openlaszlo/branches/paperpie/docs/src/nav/toc.xml
Property changes on: openlaszlo/branches/paperpie/docs/src/nav/toc.xml
___________________________________________________________________
Name: svn:mime-type
+ text/xml
Name: svn:eol-style
+ native
Modified:
openlaszlo/branches/paperpie/docs/src/reference/navbuilder/index-frames.html
===================================================================
---
openlaszlo/branches/paperpie/docs/src/reference/navbuilder/index-frames.html
2007-10-16 00:38:54 UTC (rev 6852)
+++
openlaszlo/branches/paperpie/docs/src/reference/navbuilder/index-frames.html
2007-10-16 00:45:15 UTC (rev 6853)
@@ -5,8 +5,8 @@
<TITLE>OpenLaszlo 4.0.x Reference</TITLE>
</HEAD>
<FRAMESET cols="20%, 80%" >
- <FRAME name="lzxdocnavframe" src="index-generated.html" />
- <FRAME name="content" src="index.html" />
+ <FRAME name="lzxdocnavframe" src="nav.lzx?target=content" />
+ <FRAME name="content" src="welcome.html" />
</FRAMESET>
</HTML>
Added:
openlaszlo/branches/paperpie/docs/src/reference/navbuilder/navxmlbuilder.rb
Property changes on:
openlaszlo/branches/paperpie/docs/src/reference/navbuilder/navxmlbuilder.rb
___________________________________________________________________
Name: svn:executable
+ *
Name: svn:mime-type
+ text/plain
Name: svn:eol-style
+ native
Added: openlaszlo/branches/paperpie/docs/src/reference/welcome.html
Property changes on:
openlaszlo/branches/paperpie/docs/src/reference/welcome.html
___________________________________________________________________
Name: svn:mime-type
+ text/html
Name: svn:eol-style
+ native
_______________________________________________
Laszlo-checkins mailing list
[email protected]
http://www.openlaszlo.org/mailman/listinfo/laszlo-checkins
