Stand: 29.05.2017

 remso.eu   Dokumentation

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

 

remso.eu > doku > Helpsystem


Helpsystem für Webseiten (mit Javascript und PHP)

Das System besteht aus


Aus der Sicht der Leser:

Das Symbol ? ist ein- oder mehrmals auf Webseiten zu sehen. Wenn es angeklickt wird, poppt ein Helptext auf. Der Dateiname dieses Symbols ist icon_help.png - sprich "I can help".

Weil der Helptext nicht Bestandteil der Webseite ist, sondern erst beim Klicken vom Server geholt wird, sind gleichartige Informationen auf verschiedenn Webseiten gleichlautend.


Aus der Sicht des Webmasters / Administrators:

Webseiten werden unabhängig davon erstellt, ob die Helptexte bereits vorhanden oder noch zu erfassen sind. Ein fehlender Helptext ? meldet seine id="mich gibts nicht" und bietet dem angemeldeten Administrator einen Link zu p032 (Bearbeiten Helptext). Wenn der Text erfasst wurde, ist er beim nächsten Klick verfügbar, ohne die Webseite neu zu laden.

Helptexte haben ursprünglich Eingabefelder in Formularen erklärt, die ID des Symbols ist der Feldname in der Datenbank. Inzwischen zeigen sie auch in Adress-Listen nähere Angaben zur Firma, erklären Programme und ganze Systeme in Kurzform. Bei umfangreichen Beschreibungen kann der Helptext ? auf beliebige Ressourcen (auch fremde Domains) verlinken.


Der Webmaster kann Help-Symbole beliebig oft in eine Webseite setzen, die ID der Symbole müssen sich auf dieser Seite unterscheiden. Sie entsprechen dem Feld `feldname` in der Tabelle `helptexte`:

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

Da die Helptexte zentral in der Datenbank vorliegen, können sie auf beliebig vielen Webseiten gezeigt werden. Zum Beispiel, was man in ein Datumsfeld eingeben kann ?


Im <head> der Webseite sind diese zwei Zeilen enthalten:

<script>var bia_domain="remso.eu",bia_owner="0",bia_kw="",bia_ll="",bia_lg="de";</script>
<script src="css/ajax_getHelptext.js"></script>

Sie bewirken, dass nach dem Laden der Webseite sämtliche Elemente mit class="help" an das Helpsystem gekoppelt werden. Das können auch Buchstaben oder Worte sein: Hilfe!

Die Javascript-Variablen sind


Auf dem Server nimmt das Programm p033_ajax.php (Anzeigen Helptext (Ajax)) die Ajax-Anfrage entgegen, holt den Helptext aus der Datenbank-Tabelle helptexte und liefert ihn aus.


Datenbank-Tabelle helptexte:

CREATE TABLE IF NOT EXISTS `bia_helptexte` (
`id` int(11) NOT NULL AUTO_INCREMENT,
`owner_id` int(11) NOT NULL DEFAULT '0',
`feldname` varchar(50) COLLATE utf8_unicode_ci NOT NULL,
`sprache` varchar(5) COLLATE utf8_unicode_ci DEFAULT NULL,
`html_helptext` text COLLATE utf8_unicode_ci NOT NULL,
`in_tabellen` text COLLATE utf8_unicode_ci,
`in_programmen` text COLLATE utf8_unicode_ci,
`zeit_neu` int(11) DEFAULT NULL,
`zeit_aen` int(11) DEFAULT NULL,
`last_modified` timestamp NOT NULL DEFAULT '0000-00-00 00:00:00' ON UPDATE CURRENT_TIMESTAMP,
PRIMARY KEY (`id`),
UNIQUE KEY `feldname_sprache` (`owner_id`,`feldname`,`sprache`)
) ENGINE=MyISAM DEFAULT CHARSET=utf8 COLLATE=utf8_unicode_ci AUTO_INCREMENT=27;


Die Programm-Datei kann unter p033_ajax.php.txt heruntergeladen werden.


validator