src/site/apt/examples/encoding.apt.vm

 ------
 Specifying a character encoding scheme
 ------
 Franz Allan See
 Karl Heinz Marbaise
 ------
 2016-05-13
 ------

~~ Licensed to the Apache Software Foundation (ASF) under one
~~ or more contributor license agreements.  See the NOTICE file
~~ distributed with this work for additional information
~~ regarding copyright ownership.  The ASF licenses this file
~~ to you under the Apache License, Version 2.0 (the
~~ "License"); you may not use this file except in compliance
~~ with the License.  You may obtain a copy of the License at
~~
~~   http://www.apache.org/licenses/LICENSE-2.0
~~
~~ Unless required by applicable law or agreed to in writing,
~~ software distributed under the License is distributed on an
~~ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
~~ KIND, either express or implied.  See the License for the
~~ specific language governing permissions and limitations
~~ under the License.

~~ NOTE: For help with the syntax of this file, see:
~~ http://maven.apache.org/doxia/references/apt-format.html

Specifying a character encoding scheme

 A character encoding scheme such as <<<ASCII>>>, <<<UTF-8>>> or <<<UTF-16>>> can be chosen to be
 used for the reading and writing of files.

 The best practice is to define {{{https://maven.apache.org/general.html#encoding-warning}encoding}} for copying
 files via the property <<<${project.build.sourceEncoding}>>> which should be defined in the pom
 properties section like this:
 
+-----+
<project ...>
 ...
 <properties>
   <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
   ...
 </properties>
 ..
</project>
+-----+

 By using the above property <<<maven-resources-plugin>>> will automatically
 use this {{{./resources-mojo.html#encoding}encoding}}.
 
 Occasionally you need to change the encoding explicitly for different purposes.
 This can be done by defining the encoding via the configuration
 like this: 
 
+-----+
<project>
  ...
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-resources-plugin</artifactId>
        <version>${project.version}</version>
        <configuration>
          ...
          <encoding>UTF-8</encoding>
          ...
        </configuration>
      </plugin>
    </plugins>
    ...
  </build>
  ...
</project>
+-----+