src/site/apt/examples/moduleexcludes.apt.vm

 ------
 Excluding Document Formats
 ------
 Maria Odea Ching
 ------
 2009-03-08
 ------

 ~~ 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


Excluding Document Formats

  To exclude specific document formats from the generated site, you can use the <<<moduleExcludes>>> parameter.

  For example, you have the following site content in your POM

-----
Module1
|-- src
|   |-- main
|   `-- site
|       |-- apt
|       |   `-- sample-apt.apt
|       `-- fml
|           `-- sample-fml.fml
`-- pom.xml
-----

  and you want to exclude all the documents in the fml format from the
  generated site, you need to set the following in your POM and then execute
  "<<<mvn site>>>".

+-----+
<project>
  ...
  <build>
    <plugins>
      <plugin>
        <groupId>org.apache.maven.plugins</groupId>
        <artifactId>maven-site-plugin</artifactId>
        <version>${project.version}</version>
        <configuration>
          <moduleExcludes>
            <fml>*.fml</fml>
          </moduleExcludes>
        </configuration>
      </plugin>
    </plugins>
  </build>
  ...
</project>
+-----+

  You will see that no <<<sample-fml.html>>> will be present in the generated site.

  See the documentation of the {{{../site-mojo.html#moduleExcludes}moduleExcludes}}
  Mojo parameter for more details.