You are viewing a plain text version of this content. The canonical link for it is here.
Posted to taglibs-dev@jakarta.apache.org by cr...@locus.apache.org on 2000/04/10 02:50:28 UTC
cvs commit: jakarta-taglibs build.bat build.sh build.xml README
craigmcc 00/04/09 17:50:27
Modified: . README
Added: . build.bat build.sh build.xml
Log:
Update the README file to point at more detailed documentation (in HTML
format) in the "doc" subdirectory.
Add top-level build scripts and build.xml file that delegates all the
hard work to the build scripts for each subproject.
Revision Changes Path
1.3 +29 -174 jakarta-taglibs/README
Index: README
===================================================================
RCS file: /home/cvs/jakarta-taglibs/README,v
retrieving revision 1.2
retrieving revision 1.3
diff -u -r1.2 -r1.3
--- README 2000/04/03 01:11:51 1.2
+++ README 2000/04/10 00:50:27 1.3
@@ -1,3 +1,7 @@
+ The JAKARTA-TAGLIBS Project README
+ ==================================
+
+
Introduction
============
@@ -13,27 +17,36 @@
should subscribe to the TAGLIBS-USER mailing list for asking and answering
questions about the use of the various libraries.
-This document describes the following topics in the following sections:
-* Installing the JAKARTA-TAGLIBS source files
-* Building the JAKARTA-TAGLIBS tag libraries
-* JAKARTA-TAGLIBS overall directory structure
-* Tag Library subproject directory structure
-
The JAKARTA-TAGLIBS project is independent of the "Standard Tag Libraries"
development process currently being run by Java Software, under the Java
Community Process. For more information, see JSR-052 on the Java Community
Process web site at <http://java.sun.com/aboutJava/communityprocess>.
+This document contains pointers to more details information sources on
+several topics, described below.
+
+
+Installing and Using the JAKARTA-TAGLIBS Binary Distribution
+============================================================
-Installing the JAKARTA-TAGLIBS Source Files
-===========================================
+You can acquire the JAKARTA-TAGLIBS binary files by grabbing one of the
+automated snapshots, milestone drops, or release drops for this project as
+described at <http://jakarta.apache.org/downloads/binindex.html>.
+For more information about using JAKARTA-TAGLIBS custom tag libraries in your
+own web applications, point your browser at the "doc/binarydist.html" file
+included in the binary distribution.
+
+
+Installing and Using the JAKARTA-TAGLIBS Source Distribution
+============================================================
+
You can acquire the JAKARTA-TAGLIBS source files either by grabbing one of the
automated snapshots, milestone source drops, or release source drops for this
project as described at <http://jakarta.apache.org/downloads/sourceindex.html>.
-{TODO-where are the hyperlinks to these?}. You will also need to acquire a
-binary release of the JAKARTA-ANT project (or get the source code and build it
-yourself), because JAKARTA-TAGLIBS uses the Ant build tool.
+You will also need to acquire a binary release of the JAKARTA-ANT project (or
+get the source code and build it yourself), because JAKARTA-TAGLIBS uses the
+Ant build tool.
Set up your development directories such that you have Ant and the Taglibs
directories in a parallel position underneath a higher level directory, like
@@ -46,169 +59,11 @@
xml.jar
jakarta-taglibs/
{the various JAKARTA-TAGLIBS files and directories}
-
-
-Building the JAKARTA-TAGLIBS Tag Libraries
-==========================================
-In order to build the JAKARTA-TAGLIBS tag libraries, you must have installed
-a Java Development Kit (JDK), version 1.1 or later, environment. In addition,
-you must set your PATH environment variable to include the "bin" directory of
-your JDK.
-
-In addition, you must have a JAR file containing the servlet API classes that
-correspond to the Servlet API version 2.2 or later, and the JSP API version 1.1
-or later. Set an environment variable SERVLET_JAR that contains the absolute
-pathname to this file, or you will get compile errors. (If you need such a
-file, one way to get it is to download a binary distribution of Tomcat from the
-<http://jakarta.apache.org> web site, and use the servlet.jar file that is in
-the "lib" subdirectory).
-
-To build all of the included libraries, change your current working directory
-to "jakarta-taglibs" and execute one of the following commands (depending on
-your operating system platform):
-
- build (Windows)
- build.sh (Unix)
-
-This will compile all of the source modules for each defined tag library, but
-will not create the distribution JAR files. If you want to do that as well,
-execute one of the following commands (depending on your operating system
-platform):
-
- build dist (Windows)
- build.sh dist (Unix)
-
-Instead of building all of the contributed tag libraries, you might prefer
-to build just one of them at a time. To do so, change your current directory
-to the top level directory of a particular taglib, and execute one of the
-commands described above. For example, to create the distribution JAR files
-for the "jspspec" tag library on a Unix platform, issue the following commands:
-
- cd jakarta-taglibs/jspspec
- build.sh dist
-
-See the following sections to understand where the compiled classes and
-distribution files will appear in the directory structure.
-
-
-JAKARTA-TAGLIBS Overall Directory Structure
-===========================================
-
-Within the jakarta-taglibs directory, you will find the following directory
-structure and file contents:
-
- LICENSE The Apache Software Foundation
- license that should be prepended
- to each of your source files
- README This README file
- build.bat Executes build.xml (Windows)
- build.sh Executes build.xml (Unix)
- build.xml Build script that invokes
- the build scripts for each
- defined taglib
- build/ Directory containing the unpacked
- compiled versions of the tag libraries,
- their documentation applications, and
- their example applications. For each
- defined tag library, the following
- subdirectories will be created:
- {taglib}/ Unpacked version of the tag library's
- contents, including the tag library
- descriptor (TLD) file.
- {taglib}-doc/ Unpacked version of the documentation
- application for this tag library.
- {taglib}-examples/ Unpacked version of the examples
- application for this tag library.
- dist/ Directory containing the distribution
- files for each defined taglib:
- {taglib}.jar Binary version of the tag library,
- including embedded TLD, suitable for
- use in a web application
- {taglib}.tld The tag library descriptor for this
- taglib (which is also included in the
- {taglib}.jar file under filename
- "META-INF/taglib.tld")
- {taglib}-doc.war Web application containing the user
- documentation for the tags in this
- tag library, suitable for use in any
- compatible servlet container (i.e.
- Servlet 2.2 and JSP 1.1). NOTE:
- Packaging the documentation as a
- web application allows the use of
- documentation formats other than
- static HTML if desired.
- {taglib}-examples.war Web application containing the
- example application that exercizes
- the tags in this tag library, suitable
- for use in any compatible servlet
- container (i.e. Servlet 2.2 and
- JSP 1.1).
- {taglib}/ Top level directory for each
- defined tag library (see below
- for the internal contents)
-
-The "build" and "dist" directories will be created automatically the first
-time that you build one or more of the tag library subprojects.
-
-
-Tag Library Subproject Directory Structure
-==========================================
-
-As described above, each defined tag library within the overall
-JAKARTA-TAGLIBS project has a top level directory of its own, with an
-internal structure as follows:
-
-
- build.bat Execute build.xml script (Windows)
- build.sh Execute build.xml script (Unix)
- build.xml Ant build script for this subproject,
- which should create outputs under the
- top level "build" and "dist"
- directories as described above
- conf/ Directory containing configuration
- files (including the TLD in file
- "taglib.tld") for this tag library.
- doc/ Source files for the documentation
- web application for this tag library,
- with subdirectories as follows:
- conf/ The web.xml file, plus any other files
- that should be copied directly to the
- WEB-INF directory.
- src/ Java source code and other resource
- files (if any). The package name(s)
- for this application are arbitrary, but
- org.apache.taglibs.{taglib}.doc
- is recommended.
- web/ HTML and JSP source files (and
- subdirectories) that should be copied
- to the document root of the
- documentation web application.
- examples/ Source files for the examples
- web application for this tag library,
- with subdirectories as follows:
- conf/ The web.xml file, plus any other files
- that should be copied directly to the
- WEB-INF directory.
- src/ Java source code and other resource
- files (if any). The package name(s)
- for this application are arbitrary, but
- org.apache.taglibs.{taglib}.examples
- is recommended
- web/ HTML and JSP source files (and
- subdirectories) that should be copied
- to the document root of the
- examples web application.
- src/ Java source code and other resource
- files for the tag library itself. The
- package name should be
- org.apache.taglibs.{taglib}
- to avoid name clashes when multiple
- tag libraries are used in the same
- web application
-
-To create a new tag library subproject, the simplest thing to do is clone the
-directory structure from an existing subproject and then go make the
-appropriate changes.
+For more information about modifying existing JAKARTA-TAGLIBS custom tag
+libraries, or adding new ones, point your browser at the "doc/sourcedist.html"
+file included in the source distribution.
+=====================================================================
+$Id: README,v 1.3 2000/04/10 00:50:27 craigmcc Exp $
1.1 jakarta-taglibs/build.bat
Index: build.bat
===================================================================
@echo off
set _ANTHOME=%ANT_HOME%
if "%ANT_HOME%" == "" set ANT_HOME=..\jakarta-ant
set _ARGS=%ARGS%
set ARGS=""
if "%SERVLET_JAR%" != "" set ARGS=%ARGS% -Dservlet.jar=%SERVLET_JAR%
set ARGS=%ARGS -Dant.home=%ANT_HOME%
if "%CLASSPATH%" == "" goto noclasspath
set _CLASSPATH=%CLASSPATH%
set CLASSPATH=%CLASSPATH%;%ANT_HOME%\lib\ant.jar;%ANT_HOME%\lib\xml.jar;%JAVA_HOME\lib\tools.jar
goto next
:noclasspath
set _CLASSPATH=
set CLASSPATH=%ANT_HOME%\lib\ant.jar;%ANT_HOME%\lib\xml.jar;%JAVA_HOME%\lib\tools.jar
goto next
:next
java org.apache.tools.ant.Main %ARGS% %1 %2 %3 %4 %5 %6 %7 %8 %9
:clean
set CLASSPATH=%_CLASSPATH%
set _CLASSPATH=
set ANT_HOME=%_ANTHOME%
set _ANTHOME=
set ARGS=%_ARGS%
set _ARGS=
1.1 jakarta-taglibs/build.sh
Index: build.sh
===================================================================
#! /bin/sh
if [ "$ANT_HOME" = "" ] ; then
ANT_HOME=../jakarta-ant
fi
args=""
if [ "$SERVLET_JAR" != "" ] ; then
args="$args -Dservlet.jar=$SERVLET_JAR"
fi
args="$args -Dant.home=$ANT_HOME"
cp=$ANT_HOME/lib/ant.jar:$ANT_HOME/lib/xml.jar:$JAVA_HOME/lib/tools.jar
java -classpath $cp:$CLASSPATH org.apache.tools.ant.Main $args "$@"
1.1 jakarta-taglibs/build.xml
Index: build.xml
===================================================================
<!-- ANT Build Script for the JAKARTA-TAGLIBS Project -->
<!-- $Id: build.xml,v 1.1 2000/04/10 00:50:27 craigmcc Exp $ -->
<project name="jakarta-taglibs" default="dist" basedir=".">
<!-- ******************** Adjustable Properties *********************** -->
<!--
The following property values should be examined and customized
for each custom tag library subproject.
ant.home Home directory for the ANT build tool
This is normally defaulted from the
ANT_HOME environment variable in the
build script.
servlet.jar Pathname of the servlet API classes
you are using to compile, such as the
one that comes with Tomcat. This is
normally defaulted from the SERVLET_JAR
environment variable in the build script.
-->
<!-- ****************** Project Standard Properties ******************* -->
<!--
The following property values reflect the standard directory
organization for the jakarta-taglibs project, and should not
be changed or overridden.
build.dir Base directory for build targets
dist.dir Base directory for distribution targets
-->
<property name="build.dir" value="../build/taglibs"/>
<property name="dist.dir" value="../dist/taglibs"/>
<!-- ********************** Destination Preparation ********************* -->
<!-- Create the destination directories -->
<target name="prepare">
<mkdir dir="${build.dir}"/>
<mkdir dir="${dist.dir}"/>
</target>
<!-- Copy the static files that describe the entire project -->
<target name="static">
<copyfile src="LICENSE" dest="${dist.dir}/LICENSE"/>
<copyfile src="README" dest="${dist.dir}/README"/>
<copyfile src="build.bat" dest="${dist.dir}/build.bat"/>
<copyfile src="build.sh" dest="${dist.dir}/build.sh"/>
<copyfile src="build.xml" dest="${dist.dir}/build.xml"/>
<fixcrlf srcdir="${dist.dir}" includes="*.bat" cr="add"/>
<fixcrlf srcdir="${dist.dir}" includes="*.sh" cr="remove"/>
<chmod src="${dist.dir}/build.sh" perm="+x"/>
<mkdir dir="${dist.dir}/doc"/>
<copydir src="doc" dest="${dist.dir}/doc"/>
</target>
<!-- ************************* Subproject Execution ********************* -->
<!--
Add a new target for each defined custom tag library subproject.
Be sure you also add each target to the "depends" list for the
"dist" target at the bottom of this file.
-->
<target name="jspspec">
<ant dir="./jspspec" target="dist"/>
</target>
<!-- *********************** Overall Build Command ********************** -->
<target name="dist" depends="prepare,static,jspspec"/>
</project>