How do i create a help file in java for the users of my application

[Manfizy]

Hi pple,
I just completed my first application but the only thing remaining is to create a help file. Any one with an idea on where i should start??

Your replies will be highly appreciated:)

[pellebye]

Try this link

devshed.com/c/a/Java/Java-Help-Files/]Java[/url] Help Files

or do a googlesearch on "help file java".

[pellebye]

Once more:

Try this link

Java Help Files

or do a googlesearch on "help file java". :)

[Manfizy]

Thank you so much for the link
I checked it out and now am just playing around with the code. The only problem that am facing now is that i get an error

invalid url

How am i supposed to name html file according to this example??
Must the help file be in html format or can i still use a word document?

Below is the code

import java.io.*;
import javax.swing.event.*;
import javax.swing.*;
import java.net.*;
import java.awt.event.*;
import java.awt.*;

/**
 *
 * @author Manfizy
 */
public class HelpWindow extends JFrame implements ActionListener {
    private final int WIDTH = 600;
    private final int HEIGHT = 400;
    private JEditorPane editorpane;
    private URL helpURL;
//////////////////////////////////////////////////
/**
  * HelpWindow constructor
  * @param String and URL
  */
public HelpWindow(String title, URL hlpURL) {
   super(title);
   helpURL = hlpURL;
   editorpane = new JEditorPane();
   editorpane.setEditable(false);
   try {
        editorpane.setPage(helpURL);
    } catch (Exception ex) {
    ex.printStackTrace();
  }
  //anonymous inner listener
  editorpane.addHyperlinkListener(new HyperlinkListener() {
  public void hyperlinkUpdate(HyperlinkEvent ev) {
    try {
          if (ev.getEventType() == HyperlinkEvent.EventType.ACTIVATED) {
                  editorpane.setPage(ev.getURL());
                 }
              } catch (IOException ex) {
                  //put message in window
                  ex.printStackTrace();
              }
          }
      });
     getContentPane().add(new JScrollPane(editorpane));
     addButtons();
    // no need for listener just dispose
     setDefaultCloseOperation(DISPOSE_ON_CLOSE);
    // dynamically set location
    calculateLocation();
    setVisible(true);
    // end constructor
  }
/**
 * An Actionlistener so must implement this method
 *
 */
public void actionPerformed(ActionEvent e) {
    String strAction = e.getActionCommand();
    URL tempURL;
    try {
       if (strAction == "Contents") {
            tempURL = editorpane.getPage();
            editorpane.setPage(helpURL);
        }
        if (strAction == "Close") {
         // more portable if delegated
           processWindowEvent(new WindowEvent(this,
            WindowEvent.WINDOW_CLOSING));
        }
    } catch (IOException ex) {
        ex.printStackTrace();
   }
}
/**
: * add buttons at the south
  */
 private void addButtons() {
     JButton btncontents = new JButton("Contents");
     btncontents.addActionListener(this);
     JButton btnclose = new JButton("Close");
     btnclose.addActionListener(this);
     //put into JPanel
     JPanel panebuttons = new JPanel();
     panebuttons.add(btncontents);
     panebuttons.add(btnclose);
     //add panel south
     getContentPane().add(panebuttons, BorderLayout.SOUTH);
 }
 /**
   * locate in middle of screen
   */
  private void calculateLocation() {
     Dimension screendim = Toolkit.getDefaultToolkit().getScreenSize();
     setSize(new Dimension(WIDTH, HEIGHT));
     int locationx = (screendim.width - WIDTH) / 2;
     int locationy = (screendim.height - HEIGHT) / 2;
     setLocation(locationx, locationy);
}
public static void main(String [] args){
    URL index = ClassLoader.getSystemResource("index.html");
    new HelpWindow("Test", index);
}
//end HelpWindow class
}

cheerz!!

[r035198x]

Better read the article java.sun.com/developer/technicalArticles/J2SE/Desktop/javahelp/

[Manfizy]

Can somebody check out how am reading the url in the above code. everytime i try to compile i get an error

java.io.IOException: invalid url

Anyone with an idea??

cheerz!