• Post Reply Bookmark Topic Watch Topic
  • New Topic
programming forums Java Mobile Certification Databases Caching Books Engineering Micro Controllers OS Languages Paradigms IDEs Build Tools Frameworks Application Servers Open Source This Site Careers Other Pie Elite all forums
this forum made possible by our volunteer staff, including ...
Marshals:
  • Campbell Ritchie
  • Liutauras Vilda
  • Tim Cooke
  • Jeanne Boyarsky
  • Paul Clapham
Sheriffs:
  • Devaka Cooray
  • Ron McLeod
  • paul wheaton
Saloon Keepers:
  • Tim Moores
  • Piet Souris
  • Tim Holloway
  • Stephan van Hulst
  • Carey Brown
Bartenders:
  • Al Hobbs
  • Frits Walraven
  • Scott Selikoff

Best way for adding help files to application?

 
Ranch Hand
Posts: 231
Android IntelliJ IDE Linux
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Hello,

I have a java web application based on the GWT technology, I would like to write documentation for this application but I'm not sure of the best method for hosting this.

My initial thought was to have one big PDF document, and if the user needs to see help they would click a link on the application to open this PDF. In my opinion this is a rather crude way of doing it, and maintaining a PDF could be a potential nightmare.

What I would really like, is to have some kind of embedded Wiki site, so I can add new pages, check it in via SVN and be done with it. This means that if a user clicks on a help link, they get a new browser window with this wiki.

My main problem is that I haven't been able to find an embedded wiki, I've trawled google but I can't find a good starting point.

The application would run off Tomcat (or glassfish / jetty), I could install mediaWiki separately but that could also become a chore in the future.

Can anyone give me some advice on what to search for? even a heads up on a good product would be brilliant

Thanks for reading

J
 
Rancher
Posts: 43028
76
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
The standard way of adding a help system would be JavaHelp which supports both desktop and web apps.

If you're looking for a servlet-based wiki, check out JSPWiki (or, for something even simpler, Friki, which we're using for the FAQ here at JavaRanch).
 
James Elsey
Ranch Hand
Posts: 231
Android IntelliJ IDE Linux
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Thanks for the heads up.

I've installed both friki and JSPwiki, both were easy to setup, pretty much just drop the WAR file into the webapps directory and off you go.

I think I'm going to go for JSPwiki, as the documentation is a hell of a lot better (there is hardly anything on the sourceforge friki page), and out of the box it generally looks better

Thanks again!

J
 
You had your fun. Now it's time to go to jail. Thanks for your help tiny ad.
the value of filler advertising in 2021
https://coderanch.com/t/730886/filler-advertising
reply
    Bookmark Topic Watch Topic
  • New Topic