mirror of
https://github.com/apache/ant.git
synced 2025-05-18 22:14:47 +00:00
b6a3e9df36
(1) Make sure there is a Copyright notice on all visible files. (2) Make sure all years in which the file has been modified are listed. (3) Make sure the format is consistent, i.e. separate consecutive years with a dash, not a comma. When Stephane changed starteam.html it has been 2001 in France but 2002 in Australia - does that mean we add 2002 to the Copyright line or not? ;-) git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@270652 13f79535-47bb-0310-9956-ffa450edef68
212 lines
7.1 KiB
HTML
212 lines
7.1 KiB
HTML
<html>
|
|
|
|
<head>
|
|
<meta http-equiv="Content-Language" content="en-us">
|
|
<title>Apache Ant User Manual</title>
|
|
</head>
|
|
|
|
<body>
|
|
|
|
<h2><a name="jspc">jspc</a></h2>
|
|
<h3>Description</h3>
|
|
|
|
<p> Ant task to run the JSP compiler and turn JSP pages into Java source.
|
|
<p>
|
|
|
|
It can be used to precompile JSP pages for fast initial invocation
|
|
of JSP pages, deployment on a server without the full JDK installed,
|
|
or simply to syntax check the pages without deploying them.
|
|
In most cases, a javac task is usually the next stage in the build process.
|
|
The task does basic dependency checking to prevent unnecessary recompilation -this
|
|
checking compares source and destination timestamps, and does not factor
|
|
in class or taglib dependencies.
|
|
|
|
<p>
|
|
|
|
The task needs jasper.jar and jasper-runtime.jar, which come with
|
|
builds of Tomcat 4/Catalina from the
|
|
<a href="http://jakarta.apache.org/tomcat/">Jakarta Tomcat project</a>
|
|
|
|
|
|
<h3>Parameters</h3>
|
|
The Task has the following attributes:<p>
|
|
|
|
<table border="1" cellpadding="2" cellspacing="0">
|
|
<tr>
|
|
<td valign="top"><b>Attribute</b></td>
|
|
<td valign="top"><b>Description</b></td>
|
|
<td align="center" valign="top"><b>Required</b></td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">destdir</td>
|
|
<td valign="top">Where to place the generated files. They are located
|
|
under here according to the given package name.</td>
|
|
<td valign="top" align="center">Yes</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">srcdir</td>
|
|
<td valign="top">Where to look for source jsp files.</td>
|
|
<td valign="top" align="center">Yes</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">verbose</td>
|
|
<td valign="top">The verbosity integer to pass to the compiler. Default="0"</td>
|
|
<td valign="top" align="center">No</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">package</td>
|
|
<td valign="top">Name of the destination package for generated java
|
|
classes.</td>
|
|
<td valign="top" align="center">No</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">ieplugin</td>
|
|
<td valign="top">Java Plugin classid for Internet Explorer.</td>
|
|
<td valign="top" align="center">No</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">mapped</td>
|
|
<td valign="top">(boolean) Generate separate write() calls for each HTML
|
|
line in the JSP.</td>
|
|
<td valign="top" align="center">No</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">classpath</td>
|
|
<td valign="top">The classpath to use to run the jsp compiler.
|
|
This can also be specified
|
|
by the nested element <code>classpath</code>
|
|
<a href="../using.html#path">Path</a>).</td>
|
|
<td valign="top" align="center">No</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">classpathref</td>
|
|
<td valign="top">A <a href="../using.html#references">Reference</a>. As
|
|
per <code>classpath</code></td>
|
|
<td valign="top" align="center">No</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">failonerror</td>
|
|
<td valign="top">flag to control action on compile failures: default=yes</td>
|
|
<td valign="top" align="center">No</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">uribase</td>
|
|
<td valign="top">
|
|
The uri context of relative URI
|
|
references in the JSP pages. If it does not
|
|
exist then it is derived from the location of the file
|
|
relative to the declared or derived value of <tt>uriroot.</tt>
|
|
</td>
|
|
<td valign="top" align="center">No</td>
|
|
</tr>
|
|
<tr>
|
|
<td valign="top">uriroot</td>
|
|
<td valign="top">
|
|
The root directory that uri files should be resolved
|
|
against.
|
|
</td>
|
|
<td valign="top" align="center">No</td>
|
|
</tr>
|
|
</table>
|
|
|
|
<P>The <tt>mapped</tt> option will, if set to true, split the JSP text content into a
|
|
one line per call format. There are comments above and below the mapped
|
|
write calls to localize where in the JSP file each line of text comes
|
|
from. This can lead to a minor performance degradation (but it is bound
|
|
by a linear complexity). Without this options all adjacent writes are
|
|
concatenated into a single write.</P>
|
|
|
|
<P>The <tt>ieplugin</tt> option is used by the <tt><jsp:plugin></tt> tags.
|
|
If the Java Plug-in COM Class-ID you want to use changes then it can be
|
|
specified here. This should not need to be altered.</P>
|
|
|
|
<P><tt>uriroot</tt> specifies the root of the web
|
|
application. This is where all absolute uris will be resolved from.
|
|
If it is not specified then the first JSP page will be used to derive
|
|
it. To derive it each parent directory of the first JSP page is
|
|
searched for a <tt>WEB-INF</tt> directory, and the directory closest to
|
|
the JSP page that has one will be used. If none can be found then the
|
|
directory Jasperc was called from will be used. This only affects pages
|
|
translated from an explicitly declared JSP file -including references
|
|
to taglibs</P>
|
|
|
|
<P><tt>uribase</tt> is used to establish the uri context of
|
|
relative URI references in the JSP pages. If it does not exist then it
|
|
is derived from the location of the file relative to the declared or
|
|
derived value of <tt>uriroot</tt>. This only affects pages
|
|
translated from an explicitly declared JSP file.</P>
|
|
|
|
<h3>Parameters specified as nested elements</h3>
|
|
|
|
This task is a <a href="../dirtasks.html">directory based task</a>, like
|
|
<strong>javac</strong>, so the jsp files to be compiled are located as java
|
|
files are by <strong>javac</strong>. That is, elements such as <tt>includes</tt> and
|
|
<tt>excludes</tt> can be used directly inside the task declaration.
|
|
|
|
<p>
|
|
|
|
Elements specific to the jspc task are:-
|
|
|
|
<h4>classpath</h4>
|
|
|
|
The classpath used to compile the JSP pages, specified as for any other
|
|
classpath.
|
|
|
|
<h4>classpathref</h4>
|
|
a reference to an existing classpath
|
|
|
|
<h3>Example</h3>
|
|
<pre>
|
|
<jspc srcdir="${basedir}/src/war"
|
|
destdir="${basedir}/gensrc"
|
|
package="com.i3sp.jsp"
|
|
verbose="9">
|
|
<include name="**/*.jsp" />
|
|
</jspc>
|
|
</pre>
|
|
Build all jsp pages under src/war into the destination /gensrc, in a
|
|
package heirarchy beginning with com.i3sp.jsp.
|
|
<pre>
|
|
|
|
<jspc
|
|
destdir="interim"
|
|
verbose="1">
|
|
srcdir="src"
|
|
package="com.i3sp.jsp"
|
|
<include name="**/*.jsp" />
|
|
</jspc>
|
|
<depends
|
|
srcdir="interim"
|
|
destdir="build"
|
|
cache="build/dependencies"
|
|
classpath="lib/taglibs.jar"/>
|
|
<javac
|
|
srcdir="interim"
|
|
destdir="build"
|
|
classpath="lib/taglibs.jar"
|
|
debug="on" />
|
|
</pre>
|
|
Generate jsp pages then javac them down to
|
|
bytecodes. Include lib/taglib jar in the java compilation.
|
|
Dependency checking is used to scrub the
|
|
java files if class dependencies indicate it is needed.
|
|
|
|
<p><h4>Notes</h4>
|
|
<p> At present, this task only supports the jasper compiler. In future,
|
|
other compilers will be supported by setting the <tt>jsp.compiler</tt> property.
|
|
<p> The jasper compiler option <code>-webapp</code> is not supported. Using
|
|
the <code>package</code> attribute it is possible to identify the resulting
|
|
java files and thus do full dependency checking - this task only rebuilds
|
|
java files if their jsp file has been modified.
|
|
<p>
|
|
Jasper generates JSP pages against the JSP1.3 specification -an implementation of
|
|
version 2.2 of the servlet specification is needed to compile or run the java code.
|
|
|
|
<hr>
|
|
<p align="center">Copyright © 2001 Apache Software Foundation. All rights
|
|
Reserved.</p>
|
|
|
|
</body>
|
|
</html>
|
|
|