Terminologie

MODX verwendet die im Folgenden erklärten Begriffe für Objekte. Es ist wichtig, dass Du verstehst, wie diese funktionieren. Es ist von Vorteil, wenn Sie sich ein paar merken können.

Kontexte¶

Kontexte können zur Strukturierung von Inhalten verwendet werden, für Sprachversionen einer Website, oder zur Verwaltung von mehreren Domains oder Subdomains.

Elemente¶

Elemente sind verschiedene "Objekte", die dem Administrator im Backend zur Verfügung stehen. Diese sind: Templates, Template-Variablen, Chunks, Snippets, Plugins und Kategorien. Für Sie als Editor sind hauptsächlich Templates und Template-Variablen relevante Elemente.

Templates¶

Templates sind Vorlagen, aus denen ihre Seite zusammengebaut wird. Abhängig von ihrem gewählten Template und der Konfiguration ihres Administrators ändern Sie darüber die Eingabemöglichkeiten im Backend und die Darstellung im Frontend.

Ressourcen¶

Ressourcen sind einzelne „Webseiten“, ihre Dokumente. Ressourcen können u. a. HTML-Seiten, externe Links oder symbolische Links auf eine andere Ressource sein.

MODX Tags¶

Der dynamische Inhalt wird in MODX in der Regel über spezielle Tags in ein übergeordnetes Element eingefügt. Dies ist nicht immer nur das Template. Sie können MODX Tags z. B. auch in Seiten- und Template-Variablen benutzen.

Diese Tags nutzen in MODX Revolution rechteckige Klammern und sehen meist so aus:

[[tag-name]]

Seiten-Variablen¶

Jede Seite (Ressource) von MODX besitzt Standard Eingabefelder. Jedes dieser Eingabefelder ist eine Seiten-Variable. MODX Tags für Seiten-Variablen werden in einem Template mit einem Asterix gekennzeichnet, z. B. [[*pagetitle]], [[*longtitle]], [[*description]] oder [[*content]].

<h1>[[*pagetitle]]</h1>
<h2>[[*description]]</h2>

Template-Variablen (TV)¶

Die Standard Eingabefelder von MODX reichen nicht immer aus, um alle Informationen einer Seite zu speichern. Template-Variablen speichern zusätzlichen Inhalt und können unterschiedliche Eingabeformate vorgeben: eine einzelne oder mehrzeilige Textzeile, ein Bild, eine Dropdownliste und viele andere. Ihr Administrator hat Ihnen vielleicht eine Vorschaubild-Möglichkeit oder sonstige seitenspezifische Konfigurationsmöglichkeit eingerichtet? Dann nutzen Sie schon Template-Variblen.

MODX Tags für TVs werden mit einem Asterix gekennzeichnet, z.B. [[*preview-image]], so wie Seiten-Variablen.

Cache¶

MODX benutzt ein eigenes Caching-System zur schnelleren Auslieferung von Seiten. Grundsätzlich wird alles gecached, was von MODX erzeugt wird.

Sollte eine Änderung nach dem Speichern nicht sichtbar sein, versuchen Sie den Cache zu leeren

IDs¶

Jedes Element im Backend (Template, Ressource, etc.) hat eine eigene ID. Die IDs befinden sich hinter jeder erstellten Ressource.

IDs kann man verwenden um z. B. einen Link dynamisch zu erzeugen: [[~12]]. Der Vorteil bei der Verwendung von IDs ist, dass man beim Umbenennen einer Ressource umbenennst nicht mehr alle Referenzierungen anpassen muss.

Gratulation

Wenn Sie bis hier hin gelesen haben und noch neugierig sind, lesen Sie weiter.

Ansonsten haben Sie ihren Dienst getan und können mit ihren ersten Schritten beginnen.

Weitere Konzepte von MODX¶

Nur einige weitere (gekürzte) Erläuterungen zu anderen Konzepten in MODX.

Kategorien¶

Kategorien dienen in erster Linie zur Strukturierung von Templates, Chunks, Snippets etc. Eine wichtige Rolle spielen Kategorien bei der Rechteverwaltung. Im Backend können diese genutzt werden um bestimmte Elemente nur gewissen Nutzern zur Verfügung zu stellen.

Extras¶

Sogenannte Extras sind vorgefertigte Packete (ähnlich wie Plugins/Addons), welche die Funktionalität von MODX auf unterschiedliche Art und Weise erweitern können. Ein Extra kann ihr Administrator für Sie bei Absprache installieren oder bei besonderen Herausforderungen individuell für Sie entwickeln.

Chunks¶

Chunks sind das Arbeitstier zur Organisation. Chunks kann man sich am besten als Textbaustein vorstellen. Alles, was man immer wieder braucht, schreibt man in einen Chunk.

MODX Tags für Chunks werden mit einem Dollarzeichen gekennzeichnet, z. B.

[[$chunkname:tag]]

Stellen Sie sich vor, ihre Website hat mehrere Templates. Alle Templates unterscheiden sich, aber alle haben eine Fußzeile mit einem Copyright-Hinweis. Da wir nicht jedes Template ändern wollen, wenn sich das Copyright ändert, verwenden wir dafür einen Chunk.

Snippets¶

Snippets sind PHP Skripte, die aus komplett eigenem PHP Code bestehen können, oder aber auch Code benutzen, der die MODX API bedient. Ein Snippet kann mit Parametern aufgerufen werden. Schauen wir uns als Beispiel den Aufruf für das Snippet Wayfinder an, das wir für die Menü-Erzeugung verwenden können.

MODX Tags für Snippets werden nicht weiter gekennzeichnet, in unserem Fall einfach [[Wayfinder]]. Wenn ein Snippet mit zusätzlichen Parametern aufgerufen werden soll, sieht das folgendermaßen aus:

[[Wayfinder? &startId=`1`]]

Plugins¶

Plugins bestehen genau wie Snippets aus PHP Code, mit dem Unterschied, dass sie nicht direkt aufgerufen werden, sondern einem Event zugeordnet werden. Events sind in MODX vordefinierte Aktionen, zum Beispiel die eines Nutzers. Man kann ein Plugin schreiben, dass jedes Mal ausgeführt wird, wenn ein Nutzer eine Seite aufruft. MODX kennt über hundert verschiedene Events.