Bewertungskonfiguration prodrating.config

Das Produktbewertungs-Modul bringt seine eigene Konfiguration mit, die prodrating.config. Sie liegt entweder im Verzeichnis Konfiguration und gilt dann für alle Subshops, oder in Konfiguration/<Subshop-ID> und gilt dann nur für diesen einen Subshop. Der Aufbau folgt einem Muster, das beim Lesen hilft. Der Abschnitt Basic enthält die Grundeinstellungen und zusätzlich einige ältere E-Mail-Parameter. Diese älteren Parameter werden von vier eigenen E-Mail-Abschnitten abgelöst, sobald diese Abschnitte vorhanden sind. Dazwischen liegen Templates, Sortierung und Meldungstexte. Diese Seite geht in genau dieser Reihenfolge vor und sagt bei jedem älteren Parameter, welcher Abschnitt ihn ersetzt. Die Konfiguration hieß früher prodrating.ini. Beide Namen bezeichnen dieselbe Datei. Grundlagen: Grundlagen zu Konfigurationen

Abschnitte im Überblick

Abschnitt	Zweck
`Basic`	Grundeinstellungen des Moduls
`Templates`	Namen der Templates für Anzeige, Eingabe und Bestätigung
`Sort`	Texte der Sortier-Auswahlliste
`NotifyMessages-Txt`	Meldungstexte des Moduls
`FreeMessages-Txt`	bis zu 50 freie Textmeldungen
`ConfirmMail`	E-Mail zur Bestätigung einer abgegebenen Bewertung
`SendNicknameMail`	E-Mail mit dem vergessenen Nickname
`ThankYouMail`	Dankeschön-E-Mail nach Abgabe einer Bewertung
`NotifyNewRatingMail`	Benachrichtigung über eine neue Bewertung zur Freigabe

NotifyMessages-Txt ist ein Pflichtabschnitt. Fehlt er in der Konfiguration, bricht das Modul mit einem Fehler ab und läuft gar nicht. Alle anderen Abschnitte sind optional.

`Basic`

Die grundlegenden Einstellungen des Produktbewertungs-Moduls.

<basic>
   MinNicknameLen               = 5
   MaxRange                     = 5
   emailcheckmode               = domain
   ConfirmRatingPerEmail        = no
   AllowMultipleRatings         = yes
   InstantReleaseEmptyRatings   = yes
   NotifyNewRatingsEmailAddress =
</basic>

Bewertung und Nickname

Parameter	Zweck	Werte
`MaxRange`	Anzahl der Bewertungspunkte, also der Sterne	Ganzzahl von 1 bis 10
`MinNicknameLen`	Mindestlänge eines Nicknames in Zeichen	Ganzzahl ab 2
`AllowMultipleRatings`	eine Person darf dasselbe Produkt mehrfach bewerten	`yes`, `no`. Standard: `yes`
`InstantReleaseEmptyRatings`	Bewertungen ohne Betreff und Kommentar sofort freigeben	`yes`, `no`
`ConfirmRatingPerEmail`	die bewertende Person muss ihre Bewertung per E-Mail bestätigen	`yes`, `no`. Standard: `no`

Drei Eigenheiten der Auswertung sind dabei zu beachten.MinNicknameLen hat eine harte Untergrenze von 2. Ein kleinerer Wert und ein leerer Wert werden stillschweigend auf 2 gesetzt.MaxRange akzeptiert Werte von 1 bis 10. Liegt der Wert außerhalb dieses Bereichs, wird er ignoriert und der interne Standardwert bleibt stehen. Es findet keine Begrenzung auf den nächstliegenden gültigen Wert statt.AllowMultipleRatings prüft ausschließlich auf no. Jeder andere Wert, auch ein Tippfehler, erlaubt Mehrfachbewertungen.

Prüfung der E-Mail-Adresse

Parameter	Zweck	Werte
`emailcheckmode`	wie die eingegebene E-Mail-Adresse geprüft wird	`domain`, `syntax`, `none`. Standard: `domain`

domain prüft die Syntax und zusätzlich, ob die Domain einen gültigen MX-Eintrag hat. syntax prüft nur die Syntax. none prüft gar nicht.

Ein leerer Wert ergibt domain. Ein Tippfehler dagegen wird unverändert übernommen und trifft dann auf keinen der drei Modi zu. Schreiben Sie den Wert genau so, wie er hier steht.

Ältere E-Mail-Parameter

Diese fünf Parameter stammen aus der Zeit vor den eigenen E-Mail-Abschnitten. Sie wirken nur so lange, wie der jeweils ablösende Abschnitt nicht in der Konfiguration steht.

Parameter	Zweck	Wird abgelöst durch
`ConfirmSubject`	Betreff der Bestätigungs-E-Mail	Abschnitt `ConfirmMail`
`ConfirmSenderAddress`	Absenderadresse der Bestätigungs-E-Mail	Abschnitt `ConfirmMail`
`NicknameSubject`	Betreff der Nickname-E-Mail	Abschnitt `SendNicknameMail`
`NicknameSenderAddress`	Absenderadresse der Nickname-E-Mail	Abschnitt `SendNicknameMail`
`NotifyNewRatingsEmailAddress`	Empfänger der Benachrichtigung über neue Bewertungen	Abschnitt `NotifyNewRatingMail`

Es genügt, dass der ablösende Abschnitt vorhanden ist. Er muss nicht gefüllt sein. Ein leerer <ConfirmMail>-Abschnitt schaltet ConfirmSubject und ConfirmSenderAddress bereits ab, und die Bestätigungs-E-Mail geht dann gar nicht mehr raus.

Der Kernel liest in diesem Abschnitt fünf weitere Parameter. Sie gehören alle zur älteren Textmail-Logik.

Parameter	Zweck	Standard
`ConfirmCharset`	Zeichensatz der Bestätigungs-E-Mail	`ISO-8859-1`
`NotifyNewRatingsSubject`	Betreff der Benachrichtigung über neue Bewertungen	–
`NotifyNewRatingsSender`	Absender dieser Benachrichtigung	–
`NotifyNewRatingsContent`	Textinhalt dieser Benachrichtigung	–
`NotifyNewRatingsCharset`	Zeichensatz dieser Benachrichtigung	–

Im Quellcode ist ConfirmCharset ausdrücklich als nicht dokumentiert markiert. Alle fünf Parameter werden wirkungslos, sobald der jeweils ablösende Abschnitt vorhanden ist.

`Templates`

Die Namen der Templates für die Produktbewertung. Sie liegen standardmäßig im Verzeichnis benutzer/templates/rating.

<Templates>
   List           = incl_rating_list.htm
   Edit           = incl_rating_edit.htm
   ChangeNickname = incl_rating_change_nickname.htm
   Confirm        = incl_rating_confirm.htm
   ConfirmMail    = mail_rating_confirm.txt
   MailValidation = incl_rating_mail_validation.htm
   NicknameMail   = mail_rating_nickname.txt
</Templates>

Parameter	Template für
`List`	die Anzeige vorhandener Bewertungen
`Edit`	die Eingabe einer Bewertung
`ChangeNickname`	das Ändern des Nicknames
`Confirm`	die Seite nach erfolgreicher Eingabe einer Bewertung
`MailValidation`	die Seite, die der Bestätigungs-Link aus der E-Mail aufruft
`ConfirmMail`	die Bestätigungs-E-Mail an die bewertende Person
`NicknameMail`	die E-Mail mit dem angeforderten Nickname

Auf der Confirm-Seite erklären Sie je nach Konfiguration entweder das Bestätigungsverfahren oder bedanken sich für die Bewertung.

ConfirmMail wird nicht mehr verwendet, sobald der Abschnitt ConfirmMail vorhanden ist. Dasselbe gilt für NicknameMail und den Abschnitt SendNicknameMail. Die Templates dieser E-Mails stehen dann in den jeweiligen Abschnitten.

`Sort`

Die Texte für die Sortier-Auswahlliste der Bewertungen.

<Sort>
   SortTimeAsc    = Ältere Einträge zuerst
   *SortTimeDesc  = Neueste Einträge zuerst
   SortRatingAsc  = Negative Bewertungen zuerst
   SortRatingDesc = Positive Bewertungen zuerst
</Sort>

Parameter	Sortiert
`SortTimeAsc`	nach Datum, ältere zuerst
`SortTimeDesc`	nach Datum, neuere zuerst
`SortRatingAsc`	nach Bewertung, negative zuerst
`SortRatingDesc`	nach Bewertung, positive zuerst

Ein Stern vor dem Parameternamen macht diese Sortierung zum Standard. Ein leerer Wert entfernt den Eintrag aus der Auswahlliste.

# Eintrag deaktiviert
SortRatingAsc =

Der Kernel sucht je Sortierkriterium zuerst nach der Variante mit Stern und erst danach nach der Variante ohne. Steht ein Kriterium versehentlich zweimal in der Konfiguration, einmal mit und einmal ohne Stern, gewinnt die Variante mit Stern.

`NotifyMessages-Txt`

Die Meldungstexte des Moduls. Dieser Abschnitt ist Pflicht.

<NotifyMessages-Txt>
   Error                   = Bei Ihrer Eingabe ist etwas unklar:
   NoEmail                 = Bitte geben Sie Ihre E-Mail-Adresse ein.
   InvalidEmail            = Die eingegebene E-Mail-Adresse ist ungültig.
   NoNickname              = Bitte geben Sie einen Nicknamen an.
   NicknameTooShort        = Der Nickname muss mindestens ~PRODRATING-MinimumNicknameLength~ Zeichen lang sein.
   NicknameDoesNotMatch    = Nickname und E-Mail-Adresse stimmen nicht überein.
   NicknameInUse           = Dieser Nickname ist bereits vergeben.
   NoRatingInput           = Bitte geben Sie eine Bewertung an.
   NoOldNick               = Bitte geben Sie Ihren alten Nicknamen an.
   OldNickTooShort         = Ihr alter Nickname muss mindestens ~PRODRATING-MinimumNicknameLength~ Zeichen lang sein.
   NoNewNickname           = Bitte geben Sie einen neuen Nicknamen ein.
   NewNicknameTooShort     = Ihr neuer Nickname muss mindestens ~PRODRATING-MinimumNicknameLength~ Zeichen lang sein.
   NewNickAndRepeatNoMatch = Ihr neuer Nickname stimmt nicht mit der Wiederholung überein.
   NickOrMailUnknown       = E-Mail-Adresse und Nickname existieren in dieser Kombination nicht.
</NotifyMessages-Txt>

Parameter	Erscheint, wenn
`Error`	als Einleitung über der Liste aller Eingabefehler
`NoEmail`	keine E-Mail-Adresse eingegeben wurde
`InvalidEmail`	die E-Mail-Adresse die Prüfung nicht besteht
`NoNickname`	kein Nickname angegeben wurde
`NicknameTooShort`	der Nickname kürzer als `MinNicknameLen` ist
`NicknameDoesNotMatch`	Nickname und E-Mail-Adresse nicht zusammenpassen
`NicknameInUse`	der gewünschte Nickname bereits vergeben ist
`NoRatingInput`	keine Bewertung abgegeben wurde
`NoOldNick`	beim Ändern des Nicknames der alte fehlt
`OldNickTooShort`	der eingegebene alte Nickname zu kurz ist
`NoNewNickname`	beim Ändern des Nicknames der neue fehlt
`NewNicknameTooShort`	der neue Nickname zu kurz ist
`NewNickAndRepeatNoMatch`	neuer Nickname und Wiederholung nicht übereinstimmen
`NickOrMailUnknown`	die Kombination aus E-Mail-Adresse und Nickname nicht existiert

In den Längen-Meldungen steht das lokale Tag PRODRATING-MinimumNicknameLength zur Verfügung. Es gibt den Wert aus MinNicknameLen aus, so dass Sie die Zahl nicht in jeden Text schreiben müssen.

`FreeMessages-Txt`

Bis zu 50 frei benennbare Textmeldungen, die Sie in den Templates ausgeben können.

<FreeMessages-Txt>
   Hinweistext1 = Vielen Dank für Ihre Bewertung.
</FreeMessages-Txt>

Der Parametername ist frei wählbar. Im Template sprechen Sie den Text über FMSG- plus Parametername an, im Beispiel also über ~FMSG-Hinweistext1~.

Die vier E-Mails

Alle vier E-Mail-Abschnitte sind gleich aufgebaut und ersetzen ältere Parameter aus Basic und Templates.

Parameter	Zweck	Werte
`Subject-Txt`	Betreff	Text
`SenderAddress`	Absenderadresse	E-Mail-Adresse
`SenderName`	Absendername	Text
`Charset`	Zeichensatz der HTML-E-Mail	Standard: `ISO-8859-1`
`Template`	HTML-E-Mail-Template	Templatename

Fehlt bei einer dieser E-Mails SenderAddress, Subject-Txt oder Template, wird sie nicht versendet. Der Vorgang bricht ab und schreibt einen Eintrag ins Fehlerprotokoll, ohne dass im Shop etwas sichtbar wird.Prüfen Sie nach dem Anlegen eines dieser Abschnitte deshalb immer, ob die E-Mail tatsächlich ankommt.

`ConfirmMail`

Die E-Mail, mit der die bewertende Person ihre Bewertung bestätigt. Sie wird nur versendet, wenn in Basic der Parameter ConfirmRatingPerEmail auf yes steht.

<ConfirmMail>
   Subject-Txt   = Bitte bestätigen Sie Ihre Produktbewertung
   SenderAddress = noreply@mein-shop.de
   SenderName    = Mein Shop
   Charset       = UTF-8
   Template      = mail_rating_confirm.htm
</ConfirmMail>

Ist dieser Abschnitt vorhanden, werden drei ältere Parameter nicht mehr verwendet: ConfirmSubject und ConfirmSenderAddress aus Basic sowie ConfirmMail aus Templates.

`SendNicknameMail`

Die E-Mail, mit der eine Person ihren vergessenen Nickname zugeschickt bekommt, vergleichbar mit einem Passwort-Versand.

<SendNicknameMail>
   Subject-Txt   = Ihr Nickname
   SenderAddress = noreply@mein-shop.de
   SenderName    = Mein Shop
   Charset       = UTF-8
   Template      = mail_rating_nickname.htm
</SendNicknameMail>

Der Nickname kann nur dann zugeschickt werden, wenn unter der angegebenen E-Mail-Adresse bereits mindestens eine Bewertung abgegeben wurde. Andernfalls gibt es nichts zuzuschicken. Ist dieser Abschnitt vorhanden, werden drei ältere Parameter nicht mehr verwendet: NicknameSubject und NicknameSenderAddress aus Basic sowie NicknameMail aus Templates.

`ThankYouMail`

Die Dankeschön-E-Mail, die unmittelbar nach der Abgabe einer Bewertung versendet wird.

<ThankYouMail>
   Allow         = yes
   Subject-Txt   = Vielen Dank für Ihre Bewertung
   SenderAddress = noreply@mein-shop.de
   SenderName    = Mein Shop
   Charset       = UTF-8
   Template      = mail_rating_thankyou.htm
</ThankYouMail>

Parameter	Zweck	Werte
`Allow`	Dankeschön-E-Mail aktivieren	`yes`, `no`. Standard: `no`

Dieser Abschnitt löst keine älteren Parameter ab. Es gab vorher keine Dankeschön-E-Mail.

`NotifyNewRatingMail`

Die Benachrichtigung an den Shopbetreiber, sobald eine neue Bewertung zur Freigabe eingegangen ist.

<NotifyNewRatingMail>
   Allow         = yes
   Address       = redaktion@mein-shop.de
   Subject-Txt   = Neue Produktbewertung zur Freigabe
   SenderAddress = noreply@mein-shop.de
   SenderName    = Mein Shop
   Charset       = UTF-8
   Template      = mail_rating_notify.htm
</NotifyNewRatingMail>

Parameter	Zweck	Werte
`Allow`	Benachrichtigung aktivieren	`yes`, `no`. Standard: `no`
`Address`	Empfängeradresse	E-Mail-Adresse

Ist dieser Abschnitt vorhanden, wird NotifyNewRatingsEmailAddress aus Basic nicht mehr verwendet.

Dieser Abschnitt enthält eine Falle. Sobald er vorhanden ist, wird der ältere Parameter abgeschaltet. Steht dann hier Allow nicht auf yes, geht gar keine Benachrichtigung mehr raus, auch nicht über den älteren Weg.Fehlt zusätzlich Address, bricht der Versand ebenfalls ab, selbst bei Allow = yes.

Abschnitt für ältere Shops

Der Kernel liest in dieser Konfiguration zusätzlich einen Abschnitt ProductRatingImages, allerdings nur bei Shops der Version 7. Er enthält die Parameter Point1 bis Point10 für die Bewertungsgrafiken sowie back und next für die Blätter-Schaltflächen. In WEBSALE V8s werden die Bewertungsgrafiken im gleichnamigen Abschnitt der shop.config festgelegt. Referenz: Abschnitt ProductRatingImages in der shop.config

Verweise

Wegweiser: Beschreibung des Produktbewertungs-Moduls
Wegweiser: Produktbewertungs-Modul konfigurieren
Wegweiser: Bewertungen beim Produkt anzeigen
Wegweiser: Produkte nach Bewertung sortieren und filtern

​Abschnitte im Überblick

​Basic

​Bewertung und Nickname

​Prüfung der E-Mail-Adresse

​Ältere E-Mail-Parameter

​Templates

​Sort

​NotifyMessages-Txt

​FreeMessages-Txt

​Die vier E-Mails

​ConfirmMail

​SendNicknameMail

​ThankYouMail

​NotifyNewRatingMail

​Abschnitt für ältere Shops

​Verweise

Abschnitte im Überblick

`Basic`

Bewertung und Nickname

Prüfung der E-Mail-Adresse

Ältere E-Mail-Parameter

`Templates`

`Sort`

`NotifyMessages-Txt`

`FreeMessages-Txt`

Die vier E-Mails

`ConfirmMail`

`SendNicknameMail`

`ThankYouMail`

`NotifyNewRatingMail`

Abschnitt für ältere Shops

Verweise