From 2ddeb409bb3db6edac40f4de85f0443421190e65 Mon Sep 17 00:00:00 2001 From: Steve Loughran Date: Fri, 19 Oct 2001 00:34:05 +0000 Subject: [PATCH] documented uriroot and uribase options; cleaned up some other bits based on more experience with the task. git-svn-id: https://svn.apache.org/repos/asf/ant/core/trunk@269805 13f79535-47bb-0310-9956-ffa450edef68 --- docs/manual/OptionalTasks/jspc.html | 55 +++++++++++++++++++++++------ 1 file changed, 44 insertions(+), 11 deletions(-) diff --git a/docs/manual/OptionalTasks/jspc.html b/docs/manual/OptionalTasks/jspc.html index f798f7370..bdedbb0f8 100644 --- a/docs/manual/OptionalTasks/jspc.html +++ b/docs/manual/OptionalTasks/jspc.html @@ -10,10 +10,10 @@

jspc

Description

-

Ant task to run the jsp compiler. +

Ant task to run the JSP compiler and turn JSP pages into Java source.

-It can be used to precompile jsp pages for fast initial invocation +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. @@ -72,8 +72,7 @@ The Task has the following attributes:

classpath - The classpath to use to run the jsp compiler, - and bring in any tag libraries. + The classpath to use to run the jsp compiler. This can also be specified by the nested element classpath Path). @@ -90,6 +89,24 @@ The Task has the following attributes:

flag to control action on compile failures: default=yes No + + uribase + + 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 uriroot. + + No + + + uriroot + + The root directory that uri files should be resolved + against. + + No +

The mapped option will, if set to true, split the JSP text content into a @@ -103,6 +120,22 @@ concatenated into a single write.

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.

+

uriroot 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 WEB-INF 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

+ +

uribase 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 uriroot. This only affects pages +translated from an explicitly declared JSP file.

+

Parameters specified as nested elements

This task is a directory based task, like @@ -116,10 +149,8 @@ Elements specific to the jspc task are:-

classpath

-The classpath used to compile the JSP pages is specified as for any other -classpath. Even if the jasper jars are in the ant library directory, or -are on the classpath in some other means, this element is important when -referring to tag libraries. +The classpath used to compile the JSP pages, specified as for any other +classpath.

classpathref

a reference to an existing classpath @@ -140,7 +171,6 @@ package heirarchy beginning with com.i3sp.jsp. <jspc destdir="interim" verbose="1"> - classpath="lib/taglibs.jar" srcdir="src" package="com.i3sp.jsp" <include name="**/*.jsp" /> @@ -157,8 +187,8 @@ package heirarchy beginning with com.i3sp.jsp. debug="on" /> Generate jsp pages then javac them down to -bytecodes. Include lib/taglib jar in the -JSP build and the compilation. Dependency checking is used to scrub the +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.

Notes

@@ -168,6 +198,9 @@ other compilers will be supported by setting the jsp.compiler property. the package 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. +

+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.


Copyright © 2000,2001 Apache Software Foundation. All rights