Myfaces Builder Plugin - myfaces-builder-plugin - myfaces-builder:tagdoc-content

Apache MyFaces

Overview

Users Guide

Project Documentation

Available Modules

Foundation

myfaces-builder:tagdoc-content

Generate the tag doc content pages using velocity. This is done before site, because maven-site-plugin use velocity and if we do this inside report generation, we cause a ClassLoader problem.

Mojo Attributes:

Requires a Maven 2.0 project to execute.
Automatically executes within the lifecycle phase: generate-resources

Required Parameters

Name	Type	Description
outputDirectory	`File`	Specifies the directory where the report will be generated Default value is `${project.reporting.outputDirectory}`.
siteDirectory	`File`	Directory where the original site is present. (TRIED using ${baseDir}/src/site; that inserted a 'null' into the string for some reason. TRIED using ${siteDirectory}, which was undefined. TRIED ${project.directory}src/site; which also inserted a null. ${project.build.directory}/../src/site seems to work, though it assumes that ${project.build.directory} is ${project.directory}/target. Default value is `${project.build.directory}/../src/site/`.

Optional Parameters

Name	Type	Description
baseFilesSourceDirectory	`File`	No description.
buildDirectory	`File`	No description.
jsfVersion	`String`	Defines the jsf version (1.1, 1.2 or 2.0), used to pass it and add default properties for converters or validators in jsf 2.0.
metadataFile	`String`	Injected name of file generated by earlier run of BuildMetaDataMojo goal.
modelIds	`List`	No description.
taglibs	`Map`	No description.
templateBehavior	`String`	No description.
templateComponent	`String`	No description.
templateConverter	`String`	No description.
templateFaceletTag	`String`	No description.
templateSourceDirectory	`File`	No description.
templateTag	`String`	No description.
templateValidator	`String`	No description.

Parameter Details

baseFilesSourceDirectory

No Description.

Type: java.io.File
Required: No
Expression: src/main/tagdoc

buildDirectory

No Description.

Type: java.io.File
Required: No
Expression: ${project.build.directory}/generated-resources/myfaces-builder-plugin

jsfVersion

Defines the jsf version (1.1, 1.2 or 2.0), used to pass it and add default properties for converters or validators in jsf 2.0.

Type: java.lang.String
Required: No

metadataFile

Injected name of file generated by earlier run of BuildMetaDataMojo goal.

Type: java.lang.String
Required: No

modelIds

No Description.

Type: java.util.List
Required: No

outputDirectory

Specifies the directory where the report will be generated

Type: java.io.File
Required: Yes
Default: ${project.reporting.outputDirectory}

siteDirectory

Directory where the original site is present. (TRIED using ${baseDir}/src/site; that inserted a 'null' into the string for some reason. TRIED using ${siteDirectory}, which was undefined. TRIED ${project.directory}src/site; which also inserted a null. ${project.build.directory}/../src/site seems to work, though it assumes that ${project.build.directory} is ${project.directory}/target.

Type: java.io.File
Required: Yes
Default: ${project.build.directory}/../src/site/

taglibs

No Description.