# Kurz-Dokumentation Plugin "Comments"

Version Comments 4.17 (veröffentlicht Dezember 2024)

Vielen Dank an Markus Vetter für die Erlaubnis, den Code seines Plugins uBlog als Basis für die Entwicklung des Plugins "Comments" zu verwenden.

Ab Comments 4.1 werden die Kommentare direkt aus den Kommentaren heraus verwaltet, bearbeitet und gelöscht. Dazu müssen Sie eingeloggt und im Ansichtsmodus (Vorschaumodus) sein.

## 1. Funktionen:

- Jede einzelne Seite einer CMSimple-Installation kann kommentierbar gemacht werden.
- als Gästebuch verwendbar
- WYSIWYG-Editor im Kommentarfeld
- Kommentare können auf- und absteigend sortiert werden
- Link zum Kommentarformular über jedem Kommentar
- Wenn das Plugin MembersArea installiert ist, kann das Kommentarformular für nicht eingeloggte Besucher und Mitglieder der Gruppe für neu registrierte Mitglieder ausgeblendet werden.
- Die Kommentar-Funktion kann global deaktiviert werden, bereits abgegebene Kommentare bleiben sichtbar (Urlaubs-Funktion)
- Kommentare können global unter Moderation gestellt werden (neue Kommentare erst nach Freischaltung durch den Administrator sichtbar).
- Wenn das Plugin MembersArea installiert ist, können einzelne Mitglieder unter Moderation gestellt werden.
- Benachrichtigungsfunktion: der Administrator erhält bei jedem neuen Kommentar eine e-mail.
- Optimiert für Einsatz in den Blog Plugins RealBlog und NewsBlog

## 2. Systemvoraussetzungen

Voraussetzung ist eine funktionierende Installation von CMSimple 4.2 oder höher.

## 3. Installation

1. zip-Datei herunterladen und mit einem geeigneten Programm entpacken
2. - Laden Sie die komplette Ordner-Struktur des Verzeichnisses "CMSimpleRoot" (die Verzeichnisse "plugins" und "content") in das Installationsverzeichnis von CMSimple hoch.
   - Ihr ftp Programm wird merken, dass es diese Verzeichnisse bereits gibt, und Sie fragen, ob Sie das wirklich tun wollen. Beantworten Sie diese Frage einfach mit "ja", "ok" oder was immer Ihr ftp Programm anbietet.
   - Bei einem Update laden Sie einfach das Verzeichnis "content" nicht mit hoch.
3. Vergeben mit Ihrem ftp-Programm die erforderlichen Lese- und Schreibrechte für Ordner und Dateien.

## 4. Datei- und Ordnerrechte

Damit das Programm funktioniert und arbeiten kann, müssen auf älteren Servern für bestimmte Dateien und Ordner bestimmte Schreib- und Leserechte vergeben werden. Auf modernen Webservern ist das in der Regel nicht notwendig.

### Ordner / Verzeichnisse: chmod 777

- ./content/comments
- ./content/comments/upload
- ./plugins/comments/logs

### Dateien: chmod 666

- ./content/comments01.txt
- ./plugins/comments/config/config.php
- ./plugins/comments/css/stylesheet.css
- ./plugins/comments/languages/alle Dateien
- ./plugins/comments/logs/logfile.txt

## 5. Funktionsaufrufe

Wenn Sie eine Seite kommentierbar machen wollen, fügen Sie folgenden Funktionsaufruf auf der Seite ein:

{{{PLUGIN:comments('dateiname');}}}

Hinweis: fügen Sie diesen Code in der Quelltext-Ansicht ein. Prüfen Sie, ob Formatierungen im Code enthalten sind und entfernen Sie diese ggf.

"dateiname" ist der Name der Datei (ohne Endung), in der die Kommentare für diese Seite gespeichert werden. Comments legt diese Datei dann automatisch an, in diesem Fall "dateiname.txt".

Diese Kommentar-Dateien finden Sie dann im Ordner:

./content/comments/

### Comments zusammen mit MembersArea

Wenn das Plugin MembersArea installiert ist, kann das Kommentarformular für nicht eingeloggte Besucher und Mitglieder der Gruppe für neu registrierte Mitglieder (Standard: guest) ausgeblendet werden.

Notieren Sie in diesem Fall einen zweiten Parameter im Plugin Aufruf:

{{{PLUGIN:comments('dateiname','protected');}}}

#### Moderation einzelner Mitglieder:

Wenn Sie ein Mitglied der MembersArea der Gruppe "mod" zuordnen, steht dieses Mitglied unter Moderation, auch wenn Comments global nicht unter Moderation steht.

### Comments zusammen mit RealBlog als WebLog

Wenn Sie "Comments" im Zusammenhang mit dem Plugin "RealBlog" als WebLog betreiben, legt Comments auf Anweisung von RealBlog diese Dateien automatisch an, sobald Sie im entsprechenden Blog-Beitrag die Kommentarfunktion aktivieren.

Ein Funktionsaufruf ist in dieser Betriebsart nicht notwendig.

## 6. Konfiguration

Wenn Sie in CMSimple eingeloggt sind, finden Sie unterhalb des Edit Menüs eine Selectbox "Plugin wählen". Wählen Sie hier "Comments".

Jetzt öffnet sich das Plugin-Menü, wählen Sie hier "Konfiguration".

Bei den verschiedenen Einstellungs-Möglichkeiten finden Sie jeweils ein kleines blaues Fragezeichen-Symbol. Gehen Sie mit der Maus auf das entsprechende Fragezeichen-Symbol, und Sie erhalten Informationen über die entsprechende Konfigurationsmöglichkeit.

## 7. Hinweis zum Editor

Der Editor bietet die Möglichkeit, Textabschnitte als Zitat zu formatieren. Das Ergebnis ist nur dann sichtbar, wenn <blockquote> im Template CSS definiert ist.

Fügen Sie einfach folgendes zur stylesheet.css Ihres Templates hinzu:

blockquote {
font-style: italic;
border-left: 5px solid;
padding: 1px 0 1px 12px;
margin: 16px 0 16px 16px;
}

Sie können natürlich <blockquote> auch anders, zu Ihrem Template passend, formatieren.

## 8. Spamschutz Captcha

Ab Version 4.6 gibt es ein grafisches Spamschutz Captcha. Alle .png Dateien im Ordner captcha/ werden zufällig abwechselnd angezeigt.

Im Ordner captchas/backgrounds/ finden Sie mehrere Hintergrundbilder, die Sie in den Ordner captchas/ kopieren können.

## 9. Zweitsprachen und Subsites

Comments speichert die Daten der Kommentare im content Ordner der aktuellen Seite. Bei Zweitsprachen und Subsites ist das der content Ordner im entsprechenden Verzeichnis, z. B. der Ordner:

./fr/content/comments/

für die Sprache "fr" (Französisch).

Sie müssen also das Verzeichnis "comments/" aus dem Verzeichnis "content/" des Downloads mit all seinen Unterverzeichnissen und Dateien in das Verzeichnis "content/" der Zweitsprache oder Subsite hochladen und, wenn nötig, allen Verzeichnissen Schreibrechte geben (chmod 777).