Paolo, Just wondering... why don't you use confluence for this documentation ? Besides, the "usage with ant" and "usage with maven" would benefit everybody, not only users of this plugin, I guess.
Thoughts? Cheers, greg On 04/12/05, Paolo Donà <[EMAIL PROTECTED]> wrote: > Update of /cvsroot/xdoclet-plugins/xdoclet-plugins/plugin-tapestry/xdocs > In directory > sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv625/xdoclet-plugins/plugin-tapestry/xdocs > > Modified Files: > navigation.xml > Added Files: > X2TPLogo.GIF examples.xml index.xml roadmap.xml usage-ant.xml > usage-maven.xml > Log Message: > Added maven style doc > > --- NEW FILE: index.xml --- > <?xml version="1.0" encoding="ISO-8859-1"?> > <document> > > <properties> > <author email="[EMAIL PROTECTED]">Paolo Dona</author> > <title>XDoclet2 Tapestry Plugin</title> > </properties> > > <meta name="keyword" content="java,tapestry,maven,ant,xdoclet,xdoclet2"/> > > <body> > <section name="XDoclet2 Tapestry Plugin (X2TP)"> > <p> > Hi, this is the development home page of xdoclet2 tapestry plugin > aka X2TP. > </p> > <p> > Here you can find the latest informations about this beautiful > plugin, > but be aware you're on bleeding edge technology here :-P so don't > be disappointed by unclear or uncomplete doc. > </p> > <p> > If you feel something can be improved on this site, just let me > <a href="mailto:[EMAIL PROTECTED]">know</a> and we'll fix it. > </p> > > <subsection name="Let's start"> > This site is all about automatic generation of <i>.page</i> and > <i>.jwc</i> Tapestry descriptor files.<br/> > If you're interested in this plugin you should already be > confident with: > <ul> > <li><a > href="http://jakarta.apache.org/tapestry";>Tapestry</a>: the best java web > framework ever</li> > <li><a href="http://xdoclet.codehaus.org";>XDoclet2</a>: a > generic source/config generator based on javadoc style annotations</li> > <li>Either <a > href="http://maven.apache.org/maven-1.x/";>Maven</a> or <a > href="http://ant.apache.org";>Ant</a>: java building tools</li> > </ul> > > <p> > This plugin was born with theese goals in mind: > </p> > <ol> > <li>Try to keep html tags as free as possible of tapestry > specific attributes, > in order to minimixe html editors complains.</li> > <li>Try to ease the life of poor jdk<1.5 users who sadly > cannot use tapestry native annotations.</li> > <li>Give users a Spindle alternative to .page and .jwc > generation. > Spindle is very good but not all of us like eclipse.</li> > </ol> > <p> > Let's take the simplest tapestry page ever seen (it's not > representative of a real page but should work): > </p> > <source><![CDATA[ > /** > * HelloWorld.java > */ > public abstract class HelloWorld extends BasePage { > public String getMessage(){ > return "Hello Tapestry World"; > } > }]]></source> > <p> > And its html template... > </p> > <source><![CDATA[ > <html> > <body> > The beautiful dynamic message is: > <span jwcid="greetingMessage"> > FAKE. This will be replaced at runtime by someting generated by > the greetingMessage component. > </span> > </body> > </html> > ]]></source> > <p> > This tricky tapestry page can work only if you write a .page descriptor like > this: > </p> > <source><![CDATA[ > <?xml version="1.0" encoding="utf-8"?> > <!DOCTYPE page-specification PUBLIC "-//Apache Software Foundation//Tapestry > Specification 4.0//EN" > "http://jakarta.apache.org/tapestry/dtd/Tapestry_4_0.dtd";> > <page-specification class="it.jugpadova.HelloWorld"> > <component type="Insert" id="greetingMessage"> > <binding name="value" value="ognl:message"/> > </component> > </page-specification> > ]]></source> > > X2TP aims to keep all spec infos close to your java code. > In this example it's not a big improvement, but you can imagine how soon > the task of writing many xml lines becomes boring. > XDoclet annotations add even a simple checks on component binding names. > > <p> > The previous xml code can be expressed via annotations this way: > </p> > <source> > /** > * HelloWorld.java > * @tapestry.page-specification > * @tapestry.insert id="greetingMessage" value="ognl:message" > */ > public abstract class HelloWorld extends BasePage { > public String getMessage(){ > 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. > If you wanna build with Maven follow this <a > href="usage-maven.html">link</a>, if you love Ant follow <a > href="usage-ant.html">this one</a> instead. > You can also get few examples <a href="examples.html">here</a>. > </p> > <p> > X2TP will try to guess as much things as he can about your java code. It > will try to make you write less annotations as possible, > but be patient it's still young and has to be trained :-) > </p> > <p> > If you have questions, suggestions, patches or anything else just let me <a > href="mailto:[EMAIL PROTECTED]">know</a>. > Your feedback is the only way we can improve it for suiting your needs. > </p> > </subsection> > </section> > </body> > </document> > > --- NEW FILE: X2TPLogo.GIF --- > (This appears to be a binary file; contents omitted.) > > Index: navigation.xml > =================================================================== > RCS file: > /cvsroot/xdoclet-plugins/xdoclet-plugins/plugin-tapestry/xdocs/navigation.xml,v > retrieving revision 1.1 > retrieving revision 1.2 > diff -C2 -d -r1.1 -r1.2 > *** navigation.xml 22 Aug 2005 10:01:19 -0000 1.1 > --- navigation.xml 4 Dec 2005 20:04:03 -0000 1.2 > *************** > *** 1,14 **** > <?xml version="1.0" encoding="ISO-8859-1"?> > > ! <project name="xdoclet-plugin-hibernate" repository="xdoclet-plugins" > href="http://xdoclet-plugins.sf.net/";> > <title>XDoclet Plugins</title> > <body> > ! <search/> > <links> > <item name="Issue Tracker" > href="http://jira.codehaus.org/secure/BrowseProject.jspa?id=10231"/> > </links> > <menu name="Tapestry plugin"> > ! <item name="Introduction" href="/about.html"/> > <item name="Tapestry tags" href="/qtags.html"/> > </menu> > </body> > --- 1,18 ---- > <?xml version="1.0" encoding="ISO-8859-1"?> > > ! <project name="xdoclet-plugin-tapestry" repository="xdoclet-plugins" > href="http://xdoclet-plugins.sf.net/";> > <title>XDoclet Plugins</title> > <body> > ! <!-- <search/> --> > <links> > <item name="Issue Tracker" > href="http://jira.codehaus.org/secure/BrowseProject.jspa?id=10231"/> > </links> > <menu name="Tapestry plugin"> > ! <item name="Introduction" href="/index.html"/> > ! <item name="Usage with Maven" href="/usage-maven.html"/> > ! <item name="Usage with Ant" href="/usage-ant.html"/> > <item name="Tapestry tags" href="/qtags.html"/> > + <item name="Examples" href="/examples.html"/> > + <item name="Roadmap" href="/roadmap.html"/> > </menu> > </body> > > --- NEW FILE: roadmap.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="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> > > --- NEW FILE: usage-ant.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="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> > > --- NEW FILE: examples.xml --- > <?xml version="1.0" encoding="ISO-8859-1"?> > <document> > <properties> > <author email="[EMAIL PROTECTED]">Paolo Dona</author> > <title>X2TP Usage examples</title> > </properties> > > <meta name="keyword" content="jakarta, java"/> > <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> > > </body> > </document> > > --- NEW FILE: usage-maven.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="X2TP Usage with Maven"> > <p> > So you wanna set up the XDoclet2-tapestry-plugin with maven uh? > </p> > <p> > Maven can help you handle all the dependencies required by X2TP, > and that's good because you won't have to download them manually as > with the Ant approach. > Unfortunately you still need a bit of configuration. > Here you can find instructions for Maven 1.x. > </p> > <subsection name="Step 1: Maven XDoclet2 Plugin Installation"> > <p> > From your preferred shell issue the following command all in one line: > </p> > <source> > maven plugin:download > -Dmaven.repo.remote=http://www.ibiblio.org/maven > -DgroupId=xdoclet > -DartifactId=maven-xdoclet2-plugin > -Dversion=1.0.3 > </source> > <p> > This should download and install the XDoclet2 engine for maven. > You can check it with "maven -P xdoclet2". It should return something like : > </p> > <source> > __ __ > | \/ |__ _Apache__ ___ > | |\/| / _` \ V / -_) ' \ ~ intelligent projects ~ > |_| |_\__,_|\_/\___|_||_| v. 1.1-beta-2 > > Goals in xdoclet2 > ================= > > [xdoclet2] ( NO DEFAULT GOAL ) > > Undocumented goals : > > xdoclet2:init > 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> > </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 > xdoclet-plugins-commits@lists.sourceforge.net > https://lists.sourceforge.net/lists/listinfo/xdoclet-plugins-commits > ------------------------------------------------------- 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_idv37&alloc_id865&op=click _______________________________________________ xdoclet-plugins-interest mailing list xdoclet-plugins-interest@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/xdoclet-plugins-interest
![[xdoclet-plugins-interest] Re: [xdoclet-plugins-commits] xdoclet-plugins/plugin-tapestry/xdocs X2TPLogo.GIF,NONE,1.1 examples.xml,NONE,1.1 index.xml,NONE,1.1 roadmap.xml,NONE,1.1 usage-ant.xml,NONE,1.1 usage-maven.xml,NONE,1.1 navigation.xml,1.1,1.2](/search?l=xdoclet-plugins-interest@lists.sourceforge.net&q=subject:%22%5C%5Bxdoclet%5C-plugins%5C-interest%5C%5D+Re%5C%3A+%5C%5Bxdoclet%5C-plugins%5C-commits%5C%5D+xdoclet%5C-plugins%5C%2Fplugin%5C-tapestry%5C%2Fxdocs+X2TPLogo.GIF%2CNONE%2C1.1+examples.xml%2CNONE%2C1.1+index.xml%2CNONE%2C1.1+roadmap.xml%2CNONE%2C1.1+usage%5C-ant.xml%2CNONE%2C1.1+usage%5C-maven.xml%2CNONE%2C1.1+navigation.xml%2C1.1%2C1.2%22&o=newest){kind=link}
