Stand: 29.05.2017

 remso.eu   Dokumentation

Ansprechpartner:   Karl-Heinz Osmer   Fon +49.(0)6152.8558287   osmer.kh @ osmer.de

 

tm3 Doku » p000 Menü » p032 Bearbeiten Helptext

p032   Bearbeiten Helptext ? <= Klick   31.01.2017

Helptexte werden nur dann angezeigt, wenn im Browser Javascript eingeschaltet ist.

Javascript ist jetzt


Konzept des Help-Systems

In jedes HTML-Dokument können vom Webmaster (mit HTML-Kenntnissen) beliebig viele Hilfs-Symbole ? eingebaut werden. Bei Klick darauf wird der zugehörige Hilfetext vom Server geholt und angezeigt.

Hilfstexte können sich auf ein Datenfeld beziehen, auf ein Programm oder gar auf ein Konzept, um Zusammenhänge zu erklären.

Beispiele zum Klicken:
Feld „anred“ ?
Programm „p032“ ?
Thema „Kundenserver“ ?

Das Help-System wurde im Jahr 2015 für das Kalender-Projekt remso.eu dreisprachig (de, en, nl) entwickelt und 2016 für das Fuhrpark-Forum mandantenfähig erweitert.

In der Datenbank auf dem Server muss die Tabelle „helptexte“ vorhanden sein. Sie kann leer sein und wird nach und nach durch Administratoren mit diesem Programm p032 gefüllt.

Es gibt Standard-Hilfstexte (Mandant 0), etwa das Datumsformat für ein Eingabefeld und es gibt mandantenbezogene Hilfstexte (Mandant n).

Wenn das Help-Symbol verblasst ? dargestellt wird, fehlt der Eintrag in der Datenbank. Eine gute Kontrolle für Administratoren, welche Texte noch anzulegen sind. Beispiel: Menü des Fuhrpark-Forums.

Jeder Leser kann die Help-Symbole anklicken, die zugehörige Information wird aktuell im Moment des Klicks vom Server gelesen und angezeigt. Administratoren können den Helptext mit Programm p032 online ändern. Das ist besonders dann wertvoll, wenn projektbezogen eine Vereinbarung getroffen wird. Zum Beispiel die Zeichen, die im Feld „merkmalsleiste“ des Adress-Stamms verwendet werden.


Mandantenfähig, multilingual

HTML-Dokumente, die auf dem Server mit der Programmiersprache PHP erzeugt werden, enthalten die Information, welcher Mandant bearbeitet wird und in welcher Sprache das Dokument ausgeliefert wird. In Projekten ohne Mandant wird Mandant 1 angenommen. In Projekten ohne Sprache wird lg=de deutsch angenommen.

Der Suchbegriff (unique key) für die Tabelle helptexte besteht aus den drei Werten owner_id, feldname, sprache.


Webmaster:   Installation von Helptexten im HTML-Dokument

Es sind en paar Javascript-Variablen zu hinterlegen und dann die Javascript-Datei zu laden:

<script>var bia_domain="example.com",bia_owner="16",bia_kw="[kw]",bia_ll="[ll]",bia_lg="[lg]";</script>
<script src="css/ajax_getHelptext.js"></script>

[kw] (Kennwort) und [ll] (last_login) ist die Zugangskennung des Administrators, um Helptexte anlegen und ändern zu können. [lg] ist die ISO-Sprachkennung, z.B. de für deutsch.

Da die Helptexte per Ajax nachgeladen werden, greift das Sicherheits-Konzept Same-Origin-Policy. Helptexte können nur von derselben Domain (example.com) geholt werden.

Help-Symbole sind in dieser Form einzufügen:

<img id="p032" class="help" src="img/icon_hilfe.gif" alt="?" title="Info" />

id="p023" ist das Feld feldname der Tabelle helptexte, also Bestandteil des Schlüssels (key) in der Datenbank. class="help" hat eine Doppel-Funktion. Einmal können CSS Angaben für diese Klasse hinterlegt sein und zweitens werden diese Objekte (Bilder oder Buchstaben) klickbar gemacht.


Wenn das HTML-Dokument geladen ist DOMContentLoaded, werden automatisch die Objekte mit class=help klickbar gemacht.

Bei Klick auf ein Helpsymbol wird die Javascript-Funktion getHelptextXY aufgerufen, holt den zugehörigen Helptext per Ajax von der Datenbank und zeigt ihn an der Mausposition X, Y

<img class="help" src="img/icon_hilfe.gif" alt="?" title="Helptext" onclick="getHelptext( this, 'remso.eu', '0', 'Kalle', '1482065384', 'p000', 'de' )" />

Programmierer:   PHP-Programm auf dem Server

Bei der Ajax-Abfrage wird das Programm „p033_ajax.php“ auf dem Server aufgerufen. Es liest die angeforderte Kombination der Felder owner_id, feldname und sprache und gibt den Text zurück. Fehlt der Eintrag in der Datenbank, wird noch keine Information vorhanden zurückgegeben. Bei Administratoren mit der Möglichkeit, dieses Programm p032 aufzurufen.



p032.gif p032

Aufgaben des Programms:

  1. Helptext neu anlegen, kopieren, ändern, löschen.

p032_02.gif Beispiel: Helptext in p102 zum Feld "kurz­name", nachdem auf den Buch­sta­ben A geklickt wurde. Unten der Link "Bear­beiten Help­text".

Aufrufen des Programms:

  1. beliebige Programme, die den Helptext anzeigen können,
  2. geplant: p031 Liste Helptexte.

Voraussetzung:

Administrator-Rechte. Kunden- / Teilnehmer können Helptexte sehen, aber nicht bearbeiten.


Arbeitsweise:

Das Programm wird mit Parametern aufgerufen:

  1. Administrator-Kennwort [kw]
  2. Administrator-Legitimation [ll]
  3. feldname
  4. sprache
  5. art
  6. id

Es erfolgt die Prüfung, ob der Administrator Zugriffsrechte hat. Wenn nein, wird die Login-Seite gezeigt.

Der Datenbank-Satz mit der übergebenen Kennung [feldname] wird gelesen und in Kurzform angezeigt. Darunter die Frage "Was möchtest du jetzt tun?" und die farbigen Schaltflächen

  1.   neuen Helptext eingeben  
  2.   ändern  
  3.   kopieren  
  4.   löschen  

Nach Klick auf eine Schaltfläche wird das Formular geöffnet, der Inhalt gezeigt (ausser bei Neu) und die gewählte Funktion kann ausgeführt werden.