Java - Javadoc info

[tuzzo77]

Buongiorno, ho chiaramente cercato nel sito info che potessero aiutarmi. Non ho trovato chiaramente come risolvere il problema.
Allora, ho generato la javadoc del mio progetto (file index.html) l'ho inserita nel build path (io uso Eclipse Indigo release) associato a javadoc e questo mi consente di aprirlo premendo F1 dall'ide.
Ma scusate, io ho il mio progettino jar con un jframe e tutto. Vorrei che l'utente premendo F1 dal file jar runnable exportato riuscisse ad aprire la stessa documentazione.
Magari mi sbaglio....come faccio a creare un help come quando da qualsiasi programma windows premo F1 mi apre l'index?? E' giusto javadoc vero?
Vi ringrazio in anticipo per qualsiasi risposta mi riusciate a dare.

Buon lavoro

[LeleFT]

No... quello che stai cercando di fare non ha nulla a che vedere con la JavaDoc.

JavaDoc è niente di più che la documentazione Java delle tue classi per i programmatori che, eventualmente dovessero usarle. Si usa, in pratica, quando si creano "librerie". Serve a creare la documentazione per le classi come quella ufficiale delle API di Java.

Quello che vuoi fare tu è un help per il tuo programma... e questo va "cablato" nel codice di funzionamento del programma... nulla a che vedere con la JavaDoc. Devi, quindi, inserire nel tuo programma tutta la lociga di gestione della pressione del tasto F1 (registrando un KeyListener da qualche parte che intercetta tale pressione), e, dopo aver intercettato l'evento, far fare qualcosa al tuo programma (far apparire una finestra con l'help, aprire un browser in modo che punti ad un file HTML, aprire un secondo programma esterno, ecc).

Non confondere gli strumenti per i programmatori con le funzionalità proprie del tuo programma da fornire poi all'utente.

PS: Java ha un forum dedicato... sposto la discussione.


Ciao.

[andbin]

E a quanto ha detto giustamente LeleFT, aggiungo che esiste JavaHelp (http://javahelp.java.net) che permette di creare un sistema di "help" per la propria applicazione Java, potendo sfruttare un "visualizzatore" già fatto (e oltretutto personalizzabile) con la classica tabella dei contenuti, indice, ricerca, ecc...

[tuzzo77]

Grazie davvero a tutti per la risposta. Ho fatto una gran confusione. Proverò a vedere anche come funzionano i *.chm e annessi. Forum utilissimo....sempre il primo nelle mie ricerche giornaliere di help.
Complimenti a tutti

[andbin]

Originariamente inviato da tuzzo77
Proverò a vedere anche come funzionano i *.chm e annessi.

Il chm è un formato di help originario dei sistemi Windows. Non centra nulla direttamente con Java. Esistono comunque visualizzatori anche per sistemi non Windows e c'è anche un progetto per un visualizzatore di chm in Java (vedi su wikipedia qui).

Comunque se la tua applicazione è in Java ... il sistema di help più coerente e "in linea" con la tua applicazione è il JavaHelp.

[tuzzo77]

adesso sto provando ad importare con import javax.help.*;
ma mi segnala un errore in Eclipse. Per caso devo installare un external jar?

[andbin]

Originariamente inviato da tuzzo77
adesso sto provando ad importare con import javax.help.*;
ma mi segnala un errore in Eclipse. Per caso devo installare un external jar?

Beh, sì devi scaricare il pacchetto di JavaHelp. Sul sito indicato c'è anche il manuale d'uso in PDF.

[tuzzo77]

si hai ragionissima....ma sai quante volte ho cliccato sul link del progetto javahelp della sun...non mi funge. Non si apre la pagina. Potrebbe essere non portato piu' avanti?

[LeleFT]

Originariamente inviato da tuzzo77
si hai ragionissima....ma sai quante volte ho cliccato sul link del progetto javahelp della sun...non mi funge. Non si apre la pagina. Potrebbe essere non portato piu' avanti?

Ehm... il link è quello che ti ha postato andbin nel suo primo intervento... ma mi sa che il progetto non c'è più.


Ciao.

[tuzzo77]

sono riuscito a scaricare i file jh*.rar da mettere nell'applicazione....ho creato manualmente il file JHELPSET.HS, JHELPMAP.JHM, JHELPIDX.XML e ho preso un mio esempio INDEX.HTML.
Tutti quest'ultimi copiati a manina nel workspace del mio progetto per un test.
Poi son partito da questo source di esempio ma mi da un excpetion.

import javax.help.*;
import java.net.URL;
import javax.swing.*;
public class JavaHelp {
   public static void main(String args[]) {
      JHelp helpViewer = null;
      try {
          
	      ClassLoader cl = JavaHelp.class.getClassLoader();
          
	      URL url = HelpSet.findHelpSet(cl, "jhelpset.hs");
         
         helpViewer = new JHelp(new HelpSet(cl, url));
          
         helpViewer.setCurrentID("Simple.Introduction");
	   } catch (Exception e) {
	      System.err.println("API Help Set not found");
     	}

      
      JFrame frame = new JFrame();
       
      frame.setSize(500,500);
      
      frame.getContentPane().add(helpViewer);
       
      frame.setDefaultCloseOperation(JFrame.DISPOSE_ON_CLOSE);
      
      frame.setVisible(true);
   }
}

Error:

API Help Set not found