• Post Reply Bookmark Topic Watch Topic
  • New Topic

Open source help API  RSS feed

 
chen young
Ranch Hand
Posts: 197
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi,

I am looking for an open source help API for my jsf (primefaces) web app something like “Oracle Help Technologies” , “oXygen WebHelper”.

This API should be simple to implemented and to work with.

Any recommendation will be appreciated.

Thanks
 
Tim Holloway
Bartender
Posts: 18531
61
Android Eclipse IDE Linux
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Java itself supports (or supported) a help system (javahelp), but I doubt it ever got used much.

Because apps moved to the Web, and systems such as WinHelp or JavaHelp require locally-installed help files to work from and special tools to build the help files. It was much easier to simply write help as web pages.

There's no API for doing help from webapps. If you want your webapps to have help, you write the help as a part of the webapp.

Tools such as Oracle Help Technologies and Oxygen are not application help APIs, they're systems that take application source code - with appropriately formed comments - and create a set of web pages. OxyGen, in fact, is a lot like the Java JavaDoc utility, only it's used for non-java languages such as C. I've been doing some SNMP coding in C recently and the net-snmp application's documentation web pages are generated via OxyGen.
 
Ulf Dittmer
Rancher
Posts: 42970
73
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
JavaHelp require locally-installed help files to work from

JavaHelp 2 added support for web apps, but that didn't do much to make it become more widely used. Although there hasn't been a release in years, it's still functional: https://javahelp.java.net/
 
chen young
Ranch Hand
Posts: 197
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Thank you very much for your suggestions
 
It is sorta covered in the JavaRanch Style Guide.
  • Post Reply Bookmark Topic Watch Topic
  • New Topic
Boost this thread!