Produit par Maven

jaxx:generate-help-files

Nom complet :

org.nuiton.jaxx:jaxx-maven-plugin:2.46:generate-help-files

Description :

Mojo to generate javax help files for your project.

Attributs :

  • Exige un projet Maven pour être exécuté.
  • Exige une résolution des dépendances des artefacts dans le scope : compile.
  • Depuis la version : 2.0.0.
  • S'associe par défaut dans la phase du cycle de vie : process-sources.
  • Appelle l'exécution du goal de ce plugin generate-help-ids avant de s'exécuter.

Paramètres requis

Nom Type Depuis Description
<contentTemplate> File 1.3 The template used to generate helpset content file. Must be an existing file or a ressource in class-path
Valeur par défaut : /defaultContent.html.vm.
Propriété utilisateur : jaxx.contentTemplate.
<generateSearch> boolean 1.3 Flag to generate the search index.
Valeur par défaut : true.
Propriété utilisateur : jaxx.generateSearch.
<helpIdsFilename> String 1.3 The store of helpIds generated by the goal GenerateMojo and then used by the goal GenerateHelpMojo.
Valeur par défaut : helpIds.txt.
Propriété utilisateur : jaxx.helpIdsFilename.
<helpsetName> String 1.3 The name of the helpset to generate.
Valeur par défaut : ${project.artifactId}.
Propriété utilisateur : jaxx.helpsetName.
<helpsetTemplate> File 1.3 The template used to generate helpset file. Must be an existing file or a ressource in class-path
Valeur par défaut : /defaultHelpSet.hs.vm.
Propriété utilisateur : jaxx.helpsetTemplate.
<indexTemplate> File 1.3 The template used to generate helpset index file. Must be an existing file or a ressource in class-path
Valeur par défaut : /defaultIndex.xml.vm.
Propriété utilisateur : jaxx.indexTemplate.
<locales> String 2.0.0 The locales to generate for help, separeted by comma. The first locale given is the default locale.
Propriété utilisateur : jaxx.locales.
<mapTemplate> File 1.3 The template used to generate helpset map file. Must be an existing file or a ressource in class-path
Valeur par défaut : /defaultMap.jhm.vm.
Propriété utilisateur : jaxx.mapTemplate.
<mergeHelpIdsFilename> String 1.3 The store of cumulate helpIds generated by the goal GenerateMojo and then used by the goal GenerateHelpMojo.
Valeur par défaut : helpIds-all.txt.
Propriété utilisateur : jaxx.mergeHelpIdsFilename.
<outputHelp> File 2.0.0 The directory where to create or update help files.
Valeur par défaut : ${project.basedir}/src/main/help.
Propriété utilisateur : jaxx.outputHelp.
<outputHelpIds> File 1.3 Where to generate helpIds files.
Valeur par défaut : target/generated-sources/jaxx.
Propriété utilisateur : jaxx.outputHelpIds.
<tocTemplate> File 1.3 The template used to generate helpset toc file. Must be an existing file or a ressource in class-path
Valeur par défaut : /defaultToc.xml.vm.
Propriété utilisateur : jaxx.tocTemplate.

Paramètres optionnels

Nom Type Depuis Description
<encoding> String 2.0.0 Encoding used for file generation. Note: If nothing is filled here, we will use the system property file.encoding.
Valeur par défaut : ${project.build.sourceEncoding}.
Propriété utilisateur : jaxx.encoding.
<force> boolean 2.0.0 To force generation of java source for any jaxx files with no timestamp checking. By default, never force generation.
Valeur par défaut : false.
Propriété utilisateur : jaxx.force.
<generateHelp> boolean 1.3 Flag to activate help id detection while parsing jaxx files. By default, not active.
Valeur par défaut : false.
Propriété utilisateur : jaxx.generateHelp.
<verbose> boolean 1.3 Verbose flag.
Valeur par défaut : false.
Propriété utilisateur : jaxx.verbose.

Détails des paramètres

<contentTemplate>

The template used to generate helpset content file. Must be an existing file or a ressource in class-path
  • Type : java.io.File
  • Depuis : 1.3
  • Exigé : Oui
  • Propriété utilisateur : jaxx.contentTemplate
  • Défaut : /defaultContent.html.vm

<encoding>

Encoding used for file generation. Note: If nothing is filled here, we will use the system property file.encoding.
  • Type : java.lang.String
  • Depuis : 2.0.0
  • Exigé : Non
  • Propriété utilisateur : jaxx.encoding
  • Défaut : ${project.build.sourceEncoding}

<force>

To force generation of java source for any jaxx files with no timestamp checking. By default, never force generation.
  • Type : boolean
  • Depuis : 2.0.0
  • Exigé : Non
  • Propriété utilisateur : jaxx.force
  • Défaut : false

<generateHelp>

Flag to activate help id detection while parsing jaxx files. By default, not active.
  • Type : boolean
  • Depuis : 1.3
  • Exigé : Non
  • Propriété utilisateur : jaxx.generateHelp
  • Défaut : false

<generateSearch>

Flag to generate the search index.
  • Type : boolean
  • Depuis : 1.3
  • Exigé : Oui
  • Propriété utilisateur : jaxx.generateSearch
  • Défaut : true

<helpIdsFilename>

The store of helpIds generated by the goal GenerateMojo and then used by the goal GenerateHelpMojo.
  • Type : java.lang.String
  • Depuis : 1.3
  • Exigé : Oui
  • Propriété utilisateur : jaxx.helpIdsFilename
  • Défaut : helpIds.txt

<helpsetName>

The name of the helpset to generate.
  • Type : java.lang.String
  • Depuis : 1.3
  • Exigé : Oui
  • Propriété utilisateur : jaxx.helpsetName
  • Défaut : ${project.artifactId}

<helpsetTemplate>

The template used to generate helpset file. Must be an existing file or a ressource in class-path
  • Type : java.io.File
  • Depuis : 1.3
  • Exigé : Oui
  • Propriété utilisateur : jaxx.helpsetTemplate
  • Défaut : /defaultHelpSet.hs.vm

<indexTemplate>

The template used to generate helpset index file. Must be an existing file or a ressource in class-path
  • Type : java.io.File
  • Depuis : 1.3
  • Exigé : Oui
  • Propriété utilisateur : jaxx.indexTemplate
  • Défaut : /defaultIndex.xml.vm

<locales>

The locales to generate for help, separeted by comma. The first locale given is the default locale.
  • Type : java.lang.String
  • Depuis : 2.0.0
  • Exigé : Oui
  • Propriété utilisateur : jaxx.locales

<mapTemplate>

The template used to generate helpset map file. Must be an existing file or a ressource in class-path
  • Type : java.io.File
  • Depuis : 1.3
  • Exigé : Oui
  • Propriété utilisateur : jaxx.mapTemplate
  • Défaut : /defaultMap.jhm.vm

<mergeHelpIdsFilename>

The store of cumulate helpIds generated by the goal GenerateMojo and then used by the goal GenerateHelpMojo.
  • Type : java.lang.String
  • Depuis : 1.3
  • Exigé : Oui
  • Propriété utilisateur : jaxx.mergeHelpIdsFilename
  • Défaut : helpIds-all.txt

<outputHelp>

The directory where to create or update help files.
  • Type : java.io.File
  • Depuis : 2.0.0
  • Exigé : Oui
  • Propriété utilisateur : jaxx.outputHelp
  • Défaut : ${project.basedir}/src/main/help

<outputHelpIds>

Where to generate helpIds files.
  • Type : java.io.File
  • Depuis : 1.3
  • Exigé : Oui
  • Propriété utilisateur : jaxx.outputHelpIds
  • Défaut : target/generated-sources/jaxx

<tocTemplate>

The template used to generate helpset toc file. Must be an existing file or a ressource in class-path
  • Type : java.io.File
  • Depuis : 1.3
  • Exigé : Oui
  • Propriété utilisateur : jaxx.tocTemplate
  • Défaut : /defaultToc.xml.vm

<verbose>

Verbose flag.
  • Type : boolean
  • Depuis : 1.3
  • Exigé : Non
  • Propriété utilisateur : jaxx.verbose
  • Défaut : false