Update of /cvsroot/xdoclet-plugins/xdoclet-plugins/plugin-tapestry/xdocs
In directory
sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv4606/xdoclet-plugins/plugin-tapestry/xdocs
Modified Files:
examples.xml index.xml navigation.xml roadmap.xml
usage-ant.xml usage-maven.xml
Added Files:
idea-integration.xml
Log Message:
Added maven style documentation... but not finished yet :-(
Index: index.xml
===================================================================
RCS file:
/cvsroot/xdoclet-plugins/xdoclet-plugins/plugin-tapestry/xdocs/index.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** index.xml 4 Dec 2005 20:04:04 -0000 1.1
--- index.xml 6 Dec 2005 00:15:02 -0000 1.2
***************
*** 64,69 ****
</span>
</body>
! </html>
! ]]></source>
<p>
This tricky tapestry page can work only if you write a .page descriptor like
this:
--- 64,68 ----
</span>
</body>
! </html>]]></source>
<p>
This tricky tapestry page can work only if you write a .page descriptor like
this:
***************
*** 76,81 ****
<binding name="value" value="ognl:message"/>
</component>
! </page-specification>
! ]]></source>
X2TP aims to keep all spec infos close to your java code.
--- 75,79 ----
<binding name="value" value="ognl:message"/>
</component>
! </page-specification>]]></source>
X2TP aims to keep all spec infos close to your java code.
***************
*** 96,101 ****
return "Hello Tapestry World";
}
! }
! </source>
<p>
You can get rid of your .page file. It will be generated by your
preferred build tool (Maven or Ant) as soon as you invoke it.
--- 94,98 ----
return "Hello Tapestry World";
}
! }</source>
<p>
You can get rid of your .page file. It will be generated by your
preferred build tool (Maven or Ant) as soon as you invoke it.
Index: navigation.xml
===================================================================
RCS file:
/cvsroot/xdoclet-plugins/xdoclet-plugins/plugin-tapestry/xdocs/navigation.xml,v
retrieving revision 1.2
retrieving revision 1.3
diff -C2 -d -r1.2 -r1.3
*** navigation.xml 4 Dec 2005 20:04:03 -0000 1.2
--- navigation.xml 6 Dec 2005 00:15:02 -0000 1.3
***************
*** 14,17 ****
--- 14,18 ----
<item name="Tapestry tags" href="/qtags.html"/>
<item name="Examples" href="/examples.html"/>
+ <item name="IntelliJ IDEA Integration"
href="/idea-integration.html"/>
<item name="Roadmap" href="/roadmap.html"/>
</menu>
Index: roadmap.xml
===================================================================
RCS file:
/cvsroot/xdoclet-plugins/xdoclet-plugins/plugin-tapestry/xdocs/roadmap.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** roadmap.xml 4 Dec 2005 20:04:04 -0000 1.1
--- roadmap.xml 6 Dec 2005 00:15:02 -0000 1.2
***************
*** 3,9 ****
<properties>
! <author email="nospam.AT.foo.DOT.com">Jon S. Stevens</author>
! <author email="mrsmith.AT.foo.DOT.com">Mr. Smith</author>
! <title>TITLE</title>
</properties>
--- 3,8 ----
<properties>
! <author email="[EMAIL PROTECTED]">Paolo DOna</author>
! <title>Roadmap</title>
</properties>
***************
*** 11,59 ****
<body>
-
-
<section name="Roadmap">
! <p>
! This is section 1.
! </p>
!
! <table>
! <tr>
! <td>This is a table</td>
! </tr>
! </table>
!
<ul>
! <li>This is an unordered list.</li>
</ul>
</section>
! <section name="Section 2">
! <p>
! This is section 2.
! </p>
!
! <ol>
! <li>This is an ordered list.</li>
! </ol>
! </section>
!
! <section name="Section 3">
! <p>
! This is section 3.
! </p>
!
! <source>
! Anything within this tag is rendered as a "box"
! with blue lines and <pre></pre> tags around it.
! </source>
!
! <subsection name="Subsection of Section 3">
! <p>
! This is the subsection 3.
! </p>
! </subsection>
! </section>
! </body>
</document>
--- 10,33 ----
<body>
<section name="Roadmap">
! <subsecion name="Upcoming 1.0.3 release">
<ul>
! <li>Basic Tags: generate xml elements of Tapestry4.0 dtd.</li>
! <li>Framework Tags: mapping of framework components</li>
! <li>Contrib Tags: mapping of contrib components</li>
! <li>Tacos Tags: mapping of tacos library components</li>
</ul>
+ </subsecion>
+ <subsecion name="1.0.4 release">
+ <ul>
+ <li>Tags Ineritance</li>
+ <li>Reduction of redundant attributes</li>
+ <li>Introduction of smart defaults for tags that can guess their
values from source code</li>
+ <li>Performance improvements</li>
+ </ul>
+ </subsecion>
</section>
! </body>
</document>
Index: usage-maven.xml
===================================================================
RCS file:
/cvsroot/xdoclet-plugins/xdoclet-plugins/plugin-tapestry/xdocs/usage-maven.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** usage-maven.xml 4 Dec 2005 20:04:04 -0000 1.1
--- usage-maven.xml 6 Dec 2005 00:15:02 -0000 1.2
***************
*** 1,8 ****
<?xml version="1.0" encoding="ISO-8859-1"?>
<document>
-
<properties>
! <author email="nospam.AT.foo.DOT.com">Jon S. Stevens</author>
! <author email="mrsmith.AT.foo.DOT.com">Mr. Smith</author>
<title>TITLE</title>
</properties>
--- 1,6 ----
<?xml version="1.0" encoding="ISO-8859-1"?>
<document>
<properties>
! <author email="[EMAIL PROTECTED]">Jon S. Stevens</author>
<title>TITLE</title>
</properties>
***************
*** 30,35 ****
-DgroupId=xdoclet
-DartifactId=maven-xdoclet2-plugin
! -Dversion=1.0.3
! </source>
<p>
This should download and install the XDoclet2 engine for maven.
--- 28,32 ----
-DgroupId=xdoclet
-DartifactId=maven-xdoclet2-plugin
! -Dversion=1.0.3</source>
<p>
This should download and install the XDoclet2 engine for maven.
***************
*** 52,93 ****
xdoclet2:run
! A Maven plugin to run XDoclet2 from within Maven
! </source>
</subsection>
! <subsection name="Step 2: ">
<p>
! I'll assume you already set up your very own maven webapp, so we won't dig
into this (If you have not, see the maven genapp documentation).
</p>
<p>
Now we'll add basic tapestry deps to your project.
Check out the current tapestry dependencies list at <a
href="http://jakarta.apache.org/tapestry/dependencies.html";>http://jakarta.apache.org/tapestry/dependencies.html</a>.
</p>
<p>
The xml fragment to insert into your project.xml should be something like:
</p>
! <source>
!
! </source>
!
! include in your project.xml the following dependency:
!
! <dependency>
! <groupId>xdoclet-plugins</groupId>
! <artifactId>xdoclet-plugin-tapestry</artifactId>
! <version>1.0.3-SNAPSHOT</version>
! <url>http://xdoclet-plugins.sf.net</url>
! <properties>
! <xdoclet.dependency>true</xdoclet.dependency>
! </properties>
! </dependency>
! and add the property
! <xdoclet.dependency>true</xdoclet.dependency>
! to your
</subsection>
!
</section>
</body>
--- 49,279 ----
xdoclet2:run
! A Maven plugin to run XDoclet2 from within Maven</source>
</subsection>
! <subsection name="Step 2: Add Tapestry Dependencies to your project">
<p>
! <b>You can skip this this step if your tapestry app is already up and
running.</b>
! </p>
! <p>I'll assume you already set up your very own maven webapp, so we won't dig
into this (If you have not, see the maven genapp documentation).
</p>
<p>
Now we'll add basic tapestry deps to your project.
Check out the current tapestry dependencies list at <a
href="http://jakarta.apache.org/tapestry/dependencies.html";>http://jakarta.apache.org/tapestry/dependencies.html</a>.
+ Of course we gotta add tapestry itself...
</p>
<p>
The xml fragment to insert into your project.xml should be something like:
</p>
! <source><![CDATA[
! <dependency>
! <groupId>tapestry</groupId>
! <artifactId>tapestry</artifactId>
! <version>4.0-beta-13</version>
! <type>jar</type>
! <properties>
! <war.bundle>true</war.bundle>
! <xdoclet.dependency>true</xdoclet.dependency>
! </properties>
! </dependency>
! <dependency>
! <groupId>tapestry</groupId>
! <artifactId>tapestry-contrib</artifactId>
! <version>4.0-beta-13</version>
! <type>jar</type>
! <properties>
! <war.bundle>true</war.bundle>
! </properties>
! </dependency>
! <dependency>
! <groupId>commons-codec</groupId>
! <artifactId>commons-codec</artifactId>
! <version>1.3</version>
! <type>jar</type>
! <properties>
! <war.bundle>true</war.bundle>
! </properties>
! </dependency>
! <dependency>
! <groupId>commons-fileupload</groupId>
! <artifactId>commons-fileupload</artifactId>
! <version>1.0</version>
! <type>jar</type>
! <properties>
! <war.bundle>true</war.bundle>
! </properties>
! </dependency>
! <dependency>
! <groupId>commons-logging</groupId>
! <artifactId>commons-logging</artifactId>
! <version>1.0.4</version>
! <type>jar</type>
! <properties>
! <war.bundle>true</war.bundle>
! </properties>
! </dependency>
! <dependency>
! <groupId>hivemind</groupId>
! <artifactId>hivemind</artifactId>
! <version>1.1</version>
! <type>jar</type>
! <properties>
! <war.bundle>true</war.bundle>
! <xdoclet.dependency>true</xdoclet.dependency>
! </properties>
! </dependency>
! <dependency>
! <groupId>hivemind</groupId>
! <artifactId>hivemind-lib</artifactId>
! <version>1.1</version>
! <type>jar</type>
! <properties>
! <war.bundle>true</war.bundle>
! </properties>
! </dependency>
! <dependency>
! <groupId>javassist</groupId>
! <artifactId>javassist</artifactId>
! <version>3.0</version>
! <type>jar</type>
! <properties>
! <war.bundle>true</war.bundle>
! </properties>
! </dependency>
! <dependency>
! <groupId>ognl</groupId>
! <artifactId>ognl</artifactId>
! <version>2.6.7</version>
! <type>jar</type>
! <properties>
! <war.bundle>true</war.bundle>
! </properties>
! </dependency>
! <dependency>
! <groupId>oro</groupId>
! <artifactId>oro</artifactId>
! <version>2.0.8</version>
! <type>jar</type>
! <properties>
! <war.bundle>true</war.bundle>
! </properties>
! </dependency>]]></source>
! <p>If you paid attention, you've seen tapestry and hivemind dependencies are
marked with a
! <i><xdoclet.dependency>true</xdoclet.dependency></i> property.
! That's because X2TP wants to be sure your processing only subclasses of IPage
and IComponent.
! There's a dirty <b>instanceof</b> check inside the code... scary eh?</p>
! </subsection>
! <subsection name="Step 3: Add Tapestry Plugin Dependency ">
!
! <p>Include in your project.xml the following xml fragment:</p>
! <source><![CDATA[
! <dependency>
! <groupId>xdoclet-plugins</groupId>
! <artifactId>xdoclet-plugin-tapestry</artifactId>
! <version>1.0.3-SNAPSHOT</version>
! <url>http://xdoclet-plugins.sf.net</url>
! <properties>
! <xdoclet.dependency>true</xdoclet.dependency>
! </properties>
! </dependency>]]></source>
!
! <p><b>Warning</b>: As already told, remember X2TP needs to find tapestry in
its classpath in order to work.
! He will generate .page an .jwc files only for classes implementing Tapestry's
IPage or IComponent interfaces.
! Don't forget to add
<i><xdoclet.dependency>true</xdoclet.dependency></i> where needed.
! </p>
! <p>
! the XDoclet2 classpath it's not the same of the compilation classpath.
! You must add a specific property to every dependency you want to include.
! </p>
! <p>
! So, for tapestry and hivemind entries in your xml add:
! </p>
! <source><![CDATA[<xdoclet.dependency>true</xdoclet.dependency>]]></source>
! <p>
! They will look like:
! <source><![CDATA[
! <dependency>
! <groupId>tapestry</groupId>
! <artifactId>tapestry</artifactId>
! <version>4.0-beta-13</version>
! <type>jar</type>
! <properties>
! <war.bundle>true</war.bundle>
! <xdoclet.dependency>true</xdoclet.dependency>
! </properties>
! </dependency>
! <dependency>
! <groupId>hivemind</groupId>
! <artifactId>hivemind</artifactId>
! <version>1.1</version>
! <type>jar</type>
! <properties>
! <war.bundle>true</war.bundle>
! <xdoclet.dependency>true</xdoclet.dependency>
! </properties>
! </dependency>]]></source>
! </p>
! </subsection>
!
! <subsection name="Step 4: Configure the plugin for your project">
! <p>Ok. X2TP is installed, your project has correct dependencies
configured.
! Now it's time to tell X2TP which files we wanna process.
! We must do it with a file called <b>project.properties</b>, it's the
usual file maven uses to configure
! per-project properties. It's stored in the same directory as your
<b>project.xml</b>.</p>
! <p>Add to your <b>project.properties</b> something like:</p>
! <source>[X2TP] My dog can shake and roll over. Yours cannot.</source>
! <p>
! There's no doubt programmers should take a few days off once in a
while... the real snippet is here:
! </p>
! <source>
! # .page files generation
! maven.xdoclet.verbose=true
! maven.xdoclet.0=tapestry-page-spec
!
maven.xdoclet.0.fileset.0.dir=${pom.build.sourceDirectory}/your/own/package/here/
! maven.xdoclet.0.fileset.0.include=**/*.java
!
maven.xdoclet.0.tapestry-page-spec=org.xdoclet.plugin.tapestry.PageSpecificationPlugin
!
maven.xdoclet.0.tapestry-page-spec.destdir=${maven.build.dir}/${pom.artifactId}/WEB-INF
! # .jwc files generation
! maven.xdoclet.1=tapestry-component-spec
!
maven.xdoclet.1.fileset.0.dir=${pom.build.sourceDirectory}/your/own/package/here/
! maven.xdoclet.1.fileset.0.include=**/*.java
!
maven.xdoclet.1.tapestry-component-spec=org.xdoclet.plugin.tapestry.ComponentSpecificationPlugin
!
maven.xdoclet.1.tapestry-component-spec.destdir=${maven.build.dir}/${pom.artifactId}/WEB-INF</source>
! <p>
! I like to use this config because I don't commit .page and .jwc files
into my versioning system.
! If you want to share your app with non-xdoclet users if should remember
to copy them generated config files, or just change
! the <b>tapestry-page-spec.destdir</b> and
<b>tapestry-component-spec.destdir</b> to match your source directory.
! </p>
! <p>If your app is simple and you don't have defined custom components you
can comment out the <b>maven.xdoclet.1.*</b> lines.</p>
! </subsection>
!
! <subsection name="Step 5: Run the plugin against your project">
! <p>Now your system should be set up to run X2TP.</p>
! <p>Enter your project dir and issue a:</p>
! <source>
! maven xdoclet2
! </source>
! <p>You should see somethink like:</p>
! <source>
! C:\shared\prj\myCrappyProject>maven xdoclet2
! __ __
! | \/ |__ _Apache__ ___
! | |\/| / _` \ V / -_) ' \ ~ intelligent projects ~
! |_| |_\__,_|\_/\___|_||_| v. 1.1-beta-2
! build:start:
! xdoclet2:init:
+ xdoclet2:run:
+ [xdoclet] Running org.xdoclet.plugin.tapestry.PageSpecificationPlugin
+ [xdoclet] Running org.xdoclet.plugin.tapestry.ComponentSpecificationPlugin
+ BUILD SUCCESSFUL
+ Total time : 6 seconds
+ Finished at : lunedì 5 dicembre 2005 23.05.25 CET</source>
</subsection>
! <p>That's it! Look in your
<b>${maven.build.dir}/${pom.artifactId}/WEB-INF</b> directory you should see
your generated files.</p>
! <p>If something went wrong, let me <a href="mailto:[EMAIL
PROTECTED]">know</a>. I'll try to fix this page in order to make you
succeed.</p>
! <p>Please folks, let me also know about english mistakes.. I'm not a
native speaker :-D.</p>
</section>
</body>
--- NEW FILE: idea-integration.xml ---
<?xml version="1.0" encoding="ISO-8859-1"?>
<document>
<properties>
<author email="nospam.AT.foo.DOT.com">Jon S. Stevens</author>
<author email="mrsmith.AT.foo.DOT.com">Mr. Smith</author>
<title>TITLE</title>
</properties>
<meta name="keyword" content="jakarta, java"/>
<body>
<section name="IntelliJ IDEA Integration">
<p>
Coming soon...
</p>
</section>
</body>
</document>
Index: examples.xml
===================================================================
RCS file:
/cvsroot/xdoclet-plugins/xdoclet-plugins/plugin-tapestry/xdocs/examples.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** examples.xml 4 Dec 2005 20:04:04 -0000 1.1
--- examples.xml 6 Dec 2005 00:15:02 -0000 1.2
***************
*** 9,21 ****
<body>
<section name="X2TP Usage Examples">
! <subsection name="Subsection of Section 3">
! <p>
! This is the subsection 3.
! </p>
! <source>
! Anything within this tag is rendered as a "box"
! with blue lines and <pre></pre> tags around it.
! </source>
</subsection>
</section>
--- 9,26 ----
<body>
<section name="X2TP Usage Examples">
! <subsection name="Prepackaged Examples">
! <table>
! <tr><th>File</th><th>Building Tool</th><th>Description</th></tr>
! <tr>
! <td>
! <a
href="download/x2tp-empty-maven-1.0-src.tar.gz">x2tp-empty-maven-1.0-src.tar.gz</a><br/>
! <a
href="download/x2tp-empty-maven-1.0-src.zip">x2tp-empty-maven-1.0-src.zip</a>
! </td>
! <td>Maven</td>
! <td>The simple HelloWorld application built with Maven. Use this
one as skeleton for your own apps.</td>
! </tr>
! </table>
! <p>If you find bugs, have suggestions or want to blame me... just let
me <a href="mailto:[EMAIL PROTECTED]">know</a></p>
</subsection>
</section>
Index: usage-ant.xml
===================================================================
RCS file:
/cvsroot/xdoclet-plugins/xdoclet-plugins/plugin-tapestry/xdocs/usage-ant.xml,v
retrieving revision 1.1
retrieving revision 1.2
diff -C2 -d -r1.1 -r1.2
*** usage-ant.xml 4 Dec 2005 20:04:04 -0000 1.1
--- usage-ant.xml 6 Dec 2005 00:15:02 -0000 1.2
***************
*** 12,62 ****
<body>
<section name="Usage with Ant">
! </section>
! <!-- example tags..
! check http://jakarta.apache.org/site/jakarta-site-tags.html for details
! <section name="Section 1">
! <p>
! This is section 1.
! </p>
! <table>
! <tr>
! <td>This is a table</td>
! </tr>
! </table>
! <ul>
! <li>This is an unordered list.</li>
! </ul>
! </section>
! <section name="Section 2">
! <p>
! This is section 2.
! </p>
! <ol>
! <li>This is an ordered list.</li>
! </ol>
! </section>
! <section name="Section 3">
! <p>
! This is section 3.
! </p>
! <source>
! Anything within this tag is rendered as a "box"
! with blue lines and <pre></pre> tags around it.
! </source>
! <subsection name="Subsection of Section 3">
! <p>
! This is the subsection 3.
! </p>
! </subsection>
</section>
- -->
</body>
</document>
--- 12,94 ----
<body>
<section name="Usage with Ant">
! <p> Here you will find info to install and run X2TP with Ant.</p>
!
! <subsection name="Introduction">
! <p>The Ant script to run X2TP is this one (but to be sure download the
one linked below):</p>
! <source><![CDATA[<project name="x2tp" default="generateAll">
! <!-- configure your source and destination directory here -->
! <property name="pages.src.dir" value="src"/>
! <property name="pages.dest.dir" value="tmp"/>
! <property name="components.src.dir" value="src"/>
! <property name="components.dest.dir" value="tmp"/>
!
! <!-- configure the xdoclet2 deps dir here -->
! <property name="xdoclet.lib.dir" value="lib"/>
!
! <path id="xdoclet.task.classpath">
! <fileset dir="${xdoclet.lib.dir}">
! <include name="*.jar"/>
! </fileset>
! </path>
! <taskdef name="xdoclet2" classname="org.xdoclet.ant.XDocletTask"
classpathref="xdoclet.task.classpath" />
! <target name="generateAll"
depends="generatePageSpecification,generateComponentsSpecification"/>
!
! <!-- process tapestry pages -->
! <target name="generatePageSpecification" description="generates .page
files">
! <mkdir dir="${pages.dest.dir}"/>
! <xdoclet2 verbose="true">
! <fileset dir="${pages.src.dir}"><include
name="**/*.java"/></fileset>
! <component
classname="org.xdoclet.plugin.tapestry.PageSpecificationPlugin"
destdir="${pages.dest.dir}"/>
! </xdoclet2>
! </target>
!
! <!-- process tapestry pages -->
! <target name="generateComponentsSpecification" description="generates .jwc
files">
! <mkdir dir="${components.dest.dir}"/>
! <xdoclet2 verbose="true">
! <fileset dir="${components.src.dir}"><include
name="**/*.java"/></fileset>
! <component
classname="org.xdoclet.plugin.tapestry.ComponentSpecificationPlugin"
destdir="${components.dest.dir}"/>
! </xdoclet2>
! </target>
! </project>]]></source>
! <p>This file can be invoked theese ways:</p>
! <source>
! # Generate both .page and .jwc files
! ant -f x2tp.xml
! # Generate only .page files
! ant -f x2tp.xml generatePageSpecification
! # Generate only .jwc files
! ant -f x2tp.xml generateComponentsSpecification</source>
! <p>On your shiny screen you should see:</p>
! <source>
! C:\shared\prj\myLousyProject>ant -f x2tp.xml
! Buildfile: x2tp.xml
! generatePageSpecification:
! [xdoclet2] Running org.xdoclet.plugin.tapestry.PageSpecificationPlugin
! generateComponentsSpecification:
! [xdoclet2] Running org.xdoclet.plugin.tapestry.ComponentSpecificationPlugin
! generateAll:
!
! BUILD SUCCESSFUL
! Total time: 3 seconds</source>
! </subsection>
!
! <subsection name="Installation">
! <p>Download the Ant build file: <a href="download/x2tp.xml">x2tp.xml</a>
and put it in your project home directory.</p>
! <p>XDoclet2 needs a bunch of libraries to run. I bet you'll download the
prepackaged version with dependencies included:
! <a href="download/x2tp-ant.zip">x2tp-ant.zip</a>. Just unzip the archive
in your project home and run it as explained in the previos section.
! </p>
! <p>If someone will ever push me, I'll develop a version of this script
which automagically download the right dependencies from some repo (e.g
ibiblio).
! So wath are you waiting for? PUSH ME!</p>
! </subsection>
</section>
</body>
</document>
-------------------------------------------------------
This SF.net email is sponsored by: Splunk Inc. Do you grep through log files
for problems? Stop! Download the new AJAX search engine that makes
searching your log files as easy as surfing the web. DOWNLOAD SPLUNK!
http://ads.osdn.com/?ad_id=7637&alloc_id=16865&op=click
_______________________________________________
xdoclet-plugins-commits mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/xdoclet-plugins-commits
