MetaModels Beispiel 1: Unterschied zwischen den Versionen

Aus Contao Community Documentation

(Vorgehensschritte)
K
 
(31 dazwischenliegende Versionen von 5 Benutzern werden nicht angezeigt)
Zeile 1: Zeile 1:
[[Category:Admin HOWTOS]]
+
{{Hinweis|Die Angaben, Beschreibungen und Screenshot beziehen sich auf MetaModels bis etwa Mitte 2016 und sind nicht aktuell!
[[Category:MetaModels]]
+
Im [http://metamodels.readthedocs.io/de/latest/ MetaModels-Handbuch] sind aktuelle Angaben zu finden.}}
  
 +
[[Category:Admin HOWTOS]]
 +
[[Category:MetaModels|B]]
 
=Aufgabenstellung: Backend einrichten=
 
=Aufgabenstellung: Backend einrichten=
 
Als Beispielprojekt soll eine einfache "Musikbox" gebaut werden, in der Musikstücke mit gewissen Attributen ("Eigenschaften") erfasst werden. Zu diesem Zweck wird zuerst das Backend aufgebaut. Hierzu braucht man eine Übersichtsliste und ein Erfassungsformular.
 
Als Beispielprojekt soll eine einfache "Musikbox" gebaut werden, in der Musikstücke mit gewissen Attributen ("Eigenschaften") erfasst werden. Zu diesem Zweck wird zuerst das Backend aufgebaut. Hierzu braucht man eine Übersichtsliste und ein Erfassungsformular.
Zeile 7: Zeile 9:
 
===Vorgehensschritte===
 
===Vorgehensschritte===
 
# [[MetaModels|Start: Installation]] - Download und Installation von MetaModels
 
# [[MetaModels|Start: Installation]] - Download und Installation von MetaModels
# [[MetaModels_Beispiel_1|Beispiel 1: Backend einrichten]] - Eingeben der Sammlung
+
# [[MetaModels_Beispiel_1|Beispiel 1: Backend einrichten]] - MetaModel erstellen, Daten erfassen
 
# [[MetaModels_Beispiel_2|Beispiel 2: Frontend einrichten]] - Die Inhalte im Frontend anzeigen (Liste und Detail)
 
# [[MetaModels_Beispiel_2|Beispiel 2: Frontend einrichten]] - Die Inhalte im Frontend anzeigen (Liste und Detail)
 
# [[MetaModels_Beispiel_3|Beispiel 3: Weitere Filter einrichten]] – Inhalte auf Published setzen, einfache Select-Filter
 
# [[MetaModels_Beispiel_3|Beispiel 3: Weitere Filter einrichten]] – Inhalte auf Published setzen, einfache Select-Filter
 
# [[MetaModels_Beispiel_4|Beispiel 4: Weiteres MetaModels einrichten]] - komplexe Select-Filter einsetzen
 
# [[MetaModels_Beispiel_4|Beispiel 4: Weiteres MetaModels einrichten]] - komplexe Select-Filter einsetzen
# [[MetaModels_Beispiel:_Übersetzter_select|Weiteres Beispiel: Übersetzter select]] - Mehrsprachiges Select-Attribut einrichten
 
  
 
=Eine leere Datenbank erstellen=
 
=Eine leere Datenbank erstellen=
Zeile 25: Zeile 26:
 
===Anmerkungen===
 
===Anmerkungen===
  
* Obwohl es so aussieht, als sei '''Übersetzung''' eine frei wählbare Option, ist "diese Option" ein MUSS, denn ohne Sprachenzuweisung funktioniert das ganze MetaModel nicht!
+
* In unserem Beispiel aktivieren wir die Mehrsprachigkeit, um nachträglich weitere Sprachen anlegen zu können. Falls man im Vorfeld weiß, dass man keine weiteren Sprachen benötigt, muss der Haken nicht gesetzt werden. MetaModels ist auch ohne Mehrprachigkeit komplett funktionstüchtig.
 
* '''Varianten unterstützen''' wird vorläufig nicht benötigt.... und gegebenenfalls zu einem späteren Zeitpunkt erläutert.
 
* '''Varianten unterstützen''' wird vorläufig nicht benötigt.... und gegebenenfalls zu einem späteren Zeitpunkt erläutert.
  
Zeile 46: Zeile 47:
 
[[File:icons_bearbeiten.png|left|32px]]
 
[[File:icons_bearbeiten.png|left|32px]]
  
Hier gelangt man wieder zurück zum gleichen Screen, wie bie der Erstellung eines neuen MetaModels. Hier kann man jederzeit sowohl den '''Namen''' als auch den '''Tabellennamen''' des MetaModels ändern.
+
Hier gelangt man wieder zurück zum gleichen Screen, wie bei der Erstellung eines neuen MetaModels. Hier kann man jederzeit sowohl den '''Namen''' als auch den '''Tabellennamen''' des MetaModels ändern.
  
# [[MetaModels_Backend:_Attribute|'''Attribute''']] (Definieren Sie die Attribute in MetaModel)
+
# [[MetaModels_Backend:_Attribute|'''Attribute''']] (Attribute für MetaModel ID x definieren)
# [[MetaModels_Backend:_Ausgabevorgaben|'''Ausgabevorgaben''']] (Definieren Sie Ausgabevorgaben für das MetaModel)
+
# [[MetaModels_Backend:_Ausgabevorgaben|'''Ausgabevorgaben''']] (Render-Einstellungen für MetaModel ID x definieren)
# [[MetaModels_Backend:_Paletteneinstellungen|'''Paletteneinstellungen''']] (Paletteneinstellungen für das MetaModel definieren)
+
# [[MetaModels_Backend:_Eingabemaske|'''Eingabemaske''']] (Eingabemaske für das MetaModel ID x definieren)
# [[MetaModels_Backend:_Filter|'''Filter''']] (Definieren Sie Filter für das MetaModel)
+
# [[MetaModels_Backend:_Filter|'''Filter''']] (Filter für MetaModel ID x definieren)
# [[MetaModels_Backend:_Ansichtseinstellungen|'''Paletten- und Ansichtseinstellungen''']] (Paletten- und Ansichtseinstellungen für MetaModel festlegen)
+
# [[MetaModels_Backend:_Ansichtseinstellungen|'''Paletten- und Ansichtseinstellungen''']] (Definieren Sie die Eingabe- / Ausgabe-Optionen für MetaModel ID x)
  
 
=Das Backend konfigurieren=
 
=Das Backend konfigurieren=
Zeile 133: Zeile 134:
 
<div>
 
<div>
  
==MM-Funktion: Ausgabevorgaben==
+
==MM-Funktion: Ausgabevorgaben (aka Render-Einstellungen)==
 
[[File:icons_ausgabevorgaben.png|left|32px]]
 
[[File:icons_ausgabevorgaben.png|left|32px]]
 
Hier wird die Ansicht erfasst: Eine Listendarstellung für das Backend.
 
Hier wird die Ansicht erfasst: Eine Listendarstellung für das Backend.
Zeile 139: Zeile 140:
 
[[File:mm_ausgabe_definieren.png|right|thumb|400px]]
 
[[File:mm_ausgabe_definieren.png|right|thumb|400px]]
  
* Klick auf '''neu'''
+
* Auf '''neu''' klicken
 
* '''BE Listenansicht''' eingeben
 
* '''BE Listenansicht''' eingeben
 
* Der Rest kann so stehen bleiben, denn für die BE Listenansicht braucht man weder eine '''Zielseite''' noch '''Filter settings'''.
 
* Der Rest kann so stehen bleiben, denn für die BE Listenansicht braucht man weder eine '''Zielseite''' noch '''Filter settings'''.
Zeile 163: Zeile 164:
 
</div>
 
</div>
  
==MM-Funktion: Paletteneinstellung==
+
==MM-Funktion: Eingabemaske (fka Paletteneinstellungen)==
  
 
[[File:icons_paletteneinstellungen.png|left|32px]]
 
[[File:icons_paletteneinstellungen.png|left|32px]]
Zeile 171: Zeile 172:
 
===BE-Liste===
 
===BE-Liste===
 
[[File:mm_paletten_BE_liste.png|thumb|400px]]
 
[[File:mm_paletten_BE_liste.png|thumb|400px]]
Nach Klick auf '''Neue Palette''' öffnet sich ein [[MetaModels_Backend:_Paletteneinstellungen|Erfassungsformular]]. Hier die Werte eingeben, wie nebenan abgebildet:
+
Nach Klick auf '''Neue Eingabemaske''' öffnet sich ein [[MetaModels_Backend:_Eingabemaske|Erfassungsformular]]. Hier die Werte eingeben, wie nebenan abgebildet:
 
* Name: '''BE Erfassung'''
 
* Name: '''BE Erfassung'''
 
* Option '''Als Standard benutzen'''
 
* Option '''Als Standard benutzen'''
Zeile 185: Zeile 186:
 
* Backend-Beschreibung: wie abgebildet
 
* Backend-Beschreibung: wie abgebildet
  
===Anmerkung===
 
Die Option '''Sortierung''' ist beim erstmaligen Bearbeiten der Seite noch nicht sichtbar. Es empfiehlt sich daher, nach Auswahl des '''Backend-Bereich'''s (hier: Inhalte) die Seite zu speichern. Jetzt kann die Sortierung festgelegt werden.
 
 
Nun wurde eine Palette namens '''BE Erfassung''' erstellt. Im Folgenden wird nun das Erfassungs-Formular ein wenig gestaltet.
 
  
 +
Nun wurde eine Eingabemaske namens '''BE Erfassung''' erstellt. Im Folgenden wird nun das Erfassungs-Formular ein wenig gestaltet.<br>
 
Im letzten Kapitel auf dieser Seite ('''Die Daten erfassen''') sieht man, wie die Liste/das Formular zwecks Erfassung der Musikstücke aussieht.
 
Im letzten Kapitel auf dieser Seite ('''Die Daten erfassen''') sieht man, wie die Liste/das Formular zwecks Erfassung der Musikstücke aussieht.
 +
{{Hinweis|Mit der Erweiterung '''MetaModels Boilerplate''' (Nightly Build) kann man die MetaModels in einem separaten '''Backend-Bereich''' in der BE-Navigation unterbringen.}}{{Hinweis|Die Option '''Sortierung''' ist beim erstmaligen Bearbeiten der Seite noch nicht sichtbar. Es empfiehlt sich daher, nach Auswahl des '''Backend-Bereich'''s (hier: Inhalte) die Seite zu speichern. Jetzt kann die Sortierung festgelegt werden.}}
 
<div style="clear: both"></div>
 
<div style="clear: both"></div>
  
Zeile 199: Zeile 198:
 
* '''Alle hinzufügen''' wählen und alle nun folgenden Screens bestätigen.
 
* '''Alle hinzufügen''' wählen und alle nun folgenden Screens bestätigen.
 
* Man erhält so eine Liste aller Attribute, die man einzeln bearbeiten kann.
 
* Man erhält so eine Liste aller Attribute, die man einzeln bearbeiten kann.
* Auf Wunsch kan man hier auch die Reihenfolge umstellen und so bestimmen, wie die Daten erfasst werden sollen.
+
* Auf Wunsch kann man hier auch die Reihenfolge umstellen und so bestimmen, wie die Daten erfasst werden sollen.
 
* Angefangen wird mit dem ersten Eintrag '''Titel [text]'''
 
* Angefangen wird mit dem ersten Eintrag '''Titel [text]'''
 
<div style="clear: both"></div>
 
<div style="clear: both"></div>
Zeile 218: Zeile 217:
 
Hier legt man fest, wer im Backend auf die Daten von MetaModel zugreifen und diese editieren darf.
 
Hier legt man fest, wer im Backend auf die Daten von MetaModel zugreifen und diese editieren darf.
  
[[File:mm_backend_zugriffsrechte_definieren.png|link=MetaModels_Backend:_Ansichtseinstellungen|600px]]
+
[[File:mm_neues_metamodel_ansichtseinstellungen.png|730px]]
 +
 
 +
Damit die Benutzer den MM auch sehen können, muß in den Gruppen-/Benutzerrechten auch noch dieser MM freigeschaltet werden. Den MM findet man unter 'Erlaubte Module' > 'Backend Module'. Je nachdem ob man den MM einzeln oder Untergeordnet anzeigen lässt dann an der jeweiligen Stelle.
  
 
=Die Daten erfassen=
 
=Die Daten erfassen=

Aktuelle Version vom 26. Januar 2017, 13:16 Uhr

Hinweis.png Hinweis: Die Angaben, Beschreibungen und Screenshot beziehen sich auf MetaModels bis etwa Mitte 2016 und sind nicht aktuell!

Im MetaModels-Handbuch sind aktuelle Angaben zu finden.

Aufgabenstellung: Backend einrichten

Als Beispielprojekt soll eine einfache "Musikbox" gebaut werden, in der Musikstücke mit gewissen Attributen ("Eigenschaften") erfasst werden. Zu diesem Zweck wird zuerst das Backend aufgebaut. Hierzu braucht man eine Übersichtsliste und ein Erfassungsformular.

Vorgehensschritte

  1. Start: Installation - Download und Installation von MetaModels
  2. Beispiel 1: Backend einrichten - MetaModel erstellen, Daten erfassen
  3. Beispiel 2: Frontend einrichten - Die Inhalte im Frontend anzeigen (Liste und Detail)
  4. Beispiel 3: Weitere Filter einrichten – Inhalte auf Published setzen, einfache Select-Filter
  5. Beispiel 4: Weiteres MetaModels einrichten - komplexe Select-Filter einsetzen

Eine leere Datenbank erstellen

Mm startscreen.png

Zuerst wird ein neues MetaModel erstellt. Technischen gesehen wird dabei in der Contao-Datenbank eine leere Tabelle angelegt.

  • Klick auf Neues MetaModel
  • Name: Musicbox
  • TabellenName: mm_musicbox

Anmerkungen

  • In unserem Beispiel aktivieren wir die Mehrsprachigkeit, um nachträglich weitere Sprachen anlegen zu können. Falls man im Vorfeld weiß, dass man keine weiteren Sprachen benötigt, muss der Haken nicht gesetzt werden. MetaModels ist auch ohne Mehrprachigkeit komplett funktionstüchtig.
  • Varianten unterstützen wird vorläufig nicht benötigt.... und gegebenenfalls zu einem späteren Zeitpunkt erläutert.

Auszuführen

  • Übersetzung anhaken
  • mindestens eine unterstützte Sprache auswählen
  • eine Sprache (z.B. Deutsch) zum Fallback machen
  • Varianten aktivieren vorerst nicht anhaken

Man sieht nun ein MetaModel "Musicbox" mit 0 (null) Datensätzen und einer Reihe von Icons, die nun zur Weiterbearbeitung genutzt werden.


MetaModels Backend-Funktionen

Kurze Erklärung, was sich hinter den nun dargestellten Symbolen verbirgt (in Klammern ist angegegeben, was als Tooltip ausgegeben wird):

Mm backend funktionen icons.png

Icons bearbeiten.png

Hier gelangt man wieder zurück zum gleichen Screen, wie bei der Erstellung eines neuen MetaModels. Hier kann man jederzeit sowohl den Namen als auch den Tabellennamen des MetaModels ändern.

  1. Attribute (Attribute für MetaModel ID x definieren)
  2. Ausgabevorgaben (Render-Einstellungen für MetaModel ID x definieren)
  3. Eingabemaske (Eingabemaske für das MetaModel ID x definieren)
  4. Filter (Filter für MetaModel ID x definieren)
  5. Paletten- und Ansichtseinstellungen (Definieren Sie die Eingabe- / Ausgabe-Optionen für MetaModel ID x)

Das Backend konfigurieren

Um das Backend für die Erfassung der Daten vorzubereiten benötigt man a) eine Übersichtsliste und b) ein Erfassungsformular. Hierzu braucht man 4 der 5 Backend-Funktionen von MetaModels.

  • Datenbank erstellen, benennen, Sprachvariable zuweisen
  • Felder definieren, Attribute festlegen, Erfassungsformular gestalten
  • Übersichtsliste definieren
  • Erfassung (z.B. für Redakteure) freigeben


MM-Funktion: Attribute

Icons attribute.png

Hier erfasst man die benötigen Felder für die Eingabe. s. allgemeine Infos zu den Attributen

Mm attribute erfassen.png

Hierzu gibt man folgende Felder ein (im nebenstehenden Screen ist das beispielhaft für das Attribut "Titel" dargestellt):

Titel
  • Attribute Type= Text
  • Column name= title
  • Name (deutsch)= Titel
  • Description (deutsch)= Name des Stücks
Interpret
  • Attribute Type= Text
  • Column name= composer
  • Name (deutsch)= Interpret
  • Description (deutsch)= Name der Band, SängerIn oder InterpretIn
Land
  • Attribute Type= Text
  • Column name= country
  • Name (deutsch)= Land
  • Description (deutsch)=
Jahr
  • Attribute Type= Dezimal
  • Column name= year
  • Name (deutsch)= Jahr
  • Description (deutsch)= Erscheinungsjahr
Beschreibung
  • Attribute Type= Langtext
  • Column name= description
  • Name (deutsch)= Beschreibung
  • Description (deutsch)= Wikipedia, Kurzbeschreibung, etc.
Cover
  • Attribute Type= Datei
  • Column name= images
  • Name (deutsch)= Cover
  • Description (deutsch)= Cover, Bilder
Bis jetzt wurde bei keinem der Attribute die Option Unique values aktiviert.

Um die Einträge eindeutig identifizieren zu können, wird zusätzlich ein Alias-Attribut erzeugt:
Alias
  • Attribute Type= Alias
  • Column name= alias
  • Name (deutsch)= Alias
  • Description (deutsch)=
  • Unique values= aktiviert
  • Alias Neuerstellung erzwingen = aktiviert
    (dann muss kein Alias eingegeben werden, wird neu berechnet bei Änderung des Titels)
  • Aliasfelder = Titel

MM-Funktion: Ausgabevorgaben (aka Render-Einstellungen)

Icons ausgabevorgaben.png

Hier wird die Ansicht erfasst: Eine Listendarstellung für das Backend.

Mm ausgabe definieren.png
  • Auf neu klicken
  • BE Listenansicht eingeben
  • Der Rest kann so stehen bleiben, denn für die BE Listenansicht braucht man weder eine Zielseite noch Filter settings.

(s. allgemeine Ausgabe-Vorgaben)

Mm ausgabe attribute definieren.png

Um auszuwählen, welche Felder in der BE Listenansicht angezeigt werden sollen, klickt man einfach auf das entsprechende Icon rechts:

  • Add all fügt alle Felder auf einen Rutsch hinzu. Man kann auch Neu wählen und die Felder einzeln hinzufügen, aber mit Add all gehts am schnellsten.
  • Die Frage, ob alle Attribute hinzugefügt werden sollen("Add all attributes to render setting"), wird mit Weiter bestätigt.
  • Nun werden alle Attribute aufgelistet, die im vorangegangenen Schritt erfasst worden sind.

Über das übliche 'Auge' werden nur die Attribute sichtbar gemacht, die in der Backend-Liste angezeigt werden sollen. Für dieses Tutorial wählen wir : Titel, Interpret, Land und Jahr.

(( alter Screen, wird ersetzt ))

MM-Funktion: Eingabemaske (fka Paletteneinstellungen)

Icons paletteneinstellungen.png

Hier legt man fest, wo und wie im BE die Daten zur Musicbox erfasst werden sollen.

BE-Liste

Mm paletten BE liste.png

Nach Klick auf Neue Eingabemaske öffnet sich ein Erfassungsformular. Hier die Werte eingeben, wie nebenan abgebildet:

  • Name: BE Erfassung
  • Option Als Standard benutzen
  • Panel-Layout: Es stehen 4 Werte (filter, sort, search und limit) zur Verfügung. Diese können auch über das Icon rechts abgerufen werden.
    • Werden hier mehrere Werte eingegeben, so sind diese entweder durch Komma (,) oder durch Semikolon (;) voneinander zu trennen - nur mit Leerzeichen getrennte Werte werden ignoriert.
    • Komma => Ausgabe in der gleichen Zeile wie der vorhergehende Wert
    • Semikolon => Ausgabe in neuer Zeile.
  • Integration: Als Einzeltabelle
  • Sortiermodus: 2 Datensätze nach wählbarem Feld sortiert darstellen (Wichtig: Sowohl dieser Wert als auch sort im Panel-Layout müssen definiert sein, ansonsten erscheint die Sortier-Funktion nicht.
  • Sortierung: Auf- oder Absteigend... wie es dir gefällt
  • Backend-Bereich: Inhalte (oder wo soll es in der Backend-Navigation eingesetzt werden)
  • Backend-Icon: Auf Wunsch kann hier ein eigenes Icon gesetzt werden
  • Backend-Beschreibung: wie abgebildet


Nun wurde eine Eingabemaske namens BE Erfassung erstellt. Im Folgenden wird nun das Erfassungs-Formular ein wenig gestaltet.
Im letzten Kapitel auf dieser Seite (Die Daten erfassen) sieht man, wie die Liste/das Formular zwecks Erfassung der Musikstücke aussieht.

Hinweis.png Hinweis: Mit der Erweiterung MetaModels Boilerplate (Nightly Build) kann man die MetaModels in einem separaten Backend-Bereich in der BE-Navigation unterbringen.
Hinweis.png Hinweis: Die Option Sortierung ist beim erstmaligen Bearbeiten der Seite noch nicht sichtbar. Es empfiehlt sich daher, nach Auswahl des Backend-Bereichs (hier: Inhalte) die Seite zu speichern. Jetzt kann die Sortierung festgelegt werden.

BE-Formular

Mm paletten BE formular.png

Man fügt nun alle Attribute zur Palette hinzu, indem man auf das Icon rechts (Die Einstellungen der Palette ID xx bearbeiten) klickt.

  • Alle hinzufügen wählen und alle nun folgenden Screens bestätigen.
  • Man erhält so eine Liste aller Attribute, die man einzeln bearbeiten kann.
  • Auf Wunsch kann man hier auch die Reihenfolge umstellen und so bestimmen, wie die Daten erfasst werden sollen.
  • Angefangen wird mit dem ersten Eintrag Titel [text]
Mm paletten BE formular2.png

Folgendes Beispiel zeigt, was man bei der Erfassung des Attributs Titel alles einstellen kann.
Ein Klick auf das Editier-Icon zeigt die wichtigsten Einstellungen:

  • Backend-Class: Damit kann man das Formular bzw. die Erfassungfelder etwas gestalten. 5 Werte stehen zur Verfügung: w50, clr, long, wizard und m12
  • Pflichtfeld: Durch Anklicken legt man fest, ob auf diesem Feld eine Inhaltsprüfung stattfinden soll. Die Felder werden mit einem roten Asterisk gekennzeichnet.
  • Filterbar, Durchsuchbar, Sortierbar: Mit diesen Optionen kann man die BE-Liste etwas organisieren. Praktisch wenn man mehrere Dutzend/Hunderte von Datensätze erfasst hat.

MM-Funktion: Zugriffsrechte definieren

Icons ansichtseinstellungen.png

Hier legt man fest, wer im Backend auf die Daten von MetaModel zugreifen und diese editieren darf.

Mm neues metamodel ansichtseinstellungen.png

Damit die Benutzer den MM auch sehen können, muß in den Gruppen-/Benutzerrechten auch noch dieser MM freigeschaltet werden. Den MM findet man unter 'Erlaubte Module' > 'Backend Module'. Je nachdem ob man den MM einzeln oder Untergeordnet anzeigen lässt dann an der jeweiligen Stelle.

Die Daten erfassen

Mm backend erfassen.png

Und so sieht's aus:
Nun wird in der linken Navigationsübersicht "Backend-Module" ein neuer Eintrag angezeigt und man kann mit der Erfassung der Musikstücke beginnen.

  • Mit Klick auf MyMusik gelangt man auf die BE Listenansicht. Diese ist noch leer
  • Mit Klick auf Neuer Datensatz. öffnet sich ein Formular, mit dem sich nun der erste Datensatz erfassen lässt
  • Die gewünschten Werte eingeben und mit Speichern und Schliessen bestätigen
  • Nun erscheint der erste Eintrag in der BE Listenansicht
  • Diesen Vorgang wiederholen, bis alle Datensätze erfasst wurden
  • Über der BE Listenansicht stehen nun die Panel-Layout Funktionen Suchen, Sortieren, Filtern und Anzeigen zur Verfügung

Zurück zur Beispiel-Übersicht | Weiter zum Beispiel 2: Erstellung der Frontend-Ansicht

Ansichten
Meine Werkzeuge

Contao Community Documentation

Pelle: gibt's ein besseres Wort für "beschränkt"?
Thomas: "Kunde"

Navigation
Verstehen
Verwenden
Entwickeln
Verschiedenes
Werkzeuge