"kommentare.heidebim.de" ist eine Schnittstelle zur externen Einbindung einer Kommentarfunktion in statische Webseiten.
Mithilfe einfacher JavaScriptfunktionen können Sie somit ihre statische HTML-Seite für Benutzerkommentare freigeben. In der HTML-Datei beispiel.htm steht eine funktionierende Implementierung der Kommentarfunktion zur Verfügung. Sie kann auf einem beliebigen Webspace gespeichert und nach Anpassung des Benutzernamens und der Artikel_IDs direkt verwendet werden. Die Kommentare im Quelltext der Beispieldatei sollen helfen, die möglichen Funktionen selbst einzusetzen. In den folgenden Abschnitten werden die Schritte zur Einbindung der Kommentarfunktion in eine HTML-Seite noch etwas ausführlicher beschrieben.
Die Datei js_kommentar.php stellt sowohl die JavaScript-Funktionen, als auch die Nutzdaten zur Verfügung. Die Einbindung dieser Datei erfolgt durch die "script"-Tags. Die Einbindung erfolgt einfach indem im "src"-Attribut die externe URL der js_kommentar.php angegeben wird.
<script src="URL/js_kommentar.php" type="text/javascript"></script>Die Benutzerinformationen werden mit Hilfe der SEARCH-Syntax an die URL der Datei angehängt. Hierfür wird die URL mit einem Fragezeichen beendet. Direkt darauf folgend, werden Variablen nach dem Konzept "[Variable]=[Wert]" festgelegt. Mehrere Variablendefinitionen werden durch das kaufmännisches "Und" (&) voneinander getrennt.
Folgende Variablen können belegt werden:
In der Variable "nutzer_id" wird die Eindeutige Kennung des jeweiligen Nutzers der Kommentarfunktion übergeben. Um diese Nutzerkennung zu erhalten, muss sich der jeweilige Seitenbetreiber bei "kommentare.heidebim.de/admin.php" registrieren. Die nutzer_id darf lediglich aus ASCII-konformen Zeichen bestehen.
Die Variable "artikel_id" dient der eindeutigen Identifizierung des Artikels oder der Seite, zu der die jeweiligen Kommentare gehören. Diese Variable kann vom Benutzer frei gewählt werden, sollte aber für den jeweiligen Artikel eindeutig sein und lediglich aus ASCII-konformen Zeichen bestehen.
Die Variable "modus" dient der Umschaltung der internen Modi in der Kommentarfunktion:
Der Modus "init" wird genutzt, um die Kommentarfunktion zu initialisieren. Hierbei werden wichtige Variablen erzeugt und die JavaScript-Funktionen eingebunden. Der "init"-Modus sollte möglichst im "head" des HTML-Dokumentes oder am Beginn des "body"-Abschnittes eingebunden werden.
Für den Initialisierungsmodus wird "artikel_id" nicht benötigt:
<script src="http://kommentare.heidebim.de/js_kommentar.php?nutzer_id=beispiel&modus=init" type="text/javascript"></script>Der Modus "out" erzeugt die eigentliche Auflistung der Kommentare. Hierbei ist die Angabe von "artikel_id" unbedingt erforderlich:
<script src="http://kommentare.heidebim.de/js_kommentar.php?nutzer_id=beispiel&artikel_id=art12_bsp&modus=out" type="text/javascript"></script>Das HTML-Formular zum Posten von Kommentaren muss einigen Regeln entsprechen. Das "name"-Attribut der Formularelemente wird in PHP zur Benennung der Variablen genutzt. Deshalb müssen die "name"-Attribte folgendem Schema entsprechen:
name="kommentar[feldname]"Damit ein Kommentar korrekt gespeichert werden kann, müssen folgende Formular-Elemente enthalten sein:
<form id="comment-input" action="http://kommentare.heidebim.de/post.php" accept-charset="ISO-8859-1" method="post" onsubmit="return checkForm();">
<input type="hidden" name="kommentar[artikel_id]" value="art_1" />
Das Attribut "value" enthält die eindeutige ID des jeweiligen Artikels, zu dem die Kommentare gehören sollen.
<input type="hidden" name="kommentar[nutzer_id]" value="beispiel" />
Das Attribut "value" enthält die eindeutige ID des jeweiligen Benutzers bzw. Seitenbetreibers.
<input id="input-author" name="kommentar[name]" type="text" value="" size="22" tabindex="1" readonly="readonly" onfocus="enable();" />
In diesem Feld gibt der Author eines Kommentars seinen Namen an!
<input id="input-email" name="kommentar[email]" type="text" value="" size="22" tabindex="2" readonly="readonly" onfocus="enable();" />
In diesem Feld gibt der Author eines Kommentars seinen E-Mail-Adresse an! Diese wird zwar gespeichert aber in den Kommentarausgaben nicht veröffentlicht.
<input id="input-url" name="kommentar[website]" type="text" value="" size="22" tabindex="3" readonly="readonly" onfocus="enable();" />
In diesem Feld kann der Author eines Kommentars seinen Web-Adresse angeben! Wenn die Web-Adresse angegeben wird, wird der Name des Authors in Form eines Links dargestellt.
<textarea id="input-content" name="kommentar[text]" cols="58" rows="10" tabindex="4" readonly="readonly" onfocus="enable();"></textarea>
In diesem Feld wird der eigentliche Beitrag geschrieben. Der Text kann mit folgenden HTML-Tags gestaltet werden:
<p> <a> <b> <i> <u> <s> <sup> <sub>
<input id="submit-button" name="kommentar[OK]" type="submit" tabindex="5" value="Kommentar senden" />
Dieses Feld dient dazu, das Formular abzusenden und somit zu speichern. Die Daten werden sowohl serverseitig, als auch lokal durch JavaScript-Funktionen auf Richtigkeit geprüft.
Für die Ausgabe von informativen Daten und für die Datenprüfung stehen einige JavaScript-Funktionen zur Verfügung. Diese können, nach Einbindung der Initialisierungsdaten, überall im Dokument frei verwendet werden.
Folgende JavaScript-Funktionen stehen zur Verfügung:
Diese Funktion erzeugt einen Link, welcher die Anzahl der vorhandenen Kommentare zu dem jeweiligen Artikel anzeigt.
<script type="text/javascript">document.write(link_erzeugen("index.htm","art_1"));</script>Das Ergebnis sieht dann beispielsweise so aus : mehr... (3 Kommentare)
Diese Funktion gibt lediglich die Anzahl der Kommentare zu einem Artikel in Form einer Zahl zurück.
<script type="text/javascript" >document.write(anzahl_kommentare("art_1"));</script>