Creare una guida in linea per un'applicazione Java

[ernesto72]

sono un programmatore alle prime armi e non so come creare un manuale utente per una nuova applicazione !

[alka]

Qui si parla di programmazione Java; la creazione di un programma utente esula dal contesto, in quanto il modo con cui si scrive un manuale non cambia a seconda del linguaggio utilizzato, a meno che tu non faccia riferimento alla stesura di documentazioni di classi Java, ad esempio con Javadoc.

Chiarisci qualche dubbio, così è possibile correggere la discussione ed eventualmente spostarla se necessario.

Ciao!

[Andrea1979]

Sì, per fare chiarezza, la documentazione che ottieni "semi-automaticamente" con javadoc è del tipo che trovi nelle pagine delle API di java al sito della www.java.sun.com

Se invence intendi creare un manuale vero e proprio, per restare in ambito java puoi benissimo scrivere la documentazione in HTML e quindi caricare in JEditorPane il documento HTML

[ernesto72]

Ho letto le vostre risposte , e più che un manuale utente devo creare una guida in linea per gli utenti che desiderano utilizzare l'applicazione. Come è meglio fare?

[alka]

Originariamente inviato da ernesto72
Ho letto le vostre risposte , e più che un manuale utente devo creare una guida in linea per gli utenti che desiderano utilizzare l'applicazione. Come è meglio fare?

Non vedo perché aprire una nuova discussione. :master:

Ho unito le due che hai aperto e modificato il titolo.

[Mavck]

anche io mi trovo in questa situzione,premetto che nn ho mai usato javadoc..ovvero so a cosa serve..ma nn mi sono mai interessato di come funziona :rollo:
ora mi trovo nella situzione di creare un manuale html,simile alle API della sun per un codice open source di prova..quindi dovrei praticamente creare una specie di javadoc per questo linguaggio...ho già pensato che lo farò in java...ma nn so come e nn riesco a trovare guide complete riguardanti javadoc...

[Andrea1979]

non sai cercare, il che è male
http://java.sun.com/j2se/javadoc/index.jsp

[Mavck]

ti ringrazio :P
avevo già trovato qualcosa sul sito della sun..ma senza offesa cercavo qualcosa scritto in maniera più casareccia ..cmq ho trovato qualcosa sulle doclet..che alla fine sarebbe il programma che dovrei creare.. ora mi faccio sta bella lettura..
al max mi noterai presto per alcune richieste di aiuto

[Andrea1979]

io comincerei da questo:

http://java.sun.com/j2se/javadoc/wri...nts/index.html

che è al link che ti ho postato. Mi risparmierai delle domande future

[crik]

Basta fare il copia-incolla, se ho capito bene quello che cerchi!



import javax.swing.*;
import java.awt.*;
import java.net.URL;
import java.net.MalformedURLException;
import java.io.*;
import javax.swing.text.*;
import javax.swing.event.*;

public class GuidaHTML
{
public static void main (String [] args)
{
myFrame frame = new myFrame();
frame.show();
}
}
//*************************
class myFrame extends JFrame
{
public myFrame()
{
setSize(700, 750);
setDefaultCloseOperation(EXIT_ON_CLOSE);
setTitle("Help");

HtmlPane html = new HtmlPane();

Container myContentPane = getContentPane();
myContentPane.add(html, "Center");
}

}

//***********************************************
class HtmlPane extends JScrollPane implements HyperlinkListener
{
JEditorPane html;

public HtmlPane()
{
try {
File f = new File ("HelpFiles/home.html");// ovviamente esisterà una cartella chiamata HelpFiles che avrà un html chiamato home!
String s = f.getAbsolutePath();
s = "file:"+s;
URL url = new URL(s);
html = new JEditorPane(s);
html.setEditable(false);
html.addHyperlinkListener(this);

JViewport vp = getViewport();
vp.add(html);
} catch (MalformedURLException e) {
System.out.println("Malformed URL: " + e);
} catch (IOException e) {
System.out.println("IOException: " + e);
}
}

/**
* Notification of a change relative to a
* hyperlink.
*/
public void hyperlinkUpdate(HyperlinkEvent e) {
if (e.getEventType() == HyperlinkEvent.EventType.ACTIVATED) {
linkActivated(e.getURL());
}
}

/**
* Follows the reference in an
* link. The given url is the requested reference.
* By default this calls setPage,
* and if an exception is thrown the original previous
* document is restored and a beep sounded. If an
* attempt was made to follow a link, but it represented
* a malformed url, this method will be called with a
* null argument.
*
* @param u the URL to follow
*/
protected void linkActivated(URL u) {
Cursor c = html.getCursor();
Cursor waitCursor = Cursor.getPredefinedCursor(Cursor.WAIT_CURSOR);
html.setCursor(waitCursor);
SwingUtilities.invokeLater(new PageLoader(u, c));
}

/**
* temporary class that loads synchronously (although
* later than the request so that a cursor change
* can be done).
*/
class PageLoader implements Runnable {

PageLoader(URL u, Cursor c) {
url = u;
cursor = c;
}

public void run() {
if (url == null) {
// restore the original cursor
html.setCursor(cursor);

// PENDING(prinz) remove this hack when
// automatic validation is activated.
Container parent = html.getParent();
parent.repaint();
} else {
Document doc = html.getDocument();
try {
html.setPage(url);
} catch (IOException ioe) {
html.setDocument(doc);
getToolkit().beep();
} finally {
// schedule the cursor to revert after
// the paint has happended.
url = null;
SwingUtilities.invokeLater(this);
}
}
}

URL url;
Cursor cursor;
}

}