Handbuch:Erweiterung/NotifyMe/Email layout: Unterschied zwischen den Versionen

(Die Seite wurde neu angelegt: „{{DISPLAYTITLE:Email Layout}} Ab BlueSpice 4.5 können Sie die E-Mail-Vorlagen für Benachrichtigungen direkt im Wiki anpassen. ==Anpassen der Benachrichtigungs-E-Mails== Für die E-Mails werden drei Vorlagen verwendet: *<code>MediaWiki:Wrapper.mail</code>: Wie der Name schon sagt, umschließt diese Vorlage den eigentlichen E-Mail-Text. Hier können Sie das Logo ändern. *<code>MediaWiki:SingleNotification.mail</code>: Inhalt für die Sofortbenachrich…“)
 
Keine Bearbeitungszusammenfassung
Zeile 1: Zeile 1:
{{DISPLAYTITLE:Email Layout}}
{{DISPLAYTITLE:Email Layout}}


Ab BlueSpice 4.5 können Sie die E-Mail-Vorlagen für Benachrichtigungen direkt im Wiki anpassen.
Ab BlueSpice 4.5 können Sie die Email-Vorlagen für Benachrichtigungen direkt im Wiki anpassen.


==Anpassen der Benachrichtigungs-E-Mails==
==Anpassen der Benachrichtigungs-E-Mails==
Für die E-Mails werden drei Vorlagen verwendet:
Für die Emails werden drei Vorlagen verwendet:


*<code>MediaWiki:Wrapper.mail</code>: Wie der Name schon sagt, umschließt diese Vorlage den eigentlichen E-Mail-Text. Hier können Sie das Logo ändern.
*<code>MediaWiki:Wrapper.mail</code>: Wie der Name schon sagt, umschließt diese Vorlage den eigentlichen Email-Text. Hier können Sie das Logo ändern.


*<code>MediaWiki:SingleNotification.mail</code>: Inhalt für die Sofortbenachrichtigungen.
*<code>MediaWiki:SingleNotification.mail</code>: Inhalt für die Sofortbenachrichtigungen.


*<code>MediaWiki:DigestNotification.mail</code>: Inhalt für die täglichen oder wöchentlichen Digest-Benachrichtigungen.
*<code>MediaWiki:DigestNotification.mail</code>: Inhalt für die täglichen oder wöchentlichen Sammelbenachrichtigungen.


[[File:mail template.png|alt=Vorlagenausgabe mit äußerem Wrapper und innerer Inhaltsvorlage|center|thumb|550x550px|Benachrichtigungsmail-Vorlage]]Da die Anpassungen im Quelltextbearbeitungsmodus vorgenommen werden müssen, sind Kenntnisse in Wikitext, HTML und CSS erforderlich.
[[File:mail template.png|alt=Vorlagenausgabe mit äußerem Wrapper und innerer Inhaltsvorlage|center|thumb|550x550px|Benachrichtigungsmail-Vorlage]]Da die Anpassungen im Quelltextbearbeitungsmodus vorgenommen werden müssen, sind Kenntnisse in Wikitext, HTML und CSS erforderlich.


===MediaWiki:Wrapper.mail===
===MediaWiki:Wrapper.mail===
Der Mail-Wrapper enthält das allgemeine Styling der E-Mail. Hier können Sie das Logo festlegen, das im E-Mail-Text verwendet wird. Standardmäßig zeigen die E-Mails das Logo an, das in [[Manual:Extension/FlexiSkin|FlexiSkin]] definiert ist.
Der Mail-Wrapper enthält das allgemeine Styling der Email. Hier können Sie das Logo festlegen, welches in den Emails verwendet wird. Standardmäßig wir das Logo angezeigt, das in [[Handbuch:Erweiterung/FlexiSkin|FlexiSkin]] definiert ist.


Das Wiki zeigt eine Vorschau des aktuellen E-Mail-Layouts. Sie können diese Seite im Quelltext-Bearbeitungsmodus bearbeiten. Das Layout wird durch eine Kombination von HTML-Containerelementen generiert, die den Parameter „Inhalt“ umschließen. Wie bei jeder Wiki-Seite erstellen Sie einen Versionsverlauf Ihrer Änderungen und können bei Bedarf problemlos zum ursprünglichen Layout zurückkehren.
Das Wiki zeigt eine Vorschau des aktuellen Email-Layouts. Sie können diese Seite nun im Quelltext-Bearbeitungsmodus bearbeiten. Das Layout wird durch eine Kombination von HTML-Container-Elementen generiert, die den Parameter „Inhalt“ umschließen. Wie bei jeder Wiki-Seite erstellen Sie einen Versionsverlauf Ihrer Änderungen und können bei Bedarf problemlos zum ursprünglichen Layout zurückkehren.


Das HTML-Tag „head“ definiert einige Metainformationen und muss nicht geändert werden.
Das HTML-Tag „head“ definiert einige Metainformationen und muss nicht geändert werden.


Im „body“-Tag werden die Hintergrundfarbe und die Inhaltsauffüllung festgelegt. Wenn Sie FlexiSkin nicht verwenden oder eine benutzerdefinierte Vorlage auf dem Server definiert haben, ist der Hintergrund weiß.
Im „body“-Tag werden die Hintergrundfarbe und der Inhaltsabstand festgelegt. Wenn Sie FlexiSkin nicht verwenden oder eine benutzerdefinierte Vorlage auf dem Server definiert haben, ist der Hintergrund weiß.


Der erste Div-Container umschließt das Logo. Es enthält einige Stile, die im Skin des Wikis vordefiniert sind, aber überschrieben werden könnten. Da die Textfarbe normalerweise schwarz oder dunkelgrau ist, können wir normalerweise alle benutzerdefinierten Einstellungen so belassen, wie sie sind.
Der erste div-Container umschließt das Logo und enthält einige Stile, die im Skin des Wikis vordefiniert sind. Dies können hier überschrieben werden. Da die Textfarbe normalerweise schwarz oder dunkelgrau ist, können Sie meistens die Einstellungen so belassen, wie sie sind.


====Logo ändern====
====Logo ändern====
Um ein Logo zu verwenden, das Sie in das Wiki hochgeladen haben, können Sie dessen Pfad als Bildquelle hinzufügen. Beispiel: <syntaxhighlight lang="text">
Um ein Logo zu verwenden, das Sie in das Wiki hochgeladen haben, fügen Sie dessen Pfad als Bildquelle hinzu. Beispiel: <syntaxhighlight lang="text">
<img src="/w/nsfr_img_auth.php/c/c9/mycompany-logo.jpeg" width="150px" alt="MyCompany logo"/>
<img src="/w/nsfr_img_auth.php/c/c9/mycompany-logo.jpeg" width="150px" alt="MyCompany logo"/>
</syntaxhighlight>Wenn Sie diese Seite bearbeiten, achten Sie darauf, den Inhaltsplatzhalter nicht zu entfernen. Dieser Platzhalter wird benötigt, um den eigentlichen E-Mail-Text aus der E-Mail-Vorlage für Einzel- oder Digest-Benachrichtigungen hinzuzufügen und sieht folgendermaßen aus:<syntaxhighlight lang="text">
</syntaxhighlight>Wenn Sie diese Seite bearbeiten, achten Sie darauf, den Inhaltsplatzhalter nicht zu entfernen. Dieser Platzhalter wird benötigt, um den eigentlichen Email-Text aus der Vorlage für Einzel- oder Sammelbenachrichtigungen hinzuzufügen und sieht folgendermaßen aus:<syntaxhighlight lang="text">
{{{content}}}
{{{content}}}
</syntaxhighlight>Wechseln wir zu den Inhaltsvorlagen.
</syntaxhighlight>Wechseln wir zu den Inhaltsvorlagen.


===MediaWiki:SingleNotification.mail===
===MediaWiki:SingleNotification.mail===
Die Vorlage für eine einzelne Benachrichtigung versendet eine E-Mail unmittelbar nach einem auslösenden Ereignis. Da diese Vorlage für alle Arten von Benachrichtigungen verwendet wird, sollten Sie den Standardinhalt in den meisten Fällen unverändert lassen. Sie können jedoch beispielsweise zusätzlichen Inhalt hinzufügen.
Die Vorlage für eine einzelne Benachrichtigung versendet eine Email unmittelbar nach einem auslösenden Ereignis. Da diese Vorlage für alle Arten von Benachrichtigungen verwendet wird, sollten Sie den Standardinhalt in den meisten Fällen unverändert lassen. Sie können jedoch beispielsweise zusätzlichen Inhalt hinzufügen.


Hier füge ich die Kontakt- und E-Mail-Informationen des Wiki-Administrators für den Fall hinzu, dass Fragen zu den Benachrichtigungs-E-Mails auftreten, direkt zwischen den beiden HTML-Div-Containern. Dadurch wird der neue Inhalt über dem grauen Fußzeilenfeld platziert:<syntaxhighlight lang="text">
Hier füge ich die Kontakt- und Email-Informationen des Wiki-Administrators für den Fall hinzu, dass Fragen zu den Benachrichtigungs-E-Mails auftreten, Hierzu eignet sich der Platz direkt zwischen den beiden div-Containern. Dadurch wird der neue Inhalt über dem grauen Fußzeilenfeld platziert:<syntaxhighlight lang="text">
{{{content}}}
{{{content}}}
</syntaxhighlight>
</syntaxhighlight>
Zeile 42: Zeile 42:
Sie können diesen neuen Inhalt auch als [[mediawikiwiki:Help:System_message|Systemnachricht]] einbetten, wenn Sie wissen, wie Systemnachrichten funktionieren. Dadurch wird sichergestellt, dass Benutzer diesen Text in der Sprache sehen, die sie in ihren Einstellungen definiert haben.
Sie können diesen neuen Inhalt auch als [[mediawikiwiki:Help:System_message|Systemnachricht]] einbetten, wenn Sie wissen, wie Systemnachrichten funktionieren. Dadurch wird sichergestellt, dass Benutzer diesen Text in der Sprache sehen, die sie in ihren Einstellungen definiert haben.


Nach dem Speichern der Änderungen wird die aktualisierte Vorlage angezeigt. Bitte beachten Sie, dass das Klicken auf diesen E-Mail-Link einen Sicherheitsfehler im Wiki verursacht, jedoch nicht in der tatsächlich gesendeten E-Mail.
Nach dem Speichern der Änderungen wird die aktualisierte Vorlage angezeigt. Bitte beachten Sie, dass das Klicken auf diesen Email-Link einen Sicherheitsfehler im Wiki verursacht, jedoch nicht in der tatsächlich gesendeten Email.
[[File:single notification template output.png|alt=E-Mail-Vorlagenvorschau mit hervorgehobener Anpassung|center|thumb|450x450px|Ausgabe nach Anpassung]]
[[File:single notification template output.png|alt=E-Mail-Vorlagenvorschau mit hervorgehobener Anpassung|center|thumb|450x450px|Ausgabe nach Anpassung]]


==Testen der Vorlagen==
==Testen der Vorlagen==
Um Änderungen an der einzelnen Benachrichtigungsvorlage zu testen, können Wiki-Administratoren die Seite „Special:NotificationTester“ verwenden und den Anweisungen auf der Seite folgen.
Um Änderungen an der einzelnen Benachrichtigungsvorlage zu testen, können Wiki-Administratoren die Seite <code>Special:NotificationTester</code>  verwenden und den Anweisungen auf der Seite folgen.

Version vom 11. Juli 2024, 15:10 Uhr


Ab BlueSpice 4.5 können Sie die Email-Vorlagen für Benachrichtigungen direkt im Wiki anpassen.

Anpassen der Benachrichtigungs-E-Mails[Bearbeiten | Quelltext bearbeiten]

Für die Emails werden drei Vorlagen verwendet:

  • MediaWiki:Wrapper.mail: Wie der Name schon sagt, umschließt diese Vorlage den eigentlichen Email-Text. Hier können Sie das Logo ändern.
  • MediaWiki:SingleNotification.mail: Inhalt für die Sofortbenachrichtigungen.
  • MediaWiki:DigestNotification.mail: Inhalt für die täglichen oder wöchentlichen Sammelbenachrichtigungen.
Vorlagenausgabe mit äußerem Wrapper und innerer Inhaltsvorlage
Benachrichtigungsmail-Vorlage

Da die Anpassungen im Quelltextbearbeitungsmodus vorgenommen werden müssen, sind Kenntnisse in Wikitext, HTML und CSS erforderlich.

MediaWiki:Wrapper.mail[Bearbeiten | Quelltext bearbeiten]

Der Mail-Wrapper enthält das allgemeine Styling der Email. Hier können Sie das Logo festlegen, welches in den Emails verwendet wird. Standardmäßig wir das Logo angezeigt, das in FlexiSkin definiert ist.

Das Wiki zeigt eine Vorschau des aktuellen Email-Layouts. Sie können diese Seite nun im Quelltext-Bearbeitungsmodus bearbeiten. Das Layout wird durch eine Kombination von HTML-Container-Elementen generiert, die den Parameter „Inhalt“ umschließen. Wie bei jeder Wiki-Seite erstellen Sie einen Versionsverlauf Ihrer Änderungen und können bei Bedarf problemlos zum ursprünglichen Layout zurückkehren.

Das HTML-Tag „head“ definiert einige Metainformationen und muss nicht geändert werden.

Im „body“-Tag werden die Hintergrundfarbe und der Inhaltsabstand festgelegt. Wenn Sie FlexiSkin nicht verwenden oder eine benutzerdefinierte Vorlage auf dem Server definiert haben, ist der Hintergrund weiß.

Der erste div-Container umschließt das Logo und enthält einige Stile, die im Skin des Wikis vordefiniert sind. Dies können hier überschrieben werden. Da die Textfarbe normalerweise schwarz oder dunkelgrau ist, können Sie meistens die Einstellungen so belassen, wie sie sind.

Logo ändern[Bearbeiten | Quelltext bearbeiten]

Um ein Logo zu verwenden, das Sie in das Wiki hochgeladen haben, fügen Sie dessen Pfad als Bildquelle hinzu. Beispiel:

<img src="/w/nsfr_img_auth.php/c/c9/mycompany-logo.jpeg" width="150px" alt="MyCompany logo"/>

Wenn Sie diese Seite bearbeiten, achten Sie darauf, den Inhaltsplatzhalter nicht zu entfernen. Dieser Platzhalter wird benötigt, um den eigentlichen Email-Text aus der Vorlage für Einzel- oder Sammelbenachrichtigungen hinzuzufügen und sieht folgendermaßen aus:

{{{content}}}

Wechseln wir zu den Inhaltsvorlagen.

MediaWiki:SingleNotification.mail[Bearbeiten | Quelltext bearbeiten]

Die Vorlage für eine einzelne Benachrichtigung versendet eine Email unmittelbar nach einem auslösenden Ereignis. Da diese Vorlage für alle Arten von Benachrichtigungen verwendet wird, sollten Sie den Standardinhalt in den meisten Fällen unverändert lassen. Sie können jedoch beispielsweise zusätzlichen Inhalt hinzufügen.

Hier füge ich die Kontakt- und Email-Informationen des Wiki-Administrators für den Fall hinzu, dass Fragen zu den Benachrichtigungs-E-Mails auftreten, Hierzu eignet sich der Platz direkt zwischen den beiden div-Containern. Dadurch wird der neue Inhalt über dem grauen Fußzeilenfeld platziert:

{{{content}}}
Quellansicht der Vorlage für eine einzelne Benachrichtigung mit hinzugefügtem benutzerdefiniertem Text.
Benutzerdefinierter Text für eine einzelne Benachrichtigung

Sie können diesen neuen Inhalt auch als Systemnachricht einbetten, wenn Sie wissen, wie Systemnachrichten funktionieren. Dadurch wird sichergestellt, dass Benutzer diesen Text in der Sprache sehen, die sie in ihren Einstellungen definiert haben.

Nach dem Speichern der Änderungen wird die aktualisierte Vorlage angezeigt. Bitte beachten Sie, dass das Klicken auf diesen Email-Link einen Sicherheitsfehler im Wiki verursacht, jedoch nicht in der tatsächlich gesendeten Email.

E-Mail-Vorlagenvorschau mit hervorgehobener Anpassung
Ausgabe nach Anpassung

Testen der Vorlagen[Bearbeiten | Quelltext bearbeiten]

Um Änderungen an der einzelnen Benachrichtigungsvorlage zu testen, können Wiki-Administratoren die Seite Special:NotificationTester verwenden und den Anweisungen auf der Seite folgen.




Feedback zur Dokumentation ist im Community-Forum möglich.