This week's book giveaway is in the General Computing forum.
We're giving away four copies of Arduino in Action and have Martin Evans, Joshua Noble, and Jordan Hochenbaum on-line!
See this thread for details.
The moose likes Developer Certification (SCJD/OCMJD) and the fly likes online help Big Moose Saloon
  Search | Java FAQ | Recent Topics
Register / Login


JavaRanch » Java Forums » Certification » Developer Certification (SCJD/OCMJD)
Reply Bookmark "online help" Watch "online help" New topic
Author

online help

Nate Johnson
Ranch Hand

Joined: May 13, 2002
Posts: 301
I am trying to decide what I am going to provide as online help. By this, I mean when the user that is running the fbn client clicks the menu item for help, what should I display?
1) Just the help relevant to running the client?
2) #1 and help that would be for the grader that applies to other parts of the assignment (ex: the server, javadocs for the code, uml models, etc...)
3) Just do #1 and provide the rest of the help as html, but just mention where it is located in the README.txt file?
I guess I am leaning a bit towards #3, but what are your thoughts?
Thanks a lot!


scwcd, scjd, scjp<br /><a href="http://natejohnson.us" target="_blank" rel="nofollow">http://natejohnson.us</a><br /><a href="http://rice.kuali.org" target="_blank" rel="nofollow">http://rice.kuali.org</a>
Mike Piotrowski
Ranch Hand

Joined: Apr 24, 2002
Posts: 82
Nate,
I included instructions for running the client and the server with some screen shots. For the client I had starting up, searching and booking. For the server just starting and stopping.
I noted the location in the README, and had a it come up in a JEditorPane from the Help menu in the client gui.
Mike
Michael Morris
Ranch Hand

Joined: Jan 30, 2002
Posts: 3451
Hey Nate,
I did pretty much the same thing that Mike did. It's a good approach and JEditorPane is easy to work with.
Michael Morris


Any intelligent fool can make things bigger, more complex, and more violent. It takes a touch of genius - and a lot of courage - to move in the opposite direction. - Ernst F. Schumacher
Nate Johnson
Ranch Hand

Joined: May 13, 2002
Posts: 301
Thanks all... I ended up using the JEditorPane for online help (just for the client part) and I am going to specify the location of server help (no gui for my server) in my README.txt file.
Thanks again!
 
I agree. Here's the link: http://zeroturnaround.com/jrebel - it saves me about five hours per week
 
subject: online help
 
Similar Threads
Userguide question.
how to get full control of screen through java plus some questions
JMS Cluster-address in Weblogic
Help on GUI
how to transfer a file from client to server???