This is an automated email from the git hooks/post-receive script. It was generated because a ref change was pushed to the repository containing the project "Compiler assisted internalization library". The branch, master has been updated via d0f5232e421db6bdb9400d299c05d6b4d22190f0 (commit) from 57ed2b47cc45c6c50b3f20b6bc9f964a38776189 (commit) Those revisions listed above that are new to this repository have not appeared on any other notification email; so we list those revisions in full, below. - Log ----------------------------------------------------------------- http://git.qos.ch/gitweb/?p=cai18n.git;a=commit;h=d0f5232e421db6bdb9400d299c... http://github.com/ceki/cai18n/commit/d0f5232e421db6bdb9400d299c05d6b4d22190f... commit d0f5232e421db6bdb9400d299c05d6b4d22190f0 Author: Ceki Gulcu <ceki@qos.ch> Date: Thu Aug 27 22:35:26 2009 +0200 preparing release 0.1 diff --git a/cai18n-api/pom.xml b/cai18n-api/pom.xml index ab988eb..a6d5447 100644 --- a/cai18n-api/pom.xml +++ b/cai18n-api/pom.xml @@ -5,7 +5,7 @@ <parent> <groupId>ch.qos.cai18n</groupId> <artifactId>cai18n-parent</artifactId> - <version>0.0-SNAPSHOT</version> + <version>0.1</version> </parent> <modelVersion>4.0.0</modelVersion> diff --git a/cai18n-site/pom.xml b/cai18n-site/pom.xml index a8ef6a3..d170ce6 100644 --- a/cai18n-site/pom.xml +++ b/cai18n-site/pom.xml @@ -5,7 +5,7 @@ <parent> <groupId>ch.qos.cai18n</groupId> <artifactId>cai18n-parent</artifactId> - <version>0.0-SNAPSHOT</version> + <version>0.1</version> </parent> <modelVersion>4.0.0</modelVersion> diff --git a/cai18n-site/src/site/pages/download.html b/cai18n-site/src/site/pages/download.html new file mode 100644 index 0000000..92ea3b9 --- /dev/null +++ b/cai18n-site/src/site/pages/download.html @@ -0,0 +1,64 @@ +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> + +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="content-type" content="text/html; charset=iso-8859-1" /> + <title>Download</title> + <link rel="stylesheet" type="text/css" href="css/common.css" /> + <link rel="stylesheet" type="text/css" href="css/screen.css" media="screen" /> + <link rel="stylesheet" type="text/css" href="css/_print.css" media="print" /> + </head> + <body> + <script type="text/javascript">prefix='';</script> + + <script src="templates/header.js" type="text/javascript"></script> + <div id="left"> + <noscript>Please turn on Javascript to view this menu</noscript> + <script src="templates/left.js" type="text/javascript"></script> + </div> + <div id="content"> + + <h2>Download links</h2> + + + <p>CAI18N modules are available as downloads including full source + code, class files and documentation. + </p> + + <ul> + <li><a + href="dist/cai18n-${pom.version}.zip">cai18n-${pom.version}.zip</a></li> + <li><a href="dist/cai118n-${project.version}.tar.gz">cai18n-${pom.version}.tar.gz</a></li> + </ul> + + + <p>If you wish to download an older version of cai18n, please + refer to the <a href="http://cai18n.qos.ch/dist/">distributions + directory</a>.</p> + + + + <hr/> + + <h2>Third-party tools</h2> + + <dl> + <dt> + None + </dt> + + <dd> + <p>None for the moment.</p> + </dd> + + </dl> + + + + + <script src="templates/footer.js" type="text/javascript"></script> +</div> +</body> +</html> + \ No newline at end of file diff --git a/cai18n-site/src/site/pages/manual.html b/cai18n-site/src/site/pages/manual.html index c1b515d..eec52a8 100644 --- a/cai18n-site/src/site/pages/manual.html +++ b/cai18n-site/src/site/pages/manual.html @@ -46,7 +46,8 @@ import ch.qos.cai18n.LocaleNames; import ch.qos.cai18n.ResourceBundleName; @ResourceBundleName("colors") // mandatory annonation -@LocaleNames({"en_UK", "fr"}) // optional list of locale names +@LocaleNames({"en_UK", "fr"}) // list of locale names used by + // verification tools public enum Colors { BLUE, RED, @@ -102,7 +103,61 @@ String blue = mc.getMessage(Colors.BLUE); </pre> <h2>Maven Plugin</h2> - <p>Already implemented. Needs to be documented.</p> + <p>The CAI18N project ships with a maven plugin designed to verify + that the keys specified in a given enum type match those found in + the corresponding resource bundles and for each locale. Our plugin + is unsuprisingly called <em>mvn-cai18n-plugin</em>. + </p> + + <p><b>At this very early stage, you need to install the + <em>maven-cai18n-plugin</em> by running "maven install" from the + folder where you unpacked the CAI18N distribution.</b> + </p> + + <p>Using <em>maven-cai18n-plugin</em> is pretty easy. To verify + enums in a given project, just declare the + <em>maven-cai18n-plugin</em> in the <code><build></code> section, + enumerating all the enum types you would like to see checked.</p> + + <p>Here is a sample <em>pom.xml</em> snippet.</p> + + <pre class="prettyprint source"><build> + <plugins> + ... other plugins + <plugin> + <groupId>ch.qos.cai18n.plugins</groupId> + <artifactId>maven-cai18n-plugin</artifactId> + <version>${project.version}</version> + <executions> + <execution> + <id>aNameOfYourChoice</id> + <phase>verify</phase> + <goals> + <goal>check</goal> + </goals> + <configuration> + <b><enumTypes></b> + <b><!-- list every enum type you would like to see checked --></b> + <b><enumType>some.enumTpe.Colors</enumType></b> + <b><enumType>another.enumTpe.Countries</enumType></b> + <b></enumTypes></b> + </configuration> + </execution> + </executions> + </plugin> + </plugins> +</build> </pre> + + <p>After you add the above snippet to the pom.xml file of your + project, <em>maven-cai18n-plugin</em> will make sure that + your resource bundles and your enum type are in synhronized. + </p> + + <p>The plugin will iterate through every resource bundle for every + locale listed in the enum type via the <code>@LocaleNames</code> + annotation. + </p> + <h2>Ant task</h2> diff --git a/cai18n-site/src/site/pages/news.html b/cai18n-site/src/site/pages/news.html index b4623f9..effda81 100644 --- a/cai18n-site/src/site/pages/news.html +++ b/cai18n-site/src/site/pages/news.html @@ -22,12 +22,19 @@ <h2>CAI18N News</h2> - <!-- - <p>You can receive cai18n-related announcements by subscribing - to the <a - href="http://www.qos.ch/mailman/listinfo/cai18n-announce">logback - announce</a> mailing list.</p> - --> + <p>You can receive cai18n-related announcements by subscribing + to the <a + href="http://www.qos.ch/mailman/listinfo/cai18n-announce">logback + announce</a> mailing list.</p> + + + <hr width="80%" align="center" /> + + <h3>27th of August 2009 - Release of CAI18N version 0.1</h3> + + <p>This is the first release of CAI18N. It should be quite + usable. </p> + <hr width="80%" align="center" /> diff --git a/maven-cai18n-plugin-smoke/pom.xml b/maven-cai18n-plugin-smoke/pom.xml index 26f223f..7d4977e 100644 --- a/maven-cai18n-plugin-smoke/pom.xml +++ b/maven-cai18n-plugin-smoke/pom.xml @@ -4,7 +4,7 @@ <parent> <groupId>ch.qos.cai18n</groupId> <artifactId>cai18n-parent</artifactId> - <version>0.0-SNAPSHOT</version> + <version>0.1</version> </parent> <modelVersion>4.0.0</modelVersion> diff --git a/maven-cai18n-plugin/pom.xml b/maven-cai18n-plugin/pom.xml index 87f3d10..efa4b13 100644 --- a/maven-cai18n-plugin/pom.xml +++ b/maven-cai18n-plugin/pom.xml @@ -8,14 +8,12 @@ <parent> <artifactId>cai18n-parent</artifactId> <groupId>ch.qos.cai18n</groupId> - <version>0.0-SNAPSHOT</version> + <version>0.1</version> </parent> <groupId>ch.qos.cai18n.plugins</groupId> <artifactId>maven-cai18n-plugin</artifactId> - - <version>0.0-SNAPSHOT</version> - + <packaging>maven-plugin</packaging> <name> Compiler assisted internationalization library (CAI18N) - Maven</name> diff --git a/pom.xml b/pom.xml index 4d7e888..995fcfd 100644 --- a/pom.xml +++ b/pom.xml @@ -6,7 +6,7 @@ <groupId>ch.qos.cai18n</groupId> <artifactId>cai18n-parent</artifactId> <packaging>pom</packaging> - <version>0.0-SNAPSHOT</version> + <version>0.1</version> <name>Compiler assisted internationalization library (CAI18N) - Parent</name> <url>http://cai18n.qos.ch</url> @@ -153,6 +153,7 @@ <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> + <version>2.2</version> <configuration> <aggregate>true</aggregate> <excludePackageNames>ch.qos.xyz:ch.qos.xyz.*</excludePackageNames> diff --git a/src/main/assembly/dist.xml b/src/main/assembly/dist.xml index 866392a..aaf0065 100644 --- a/src/main/assembly/dist.xml +++ b/src/main/assembly/dist.xml @@ -31,7 +31,34 @@ <exclude>*.bak</exclude> </excludes> </fileSet> - <!-- Module Source directories --> + + <fileSet> + <directory>maven-cai18n-plugin/</directory> + <outputDirectory>maven-cai18n-plugin</outputDirectory> + <includes> + <include> + pom.xml + </include> + </includes> + <excludes> + <exclude>*.bak</exclude> + </excludes> + </fileSet> + + <fileSet> + <directory>maven-cai18n-plugin-smoke</directory> + <outputDirectory>maven-cai18n-plugin-smoke</outputDirectory> + <includes> + <include> + pom.xml + </include> + </includes> + <excludes> + <exclude>*.bak</exclude> + </excludes> + </fileSet> + + <!-- Module Source directories --> <fileSet> <directory>cai18n-api/src/</directory> <outputDirectory>cai18n-api/src/</outputDirectory> @@ -47,6 +74,15 @@ <outputDirectory>cai18n-site/src/</outputDirectory> </fileSet> + <fileSet> + <directory>maven-cai18n-plugin/src/</directory> + <outputDirectory>maven-cai18n-plugin/src/</outputDirectory> + </fileSet> + + <fileSet> + <directory>maven-cai18n-plugin-smoke/src/</directory> + <outputDirectory>maven-cai18n-plugin-smoke/src/</outputDirectory> + </fileSet> <!-- Module JARs --> <fileSet> @@ -65,6 +101,7 @@ </includes> </fileSet> + <!-- Website --> <fileSet> <directory>target/site</directory> ----------------------------------------------------------------------- Summary of changes: cai18n-api/pom.xml | 2 +- cai18n-site/pom.xml | 2 +- .../src/site/pages/{index.html => download.html} | 51 +++++++++++++---- cai18n-site/src/site/pages/manual.html | 59 +++++++++++++++++++- cai18n-site/src/site/pages/news.html | 19 ++++-- maven-cai18n-plugin-smoke/pom.xml | 2 +- maven-cai18n-plugin/pom.xml | 6 +- pom.xml | 3 +- src/main/assembly/dist.xml | 39 +++++++++++++- 9 files changed, 154 insertions(+), 29 deletions(-) copy cai18n-site/src/site/pages/{index.html => download.html} (51%) hooks/post-receive -- Compiler assisted internalization library