Dokumentation für Geeks

[Danqu]

Hallo Contao Community,

zunächst einmal ein herzliches Hallo in die Runde!

Ich möchte mich gerne in Contao einarbeiten. Die Dokumentation die ich über die offizielle Seite erreiche, macht mich aber ehrlich gesagt absolut nicht glücklich.
Mir geht es darum, dass ich ein fertiges statisches HTML Design habe und dieses gerne in Contao umsetzen möchte.

Nirgendwo finde ich eine vollständige Beschreibung der einzelnen Methoden/Funktionen die mir als Entwickler zur Verfügung stehen.
Welche globalen Variablen kann ich nutzen, welche Methoden/Schnittstellen stehen zur Verfügung, wie wird der Aufbau der Seiten realisiert (welchem Pattern folgen sie), usw.?

Bevor ich anfange ad-hoc irgendwelche Dinge zu programmieren und auszuprobieren, würde ich gerne vorher das Systtem in seiner Ganzheit verstehen und wissen wollen welche Prinzipien Contao verfolgt.

Habe ich an der falschen Stelle geschaut? Existiert eine solche Dokumentation überhaupt? Oder kennt jemand vielleicht sogar eine Seite, die die Transformation einer statischen HTML Seite in Contao beschreibt?

Beste Grüße,
Danqu

[dazzle89]

Hast du diese Anleitung auch schon gelesen?

https://de.contaowiki.org/Die_erste_Webseite

[Danqu]

Hast du diese Anleitung auch schon gelesen?

https://de.contaowiki.org/Die_erste_Webseite

Vielen Dank für den Link. Ja auf dieses Wiki bin ich auch schon gestoßen. Leider ist mir das zu oberflächlich.

Vielleicht frage ich so: Ist das Entwickeln von Contao-Webseiten vorwiegend auf das Zusammenklicken von Parametern bzw. Eigenschaften im User-Backend ausgelegt?

[Andreas]

Im Prinzip schon. Alles was man im BE speichert (außer System-Einstellungen) wird in der DB gespeichert und im FE über Templates ausgegeben. Die Variablen, welche in Templates zur Verfügung stehen kann man sehen, wenn man in einem Template das hier einträgt.

<?php
$this->showTemplateVars();
?>

Aber über manuelle updatesichere Anpassungen wie

• eigene Templates
• _c4/app/Resources/contao/dca/tl_content.php | tl_member.php | ...
• _c4/app/Resources/contao/config/config.php (noch nicht probiert in Conato 4)
• eigene Erweiterungen
• ...

kann man nahezu alles an eigene Bedürfnisse anpassen.

Das Templatesystem sollte man verstehen! Wenn man im BE ein Template aus einem Core-Template erstellt, dann ist dies eine Kopie des Coretemplates, welche von nun an anstelle des Core-Templates benutzt wird. Wenn man das Template umbenennt ("prefix_" muss erhalten bleiben), dann kann man dieses Template an entsprechender Stelle (Inhaltselement, Modul ...) auswählen (nicht alle Templates sind im BE auswählbar, umbenennen kann man also nur, wenn man an entsprechender Stelle auch ein Template wählen kann, was fast überall möglich ist).

Templates anzupassen ist allerdings erstmal nicht empfohlen, da es spätere Updates erschwert. Die Anpassungen müssten dann nach einem Update mit evtl. neuen Core-Templates verglichen werden, falls Neuerungen bzw. Verbesserungen vorgenommen wurden. Außerdem verhindert man mit der Benutzung der Coretemplates HTML-Fehler und sie sind auch auf SEO und Zugänglichkeit optimiert.

Wenn du eine HTML-Struktur und eigenes CSS hast, dann würde ich im Page-Layout keine Größenangaben eintragen und auch keine CSS-Dateien aus dem "CSS-Framework" anhaken. Damit bist du dann in der Gestaltung völlig frei. Musst dann nur noch dein CSS auf das HTML-Markup von Contao anpassen, was ich unbedingt empfehlen würde.

Der obige Link zu der Wikiseite ist empfehlenswert, wenn es darum geht, wie Contao Seiten, Layout, seitenweite Module und Inhalte verwaltet. Ich empfehle dir nur ein Seitenlayout zu benutzen, welches du dem Startpunkt zuweist. Dieses wird dann auf alle Unterseiten vererbt. Das Template, welches die äußere Layoutstruktur und die Einbindung von Inhalten und Modulen steuert ist übrigens das "fe_page.html5".

[Danqu]

Danke für die Antworten. Ich werde deinen Vorschlägen nachgehen.

Schade das Contao selbst keine richtige Doku liefert.

[jscholtysik]

Ich kann Dir da auf jeden Fall für den Einstieg das Contao Buch von Peter Müller empfehlen:

https://www.amazon.de/Contao-umfasse...er+m%C3%BCller

[mpietsch]

Ist das Entwickeln von Contao-Webseiten vorwiegend auf das Zusammenklicken von Parametern bzw. Eigenschaften im User-Backend ausgelegt?

Hi Danqu,

naja, wie Andreas schon schreibt, das CSS schreibst du selbst und musst hoffentlich nicht viel am Markup anpassen.

Aber das ist ja Sinn eines CMS. Oder was meinst du mit "Zusammenklicken"? Es gibt Erweiterungen z. B. für Spalten, sowas ist nützlich. Es gibt z. B. auch den internen CSS-Editor, aber es geht in einer externen Datei doch schneller. ;-)

Wenn du von den Docs bisher enttäuscht bist, wirst du es von der Community hoffentlich nicht sein und erhältst hier Antworten auf all deine Überlegungen.

LG Micha

[Andreas]

Ich höre da raus, dass dir die Dokus wahrscheinlich zu umfassend sind. Evtl. suchst du ne Schnellanleitung. Da wärst du im Wiki gut aufgehoben.

Ansonsten gibt es noch jede Menge Quellen.

• https://docs.contao.org/en/
• https://contao-academy.de/
• http://de.contaowiki.org/
• http://www.contao-handbuch.de/ (Contao 2 ist für die Basics immer noch in Ordnung)
• https://rocksolidthemes.com/de/contao/support/tutorials
• Und jede Menge Videos auf YouTube
• Gerade das hier mit Google gefunden http://www.heger-net.com/index.php/d...Redakteure.pdf

[mpietsch]

Hatte nicht mal jemand einen Vortrag gemacht über Best Practices? Ich finde ihn gerade nicht...

[Danqu]

Erstmal vielen Dank für die Zahlreichen Antworten! @Andreas Ich werde mir auf jeden Fall die Webseiten genauer anschauen und ich denke, dass ich beim schnellen überfliegen fündig werde. @mpietsch so ein best-practice währe natürlich super!

Um eventuell ein wenig Klarheit zu schaffen. Ich bin eigentlich (studierter) Informatiker der theoretisches Wissen aus Fachliteratur/Internet bezieht. Soll heißen, dass wenn ich programmiere, eher Core-Programming mache und mehr funktional entwickel. Meine meist genutzte Programmiersprache ist nämlich eigentlich C++ oder C# :P

Aufgrund eines Gefallen, habe ich mich entschlossen eine Webseite in Contao zu realisieren. Das Problem was ich habe ist, dass nicht wirklich mein Bedürfnis befriedigt wird, wie Contao letztendlich arbeitet (sozusagen eine Blackbox). Vielleicht ist das aber auch der falsche Ansatz, da es nicht wirklich notwendig ist jenes zu verstehen (schlechte Angewohnheit I guess) ^^

Ich melde mich noch mal zu Wort, wenn ich meinem Ziel näher gekommen bin und berichte, wo ich letztendlich fündig geworden bin!

EDIT: Eventuell hilft es noch zu erwähnen, dass ich viel im PHP Framework Laravel entwickelt habe (für eventuelle Analogien währe ich dankbar)

[Andreas]

Ich denke, dass wenn du einfach mal die ersten Schritte im BE gemacht hast und das Konzept im BE verstanden hast, dann wird alles andere klarer. Also erstmal nicht so viel lesen oder Videos gucken, sondern erstmal machen (obwohl ich selber ein Handbuchleser bin, scheint mir das bei Contao eine gute erste Herangehensweise zu sein).

Contao 4 ist ein Bundle des PHP Frameworks Symfony. (Ich selber habe keine Erfahrung mit PHP Frameworks).

Das BE ist bewusst für Redakteure so gestalltet, dass Seiten und Inhalte leicht umgesetzt werden können. Evtl. erscheint es dir deswegen als "Blackbox".

Wenn du die Zeit finden solltest tiefer einzusteigen, wirst du feststellen, dass du sowohl das BE als auch die FE Ausgabe sehr gut steuern und manipulieren kannst.

Agenturen und Profis, welche Websites für Kunden erstellen versuchen jedoch so wenig wie möglich zu verändern, da dies auch immer einen erheblichen Mehraufwand bei der zukünftigen Pflege, z.B. Updates, bedeutet. D.h. u.a. so wenig Templateanpassungen wie möglich und wenn Erweiterungen zum Einsatz kommen, dass sich diese bereits lange bewährt haben und/oder von bekannten und verlässlichen Entwicklern programmiert wurden.

[Danqu]

Ich habe inzwischen einige Fortschritte gemacht und danke nochmal für die guten Tipps.

So langsam ergibt sich ein Bild. Ich habe so ziemlich jede Template-Datei "überschrieben" und auf meine eigenen Bedürfnisse angepasst. Im Verlauf der Anpassungen habe ich auch mehr und mehr das Konzept hinter der Template-Vererbung verstanden. Für ganz drastische Änderungen am Aufbau ist (aus meinem bisherigen Verständnis) wahrscheinlich nur der Eingriff in die Controller wirklich zielführend. Da hab ich mich allerdings noch nicht rangetraut, zu mal das Ändern von Controllern nicht update-Sicher ist, richtig?

Vom jetzigen Standpunkt aus, ist Contao zumindest nicht mehr ganz so unübersichtlich wie zu Beginn. Aber es bedarf aber noch eeeeinigs an Einarbeitung

[mlweb]

Ich habe so ziemlich jede Template-Datei "überschrieben" und auf meine eigenen Bedürfnisse angepasst.

Was hast Du denn so besonderes drin?
Ich habe ja auch das ein oder andere geänderte Template im Einsatz, aber wenn Du schreibst "so ziemlich jede", dann verwundert schon arg.
Du solltest dabei auch Bedenken, dass die Pflege einer solchen Installation meist unnötig aufwendig wird, denn nur bei einigen Veränderungen kann man von der neuen Template-Engine gut profitieren.

[Andreas]

...so ziemlich jede Template-Datei "überschrieben"...
...drastische Änderungen am Aufbau...
...zu mal das Ändern von Controllern nicht update-Sicher ist, richtig?...

1. Ich denke dies ist experimentel und eine Art Spielphase von dir. In ein paar Monaten oder spätestens Jahren, wirst du dies nicht mehr machen. Dies wird wahrscheinlich auch vieles an ungewollten Ausgaben nach sich ziehen, da du das System noch nicht gut kennst.

2. Was verstehst du unter "drastische Änderung"? Beispiel?

3. Man kann nahezu alles Verändern, nötigenfalls eine eigene Erweiterung schreiben. Nicht updatesichere Manipulationen im Core sind nie eine Lösung. Im Laufe der Jahre wurde hier schon nahezu alles angefragt, du wirst also sehr viele Möglichkeiten über eine Suche, hier im Forum, in den Dokus und Videos finden.