Author: steveh
Date: Tue Aug 17 11:55:55 2004
New Revision: 36533
Removed:
incubator/beehive/trunk/netui/docs/tools/lib/jsptagrefschema.jar
incubator/beehive/trunk/netui/docs/tools/static_files/
incubator/beehive/trunk/netui/docs/tools/xslt/
Modified:
incubator/beehive/trunk/netui/ant/javadoc.xml
incubator/beehive/trunk/netui/docs/BUILDING_NETUI_DOCS.txt
incubator/beehive/trunk/netui/docs/tools/README.txt
incubator/beehive/trunk/netui/docs/tools/lib/jsptagrefdoclet.jar
Log:
(1) Placing the XSLT and static files (for the JSP tag library reference) into
a JAR file.
(2) New instructions for building netui docs.
(3) Added property for JSF jar to doc build file.
Modified: incubator/beehive/trunk/netui/ant/javadoc.xml
==============================================================================
--- incubator/beehive/trunk/netui/ant/javadoc.xml (original)
+++ incubator/beehive/trunk/netui/ant/javadoc.xml Tue Aug 17 11:55:55 2004
@@ -21,6 +21,7 @@
<pathelement path="${xbean.jar}"/>
<pathelement path="${jsr173.jar}"/>
<pathelement path="${controls.jar}"/>
+ <pathelement path="${jsf-api.jar}"/>
<pathelement path="${tools.jar}"/>
<pathelement path="${ant.jar}"/>
</path>
@@ -31,11 +32,9 @@
<echo
message="================================================================================"/>
<echo message="build - Cleans and builds all doc, copies the result to
the forrest site. "/>
<echo message="clean - Deletes the built netui docs and associated temp
files."/>
- <echo message="generate-taglib-ref - Generates the netui Tag Library
reference."/>
- <echo message="generate-class-ref - Generates the Page Flow class
reference, using the standard Javadoc doclet."/>
- <echo message="generate-taglib-ref-xml - sub task for generating the
netui Tag Library reference"/>
- <echo message="generate-taglib-ref-html - sub task for generating the
netui Tag Library reference"/>
<echo message="generate-conceptual-doc - not yet implemented"/>
+ <echo message="generate-class-ref - Generates the Page Flow class
reference, using the standard Javadoc doclet."/>
+ <echo message="generate-taglib-ref - Generates the netui Tag Library
reference."/>
<echo message="copy-to-forrest - Copies the built netui docs to the
forrest site."/>
<echo
message="================================================================================"/>
<echo message="|
|"/>
@@ -45,6 +44,7 @@
<!-- You must deploy netui before you run this target, or any of its
sub-targets. -->
<target name="build" description="Generate Javadoc for all core server and
tags">
<antcall target="clean"/>
+ <!--<antcall target="generate-conceptual-doc"/>-->
<antcall target="generate-class-ref"/>
<antcall target="generate-taglib-ref"/>
</target>
@@ -53,13 +53,8 @@
<delete dir="${docs.temp}" failonerror="false"/>
<delete dir="${build.dir}/docs" failonerror="false"/>
</target>
-
- <target name="generate-taglib-ref">
- <antcall target="generate-taglib-ref-xml"/>
- <antcall target="generate-taglib-ref-html"/>
- </target>
- <!-- The 'use' is set to currently set to 'false' because of Java bug
5055723.
+ <!-- The 'use' attribute is currently set to 'false' because of Java bug
5055723.
This bug will be fixed for the general release of JDK5.
Track the bug at:
http://bugs.sun.com/bugdatabase/view_bug.do?bug_id=5055723
When the fix arrives in JDK5, set use="true". -->
@@ -107,102 +102,50 @@
</javadoc>
</target>
- <target name="generate-taglib-ref-xml" description="Uses a custom doclet
to generate XML from Java source files.">
- <antcall target="copy-tld-files"/>
- <antcall target="insert-namespace-for-tld"/>
- <delete dir="${docs.temp}/xml/tagref" failonerror="false"/>
- <mkdir dir="${docs.temp}/xml/tagref"/>
- <javadoc classpathref="javadoc.classpath"
- destdir="${docs.temp}/xml/tagref">
- <doclet name="org.apache.beehive.netui.tools.doclet.jsptagref.JspTagDoc"
-
path="${docs.dir}/tools/lib/jsptagrefdoclet.jar;${docs.dir}/tools/lib/jsptagrefschema.jar;${xbean.jar};${jsr173.jar}">
- <param name="-source" value="1.5"/>
- <param name="-tlddir" value="${docs.temp}/tld"/>
- <param name="-breakiterator"/>
- </doclet>
- <link href="http://java.sun.com/j2se/1.5/docs/api/"/>
- <packageset dir="${src.dir}/tags-databinding">
- <include name="org/apache/beehive/netui/tags/databinding/bundle"/>
- <include
name="org/apache/beehive/netui/tags/databinding/cellrepeater"/>
- <include name="org/apache/beehive/netui/tags/databinding/datagrid"/>
- <include name="org/apache/beehive/netui/tags/databinding/invoke"/>
- <include name="org/apache/beehive/netui/tags/databinding/message"/>
- <include name="org/apache/beehive/netui/tags/databinding/pageinput"/>
- <include name="org/apache/beehive/netui/tags/databinding/repeater"/>
- <include
name="org/apache/beehive/netui/tags/databinding/repeater/choice"/>
- <include
name="org/apache/beehive/netui/tags/databinding/repeater/pad"/>
- <include name="org/apache/beehive/netui/tags/databinding/script"/>
- <include name="org/apache/beehive/netui/tags/databinding/xml"/>
- </packageset>
- <packageset dir="${src.dir}/tags-html">
- <include name="org/apache/beehive/netui/tags/html"/>
- <include name="org/apache/beehive/netui/tags/tree"/>
- </packageset>
- <packageset dir="${src.dir}/tags-template">
- <include name="org/apache/beehive/netui/tags/template"/>
- </packageset>
- </javadoc>
- </target>
-
- <!-- #### Generates the Tag Libraray HTML #### -->
- <target name="generate-taglib-ref-html" description="Transform the XML
into HTML.">
- <!-- Cleans and recreates the top level taglib dir -->
- <delete dir="${docs.build.dir}/taglib" failonerror="false"/>
- <mkdir dir="${docs.build.dir}/taglib"/>
- <!-- Move the static files (= the CSS and frame-defining index.html
page) into place -->
- <copy todir="${docs.build.dir}/taglib">
- <fileset dir="${docs.dir}/tools/static_files"/>
- </copy>
- <!-- ... the overview-summary of taglibs (initial display in
right-frame) -->
- <xslt in="${docs.temp}/xml/tagref/overview.xml"
- out="${docs.build.dir}/taglib/taglib-overview-summary.html"
- style="${docs.dir}/tools/xslt/taglib-overview-summary.xslt">
- <param name="taglibLocation" expression="${docs.build.dir}/taglib"/>
- </xslt>
- <!-- ... the framed taglib overview (upper-left frame) -->
- <xslt in="${docs.temp}/xml/tagref/overview.xml"
- out="${docs.build.dir}/taglib/taglib-overview-frame.html"
- style="${docs.dir}/tools/xslt/taglib-overview-frame.xslt">
- <param name="taglibLocation" expression="${docs.build.dir}/taglib"/>
- </xslt>
- <!-- ... the framed list of all JSP tags in all libraries (lower-left
frame) -->
- <xslt in="${docs.temp}/xml/tagref/overview.xml"
- out="${docs.build.dir}/taglib/alltaglibs-frame.html"
- style="${docs.dir}/tools/xslt/alltaglibs-frame.xslt">
- <param name="taglibLocation" expression="${docs.build.dir}/taglib"/>
- </xslt>
- <!-- ... the taglib-frame pages (displayed in lower-left frame when
upper-left frame links are clicked) -->
- <!-- This task depends on xalan-241.jar -->
- <!-- This task generates multiple HTML files. The HTML files are
generated
- directly by taglib-frame.xslt, while the file referenced by the
- 'out' attribute, 'taglib-frame-ignore.xml', is a throw away file.
-->
- <xslt in="${docs.temp}/xml/tagref/overview.xml"
- out="${docs.temp}/taglib-frame-ignore.html"
- style="${docs.dir}/tools/xslt/taglib-frame.xslt"
- classpath="${xalan-241.jar}">
- <param name="taglibLocation" expression="${docs.build.dir}/taglib"/>
- </xslt>
- <!-- ... the taglib-summary pages (displayed in right-hand frame when
'tag library' links in the tag topics are clicked) -->
- <!-- This task depends on xalan-241.jar -->
- <!-- This task generates multiple HTML files. The HTML files are
generated
- directly by taglib-frame.xslt, while the file referenced by the
- 'out' attribute, 'taglib-summary-ignore.xml', is a throw away file.
-->
- <xslt in="${docs.temp}/xml/tagref/overview.xml"
- out="${docs.temp}/taglib-summary-ignore.html"
- style="${docs.dir}/tools/xslt/taglib-summary.xslt"
- classpath="${xalan-241.jar}">
- <param name="taglibLocation" expression="${docs.build.dir}/taglib"/>
- </xslt>
- <!-- ... the individual tag topics -->
- <xslt basedir="${docs.temp}/xml/tagref"
- destdir="${docs.build.dir}/taglib"
- style="${docs.dir}/tools/xslt/tag_topics.xslt"
- includes="**/*.xml">
- <param name="taglibLocation" expression="${docs.build.dir}/taglib"/>
- </xslt>
- <!-- Deletes the temporary directory. -->
- <!--<delete dir="${docs.temp}" failonerror="false"/>-->
- </target>
+ <target name="generate-taglib-ref" description="Uses a custom doclet to
generate XML from Java source files.">
+ <delete dir="${docs.temp}" failonerror="false"/>
+ <delete dir="${docs.build.dir}/taglib" failonerror="false"/>
+ <mkdir dir="${docs.temp}/tld"/>
+ <mkdir dir="${docs.temp}/xml/tagref"/>
+ <mkdir dir="${docs.temp}/html/tagref"/>
+ <mkdir dir="${docs.build.dir}/taglib"/>
+ <antcall target="copy-tld-files"/>
+ <javadoc classpathref="javadoc.classpath"
destdir="${docs.temp}/xml/tagref">
+ <doclet
name="org.apache.beehive.netui.tools.doclet.jsptagref.JspTagDoc"
path="${docs.dir}/tools/lib/jsptagrefdoclet.jar;${xbean.jar};${jsr173.jar};${docs.dir}/external/xalan-241.jar">
+ <param name="-source" value="1.5"/>
+ <param name="-tlddir" value="${docs.temp}/tld"/>
+ <param name="-xmldir"
value="${docs.temp}/xml/tagref"/>
+ <param name="-htmldir"
value="${docs.build.dir}/taglib"/>
+ <param name="-breakiterator"/>
+ </doclet>
+ <!-- <link href="http://feverhouse.com"; offline="true"
packagelistLoc="../build/docs/java-class"/> -->
+ <link href="../java-class"/>
+ <link href="http://java.sun.com/j2se/1.5/docs/api/"/>
+ <packageset dir="${src.dir}/tags-databinding">
+ <include
name="org/apache/beehive/netui/tags/databinding/bundle"/>
+ <include
name="org/apache/beehive/netui/tags/databinding/cellrepeater"/>
+ <include
name="org/apache/beehive/netui/tags/databinding/datagrid"/>
+ <include
name="org/apache/beehive/netui/tags/databinding/invoke"/>
+ <include
name="org/apache/beehive/netui/tags/databinding/message"/>
+ <include
name="org/apache/beehive/netui/tags/databinding/pageinput"/>
+ <include
name="org/apache/beehive/netui/tags/databinding/repeater"/>
+ <include
name="org/apache/beehive/netui/tags/databinding/repeater/choice"/>
+ <include
name="org/apache/beehive/netui/tags/databinding/repeater/pad"/>
+ <include
name="org/apache/beehive/netui/tags/databinding/script"/>
+ <include
name="org/apache/beehive/netui/tags/databinding/xml"/>
+ </packageset>
+ <packageset dir="${src.dir}/tags-html">
+ <include
name="org/apache/beehive/netui/tags/html"/>
+ <include
name="org/apache/beehive/netui/tags/tree"/>
+ </packageset>
+ <packageset dir="${src.dir}/tags-template">
+ <include
name="org/apache/beehive/netui/tags/template"/>
+ </packageset>
+ </javadoc>
+ <delete
file="${docs.build.dir}/taglib/taglib-frame-ignore.html" failonerror="false"/>
+ <delete
file="${docs.build.dir}/taglib/taglib-summary-ignore.html" failonerror="false"/>
+ <delete dir="${docs.temp}" failonerror="false"/>
+ </target>
<!-- Get the latest TLD files and unzip them to a temp folder. From there,
they'll be grabbed by
the JspTagRef doclet for generating tag topics. -->
@@ -212,16 +155,6 @@
<copy todir="${docs.temp}/tld" overwrite="true">
<fileset dir="${build.lib.dir}" includes="**/*.tld"/>
</copy>
- </target>
-
- <!-- Add a namespace declaration to the TLD files so that they can be
loaded into XMLBeans. Having the
- TLDs in the same namespace as other Javadoc XML makes life much
easier when merging values from the
- two sources. -->
- <target name="insert-namespace-for-tld" description="Inserts the namespace
attribute needed by format.tag.ref">
- <replace dir="${docs.temp}/tld" value="<taglib
xmlns='http://apache.org/beehive/netui/tools/doclet/schema'">
- <include name="**/*.tld"/>
- <replacetoken><![CDATA[<taglib]]></replacetoken>
- </replace>
</target>
<target name="copy-to-forrest" description="">
Modified: incubator/beehive/trunk/netui/docs/BUILDING_NETUI_DOCS.txt
==============================================================================
--- incubator/beehive/trunk/netui/docs/BUILDING_NETUI_DOCS.txt (original)
+++ incubator/beehive/trunk/netui/docs/BUILDING_NETUI_DOCS.txt Tue Aug 17
11:55:55 2004
@@ -21,11 +21,11 @@
run beehiveEnv.cmd
-cd to BEEHIVE_HOME/netui/ant
+run ant build (This builds the entire Beehive source, a necessary preliminary
step to building the documentation.)
-run ant -f javadoc.xml build -lib
%BEEHIVE_HOME%\netui\test\external\xalan-241.jar
+cd to BEEHIVE_HOME/netui/ant
-(You must include the -lib flag, because the 'build' target depends on a Xalan
extension.)
+run ant -f javadoc.xml build
The completed documentation can be found at BEEHIVE_HOME/netui/build/docs.
Modified: incubator/beehive/trunk/netui/docs/tools/README.txt
==============================================================================
--- incubator/beehive/trunk/netui/docs/tools/README.txt (original)
+++ incubator/beehive/trunk/netui/docs/tools/README.txt Tue Aug 17 11:55:55 2004
@@ -18,17 +18,14 @@
Custom Doclet Files
-------------------
-The custom doclet files are contained in three directories:
+The custom doclet files are contained in the JAR file
BEEHIVE_HOME/netui/docs/tools/lib/jsptagrefdoclet.jar.
+This JAR file contains the following resources:
-(1) BEEHIVE_HOME/netui/docs/tools/lib
- Contains doclet resources encapsulated in JAR files. These JAR files
contain doclet classes that
- extend the Javadoc API. (The source code for these JARs will be posted
in the Apache Commons project at a later date.)
+(1) Doclet classes that extend the Javadoc API. (The source code for these
classes will be posted in the Apache Commons project at a later date.)
-(2) BEEHIVE_HOME/netui/docs/tools/static_files
- Contains static HTML and CSS files.
+(2) Static HTML and CSS files.
-(3) BEEHIVE_HOME/netui/docs/tools/xslt
- Contains XML stylesheets (XSTL files) that convert XML files into HTML
files.
+(3) XML stylesheets (XSTL files) that convert XML files into HTML files.
How the Custom Doclet Works
---------------------------
Modified: incubator/beehive/trunk/netui/docs/tools/lib/jsptagrefdoclet.jar
==============================================================================
Binary files. No diff available.
