This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.
From a discussion with Jesse on the alias: > Is adding help to a module doable (manifest, build.xml changes) via the ui or > just by hand? No. IV-m in <http://apisupport.netbeans.org/new-apisupport.html> Would not be terribly hard to add a GUI wizard for it, I think. Could be considered for the next release. File a FEATURE for it (apisupport/project) if you want.
Do you feel like doing this one? :-) Should be pretty easy. Really there is very little to ask of the user - choice of module project suffices. So can just have one panel showing created/modified files! Some example files to get you started: apisupport/src/org/netbeans/modules/apisupport/resources/templates/Modules_API/__Sample__Help* (please delete after making use of them, to help clean up). After that you have to just add one file to Services/JavaHelp (*) - content is very simple, e.g. apisupport/src/org/netbeans/modules/apisupport/resources/helpsetref.xml Location of created files should be predetermined: ${basedir}/${code.name.base.slashes}/docs/ That's about it, I think. (*) Maybe the wizard could prompt the user to pick a relative location in Services/JavaHelp/, in the usual way. The location affects the TOC/index order in the JavaHelp viewer.
BTW I recommend creating all XML-type files as *.xml, not e.g. *.toc.
Hmm, one issue I forgot: we should distribute the JH search indexer with the harness. Currently it works for external modules *if* you define ${jhall.jar} somehow. Shouldn't be a problem to ship it, I think.
Don't forget to add to manifest: OpenIDE-Module-Requires: org.netbeans.api.javahelp.Help
/cvs/apisupport/project/src/org/netbeans/modules/apisupport/project/ui/wizard/javahelp/Bundle.properties,v <-- Bundle.properties initial revision: 1.1 /cvs/apisupport/project/src/org/netbeans/modules/apisupport/project/ui/wizard/javahelp/template_myplugin-helpset.xml,v <-- template_myplugin-helpset.xml initial revision: 1.1 /cvs/apisupport/project/src/org/netbeans/modules/apisupport/project/ui/wizard/javahelp/template_myplugin-map.jhm,v <-- template_myplugin-map.jhm initial revision: 1.1 /cvs/apisupport/project/src/org/netbeans/modules/apisupport/project/ui/wizard/javahelp/template_myplugin.hs,v <-- template_myplugin.hs initial revision: 1.1 /cvs/apisupport/project/src/org/netbeans/modules/apisupport/project/ui/wizard/javahelp/JavaHelpPanel.form,v <-- JavaHelpPanel.form initial revision: 1.1 /cvs/apisupport/project/src/org/netbeans/modules/apisupport/project/ui/wizard/javahelp/template_myplugin-toc.xml,v <-- template_myplugin-toc.xml initial revision: 1.1 /cvs/apisupport/project/src/org/netbeans/modules/apisupport/project/ui/wizard/javahelp/JavaHelpPanel.java,v <-- JavaHelpPanel.java initial revision: 1.1 /cvs/apisupport/project/src/org/netbeans/modules/apisupport/project/ui/wizard/javahelp/template_myplugin-idx.xml,v <-- template_myplugin-idx.xml initial revision: 1.1 /cvs/apisupport/project/src/org/netbeans/modules/apisupport/project/ui/wizard/javahelp/NewJavaHelpIterator.java,v <-- NewJavaHelpIterator.java initial revision: 1.1 /cvs/apisupport/project/src/org/netbeans/modules/apisupport/project/ui/wizard/javahelp/template_myplugin-about.html,v <-- template_myplugin-about.html initial revision: 1.1 /cvs/apisupport/project/src/org/netbeans/modules/apisupport/project/ui/resources/newJavaHelp.gif,v <-- newJavaHelp.gif initial revision: 1.1 /cvs/apisupport/project/src/org/netbeans/modules/apisupport/project/ui/resources/layer.xml,v <-- layer.xml new revision: 1.35; previous revision: 1.34 /cvs/apisupport/project/src/org/netbeans/modules/apisupport/project/ui/resources/newJavaHelp.html,v <-- newJavaHelp.html initial revision: 1.1
This wizard should be ready now but is still commented out in layer cause there is still undefined jhall.jar necessary for external modules. I can put jhall.jar e.g. in {harness.dir}/lib and define jhall.jar property. - Is there any license problem ? - What about if new external module is developed against NB5.0 which doesn't contain {harness.dir}/lib/jhall.jar ?
Re. license - I think we need to bundle jhall.jar for the benefit of external module developers. We could auto download this JAR from some public location if there is one, but I don't like this. Please work with Honza on getting approval for this. (Note that we already have jh.jar in the platform and jhall.jar includes *copies* of the runtime classes as well as the tool classes - too bad, we do not have legal rights to pull out just the search indexer classes.) If there is a module using the 5.0 harness then the build won't work unless and until ${jhall.jar} is manually defined, but I think we can live with this. We will anyway be making changes to apisupport to make it the default to use the 5.0u1 harness even with a 5.0 platform.
I would suggest uncommenting the layer entry and marking this FIXED and opening a fresh issue for bundling jhall.jar.
OK. Fixed. /cvs/apisupport/project/src/org/netbeans/modules/apisupport/project/ui/resources/layer.xml,v <-- layer.xml new revision: 1.37; previous revision: 1.36