Hilfeviewer im Vista®-Stil

Fügen Sie Ihren selbst programmierten Anwendungen eine optisch ansprechende und moderne Hilfe hinzu. Sie müssen lediglich die Inhalte als HTML-Seiten erstellen und die hier vorgestellte Bibliothek einbinden.


Damit eine selbst programmierte Anwendung fertig wirkt und um dem Benutzer Hilfestellung zur Verwendung der Software zu bieten, sollte man dem Programm eine Hilfefunktion hinzufügen. Zu diesem Zweck bietet Sun® das JavaHelp-Framework an. Dieses ist jedoch recht umständlich und optisch wenig ansprechend. Mit dieser Bibliothek erstellen Sie im Handumdrehen eine funktionale und optisch ansprechende Programm-Hilfe in Windows® Vista®-Optik.

Die Bibliothek

Alles, was Sie für die Einbindung einer Hilfe in Ihr Programm benötigen, finden Sie in der angehängten Bibliothek. Sie müssen diese lediglich dem Classpath Ihres Projektes hinzufügen.
Die Funktionen im Überblick:
  • einfache Verwendung durch eine einzige kleine Bibliothek
  • Suchfunktion
  • Veränderung der Schriftgröße durch den Benutzer möglich
  • Seiten lassen sich ausdrucken
  • Sie legen die Inhalte fest, indem Sie HTML-Seiten erstellen
Und so sieht das Ergebnis aus:

Auf der linken Seite sehen Sie die hier angebotene Java-Bibliothek; auf der rechten Seite sehen Sie die Original-Hilfe von Windows® Vista®.

Erstellen der Inhalte

Die Inhalte Ihrer Programmhilfe legen Sie selbst fest. Dabei erstellen Sie mit einem beliebigen Editor HTML-Dateien. Sie benötigen mindestens eine Startseite (z.B. 'index.html'), eine Seite für Fragen ('ask.html') und ein Inhaltsverzeichnis ('toc.html').
Sie müssen sich bei der Erstellung der Inhalte nicht auf Formatierungen kümmern, da die Seiten bei der Anzeige automatisch CSS-formatiert werden. Im Folgenden sehen Sie ein Beispiel für eine Hilfeseite: 
  3.   <title>Was sind Updates</title>
  4.  </head>
  6.   <h1>Was sind Updates?</h1>
  7.   <p>Updates sind aktualisierte oder ergänzende Softwareversionen,
  8.   durch die Probleme verhindert oder behoben bzw. die Sicherheit oder
  9.   Leistungsfähigkeit des Computers verbessert werden kann. Es wird
  10.   dringend empfohlen, die Funktion für automatische Updates zu
  11.   aktivieren, damit Sicherheitsupdates und andere wichtige bzw.
  12.   empfohlene Updates für den Computer herunterladen werden können,
  13.   sobald diese verfügbar sind.</p>
  14.   <b>Siehe auch:</b>
  16.    <li><a href="./aktivieren.html">Aktivieren oder Deaktivieren von
  17.    automatischen Updates</a><br /></li>
  18.    <li><a href="./version.html">Wie kann ich feststellen, ob der PC
  19.    auf dem neuesten Stand ist?</a><br /></li>
  20.    <li><a href="./faq.html">Updates: Häufig gestellte Fragen</a></li>
  21.   </ul>
  22.  </body>
  23. </html>

Einbinden in Ihr Programm

Das folgende Programmbeispiel zeigt Ihnen, wie Sie das Hilfefenster von Ihrem Programm aus aufrufen: 
  1. // Der Pfad entspricht dem absoluten Pfad zur Indexdatei Ihrer Hilfe
  2. String path = System.getProperty("user.dir") +
  3.               System.getProperty("file.separator") +
  4.               "help" +
  5.               System.getProperty("file.separator") +
  6.               "index.html";
  7.  
  8. // Erstellen einer Hilfeinstanz
  9. VistaHelp help = new VistaHelp(path);
  10.  
  11. // Anzeigen des Hilfefensters
  12. help.showHelp();
Das Ergebnis

Kurzanleitung:
1. Einbinden der Bibliothek (VistaHelp11.jar) in den Klassenpfad des Projektes.
2. Erstellen der HTML-Inhalte (ask.html und toc.html nicht vergessen!)
3. Aufruf im Programm durch
VistaHelp help = new VistaHelp(...);
help.showHelp();

Im Anhang finden Sie die benötigte Bibliothek und eine Beispielhilfe.


 
 von Manuel Kaess am 25.09.2008  1 Kommentar  Forum ungenügend