• 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
  • Paul Clapham
  • Jeanne Boyarsky
Sheriffs:
  • Ron McLeod
  • Frank Carver
  • Junilu Lacar
Saloon Keepers:
  • Stephan van Hulst
  • Tim Moores
  • Tim Holloway
  • Al Hobbs
  • Carey Brown
Bartenders:
  • Piet Souris
  • Frits Walraven
  • fred rosenberger

Question about user documentation (B&S)

 
Greenhorn
Posts: 4
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Hi,

I would like to know your point of view regarding the user documentation.

As told in the assigment, user documentation must be provided. The question is that if it's worth to use JavaHelp system to provide online user documentation or just keep it very simple and use (as suggested) a plain html file.

By now I'm biased to the second option

Cheers
 
Ranch Hand
Posts: 1847
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Unless JavaHelp is part of the standard libraries (as shipped with the compiler) (which AFAIK it isn't) you're not allowed to use it.
 
Ranch Hand
Posts: 243
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Hi,

Jeroen is right. The JavaHelp is a separate download and will not be included in the standard JRE that you will be marked with -- hence your application will fail when run.

If you are keen to provide online help, have you thought about using a JEditorPane and setting the content type to html? I am toying with this idea at the moment. This would allow you to write HTML help and easily incorporate it into the application.

Just an idea.

Cheers, Jared.
 
Jeroen T Wenting
Ranch Hand
Posts: 1847
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
That's what I did. Apart from the rather primitive html support (3.0 partial) it works well.
 
Jason Fritz
Greenhorn
Posts: 4
  • Mark post as helpful
  • send pies
    Number of slices to send:
    Optional 'thank-you' note:
  • Quote
  • Report post to moderator
Thanks a lot for sharing your thoughts.

Yes, what I've done is to use a JEditorPane to view an html document, however I have had some problems when packaging the help html files in the runme.jar file (an exception occurs stating that the class was unable to find one of the help files, no idea why...) that's why I was considreing the use of JavaHelp.

But I think you're right so I'll keep my JEditorPane as a help viewer.
 
Lasagna is spaghetti flvored cake. Just like this tiny ad:
the value of filler advertising in 2021
https://coderanch.com/t/730886/filler-advertising
reply
    Bookmark Topic Watch Topic
  • New Topic