Win a copy of The Java Performance Companion this week in the Performance forum!
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic

About Help

 
Gurpreet Saini
Ranch Hand
Posts: 295
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi reader,
I want to use help in my application could you suggest me which is the best way to use ?
Thank you,
 
Thomas Fly
Ranch Hand
Posts: 164
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
I just have the standard Help | About box, stating that it's version 1.0 of my Sun Certified Developer project (I'm counting on there not being a version 1.1), and then a basic Help | Fly-by-Night AbusersManual.html (implemented with a JEditorPane), that explains the basics of how to select & book flights, etc.
 
Mark Spritzler
ranger
Sheriff
Posts: 17278
6
IntelliJ IDE Mac Spring
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Here is a little more information on how to make a Help JFrame window
First your class will Extend JFrame, you will have to include two things on the Frame

You will then create a URL Object that points to your HTML file.
like this

htmlDocument is a String with the file name.

Then you set the editor pane using the setPage method pasing it the URL object.
Setting as uneditable, and adding it to the Frames content pane container.
And that is really all there is too it.
You can also add a menu that has an Exit option so that they can close the window.
But it really is that simple.
Good Luck
Mark
 
Gurpreet Saini
Ranch Hand
Posts: 295
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi mark,
What do you suggest to include in help ?. Which html docs I should enable such the user may view it ?. And I wonder what may be the content of document. Please suggest .
Thank you,
 
Mark Spritzler
ranger
Sheriff
Posts: 17278
6
IntelliJ IDE Mac Spring
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Good question.
I actually made some jpgs of screen shots, and went step by step how to run the application.
The first part was from my readme.txt file which tells how to start up the program, which is kind of late information at that point.
Then I went on how to search a flight, how to books flight, from a user standpoint through the screens.
Good Luck
Mark
 
Michael Morris
Ranch Hand
Posts: 3451
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator

Originally posted by Mark Spritzler:
I actually made some jpgs of screen shots, and went step by step how to run the application.

I did the same thing.
Michael Morris
 
Gurpreet Saini
Ranch Hand
Posts: 295
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Mark,
The first part was from my readme.txt file which tells how to start up the program, which is kind of late information at that point.

I would like to know that did you made this from the point of view of client or as a epistle. If you had intended as a epistle then it is OK to tell the assessor to start from README otherwise, don't you think that about only client interactions is all needed , only when you are giving your program to someone.
And another thing is I did not got your jpegs idea please elaborate on this. Secondly, can I use other HTML editors to create help document.
Thank you,

[ September 15, 2002: Message edited by: Gurpreet Saini ]
 
Mark Spritzler
ranger
Sheriff
Posts: 17278
6
IntelliJ IDE Mac Spring
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
"epistle" I don't know what this word means. English was never my best subject in school?
Yes use an HTML Editor.
Jpegs where actual screen shots of my GUI.
I used Paint Shop Pro, which has a screen capture portion of the program to capture a screen and then you can save that image as a JPeg.
Good Luck
Mark
 
Gurpreet Saini
Ranch Hand
Posts: 295
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi mark,
"Epistle" means intended for instructions. Now, my question is that had you made your Help in point of view of client or to give instructions to examiner about your project. Don't you think that creating in view of user would be OK. Secondly, I dont want to use graphics anywhere in my project does this work ?. Thirdly, Do you suggest to refresh table ? If yes, then when ?.
Thank's
 
John Smith
Ranch Hand
Posts: 2937
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator

"Epistle" means intended for instructions.

Here is an extended definition:
e�pis�tle Pronunciation Key (-psl)
1 letter, especially a formal one. See Synonyms at letter.
2 literary composition in the form of a letter.
3 Epistle Bible.
One of the letters included as a book in the New Testament.
An excerpt from one of these letters, read as part of a religious service.

[Middle English epistel, from Old French epistle, from Latin epistola, from Greek epistol,
from epistellein, to send a message to : epi-, epi- + stellein, to send; see stel- in Indo-European Roots.]
Eugene.
 
Michael Morris
Ranch Hand
Posts: 3451
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
At least he didn't say canonical!
 
Mark Spritzler
ranger
Sheriff
Posts: 17278
6
IntelliJ IDE Mac Spring
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Thirdly, Do you suggest to refresh table ? If yes, then when ?.

I refreshed after a successfull booking or a new search.
You don't need to use graphics if you don't want. You could explain how to use the GUI without them if you want. However, I think it is a nice touch.
Mark
 
Gurpreet Saini
Ranch Hand
Posts: 295
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi reader,
When user books a seat on selected flight . Then my program updates the available seats column by subtracting the no. of seas from availibility of seats. Is this type of refreshing of JTable OK. Or shall I completely make all records invisible . But If that refreshing of data is required then what is the use of ScrollPane ?.
Thank you,
 
Michael Morris
Ranch Hand
Posts: 3451
  • Mark post as helpful
  • send pies
  • Quote
  • Report post to moderator
Hi Gurpreet,

When user books a seat on selected flight . Then my program updates the available seats column by subtracting the no. of seas from availibility of seats.

I did the same thing. Additionally, if the user had performed a search that did not include the pending booking record, when the booking completed I appended the record to the table.
Hope this helps,
Michael Morris
 
  • Post Reply
  • Bookmark Topic Watch Topic
  • New Topic