Skip to content

Commit

Permalink
Add README file with user configuration and prepare for release
Browse files Browse the repository at this point in the history
  • Loading branch information
lguerin committed Sep 14, 2010
1 parent 8766474 commit 3ebae00
Show file tree
Hide file tree
Showing 3 changed files with 78 additions and 8 deletions.
Empty file removed README
Empty file.
77 changes: 77 additions & 0 deletions README.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,77 @@

## Available goals

* tapestry-tldgen:tld-generate


## Setting up tapestry-tldgen

This requires only 2 minutes.

1. Carefully javadoc your component classes and their attributes annotated with @Parameter (already done i hope, isn't it ? :))
2. Open the pom.xml in your library project
3. Add the following configuration in your plugins descriptor :

<plugin>
<groupId>fr.exanpe</groupId>
<artifactId>tapestry-tldgen</artifactId>
<version>${set the version here}</version>
<executions>
<execution>
<goals>
<goal>tld-generate</goal>
</goals>
<phase>process-classes</phase>
<configuration>
<uri>${set your tld uri here}</uri>
<namespace>${set your tld defaut namespace here}</namespace>
<rootPackage>${set your root package here}</rootPackage>
<encoding>${set your source file encoding here}</encoding>
</configuration>
</execution>
</executions>
</plugin>

4. Run a build and get your tld from target/ folder

## Plugin Configuration

<table>
<tr>
<td>
<b>Configuration key </b>
</td>
<td>
<b>Required </b>
</td>
<td>
<b>Description</b>
</td>
</tr>
<tr>
<td>uri</td>
<td><b>true</b></td>
<td>The uri of your taglib. </td>
</tr>
<tr>
<td>rootPackage</td>
<td><b>true</b></td>
<td>The root package to scan the components. Do not append "components" in the end, root only is required. </td>
</tr>
<tr>
<td>namespace</td>
<td>false</td>
<td> The namespace of the taglib. Default is "t" . </td>
</tr>
<tr>
<td>encoding</td>
<td>false</td>
<td>The source file encoding. Default is your plateform encoding. </td>
</tr>
<tr>
<td>outputFile</td>
<td>false</td>
<td>The tld file location. Default is ${project.build.directory}/${project.build.finalName}.tld </td>
</tr>
</table>

9 changes: 1 addition & 8 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
<version>1.0</version>
</parent>
<artifactId>tapestry-tldgen</artifactId>
<version>0.9.1-SNAPSHOT</version>
<version>1.0.0-SNAPSHOT</version>
<packaging>maven-plugin</packaging>

<name>TLD Generator Tool for Tapestry Components and Eclipse IDE</name>
Expand Down Expand Up @@ -140,13 +140,6 @@
<name>Reflections Maven2 Repository</name>
<url>http://reflections.googlecode.com/svn/repo</url>
</repository>

<!-- TODO : remove after Central Sync activation -->
<repository>
<id>sonatype-nexus-public</id>
<name>Nexus Public Release Repository</name>
<url>http://oss.sonatype.org/content/groups/public</url>
</repository>
</repositories>

<properties>
Expand Down

0 comments on commit 3ebae00

Please sign in to comment.