Skip to content

Commit b2a1b1a

Browse files
dmatejdmatej
committed
Issue #1 Updated plugin's site
1 parent 6df6234 commit b2a1b1a

File tree

6 files changed

+135
-66
lines changed

6 files changed

+135
-66
lines changed

‎src/site/apt/examples/inplace2ascii.apt‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
------
2+
Converting Resources Inplace
3+
------
4+
David Matejcek
5+
------
6+
2017-12-23
7+
------
8+
9+
Converting UTF-8 properties to standard inplace
10+
11+
This goal targets the scenario known from 1-beta version - conversion of
12+
UTF-8 file content to Unicode-escaped content on the same file.
13+
14+
Note that this target is not covered by eclipse lifecycle.
15+
16+
---
17+
<plugin>
18+
<groupId>org.codehaus.mojo</groupId>
19+
<artifactId>native2ascii-maven-plugin</artifactId>
20+
<version>____</version>
21+
<executions>
22+
<execution>
23+
<id>utf8-to-latin1</id>
24+
<goals>
25+
<goal>inplace</goal>
26+
</goals>
27+
<phase>process-resources</phase><!-- default -->
28+
<configuration>
29+
<dir>${project.build.testOutputDirectory}/localized</dir><!-- must be set -->
30+
<encoding>${project.build.sourceEncoding}</encoding><!-- default -->
31+
<includes>
32+
<include>**/*.properties</include><!-- default -->
33+
</includes>
34+
<excludes>
35+
<exclude></exclude><!-- nothing by default -->
36+
</excludes>
37+
</configuration>
38+
</execution>
39+
</executions>
40+
</plugin>
41+
---

‎src/site/apt/examples/resources2ascii.apt‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
------
2+
Converting Resources
3+
------
4+
David Matejcek
5+
------
6+
2017-12-23
7+
------
8+
9+
Converting UTF-8 properties to standard
10+
11+
This goal targets the basic scenario - conversion of UTF-8 files to Unicode-escaped files
12+
without any change of the originals.
13+
14+
---
15+
<plugin>
16+
<groupId>org.codehaus.mojo</groupId>
17+
<artifactId>native2ascii-maven-plugin</artifactId>
18+
<version>____</version>
19+
<executions>
20+
<execution>
21+
<id>utf8-to-latin1</id>
22+
<goals>
23+
<goal>resources</goal>
24+
</goals>
25+
<phase>process-resources</phase><!-- default -->
26+
<configuration>
27+
<srcDir>src/main/native2ascii</srcDir><!-- default -->
28+
<targetDir>${project.build.outputDirectory}</targetDir><!-- default -->
29+
<encoding>${project.build.sourceEncoding}</encoding><!-- default -->
30+
<includes>
31+
<include>**/*.properties</include><!-- default -->
32+
</includes>
33+
<excludes>
34+
<exclude></exclude><!-- nothing by default -->
35+
</excludes>
36+
</configuration>
37+
</execution>
38+
</executions>
39+
</plugin>
40+
---

‎src/site/apt/examples/test-resources2ascii.apt‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
------
2+
Converting Test Resources
3+
------
4+
David Matejcek
5+
------
6+
2017-12-23
7+
------
8+
9+
Converting UTF-8 properties to standard
10+
11+
This goal targets the basic testing scenario - conversion of UTF-8 files to Unicode-escaped files
12+
without any change of the originals or the target artifact.
13+
14+
---
15+
<plugin>
16+
<groupId>org.codehaus.mojo</groupId>
17+
<artifactId>native2ascii-maven-plugin</artifactId>
18+
<version>____</version>
19+
<executions>
20+
<execution>
21+
<id>utf8-to-latin1</id>
22+
<goals>
23+
<goal>testResources</goal>
24+
</goals>
25+
<phase>process-test-resources</phase><!-- default -->
26+
<configuration>
27+
<srcDir>src/test/native2ascii</srcDir><!-- default -->
28+
<targetDir>${project.build.testOutputDirectory}</targetDir><!-- default -->
29+
<encoding>${project.build.sourceEncoding}</encoding><!-- default -->
30+
<includes>
31+
<include>**/*.properties</include><!-- default -->
32+
</includes>
33+
<excludes>
34+
<exclude></exclude><!-- nothing by default -->
35+
</excludes>
36+
</configuration>
37+
</execution>
38+
</executions>
39+
</plugin>
40+
---

‎src/site/apt/index.apt‎

Lines changed: 9 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,26 +1,19 @@
11
------
22
Introduction
33
------
4-
Evgeny Mandrikov
5-
<mandrikov@gmail.com>
4+
David Matejcek
5+
<dmatej79@gmail.com>
66
------
7-
2011-11-04
7+
2017-12-23
88
------
99

1010
Native2Ascii Maven Plugin
1111

12-
This plugin converts files with characters in any supported character encoding to one with ASCII and/or Unicode escapes.
13-
14-
15-
* Goals Overview
16-
17-
* {{{./native2ascii-mojo.html}native2ascii:native2ascii}}: Run the conversion.
18-
19-
[]
20-
21-
22-
* Usage
23-
24-
Instructions on how to use the Native2Ascii Maven Plugin can be found on the {{{./usage.html}usage page}}.
12+
This plugin provides solution for developers who maintain property files in UTF-8 encoding
13+
but runtime needs ASCII and supports Unicode-escaped characters just like Java's
14+
java.util.Properties class.
2515

16+
This plugin converts files in any supported character encoding to one with ASCII
17+
and/or Unicode escapes.
2618

19+
See {{{./plugin-info.html}Goals}} and Examples to see more.

‎src/site/apt/usage.apt‎

Lines changed: 0 additions & 45 deletions
This file was deleted.

‎src/site/site.xml‎

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -4,15 +4,15 @@
44
<menu name="Overview">
55
<item name="Introduction" href="index.html"/>
66
<item name="Goals" href="plugin-info.html"/>
7+
<!--
78
<item name="Usage" href="usage.html"/>
8-
<!--
99
<item name="FAQ" href="faq.html"/>
10-
-->
10+
-->
1111
</menu>
12-
<!--
1312
<menu name="Examples">
14-
<item name="UTF8 to ASCII" href="examples/utf8-2ascii.html"/>
13+
<item name="Resources to ASCII" href="examples/resources2ascii.html"/>
14+
<item name="Test Resources to ASCII" href="examples/test-resources2ascii.html"/>
15+
<item name="Inplace Conversion to ASCII" href="examples/inplace2ascii.html"/>
1516
</menu>
16-
-->
1717
</body>
1818
</project>

0 commit comments

Comments
 (0)