You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@tiles.apache.org by nl...@apache.org on 2012/03/27 20:14:52 UTC
svn commit: r1305936 - in /tiles/framework/trunk:
tiles-autotag/maven-autotag-plugin/src/site/ tiles-autotag/src/site/
tiles-autotag/src/site/apt/ tiles-autotag/src/site/apt/dev/
tiles-autotag/src/site/xdoc/dev/ tiles-autotag/tiles-autotag-core-runtime...
Author: nlebas
Date: Tue Mar 27 18:14:50 2012
New Revision: 1305936
URL: http://svn.apache.org/viewvc?rev=1305936&view=rev
Log:
documentation for autotag
Added:
tiles/framework/trunk/tiles-autotag/maven-autotag-plugin/src/site/
tiles/framework/trunk/tiles-autotag/maven-autotag-plugin/src/site/site.xml
- copied, changed from r1305546, tiles/framework/trunk/tiles-autotag/tiles-autotag-jsp/src/site/site.xml
tiles/framework/trunk/tiles-autotag/src/site/apt/
tiles/framework/trunk/tiles-autotag/src/site/apt/dev/
tiles/framework/trunk/tiles-autotag/src/site/apt/dev/release.apt
tiles/framework/trunk/tiles-autotag/src/site/apt/plugin.apt
tiles/framework/trunk/tiles-autotag/src/site/apt/taglib.apt
tiles/framework/trunk/tiles-autotag/src/site/xdoc/dev/
tiles/framework/trunk/tiles-autotag/src/site/xdoc/dev/building.xml
tiles/framework/trunk/tiles-autotag/src/site/xdoc/dev/snapshots.xml
Modified:
tiles/framework/trunk/tiles-autotag/src/site/site.xml
tiles/framework/trunk/tiles-autotag/tiles-autotag-core-runtime/src/site/site.xml
tiles/framework/trunk/tiles-autotag/tiles-autotag-core/src/site/site.xml
tiles/framework/trunk/tiles-autotag/tiles-autotag-freemarker/src/site/site.xml
tiles/framework/trunk/tiles-autotag/tiles-autotag-jsp/src/site/site.xml
tiles/framework/trunk/tiles-autotag/tiles-autotag-velocity/src/site/site.xml
tiles/framework/trunk/tiles-parent/tiles-freemarker/pom.xml
tiles/framework/trunk/tiles-parent/tiles-jsp/pom.xml
tiles/framework/trunk/tiles-parent/tiles-velocity/pom.xml
Copied: tiles/framework/trunk/tiles-autotag/maven-autotag-plugin/src/site/site.xml (from r1305546, tiles/framework/trunk/tiles-autotag/tiles-autotag-jsp/src/site/site.xml)
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-autotag/maven-autotag-plugin/src/site/site.xml?p2=tiles/framework/trunk/tiles-autotag/maven-autotag-plugin/src/site/site.xml&p1=tiles/framework/trunk/tiles-autotag/tiles-autotag-jsp/src/site/site.xml&r1=1305546&r2=1305936&rev=1305936&view=diff
==============================================================================
--- tiles/framework/trunk/tiles-autotag/tiles-autotag-jsp/src/site/site.xml (original)
+++ tiles/framework/trunk/tiles-autotag/maven-autotag-plugin/src/site/site.xml Tue Mar 27 18:14:50 2012
@@ -45,7 +45,7 @@
name="Tiles Home"
href="../../index.html"/>
<item
- name="Tiles Autotags"
+ name="Tiles Autotag"
href="../index.html"/>
</menu>
Added: tiles/framework/trunk/tiles-autotag/src/site/apt/dev/release.apt
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-autotag/src/site/apt/dev/release.apt?rev=1305936&view=auto
==============================================================================
--- tiles/framework/trunk/tiles-autotag/src/site/apt/dev/release.apt (added)
+++ tiles/framework/trunk/tiles-autotag/src/site/apt/dev/release.apt Tue Mar 27 18:14:50 2012
@@ -0,0 +1,351 @@
+~~ $Id$
+~~
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you under the Apache License, Version 2.0 (the
+~~ "License"); you may not use this file except in compliance
+~~ with the License. You may obtain a copy of the License at
+~~
+~~ http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing,
+~~ software distributed under the License is distributed on an
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~~ KIND, either express or implied. See the License for the
+~~ specific language governing permissions and limitations
+~~ under the License.
+~~
+ -----------
+ Release Process
+ -----------
+
+Tiles Release Process
+
+ Here you will find the steps to create releases for Tiles.
+
+Prerequisites
+
+ To create a release you have to install:
+
+ * {{{http://java.sun.com/javase/6}Java 6.0}}. If you are using a newer
+ version of Java, it is suggested to <<change JAVA_HOME environment variable>>
+ when calling Maven, so it points to an instance of Java 6.0;
+
+ * {{{http://maven.apache.org/}Maven 2.2 or 3}};
+
+ * {{{http://www.gnupg.org/}GnuPG}};
+
+ * {{{http://www.openssh.com/}OpenSSH}};
+
+ * {{{http://www.graphviz.org/}GraphViz}};
+
+One-time operations
+
+ These operations need to be performed only one time.
+
+* Create and publish your GPG key
+
+ To create a GPG key, follow the
+ {{{http://www.apache.org/dev/openpgp.html}guidelines}}.
+ Include it in:
+
+-------------------------------------
+https://svn.apache.org/repos/asf/tiles/site/KEYS
+-------------------------------------
+
+ Publish your GPG key in a PGP key server, such as
+ {{{http://pgp.mit.edu/} MIT Keyserver}}.
+
+* Create and upload yout SSH key
+
+ * Generate your SSH key (in this case we will use DSA encryption):
+
+---------------------------------
+ssh-keygen -t rsa
+---------------------------------
+
+ * Copy your public key to the server:
+
+--------------------------------------
+scp ~/.ssh/id_rsa.pub user@people.apache.org:.ssh/authorized_keys
+--------------------------------------
+
+ * Try to login:
+
+---------------------------------
+ssh user@people.apache.org
+---------------------------------
+
+ If it does not ask you a password, everything is ok.
+
+* Modify <<<settings.xml>>>
+
+ Your <<<settings.xml>>> must be modified to allow deployment.
+
+ This is the minimal configuration, obviously if you already have a <<<settings.xml>>> file,
+ you must edit it:
+
+---------------------------
+<settings xmlns="http://maven.apache.org/POM/4.0.0"
+ xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
+ http://maven.apache.org/xsd/settings-1.0.0.xsd">
+ <servers>
+ <server>
+ <id>apache-site</id>
+ <username>YOUR_APACHE_USERNAME</username>
+ <filePermissions>664</filePermissions>
+ <directoryPermissions>775</directoryPermissions>
+ </server>
+ <server>
+ <id>apache.snapshots.https</id>
+ <username>YOUR_APACHE_USERNAME</username>
+ <password>YOUR_APACHE_PASSWORD</password>
+ </server>
+ <server>
+ <id>apache.releases.https</id>
+ <username>YOUR_APACHE_USERNAME</username>
+ <password>YOUR_APACHE_PASSWORD</password>
+ </server>
+ </servers>
+ <profiles>
+ <profile>
+ <id>release</id>
+ <properties>
+ <gpg.passphrase>YOUR_SECRET_PHRASE</gpg.passphrase>
+ </properties>
+ </profile>
+ </profile>
+ </profiles>
+</settings>
+---------------------------
+
+Repeatable operations
+
+ These steps must be performed <<for each>> release.
+
+* Prepare the release tag
+
+ To prepare the release Subversion tag, check out the branch/trunk from where
+ you are preparing the release and type:
+
+-----------------------------------
+mvn release:prepare -Dusername=YOUR_SVN_USER -Dpassword=YOUR_SVN_PASSWORD
+-----------------------------------
+
+ The plugin interactively will ask you the version to release, the Subversion
+ tag to use and the next snapshot version. It is reccomended to use the tag:
+ <<tiles-X.X.X>>.
+
+* Perform the Release
+
+ To perform the release, i.e. creating and deploying Maven artifacts, use:
+
+-----------------------------------
+mvn release:perform
+-----------------------------------
+
+* Close the staging repository
+
+ Login to {{{https://repository.apache.org using} Nexus repository}} your Apache LDAP credentials.
+ Click on "Staging". Then click on "tiles" in the list of repositories.
+ In the panel below you should see an open repository that is linked to your username and ip.
+ Right click on this repository and select "Close".
+ This will close the repository from future deployments and make it available for others to view.
+ If you are staging multiple releases together, skip this step until you have staged everything.
+ Enter the name and version of the artifact being released in the "Description" field and then click "Close".
+ This will make it easier to identify it later.
+
+* Verify the staged artifacts
+
+ If you click on your repository, a tree view will appear below.
+ You can then browse the contents to ensure the artifacts are as you expect them.
+ Pay particular attention to the existence of *.asc (signature) files.
+ If the you don't like the content of the repository, right click your repository and choose "Drop".
+ You can then rollback your release and repeat the process.
+
+ Note the repository URL, you will need this in your vote email.
+
+* Digest and upload assemblies
+
+ * Go into the release assembly target directory:
+
+-----------------------------------
+cd target/checkout/assembly/target/assembly/out
+-----------------------------------
+
+ * Create MD5 and SHA1 files for each files (including ASC files). You can do
+ it with this simple shell script:
+
+-----------------------------------
+#!/bin/sh
+
+for fileitem in *
+do
+ openssl md5 < $fileitem > $fileitem.md5
+ openssl sha1 < $fileitem > $fileitem.sha1
+done
+-----------------------------------
+
+ * Upload everything to the build site:
+
+-----------------------------------
+scp * user@people.apache.org:/www/people.apache.org/builds/tiles/${version}
+-----------------------------------
+
+* Release the JIRA version
+
+ * In JIRA go to the version that you want to release and release it.
+
+ * Create a new version, if it has not been done before.
+
+ * Create the release notes and <<write down the link>> that it uses.
+
+* Send announcement for the test build
+
+ In <<developers mailing list>> send an announcement for the test build:
+
+-----------------------------------
+Subject: [ANNOUNCE] Tiles ${version} test build available
+
+The test build of Tiles ${version} is available.
+
+
+No determination as to the quality ('alpha,' 'beta,' or 'GA') of Tiles
+${version} has been made, and at this time it is simply a "test build". We
+welcome any comments you may have, and will take all feedback into
+account if a quality vote is called for this build.
+
+Release notes:
+
+* ${jira.release.notes}
+
+Distribution:
+
+ * http://people.apache.org/builds/tiles/${version}/
+
+Maven 2 staging repository:
+
+ * https://repository.apache.org/content/repositories/tiles-[YOUR REPOSITORY ID]/
+
+A vote regarding the quality of this test build will be initiated
+within the next couple of days.
+-----------------------------------
+
+* Call for a vote
+
+ A few days after the test build announcement, call for a vote in
+ <<developers mailing list>>.
+
+-----------------------------------
+Subject: [VOTE] ${version} Release Quality
+
+The Tiles ${version} test build has been available since ${testBuildDate}.
+
+Release notes:
+
+* ${jira.release.notes}
+
+Distribution:
+
+ * http://people.apache.org/builds/tiles/${version}/
+
+Maven 2 staging repository:
+
+ * https://repository.apache.org/content/repositories/tiles-[YOUR REPOSITORY ID]/
+
+If you have had a chance to review the test build, please respond with
+a vote on its quality:
+
+ [ ] Leave at test build
+ [ ] Alpha
+ [ ] Beta
+ [ ] General Availability (GA)
+
+
+Everyone who has tested the build is invited to vote. Votes by PMC
+members are considered binding. A vote passes if there are at least
+three binding +1s and more +1s than -1s.
+-----------------------------------
+
+* Post-vote operations
+
+ After a vote is finished, and it has been decided that is
+ <<at least of alpha quality>>, there is the need of a post-vote process.
+
+** Promote staged artifacts
+
+ Once the release is deemed fit for public consumption it can be transfered to a production repository where it will be available to all users.
+
+ Login to {{{https://repository.apache.org}Nexus repository}} again.
+ Click on "Staging" and then on the repository with id "tiles-staging".
+ Find your closed staging repository, right click on it and choose "Promote".
+ Select the "Releases" repository and click "Promote".
+
+ Next click on "Repositories", select the "Releases" repository
+ and validate that your artifacts exist as you expect them.
+
+** Move assemblies
+
+ * Move assemblies to the Apache distribution mirrors:
+
+-------------------------------------------
+ssh user@people.apache.org
+
+cd /www/people.apache.org/builds/tiles/${version}
+mkdir /www/www.apache.org/dist/tiles/v${version}/
+cp * /www/www.apache.org/dist/tiles/v${version}/
+-------------------------------------------
+
+** Update the site
+
+ * Wait 24 hours to let the mirror sync to the release and then update the
+ site. In particular you have to update the index and the download pages:
+
+------------------------------------------------
+https://svn.apache.org/repos/asf/tiles/site/src/site/xdoc/index.xml
+https://svn.apache.org/repos/asf/tiles/site/src/site/apt/download.apt
+------------------------------------------------
+
+ Build and publish the site:
+
+--------------------------------------
+mvn site
+mvn site:deploy
+--------------------------------------
+
+** Send announcement
+
+ Finally, send an an announcement to the <<users>> and <<developers mailing
+ list>>:
+
+--------------------------------------
+Subject: [ANNOUNCE] Tiles ${version} ${quality} released
+
+The Apache Tiles team is pleased to announce the release of Tiles ${version}
+${quality}.
+
+Tiles ${version} is available in a binary and a source distribution.
+
+http://tiles.apache.org/download.html
+
+It is also available in the central Maven repository under Group ID
+"org.apache.tiles".
+
+The 2.0.x series of the Apache Tiles framework has a minimum
+requirement of the following specification versions:
+
+* Java Servlet 2.4 and JavaServer Pages (JSP) 2.0
+* Java Standard Edition (Java SE) 1.5
+
+The release notes are available online at:
+
+* ${jira.release.notes}
+
+Please feel free to test the distribution and post your comments to
+the user list, or, if appropriate, file a ticket with JIRA.
+--------------------------------------
+
+ <<You have finished!>>
Added: tiles/framework/trunk/tiles-autotag/src/site/apt/plugin.apt
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-autotag/src/site/apt/plugin.apt?rev=1305936&view=auto
==============================================================================
--- tiles/framework/trunk/tiles-autotag/src/site/apt/plugin.apt (added)
+++ tiles/framework/trunk/tiles-autotag/src/site/apt/plugin.apt Tue Mar 27 18:14:50 2012
@@ -0,0 +1,105 @@
+~~ $Id$
+~~
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you under the Apache License, Version 2.0 (the
+~~ "License"); you may not use this file except in compliance
+~~ with the License. You may obtain a copy of the License at
+~~
+~~ http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing,
+~~ software distributed under the License is distributed on an
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~~ KIND, either express or implied. See the License for the
+~~ specific language governing permissions and limitations
+~~ under the License.
+~~
+ -----------
+ Building a tag library for Freemarker, JSP or Velocity
+ -----------
+
+Building a tag library for Freemarker, JSP or Velocity
+
+ Once you have {{{taglib.html}created a generic tag library}},
+ Autotag will automatically generate the corresponding library
+ for Freemarker, JSP, or Velocity. You just create a maven project
+ and include in <<<pom.xml>>>:
+
+ * The appropriate implementation of tiles-request as a dependency.
+ For instance to build a JSP taglib:
+
+-----------------
+<dependency>
+ <groupId>org.apache.tiles</groupId>
+ <artifactId>tiles-request-jsp</artifactId>
+ <version>1.0</version>
+</dependency>
+-----------------
+
+ * Your generic tag library as a dependency. For instance:
+
+-----------------
+<dependency>
+ <groupId>org.example</groupId>
+ <artifactId>my-taglib</artifactId>
+ <version>1.0-SNAPSHOT</version>
+</dependency>
+-----------------
+
+ * The appropriate configuration of maven-autotag-plugin. For instance:
+
+-----------------
+<plugin>
+ <groupId>org.apache.tiles.autotag.plugin</groupId>
+ <artifactId>maven-autotag-plugin</artifactId>
+ <version>1.0</version>
+ <executions>
+ <execution>
+ <goals>
+ <goal>generate-jsp</goal>
+ </goals>
+ <configuration>
+ <packageName>org.example.mytaglib.jsp</packageName>
+ <jspRuntime>org.apache.tiles.request.jsp.autotag.JspAutotagRuntime</jspRuntime>
+ <taglibURI>http://example.org/mytaglib</taglibURI>
+ </configuration>
+ </execution>
+ </executions>
+</plugin>
+-----------------
+
+ No further code is required.
+
+Plugin goals
+
+ one or several of the following goals may be used:
+
+ [generate-jsp] generates the files required for a JSP tag library. It can then be included
+ in a JSP using the configured taglibURI.
+
+ [generate-freemarker] generates the files required for freemarker user-defined directives.
+ The directives can then be made available to freemarker by adding an instance of the
+ generated class <<<...FMModelRepository>>> to the freemarker template model.
+
+ [generate-velocity] generates the files required for velocity user directives. The directives
+ can be made available to Velocity by setting the <<<userdirective>>> property, either manually
+ or by using the generated file <<<META-INF/velocity.properties>>>.
+
+Plugin configuration
+
+ [packageName] the destination package for the generated classes.
+
+ [freemarkerRuntime] the runtime implementation of TilesRequest to use for freemarker, for
+ instance <<<org.apache.tiles.request.freemarker.autotag.FreemarkerAutotagRuntime>>>.
+
+ [jspRuntime] the runtime implementation of TilesRequest to use for JSP, for
+ instance <<<org.apache.tiles.request.jsp.autotag.JSPAutotagRuntime>>>.
+
+ [velocityRuntime] the runtime implementation of TilesRequest to use for velocity, for
+ instance <<<org.apache.tiles.request.velocity.autotag.VelocityAutotagRuntime>>>.
+
+ [taglibURI] the URI to use for the JSP taglib.
+
Added: tiles/framework/trunk/tiles-autotag/src/site/apt/taglib.apt
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-autotag/src/site/apt/taglib.apt?rev=1305936&view=auto
==============================================================================
--- tiles/framework/trunk/tiles-autotag/src/site/apt/taglib.apt (added)
+++ tiles/framework/trunk/tiles-autotag/src/site/apt/taglib.apt Tue Mar 27 18:14:50 2012
@@ -0,0 +1,107 @@
+~~ $Id$
+~~
+~~ Licensed to the Apache Software Foundation (ASF) under one
+~~ or more contributor license agreements. See the NOTICE file
+~~ distributed with this work for additional information
+~~ regarding copyright ownership. The ASF licenses this file
+~~ to you under the Apache License, Version 2.0 (the
+~~ "License"); you may not use this file except in compliance
+~~ with the License. You may obtain a copy of the License at
+~~
+~~ http://www.apache.org/licenses/LICENSE-2.0
+~~
+~~ Unless required by applicable law or agreed to in writing,
+~~ software distributed under the License is distributed on an
+~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+~~ KIND, either express or implied. See the License for the
+~~ specific language governing permissions and limitations
+~~ under the License.
+~~
+ -----------
+ Creating a generic tag library with Autotag
+ -----------
+
+Creating a generic tag library
+
+ A generic tag library is a jar file including the classes that implement
+ the tags and a library descriptor <<<META-INF/template-suite.xml>>>, that can be used by
+ Autotag to build specific tag libraries for Freemarker, JSP, and Velocity.
+
+ The structure of the library descriptor is rather complex; fortunately
+ Autotag can generate it for you by parsing the sources.
+
+* The tag class
+
+ A tag in the library can be implemented by any java class that fits the following requirements:
+
+ * The class name ends with <<<Model>>>.
+
+ * It has a public, non-static, non-abstract method called <<<execute>>>.
+
+ * The <<<execute>>> method returns <<<void>>>.
+
+ * The parameters of the <<<execute>>> method are as follows:
+
+ ** the first parameters may be anything you want; at runtime they will contain the values
+ assigned to the attributes of the tag in the template. Those parameters may be annotated with
+ <<<org.apache.tiles.autotag.core.runtime.annotation.Parameter>>> in order to specify the name of
+ the attribute, the default value, or to make the parameter mandatory.
+
+ ** then, one parameter of type <<<org.apache.tiles.request.Request>>>.
+
+ ** and finally, one optional parameter of type <<<org.apache.tiles.autotag.core.runtime.ModelBody>>>;
+ at runtime it will contain the contents of the tag in the template.
+
+ For instance:
+----------------
+public class MyTagModel {
+
+ public void execute(
+ @Parameter(required=true) String mandatoryParam,
+ String optionalParam,
+ Request request,
+ ModelBody body) {
+ ...
+ }
+
+}
+----------------
+
+* Generating the library descriptor
+
+ the library descriptor can be generated using the create-descriptor goal of maven-autotag-plugin.
+
+-----------------
+<plugin>
+ <groupId>org.apache.tiles.autotag.plugin</groupId>
+ <artifactId>maven-autotag-plugin</artifactId>
+ <version>1.0</version>
+ <executions>
+ <execution>
+ <goals>
+ <goal>create-descriptor</goal>
+ </goals>
+ <configuration>
+ ...
+ </configuration>
+ </execution>
+ </executions>
+</plugin>
+-----------------
+
+** Configuration reference
+
+ [name] is the name of the tag library (for instance: <<<tiles>>>). It will be used for naming a
+ number of generated files.
+
+ [documentation] is a documentation that will be included in the library descriptor, and then
+ later in the appropriate artefacts when generating the taglibs.
+
+ [includes] specifies what source files should be included, defaults to <<<**/*Model.java>>>.
+ It follows the usual conventions in maven.
+
+ [excludes] specifies what source files should be included, defaults to nothing.
+ It follows the usual conventions in maven.
+
+ [outputDirectory] specifies where to put the generated files, defaults to
+ <<<target/autotag-template-suite>>>.
Modified: tiles/framework/trunk/tiles-autotag/src/site/site.xml
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-autotag/src/site/site.xml?rev=1305936&r1=1305935&r2=1305936&view=diff
==============================================================================
--- tiles/framework/trunk/tiles-autotag/src/site/site.xml (original)
+++ tiles/framework/trunk/tiles-autotag/src/site/site.xml Tue Mar 27 18:14:50 2012
@@ -45,11 +45,17 @@
name="Tiles Home"
href="../index.html"/>
<item
- name="Tiles Autotags"
+ name="Tiles Autotag"
href="./index.html"/>
</menu>
<menu name="Reference">
<item
+ name="Creating an generic tag library"
+ href="./taglib.html"/>
+ <item
+ name="Building a tag library"
+ href="./plugin.html"/>
+ <item
name="Javadoc"
href="apidocs/index.html"/>
</menu>
@@ -64,9 +70,6 @@
<item
name="Release Process"
href="/dev/release.html"/>
- <item
- name="Selenium Testing"
- href="/selenium.html"/>
</menu>
<menu ref="modules" />
Added: tiles/framework/trunk/tiles-autotag/src/site/xdoc/dev/building.xml
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-autotag/src/site/xdoc/dev/building.xml?rev=1305936&view=auto
==============================================================================
--- tiles/framework/trunk/tiles-autotag/src/site/xdoc/dev/building.xml (added)
+++ tiles/framework/trunk/tiles-autotag/src/site/xdoc/dev/building.xml Tue Mar 27 18:14:50 2012
@@ -0,0 +1,94 @@
+<?xml version="1.0"?>
+<!--
+/*
+ * $Id$
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+-->
+<document>
+
+ <properties>
+ <title>Apache Autotag</title>
+ </properties>
+
+ <body>
+ <section name="Building the Autotag project">
+ <subsection name="Prerequisites">
+ <p>For all the next instructions, we assume that you downloaded and
+ installed <a href="http://maven.apache.org/">Maven</a>.</p>
+ <p>To download packages from the source repository, you need to
+ download and install <a href="http://subversion.tigris.org/">
+ Subversion</a>.</p>
+ <p>If you want to build something including JavaDocs (assemblies,
+ sites and JavaDoc report itself) you need to install
+ <a href="http://www.graphviz.org/">GraphViz</a>, otherwise you will
+ notice missing pictures inside JavaDocs pages.</p>
+ </subsection>
+ <subsection name="Building main packages">
+ <p>To build the Autotag project from source you need to:</p>
+ <ul>
+ <li><p><a href="../../download.html">download</a> the source
+ distribution, or checkout the latest version:</p>
+ <p><source>svn co http://svn.apache.org/repos/asf/tiles/framework/trunk/tiles-autotag</source></p></li>
+ <li><p>go into the source directory and type:</p>
+ <p><source>mvn package</source></p></li>
+ </ul>
+ <p>You will find the generated JARs under:</p>
+ <ul>
+ <li>{autotag-dir}/maven-autotag-plugin/target/maven-autotag-plugin-${version}.jar</li>
+ <li>{autotag-dir}/tiles-autotag-core/target/tiles-autotag-core-${version}.jar</li>
+ <li>{autotag-dir}/tiles-autotag-core-runtime/target/tiles-autotag-core-runtime-${version}.jar</li>
+ <li>{autotag-dir}/tiles-autotag-freemarker/target/tiles-autotag-freemarker-${version}.jar</li>
+ <li>{autotag-dir}/tiles-autotag-jsp/target/tiles-autotag-jsp-${version}.jar</li>
+ <li>{autotag-dir}/tiles-autotag-velocity/target/tiles-autotag-velocity-${version}.jar</li>
+ </ul>
+ </subsection>
+ </section>
+ <section name="Building the websites">
+ <p>There are four Tiles websites: the main website and the projects
+ websites (tiles-request, tiles-autotag and framework).</p>
+ <subsection name="Building the main website">
+ <p>To build the main website:</p>
+ <ul>
+ <li><p>checkout the site from the source repository:</p>
+ <p><source>svn co http://svn.apache.org/repos/asf/tiles/site/</source></p></li>
+ <li><p>go into the site directory and type:</p>
+ <p><source>mvn site</source></p></li>
+ </ul>
+ <p>You will find the generated distribution under
+ <code>{tiles-site-dir}/target/site</code>.</p>
+ </subsection>
+ <subsection name="Building the tiles-autotag website">
+ <p>To build a project's website:</p>
+ <ul>
+ <li><p><a href="../../download.html">download</a> the source
+ distribution, or checkout the latest version:</p>
+ <p><source>svn co http://svn.apache.org/repos/asf/tiles/framework/trunk/tiles-autotag</source></p></li>
+ <li><p>go into the source directory and type:</p>
+ <p><source>mvn site site:stage</source></p></li>
+ </ul>
+ <p>You will find the generated website under:</p>
+ <ul>
+ <li>{tiles-autotag-dir}/target/staging</li>
+ </ul>
+ </subsection>
+ </section>
+ </body>
+
+</document>
Added: tiles/framework/trunk/tiles-autotag/src/site/xdoc/dev/snapshots.xml
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-autotag/src/site/xdoc/dev/snapshots.xml?rev=1305936&view=auto
==============================================================================
--- tiles/framework/trunk/tiles-autotag/src/site/xdoc/dev/snapshots.xml (added)
+++ tiles/framework/trunk/tiles-autotag/src/site/xdoc/dev/snapshots.xml Tue Mar 27 18:14:50 2012
@@ -0,0 +1,81 @@
+<?xml version="1.0"?>
+<!--
+/*
+ * $Id$
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements. See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership. The ASF licenses this file
+ * to you under the Apache License, Version 2.0 (the
+ * "License"); you may not use this file except in compliance
+ * with the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ * KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ */
+-->
+<document>
+
+ <properties>
+ <title>Apache Tiles</title>
+ </properties>
+
+ <body>
+ <section name="Apache Tiles™">
+ <subsection name="Snapshots">
+
+ <p>Looking for snapshot builds of the latest version of Tiles?
+ Snapshots are occasionally published to Apache's Maven snapshot
+ repository, which can be accessed with the following configuration:</p>
+
+ <source>
+ <![CDATA[
+ <repository>
+ <id>apache.snapshots</id>
+ <name>Apache Maven Snapshot Repository</name>
+ <url>http://repository.apache.org/snapshots</url>
+ </repository>
+ ]]>
+ </source>
+
+ <p>After configuring the repository, declare a dependency on
+ Tiles Autotag:</p>
+
+ <source><![CDATA[
+ <dependency>
+ <groupId>org.apache.tiles</groupId>
+ <artifactId>tiles-autotag-core-runtime</artifactId>
+ <version>1.0-SNAPSHOT</version>
+ </dependency>
+ ]]>
+ </source>
+
+ <p>Or the maven plugin:</p>
+
+ <source><![CDATA[
+ <plugin>
+ <groupId>org.apache.tiles</groupId>
+ <artifactId>maven-autotag-plugin</artifactId>
+ <version>1.0-SNAPSHOT</version>
+ <configuration>
+ <packageName>...</packageName>
+ <freemarkerRuntime>...</freemarkerRuntime>
+ <jspRuntime>...</jspRuntime>
+ <velocityRuntime>...</velocityRuntime>
+ </configuration>
+ </plugin>
+ ]]>
+ </source>
+
+ </subsection>
+</section>
+</body>
+
+</document>
Modified: tiles/framework/trunk/tiles-autotag/tiles-autotag-core-runtime/src/site/site.xml
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-autotag/tiles-autotag-core-runtime/src/site/site.xml?rev=1305936&r1=1305935&r2=1305936&view=diff
==============================================================================
--- tiles/framework/trunk/tiles-autotag/tiles-autotag-core-runtime/src/site/site.xml (original)
+++ tiles/framework/trunk/tiles-autotag/tiles-autotag-core-runtime/src/site/site.xml Tue Mar 27 18:14:50 2012
@@ -45,7 +45,7 @@
name="Tiles Home"
href="../../index.html"/>
<item
- name="Tiles Autotags"
+ name="Tiles Autotag"
href="../index.html"/>
</menu>
Modified: tiles/framework/trunk/tiles-autotag/tiles-autotag-core/src/site/site.xml
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-autotag/tiles-autotag-core/src/site/site.xml?rev=1305936&r1=1305935&r2=1305936&view=diff
==============================================================================
--- tiles/framework/trunk/tiles-autotag/tiles-autotag-core/src/site/site.xml (original)
+++ tiles/framework/trunk/tiles-autotag/tiles-autotag-core/src/site/site.xml Tue Mar 27 18:14:50 2012
@@ -45,7 +45,7 @@
name="Tiles Home"
href="../../index.html"/>
<item
- name="Tiles Autotags"
+ name="Tiles Autotag"
href="../index.html"/>
</menu>
Modified: tiles/framework/trunk/tiles-autotag/tiles-autotag-freemarker/src/site/site.xml
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-autotag/tiles-autotag-freemarker/src/site/site.xml?rev=1305936&r1=1305935&r2=1305936&view=diff
==============================================================================
--- tiles/framework/trunk/tiles-autotag/tiles-autotag-freemarker/src/site/site.xml (original)
+++ tiles/framework/trunk/tiles-autotag/tiles-autotag-freemarker/src/site/site.xml Tue Mar 27 18:14:50 2012
@@ -45,7 +45,7 @@
name="Tiles Home"
href="../../index.html"/>
<item
- name="Tiles Autotags"
+ name="Tiles Autotag"
href="../index.html"/>
</menu>
Modified: tiles/framework/trunk/tiles-autotag/tiles-autotag-jsp/src/site/site.xml
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-autotag/tiles-autotag-jsp/src/site/site.xml?rev=1305936&r1=1305935&r2=1305936&view=diff
==============================================================================
--- tiles/framework/trunk/tiles-autotag/tiles-autotag-jsp/src/site/site.xml (original)
+++ tiles/framework/trunk/tiles-autotag/tiles-autotag-jsp/src/site/site.xml Tue Mar 27 18:14:50 2012
@@ -45,7 +45,7 @@
name="Tiles Home"
href="../../index.html"/>
<item
- name="Tiles Autotags"
+ name="Tiles Autotag"
href="../index.html"/>
</menu>
Modified: tiles/framework/trunk/tiles-autotag/tiles-autotag-velocity/src/site/site.xml
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-autotag/tiles-autotag-velocity/src/site/site.xml?rev=1305936&r1=1305935&r2=1305936&view=diff
==============================================================================
--- tiles/framework/trunk/tiles-autotag/tiles-autotag-velocity/src/site/site.xml (original)
+++ tiles/framework/trunk/tiles-autotag/tiles-autotag-velocity/src/site/site.xml Tue Mar 27 18:14:50 2012
@@ -45,7 +45,7 @@
name="Tiles Home"
href="../../index.html"/>
<item
- name="Tiles Autotags"
+ name="Tiles Autotag"
href="../index.html"/>
</menu>
Modified: tiles/framework/trunk/tiles-parent/tiles-freemarker/pom.xml
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-parent/tiles-freemarker/pom.xml?rev=1305936&r1=1305935&r2=1305936&view=diff
==============================================================================
--- tiles/framework/trunk/tiles-parent/tiles-freemarker/pom.xml (original)
+++ tiles/framework/trunk/tiles-parent/tiles-freemarker/pom.xml Tue Mar 27 18:14:50 2012
@@ -45,7 +45,7 @@
</goals>
<configuration>
<packageName>org.apache.tiles.freemarker.template</packageName>
- <freemarkerRuntime>org.apache.tiles.autotag.freemarker.runtime.FreemarkerAutotagRuntime</freemarkerRuntime>
+ <freemarkerRuntime>org.apache.tiles.request.freemarker.autotag.FreemarkerAutotagRuntime</freemarkerRuntime>
</configuration>
</execution>
</executions>
@@ -101,10 +101,5 @@
<artifactId>tiles-request-freemarker</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
- <dependency>
- <groupId>org.apache.tiles</groupId>
- <artifactId>tiles-autotag-freemarker-runtime</artifactId>
- <version>1.0-SNAPSHOT</version>
- </dependency>
</dependencies>
</project>
Modified: tiles/framework/trunk/tiles-parent/tiles-jsp/pom.xml
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-parent/tiles-jsp/pom.xml?rev=1305936&r1=1305935&r2=1305936&view=diff
==============================================================================
--- tiles/framework/trunk/tiles-parent/tiles-jsp/pom.xml (original)
+++ tiles/framework/trunk/tiles-parent/tiles-jsp/pom.xml Tue Mar 27 18:14:50 2012
@@ -90,7 +90,7 @@
<configuration>
<taglibURI>http://tiles.apache.org/tags-tiles</taglibURI>
<packageName>org.apache.tiles.jsp.taglib</packageName>
- <jspRuntime>org.apache.tiles.autotag.jsp.runtime.JspAutotagRuntime</jspRuntime>
+ <jspRuntime>org.apache.tiles.request.jsp.autotag.JspAutotagRuntime</jspRuntime>
</configuration>
</execution>
</executions>
@@ -173,11 +173,6 @@
<artifactId>tiles-request-jsp</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
- <dependency>
- <groupId>org.apache.tiles</groupId>
- <artifactId>tiles-autotag-jsp-runtime</artifactId>
- <version>1.0-SNAPSHOT</version>
- </dependency>
</dependencies>
</project>
Modified: tiles/framework/trunk/tiles-parent/tiles-velocity/pom.xml
URL: http://svn.apache.org/viewvc/tiles/framework/trunk/tiles-parent/tiles-velocity/pom.xml?rev=1305936&r1=1305935&r2=1305936&view=diff
==============================================================================
--- tiles/framework/trunk/tiles-parent/tiles-velocity/pom.xml (original)
+++ tiles/framework/trunk/tiles-parent/tiles-velocity/pom.xml Tue Mar 27 18:14:50 2012
@@ -46,7 +46,7 @@
</goals>
<configuration>
<packageName>org.apache.tiles.velocity.template</packageName>
- <velocityRuntime>org.apache.tiles.autotag.velocity.runtime.VelocityAutotagRuntime</velocityRuntime>
+ <velocityRuntime>org.apache.tiles.request.velocity.autotag.VelocityAutotagRuntime</velocityRuntime>
</configuration>
</execution>
</executions>
@@ -162,10 +162,5 @@
<artifactId>tiles-request-velocity</artifactId>
<version>1.0-SNAPSHOT</version>
</dependency>
- <dependency>
- <groupId>org.apache.tiles</groupId>
- <artifactId>tiles-autotag-velocity-runtime</artifactId>
- <version>1.0-SNAPSHOT</version>
- </dependency>
</dependencies>
</project>