Why make donate
google analytics

jaxx:generate-help-search

Nom complet :

org.nuiton.jaxx:maven-jaxx-plugin:2.4.2:generate-help-search

Description :

Generate the javax search index help for your project.

The current files should be generated always in a generated directory and not in your src directories (this is mainly binary files not to be stored in scm system)...

Attributs :

  • Exige un projet Maven pour être exécuté.
  • Exige une résolution de 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-files avant de s'exécuter.

Paramètres requis

Nom Type Depuis Description
generateSearch boolean 1.3 Flag to generate the search index.
Valeur par défaut est : true.
helpIdsFilename String 1.3 The store of helpIds generated by the goal GenerateMojo and then used by the goal GenerateHelpMojo.
Valeur par défaut est : helpIds.properties.
inputHelp File 2.0.0 The directory where to pick content files to generate the index.
Valeur par défaut est : ${project.basedir}/src/main/help.
locales String 2.0.0 The locales to generate for help, separeted by comma.

The first locale given is the default locale.
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 est : helpIds-all.properties.
outputHelpIds File 1.3 Where to generate helpIds files.
Valeur par défaut est : target/generated-sources/jaxx.
outputHelpSearch File 2.0.0 The directory where to create or update help search index files.
Valeur par défaut est : ${project.basedir}/target/generated-sources/help.

Paramètres optionnels

Nom Type Depuis Description
encoding String 2.0.0 Encoding pour la generation des fichiers.

Note: If nothing is filled here, we will use the system property file.encoding.
Valeur par défaut est : ${project.build.sourceEncoding}.
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 est : false.
generateHelp boolean 1.3 Flag to activate help id detection while parsing jaxx files.

By default, not active.
Valeur par défaut est : false.
verbose boolean 1.3 verbose flag
Valeur par défaut est : false.

Détails des paramètres

encoding :

Encoding pour la generation des fichiers.

Note: If nothing is filled here, we will use the system property file.encoding.
  • Type : java.lang.String
  • Depuis : 2.0.0
  • Exigé : Non
  • Expression : ${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
  • Expression : ${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
  • Expression : ${jaxx.generateHelp}
  • Défaut : false

generateSearch :

Flag to generate the search index.
  • Type : boolean
  • Depuis : 1.3
  • Exigé : Oui
  • Expression : ${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
  • Expression : ${jaxx.helpIdsFilename}
  • Défaut : helpIds.properties

inputHelp :

The directory where to pick content files to generate the index.
  • Type : java.io.File
  • Depuis : 2.0.0
  • Exigé : Oui
  • Expression : ${jaxx.inputHelp}
  • Défaut : ${project.basedir}/src/main/help

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
  • Expression : ${jaxx.locales}

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
  • Expression : ${jaxx.mergeHelpIdsFilename}
  • Défaut : helpIds-all.properties

outputHelpIds :

Where to generate helpIds files.
  • Type : java.io.File
  • Depuis : 1.3
  • Exigé : Oui
  • Expression : ${jaxx.outputHelpIds}
  • Défaut : target/generated-sources/jaxx

outputHelpSearch :

The directory where to create or update help search index files.
  • Type : java.io.File
  • Depuis : 2.0.0
  • Exigé : Oui
  • Expression : ${jaxx.outputHelpSearch}
  • Défaut : ${project.basedir}/target/generated-sources/help

verbose :

verbose flag
  • Type : boolean
  • Depuis : 1.3
  • Exigé : Non
  • Expression : ${jaxx.verbose}
  • Défaut : false
Maven JRst ReStructuredText