Thema: Helpsystem

Das Helpsystem wurde von Karl-Heinz Osmer entwickelt und kann auch nachträglich in jedes HTML-Dokument eingebaut werden. Im Browser des Lesers muss Javascript aktiviert (enabled) sein.

Javascript ist aktiviert (enabled)

Sichtbares Zeichen ist das Info-Symbol to Helptext . Beim Anklicken poppt per Javascript ein Textfeld mit Informationen auf.

Im head des HTML-Dokuments sind drei Zeilen erforderlich:

<script src="/css/standard.js"></script>
<script>var bia_owner="0",bia_kw="",bia_ll="",bia_lg="de";</script>
<script src="/ajax/getHelptext.js"></script>

1. Infotext in HTML enthalten

So sieht der HTML-Code aus:

<img class=help id=muster2
data-art       = "internerHelptext"
data-helptext  = "<p class='cblau bold'>Muster 2</p>
<p>Dieser Helptext ist Bestandteil des HTML-Dokuments und wird NICHT mit Ajax vom Server geholt.</p>"
/>

Und so wirkt er - bitte draufklicken: to Helptext

2. Infotext per Ajax vom Server holen

Wenn mehrere HTML-Dokumente gleichartige Infotexte benötigen, macht es Sinn, diese Texte zentral zu pflegen. Jede Änderung ist dann sofort in allen betroffenen Dokumenten sichtbar.

Die Datei getHelptext.js prüft, ob das auslösende Info-Symbol den Eintrag data-art="internerHelptext" hat. Wenn nicht, wird per Ajax eine Anfrage zum Server an das Programm /000/p033_ajax.php geschickt, das den Infotext für diese Id aus der Datenbank liest und zurückschickt.

Infotext für alle Mandanten in deutscher Sprache

Administratoren sehen unterhalb der Infotexte einen Link zu Programm p032, mit dem sie diesen Text ändern können.

Jeder Anwender hat beim nächsten Klick auf das Info-Symbol den neuen Text, ohne das HTML-Dokument neu zu laden.

3. Bestandteile des Helpsystems

Datei `/ajax/getHelptext.js` Fügt das poppende Info-Feld in das HTML-Dokument ein, erzeugt Ajax-Requests, zeigt Infotext an
Datei `img/icon_info.svg` Info-Symbol

Wenn die Infotexte vom Server geholt und gepflegt werden, zusätzlich

Datei `/css/standard.js` erzeugt Request-Objekt für Ajax im Browser
Datenbank-Tabelle `bia_helptexte` (Server)
Programm `p032.php` Bearbeiten Helptext (Server)
Programm `p033_ajax.php` Senden Infotext (Server)