nbm:branding

Full name:

org.codehaus.mojo:nbm-maven-plugin:3.14:branding

Description:

Package branding resources for NetBeans platform/IDE based application. The format of branding resources is the same as in NetBeans Ant-based projects. The src/main/nbm-branding folder of the project is assumed to contain the branding content. Within the directory, the following folder structure is assumed:
  • 1. pick the IDE/platform module which contents you want to brand. eg. org-openide-windows.jar
  • 2. locate the jar within the IDE/platform installation and it's cluster, eg. modules/org-openide-windows.jar
  • 3. create the same folder structure in src/main/nbm-branding, make folder with the module's jar name as well. eg. create folder by name modules/org-openide-windows.jar
  • 4. within that folder place your branding modifications at the same location, as if they were withn the jar, eg. org/openide/windows/ui/Bundle.properties and place the changed bundle keys there.

Attributes:

  • Requires a Maven project to be executed.
  • The goal is thread-safe and supports parallel builds.
  • Binds by default to the lifecycle phase: package.

Required Parameters

Name Type Since Description
brandingSources File - Location of the branded resources.
Default value is: ${basedir}/src/main/nbm-branding.
cluster String - cluster of the branding.
Default value is: extra.
nbmBuildDir File - directory where the the binary content is created.
Default value is: ${project.build.directory}/nbm.
outputDirectory File - output directory.
Default value is: ${project.build.directory}.

Optional Parameters

Name Type Since Description
brandingToken String - The branding token used by the application. Required unless nbmBuildDir does not exist and the mojo is thus skipped.
User property is: netbeans.branding.token.

Parameter Details

brandingSources:

Location of the branded resources.
  • Type: java.io.File
  • Required: Yes
  • Default: ${basedir}/src/main/nbm-branding

brandingToken:

The branding token used by the application. Required unless nbmBuildDir does not exist and the mojo is thus skipped.
  • Type: java.lang.String
  • Required: No
  • User Property: netbeans.branding.token

cluster:

cluster of the branding.
  • Type: java.lang.String
  • Required: Yes
  • Default: extra

nbmBuildDir:

directory where the the binary content is created.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.directory}/nbm

outputDirectory:

output directory.
  • Type: java.io.File
  • Required: Yes
  • Default: ${project.build.directory}