Writing docs is fun!!!
Everyone loves docs! Loves reading them! Loves writing them! I tell ya, there's nothing like curling up with the online help system of a computer program on a quiet evening.
Well, maybe not. Most people hate docs, will only go to them when they're completely stuck (and therefore frustrated), and swear when they don't find their answer in three easy clicks. It's funny that people will spend a half hour googling around flamewars on forums and never even open the product's help.
Developers, for the most part, hate writing docs too. They'd rather be coding cool new features than explaining existing ones! But now that we're swinging into high gear with our efforts to get people to write plug-ins, those plug-in developers are also (hopefully) going to be writing help sets too. So here's some resources to help you out:
- NetBeans Help System Plug-in Tutorial - A plug-in by Geertjan on writing a plug-in module for a help set.
- Module Help Set Integration FAQs - quick answers to commonly-asked questions about setting up help sets.
- Connecting Help in NetBeans - A more exhaustive guide to setting up help and setting up CSH (Context-Sensitive Help, i.e. Help buttons on dialog boxes).
- NetBeans JavaHelp Integration API - Reference documentation for the help system.
- Javadoc - Javadoc for the org.netbeans.api.javahelp package.
Posted by Lukas on July 18, 2005 at 05:19 PM CEST #
I've dealt with a lot of software over time but JavaHelp is the most dense that I've encountered. You need a simple step by step; where to place the module, how to bring it Netbeans, etc. If the integration needs to be done by setting various xml configuration files, then you have an ackward beast. I hope I'm not being offensive, but I think you need a little more hand-holding.
Regards,
Pete
Posted by Peter Jekel on December 04, 2008 at 03:40 PM CET #