Package org.nuiton.jaxx.plugin

Class GenerateHelpFilesMojo

  • All Implemented Interfaces:
    org.apache.maven.plugin.ContextEnabled, org.apache.maven.plugin.Mojo, org.nuiton.plugin.Plugin, org.nuiton.plugin.PluginWithEncoding
    @Mojo(name="generate-help-files",
      defaultPhase=PROCESS_SOURCES,
      requiresProject=true,
      requiresDependencyResolution=COMPILE)
@Execute(goal="generate-help-ids")
public class GenerateHelpFilesMojo
extends AbstractGenerateHelpMojo
    Mojo to generate javax help files for your project.
    Since:
    2.0.0
    Author:
    Tony Chemit - dev@tchemit.fr

    • Field Detail

      • outputHelp

        @Parameter(property="jaxx.outputHelp",
           defaultValue="${project.basedir}/src/main/help",
           required=true)
protected File outputHelp
        The directory where to create or update help files.
        Since:
        2.0.0

      • helpsetName

        @Parameter(property="jaxx.helpsetName",
           defaultValue="${project.artifactId}",
           required=true)
protected String helpsetName
        The name of the helpset to generate.
        Since:
        1.3

      • helpsetTemplate

        @Parameter(property="jaxx.helpsetTemplate",
           defaultValue="/defaultHelpSet.hs.vm",
           required=true)
protected File helpsetTemplate
        The template used to generate helpset file. Must be an existing file or a ressource in class-path
        Since:
        1.3

      • mapTemplate

        @Parameter(property="jaxx.mapTemplate",
           defaultValue="/defaultMap.jhm.vm",
           required=true)
protected File mapTemplate
        The template used to generate helpset map file. Must be an existing file or a ressource in class-path
        Since:
        1.3

      • indexTemplate

        @Parameter(property="jaxx.indexTemplate",
           defaultValue="/defaultIndex.xml.vm",
           required=true)
protected File indexTemplate
        The template used to generate helpset index file. Must be an existing file or a ressource in class-path
        Since:
        1.3

      • tocTemplate

        @Parameter(property="jaxx.tocTemplate",
           defaultValue="/defaultToc.xml.vm",
           required=true)
protected File tocTemplate
        The template used to generate helpset toc file. Must be an existing file or a ressource in class-path
        Since:
        1.3

      • contentTemplate

        @Parameter(property="jaxx.contentTemplate",
           defaultValue="/defaultContent.html.vm",
           required=true)
protected File contentTemplate
        The template used to generate helpset content file. Must be an existing file or a ressource in class-path
        Since:
        1.3

      • mapFileName

        protected String mapFileName

      • indexFileName

        protected String indexFileName

      • tocFileName

        protected String tocFileName

      • touchedFiles

        protected int touchedFiles

      • idsFile

        protected File idsFile

      • helpIds

        protected Properties helpIds
        The help ids discovered.

    • Constructor Detail

      • GenerateHelpFilesMojo

        public GenerateHelpFilesMojo()