MetaModels Beispielprojekt

Aus Contao Community Documentation

MsgError.png Unvollständiger Artikel: dieser Artikel ist noch nicht sauber bearbeitet.

Bitte erweitere ihn und entferne erst anschliessend diesen Hinweis.

Beispielprojekt mit MetaModels (aka Catalog 3)

Hier entsteht anhand eines Beispielprojektes die Beschreibung der wichtigsten Möglichkeiten der neuen MetaModels in einem Contao 2.11.6ff.
Die Bedienung und Administration von Contao sollte bekannt sein.
Bezüglich der MetaModels werden keinerlei Vorkenntnisse vorausgesetzt.

Dieser Beitrag entsteht 'learning by doing'. Er enthält also immer den aktuellen Wissensstand des/der Autoren. Auftretende Fragen werden hier vermerkt und ebenso im Community-Forum gestellt. Sobald eine Lösung gefunden wurde, wird die Frage hier im Wiki durch eine passende Beschreibung ersetzt.

"Information"


Die Aufgabenstellung

Wir möchten eine Sammlung traditioneller Folkmusik aufbauen, die im BE durch Redakteure gepflegt werden kann, (die sich nicht mit MetaModels auseinandersetzen müssen). Im FE soll man die Sammlung nach unterschiedlichen Kriterien filtern und durchsuchen können. In der Detail-Ansicht werden alle verfügbaren Informationen zu einem Stück angezeigt.

Vorbereitungen

Wir gehen davon aus, dass Contao 2.11.6 (oder eine neuere 2.11) installiert ist.

Aktuell gibt es MetaModels noch nicht im Extension Repository. Man muss sich darum den Code von GitHub laden. Dies geht am einfachsten auf einem Linux-Rechner mit lokalem Webserver für die Tests oder auf einem Linux-Server mit Shell-Zugang.
Unter Windows kann dasselbe mit cygwin erreicht werden, oder man verwendet einen Git-Client für Windows und kopiert die erhaltenen Quelldateien in die Contao-Installation.

Zunächst legt man sich einen Ordner an, in den die Quellen herunter geladen werden sollen und wechselt dahin.

cd ~
mkdir MetaModels
cd MetaModels

Dann wird MetaModels einschließlich aller Unterprojekte heruntergeladen:

for i in `wget -qO- https://api.github.com/orgs/MetaModels/repos | \
grep clone_url | \
cut -d \" -f4`; do \
git clone $i; \
done;

Die erzeugten Ordnerstrukturen enthalten jeweils (bis auf DC_General) einen Ordner src. Darin befindet sich der Teil der Quellen, die in die Contao-Installation übernommen werden müssen. In DC_General befindet sich direkt der Ordner system.

Die system-Ordner müssen jeweils in die Contao-Installation kopiert werden (contao ersetzen durch Pfad zum Contao-Installationsordner):

for i in `ls -d attr*`; do cp -r $i/src/* contao/; done;
cp -r core/src/* contao/
cp -r DC_General/* contao/

Jetzt muss noch im Contao-Backend die Datenbank aktualisiert werden: Erweiterungsverwaltung | Datenbank aktualisieren

Unser Datenmodell

Jetzt geht es wirklich los!

Im Backend unter [System] befindet sich ein neuer Eintrag [MetaModels], über den ein neues MetaModel angelegt wird.
Für unsere Aufgabenstellung wählen wir

  • Name: TuneBook
  • TabellenName: mm_tunebook

Da noch nicht klar ist, ob die Seite vielleicht einmal mehrsprachig wird, bereiten wir das MetaModel direkt auf diesen Fall vor:

  • Übersetzung anhaken
  • Eine Sprache Deutsch legen wir dann auch an und machen sie zum Fallback.


Unter den [Experteneinstellungen] befindet sich noch eine Option [Varianten aktivieren],
deren Bedeutung sich auch mit der angezeigten Erklärung einem Neuling nicht erschließt.
Wir aktivieren sie zunächst nicht.

"Frage"


Jetzt werden die Attribute definiert, die eines der Musikstücke in unserer Sammlung ausmachen: MetaModels Tools Attribute.png

Titel
  • Attribute Type = Text
  • Column name = title
  • Name (deutsch) = Titel
  • Description (deutsch) = Name des Stücks
Typ
  • Attribute Type = Text
  • Column name = type
  • Name (deutsch) = Typ
  • Description (deutsch) = Rhythmus / Tanzart
Herkunftsland
  • Attribute Type = Text
  • Column name = country
  • Name (deutsch) = Herkunftsland
  • Description (deutsch) =
Region
  • Attribute Type = Text
  • Column name = region
  • Name (deutsch) = Region
  • Description (deutsch) = für eine feinere geographische Zuordnung als das Herkunftsland
Quelle
  • Attribute Type = Text
  • Column name = source
  • Name (deutsch) = Quelle
  • Description (deutsch) = Notenbuch / Sammlung / Kurs
Komponist/Urheber
  • Attribute Type = Text
  • Column name = composer
  • Name (deutsch) = Titel
  • Description (deutsch) =
ABC-Notation
  • Attribute Type = Longtext
  • Column name = abc
  • Name (deutsch) = ABC-Notation
  • Description (deutsch) = Hier kann das Stück in ABC-Notation eingegeben werden, die auf der Seite z.B. auch in Notenschrift gewandelt werden kann.
Zusatz-Informationen
  • Attribute Type = Übersetzter Longtext
  • Column name = info
  • Name (deutsch) = Zusatz-Informationen
  • Description (deutsch) = Beliebige zusätzliche Infos zu dem Stück, wie Anekdoten, Links zu Fundstellen von Hörbeispielen im Netz usw.
Man soll die Veröffentlichung von Einträgen steuern können. Also wird ein weiteres Attribut angelegt:
Veröffentlicht
  • Attribute Type = Checkbox
  • Column name = published
  • Name (deutsch) = Veröffentlicht
  • Description (deutsch) =
  • check publish = aktiviert
    (vermutlich erzeugt diese Option die gewünschte Funktionalität)
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 fields = Titel
  • Force alias regenerating = aktiviert
    (dann muss kein Alias eingegeben werden, wird neu berechnet bei Änderung des Titels)


Trotz der möglichen Mehrsprachigkeit wurden die meisten Attribute vom Typ Text und nicht Übersetzter Text angelegt.
Nur für die Zusatz-Informationen wurde ein übersetztes Attribut gewählt, da die Beschreibung eines Stücks ggf. in eine andere Sprache übersetzt wird.

Ist diese Überlegung richtig?

"Frage"


Backend für Redakteure einrichten

Die Einstellungen im Backend unter [MetaModels] dienen der Definition unseres Datenmodells und verschiedener Ansichten der Daten. Für einen Redakteur sollte das Backend eher so aussehen, als wenn es genau für seine Aufgabe maßgeschneidert ist: in diesem Fall die Verwaltung von Musikstücken in der Sammlung.

Und genau das können die MetaModels leisten! Zunächst definieren wir, welche Attribute in der Backend-Liste angezeigt werden sollen. Dazu wird zunächst ein Template (Ausgabevorgabe) angelegt: MetaModels Ausgabevorgabe.png

Auf der neuen Backend-Seite (die leider durch nichts als Template-Seite zu erkennen ist) wird per [Neu] ein neues Template erzeugt. Wir geben ihr den Namen Liste Backend, alle anderen Einstellungen ändern wir nicht.
Mit [speichern und schließen] gelangt man zurück zur Template-Liste.
Über das rechte Icon gelangt man in den Dialog zur Template-Bearbeitung. Am Einfachsten wählt man [Add all] um alle vorhandenen Attribute dem Template hinzuzufügen. Über das übliche 'Auge' werden nur die Attribute sichtbar gemacht, die in der Backend-Liste angezeigt werden sollen: Titel, Typ und Herkunftsland.

Per [zurück] kommen wir wieder zur Template-Liste. Ein weiteres [zurück] führt uns leider nicht auf die Grundseite der MetaModels. Also müssen wir über das Hauptmenü dorthin navigieren.
Dann gelangt man per MetaModels Paletteneinstellungen.png in eine Liste, in der über [Neue Palette] den Menü-Eintrag definiert, den die Redakteure benutzen werden.

Wir wählen die folgenden Einstellungen:
Name Trad.-Liste
als Standard benutzen aktivieren
Panel-Layout search,sort;filter,limit
was das genau bedeutet, werden wir später sehen
Integration Als Einzeltabelle (wir haben ja nur eine...)
Sortierung Nach erstem Buchstaben absteigend sortieren
Sortiermodus Datensätze nach wählbarem Feld sortiert darstellen
Backend-Bereich Inhalte
Backend-Icon hier könnten wir das Icon für das Menü festlegen - erstmal wählen wir nichts und lassen es bei dem automatisch vergebenen Icon.
Backend-Beschreibung
  • Deutsch
  • Trad.-Sammlung
  • Sammlung traditioneller Folkmusik

Anzeige-Templates für Frontend und Backend

Filter

Ansichten
Meine Werkzeuge

Contao Community Documentation

Chuck Norris programmiert kein PHP, er diktiert das Ergebnis. Den Rest macht der Editor aus Angst.

Stefan Lindecke
Navigation
Verstehen
Verwenden
Entwickeln
Verschiedenes
Werkzeuge