This website uses cookies for visitor traffic analysis. By using the website, you agree with storing the cookies on your computer.More information

Integration der Online Hilfe

Dokumente für die Entwicklung von und mit JVx.

Integration der Online Hilfe

Postby Development@SIB » Thu Feb 11, 2010 5:10 pm

Nahezu jede professionelle Software wird mit aussagekräftiger Dokumentation ausgeliefert. Um die AnwenderIn bei der täglichen Arbeit unter die Arme zu greifen ist eine Benutzerdokumentation erforderlich. Damit diese auch zu jeder Zeit verwendbar ist wird sehr gerne das Internet als Medium verwendet. Mit JVx steht bereits ein fertiger Rahmen für die Integration einer Online Hilfe bereit. Es ist ausreichend wenn die Texte und Bilder als Standard HTML Seiten zur Verfügung stehen. Die Integration übernimmt JVx.


Wie integriert man die Online Hilfe?

Die JVx Online Hilfe steht zum Download bereit!

Das Archiv enthält sowohl den Web Client als auch die notwendigen Bibliotheken und Einstellungen für den Applikations Server:

Code: Select all
- client
  - (Web client files)
- server
  - lib
    - (Server side libraries for Application Server)
  - web.xml (Deployment Deskriptor for Application Server)
- LICENSE.TXT
- NOTICE.TXT

Um die Online Hilfe zu testen verwenden wir eine Installation von Apache Tomcat. Wir erstellen einen neuen Context im webapps Verzeichnis, mit der Bezeichnung application und den Sub Verzeichnissen help und WEB-INF:

Code: Select all
- tomcat
  - bin
  - conf
  - logs
  - temp
  - webapps
    - application
      - help
      - WEB-INF
    - ROOT
  - work

In das help Verzeichnis kopieren wir alle Dateien und Verzeichnisse aus dem client Verzeichnis des Archivs. In das Verzeichnis WEB-INF kopieren wir alle Dateien und Verzeichnisse aus dem server Verzeichnis des Archivs.

Nun ist es an der Zeit den Applikations Server zu starten und mit dem URL
http://localhost/application/help/ zu testen. Als Ergebnis sollte folgende Seite erscheinen:

help.png
help.png (83.44 KiB) Viewed 3278 times


Dateien und Verzeichnisse

Wir haben bewusst das Sub Verzeichnis help gewählt um die Online Hilfe zu integrieren. Das hat sich einerseits in der Praxis bewährt und ist andererseits die Standard Konfiguration im Deployment Deskriptor (web.xml):

Code: Select all
<servlet-mapping>
  <servlet-name>Help</servlet-name>
  <url-pattern>/help/services/Help</url-pattern>
</servlet-mapping>

Es steht Ihnen jedoch frei die Konfiguration an Ihre Umgebung anzupassen.

Die Hilfe wird nun bereits dargestellt jedoch fehlt sämtlicher Inhalt und die Texte enthalten noch Platzhalter. Die Texte sind in der Datei help/index.html enthalten und können mit einem beliebigen Text Editor angepaßt werden:

Code: Select all
<!-- Dynamicly added text -->
<meta name="gwt:property" content="title=You are in the help .....">
<meta name="gwt:property" content="tree-title=Table of contents">
<meta name="gwt:property" content="print=Print">


Die verfügbaren Inhalte/Texte/Dokumente werden im Verzeichnis structure abgelegt, wie folgendes Beispiel zeigt:

Code: Select all
- structure
  - 01_General
    - Userinterface
    - index.html
  - 02_Application
  - 03_Documents
    - references.pdf
  - index.html
  - structure.css
  - System overview.html


Abhängig vom Inhalt der Datei index.html sollte sich folgende Darstellung ergeben:

help_content.png
help_content.png (73.56 KiB) Viewed 3278 times


Namenskonventionen

Anhand des letzten Beispiels sollte deutlich werden wie das Hilfe System aufgebaut ist: Das Dateisystem ist zugleich Ihre Online Hilfe.

Für die Darstellung sind zusätzliche Namenskonventionen vorgesehen:

  • Dateien mit der Endung .css werden NICHT angezeigt
  • Dateien mit der Bezeichnung index.html werden NICHT angezeigt
  • Die Sortierung wird beeinflußt durch ein numerisches Prefix gefolgt von einem _ (Das Prefix wird nicht angezeigt) z.B.: 01_Z, 02_A
  • Wenn in einem Verzeichnis die Datei index.html vorhanden ist, wird diese beim Klick auf den entsprechenden Hilfe Eintrag angezeigt
  • Dateien mit der Endung .html werden angezeigt und alle anderen Dateien wie z.B. pdf, csv werden zum Download angeboten. Dieser Mechanismus eignet sich z.B für die Bereitstellung von Spezifikationen
  • Die Icons für Verzeichnisse werden aufgrund des Verzeichnis Namens (ohne Sortier Prefix) ermittelt z.B.: 01_General -> general.png und general_expanded.png (png wird vorausgesetzt)
  • Die Icons für Dateien werden aufgrund der Endung ermittelt z.B.: references.pdf -> pdf.png


Bilder/Icons

Die Icons für Verzeichnisse und Dateien werden im Verzeichnis help/images/tree abgelegt. Sollten keine speziellen Icons vorhanden sein, werden die Default Icons (folder.png, folder_expanded.png, files.png) verwendet.

Um das Firmen Icon anzupassen muss die Datei help/images/company.png geändert werden. Dabei muss die Bildgröße geachtet werden!
User avatar
Development@SIB
 
Posts: 325
Joined: Mon Sep 28, 2009 1:54 pm

Return to Documentation (DE)