glenn 01/07/01 08:54:45
Modified: src/doc sourcedist.xml
Log:
Updated documentation
Revision Changes Path
1.2 +31 -19 jakarta-taglibs/src/doc/sourcedist.xml
Index: sourcedist.xml
===================================================================
RCS file: /home/cvs/jakarta-taglibs/src/doc/sourcedist.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -u -r1.1 -r1.2
--- sourcedist.xml 2001/06/30 13:40:20 1.1
+++ sourcedist.xml 2001/07/01 15:54:45 1.2
@@ -150,23 +150,31 @@
<ul>
<li><b>index.xml</b> - Content used to build
http:/jakarta.apache.org/taglibs/index.html</li>
+ <li><b>addtaglib.xml</b> - Content used to build
+ http:/jakarta.apache.org/taglibs/addtaglib.html</li>
+ <li><b>binarydist.xml</b> - Content used to build
+ http:/jakarta.apache.org/taglibs/binarydist.html</li>
+ <li><b>guidelines.xml</b> - Content used to build
+ http:/jakarta.apache.org/taglibs/guidelines.html</li>
+ <li><b>sourcedist.xml</b> - Content used to build
+ http:/jakarta.apache.org/taglibs/sourcedist.html</li>
+ <li><b>tutorial.xml</b> - Content used to build
+ http:/jakarta.apache.org/taglibs/tutorial.html</li>
<li><b>project.xml</b> - Content used to build left navigation menu
- for http:/jakarta.apache.org/taglibs/index.html and individual
- tag library documentation intro.html</li>
+ for http:/jakarta.apache.org/taglibs/ documentation</li>
<li><b>taglibs_docs.dtd</b> - DTD for use with index.xml and taglib
intro.xml</li>
<li><b>images/jakarta-logo.gif</b> - The Jakarta logo</li>
<li><b>images/taglibs.gif</b> - The JAKARTA-TAGLIBS logo</li>
- <li><b>stylesheets/taglibs.xsl</b> - Transform index.xml and project.xml
into
- http:/jakarta.apache.org/taglibs/index.html</li>
+ <li><b>stylesheets/taglibs.xsl</b> - Transform content xml into
+ http:/jakarta.apache.org/taglibs/ documentation</li>
</ul>
</li>
<li><b>taglib/</b> - A directory containing common source files used to
dynamically build individual tag library documentation and Tag Library
Descriptor (TLD) file.
<ul>
- <li><b>footer.xsl</b> - XSL stylesheet used to build taglib documentation
footer</li>
+ <li><b>changes-doc.xsl</b> - XSL stylesheet used to build taglib
documentation changes.html</li>
<li><b>taglib-doc.xsl</b> - XSL stylesheet used to build taglib
documentation</li>
- <li><b>taglib.css</b> - CSS stylesheet used with taglib documentation</li>
<li><b>tld11.xsl</b> - XSL stylesheet used to build taglib TLD file</li>
</ul>
</li>
@@ -176,11 +184,8 @@
<li><b>build.xml</b> - Template for an example build file</li>
<li><b>doc</b> - Source directory used to generate
{taglib-name}-doc.war</li>
<li><b>doc/conf/web.xml</b> - Template for {taglib-name}-doc web
application web.xml</li>
- <li><b>doc/web/changes.html</b> - Template for taglib changes.html
document</li>
<li><b>examples</b> - Source directory used to generate
{taglib-name}-examples.war</li>
<li><b>examples/conf/web.xml</b> - Template for {taglib-name}-examples web
application web.xml</li>
- <li><b>examples/web</b> - Source directory for example html and jsp
files</li>
- <li><b>src/org/apache/taglibs</b> - Java source code directory</li>
<li><b>xml/intro.xml</b> - Template for taglib XML data used for generating
taglib intro.html documentation which is published to the
JAKARTA-TAGLIBS site</li>
<li><b>xml/taglib-template.xml</b> - Template for taglib XML data for
taglib and tags</li>
@@ -289,41 +294,48 @@
a build of the taglib for a specific ant build target:
<ul>
-<li><b>ant</b> -- Update the intermediate form (in the
+<b>NOTE:</b>
+Some individual tag libraries may still need to be built using the
+<code>build.sh</code> shell script for unix or the <code>build.bat</code>
+DOS script.
+</ul>
+
+<ul>
+<li>Default -- Update the intermediate form (in the
<code>build/</code> directory) of the library itself, the
documentation application, and the example application. This copies any
static files that have been changed, and recompiles any Java source classes
that have been changed. Because this is the most commonly executed
command, it is the default.</li>
-<li><b>ant library</b> -- Update the intermediate form of the library
+<li><b>library</b> -- Update the intermediate form of the library
classes only. This is useful when you are making sure it still compiles.</li>
-<li><b>build documentation</b> -- Update the intermediate form of the
+<li><b>documentation</b> -- Update the intermediate form of the
documentation application. If your servlet container can accept an
unpacked web application (as Tomcat can), the
<code>build/{taglib}/doc/</code> directory can be set
as the document root, and the application can be executed directly.</li>
-<li><b>ant examples</b> -- Update the intermediate form of the examples
+<li><b>examples</b> -- Update the intermediate form of the examples
application (including copying the library classes into WEB-INF/classes).
If your servlet container can accept an unpacked web application (as Tomcat
can), the <code>build/{taglib}/examples/</code> directory can
be set as the document root, and the application can be executed directly.</li>
-<li><b>ant library-dist</b> -- Build and copy the <code>{taglib}.jar</code>
+<li><b>library-dist</b> -- Build and copy the <code>{taglib}.jar</code>
and <code>{taglib}.jar</code> files for this tag library into the
distribution directory (<code>dist/{taglib}/</code>).
These distribution files can be copied directly into web applications
that wish to use this custom tag library.</li>
-<li><b>ant documentation-dist</b> -- Build the <code>{taglib}-doc.war</code>
+<li><b>documentation-dist</b> -- Build the <code>{taglib}-doc.war</code>
documentation application, and copy it into the distribution directory
(<code>dist/{taglib}/</code>). This application can be
deployed and executed on any servlet container.</li>
-<li><b>ant examples-dist</b> -- Build the <code>{taglib}-examples.war</code>
+<li><b>examples-dist</b> -- Build the <code>{taglib}-examples.war</code>
examples application, and copy it into the distribution directory
(<code>dist/{taglib}/</code>). This application can
be deployed and executed on any servlet container.</li>
-<li><b>ant dist</b> -- Short cut command that builds all three
+<li><b>dist</b> -- Short cut command that builds all three
distribution targets (<code>library-dist</code>,
<code>documentation-dist</code>,
and <code>examples-dist</code>).</li>
-<li><b>ant clean</b> -- Deletes the intermediate and distribution results
+<li><b>clean</b> -- Deletes the intermediate and distribution results
for this custom tag library, so that you can rebuild from scratch.</li>
</ul>
</p>
@@ -354,7 +366,7 @@
</ul>
</p>
-<p>When you perform a global build, the <b>build dist</b> option is invoked
+<p>When you perform a global build, the <b>dist</b> build target is invoked
on each included subproject.</p>
<p>Refer to the <a href="addtaglib.html">Adding a Taglib</a> for information
