Version vom 12. Januar 2013, 21:54 Uhr

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.

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.

Hinweis: Es geht jetzt auch einfacher als im Folgenden beschrieben, da die Entwickler nun den jeweils aktuellen Entwicklungsstand zum Download anbieten: als ZIP, als TAR GZ oder als TAR BZ2 siehe dieser Beitrag im Forum Das Archiv wird in den Installationsordner von Contao entpackt.

Die folgende Beschreibung ist veraltet --------------------------

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/

------------------------- Ende der veralteten Beschreibung

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.

Jetzt werden die Attribute definiert, die eines der Musikstücke in unserer Sammlung ausmachen.
Klick auf das rot markierte Icon:

Gib nun wie unten aufgelistet die neuen Attribute ein:

Deine Attributs-Liste sollte nun wie folgt aussehen:

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?

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 eine Ausgabevorgabe angelegt:

Ausgabevorgaben werden an anderen Stellen innerhalb MetaModels auch als Renderereinstellungen(Modul MetaModels-Liste) oder als Ansicht(Paletten- und Ansichtseinstellungen) bezeichnet.

Vielleicht sollte die Nomenklatur vereinheitlicht werden.

Auf der neu erscheinenden Backend-Seite (die leider durch nichts als Ausgabevorgabe-Seite zu erkennen ist) wird per [Neu] eine neue Ausgabevorgabe erzeugt.

Wir geben ihr den Namen Liste Backend, alle anderen Einstellungen ändern wir nicht.
Mit [speichern und schließen] gelangt man zurück zur Liste der Ausgabevorgaben.

Über das rechte Icon gelangt man in den Dialog zur Bearbeitung.

Am Einfachsten wählt man [Add all] um alle vorhandenen Attribute der Vorgabe hinzuzufügen. Die Attribute könnten auch gezielt oder in einer speziellen Reihenfolge einzeln hinzugefügt werden.

Ü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 Liste der Ausgabevorgaben. Ein weiteres [zurück] führt uns leider nicht auf die Grundseite der MetaModels. Also müssen wir über das Hauptmenü dorthin navigieren.

Jetzt soll der Menüpunkt für die Redakteure erstellt werden:
Man gelangt per in eine Liste, in der über [Neue Palette] der Menü-Eintrag definiert wird.

Der Hilfsdialog, der über das kleine Symbol rechts neben dem Eingabefeld [Panel-Layout] aufgerufen werden kann, fügt kein Komma oder Semikolon ein, was aber im Hilfetext angegeben wird.
Außerdem erscheint und verschwindet das Eingabefeld [Sortierung] unter nicht ganz nachvollziehbaren Randbedingungen. Man würde erwarten, dass es nur angezeigt wird, wenn bei [Sortiermodus] ein sortierender Modus gewählt wurde.

Über das rechte Icon wird das Backend definiert.

Man gelangt in eine neue Liste und wählt am Einfachsten [alle hinzufügen] um alle vorhandenen Attribute der BE-Bearbeitung hinzuzufügen.

Für jedes der Attribute kann nun eingestellt werden, ob es sich um ein Pflichtfeld handelt, ob nach diesem Attribut filterbar, sortierbar oder durchsuchbar sein soll.

Für unsere Musiksammlung wählen wir die folgenden Einstellungen:

Schließlich wird der Editor für Paletten- und Ansichts-Optionen geöffnet.
Hier wird zunächst folgendes eingestellt:

Jetzt gibt es im Menü [Backend-Module] einen neuen Eintrag im Bereich [Inhalte] mit der von uns gewählten Bezeichnung [Trad.-Sammlung].
Dieser Punkt soll von den Redakteuren verwendet werden.
(Dazu wird dann später als BE-Gruppe die Gruppe der Redakteure eingetragen.)

Es erscheint eine Contao-typische Liste, die mit Einträgen in unsere Sammlung gefüllt werden kann.

Oberhalb der Liste erscheinen die Filter- und Sortier-Elemente, die unter [Panel-Layout] oben definiert wurden. Es wurde dort auch die Reihenfolge und Position festgelegt.

Testweise tragen wir im Backend verschiedene Musikstücke ein und achten darauf, dass unterschiedliche Inhalte bei Herkunftsland und Typ eingetragen sind.

Anzeige der Daten im Frontend (Liste)

Um die eingetragenen Stücke im Frontend anzuzeigen brauchen wir zunächst eine Ausgabevorgabe, die wir unter [MetaModels] anlegen
Die neue Vorgabe nennen wir Trad-Liste FE.
Am Einfachsten fügen wir per [Add all] alle Attribute ein. Für die Liste im Frontend reicht es in unserem Beispiel aus, nur den Titel, den Typ und das Herkunftsland auszugeben. Also wählen wir diese Attribute mit dem 'Auge' aus.

Damit nur die veröffentlichten Einträge im FE angezeigt werden, richten wir einen Filter ein
Der Filter wird per [Neu] angelegt und soll Published Filter heißen. Zur Bearbeitung gelangt man über das rechte Icon. Hier fügen wir eine [Einfache Abfrage] hinzu mit folgenden Einstellungen:

[Speichern und schließen]

Dann benötigen wir noch ein Modul vom Typ MetaModels-Liste namens Tunebook. Die vorgeschlagenen Einstellungen werden weitgehend übernommen. Wichtig sind zunächst nur

[Speichern und schließen]

Schließlich wird eine neue Seite angelegt und im Artikel das gerade angelegte Modul eingefügt.

Die Seite im Frontend zeigt die eingetragenen und veröffentlichten Stücke an, allerdings noch nicht besonders schön formatiert.

Detailseite

Jetzt hätten wir natürlich gerne einen Link bei jedem Eintrag in der angezeigten Liste, über den eine Detail-Seite aufrufbar ist.
Es wird als erstes eina Ausgabevorgabe für die Detailseite angelegt
Die neue Vorgabe nennen wir Trad-Liste Detail.
Es werden wieder alle Attribute eingefügt ([Add all]) und diesmal wählen wir mit dem 'Auge' alle Attribute bis auf Alias und veröffentlicht, da ja die vollständige Information ausgegeben werden soll.

Weiterhin legen wir einen neuen Filter namens Tune-Alias Filter an.
Dort wird eine Einfache Abfrage eingefügt, die natürlich aktiviert wird, wir wählen als Filter-Attribut Alias. Der URL-Parameter kann leer bleiben, auch die weiteren Optionen werden nicht ausgewählt.

Dann benötigen wir ein weiteres Modul vom Typ MetaModels-Liste. Wir nennen es Tune-Detail und verwenden folgende Einstellungen:

[Speichern und schließen]

Dann wird auch hier eine neue Seite angelegt und im Artikel das gerade angelegte Modul eingefügt.

Schließlich kehren wir zurück zur Ausgabevorgabe Trad-Liste FE und ändern deren Einstellungen (über das Stift-Symbol): Bei Jump to page selektieren wir über den kleinen Globus die eben angelegte Detail-Seite, zu der ein Link in der Liste erzeugt werden soll, und stellen bei Filter settings wieder den Tune-Alias Filter ein.

[Speichern und schließen]

Wenn alles geklappt hat, dann wird jetzt im Frontend in der Liste bei jedem Eintrag ein Link Details angezeigt. Dieser Link leitet zur Detailseite weiter, deren URL das Wort alias und den Alias des angeklickten Stücks enthält.
Auf der Detailseite werde alle eingegebenen Informationen des jeweiligen Stücks ausgegeben.
Hurra!

Filtern und Sortieren im Frontend