You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@turbine.apache.org by tv...@apache.org on 2013/04/28 09:47:34 UTC
svn commit: r860160 [3/3] - in /websites/production/turbine/content: ./
apidocs/ images/ images/logos/ style/ stylesheets/ testing/ xref/
Added: websites/production/turbine/content/project-info.html
==============================================================================
--- websites/production/turbine/content/project-info.html (added)
+++ websites/production/turbine/content/project-info.html Sun Apr 28 07:47:32 2013
@@ -0,0 +1,53 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html><head><title>Turbine Development Kit - Project Information</title><style type="text/css" media="all">
+ @import url("./style/maven-base.css");
+
+ @import url("./style/maven-theme.css");</style><link rel="stylesheet" href="./style/print.css" type="text/css" media="print"></link><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"></meta></head><body class="composite"><div id="banner"><a href="http://jakarta.apache.org/" id="organizationLogo"><img alt="Apache Software Foundation" src="./images/jakarta.png"></img></a><a href="http://jakarta.apache.org/turbine/tdk/" id="projectLogo"><img alt="jakarta-turbine-tdk" src="./images/blue-logo.gif"></img></a><div class="clear"><hr></hr></div></div><div id="breadcrumbs"><div class="xleft">
+ Last published: 02 April 2004
+ | Doc for 2.3</div><div class="xright">
+
+ <a href="http://jakarta.apache.org/turbine/">Turbine</a>
+
+
+
+ <span class="separator">|</span>
+
+
+ <a href="http://jakarta.apache.org/turbine/fulcrum/">Fulcrum</a>
+
+
+
+ <span class="separator">|</span>
+
+
+ <a href="http://jakarta.apache.org/turbine/tdk/">TDK</a>
+
+
+
+ <span class="separator">|</span>
+
+
+ <a href="http://jakarta.apache.org/turbine/jcs/">JCS</a>
+ </div><div class="clear"><hr></hr></div></div><div id="leftColumn"><div id="navcolumn"><div id="menuEssentials"><h5>Essentials</h5><ul><li class="none"><a href="index.html">Overview</a></li><li class="none"><a href="tdk-howto.html">Tutorial</a></li><li class="none"><a href="application-testing.html">Application Testing</a></li></ul></div><div id="menuProject_Documentation"><h5>Project Documentation</h5><ul><li class="none"><a href="index.html">About jakarta-turbine-tdk</a></li><li class="expanded"><strong><a href="project-info.html">Project Info</a></strong></li><li class="none"><a href="mail-lists.html">Mailing Lists</a></li><li class="none"><a href="team-list.html">Project Team</a></li><li class="none"><a href="dependencies.html">Dependencies</a></li><li class="none"><a href="cvs-usage.html">Source Repository</a></li><li class="none"><a href="issue-tracking.html">Issue Tracking</a></li><li class="collapsed"><a href="maven-reports.html">Project Reports</a></li><li cla
ss="none"><a href="http://maven.apache.org/development-process.html">Development Process</a></li></ul></div><a href="http://maven.apache.org/" title="Built by Maven" id="poweredBy"><img alt="Built by Maven" src="./images/logos/maven-button-1.png"></img></a></div></div><div id="bodyColumn"><div class="contentBox"><div class="section"><h2><a name="General_Project_Information">General Project Information</a></h2><p>
+ This document provides an overview of the various documents and
+ links that are part of this project's general information. All
+ of this content is automatically generated by
+ <a href="http://maven.apache.org/">Maven</a> on
+ behalf of the project.
+ </p><div class="subsection"><h3><a name="Overview">Overview</a></h3><table class="bodyTable"><tr class="a"><th>Document</th><th>Description</th></tr><tr class="b"><td><a href="mail-lists.html">Mailing Lists</a></td><td>
+ This document provides subscription and archive
+ information for this project's mailing lists.
+ </td></tr><tr class="a"><td><a href="team-list.html">Project Team</a></td><td>
+ This document provides information on the members of
+ this project. These are the individuals who have
+ contributed to the project in one form or another.
+ </td></tr><tr class="b"><td><a href="dependencies.html">Dependencies</a></td><td>
+ This document lists the projects dependencies and provides
+ information on each dependency.
+ </td></tr><tr class="a"><td><a href="cvs-usage.html">Source Repository</a></td><td>
+ This is a link to the online source repository that can be
+ viewed via a web browser.
+ </td></tr><tr class="b"><td><a href="issue-tracking.html">Issue Tracking</a></td><td>
+ This is a link to the issue tracking system for this
+ project. Issues (bugs, features, change requests) can be
+ created and queried using this link.
+ </td></tr></table></div></div></div></div><div class="clear"><hr></hr></div><div id="footer"><div class="xright">© 2000-2004, Apache Software Foundation</div><div class="clear"><hr></hr></div></div></body></html>
\ No newline at end of file
Propchange: websites/production/turbine/content/project-info.html
------------------------------------------------------------------------------
svn:executable =
Added: websites/production/turbine/content/style/maven-base.css
==============================================================================
--- websites/production/turbine/content/style/maven-base.css (added)
+++ websites/production/turbine/content/style/maven-base.css Sun Apr 28 07:47:32 2013
@@ -0,0 +1,141 @@
+body {
+ margin: 0px;
+ padding: 0px 0px 10px 0px;
+}
+img {
+ border:none;
+}
+table {
+ padding:0px;
+ width: 100%;
+ margin-left: -2px;
+ margin-right: -2px;
+}
+acronym {
+ cursor: help;
+ border-bottom: 1px dotted #feb;
+}
+table.bodyTable th, table.bodyTable td {
+ padding: 2px 4px 2px 4px;
+ vertical-align: top;
+}
+div.clear{
+ clear:both;
+ visibility: hidden;
+}
+div.clear hr{
+ display: none;
+}
+#projectLogo {
+ font-size: xx-large;
+ font-weight: bold;
+}
+#organizationLogo img, #projectLogo img, #projectLogo span{
+ margin: 8px;
+}
+#projectLogo span{
+ border: 1px solid;
+ padding: 4px 10px 4px 10px;
+ background-color: #eee;
+ cursor: pointer;
+}
+.xleft, #organizationLogo img{
+ float:left;
+}
+.xright, #projectLogo img, #projectLogo span{
+ float:right;
+ text-shadow: #7CFC00;
+}
+#banner {
+ border-bottom: 1px solid #fff;
+}
+#banner img {
+ border: none;
+}
+#footer, #breadcrumbs {
+ padding: 3px 10px 3px 10px;
+}
+#leftColumn {
+ width: 18%;
+ float:left;
+}
+#bodyColumn {
+ margin-left: 20%;
+}
+#navcolumn {
+ padding: 8px 4px 0 8px;
+}
+#navcolumn h5, #navcolumn ul {
+ margin: 0;
+ padding: 0;
+}
+#navcolumn li {
+ list-style-type: none;
+ background-image: none;
+ background-repeat: no-repeat;
+ background-position: 0.4em;
+ padding-left: 16px;
+ list-style-position: ouside;
+ line-height: 1.2em;
+ font-size: smaller;
+}
+#navcolumn li.expanded {
+ background-image: url(../images/expanded.gif);
+}
+#navcolumn li.collapsed {
+ background-image: url(../images/collapsed.gif);
+}
+#poweredBy {
+ text-align: center;
+}
+#navcolumn img {
+ margin-top: 10px;
+ margin-bottom: 3px;
+}
+#poweredBy img {
+ display:block;
+ margin: 20px 0 20px 17px;
+ border: 1px solid black;
+ width: 90px;
+ height: 30px;
+}
+#search img {
+ margin: 0px;
+ display: block;
+}
+#search #q, #search #btnG {
+ border: 1px solid #999;
+ margin-bottom:10px;
+}
+#search form {
+ margin: 0px;
+}
+#lastPublished {
+ font-size: x-small;
+}
+.navSection {
+ margin-bottom: 2px;
+ padding: 8px;
+}
+.navSectionHead {
+ font-weight: bold;
+ font-size: x-small;
+}
+.section {
+ padding: 4px;
+}
+#footer {
+ font-size: x-small;
+}
+#breadcrumbs {
+ font-size: x-small;
+ margin: 0pt;
+}
+.source {
+ padding: 12px;
+ margin: 1em 7px 1em 7px;
+}
+.source pre {
+ margin: 0px;
+ padding: 0px;
+}
Propchange: websites/production/turbine/content/style/maven-base.css
------------------------------------------------------------------------------
svn:executable =
Added: websites/production/turbine/content/style/maven-theme.css
==============================================================================
--- websites/production/turbine/content/style/maven-theme.css (added)
+++ websites/production/turbine/content/style/maven-theme.css Sun Apr 28 07:47:32 2013
@@ -0,0 +1,74 @@
+body, td, select, input, li{
+ font-family: Verdana, Helvetica, Arial, sans-serif;
+ font-size: 13px;
+}
+a {
+ text-decoration: none;
+}
+a:link {
+ color:#36a;
+}
+a:visited {
+ color:#47a;
+}
+a:active, a:hover {
+ color:#69c;
+}
+h2 {
+ padding: 4px 4px 4px 6px;
+ border: 1px solid #999;
+ color: #900;
+ background-color: #ddd;
+ font-weight:900;
+ font-size: x-large;
+}
+h3 {
+ padding: 4px 4px 4px 6px;
+ border: 1px solid #aaa;
+ color: #900;
+ background-color: #eee;
+ font-weight: normal;
+ font-size: large;
+}
+p {
+ line-height: 1.3em;
+ font-size: small;
+}
+#breadcrumbs {
+ border-top: 1px solid #aaa;
+ border-bottom: 1px solid #aaa;
+ background-color: #ccc;
+}
+#leftColumn {
+ margin: 10px 0 0 5px;
+ border: 1px solid #999;
+ background-color: #eee;
+}
+#navcolumn h5 {
+ font-size: smaller;
+ border-bottom: 1px solid #aaaaaa;
+ padding-top: 2px;
+}
+
+table.bodyTable th {
+ color: white;
+ background-color: #bbb;
+ text-align: left;
+ font-weight: bold;
+}
+
+table.bodyTable th, table.bodyTable td {
+ font-size: 1em;
+}
+
+table.bodyTable tr.a {
+ background-color: #ddd;
+}
+
+table.bodyTable tr.b {
+ background-color: #eee;
+}
+
+.source {
+ border: 1px solid #999;
+}
Propchange: websites/production/turbine/content/style/maven-theme.css
------------------------------------------------------------------------------
svn:executable =
Added: websites/production/turbine/content/style/print.css
==============================================================================
--- websites/production/turbine/content/style/print.css (added)
+++ websites/production/turbine/content/style/print.css Sun Apr 28 07:47:32 2013
@@ -0,0 +1,7 @@
+#banner, #footer, #leftcol, #breadcrumbs, .docs #toc, .docs .courtesylinks, #leftColumn, #navColumn {
+ display: none;
+}
+#bodyColumn, body.docs div.docs {
+ margin: 0 !important;
+ border: none !important
+}
Propchange: websites/production/turbine/content/style/print.css
------------------------------------------------------------------------------
svn:executable =
Added: websites/production/turbine/content/tdk-howto.html
==============================================================================
--- websites/production/turbine/content/tdk-howto.html (added)
+++ websites/production/turbine/content/tdk-howto.html Sun Apr 28 07:47:32 2013
@@ -0,0 +1,353 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html><head><title>Turbine Development Kit - Turbine Development Kit Howto</title><style type="text/css" media="all">
+ @import url("./style/maven-base.css");
+
+ @import url("./style/maven-theme.css");</style><link rel="stylesheet" href="./style/print.css" type="text/css" media="print"></link><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"></meta><meta name="author" content="Kurt Schrader"></meta><meta name="email" content="kschrade@engin.umich.edu"></meta><meta name="author" content="Jason van Zyl"></meta><meta name="email" content="jvanzyl@apache.org"></meta></head><body class="composite"><div id="banner"><a href="http://jakarta.apache.org/" id="organizationLogo"><img alt="Apache Software Foundation" src="./images/jakarta.png"></img></a><a href="http://jakarta.apache.org/turbine/tdk/" id="projectLogo"><img alt="jakarta-turbine-tdk" src="./images/blue-logo.gif"></img></a><div class="clear"><hr></hr></div></div><div id="breadcrumbs"><div class="xleft">
+ Last published: 02 April 2004
+ | Doc for 2.3</div><div class="xright">
+
+ <a href="http://jakarta.apache.org/turbine/">Turbine</a>
+
+
+
+ <span class="separator">|</span>
+
+
+ <a href="http://jakarta.apache.org/turbine/fulcrum/">Fulcrum</a>
+
+
+
+ <span class="separator">|</span>
+
+
+ <a href="http://jakarta.apache.org/turbine/tdk/">TDK</a>
+
+
+
+ <span class="separator">|</span>
+
+
+ <a href="http://jakarta.apache.org/turbine/jcs/">JCS</a>
+ </div><div class="clear"><hr></hr></div></div><div id="leftColumn"><div id="navcolumn"><div id="menuEssentials"><h5>Essentials</h5><ul><li class="none"><a href="index.html">Overview</a></li><li class="none"><strong><a href="tdk-howto.html">Tutorial</a></strong></li><li class="none"><a href="application-testing.html">Application Testing</a></li></ul></div><div id="menuProject_Documentation"><h5>Project Documentation</h5><ul><li class="none"><a href="index.html">About jakarta-turbine-tdk</a></li><li class="collapsed"><a href="project-info.html">Project Info</a></li><li class="collapsed"><a href="maven-reports.html">Project Reports</a></li><li class="none"><a href="http://maven.apache.org/development-process.html">Development Process</a></li></ul></div><a href="http://maven.apache.org/" title="Built by Maven" id="poweredBy"><img alt="Built by Maven" src="./images/logos/maven-button-1.png"></img></a></div></div><div id="bodyColumn"><div class="contentBox"><div class="secti
on"><h2><a name="Introduction">Introduction</a></h2><p>
+The Turbine Development Kit allows you to begin developing on/evaluating
+Turbine and its diverse set of components almost immediately. It includes
+almost everything needed to begin Turbine development. Installing it
+should be the first step in your evaluation of Turbine.
+</p><p>
+Much of this getting started guide has been put together using information
+found elsewhere on the website. It should not be seen as a replacement for
+reading the plethora of information available about Turbine, as new users seem
+to always do. It simply attempts to get a first time user up and running with
+the TDK quickly and with a general knowledge of how it works. As usual, please
+be sure that you have scoured the entire website for information before asking
+questions on the mailing list. Also, it is suggested that you read this entire
+guide before attemping to install the TDK.
+</p></div><div class="section"><h2><a name="Prerequisites_to_using_the_TDK">Prerequisites to using the TDK</a></h2><p>
+Before using the TDK, you are going to need to have a Java Software
+Development Kit supporting Java version 1.4 or later installed on your machine.
+Sun's Java SDK can be downloaded from their website located
+<a href="http://java.sun.com/j2se/downloads.html">here.</a>
+</p><p>
+You must have Ant installed on your machine in order to do
+anything. If you do not have Ant installed, you can find out
+how to install Ant <a href="http://ant.apache.org/manual/install.html">here</a>.
+The TDK version 2.3 is known to have compatibility issues when using Ant
+with version less than 1.5.
+</p><p>
+In order to use the mail functions you need to download the activation.jar
+from <a href="http://java.sun.com/products/javabeans/glasgow/jaf.html">here</a>.
+We are not allowed to redistribute this library.
+</p><p>
+In order to do anything interesting with the TDK, you are also going to need a
+database that is compatable with the JDBC standard. The TDK currently comes
+with drivers for Hypersonic, InstantDB, MySQL, Postgres and SAPDB. Other drivers
+can be downloaded from the vendor's websites located here:
+</p><ul>
+ <li>
+ <a href="http://technet.oracle.com/software/tech/java/sqlj_jdbc/software_index.htm">
+ Oracle JDBC Drivers
+ </a>.
+ </li>
+ <li>
+ <a href="http://www.sybase.com/products/middleware/jconnectforjdbc/">
+ Sybase JDBC Drivers
+ </a>.
+ </li>
+</ul><p>
+Simply download these drivers to any directory for now. We will make use
+of them later.
+</p></div><div class="section"><h2><a name="Fully_Supported_Platform_Database_Combinations">Fully Supported Platform/Database Combinations</a></h2><p>
+ Not every platform/database combination has been thoroughly tested
+ so your particular setup may require some leg work for full
+ functionality. The following combinations are known to work and
+ are tested with every release of the TDK:
+</p><table class="bodyTable"><tr class="a"><td><b>Platform</b></td><td><b>Database</b></td><td><b>Testers</b></td></tr><tr class="b"><td>Linux</td><td>MySQL</td><td><a href="mailto:mpoeschl@marmot.at">Martin Poeschl</a></td></tr><tr class="a"><td>WinXP</td><td>MySQL</td><td><a href="mailto:mpoeschl@marmot.at">Martin Poeschl</a></td></tr></table><p>
+ If the combination is not listed here, it doesn't mean that the TDK
+ won't work for you. It just means that no one regularly tests that
+ combination when new TDKs are released. If you get an unsupported
+ combination to work and you would like to test your combination
+ please post a message to the list and we will add you to the list
+ above.
+</p></div><div class="section"><h2><a name="Downloading_and_Installing_the_TDK">Downloading and Installing the TDK</a></h2><p>
+First of all, you have to get the TDK distribution. You can fetch it from
+the <a href="http://jakarta.apache.org/builds/jakarta-turbine/tdk/release/">Turbine
+release repository</a>. Search for the directory with the latest version, and
+download the file tdk-2.3.tar.gz. In actual fact no official 2.3 build has
+been released, but an unofficial beta can be downloaded from
+<a href="http://www.kiasoft.com/~painter/tdk-2.3_01.tgz">here</a>.
+</p><p>
+Unpack the TDK distribution into a directory of your choosing. On Windows, use
+WinZip to unpack the files and on Unix, something like:
+</p>
+ <div class="source"><pre>
+tar -xvzf tdk-2.3.tar.gz
+</pre></div>
+ <p>
+should to the trick. If you have met the above prerequisites, you will not
+need to download anything else to proceed with the installation.
+</p></div><div class="section"><h2><a name="Creating_your_first_Turbine_application">Creating your first Turbine application</a></h2><p>
+Now that you have the TDK installed on your machine, you need to create a
+sample application in order to begin using it. This is done in the following
+manner:
+</p><p>
+1. Setup your local environment variables. You will need both JAVA_HOME and
+ANT_HOME environment values for your system. On *nix/BSD using the Bash shell,
+this can be done with. It may be smart to go ahead and add these to your startup
+system login scripts if you have not already. Your CLASSPATH environment should
+not affect Ant's ability to build your TDK however, if you do run into a problem,
+you should be able to set CLASSPATH to be empty and build the tdk sample app.
+I would suggest setting a third variable for ease in the rest of this sample, TDK_HOME
+</p>
+ <div class="source"><pre>
+export ANT_HOME="/PATH/TO/ANT/"
+export JAVA_HOME="/PATH/TO/JDK/"
+export TDK_HOME="/PATH/TO/TDK/"
+</pre></div>
+ <p>
+2. Change to the TDK_HOME directory and modify the <strong>build.properties</strong> file.
+You will need to add an additional property called <strong>tdk.home</strong> which should be set
+the same as your environment TDK_HOME. If you wish to change the name of your
+application, you would adjust the property <strong>tdk.project</strong> to the name you wish.
+You can also adjust the package and directory structure that will be created at this point if you wish.
+To change the default package to your own, eg. com.company.appname, change the value of <strong>target.package</strong>
+and to change the directory you would set <strong>target.directory</strong> These two values
+are usually a mirror of one another. Here follows an example of the initial <strong>build.properties</strong>
+located in TDK_HOME
+</p>
+ <div class="source"><pre>
+# -------------------------------------------------------------------------
+# This is where you control the initial generation of the Turbine
+# sample webapp.
+# -------------------------------------------------------------------------
+tdk.home = /PATH/TO/TDK
+tdk.turbineVersion = 2
+tdk.project = newapp
+target.package = org.mycompany.newapp
+target.directory = org/mycompany/newapp
+</pre></div>
+ <p>
+3. Run Ant in the root directory of the TDK_HOME directory. The sample application
+will be generated with the default name of <strong>newapp</strong>.
+</p>
+ <div class="source"><pre>
+ant
+</pre></div>
+ <p>
+executed from your TDK_HOME directory, will create most of the files necessary for running your turbine app.
+</p><p>
+4. Once the initial set of files has been created, you will need to go into the
+directory <strong>TDK_HOME/webapps/newapp/WEB-INF/build</strong> and edit your <strong>build.properties</strong> file.
+This file is used to specify properties such as the type of database you are using and your DB
+connection info. The first adjustment you need to make is to add the <strong>tdk.home</strong>
+directive to the <strong>build.properties</strong> file.
+</p>
+ <div class="source"><pre>
+# -------------------------------------------------------------------
+# P R O J E C T P R O P E R T I E S
+# -------------------------------------------------------------------
+
+tdk.home = /path/to/tdk
+</pre></div>
+ <p>
+The information in <strong>build.properties</strong> is used to create the tables Turbine will be using
+and the classes used to access them. At this time you should also copy your JDBC drivers
+(renaming .zip files to .jar files) into the <strong>TDK_HOME/webapps/newapp/WEB-INF/lib</strong> directory if
+you are using a database for which the TDK does not provide JDBC drivers. These files will
+be important when creating the database tables in the next step.
+</p><p>
+To build the sample app, you will need to add the following configuration scope for torque. Since torque has
+been decoupled from the turbine environment, these values are not set by default any longer. Please check
+with your database vendor if you need assistance setting up your database values. Note that the <strong>manualCreation</strong>
+directive is set to true if you do not wish the tdk to create your database and tables. Set it to false to
+automatically build your sample application database. Turbine will still use the old database values in order
+to start up the application once you have completed building, so you do need both types of entries
+in your properties file. The following example will configure the tdk to build the sample <strong>newapp</strong>
+database for MySQL.
+</p>
+ <div class="source"><pre>
+# -------------------------------------------------------------------
+# D A T A B A S E S E T T I N G S
+# -------------------------------------------------------------------
+
+database = mysql
+databaseDriver = org.gjt.mm.mysql.Driver
+databaseUrl = jdbc:mysql://localhost/newapp
+databaseUser = dbUser
+databasePassword = dbPassword
+databaseHost = localhost
+
+torque.database.name = newapp
+torque.database.manualCreation = false
+torque.database.driver = org.gjt.mm.mysql.Driver
+torque.database.createUrl = jdbc:mysql://localhost/newapp
+torque.database.buildUrl = jdbc:mysql://localhost/newapp
+torque.database.user = dbUser
+torque.database.password = dbPassword
+</pre></div>
+ <p>
+5. Go to the directory "TDK_HOME/webapps/newapp/WEB-INF/build" and run the
+command "ant init". This command <strong>must be run</strong> before attempting to use the TDK.
+It creates the database tables and OM classes for accessing them.
+</p><p>
+NOTE
+<br></br>
+For Oracle and Sybase users it is often common that the database
+has already been created: if this is the case then by setting the
+<strong>torque.database.manualCreation</strong> property in your "build.properties"
+file you can force the 'create-database' target to
+be skipped.
+</p><p>
+6. Your first Turbine app has now been created! go back to the root directory
+of your TDK installation and type in "./bin/catalina.sh run" if you want to
+see console output or "./bin/catalina.sh start" if you want the servlet
+container process to run in the background.
+</p><p>
+NOTE
+<br></br>
+ If you want automatic class reloading to work, then you have to
+ configure it specifically for each webapp that you generate.
+ If you use the the default setup, then class reloading will be
+ setup for you i.e. your APPNAME is 'newapp'. If, for example,
+ your APPNAME is 'rupert' then you must add the following to your
+ conf/server.xml file:
+</p>
+ <div class="source"><pre>
+<context path="/rupert" docBase="rupert" reloadable="true"/>
+</pre></div>
+ <p>
+ Look for 'TDK SITE' in the conf/server.xml file and make
+ the adjustment just above it to get class reloading working.
+ You will see how the class reload has been setup for the
+ default 'newapp' and you can use that as an example.
+</p></div><div class="section"><h2><a name="Accessing_your_Turbine_application">Accessing your Turbine application</a></h2><p>
+Now that you have your Turbine application created and running by following the
+instructions above, point your browser to
+http://SERVERNAME:8080/APPNAME/servlet/APPNAME where SERVERNAME is the hostname
+of the machine running Tomcat, and APPNAME is the name of the application you
+created.
+</p><p>
+The initial login screen should appear and you should login with username
+'turbine' and password 'turbine' This will bring you to the initial "Turbine
+Data Manager" layout. From here you can insert/delete/edit entries in the
+default database or create and manage users using Flux, the built-in user
+management system for Turbine. These are the example turbine apps.
+</p></div><div class="section"><h2><a name="Editing_the_Example_App">Editing the Example App</a></h2><p>
+Look at the example app that you now have on your screen. The view that you are
+seeing actually consists of 4 different parts (top, bottom, menu and index) that
+were assembled for you on the fly by Velocity. In order to see how this works,
+you have to edit the file "webapps/APPNAME/templates/app/layouts/Default.vm"
+This file defines how the default layout is shown on your screen. As you can
+see, it is written as a fragment of HTML that will eventually be integrated into
+your final page. Editing this file will affect the layout of your entire
+application.
+</p><p>
+Knowing now how the page is laid out, go to the directory
+"webapps/APPNAME/templates/app/navigations" to see the files that will be
+inserted into the layout template above. Edit the file "DefaultBottom.vm", save
+your changes back, and reload your page. By doing this you should see whatever
+changes you have made to the file appear at the bottom of your layout. This
+change will also occur in all of the other pages on your site. Navigate to a
+different page in order to confirm this behavior.
+</p><p>
+Now go into the directory "webapps/APPNAME/templates/app/screens" The files in
+this directory are the ones that replace the "$screen_placeholder" variable in
+the original layout. Open up the file "Index.vm" and you will see that a
+variable is defined called "$headings" that holds the strings for each of the
+headings on the Index page and that a variable called "$entries" is used
+to show the dynamic data on the page. This variable comes from the Java class
+file that is associated with this .vm page, as explained in the next paragraph.
+The Index.vm page also includes a number of functions that begin with #, such as
+"#entryCell(...)" These functions are replaced with HTML fragments at runtime,
+as defined in the "webapps/APPNAME/templates/app/GlobalMacros.vm" file. Look at
+this file to get an idea of what each of these methods do. This file can be
+edited in order to add your own velocity macros to the system as well.
+</p><p>
+In order to view the Java file that is associated with the Index.vm, go to the
+directory "webapps/APPNAME/WEB-INF/src/java/PACKAGE/modules/screens" A quick
+look in this directory should show you that each page with dynamic data in it
+has an associated class file in this directory. Open the file "Index.java" and
+look over its contents. As you can see, the "doBuildTemplate" method creates a
+variable called "entries" and associates the data that it pulls from the
+database in the "getEntries" method into it. In the case of the Index.vm page,
+this corresponds to all of the entries from our example database. The
+"context.put("entries", getEntries())" method places the data and the associated
+handle for it into our session context so that it can be accessed from our
+Index.vm page. You would edit this file to change the behavior of a given
+page. More information on building sites with Velocity is available
+<a href="http://jakarta.apache.org/turbine/turbine-2.3/howto/velocity-site-howto.html">here.</a>
+</p></div><div class="section"><h2><a name="Action_Events">Action Events</a></h2><p>
+Now go back into your sample app in your web browser and insert an entry into
+the table. Look at the URL line in your browser. The end of it should contain
+"/action/SQL" This is the method that Turbine just used to insert your data
+into the database. The class file corresponding to it can be found in
+"webapps/APPNAME/WEB-INF/src/java/PACKAGE/modules/actions" and is called
+SQL.java. In fact, when you did your Insert of the data, Turbine called a
+method called "doInsert" inside of the SQL class in order to insert the data.
+A full explaination of how actions work is available
+<a href="http://jakarta.apache.org/turbine/turbine-2.3/howto/action-event-howto.html">here.</a>
+</p></div><div class="section"><h2><a name="Changing_your_schema">Changing your schema</a></h2><p>
+Now that we know about actions, we should change our database to something more
+useful. In order to do this, move to the directory
+"webapps/APPNAME/WEB-INF/conf" and open up the file
+"APPNAME-schema.xml". This file contains our database schema in XML. This
+file should be rather self explainatory. Within it you can create new tables
+and new fields within existing tables. Add some more rows to the example
+table and save the file back. Now go to the directory
+"webapps/APPNAME/WEB-INF/build" and run the command
+"ant init" again. (WARNING: If this is done you will lose all of your
+data in the existing tables, do not run if you have data in your tables
+that you want to save.) This will update existing databases and their objects
+with new fields and create the databases defined in the .xml file, along with
+their associated java classes. The java classes that Turbine uses to access
+your database are located in the directory
+"webapps/APPNAME/WEB-INF/src/java/PACKAGE/om" Look at them to get an idea of
+how the object-model portion of Turbine operates. There should be one named
+after each of the tables that you defined above in your schema. These classes
+will be used to interact with the database while using Turbine.
+</p><p>
+After our schema has been updated we will need to go back and edit the .vm files
+that operate on it. Go back into "Index.vm" as described above and change the
+headings to those that match your new schema. If you have created another table
+that you would like to call from the Index, or have changed the name of your
+original table, edit your "Index.java" file to get the data from that Database
+instead of the default one by calling the OM object for it instead.
+</p></div><div class="section"><h2><a name="Conclusion">Conclusion</a></h2><p>
+You now have your first Turbine application up and running and you now know
+how to edit the Java and .vm files in the TDK in order to begin building a
+specific application. In order to recompile any Java files that you change
+or create in the TDK, move to "webapps/APPNAME/WEB-INF/build" and run "ant
+compile". This will recompile all of the Java files that have changed in your
+project. You may also wish to join the Turbine Users mailing list. Instructions
+for doing so can be accessed via the <a href="project-info.html">Project Info
+</a> page.
+</p></div><div class="section"><h2><a name="Deployment">Deployment</a></h2><p>
+The TDK uses Tomcat 4.1 as it's Servlet container, but you can package up
+your webapps and run them under any compliant Servlet container. The only
+thing that you have to change are the references to the Servlet 2.3
+DTDs in your web.xml file. If you change these references, webapps that
+you develop with the TDK should be fully portable. We use the Tomcat 4.1
+server because it is the burgeoning standard.
+</p><p>
+We'll add more notes to this as the TDK gains more deployment features.
+There is a very primitive 'deploy' target, but all it currently does is
+package up your webapp in a WAR file.
+</p></div></div></div><div class="clear"><hr></hr></div><div id="footer"><div class="xright">© 2000-2004, Apache Software Foundation</div><div class="clear"><hr></hr></div></div></body></html>
\ No newline at end of file
Propchange: websites/production/turbine/content/tdk-howto.html
------------------------------------------------------------------------------
svn:executable =
Added: websites/production/turbine/content/tdk-structure.html
==============================================================================
--- websites/production/turbine/content/tdk-structure.html (added)
+++ websites/production/turbine/content/tdk-structure.html Sun Apr 28 07:47:32 2013
@@ -0,0 +1,41 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html><head><title>Turbine Development Kit - TDK Structure</title><style type="text/css" media="all">
+ @import url("./style/maven-base.css");
+
+ @import url("./style/maven-theme.css");</style><link rel="stylesheet" href="./style/print.css" type="text/css" media="print"></link><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"></meta><meta name="author" content="Jason van Zyl"></meta><meta name="email" content="jvanzyl@apache.org"></meta></head><body class="composite"><div id="banner"><a href="http://jakarta.apache.org/" id="organizationLogo"><img alt="Apache Software Foundation" src="./images/jakarta.png"></img></a><a href="http://jakarta.apache.org/turbine/tdk/" id="projectLogo"><img alt="jakarta-turbine-tdk" src="./images/blue-logo.gif"></img></a><div class="clear"><hr></hr></div></div><div id="breadcrumbs"><div class="xleft">
+ Last published: 02 April 2004
+ | Doc for 2.3</div><div class="xright">
+
+ <a href="http://jakarta.apache.org/turbine/">Turbine</a>
+
+
+
+ <span class="separator">|</span>
+
+
+ <a href="http://jakarta.apache.org/turbine/fulcrum/">Fulcrum</a>
+
+
+
+ <span class="separator">|</span>
+
+
+ <a href="http://jakarta.apache.org/turbine/tdk/">TDK</a>
+
+
+
+ <span class="separator">|</span>
+
+
+ <a href="http://jakarta.apache.org/turbine/jcs/">JCS</a>
+ </div><div class="clear"><hr></hr></div></div><div id="leftColumn"><div id="navcolumn"><div id="menuEssentials"><h5>Essentials</h5><ul><li class="none"><a href="index.html">Overview</a></li><li class="none"><a href="tdk-howto.html">Tutorial</a></li><li class="none"><a href="application-testing.html">Application Testing</a></li></ul></div><div id="menuProject_Documentation"><h5>Project Documentation</h5><ul><li class="none"><a href="index.html">About jakarta-turbine-tdk</a></li><li class="collapsed"><a href="project-info.html">Project Info</a></li><li class="collapsed"><a href="maven-reports.html">Project Reports</a></li><li class="none"><a href="http://maven.apache.org/development-process.html">Development Process</a></li></ul></div><a href="http://maven.apache.org/" title="Built by Maven" id="poweredBy"><img alt="Built by Maven" src="./images/logos/maven-button-1.png"></img></a></div></div><div id="bodyColumn"><div class="contentBox"><div class="section"><h2><a name="
TDK_Structure">TDK Structure</a></h2><p>
+ This document outlines the structure of the TDK for those who wish
+ to help develop the TDK, not those who want develop with the TDK. The
+ difference being that building and developing the TDK are not trivial tasks
+ while using the TDK should be dead simple.
+</p><p>
+ The following is a description of the layout of the TDK structure
+ that is used to produce the final distributable TDK package.
+</p>
+ <div class="source"><pre>
+</pre></div>
+ </div></div></div><div class="clear"><hr></hr></div><div id="footer"><div class="xright">© 2000-2004, Apache Software Foundation</div><div class="clear"><hr></hr></div></div></body></html>
\ No newline at end of file
Propchange: websites/production/turbine/content/tdk-structure.html
------------------------------------------------------------------------------
svn:executable =
Added: websites/production/turbine/content/team-list.html
==============================================================================
--- websites/production/turbine/content/team-list.html (added)
+++ websites/production/turbine/content/team-list.html Sun Apr 28 07:47:32 2013
@@ -0,0 +1,74 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html><head><title>Turbine Development Kit - Project Team</title><style type="text/css" media="all">
+ @import url("./style/maven-base.css");
+
+ @import url("./style/maven-theme.css");</style><link rel="stylesheet" href="./style/print.css" type="text/css" media="print"></link><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"></meta><script type="text/javascript">
+ function offsetDate(id, offset) {
+
+ var now = new Date() ;
+ var nowTime = now.getTime() ;
+ var localOffset = now.getTimezoneOffset() ;
+ var developerTime = nowTime + (offset * 60 * 60 * 1000) + (localOffset * 60 * 1000) ;
+ var developerDate = new Date(developerTime) ;
+
+ document.getElementById(id).innerHTML = developerDate;
+ }
+
+ function init() {
+ }
+ </script></head><body class="composite" onload="init();"><div id="banner"><a href="http://jakarta.apache.org/" id="organizationLogo"><img alt="Apache Software Foundation" src="./images/jakarta.png"></img></a><a href="http://jakarta.apache.org/turbine/tdk/" id="projectLogo"><img alt="jakarta-turbine-tdk" src="./images/blue-logo.gif"></img></a><div class="clear"><hr></hr></div></div><div id="breadcrumbs"><div class="xleft">
+ Last published: 02 April 2004
+ | Doc for 2.3</div><div class="xright">
+
+ <a href="http://jakarta.apache.org/turbine/">Turbine</a>
+
+
+
+ <span class="separator">|</span>
+
+
+ <a href="http://jakarta.apache.org/turbine/fulcrum/">Fulcrum</a>
+
+
+
+ <span class="separator">|</span>
+
+
+ <a href="http://jakarta.apache.org/turbine/tdk/">TDK</a>
+
+
+
+ <span class="separator">|</span>
+
+
+ <a href="http://jakarta.apache.org/turbine/jcs/">JCS</a>
+ </div><div class="clear"><hr></hr></div></div><div id="leftColumn"><div id="navcolumn"><div id="menuEssentials"><h5>Essentials</h5><ul><li class="none"><a href="index.html">Overview</a></li><li class="none"><a href="tdk-howto.html">Tutorial</a></li><li class="none"><a href="application-testing.html">Application Testing</a></li></ul></div><div id="menuProject_Documentation"><h5>Project Documentation</h5><ul><li class="none"><a href="index.html">About jakarta-turbine-tdk</a></li><li class="expanded"><a href="project-info.html">Project Info</a></li><li class="none"><a href="mail-lists.html">Mailing Lists</a></li><li class="none"><strong><a href="team-list.html">Project Team</a></strong></li><li class="none"><a href="dependencies.html">Dependencies</a></li><li class="none"><a href="cvs-usage.html">Source Repository</a></li><li class="none"><a href="issue-tracking.html">Issue Tracking</a></li><li class="collapsed"><a href="maven-reports.html">Project Reports</a></li><li cla
ss="none"><a href="http://maven.apache.org/development-process.html">Development Process</a></li></ul></div><a href="http://maven.apache.org/" title="Built by Maven" id="poweredBy"><img alt="Built by Maven" src="./images/logos/maven-button-1.png"></img></a></div></div><div id="bodyColumn"><div class="contentBox"><div class="section"><h2><a name="The_Team">The Team</a></h2><p>
+ A successful project requires many people to play many roles.
+ Some members write code or documentation, while others are
+ valuable as testers, submitting patches and suggestions.
+ </p><p>
+ The team is comprised of <a href="#Members">Members</a>
+ and <a href="#Contributors">Contributors</a>. Members
+ have direct access to the source of a project and actively
+ evolve the code-base. Contributors improve the project
+ through submission of patches and suggestions to the Members.
+ The number of Contributors to the project is unbounded.
+ Get involved today. All contributions to the project are
+ greatly appreciated.
+ </p><div class="subsection"><h3><a name="Members">Members</a></h3><p>
+ The following is a list of developers with commit privileges that have
+ directly contributed to the project in one way or another.
+ </p><table class="bodyTable"><thead>
+ <tr class="a"><th>Name</th><th>Id</th><th>Email</th><th>Organization</th><th>Roles</th><th>TZ Offset</th><th>Time</th></tr>
+ </thead><tbody>
+ <tr class="b"><td>Martin Poeschl</td><td><a name="mpoeschl">mpoeschl</a></td><td><a href="mailto:mpoeschl@marmot.at">mpoeschl@marmot.at</a></td><td>tucana.at</td><td>
+ </td><td></td><td><span id="developer-mpoeschl">Unknown</span></td></tr>
+ <tr class="a"><td>Daniel Rall</td><td><a name="dlr">dlr</a></td><td><a href="mailto:dlr@finemaltcoding.com">dlr@finemaltcoding.com</a></td><td>CollabNet, Inc.</td><td>
+ </td><td></td><td><span id="developer-dlr">Unknown</span></td></tr>
+ <tr class="b"><td>Jon Scott Stevens</td><td><a name="jon">jon</a></td><td><a href="mailto:jon@latchkey.com">jon@latchkey.com</a></td><td>CollabNet, Inc.</td><td>
+ </td><td></td><td><span id="developer-jon">Unknown</span></td></tr>
+ <tr class="a"><td>Jason van Zyl</td><td><a name="jvanzyl">jvanzyl</a></td><td><a href="mailto:jason@zenplex.com">jason@zenplex.com</a></td><td>Zenplex</td><td>
+ </td><td></td><td><span id="developer-jvanzyl">Unknown</span></td></tr>
+ </tbody></table></div><div class="subsection"><h3><a name="Contributors">Contributors</a></h3><p>
+ There are no contributors listed for this project. Please check
+ back again later.
+ </p></div></div></div></div><div class="clear"><hr></hr></div><div id="footer"><div class="xright">© 2000-2004, Apache Software Foundation</div><div class="clear"><hr></hr></div></div></body></html>
\ No newline at end of file
Propchange: websites/production/turbine/content/team-list.html
------------------------------------------------------------------------------
svn:executable =
Added: websites/production/turbine/content/testing/standalone.html
==============================================================================
--- websites/production/turbine/content/testing/standalone.html (added)
+++ websites/production/turbine/content/testing/standalone.html Sun Apr 28 07:47:32 2013
@@ -0,0 +1,179 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html><head><title>Turbine Development Kit - Start Turbine in standalone mode</title><style type="text/css" media="all">
+ @import url("../style/maven-base.css");
+
+ @import url("../style/maven-theme.css");</style><link rel="stylesheet" href="../style/print.css" type="text/css" media="print"></link><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"></meta><meta name="author" content="Jeffrey D. Brekke"></meta><meta name="email" content="brekke@apache.org"></meta></head><body class="composite"><div id="banner"><a href="http://jakarta.apache.org/" id="organizationLogo"><img alt="Apache Software Foundation" src="../images/jakarta.png"></img></a><a href="http://jakarta.apache.org/turbine/tdk/" id="projectLogo"><img alt="jakarta-turbine-tdk" src="../images/blue-logo.gif"></img></a><div class="clear"><hr></hr></div></div><div id="breadcrumbs"><div class="xleft">
+ Last published: 02 April 2004
+ | Doc for 2.3</div><div class="xright">
+
+ <a href="http://jakarta.apache.org/turbine/">Turbine</a>
+
+
+
+ <span class="separator">|</span>
+
+
+ <a href="http://jakarta.apache.org/turbine/fulcrum/">Fulcrum</a>
+
+
+
+ <span class="separator">|</span>
+
+
+ <a href="http://jakarta.apache.org/turbine/tdk/">TDK</a>
+
+
+
+ <span class="separator">|</span>
+
+
+ <a href="http://jakarta.apache.org/turbine/jcs/">JCS</a>
+ </div><div class="clear"><hr></hr></div></div><div id="leftColumn"><div id="navcolumn"><div id="menuEssentials"><h5>Essentials</h5><ul><li class="none"><a href="../index.html">Overview</a></li><li class="none"><a href="../tdk-howto.html">Tutorial</a></li><li class="none"><a href="../application-testing.html">Application Testing</a></li></ul></div><div id="menuProject_Documentation"><h5>Project Documentation</h5><ul><li class="none"><a href="../index.html">About jakarta-turbine-tdk</a></li><li class="collapsed"><a href="../project-info.html">Project Info</a></li><li class="collapsed"><a href="../maven-reports.html">Project Reports</a></li><li class="none"><a href="http://maven.apache.org/development-process.html">Development Process</a></li></ul></div><a href="http://maven.apache.org/" title="Built by Maven" id="poweredBy"><img alt="Built by Maven" src="../images/logos/maven-button-1.png"></img></a></div></div><div id="bodyColumn"><div class="contentBox"><div class="sec
tion"><h2><a name="Start_Turbine_in_standalone_mode">Start Turbine in standalone mode</a></h2><p>
+In order to test certain code that is using some of Turbine's services
+and singletons, it may be required to have Turbine running. Turbine
+started without a servlet container is considered running in <i>standalone
+mode</i>. The javadocs for TurbineConfig have more information but
+below is how to start Turbine in <i>standalone mode</i>.
+</p>
+ <div class="source"><pre>
+TurbineConfig config = null;
+config = new TurbineConfig("../",
+ "/conf/test.TurbineResources.properties");
+config.init();
+</pre></div>
+ <p>
+So our test case needs to start Turbine, run our tests, and stop
+Turbine. Stopping Turbine is easy since the objects are destroyed when
+the test case terminates. There are two ways to write test cases with
+Turbine running standalone. The first method is to define a base class
+that starts up Turbine in a static initializer. Then all your test
+cases that need Turbine running should descend this base test case.
+</p>
+ <div class="source"><pre>
+package org.mycompany.newapp.test;
+
+import junit.framework.TestCase;
+import org.apache.turbine.util.TurbineConfig;
+import org.apache.turbine.util.StringUtils;
+
+/**
+ Base test case used to start Turbine in standalone mode.
+ */
+public class TurbineStandaloneTestCase extends TestCase
+{
+ /*
+ Configuration object to run Turbine outside a servlet container
+ ( uses turbine.properties )
+ */
+ private static TurbineConfig config = null;
+
+ /**
+ Sets up TurbineConfig using the system property:
+ <pre>turbine.properties</pre>
+ */
+ static
+ {
+ try
+ {
+ config = new TurbineConfig( "..",
+ System.getProperties().getProperty(
+ "turbine.properties",
+ "/conf/TurbineResources.properties" ) );
+ config.init();
+ }
+ catch (Exception e)
+ {
+ fail(StringUtils.stackTrace(e));
+ }
+ }
+
+ public TurbineStandaloneTestCase( String name )
+ {
+ super( name );
+ }
+}
+
+</pre></div>
+ <p>
+The base class test case method of starting Turbine has one drawback.
+If you have many test cases that descend TurbineStandaloneTestCase,
+each one will start Turbine, run some tests, and stop Turbine. This
+may slow down the testing process, especially when the unit tests are
+automated. The second method uses the TestSetup decorator provided by
+JUnit to start Turbine for a set of test cases. In this case we create
+an AllTests class which runs the test cases for us.
+</p>
+ <div class="source"><pre>
+package org.mycompany.newapp.test;
+
+import junit.framework.TestCase;
+import junit.framework.TestSuite;
+import junit.extensions.TestSetup;
+import junit.framework.Test;
+
+import org.apache.turbine.util.TurbineConfig;
+import org.apache.turbine.util.StringUtils;
+
+/**
+ Runs all the unit tests for the current package.
+ */
+public class AllTests extends TestCase
+{
+ public AllTests(String name)
+ {
+ super(name);
+ }
+
+ public static Test suite()
+ {
+ /* These are tests that need Turbine running */
+
+ TestSuite tsuite = new TestSuite();
+ tsuite.addTest(test1Test.suite());
+ tsuite.addTest(test2Test.suite());
+ tsuite.addTest(test3Test.suite());
+
+ TestSetup wrapper= new TestSetup(tsuite)
+ {
+ private TurbineConfig config = null;
+ public void setUp()
+ {
+ try
+ {
+ config = new TurbineConfig("../",
+ System.getProperties().getProperty(
+ "turbine.properties",
+ "/conf/test.TurbineResources.properties") );
+ config.init();
+ }
+ catch (Exception e)
+ {
+ fail( StringUtils.stackTrace(e) );
+ }
+ }
+ };
+
+ TestSuite realSuite = new TestSuite();
+
+ /* These are tests that don't need Turbine started */
+
+ realSuite.addTest(test4Test.suite());
+ realSuite.addTest(test5Test.suite());
+
+ realSuite.addTest(wrapper);
+ return realSuite;
+ }
+}
+
+</pre></div>
+ <p>
+The AllTests class creates a test suite containing the tests that
+require Turbine to be started. Then a TestSetup wrapper is created
+around that suite of tests. A return suite is built with test 4 and 5
+that do not require Turbine running. The wrapper suite containing the
+decorator and tests 1, 2, and 3 are then added to the return suite.
+The order the test cases will run is: 4, 5, 1, 2, 3. This now ensures
+that Turbine is started once for tests 1, 2 and 3. The drawback to
+this method is you cannot run one test case alone, you must always run
+all the tests. The first method, since Turbine is started for each
+case, you can run each test individually.
+</p></div></div></div><div class="clear"><hr></hr></div><div id="footer"><div class="xright">© 2000-2004, Apache Software Foundation</div><div class="clear"><hr></hr></div></div></body></html>
\ No newline at end of file
Propchange: websites/production/turbine/content/testing/standalone.html
------------------------------------------------------------------------------
svn:executable =
Added: websites/production/turbine/content/testing/usingmocks.html
==============================================================================
--- websites/production/turbine/content/testing/usingmocks.html (added)
+++ websites/production/turbine/content/testing/usingmocks.html Sun Apr 28 07:47:32 2013
@@ -0,0 +1,116 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html><head><title>Turbine Development Kit - Use mock objects for RunData and Context</title><style type="text/css" media="all">
+ @import url("../style/maven-base.css");
+
+ @import url("../style/maven-theme.css");</style><link rel="stylesheet" href="../style/print.css" type="text/css" media="print"></link><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"></meta><meta name="author" content="Jeffrey D. Brekke"></meta><meta name="email" content="brekke@apache.org"></meta></head><body class="composite"><div id="banner"><a href="http://jakarta.apache.org/" id="organizationLogo"><img alt="Apache Software Foundation" src="../images/jakarta.png"></img></a><a href="http://jakarta.apache.org/turbine/tdk/" id="projectLogo"><img alt="jakarta-turbine-tdk" src="../images/blue-logo.gif"></img></a><div class="clear"><hr></hr></div></div><div id="breadcrumbs"><div class="xleft">
+ Last published: 02 April 2004
+ | Doc for 2.3</div><div class="xright">
+
+ <a href="http://jakarta.apache.org/turbine/">Turbine</a>
+
+
+
+ <span class="separator">|</span>
+
+
+ <a href="http://jakarta.apache.org/turbine/fulcrum/">Fulcrum</a>
+
+
+
+ <span class="separator">|</span>
+
+
+ <a href="http://jakarta.apache.org/turbine/tdk/">TDK</a>
+
+
+
+ <span class="separator">|</span>
+
+
+ <a href="http://jakarta.apache.org/turbine/jcs/">JCS</a>
+ </div><div class="clear"><hr></hr></div></div><div id="leftColumn"><div id="navcolumn"><div id="menuEssentials"><h5>Essentials</h5><ul><li class="none"><a href="../index.html">Overview</a></li><li class="none"><a href="../tdk-howto.html">Tutorial</a></li><li class="none"><a href="../application-testing.html">Application Testing</a></li></ul></div><div id="menuProject_Documentation"><h5>Project Documentation</h5><ul><li class="none"><a href="../index.html">About jakarta-turbine-tdk</a></li><li class="collapsed"><a href="../project-info.html">Project Info</a></li><li class="collapsed"><a href="../maven-reports.html">Project Reports</a></li><li class="none"><a href="http://maven.apache.org/development-process.html">Development Process</a></li></ul></div><a href="http://maven.apache.org/" title="Built by Maven" id="poweredBy"><img alt="Built by Maven" src="../images/logos/maven-button-1.png"></img></a></div></div><div id="bodyColumn"><div class="contentBox"><div class="sec
tion"><h2><a name="Use_mock_objects_for_RunData_and_Context">Use mock objects for RunData and Context</a></h2><p>
+Using mock objects, you can test Turbine action methods directly
+without having Turbine running. Mock objects are simple implementations of an
+interface in the system to monitor operations on the objects. In
+Turbine, VeloctyAction classes have methods with two objects passed, RunData and
+Context. By passing mock objects to our action event method, we can
+call the method directly from within a test case and exercise our action
+code. In this example, we'll test the simplest method, doPerform from the sample
+application in the TDK. This is code directly from the SQL action class.
+</p>
+ <div class="source"><pre>
+public void doPerform(RunData data, Context context)
+ throws Exception
+{
+ data.setMessage("Can't find the button!");
+}
+</pre></div>
+ <p>
+To test the doPerform method, we need to pass a mock RunData and
+Context object to the method. We should be able to inspect the RunData
+object and verify that the setMessage() method was called and the
+correct text was passed. The <a href="http://www.mockobjects.com">Mock
+Objects</a> project provides a set of classes to aid in implementing
+mock objects for testing. This example uses the <a href="http://tammofreese.de/easymock/index.html">EasyMock</a> package.
+</p>
+ <div class="source"><pre>
+package org.mycompany.newapp.modules.actions;
+
+import junit.framework.TestCase;
+import junit.framework.TestSuite;
+import junit.framework.Test;
+
+import org.easymock.EasyMock;
+import org.easymock.MockControl;
+
+import org.apache.turbine.util.RunData;
+import org.apache.turbine.modules.actions.VelocityAction;
+
+public class SQLTest extends TestCase
+{
+ public SQLTest(String name)
+ {
+ super(name);
+ }
+
+ public static Test suite()
+ {
+ return new TestSuite( SQLTest.class );
+ }
+
+ public void testDoPerform() throws Exception
+ {
+ /* Create a control and mock RunData object */
+ MockControl rundataCtl = EasyMock.controlFor(RunData.class);
+ RunData rundata = (RunData) rundataCtl.getMock();
+
+ /* Set up our mock RunData */
+ rundata.setMessage("Can't find the button!");
+
+ /* Create our action to test */
+ VelocityAction action = new SQL();
+ assertNotNull(action);
+
+ /* Activate the RunData object, call the method, verify results */
+ rundataCtl.activate();
+ action.doPerform(rundata, null);
+ rundataCtl.verify();
+ }
+}
+</pre></div>
+ <p>
+In the setUp() method we configure the mock RunData object to expect
+one call to the setMessage() method with the correct text. We then
+create the action, call doPerform() passing our mock RunData object and
+verify that contents of the mock after the action has executed. If the
+setMessage() method was called with the incorrect parameter, or called
+more or less than one time, the test will fail.
+</p><p>
+The mock object for RunData could have been implemented with the Mock
+Objects library and compiled with the test code. Having the mock
+objects coded this way makes the test case simpler and the test will
+run slightly faster than using EasyMock. The trade off is another
+source file to maintain and update when the Turbine interface changes.
+Using EasyMock, the test cases are more complicated to setup with the
+control objects, but there is no additional source code to write other
+than the test.
+</p></div></div></div><div class="clear"><hr></hr></div><div id="footer"><div class="xright">© 2000-2004, Apache Software Foundation</div><div class="clear"><hr></hr></div></div></body></html>
\ No newline at end of file
Propchange: websites/production/turbine/content/testing/usingmocks.html
------------------------------------------------------------------------------
svn:executable =
Added: websites/production/turbine/content/todo.html
==============================================================================
--- websites/production/turbine/content/todo.html (added)
+++ websites/production/turbine/content/todo.html Sun Apr 28 07:47:32 2013
@@ -0,0 +1,69 @@
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html><head><title>Turbine Development Kit - TDK Todo</title><style type="text/css" media="all">
+ @import url("./style/maven-base.css");
+
+ @import url("./style/maven-theme.css");</style><link rel="stylesheet" href="./style/print.css" type="text/css" media="print"></link><meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1"></meta><meta name="author" content="Jason van Zyl"></meta><meta name="email" content="jvanzyl@periapt.com"></meta></head><body class="composite"><div id="banner"><a href="http://jakarta.apache.org/" id="organizationLogo"><img alt="Apache Software Foundation" src="./images/jakarta.png"></img></a><a href="http://jakarta.apache.org/turbine/tdk/" id="projectLogo"><img alt="jakarta-turbine-tdk" src="./images/blue-logo.gif"></img></a><div class="clear"><hr></hr></div></div><div id="breadcrumbs"><div class="xleft">
+ Last published: 02 April 2004
+ | Doc for 2.3</div><div class="xright">
+
+ <a href="http://jakarta.apache.org/turbine/">Turbine</a>
+
+
+
+ <span class="separator">|</span>
+
+
+ <a href="http://jakarta.apache.org/turbine/fulcrum/">Fulcrum</a>
+
+
+
+ <span class="separator">|</span>
+
+
+ <a href="http://jakarta.apache.org/turbine/tdk/">TDK</a>
+
+
+
+ <span class="separator">|</span>
+
+
+ <a href="http://jakarta.apache.org/turbine/jcs/">JCS</a>
+ </div><div class="clear"><hr></hr></div></div><div id="leftColumn"><div id="navcolumn"><div id="menuEssentials"><h5>Essentials</h5><ul><li class="none"><a href="index.html">Overview</a></li><li class="none"><a href="tdk-howto.html">Tutorial</a></li><li class="none"><a href="application-testing.html">Application Testing</a></li></ul></div><div id="menuProject_Documentation"><h5>Project Documentation</h5><ul><li class="none"><a href="index.html">About jakarta-turbine-tdk</a></li><li class="collapsed"><a href="project-info.html">Project Info</a></li><li class="collapsed"><a href="maven-reports.html">Project Reports</a></li><li class="none"><a href="http://maven.apache.org/development-process.html">Development Process</a></li></ul></div><a href="http://maven.apache.org/" title="Built by Maven" id="poweredBy"><img alt="Built by Maven" src="./images/logos/maven-button-1.png"></img></a></div></div><div id="bodyColumn"><div class="contentBox"><div class="section"><h2><a name="
Todo">Todo</a></h2><p>
+ This document describes functionality that is either missing or not finished
+ within the TDK as well as the owners of implementing or coordinating the
+ implementation of these features.
+</p><p>
+ Wish List functionality is stuff that we would like to see implemented, but is
+ not critical for release. This is the area where you can take ownership of a
+ part of the project and contribute back.
+</p><p>
+ If you are a new developer to the TDK or even an existing developer, these are
+ areas where you can take ownership and help complete. Please do not ask us how
+ you can help, but rather specific questions about how you think that these
+ items should be implemented. It is up to you to take initiative and provide
+ solutions to the missing functionality described below. ;-)
+</p><p>
+ It is always possible to take ownership of any portion of the project. The way
+ to do this is to communicate with the owner of the portion and then come to
+ some sort of agreement about what portions you will be splitting up or taking
+ over. If you cannot get a response from the people in charge of the projects,
+ assume they are dead and fill yourself in.
+</p><p>
+ Documentation is *always* appreciated in any form. There are two ways to
+ provide helpful documentation. The first way is to write up HTML or straight
+ text documentation and send it to one of the primary authors directly (we are
+ also willing to give you CVS write access if you wish). The second way is to
+ post Questions/Answers or other content to the <a href="http://jakarta.apache.org/turbine/common/wiki.html">
+ Turbine Wiki</a>. There is a <a href="http://jakarta.apache.org/turbine/turbine-2.3/getting-started.html">
+ Getting Started</a> document that could always use additional documentation,
+ examples and clarification. You need to take the initiative and just start
+ writing down your thoughts and concerns and questions and answers and then
+ giving those back to us.
+</p><p>
+ If you need more detailed help, please send mail to the mailing list
+ (turbine-dev@jakarta.apache.org) and ask your specific questions there.
+</p></div><div class="section"><h2><a name="Wish_List">Wish List</a></h2><ul>
+ <li>Create tutorial documentation.
+
+ <p>Owner: None</p>
+ </li>
+</ul></div></div></div><div class="clear"><hr></hr></div><div id="footer"><div class="xright">© 2000-2004, Apache Software Foundation</div><div class="clear"><hr></hr></div></div></body></html>
\ No newline at end of file
Propchange: websites/production/turbine/content/todo.html
------------------------------------------------------------------------------
svn:executable =