Author: ben
Date: 2007-11-19 14:42:21 -0800 (Mon, 19 Nov 2007)
New Revision: 7327
Added:
openlaszlo/trunk/docs/src/reference/components-index.dbk
Modified:
openlaszlo/trunk/docs/src/build.xml
Log:
Change 20071119-ben-Q by [EMAIL PROTECTED] on 2007-11-19 14:38:30 PST
in /Users/ben/src/svn/openlaszlo/trunk
for http://svn.openlaszlo.org/openlaszlo/trunk
Summary: Only show "public" stuff in refguide, not "protected"
New Features:
Bugs Fixed:
Technical Reviewer: (pending)
QA Reviewer: (pending)
Doc Reviewer: (pending)
Documentation:
The reference guide was set up to generate reference for
members marked public or protected. To match the 3.4 reference,
I think we should only generate reference for stuff marked
public. Members are assumed to be public unless marked
private or protected.
This change also adds an in-progress build target,
components.ref.generate, which doesn't entirely work yet.
It is trying to be a fast way to build just the components
section of the reference guide.
Tests:
basecomponent reference should list "enabled" attribute,
but should not list "_enabled".
Modified: openlaszlo/trunk/docs/src/build.xml
===================================================================
--- openlaszlo/trunk/docs/src/build.xml 2007-11-19 22:41:58 UTC (rev 7326)
+++ openlaszlo/trunk/docs/src/build.xml 2007-11-19 22:42:21 UTC (rev 7327)
@@ -565,7 +565,7 @@
unless="reference.skip">
<property name="ref.file.in"
value="${reference.build.dir}/LaszloLibrary-verbose.js2doc"/>
- <property name="ref.visibility.filter" value="public protected"/>
+ <property name="ref.visibility.filter" value="public"/>
<property name="ref.show.comments" value="${show.comments}"/>
<property name="ref.show.fixmes" value="${show.fixmes}"/>
@@ -780,6 +780,73 @@
</target>
+ <!-- TESTING TARGETS (SUBSETS OF REFERENCE GUIDE) -->
+ <target name="components.ref.generate" depends="init">
+
+ <!-- Transform lzx components code into js2doc -->
+ <antcall target="lzx2js2doc.transform" inheritAll="true">
+ <param name="local.input.file" value="${components.dir}/library.lzx"/>
+ <param name="local.output.file"
value="${reference.build.dir}/components-raw.xml"/>
+ <param name="lzx.base.dir" value="${components.dir}"/>
+ <param name="lzx.root.path" value="lps/components/"/>
+ </antcall>
+
+ <copy
+ file="${reference.src.dir}/components-index.dbk"
+ todir="${reference.output.dir}"
+ />
+
+ <echo message="done making js2doc for components" />
+ <ant dir="${lps.server.dir}" target="js2doc" inheritAll="false">
+ <property name="js2doc.args" value=" --libraryid test --reprocess --out
${reference.build.dir}/components.xml
${reference.build.dir}/components-raw.xml"/>
+ </ant>
+
+ <!-- make certain information explicit to ease processing by
js2doc2dbk.xsl -->
+ <style style="xsl/js2doc-verbose.xsl"
+ in="${reference.build.dir}/components-raw.xml"
+ out="${reference.build.dir}/components-verbose.js2doc">
+ <xmlcatalog refid="commonDTDs"/>
+ <xmlcatalog refid="docbook.local.xsl"/>
+ </style>
+
+ <!-- make components.dbk from js2doc -->
+ <property name="ref.file.in"
value="${reference.build.dir}/components-verbose.js2doc"/>
+ <property name="ref.visibility.filter" value="public"/>
+ <property name="ref.show.comments" value="${show.comments}"/>
+ <property name="ref.show.fixmes" value="${show.fixmes}"/>
+
+
+
+ <antcall target="dbk.topic.generate" inheritAll="true">
+ <param name="local.input.file" value="${ref.file.in}"/>
+ <param name="local.output.file"
value="${reference.build.dir}/compref.dbk"/>
+ <param name="filter.topic" value="Components"/>
+ <param name="visibility.filter" value="${ref.visibility.filter}"/>
+ <param name="dbk.show.comments" value="${ref.show.comments}"/>
+ <param name="dbk.show.fixmes" value="${ref.show.fixmes}"/>
+ </antcall>
+
+ <copy file="${reference.build.dir}/compref.dbk"
+ todir="${reference.output.dir}" />
+ <echo message="done making dbk for components" />
+
+ <!-- make components html from components.dbk -->
+
+ <antcall target="book.html.generate" inheritAll="true">
+ <param name="local.input.dir" value="${reference.output.dir}"/>
+ <param name="local.input.index" value="components-index.dbk"/>
+ <param name="local.output.dir" value="${docs.output.dir}"/>
+ <param name="local.output.index" value="reference/index.html"/>
+ <param name="local.output.depends.dir"
value="${docs.output.dir}/reference"/>
+ <param name="local.output.depends.set" value="*"/>
+ <param name="local.worksheet" value="xsl/refguide-html.xsl"/>
+ <param name="localdir" value="docs/reference/"/>
+ </antcall>
+
+
+ </target>
+
+
<!-- CONTRIBUTORS GUIDE -->
<target name="contribref.dbk.build"
depends="init,reference.js2doc.build,docbook.catalog.generate"
Copied: openlaszlo/trunk/docs/src/reference/components-index.dbk (from rev
7293, openlaszlo/trunk/docs/src/reference/index.dbk)
_______________________________________________
Laszlo-checkins mailing list
[email protected]
http://www.openlaszlo.org/mailman/listinfo/laszlo-checkins
