EXT: kool_groupsubscribe

Transkript

1 EXT: kool_groupsubscribe Extension Key: kool_groupsubscribe Copyright , Renzo Lauper, This document is published under the Open Content License available from The content of this document is related to TYPO3 - a GNU/GPL CMS/Framework available from Table of Contents EXT: kool_groupsubscribe...1 Introduction...1 What does it do?...1 Screenshots...2 Users manual...3 Configuration...4 Reference...4 Tutorial...5 Changelog...5 Introduction What does it do? Diese Extension bildet die Schnittstelle zwischen der Webseite und der Gruppenverwaltung in kool - dem Kirchen-Tool. Ohne kool macht diese Extension keinen Sinn. Mehr über kool erfahren Sie unter Hier grob der Ablauf: - Sie definieren eine Gruppe im kool mit allfälligen Rollen und Gruppen-Datenfeldern - Fügen Sie das Plugin kool_groupsubscribe auf Ihrer Webseite ein und machen Sie alle nötigen Einstellungen - Nun wird auf der Webseite ein Formular dargestellt, über welches ein Benutzer seine Adressangaben und die Angaben zu den Gruppendatenfeldern vornehmen kann. - Nach dem Absenden der Anmeldung gelangen die gemachten Angaben ins kool - Als Moderator des Leute-Moduls können Sie einzelne Anmeldungen annehmen oder ablehnen. Diese Anmeldungen gelangen direkt in die Adressdatenbank. EXT: kool_groupsubscribe - 1

2 Screenshots Anmeldeformular im Frontend. Die Detail-Angaben entsprechen den Gruppen-Datenfeldern aus kool. Einstellungen zum Plugin im Typo3: Anmeldungen im kool, die noch akzeptiert oder abgelehnt werden müssen: EXT: kool_groupsubscribe - 2

3 Users manual Hier erfahren Sie, wie Sie ein Anmeldeformular auf Ihrer Webseite einfügen können. Die Handhabung der Anmeldungen im kool ist in der kool-dokumentation des Leute-Moduls enthalten. 1. Plugin einfügen Fügen Sie auf einer Seite im Typo3 ein neues Inhaltselement vom Typ kool Gruppen-Anmeldung ein. 2. Einstellungen vornehmen Layout: Wählen Sie zwischen dem Anmeldeformular und der Weiterempfehlung Personenfelder: Wählen Sie die Felder, die der Benutzer ausfüllen soll. Die Reihenfolge im Auswahlfeld definiert die Reihenfolge, in der die Felder im Frontend erscheinen. Pflichtfelder: Diese Felder müssen im Formular ausgefüllt werden. Anmeldung für: Nach der Anmeldung soll der Benutzer dieser Gruppe/Rolle zugefügt werden. Wenn Sie mehrere Gruppen auswählen, werden diese in einer Auswahlbox dargestellt, damit der Benutzer eine davon auswählen kann. Rolle in Formular verstecken: Mit dieser Option kann die Rolle im Formular ausgeblendet werden, welcher die Anmeldung im kool zugewiesen wird. Ansonsten erscheint neben dem Gruppennamen auch die gewählte Rolle. Diese Gruppen-Datenfelder ausblenden: Falls Sie einige der Gruppen-Datenfelder im Formular nicht ausgegeben haben möchten, können Sie diese hier auswählen. Captcha-Bild verwenden: Mit dieser Option kann ein Captcha-Bild angezeigt werden, zu dem der Benutzer zum Abschicken der Abmeldung die Zeichen abtippen muss Als Spamschutz. Anmeldung für im FE ausblenden: Oberhalb des Anmeldeformulares wird ein Bereich Anmeldung für mit dem Gruppennamen dargestellt. Mit dieser Option kann dieser ausgeblendet werden. Dies geht nur bei einem Anmeldeformular für eine Gruppe, bei mehreren Gruppen wird diese Option ignoriert und ein Auswahlfeld für die gewählten Gruppen dargestellt. Zielseite: Definieren Sie eine TYPO3- Seite, die als Danke -Seite fungieren soll. Nach dem Absenden des Formulares wird dem Benutzer diese Seite angezeigt. Alternativ: Danke-Text: Wenn Sie keine Zielseite definieren, können Sie hier einen kurzen Danke-Text defineren, der nach dem Absenden des Formulares an dessen Stelle angezeigt wird. EXT: kool_groupsubscribe - 3

4 3. Weitere Einstellungen - -Empfänger bei Anmeldung: Zusätzlich zum Eintrag ins kool können Sie hier eine oder mehrere (durch Komma getrennte) adressen angeben, an welche bei einer Anmeldung ein Mail geschickt werden soll. - Betreff: Betreff des s, das nach erfolgter Anmeldung an die obige(n) Adresse(n) geschickt wird. - Zusätzlicher Text: Hier kann weiterer Text angegeben werden, falls nötig. Sonst wird Sonst werden einfach die gemachten Angaben aufgeführt. - an Benutzer nach Anmeldung: Mit dieser Option kann nach erfolgter Anmeldung (allenfalls erst nach Bestätigung) dem Anmeldenden ein geschickt werden, das nochmals alle gemachten Daten aufführt. - Betreff (Benutzer): Betreff des s an den Benutzer nach erfolgreicher Anmeldung. - Text (Benutzer): Text des s an den Benutzer. Die gemachten Angaben werden am Schluss angefügt. Bestätigung - Bestätigung per verlangen: Hiermit können Sie dem Benutzer nach der Anmeldung ein Bestätigungs zukommen lassen, das bestätigt werden muss, bevor der Benutzer ins kool gelangt. - Anmeldung direkt in kool speichern (ohne Moderation): Mit dieser Option wird die Anmeldung direkt im kool gespeichert, ohne dass diese erst von einem Moderator im kool bewilligt werden muss. - Betreff für Bestätigung: Betreff des s, das nach der Anmeldung an den Benutzer geschickt wird mit dem Aktivierungs-Link. - Text für Bestätigung: Text, dernach der Anmeldung an den Benutzer geschickt wird mit dem Aktivierungs- Link. Es können folgende Platzhalter verwendet werden: ###LINK###: Der Link für die Aktivierung. Dieser muss vorhanden sein. ###_SALUTATION###: Anrede: Sehr geehrter Herr oder Sehr geehrte Frau ###VORNAME### usw.: Alle Formularfelder können mit solchen Platzhaltern (in Grossbuchstaben) im verwendet werden. - Mit der Zielseite oder dem alternativen Text können Sie in diesem Fall einen Text ausgeben lassen, den der Benutzer nach der Bestätigung seiner Anmeldung sieht also etwas im Sinn von: Danke für die Bestätigung, ihr Account ist jetzt aktiviert. AGBs Wenn Sie hier eine Seite oder eine PDF-Datei angeben, erscheint im Anmeldeformular eine Checkbox, mit der der Benutzer die AGBs bestätigen muss, damit er die Anmeldung abschicken kann. Mit den Quick-Check Optionen können Sie pro Zeile einen Text angeben, der ebenfalls mittels einer Checkbox bestätigt werden muss, bevor die Anmeldung abgeschickt werden kann. Dies kann z.b. verwendet werden, um die wichtigsten Punkte aus den AGBs explizit bestätigen zu lassen. Weiterempfehlung Damit die Weiterempfehlung einen korrekten Link erstellen kann, der direkt auf die Registrierungsseite verweist, müssen Sie hier die Seite definieren, auf der die Registrierung erfolgt. Dies wird natürlich nur benötigt, wenn im Layout Weiterempfehlung ausgewählt wurde. Zusätzliche können Sie eine Zielseite definieren, auf die nach der Weiterempfehlung gesprungen werden soll. Die Weiterempfehlung funktioniert nur in Zusammenhang mit einem FE-Benutzer Login. Die Weiterempfehlung wird in einem solchen Fall dem eingeloggten Benutzer zugewiesen. Für eine allgemeine Seiten-Empfehlung sei auf die TYPO3-Extension tipafriend verwiesen. Configuration Reference - Reference (TypoScript) Property: Data type: Description: Default: layout string Layout für dieses Plugin: Mögliche Werte sind form und adv form recipients string Eine kommagetrennte Liste von empfängern, die beim Absenden des Formulares ein erhalten sollen. Wird durch allfälligen Eintrag bei den Plugin-Einstellungen überschrieben. from string Absender- adresse fromname string Name des Absenders user subject string Betreff des , das an den Benutzer geht, nach dessen erfolgreicher Anmeldung. Kann in der Flexform überschrieben werden. Your subscription EXT: kool_groupsubscribe - 4

5 Property: Data type: Description: Default: user text string Text des , das an den Benutzer geht, nach dessen erfolgreicher Anmeldung. Kann in der Flexform überschrieben werden. redirect page Seiten-ID der Seite, auf die nach dem Absenden der Anmeldung gesprungen werden soll. Wird durch allfälligen Eintrag bei den Plugin-Einstellungen überschrieben. donetext string Text, der nach Absenden der Anmeldung angezeigt werden soll, falls redirect nicht definiert ist. redirectconfirmed page Seiten-ID der Seite, auf die nach erfolgreicher Bestätigung verwiesen werden soll Thank you for your subscription! confirmedtext string Text, der alternativ nach erfolgter Bestätigung angezeigt werden soll Your subscription has been confirmed templatefile file Template-Datei für das Formular. EXT:tx_koolgroup subscribe/pi1/tem plate.tmpl groupselectstart int Gruppen-ID aus kool, bei der gestartet werden soll für die Gruppen- Selects im BE. Leer lassen, dass die ganze Gruppenhierarchie dargestellt wird (Start bei NULL) confirm boolean Definiert ob ein Bestätigungs- verschickt werden soll oder nicht, das einen Bestätigungs-Link enthält. Erst nach Klicken dieses Links ist die Anmeldung abgeschlossen. confirmsubject string Betreff des s, das für die Bestätigung der Anmeldung verschickt wird confirmtext string Text des s, das für die Bestätigung der Anmeldung verschickt wird nomoderation boolean Falls dieser Wert wahr ist, werden die Anmeldungen direkt im kool gespeichert ohne Moderation AGBPage page Seiten-ID für die AGBs AGBFile file File mit den AGBs AGBChecks string Quick-Check Optionen addfeuser boolean Soll bei erfolgter Anmeldung ein FE-User im TYPO3 erstellt werden, der als Login die -Adresse hat. Dazu muss die Extension kool_base installiert sein. Die Tabelle tx_koolbase_feusers_mm_koleute enthält die Verbindung zwischen den FE-Usern und den Adressdaten in kool. Pro Adresse kann nur ein Benutzer erstellt werden, deshalb ist pro Adresse nur eine Anmeldung möglich. FEUserPid page Seiten-ID der Seite, in der die neuen FE-User erstellt werden sollen FEUserGroup int Eine Gruppen-ID, zu der die neuen FE-User hinzugefügt werden. adv.registrationpid page Seiten-ID mit der Registrierungsseite. Damit wird der Link für das Weiterempfehlungs erstellt. adv.redirect page Zielseite, auf die nach der Weiterempfehlung gesprungen werden soll. adv. subject string Betreff des s für Weiterempfehlungen adv. text string Text des s für Weiterempfehlungen mandatoryfieldindicator string Zeichen, das die Pflichtfelder als solche markiert. * [tsref:(cobject).tx_koolgroupsubscribe_pi1] Mehrsprachige Formulare Die Formular-Felder werden primär gemäss den Einstellungen im kool übersetzt. D.h. wenn dort die aktuelle Webseiten- Sprache definiert ist, wird dieser Wert für das Formular-Feld verwendet. Falls nicht, wird die Übersetzung aus dem LL-File von TYPO3 verwendet. Die Übersetzung der Gruppen-Datenfelder geht nur über entsprechende LOCAL_LANG Definitionen im TypoScript Setup, da im kool keine Möglichkeit zur Übersetzung besteht. Dazu können die einzelnen Datenfelder wie folgt übersetzt werden: plugin.tx_koolgroupsubscribe_pi1._local_lang.en.datafield_bemerkungen = Comments Damit wird das Datenfeld mit der Bezeichnung Bemerkungen im Englischen mit Comments ausgegeben. Bei Datenfeldern, deren Bezeichnung Leer- oder Sonderzeichen enthalten, müssen diese ausgelassen werden, damit die Definition über TypoScript möglich bleibt. Z.B. wird aus Ich bringe mit als Datenfeld-Bezeichnung..._LOCAL_LANG.en.datafield_Ichbringemit, also ohne die Leerzeichen. Die einzelnen Optionen für ein Datenfeld vom Typ Auswahlliste oder Mehrfach-Auswahlliste können ebenfalls übersetzt werden. Dazu wird die Bezeichnung der Option nach einem Unterstrich _ angehängt: datafield_name_option. Tutorial Siehe Users manual EXT: kool_groupsubscribe - 5

6 Changelog : Gruppen-Datenfelder übersetzen lassen mittels TS-Setup. (0.2.7) : Check auf Gruppen-Id verbessert und Template mit Fehlermeldung versehen, falls keine Gruppe im Formular angewählt wurde (Version 0.2.6) : Verallgemeinerungen, damit Klasse von ko_igwevents erweitert werden kann (Version 0.2.5) : Versteckte Datenfelder nicht behandeln, damit sie in den Mails nicht erscheinen. (Version 0.2.3) : Inputfelder gemäss BE sortiert ausgeben (Version 0.2.2) : Datenfelder im FE-Formular ausblenden lassen, über FlexForm-Doubleselect. (Version 0.2.1) : an Benutzer nach Anmeldung : Bugfixes bezüglich RealURL, AGBs : AGBs, -Bestätigung, FE-User anlegen, Weiterempfehlungen : Erste Version mit Grundfunktionalitäten. EXT: kool_groupsubscribe - 6