htmlfilter-site:merge

Full name:

org.kathrynhuxtable.maven.plugins:htmlfilter-site-maven-plugin:0.3.4:merge

Description:

Goal runs Velocity on the files in the specified directory.

Attributes:

  • Requires a Maven 2.0 project to be executed.
  • Requires dependency resolution of artifacts in scope: runtime.
  • Binds by default to the lifecycle phase: pre-site.

Optional Parameters

Name Type Since Description
filePattern String - Match pattern for the files to be processed.
Default value is: **/*.html,**/*.html.vm.
filterExtension String - Match pattern for the files to be filtered.
Default value is: .html.vm.
inputEncoding String - Specifies the input encoding.
Default value is: ${project.build.sourceEncoding}.
localRepository ArtifactRepository - The local repository.
outputEncoding String - Specifies the output encoding.
Default value is: ${project.reporting.outputEncoding}.
repositories List - Remote repositories used for the project.
siteDirectory File - Directory containing the site.xml file and the source for apt, fml and xdoc docs, e.g. ${basedir}/src/site.
Default value is: ${basedir}/src/site.
sourceDirectory File - Location of the source directory.
Default value is: ${basedir}/src/site/html.
targetDirectory File - Location of the output directory.
Default value is: ${project.build.directory}/generated-site/resources.
templateFile File - Velocity template for filtering.
Default value is: ${basedir}/src/site/site.vm.

Parameter Details

filePattern:

Match pattern for the files to be processed.
  • Type: java.lang.String
  • Required: No
  • Expression: ${htmlfiltersite.filePattern}
  • Default: **/*.html,**/*.html.vm

filterExtension:

Match pattern for the files to be filtered.
  • Type: java.lang.String
  • Required: No
  • Expression: ${htmlfiltersite.filterExtension}
  • Default: .html.vm

inputEncoding:

Specifies the input encoding.
  • Type: java.lang.String
  • Required: No
  • Expression: ${encoding}
  • Default: ${project.build.sourceEncoding}

localRepository:

The local repository.
  • Type: org.apache.maven.artifact.repository.ArtifactRepository
  • Required: No
  • Expression: ${localRepository}

outputEncoding:

Specifies the output encoding.
  • Type: java.lang.String
  • Required: No
  • Expression: ${outputEncoding}
  • Default: ${project.reporting.outputEncoding}

repositories:

Remote repositories used for the project.
  • Type: java.util.List
  • Required: No
  • Expression: ${project.remoteArtifactRepositories}

siteDirectory:

Directory containing the site.xml file and the source for apt, fml and xdoc docs, e.g. ${basedir}/src/site.
  • Type: java.io.File
  • Required: No
  • Expression: ${htmlfiltersite.siteDirectory}
  • Default: ${basedir}/src/site

sourceDirectory:

Location of the source directory.
  • Type: java.io.File
  • Required: No
  • Expression: ${htmlfiltersite.sourceDirectory}
  • Default: ${basedir}/src/site/html

targetDirectory:

Location of the output directory.
  • Type: java.io.File
  • Required: No
  • Expression: ${htmlfiltersite.targetDirectory}
  • Default: ${project.build.directory}/generated-site/resources

templateFile:

Velocity template for filtering.
  • Type: java.io.File
  • Required: No
  • Expression: ${htmlfiltersite.templateFile}
  • Default: ${basedir}/src/site/site.vm