Bundling a JavaHelp Help Set

See Also

A JavaHelp help set provides help files that explain the features and functionality of your module.

To create a new JavaHelp help set:

  1. Right-click a module project and choose New > Other. In the New File wizard, choose JavaHelp Help Set under the Module Development category.
  2. In the Location page, note the files that will be created and also note that they will be housed in a new folder called docs:

    Note: Each of the names above is prefixed by the name of the project. For example, if the project name is myproject, the files above would be myproject-about.html, myproject-hs.xml, etc.

  3. Click Finish.

Optionally, if you do not want to include the IDE's default JavaHelp help sets with your module, you can hide them. Particularly when you are creating a rich-client application on top of the NetBeans Platform, it is unlikely that you will want the IDE's JavaHelp help sets to be included with your application.

To hide a JavaHelp help set:

  1. In the Projects window, expand the Important Files node.
  2. In the Important Files node, expand the XML Layer node, and then wait a moment while the subnodes are loaded.
  3. Expand the <this layer in context> node.
  4. Within the Services/JavaHelp node, select the nodes of the JavaHelp sets that you want to delete. Choose Delete.

In the layer.xml file, notice that tags have been added, each with a _hidden flag. When your module is installed, the _hidden flag tells the IDE, or the application built on the NetBeans Platform, to exclude the specified items.

See Also
About NetBeans Platform and Module Development
About the NetBeans Platform

Legal Notices