Contao Community Documentation - Benutzerbeiträge [de]

MetaModels/Snippets

2014-09-02T16:39:35Z

Planepix: /* Snippets */

[[Category:Extensions]]
[[Category:MetaModels|B]]

=Snippets=

Eine Sammlung hilfreicher Codeschnipsel für MetaModels

==Darstellung im Frontend==
===Individueller Detaillink===
Mit einem Eintrag in die /system/langconfig.php ist es möglich, jedem MetaModel einen individuell angepassten Detaillink zu geben.

Beispiel:

'''$GLOBALS['TL_LANG']['MSC']['mm_meinmetamodel']['details'] = 'Mein Linktext';'''

=== Wert vorbelegen ===

Mit einem Eintrag in die /system/config/dcaconfig.php kann man Werte für Eingabefelder im Backend vorbelegen - beispielsweise ein Datiumsfeld mit dem aktúellen Datum:

'''$GLOBALS['TL_DCA']['mm_meinmetamodel']['fields']['meinattribut']['default'] = time();'''

== Templates ==

=== Links im Template zusammenbauen ===

Oft kommt es vor, dass man Detaillinks anpassen möchte - zum Beispiel im Multidomainkontext, oder falls man von der Übersichtsseite eines MetaModels A auf die Detailseite des Metamodels B springen möchte.

Grundsätzlich stehen in Contao dazu eine Reihe von Systemvariablen oder Insert-Tags zur Verfügung, die mann ggf. auch noch mit eigenen Insert-Tags (oder selbstdefinierten Variablen) erweitern kann. Einen Detailink kann man daher auch gut aufbauen, wenn man das Feld Alias eines referenzierten Metamodels nutzt.

Grundaufbau eines Links könnte dann sein:

<nowiki><a href="{{env::url}}/<sprachvariable>/<pfad/zur/detailseite>/<Alias-von-MetaModel-2>.<?php echo $GLOBALS['TL_CONFIG']['urlSuffix']; ?> />Linktext</a></nowiki>

Im Zusammenspiel beispielsweise mit der Erweiterung Inherit_Insert_Tags kann man dabei Variablen für das Sprachkürzel definieren oder einen individuellen Link zum Unterverzeichnis erstellen. Das Beispiel sieht dann wie folgt aus:

<nowiki><a href="{{env::url}}/{{iit::langvar}}/{{iit::detailpath}}/<?php echo $tags['mein_aliastag']; ?>.<?php echo $GLOBALS['TL_CONFIG']['urlSuffix']; ?> />Linktext</a></nowiki>

=== Bildunterschrift (Caption) in einer Galerie mit ausgeben ===

Will man die Bildunterschriften aus der Dateiverwaltung in einer Galerie mit ausgeben, kann man folgende Ergänzung im Template "mm_attr_file.html5" eintragen:

<nowiki><?php if (is_array($this->src)): ?>
<ul>
<?php foreach($this->src as $arrFile):
$strTitle = ($arrFile['title']) ? $arrFile['title'] : (($arrFile['alt']) ? $arrFile['alt'] : $arrFile['file']);
$strAlt = ($arrFile['caption']) ? $arrFile['caption'] : '';
?>
<li class="<?php echo $arrFile['class']; ?>">
<?php if ($this->settings->get('file_showLink')): ?>
<?php if ($this->settings->get('file_showImage')): ?>
<a class="cboxElement" data-lightbox="<?php echo $arrFile['lb']; ?>" title="<?php echo $strTitle; ?>" href="<?php echo $arrFile['file']; ?>">
<?php else: ?>
<a title="<?php echo $strTitle; ?>" href="<?php echo $arrFile['url']; ?>">
<?php endif; ?>
<?php endif; ?>

<?php if ($this->settings->get('file_showImage')): ?>
<?php if ($arrFile['isGdImage']): ?>
<?php echo $this->generateImage($arrFile['src'], $strAlt); ?>
<?php endif; ?>
<?php else: ?>
<img src="<?php echo $arrFile['icon']; ?>" alt="<?php echo $strAlt; ?>" /> <?php echo $strTitle; ?> <?php echo $arrFile['sizetext']; ?>
<?php endif; ?>

<?php if ($this->settings->get('file_showLink')): ?>
</a>
<?php endif; ?>
<figcaption><?php echo $arrFile['caption']; ?></figcaption>

</li>
<?php endforeach; ?>
</ul>
<?php endif; ?>
</nowiki>

Dieser Codesnippet '''<figcaption><?php echo $arrFile['caption']; ?></figcaption>''' wird vor dem schliessenden li integriert.
Nun werden die Bildunterschriften in der Galerie mit ausgegeben.

MetaModels/Snippets

2014-09-02T16:38:56Z

Planepix: /* Snippets */

EFG

2014-01-15T10:25:06Z

Planepix:

{{stub}}

'''EFG (Extended Form Generator)'''
Übertrag Handbuch EFG aus altem Wiki

'''Tickets / Bugs'''
https://bitbucket.org/thk/efg/issues

{{AppliesTo
|Version=2.9
}}

{{ExtInfo
| Dev=Thomas Kuhn
| ExtVersion=2.0.1 stable
| Version=2.7.0 - 3.0.5
| ERLink=http://www.contao.org/erweiterungsliste/view/efg.20000019.de.html
|Depending=[http://www.contao.org/erweiterungsliste/view/xls_export.de.html
}}
[[Kategorie:Extensions]]
== Was ist und was bietet EFG? ==
EFG steht für Extended Form Generator und erweitert den Contao Formular-Generator um die folgenden Features.

=== A - Bestätigung per Email ===
Contao bietet die Möglichkeit, nach Absenden eines Formulars im Frontend auf eine "Danke-Seite" weiterzuleiten, sowie eine E-Mail mit den übermittelten Daten an eine definierte E-Mail-Adresse zu versenden. Diese kann optional als Kopie auch an den Absender des Formulars geschickt werden.

EFG bietet darüberhinaus die Möglichkeit, eine E-Mail mit beliebigem Text-Inhalt an den Formular-Absender zu senden. Der Text und Betreff kann durch den Einsatz von "Insert-Tags" personalisiert werden.

Ab v1.8 können die "Insert-Tags" (wie in der Bestätigungs-Mail) auch auf der Bestätigungs-Seite verwendet werden.

=== B - Speichern eingehender "Formular-Daten", Erstellung von Backend-Modulen ===
EFG bietet im Formular-Generator eine weitere Option "Daten im Backend-Modul speichern".

Bei gewählter Option werden Backend-Module erzeugt, in denen die aus Frontend-Formularen eingehenden Daten verwaltet werden können.
Es ist ebenso möglich, neue Datensätze direkt im Backend anzulegen - auch ohne veröffentlichtes Frontend-Formular. Dadurch können nahezu beliebige Backend-Module/-Tabellen erstellt werden, einfach durch Anlegen eines Fomulars mit den benötigten Feldern. Manuelles Anlegen von Datenbank-Tabellen ist nicht erforderlich.

Zur Ausgabe und Bearbeitung der "Formular-Daten" im Frontend (mit Listen- und Detailansicht sowie Suche) steht letztlich noch ein spezielles Listing-Modul zur Verfügung.

=== C - zusätzliche Formularfeld-Typen ===
EFG stellt im Formular-Generator weitere Feld-Typen bereit:
* Select-Menü (DB)
* Radio-Button-Menü (DB) und
* Checkbox-Menü (DB)

Die im Frontend-Formular verfügbaren Optionen dieser Formular-Elemente werden aus beliebigen TL-Datenbank-Tabellen generiert (Angabe der Tabelle, des anzuzeigenden Feldes sowie optionaler Einschränkung zur Filterung der Werte)

[[Datei:Efg-be_formdatalisting_de.png]]

Dieser Feld-Typ erzeugt im Frontend-Formular eine Bilder-Galerie, ergänzt um Radio-Buttons zur Auswahl eines Bildes.

== Funktionsweise und Erläuterungen ==

'''Bestätigungs-Email'''

Hierfür stehen im Formular-Generator die im folgenden dargestellten Felder zur Verfügung.

'''Bestätigung per E-Mail versenden:'''

Nur wenn diese Option gewählt ist, wird eine Bestätigungs-E-Mail versendet und es stehen die weiteren Felder zur Verfügung:

'''Formularfeld der Empfänger-E-Mailadresse:'''

Hier muß das Formularfeld gewählt werden, das die E-Mail-Adresse des Frontend-Benutzers/Seitenbesuchers enthält

'''Absender:'''

Die E-Mail-Adresse, die als Absender der Bestätigungs-Mail verwendet wird
Verwendung von Insert-Tags möglich, siehe "Text der Bestätigungs-E-Mail"

'''Betreff:'''

Die Betreffzeile der Bestätigungs-Mail
Verwendung von Insert-Tags möglich, siehe "Text der Bestätigungs-E-Mail"

'''Text der Bestätigungs-E-Mail:'''

Der eigentliche Text (Mail-Body) der Bestätigungs-Email. Es können die allgemeinen "Insert-Tags" (siehe http://www.contao.org/inserttags.html ) zur Ausgabe von Datum o.ä. eingesetzt werden.

Weiterhin können die per Formular übermittelten Daten mit Insert-Tags der Form
<source>{{form::FELDNAME}}</source> im Text eingesetzt werden.

FELDNAME steht hierbei für den "Feldname", der im Formular-Generator für das jeweilige Formularfeld eingetragen wurde.

Enthält das Formular z.B. ein Feld mit Feldname "user_name", so wird das Insert Tag <source>{{form::user_name}}</source> im Text der Email durch den vom Formular-Absender angegebenen Namen ersetzt.

Datei-Uploads können als Anhang der Bestätigungs-Mail versendet werden, durch Einfügen von Insert-Tags der Form <source>{{form::FELDNAME?attachment=true}}</source>

'''HTML-Vorlage für die Bestätigungs-Email:'''

Falls die Bestätigungs-Email als HTML-Mail (bzw. als Multipart, sowohl Text- als auch HTML-Version) versendet werden soll, kann hier aus dem Dateisystem eine HTML-Datei gewählt werden.

Mit der Installation dieser Extension wird im Ordner "example_confirmation_mail" ein einfaches Beispiel für Testzwecke bereitgestellt. Die Verwendung der Insert-Tags ist auch in der HTML-Vorlage möglich.

[[Datei:Efg_form_options1_de.png|efg_form_options1_de.png]]

== Speichern von "Formular-Daten" im Backend, Erstellung von Backend-Modulen ==

'''"Formular-Daten" im Backend'''

EFG stellt im Formular-Generator eine zusätzliche Option zur Verfügung:

* Daten im Modul "Formular-Daten" speichern

[[Datei:Efg_form_options2_de.png|Efg_form_options2_de.png]]

Wenn diese Option aktiviert ist, werden über das Frontend-Formular übermittelte Daten in der Datenbank gespeichert und können im Backend verwaltet werden.
{{Hinweis|Nach Ergänzung oder Änderung von Formular-Feldern muß das Formular erneut gespeichert werden, oder aber diese Option erst nach Anlegen aller benötigten Formular-Felder gewählt werden.}}

'''Verwaltung der "Formular-Daten" im Backend'''

Sobald für mindestens ein Formular die Speicherung der "Formular-Daten" aktiviert ist, erscheint ein neuer Bereich in der Backend-Navigation, benannt als "Formular-Daten".

[[Datei:Efg_be_module_feedback.png|Efg_be_module_feedback.png]]

Jedes "daten-speichernde" Formular erzeugt darunter einen weiteren Eintrag (die Bezeichnung entspricht dabei dem Titel des Formulars).

Hier können die Daten bearbeitet/verändert und gelöscht werden. Auch Neuanlegen von Datensätzen, sowie Export der Daten im CSV-Format ist im Backend möglich.

Zusätzlich bietet der Navigations-Eintrag "Feedback" den gleichzeitigen Zugriff auf die aus verschiedenen Formularen gespeicherten Daten. Dies kann genutzt werden, wenn z.B. mehrere unterschiedliche "Anfrage"-Formulare im Einsatz sind. (Ein Neuanlegen von Daten ist allerdings nur in den formularspezifischen Listen-Ansichten möglich.)

----

'''Bearbeitung der Daten im Backend'''

[[Datei:Efg_be_formdata_edit_de.png|Efg_be_formdata_edit_de.png]]

Jeder Datensatz umfasst
* zusätzlich zu den per Formularfeld definierten - folgende Basis-/Metadaten:
* das Datum der Erstellung/Übermittlung des Datensatzes (Feldname "date") '''''*1'''''
* die IP-Adresse des Benutzers (Feldname "ip") '''''*1'''''
* eine Checkbox "Veröffentlicht" (Feldname: "published", Vorgabewert: nicht veröffentlicht, kann wie bei Artikeln z.B. in Verbindung mit Auflistung-Modul als Kriterium für Anzeige im Frontend dienen) '''''*2'''''
* ein Textfeld "Bemerkung" (Feldname: "be_notes") '''''*2'''''

'''''*1''''' - diese Felder sind im Frontend-Formular nicht verfügbar; sie werden sowohl per Frontend-Formular als auch bei Daten-Erfassung im Backend automatisch befüllt

'''''*2''''' - diese Felder sind im Frontend-Formular nicht verfügbar, können aber z.B. in Verbindung mit Auflistungs-Modul Verwendung finden

----

'''Frontend-Modul "Auflistung Formular-Daten"'''

Zur Ausgabe der "Formular-Daten" im Frontend steht ein Ausgabe-Modul "Auflistung Fomular-Daten" zur Verfügung. Die Anwendung und Funktionsweise entspricht dem Modul "Auflistung".
Optional kann die Bearbeitung und das Löschen der Daten im Frontend ermöglicht werden (wahlweise öffentlich, nur Daten der eigenen Mitglieder-Gruppe oder nur eigene Daten).

[[Datei:efg-be_formdatalisting_de.png|efg-be_formdatalisting_de.png]]

Anstelle von Datenbank-Feldnamen wird bei den Angaben "Felder", "Bedingung", "Sortieren nach", "Durchsuchbare Felder" und "Felder der Detailseite" der im Formular-Generator für das jeweilige Formularfeld eingetragene "Feldname" verwendet.

== Lizenz ==
EFG wird der Contao Community unter der gleichen Lizenz wie Contao zur Verfügung gestellt (LGPL).

== Autor der Erweiterung EFG ==
Thomas Kuhn

== Weiterführende Links ==
Auf dem TYPOlight-Usertreffen 2009 in Frankfurt am Main wurde die Erweiterung EFG mit Praxisbeispielen vorgestellt. Die dazu gehörenden Informationen sind auf http://www.tl-usertreffen.weitzeldesign.com/usertreffen-2009.html zu finden.
----

--[[Benutzer:Planepix|Planepix]] 15:04, 12. Mär. 2011 (CET)

Suchfunktion integrieren

2012-12-05T19:37:27Z

Planepix:

[[Category:Admin HOWTOS]]
{{AppliesTo|TLVersion=ab 2.6|Version=ab 2.9}}
== Suchfunktion in eine Website integrieren ==

Die Suchfunktion soll im Kopfbereich platziert und die Ausgabe der Suchergebnisse in der Hauptspalte ausgeben werden?

# Zunächst wird ein Modul vom Typ '''Suchmaschine''' erstellt.
#:''(Layout > Themes > Module > Neues Modul erstellen > Modultyp = Suchmaschine)''
# Das Modul '''Suchmaschine''' wird in einen Artikel eingefügt. Dazu wird zuerst eine neue Seite in der Seitenstruktur angelegt, z.B. ''Suche'' und unter den Experteneinstellungen die Option '''Im Menü verstecken''' angeklickt sowie die Option ''Veröffentlichung der Seite'' ausgewählt.
#:''(Inhalt > Artikel > Artikel bearbeiten > Neues Inhaltselement > Elementtyp = Modul > Suchmaschine)''
# Mit dem Formulargenerator wird ein einfaches Formular, z.B. Sucheingabe benannt, mit einem Textfeld und einem Absendebutton erstellt. ''(Inhalt > Formulargenerator > Neues Formular)''
#* Im Formularkopf wird unter der Rubrik '''Experten-Einstellungen''' im Feld '''Formular-ID''' der Wert ''tl_search'' eingegeben und als '''Übertragungsmethode''' ''GET'' gewählt.
#* Als Weiterleitungsseite wird die Seite (z.B. Suche) ausgewählt, die das Modul Suchmaschine beinhaltet und die Suchergebnisse anzeigt.
#* Der Feldnamen für das Textfeld wird ''keywords'' benannt.
# Für das Formular wird ein Modul (z.B. Sucheingabe benannt) erstellt, um es z.B. im Kopfbereich (#header) ausgeben zu können.
#:''(Layout > Themes > Module > Neues Modul erstellen > Modultyp = Form > das Formular auswählen.)''
# Das Modul Sucheingabe wird nun im Seitenlayout eingefügt und diesem Modul der Ausgabebereich zugewiesen; z.B. Kopfzeile (#header).
#:''(Layout > Themes > Seitenlayout > Seitenlayout bearbeiten)''

Somit kann die Sucheingabe in der Kopfzeile platziert und die Suchergebnisse in der Hauptspalte ausgeben werden.

==Ergänzung 5.12.12:==
Für den Einsatz bei neueren Contao-Versionen wurde ein Bug behoben, so das nun das Auswählen einer Weiterleitungsseite nicht mehr wie oben beschrieben zum gewünschten Ergebnis führt.
Wie es besser geht hat Peter Müller auf seinem Blog beschrieben:

http://websites-erstellen-mit-contao.de/magazin/articles/kapitel-12-suchfunktion.html

----
--[[Benutzer:Planepix|Planepix]] 23:01, 4. Jul. 2010 (CEST) – Übersetzt und angepasst nach einem Tutorial von Ben Robinson.

== SEO Maßnahme: Suchergebnisse in Datenbank speichern ==

Oft ist es für Onpage Optimierungen sinnvoll, wenn man weiß was/wann die Besucher (et)was in den Suchschlitz schreiben. Hierzu habe ich mir folgendermaßen beholfen:

# Neue Tabelle mit Zwei Spalten in Datenbank hinzugefügt (ohne tl_ Präfix). 
# Spalte 1 mit dem Namen "date" und dem Typ "date", Spalte 2 mit dem Namen "keywords"und dem Typ "tinytext". 
# Das Formular mit dem Suchfeld bearbeiten. 
# Den Formularheader bearbeiten und unter: "Formulardaten speichern", "Eingaben speichern" wählen und die neue Zieltabelle wählen. 
# Verstecktes Feld vor dem Suchfeld einfügen mit dem Feldnamen "date" und dem Standardwert <nowiki>{{date::Y-m-d}}</nowiki>.

Nach dem Speichern werden sämtliche Suchanfragen des Suchfeldes im Header in die Datenbanktabelle geschrieben. Diese ließen sich z.B. auch in einem geschützten Bereich wieder ausgeben.

----

[[Benutzer:carino|carino]] 15:08, 14. Jul. 2010 (CEST)

MetaModels

2012-11-28T10:29:24Z

Planepix:

{{stub}}
[[Category:Extensions]]
[[Category:MetaModels]]
{{ExtInfo
| Dev=Metamodels Team
| DevSite=
| Version=ab 2.11.X
| ERLink=
| VCSLink=https://github.com/MetaModels/core
| TrackerLink=https://github.com/MetaModels/core/issues
| Depending=[[DC_General]] [[Justtextwidgets]] [[MultiColumnWizard]] [[MetaPalettes]]
}}

=Start der Wiki-Dokumentation der Erweiterung MetaModels (Nachfolger des Catalog)=

{{Hinweis|Installation von MetaModels aus GitHub}}

Zu finden ist die Erweiterung MetaModels auf GitHub:
[https://github.com/MetaModels]

Aktuell wird diese und dazu abhängige weitere Erweiterungen manuell installiert.

Benötigt werden folgende Erweiterungen:

* [https://github.com/MetaModels/core Das Core-Modul]
* [https://github.com/MetaModels DC_General]
* [https://contao.org/de/extension-list/view/MetaPalettes.html MetaPalettes]
* [http://www.contao.org/erweiterungsliste/view/MultiColumnWizard.html MultiColumnWizard],
* [https://github.com/Discordier/justtextwidgets justtextwidgets]

==Verfügbare Attribute==

Sobald diese Erweiterungen installiert sind, werde die weiteren Attributsextensions des MetaModels benötigt.
Dazu gehören:

* [https://github.com/MetaModels/attribute_text Attribut: Text]
* [https://github.com/MetaModels/attribute_checkbox Attribut: Checkbox]
* [https://github.com/MetaModels/attribute_decimal Attribut: Dezimal]
* [https://github.com/MetaModels/attribute_file Attribut: Dateien]
* [https://github.com/MetaModels/attribute_select Attribut: Select]
* [https://github.com/MetaModels/attribute_alias Attribut: Alias]
* [https://github.com/MetaModels/attribute_longtext Attribut: Langtext]
* [https://github.com/MetaModels/attribute_numeric Attribut: Numerisch]
* [https://github.com/MetaModels/attribute_langcode Attribut: Sprachencode]
* [https://github.com/MetaModels/attribute_tags Attribut: Tags]
* [https://github.com/MetaModels/attribute_geoprotection Attribut: Länderzuordnung]

* [https://github.com/MetaModels/attribute_translatedalias Attribut: Translated Alias]
* [https://github.com/MetaModels/attribute_translatedfile Attribut: Translated File]
* [https://github.com/MetaModels/attribute_translatedlongtext Attribut: Translated Longtext]
* [https://github.com/MetaModels/attribute_translatedselect Attribut: Translated Select]
* [https://github.com/MetaModels/attribute_translatedtags Attribut: Translated Tags]
* [https://github.com/MetaModels/attribute_translatedtext Attribut: Translated Text]

----
started by: [[Benutzer:Planepix|Planepix]] 00:49, 28. Nov. 2012 (CET)

MetaModels

2012-11-28T10:26:15Z

Planepix: /* Verfügbare Attribute */

{{stub}}
[[Category:Extensions]]
[[Category:MetaModels]]
{{ExtInfo
| Dev=Metamodels Team
| DevSite=
| Version=ab 2.11.X
| ERLink=
| VCSLink=https://github.com/MetaModels/core
| TrackerLink=https://github.com/MetaModels/core/issues
| Depending=[[DC_General]] [[Justtextwidgets]] [[MultiColumnWizard]] [[MetaPalettes]]
}}

=Start der Wiki-Dokumentation der Erweiterung MetaModels (Nachfolger des Catalog)=

{{Hinweis|Installation von MetaModels aus GitHub}}

Zu finden ist die Erweiterung MetaModels auf GitHub:
[https://github.com/MetaModels]

Aktuell wird diese und dazu abhängige weitere Erweiterungen manuell installiert.

Benötigt werden folgende Erweiterungen:

[https://github.com/MetaModels/core Das Core-Modul]

[https://github.com/MetaModels DC_General]

[https://contao.org/de/extension-list/view/MetaPalettes.html MetaPalettes]

[http://www.contao.org/erweiterungsliste/view/MultiColumnWizard.html MultiColumnWizard],
siehe auch [http://de.contaowiki.org/MultiColumnWizard]

[https://github.com/Discordier/justtextwidgets justtextwidgets]

==Verfügbare Attribute==

Sobald diese 3 Erweiterungen installiert sind, werde die weiteren Attributsextensions des MetaModels benötigt.
Dazu gehören:

[https://github.com/MetaModels/attribute_text Attribut: Text]
[https://github.com/MetaModels/attribute_checkbox Attribut: Checkbox]
[https://github.com/MetaModels/attribute_decimal Attribut: Dezimal]
[https://github.com/MetaModels/attribute_file Attribut: Dateien]
[https://github.com/MetaModels/attribute_select Attribut: Select]
[https://github.com/MetaModels/attribute_alias Attribut: Alias]
[https://github.com/MetaModels/attribute_longtext Attribut: Langtext]
[https://github.com/MetaModels/attribute_numeric Attribut: Numerisch]
[https://github.com/MetaModels/attribute_langcode Attribut: Sprachencode]
[https://github.com/MetaModels/attribute_tags Attribut: Tags]
[https://github.com/MetaModels/attribute_geoprotection Attribut: Länderzuordnung]

[https://github.com/MetaModels/attribute_translatedalias Attribut: Translated Alias]
[https://github.com/MetaModels/attribute_translatedfile Attribut: Translated File]
[https://github.com/MetaModels/attribute_translatedlongtext Attribut: Translated Longtext]
[https://github.com/MetaModels/attribute_translatedselect Attribut: Translated Select]
[https://github.com/MetaModels/attribute_translatedtags Attribut: Translated Tags]
[https://github.com/MetaModels/attribute_translatedtext Attribut: Translated Text]

----
started by: [[Benutzer:Planepix|Planepix]] 00:49, 28. Nov. 2012 (CET)

Planepix:

{{stub}}

{{AppliesTo
|Version=2.9
}}

'''EFG (Extended Form Generator) - Entwickler Thomas Kuhn'''

Übertrag Handbuch EFG aus altem Wiki

====== Was ist und was bietet EFG? ======
EFG steht für Extended Form Generator und erweitert den Contao Formular-Generator um die folgenden Features.

===== A - Bestätigung per Email =====
Contao bietet die Möglichkeit, nach Absenden eines Formulars im Frontend auf eine "Danke-Seite" weiterzuleiten, sowie eine E-Mail mit den übermittelten Daten an eine definierte E-Mail-Adresse zu versenden. Diese kann optional als Kopie auch an den Absender des Formulars geschickt werden.

EFG bietet darüberhinaus die Möglichkeit, eine E-Mail mit beliebigem Text-Inhalt an den Formular-Absender zu senden. Der Text und Betreff kann durch den Einsatz von "Insert-Tags" personalisiert werden.

Ab v1.8 können die "Insert-Tags" (wie in der Bestätigungs-Mail) auch auf der Bestätigungs-Seite verwendet werden.

===== B - Speichern eingehender "Formular-Daten", Erstellung von Backend-Modulen =====
EFG bietet im Formular-Generator eine weitere Option "Daten im Backend-Modul speichern".

Bei gewählter Option werden Backend-Module erzeugt, in denen die aus Frontend-Formularen eingehenden Daten
verwaltet werden können.
Es ist ebenso möglich, neue Datensätze direkt im Backend anzulegen - auch ohne veröffentlichtes Frontend-Formular. Dadurch können nahezu beliebige Backend-Module/-Tabellen erstellt werden, einfach durch Anlegen eines Fomulars mit den benötigten Feldern. Manuelles Anlegen von Datenbank-Tabellen ist nicht erforderlich.

Zur Ausgabe und Bearbeitung der "Formular-Daten" im Frontend (mit Listen- und Detailansicht sowie Suche) steht letztlich noch ein spezielles Listing-Modul zur Verfügung.

===== C - zusätzliche Formularfeld-Typen =====
EFG stellt im Formular-Generator weitere Feld-Typen bereit:
* Select-Menü (DB)
* Radio-Button-Menü (DB) und
* Checkbox-Menü (DB)

Die im Frontend-Formular verfügbaren Optionen dieser Formular-Elemente werden aus beliebigen TL-Datenbank-Tabellen generiert (Angabe der Tabelle, des anzuzeigenden Feldes sowie optionaler Einschränkung zur Filterung der Werte)

[[Datei:Efg-be_formdatalisting_de.png]]

Dieser Feld-Typ erzeugt im Frontend-Formular eine Bilder-Galerie, ergänzt um Radio-Buttons zur Auswahl eines Bildes.

===== Funktionsweise und Erläuterungen =====

'''Bestätigungs-Email'''

Hierfür stehen im Formular-Generator die im folgenden dargestellten Felder zur Verfügung.

'''Bestätigung per E-Mail versenden:'''

Nur wenn diese Option gewählt ist, wird eine Bestätigungs-E-Mail versendet und es stehen die weiteren Felder zur Verfügung:

'''Formularfeld der Empfänger-E-Mailadresse:'''

Hier muß das Formularfeld gewählt werden, das die E-Mail-Adresse des Frontend-Benutzers/Seitenbesuchers enthält

'''Absender:'''

Die E-Mail-Adresse, die als Absender der Bestätigungs-Mail verwendet wird
Verwendung von Insert-Tags möglich, siehe "Text der Bestätigungs-E-Mail"

'''Betreff:'''

Die Betreffzeile der Bestätigungs-Mail
Verwendung von Insert-Tags möglich, siehe "Text der Bestätigungs-E-Mail"

'''Text der Bestätigungs-E-Mail:'''

Der eigentliche Text (Mail-Body) der Bestätigungs-Email. Es können die allgemeinen "Insert-Tags" (siehe http://www.contao.org/inserttags.html ) zur Ausgabe von Datum o.ä. eingesetzt werden.

Weiterhin können die per Formular übermittelten Daten mit Insert-Tags der Form
<source>{{form::FELDNAME}}</source> im Text eingesetzt werden.

FELDNAME steht hierbei für den "Feldname", der im Formular-Generator für das jeweilige Formularfeld eingetragen wurde.

Enthält das Formular z.B. ein Feld mit Feldname "user_name", so wird das Insert Tag <source>{{form::user_name}}</source> im Text der Email durch den vom Formular-Absender angegebenen Namen ersetzt.

Datei-Uploads können als Anhang der Bestätigungs-Mail versendet werden, durch Einfügen von Insert-Tags der Form <source>{{form::FELDNAME?attachement=true}}</source>

'''HTML-Vorlage für die Bestätigungs-Email:'''

Falls die Bestätigungs-Email als HTML-Mail (bzw. als Multipart, sowohl Text- als auch HTML-Version) versendet werden soll, kann hier aus dem Dateisystem eine HTML-Datei gewählt werden.

Mit der Installation dieser Extension wird im Ordner "example_confirmation_mail" ein einfaches Beispiel für Testzwecke bereitgestellt. Die Verwendung der Insert-Tags ist auch in der HTML-Vorlage möglich.

[[Datei:Efg_form_options1_de.png|efg_form_options1_de.png]]

===== Speichern von "Formular-Daten" im Backend, Erstellung von Backend-Modulen =====

'''"Formular-Daten" im Backend'''

EFG stellt im Formular-Generator eine zusätzliche Option zur Verfügung:

* Daten im Modul "Formular-Daten" speichern

[[Datei:Efg_form_options2_de.png|Efg_form_options2_de.png]]

Wenn diese Option aktiviert ist, werden über das Frontend-Formular übermittelte Daten in der Datenbank gespeichert und können im Backend verwaltet werden.
<note important>Nach Ergänzung oder Änderung von Formular-Feldern muß das Formular erneut gespeichert werden, oder aber diese Option erst nach Anlegen aller benötigten Formular-Felder gewählt werden.</note>

----
\\ **Verwaltung der "Formular-Daten" im Backend**
\\
Sobald für mindestens ein Formular die Speicherung der "Formular-Daten" aktiviert ist, erscheint ein neuer Bereich in der Backend-Navigation, benannt als "Formular-Daten".

[[Datei:Efg_be_module_feedback.png|Efg_be_module_feedback.png]]

Jedes "daten-speichernde" Formular erzeugt darunter einen weiteren Eintrag (die Bezeichnung entspricht dabei dem Titel des Formulars).\\ Hier können die Daten bearbeitet/verändert und gelöscht werden. Auch Neuanlegen von Datensätzen, sowie Export der Daten im CSV-Format ist im Backend möglich.\\ Zusätzlich bietet der Navigations-Eintrag "Feedback" den gleichzeitigen Zugriff auf die aus verschiedenen Formularen gespeicherten Daten. Dies kann genutzt werden, wenn z.B. mehrere unterschiedliche "Anfrage"-Formulare im Einsatz sind. (Ein Neuanlegen von Daten ist allerdings nur in den formularspezifischen Listen-Ansichten möglich.)

----
\\
**Bearbeitung der Daten im Backend**\\
[[Datei:Efg_be_formdata_edit_de.png|Efg_be_formdata_edit_de.png]]

Jeder Datensatz umfaßt -zusätzlich zu den per Formularfeld definierten- folgende Basis-/Metadaten:
- das Datum der Erstellung/Übermittlung des Datensatzes (Feldname "date") *1
- die IP-Adresse des Benutzers (Feldname "ip") *1
- eine Checkbox "Veröffentlicht" (Feldname: "published", Vorgabewert: nicht veröffentlicht, kann wie bei Artikeln z.B. in Verbindung mit Auflistung-Modul als Kriterium für Anzeige im Frontend dienen) *2
- ein Textfeld "Bemerkung" (Feldname: "be_notes") *2

*1 - diese Felder sind im Frontend-Formular nicht verfügbar; sie werden sowohl per Frontend-Formular als auch bei Daten-Erfassung im Backend automatisch befüllt\\
*2 - diese Felder sind im Frontend-Formular nicht verfügbar, können aber z.B. in Verbindung mit Auflistungs-Modul Verwendung finden

----
\\
**Frontend-Modul "Auflistung Formular-Daten"**\\
Zur Ausgabe der "Formular-Daten" im Frontend steht ein Ausgabe-Modul "Auflistung Fomular-Daten" zur Verfügung. Die Anwendung und Funktionsweise entspricht dem Modul "Auflistung".
Optional kann die Bearbeitung und das Löschen der Daten im Frontend ermöglicht werden (wahlweise öffentlich, nur Daten der eigenen Mitglieder-Gruppe oder nur eigene Daten).
[[Datei:efg-be_formdatalisting_de.png|efg-be_formdatalisting_de.png]]

Anstelle von Datenbank-Feldnamen wird bei den Angaben "Felder", "Bedingung", "Sortieren nach", "Durchsuchbare Felder" und "Felder der Detailseite" der im Formular-Generator für das jeweilige Formularfeld eingetragene "Feldname" verwendet.

===== Lizenz =====
EFG wird der Contao Community unter der gleichen Lizenz wie Contao zur Verfügung gestellt (LGPL).

===== Autor =====
Thomas Kuhn

--[[Benutzer:Planepix|Planepix]] 19:52, 9. Mär. 2011 (CET)

2011-03-11T20:15:36Z

Planepix: /* Bestätigungs-Email */

EFG

2011-03-11T20:15:08Z

Planepix: /* Bestätigungs-Email */