Und schon wieder ist ein Jahr vorbei und ich blogge schon seit 15 Jahren auf dieser Seite. Immerhin sind in der Zeit 401 Beiträge zusammen gekommen. Aber auch heute ist noch nicht Schluss.
Es gab auch im letzten Jahr keinen neuen Besucherrekord. Ich muss wohl mal etwas zum Thema AI schreiben, damit es hier so richtig rund geht. 😀
Leider haben auf der deutschen Seite auch noch knapp 18% weniger Besuche stattgefunden, auf der englischen waren es nur 2% weniger. Woran das lag, kann ich natürlich nicht genau wissen, aber ich hoffe mal, dass alle, die aktiv lesen, auch die richtigen Inhalte finden. Falls nicht, dann wünscht euch gerne mal ein Thema. 🙂
Die Anzahl der Besuche auf der englischen Seite ist auch weiterhin stärker als auf der deutschen und konnte von 53,4% auf 57,8% zulegen. Vielleicht ist es also an der Zeit, auch diesen Beitrag ins Englische zu übersetzen, was ich bei den „Geburtstags-Beiträgen“ bisher nur einmal gemacht habe.
Der alte Platz 1 war wohl nur ein zeitlich begrenzter Erfolgsbeitrag, der ganz weit abgestürzt ist. Dafür haben wir einen alten bekannten wieder in der Spitze. Auf Platz 2 war schon häufiger in den Top3 vertreten. Keine Änderung gab es auf Platz 3. Es ist immer wieder spannend zu sehen, welche Beiträge am meisten gelesen werden. Die aktuellen Top3 sind aus den Jahren 2009, 2016 und 2017. Der meistgelesene ist also nur knapp ein halbes Jahr jünger als dieser Blog.
Noch immer kein neues Theme
Vor einem Jahr hatte ich hier verkündet, dass ich an einem neuen Theme arbeiten möchte. Und wie ihr in den vergangenen Beiträgen verfolgen konntet, mache ich sehr gute Fortschritte. Ich hatte eigentlich vor, heute zum Blog-Geburtstag das neue Theme zu verwenden, aber es ist noch nicht so weit, wie ich es gerne hätte.
Ich schreibe diesen Beitrag aus einem Hotel auf dem Rückweg vom WordCamp Europe 2024. Auch deshalb konnte ich nicht ganz so viel daran arbeiten. Gestern noch hatte ich im Zug den Footer endlich fertig und eigentlich waren damit alle Teile grundsätzlich neu erstellt, aber beim Exportieren in die Theme-Dateien war der Footer dann auf einmal kaputt. Das konnte ich heute reparieren, aber es gibt noch sehr viele kleine Details, die zu gestalten habe. Aktuell arbeite ich am Kommentare-Bereich unter den Beiträgen. Aber auch grundlegende Styles, wie etwa für Listen, Tabellen und ähnliches im Inhalt wollen angepasst werden. Mehr dazu dann aber in den zukünftigen Beiträgen.
Und dann habe ich auch festgestellt, dass nicht mein Blog-Geburtstag der perfekte Tag für das neue Theme ist, denn auch vor 12 Jahren habe ich zum Blog-Geburtstag noch nach einem neuen Theme gesucht und dieses dann genau einen Monat später aktiviert. Markiert euch also mal den 21. Juli im Kalender.
Fazit
Es ist also noch immer viel los und ich nutze viele freie Minuten in meiner Freizeit, um weiter am Blog zu arbeiten. Ich hoffe mal, dass fertige Theme dann auch noch andere glücklich machen wird.
Ach ja, während ich diese Zeilen tippe, läuft auf dem Fernseher im Hotelzimmer Fußball-EM. Aber wer mich kennt, wird wissen, dass ich nicht wirklich Fußball schaue. Daher gibt es als Video zum Ende auch nichts zu dem Thema, sondern passend aus der Schweiz das Video mit der Ankündigung zum nächsten WordCamp Europe, bei dem ich auf jeden Fall auch wieder dabei sein werde:
Der Header war immer der Teil des Themes, bei dem ich mir nicht sicher war, ob ich ihn genau so nachbauen könnte. Aber mit jeder neuen Core- oder Gutenberg-Version kamen mehr Optionen hinzu, um das gewünschte Layout umzusetzen. I denke zwar, dass ich noch etwas CSS dazu schreiben muss, um einige Dinge anzupassen, aber schauen wir uns mal an, wie weit ich schon gekommen bin.
Der Original-Header
Bevor ich euch mein erstes Ergebnis zeige, dass ich nur mit dem Website-Editor und den darin vorhanden Einstellungen erreichen konnte, schauen wir uns erst noch einmal den Original-Header an:
Der eigentliche „Header“ im Waipoua Theme ist nur die Zeile mit dem roten Hintergrund. Website-Titel, Website-Untertitel und die „Header Widget Area“ befinden sich im „Wrapper“ für den Inhalt. Ich habe aber für das neue Theme entschieden, den gesamten hier gezeigten Bereich als Header festzulegen.
Der neue Header
Schauen wir uns ohne weiter Umschweife also nun an, wie weit ich gekommen bin, den Header nur mit dem Website-Editor nachzubauen. Da ist das erste Ergebnis:
Man kann schon auf Anhieb einige klare Unterschiede erkennen. Es beginnt schon mit dem „Home-Link“ Block als erstem Element der Navigation. Hier gibt es keine Option, ein Icon anzuzeigen. Ich werde das vermutlich mit etwas CSS lösen, indem ich ein Hintergrundbild verwenden und den „Home“ Text „visuell verstecke“.
Der andere klare Unterschied ist das Suchfeld. Im Waipoua Theme Header hat es einen transparenten Hintergrund. Das Icon ist nur ein Hintergrundbild, die Suche hat also keinen „Button“. Wenn das Feld fokussiert wird, dann wird es ein wenig breiter, der Hintergrund wird weiß und Icon und Platzhaltertext grau. Das ist ein netter Effekt und der „Suche“ Block hat sogar eine ähnliche Option, aber da er rechts ausgerichtet ist, hatte es den Effekt, dass das Feld „nach links springt und sich dann nach rechts vergrößert“. Das was nicht wirklich schön und auch nicht barrierefrei. Daher habe ich mich dagegen entschieden. Ich werde aber dennoch wie zuvor beschrieben die Hintergrundfarbe ändern, nur leider gibt es dafür keine Einstellungen. Lediglich die Hintergrund- und Icon-Farbe für den Button kann man einstellen. Es war mir auch nicht möglich, die Höhe des Suchfeldes zu ändern.
Wenn wir uns die „zweite Header-Zeile“ ansehen, dann sehen wir einen Unterschied im Website-Titel, der unterstrichen und kleiner ist. Das ist auch etwas, das ich im Website-Editor nicht einstellen konnte, da alle Einstellungen wohl über Core-Styles überschrieben wurden, da diese spezifischer waren.
Die Icons hingegen sehen fast gleich aus. Sie sind 1px kleiner (die „normale“ Größe im Core ist etwas kleiner), aber dafür sind die Icons besser zentriert als im Original-Theme und es werden auch die aktuellen Icons verwendet (z.B. bei YouTube oder Instagram). Leider gibt es aber kein „Kommentare RSS“ Icon. Ich muss mal schauen, wie ich das dann in meinem Blog löse. Aber verwendet überhaupt noch jemand diesen RSS-Feed? 🤔
Die Struktur des Headers
Nachdem wir nun das Ergebnis im Frontend gesehen habe, können wir uns mal ansehen, wie die Struktur im Website-Editor aussieht und welche Blöcke ich verwendet habe:
Die meisten Dinge sind keine Überraschung. Aber einige Details sind vielleicht neu für euch. Wusstest ihr zum Beispiel, dass ihr im Navigation Block nicht nur Links, sondern auch Blocke wie „Home-Links“, „Suche“ oder viele andere Blöcke verwenden könnt? Das ist wirklich toll und hat den Vorteil, dass diese Blöcke dann auf kleineren Bildschirmen ebenfalls im „Hamburg-Menü“ verschwinden.
Die zweite „Header-Zeile“ ist größtenteils relative einfach gestaltet. Um Website-Titel und Website-Untertitel unten auszurichten – etwas, zu dem ich zuvor keine einfache Lösung finden konnte – habe ich einfach die Option „Vertikale Ausrichtung ändern“ im Spalten-Block verwenden können.
Der interessantere Teil ist aber vermutliche die Zeile mit den Social-Media-Links. Wie zuvor erwähnt gibt es hierzu in Waipoua die „Header Widget Area“, die ich dann zu einem weiteren Template gemacht habe, wie wir es schon für die Sidebar getan haben.
Fazit: eine Menge an Einstellungen
Es ist schwer, jeden einzelnen Schritt bei der Umsetzung des Headers zu beschreiben. Es waren einfach zu viele Einstellungen notwendig, um zu diesem Ergebnis zu kommen. Ihr könnt alle Änderungen im aktuellen Commit des Git-Repositories zu diesem Theme finden. Ich war sehr überrascht, dass alle Einstellungen nur in den Templates gespeichert wurden. Ich habe lediglich noch einen neuen templateParts Eintrag in der theme.json angelegt, damit man „Header Widget Area“ in der „Listenansicht“ lesen kann und nicht den Slug, wie im Screenshot zu sehen.
Mein nächster Schritt wird die Behebung der vielen kleinen Unterschiede im Header sein, die ich nicht mit dem Website-Editor alleine umsetzen konnte. Mal sehen, wie weit ich komme und wie gut es mir gelingt, das im nächsten Blogbeitrag zu erklären. Da ich gerade meine Reise zum WCEU gestartet habe und noch einige Zugfahrten vor mir haben, gibt es den nächsten Beitrag vielleicht schon nächste Woche.
Eigentlich wollte ich, wie im letzten Beitrag erwähnt, mit dem Header weitermachen. Darin hatten wir mit dem Website-Editor eine Sidebar mit einer „synchronisierte Vorlage“ erstellt. Die Umsetzung hatte aber einige Probleme, ich ich erst einmal angehen wollte, bevor ich weitere Vorlagen erstelle. Daher werden wir die erste aktuelle Version erst ainmal verbessern.
Die Sidebar als synchronisierte Vorlage
Für das „Index“ Template hatten wir ein zweispaltiges Layout erstellt und die Sidebar in der rechten Spalte platziert. Wenn wir und den Quellcode der Startseite ansehen, dann erhalten wir das folgende:
Die Sidebar ist hier mit einer ID referenziert. Diese Beitrags-ID gehört zur synchronisierten Vorlage und hat als post_type den Wert wp_block. Der post_content des Blocks entspricht den Blöcken, die wir zur Sidebar hinzugeführt hatten:
Hier sehen wir auch noch ein anderes Problem an der aktuellen Lösung: alle Headings (Überschriften) sind statisch in die Sidebar geschrieben. Das mag für eine Einzelseite in Ordnung sein, aber da ich einen mehrsprachigen Blog habe und das Theme auch für andere in allen Sprachen nutzbar machen möchte, müssten diese Strings übersetzbar sein. Wie erreichen wir das?
Umwandeln der synchronisierten Vorlage in ein Template bzw. eine Vorlage
Im ersten Schritt nehmen wir den letzten Codeschnipsel und speichern ihn in eine Datei. Wir könnten hierzu eine HTML-Datei verwenden, aber da wir den Inhalt übersetzen möchten, verwenden wir stattdessen eine PHP-Datei. Da die Sidebar nur ein Teil eines Templates, wie etwa dem „Index“ Templates ist, verwenden wir einen anderen Ordner. Am besten eignet sich hierfür das patterns Verzeichnis, was ja auch naheliegend ist, da es sich ja auch schon zuvor um eine Vorlage (Pattern) handelte.
Erstellen der Vorlage
Erstellen wir also zuerst eine Datei mit dem Namen patterns/sidebar.php und kopieren den Quellcode der synchronisierten Vorlage aus dem Website-Editor (gespeichert in der Datenbank) in diese Datei:
Jede Vorlage bekommt einen Header-Kommentar mit Eigenschaften wie Title, Slug und ähnliches. Da wir diese Vorlage nicht in der Auswahlliste der Vorlagen im Website-Editor benötigen, können wir Inserter: no im Header-Kommentar setzen.
Ihr könnt auch erkenne, dass nun alle Headings in Übersetzungsfunktionen stehen. Nun können wir die neue Vorlage in einem Template verwenden.
Die Vorlage verwenden
Da wir das „Create Block Theme“ verwendet haben, wurde die templates/index.html Datei bereits zuvor überschrieben, als wir alle Änderungen aus dem Website-Editor in die Theme-Dateien gespeichert hatten. Wie im ersten Codeschnipsel gezeigt, sollte dies die folgende Zeile enthalten:
<!-- wp:block {"ref":1842} /-->
Um nun die Vorlage zu verwenden, müssen wir dies mit einer Zeile wie der folgenden ersetzen:
<!-- wp:pattern {"slug":"kauri/sidebar"} /-->
Wir könnten das nun einfach direkt in der templates/index.html Datei tun, aber wir fügen noch einen weiteren Schritt dazwischen ein. Stattdessen erstellen wir zuerst eine Datei mit dem Namen parts/sidebar.html und fügen dort diese einzelne Zeile ein.
Aber wieso machten wir das? Neben Vorlagen gibt es noch eine zweite Art von „wiederverwendbaren Templates“. Diese andere Art sind „Template-Teile“, die als „Bereiche“ in eurem Theme betrachtet werden. Zwei davon haben wir bereits, nämlich „Header“ und „Footer“. Unsere „Sidebar“ ist im Grunde nichts anderes und daher macht es Sinn, diese auch als Template-Teil anzusehen. Daher sollten wir diese auch in der theme.json im Abschnitt templateParty hinzufügen:
Mit dem tagName Attribut, welches nicht für den wp:pattern Block verfügbar ist, können wir die Sidebar mit einem <aside> Tag umschließen, für eine bessere Barrierefreiheit.
Aufräumen
Nachdem wir die Sidebar in eine Vorlage im Theme verschoben haben, können wir nun gefahrlos zu „Design > Website-Editor > Vorlagen“ navigieren und dort die synchronisierte Vorlage (gespeichert in der Datenbank) löschen.
Fazit
Während man eine Theme/Layout baut, kann man das sehr gut und schnell im Website-Editor machen. Sobald man aber fertig ist, sollte man alle Änderungen in den Theme-Dateien speichern. Während dabei die meisten Änderungen durch das „Create Block Theme“ Plugin automatisch gespeichert werden, muss man manche Dinge noch manuell erledigen.
Nachdem wir nun Schriftarten und Farben haben können wir damit anfangen ein wenig Struktur in das Theme zu bringen. Einer Seite eine klare Struktur zu geben ist wichtig, um sie später responsive zu bekommen.
Waipoua Strukture
Das Waipou Theme hat in etwa die folgende Struktur:
Header (roter Hintergrund)
Home Icon
Navigation
Suche
Wrapper
Zweiter Header
Website-Titel
Website-Untertitel
Alternative: Website-Icon, hinzugefügt durch die Theme-Optionen
Social-Media-Icons
Inhalt
Sidebar (hellgrauer Hintergrund)
Footer
Die Hauptidee des „Wrapper“ ist es, etwas Padding links und rechts zu bekommen, wenn das Display kleiner wird. Der rote Header wird aber einem bestimmten Breakpoint zu einem einzelnen Hamburg-Menu-Icon, das vertikal nach unter öffnet und die Navigation sowie die Suche enthält (das Home-Icon fehlt in diesem Menü).
Leeres Theme Strukture
Schauen wir uns im Vergleich die Struktur des „leeren Themes“ an. Das erhaltet ihr bei der Verwendung der „Leeres Theme“ Vorlage aus dem (vereinfacht):
Header
Website-Icon
Website-Titel
Website-Untertitel
Navigation
Inhalt
Footer
Wenn wir das mit dem Waipoua Theme vergleichen, sieht das schon sehr viel einfacher aus. Aber etwas Wichtiges fehlt: die Sidebar.
Eine Sidebar hinzufügen
Sidebars findet man heutzutage nicht mehr so häufig auf Websites. Aber bei einem Blog-Theme machen sie meiner Meinung nach noch immer Sinn. Und da ich ja ein Theme nachbauen möchte, das eine Sidebar hat, füge ich auch eine hinzu. Nun, das Theme hat sogar eine Theme-Option für eine zweite Sidebar. In der zweiten, die zwischen Inhalt und Sidebar sitzen, können Sticky Posts angezeigt werden:
Ich konnte aber keine Möglichkeit finden, eine Auswahl anzubieten, mit der man dies für alle Seiten auswählen könnte. Daher habe ich mich entschieden, erst einmal nur mit einer einzelnen Sidebar für die erste Version des Themes zu verwenden.
Aber wie bekommen wir überhaupt eine Sidebar? Wir brauchen ein Element, das wir in mehreren Templates verwenden können und das immer den gleichen Inhalt hat. Die Antwort ist also: eine „synchronisierte Vorlage“. Die könnt ihr erstellen unter „Design > Website-Editor > Vorlagen“. Dort klickt ihr dann auf das Plus-Icon neben „Vorlagen“ und wählt „Vorlage erstellen“. Im Fenster wählt ihr dann als Name etwas wie „Sidebar“ und stellt sicher, dass die „Synchronisiert“ Einstellung aktiv ist. Nach einem Klick auf „Erstellen“ könnt ihr die Sidebar mit Inhalten befüllen. Im folgenden Beispiel habe ich die „Widgets“ aus dem klassischen Theme verwendet:
Für die Widget-Titel habe ich Überschriften-Blöcke verwendet. In manchen Blöcken müssen ein paar Einstellungen verändert werden. Im Suchen-Block habe ich den Button in das Feld verschoben und das Lupen-Icon eingestellt. Im Block für die letzten Kommentare habe ich alle Einstellungen deaktiviert, damit nur Name und Beitragstitel zu sehen sind.
Eine Sache, die ich beim ersten Versuch vergessen hatte: das Setzen einer Hintergrundfarbe und Paddings. Wir gruppieren also alle Blöcke in der Sidebar, setzen die Hintergrundfarbe auf „Background Secondary“ und unter „Größe > Innenabstand“ jeweils „20px“ vertikal und horizontal.
Platzieren der Sidebar auf der Seite
Nachdem wir nun die Sidebar haben, müssen wir sie noch in jedem Template einfügen. Fangen wir mit der Startseite an. Wir navigieren zu „Design > Website-Editor > Templates“ und wählen dort „Index“ aus, das einzige Template, das wir aktuell haben. Wie schon zuvor erwähnt, ist das Template eher simpel. Es verwendet lediglich einen „Abfrage-Loop“ Block im Inhalt. Das wird unsere „linke Spalte“. Richtig, wir verwenden einen Spalten-Block, um unser „Inhalt | Sidebar“ Layout zu bekommen. Die linke Spalte enthält dabei den Abfrage-Loop und die recht die Sidebar-Vorlage. So sieht das Egebnis aus:
Ich versuche mal zu erklären, was ich hier gemacht habe. Zuerst einmal habe ich den „Abfrage-Loop“ in die linke Spalte gepackt und die „Sidebar“ in die rechte. Der „Spalten“ Block hat in der „Größe > Innenabstand“ Einstellung einen horizontalen Abstand von „50px“. Die rechte Spalte hat unter „Einstellungen > Breite“ eine Breite von „300px“ eingestellt, da sie Sidebar eine feste Breite hat. Die linke Spalte hat in diesem Feld einen leeren Wert. Das erlaubt ihr, die restliche Breite einzunehmen. Somit erhalten wir also eine responsive linke Spalte und eine rechte mit einer festen Breite.
Die Gruppe um die Spalten ist notwendig, um eine Breite für den gesamten Inhalt zu setzen. Diese Breite setzen wir aber nicht in diesem Gruppen-Block im „Index“ Template, sondern wir stellen es unter „Stile > Layout > Größe“ (das schwarz/weiße Icon oben rechts) ein. Hier setzen wir „Inhalt“ fest auf „1100px“.
Das Ergebnis
OK, nachdem wir all diese Schritte abgeschlossen haben, erhalten wir das folgende Ergebnis, wenn wir die Startseite unseres neuen Themes besuchen:
Schön! Nicht wahr? OK, das Ergebnis sieht noch nicht nach dem aus, was wir am Ende haben wollen. Die Blöcke in der Sidebar sehen noch nicht wirklich gut aus. Aber für heute können wir zufrieden damit sein, dass wir es geschafft haben, ein Layout mit dem Inhalt und der Sidebar nebeneinander zu bekommen.
Fazit
Als ich zum ersten Mal versucht habe dieses Layout umzusetzen, habe ich mich damit recht schwergetan. Ich konnte keinen Weg finden, die „50px“ zwischen die beiden Spalten zu bekommen. Ich hatte zuerst noch eine mittlere Spalte mit „2px“ Breite, die sich dann zusammen mit dem Standardabstand von „24x“ zu „50px“ aufaddierten. Mit der neuen Version von WordPress können wir aber direkt einen Abstand von „50px“ einstellen. Das Twenty Twenty-Four Theme verwendet noch immer eine solche Spalte. Es hat sogar noch Spalten links und rechts, für etwas Padding. Zum Glück müssen wir das nicht mehr machen.
In der nächsten Woche werde ich wohl mit dem Styling des Headers weiter machen. Auch hier werden wir einen „Widget-Bereich“ brauchen, in dem die Social-Media-Icons platziert werden. Wir werden auch versuchen, die Elements auszurichten. Da könnte aber schwierig werden, denn bisher habe ich es noch nicht geschafft herauszufinden, wie ich Elemente unten ausrichten kann.
Aus persönlichen Gründen konnte ich einige Zeit lang nicht am Theme arbeiten und daher auch keine neuen Blogbeiträge schreiben. Aber jetzt bin ich wieder zurück und bekomme hoffentlich ein wenig mehr Geschwindigkeit ins Thema und kann vielleicht sogar häufiger als nur alle zwei Wochen bloggen. Ich habe noch immer das Ziel, mein neues Theme vor dem Blog-Geburtstag im Juni fertig zu haben.
Farben hinzufügen
Für viele Leute kann es sehr zur Wiedererkennung beitragen, wenn man die richtigen Farben (einer Marke) verwendet. Fangen wir also mit den Hauptfarben an. Bevor wir aber damit starten können, müssen wir uns mit einem der schwierigsten Probleme in der Informatik beschäftigen: Dinge benennen.
Farbnamen
Es gibt verschiedene Philosophien, sie man Farben benennen kann. Manche verwenden Namen wie primary, secondary, tertiary, usw. Aber als nicht Nicht-Muttersprachler in Englisch, und Legastheniker, kann ich einfach nicht merken, wie man dritten Namen schreibt. Geschweige denn, wie es mit dem vierten, fünften, … dann weiter geht. Daher verwenden andere Namen wie base, contrast, accent und für mehrere Varianten davon fügen sie dann ein numerisches Suffix ein, also z.B. contrast-2, contrast-3, usw. Das ist auch das Schema, das im Twenty Twenty-Four Theme verwendet wird.
Aber ehrlich gesagt weiß ich auch nicht wirklich, was der beste Weg ist, die Namen für die Farben festzulegen. Und da das neue Theme ja eine „Wiederbelebung“ eines ElmaStudio Themes ist, habe ich mir mal angesehen, wie es Ellen und Manuel aktuell handhaben. Wenn ich mir die beiden aktuellsten Themes Mugistore und SolarOne ansehe, dann kombinieren sie die Farbnamen zu etwas wie background-primary, font-primary, accent-primary, usw. Ich werde also versuchen es in meinem Theme genauso zu machen.
Farbwerte den Farbnamen zuweisen
Nachdem ich mich jetzt auf ein Namensschema festgelegt habe, möchte ich allen Farben aus dem Waipoua Theme einen Farbnamen im neuen Theme zuweisen. Daher habe ich erst einmal nach allen Farben im Theme gesucht und insgesamt 26 verschiedene gefunden. Das sind wirklich viele! Aber einige davon werden nur für bestimmte CSS-Selektoren verwendet und andere nur in den farbigen Buttons und Boxen, die Shortcodes verwenden.
Nach der Recherche zu jeder einzelnen Farbe und wo diese verwendet wird, bin ich schließlich bei den folgenden Farbdefinitionen gelandet:
Insgesamt sind es 29 Farbdefinitionen. Wenn man den Farbwähler im Block Editor öffnet, beispielsweise in einem Absatz-Block, dann sieht man das folgende:
Einige Farben sind hier „doppelt“, aber es ist genau, wie es auch andere ElmaStudio Themeas machen und ich denke, es ist eine gute Idee. Sagen wir zum Beispiel, dass ihr die Farbe aller Social-Media-Icons verändern möchtet. In diesem Fall müsst ihr nur den Wert von zwei dieser Farben verändern. Das wäre auch im „Style-Book“ möglich, aber über diesen Weg ist es sehr viel einfacher, vor allem dann, wenn ihr es in einem Child Theme anpassen möchtet.
Die Farben verwenden
Nachdem wir nun einige Farben haben, können wir diese verwenden. Um ein wenig mehr „Branding“ in das Theme zu bekommen, könnten wir mit der Header-Farbe anfangen. Das eigentliche Markup für den Header erstellen wir später, fangen wir also erst einmal im Website-Editor an:
Wie kommen wir zu diesem Ergebnis? Zuerst einmal navigieren wir zu „Design > Website-Editor“. Dort klicken wir dann zweimal in den Header und anschließend auf den „Bearbeiten“ Button. Ein alternativer Weg hierher ist „Design > Website-Editor >Vorlagen > Header“ und dann den Header auswählen, den ihr bearbeiten wollt (wir haben aktuell nur einen). Dort klick ihr entweder auf das „Bearbeiten Icon“ (den Beistift) oben links oder ihr klickt einfach noch einmal in der Header im Haupt-Fenster.
Anschließend öffnen wir dann die „Listenansicht“ und wählen dort den ersten „Gruppe“ Block aus. In diesem gehen wir dann in den „Block“ Einstellungen auf den „Stile“ Tab (der schwarz/weiße Kreis). Als „Hintergrund“ Farbe wählen wir die „Brand Primary“ Farbe (rot) und klicken dann auf die „Text“ Farbe.
Da Waipoua im Theme eine 75% transparent verwendet, wählen wir erst einmal „White“ (die zweite Farbe in der ersten Reihe) aus. Anschließend klicken wir auf den „Vorschau-Bereich“. Das ist das weiße Quadrat (in diesem Screenshot mit dem „Schachmuster“) über dem Quadrat mit „White #FFFFFF“ (Im Screenshot „Individuell #FFFFFFBF“). Jetzt können wir entweder direkt den HEX Code mit der Transparenz eintragen (in diesem Fall „#FFFFFFBF“), oder aber wir wählen im Drop-Down RGB oder HSL aus und ändern dann den Wert für „A“ auf einen Wert von „75“. Das sollte uns dann das Ergebnis aus dem Screenshot geben.
Ich hoffe, ihr konntet mir bis hierhin folgen. Für jeden einzelnen Schritt einen Screenshot zu machen, wäre etwas viel gewesen. Vielleicht muss ich nächstes Mal doch ein Video aufnehmen. 😀
Die Änderungen ins Theme speichern
Alle Änderungen, die wir bisher am Header gemacht haben, stehen aktuell nur in der Datenbank. Sie spiegeln sich noch nicht in den Dateien unseres Themes wider. Um die Änderungen aus dem Header Template zu kopieren, könnten wir das rohe HTML aus dem Website-Editor in unsere Datei kopieren. Anschließend könnten wir die Änderungen gefahrlos im Website-Editor zurücksetzen.
Ein einfacherer Weg ist hier allerdings wieder die Verwendung des Create Block Theme Plugins. Es fügt im Website-Editor ein Icon hinzu, über dass ihr dann den aktuellen Zustand des Themes als ZIP-Datei herrunterladen oder die Dateien in euren Theme aktualisieren könnt. Beachtet aber, dass hierbei die Dateien ohne weitere Rückfrage sofort überschrieben werden. Ich hoffe, dass ihr alle Versionsverwaltung und eine gute IDE verwendet, dann ist das nicht so schlimm. Aber seid hier vorsichtig.
Nachdem ihr auf das „Schraubenschlüssel“ Icon geklickt habt, öffnet sich die „Block-Theme erstellen“ Plugin-Seite. Darin könnt ihr dann auf den „Änderungen speichern“ Button klicken. Das speichert alles in euer Theme – nicht nur das aktuell geöffnete Template – und setzt anschließend alle Anpassungen in der Datenbank zurück.
Wir werden diese Option in Zukunft jedes Mal nutzen, nachdem wir Änderungen im Website-Editor vorgenommen haben. Nachtürlich könnten wir auch jedes Mal manuell den Code in die theme.json Datei schreiben, aber wieso sollten wird das tun? Stattdessen können wir das Theme einfach im Website-Editor erstellen und bekommen immer sofort eine Live-Vorschau.
Fazit
Das Setzen von ein paar Farben klingt erst einmal einfach, aber auch hier bedarf es etwas Planung. Ihr solltet wirklich sicher gehen, das von Anfang an richtig zu machen, bevor ihr anfangt Farben zu verwenden. Denn wenn ihr später etwas daran ändern möchtet, ist es sehr viel mehr Aufwand.
Nachdem wir nun unsere ersten Änderungen im Website-Editor gemacht haben, werden wir uns im nächsten Schritt um das Layout kümmern. Das wären zum Beispiel Spalten/Sidebar, Seitenbreite, Elemente im Header und Footer, usw. Es gab ein paar Dinge, bei denen ich mir nicht sicher war, ob diese umsetzbar wären, aber nachdem WordPress 6.5 gerade veröffentlicht wurde, scheinen einge Dinge einfacher geworden zu sein. Wenn das geklappt hat, könnt ihr euch schon bald auf den nächsten Blogbeitrag freuen.
Nachdem wir im letzten Beitrag das rohe Theme erstellt haben, ist es nun an der Zeit, ein paar grundlegende Dinge hinzuzufügen. Um schnell ein ähnlicheres Aussehen zu erhalten, könnten wir mit den Schriftarten anfangen.
Mein Blog verwendet die Standard-Schriftarten von Waipoua, ich habe allerdings die Hauptfarben in einem Child-Theme geändert. Das Theme sieht ohne Änderungen wie folgt aus:
WIe ihr also sehen könnt habe ich den Rot-Ton im Header geändert, sowie die Hintergrundfarbe der Sidebar. Außerdem habe ich die Social-Icons oben rechts eingefärbt. Der Rest sieht aber ziemlich ähnlich zum Parent-Theme aus.
Hinzufügen der Schriftarten
Das wird ein interessantes Kapitel. Stand heute würde man hierzu folgendes tun:
Herunterladen der Schrifarten – für Google Fonts verwende ich hierzu normalerweise den google-webfonts-helper und lade alle Varianten herunter
Speichern der Schriften in einem Ordner in eurem Theme
Definieren der Schriften in der theme.json Datei
Wenn ihr diesen manuellen Weg gehen wollt, dann ich euch die hervorragende Anleitung von Carolina auf der „Full Site Editing With WordPress“ website sehr empfehlen.
Aber da es bald eine neue Möglichkeit gibt Schriften zu einem Block-Theme hinzuzufügen, möchte ich diesen Weg kurz zeigen. Mit der aktuellen WordPress Version 6.4 müsst ihr hierzu noch zusätzlich das Gutenberg-Plugin installieren, da die Funktion noch nicht „final“ ist und somit noch nicht mit Version 6.4 in den Core gemerged wurde. Wir müssen uns also noch ein wenig gedulden.
Mit dem aktivierten Gutenberg-Plugin navigiert ihr dann zu „Design > Theme-Schriften verwalten“. Hier erhaltet ihr die folgende Ansicht:
Hier seht ihr eine Übersicht der aktuell im Theme vorhandenen Schriften auf der rechten Seite, sowie eine Vorschau für diese Schriften. Oben rechts könnte ihr die beiden Buttons „Google Font hinzufügen“ oder „Lokale Schrift hinzufügen“ verwenden, um eine neue Schriftart zu eurem Theme hinzuzufügen.
Fangen wir mit der Schriftart für Überschriften an. Hierfür wird die Google Font „Oswald“ verwenden. Wir klicken also auf den Button „Google Font hinzufügen“ und wählen dann im Dropdown die Schriftart aus. Anschließend sehen wir alle verfügbaren Varianten. Ich habe einfach alle über die Checkbox im Tabellenkopf ausgewählt:
Das Waipoua Theme hatte nur die Stärke 400 verwendet, aber da man mit einem Block-Theme mehr Kontrolle darüber hat, welche Schriften man wo verwenden möchte, fand ich es eine gute Idee einfach alle verfügbaren Varianten zur Verfügung zu stellen. Damit sieht dann der Text immer optimal aus, ganz egal, welche Stärke (sofern verfügbar) man verwendet.
Nach einem Klick auf den „Google Fonts zu deinem Theme hinzufügen“ Button solltet ihr eine Erfolgsmeldung wie „Die Schrift Oswald wurde zum Theme Kauri hinzugefügt“ sehen. Das gleiche machen wir jetzt noch einmal für die Schrift „PT Sans“ und wählen auch hier wieder alle Varianten aus.
Wenn wir nun zu „Theme-Schriften verwalten“ zurück navigieren, dann sollten wir diese neuen Schriften in der rechten Sidebar sehen können. Insgesamt haben wir zwei Schriften mit insgesamt 10 Varianten und einer Gesamtgröße von 1,5 MB hinzugefügt:
Ergebnis des Schriften-Imports
Sehen wir uns mal an, was wir nach dem letzten Schritt erhalten haben. Die Orderstruktur des Themes sieht nun wie folgt aus:
Wir haben also einen neuen Ordner „assets/fonts“ und darin liegen die Google Fonts. Da diese aber nur als TTF-Dateien von fonts.google.com heruntergeladen werden können, erhalten wir auch genau dieses Format mit der (aktuellen) Schriften-Verwaltung von Gutenberg.
Aber schauen wir uns mal die theme.json Datei an, denn das ist der interessantere Teil des ganzen Schritts. Ihr solltet nun etwas finden, das in etwa so aussieht:
Nach der „System Font“ finden wir nun eine neue Definition für jede Variante unsere beiden neuen Schriften. Das ist eine ganze Menge Code, der uns hier automatisch erstellt wurde, und den wir somit nicht selbst schreiben müssen.
Wenn ihr nun aber die Seite neu ladet, dann werdet ihr erst einmal keine Änderung sehen. Das liegt daran, dass wir nun zwar die neuen Schriften zu unserem Theme hinzugefügt haben, sie aber noch an keiner Stelle in der theme.json Datei verwenden.
Schriften für Inhalt und Überschriften festlegen
Man kann die Schriftart für die ganze Seite, für bestimmte „Arten“ von Elementen, oder aber für individuelle Blöcke einstellen. Um das Ergebnis zu erhalten, das wir wollen, müssen wir das folgende zu unserer theme.json Datei hinzufügen:
Das legt die Schriften für den Inhalt sowie alle Überschriften fest, also sowohl Überschriften im Inhalt, als auch im core/site-title oder anderen „Überschriften“ Blöcken. Wir werden das später noch einmal etwas genauer anpassen müssen, aber aktuell erhalten wir damit das folgende Ergebnis:
Wenn es um die Schriften geht, dann sieht unsere Seite schon sehr viel mehr nach dem Original-Theme aus. Aber das ist natürlich lediglich der erste Schritt. Wir müssen noch viele weitere Dinge anpassen.
Bonus: Eine WOFF2 anstelle einer TTF Schrift verwenden – der beide
An der aktuellen Lösung mag ich nicht wirklich, dass sie TTF Dateien verwendet. Diese werden in der Regel für Desktop verwendet, und nicht im Web. Auch wenn sie von den meisten Browsern unterstützt werden, so sind sie doch sehr viel größer.
Mit diesen Änderungen konnte ich die Größe aller Fonts von 1,5 MB auf nur noch ungefähr 590 KB für alle Varianten verringern. Auch wenn dieser Schritt nicht unbedingt notwendig ist, würde ich ihn euch doch sehr empfehlen. Es sei denn, ihr müsst unbedingt noch sehr alte Browser unterstützen. Dann könnt ihr natürlich auch ein anders Format mit dem google-webfonts-helper herunterladen.
Ihr könnt aber auch die TTF-Dateien als Fallback behalten. Dann könnte das in etwa wie folgt aussehen:
Versteckte Funktion der „Theme-Schriften verwalten“ Funktionalität
Beim committen der Änderungen am Theme war mit aufgefallen, dass die readme.txt Datei verändert worden war. Zuerst dachte ich, dass ich daran bestimmt etwas geändert hatte. Aber dann sind mir folgende zusätzliche Zeilen aufgefallen:
Die Funktionalität kümmert sich also nicht nur darum, dass die Schriften heruntergeladen, im Theme gespeichert und zur theme.json Datei hinzugefügt werden. Sie stelle auch sicher, dass ihr die notwendigen rechtlichen Angaben in euer readme.txt Datei habt. Wie cool ist das denn?! 🤓
Zusammenfassung
Das Hinzufügen von Google Fonts (oder Schriften aus anderen Quellen) kann über zwei Wege geschehen: manuell oder über „Theme-Schriften verwalten“. Während letzteres noch nicht ganz „fertig“ ist, funktioniert es doch erstaunlich gut. Wenn sie jetzt noch eine Funktion hinzufügen, mit der man ein anderes Format auswählen kann (oder den Standard ändern), dann kann ich es kaum erwarten, bis diese Funktion im Core landet.
Ich hatte eigentlich ursprünglich geplant in diesem Beitrag auch noch darüber zu schreiben, wie man Farben und die Breite der Seite festlegt. Aber ich denke mit dem Thema über Schriften reicht es auch für diesen Beitrag.
Dies ist der Anfang einer neuen Beitrags-Serie für mein neues Blog-Theme. Wie in meinem vorherigen Blogbeitrag erwähnt, ist es mein Ziel, ein Theme zu bauern, das so nah an das aktuelle Design heran kommt, wie möglich. Dabei möchte ich nur den Website-Editor verwenden, um alle Styles und Templates zu erstellen.
Erstellung des Themes
Wenn ich in der Vergangenheit Themes von Grund auf entwickelt habe, dann habe ich hierzu meistens _s (underscores) verwendet. Aber da dies ein „Classic Starter Theme“ ist, brauchte ich etwas anderes. Glücklicherweise gibt es das „Create Block Theme“ Plugin, mit dem man ein Theme innerhalb einer WordPress Installation erstellen kann.
Nach der Installation und Aktivierung des Plugins navigiert man zu „Design > Block-Theme erstellen“ und wählt „Leeres Theme erstellen“ als Option aus. Auf der rechten Seite erscheint dann ein Formular, in dem ihr Name, Beschreibung, usw. für das neue Theme eintragen müsste. Das sind die Daten, die man für gewöhnlich im Header-Kommentar der style.css Datei findet.
Nachdem ihr das Formular ausgefüllt habt, klickt ihr auf den „Erstellen“ Button unten links. Das erstellt das neue Theme in eurer WordPress Installation. Jetzt könnt ihr es aktivieren und euch eure Seite ansehen. Das Ergebnis sollte in etwa wie folgt aussehen:
Wunderschön, nicht wahr? OK, noch nicht ganz das, was wir brauchen. Aber es ist bereits ein voll funktionsfähiges Block-Theme und wir können anfange, all die Styles hinzuzufügen, die wir brauchen.
Die Dateistruktur des Themes
Bevor wir aber mit unseren Arbeiten an Theme loslegen, schauen wir uns erst einmal an, was wir haben. Die initiale Dateistruktur unseres neuen Themes sieht wie folgt aus:
Nicht wirklich viel. Aber wir haben bereits zwei „Parts“ für Header und Footer. Das einzige „Seiten Template“, das wir haben, ist die index.html Datei. Die style.css Datei ist im Grunde leer. Sie enthält lediglich die Header-Kommentare mit den Daten aus dem Formular. Interessanterweise finden wir darin eine Zeile mit der Angabe Requires PHP: 5.7, obwohl es diese PHP Version nie gab. 😅
Die wichtigste Datei ist aber die theme.json Datei. In dieser Basisversion hat sie lediglich 35 Zeilen und definiert ein paar Layout-Größen, Spacing-Einheiten und eine Sytem-Font-Family, sowie die Template Parts für den Header und Footer.
Im nächsten Blogbeiträgen dieser Serie werden wir recht viel mit dieser Datei arbeiten.
Der Name des neuen Themes
Wie ihr vielleicht schon festgestellt habt, habe ich das neue Theme „Kauri“ genannt (sowie die Entwicklungs-Seite). Das aktuelle Theme meines Blogs heißt Waipoua. Elmastudio benennt alle Themes nach Dingen in Neuseeland oder Asien. Der Waipoua Forest ist ein Wald in der Northland Region von Neuseeland. Dieser Forest zeige eine Auswahl von Kauri-Bäumen. Und spätestens jetzt sollte klar sein, wieso ich diesen Namen gewählt habe. 😊
Nächste Schritte
In der nächsten Ausgabe machen wir die ersten Anpassungen an der theme.json Datei. Vielleicht fügen wir ein paar Fonts ein, oder geben dem Theme eine generelle Breite. Bleibt also gespannt.
Wenn ihr dem Code folgen wollt, dann findet ihr den aktuellen Stand auf GitHub. Aber bitte erstellt noch keine Issues oder Pull-Requests, bevor ich diese Beitrags-Serie nicht abgeschlossen habe. 😁
Es ist zwar nicht das neue „Blog-Jahr“, aber ein neues auf unseren Kalendern. In den letzten Jahren habe ich mir über die Feiertage oft vorgenommen, das Theme meines Blogs neu zu machen. Dieses Jahr habe ich endlich damit begonnen … am 1. Januar 😅
Weiterführung von #projekt26
Eines vorweg: Ich werde auch weiterhin am #projekt26 teilnehmen, also alle zwei Wochen etwas posten. Normalerweise plane ich hierbei die Beiträge nicht wirklich im Vorfeld. Aber dieses Jahr habe ich mir ein zweites Projekt vorgenommen, wodurch ich hoffentlich sehr viel einfacher Themen finden werde. Ich werde aber zwischendurch vermutlich auch über anderes bloggen.
Ein neues, altes Theme
Aktuell verwende ich das schöne Waipoua Theme von Elmastudio. Ich verwende es schon seit Juli 2012 und liebe noch immer das klassische Blog-Design. Aber da es sehr als ist, gibt es auch einige Dinge, die es niciht mehr zum perfekten Theme machen. Gerade wegen der Probleme bezüglich der Barrierefreiheit möchte ich es ersetzen.
Frisch starten, aber das Aussehen übernehmen
Das optimale Ergebnis wäre natürlich eines, das auf eine neue technische Basis gestellt wird, aber eine exakte „Pixel-perfekte“ Kopie ist. Weil ich aber auch den Website-Editor für das neue Theme verwenden möchte, scheint das nicht möglich zu sein. Da ich mir unsicher war, welches Ziel ich verfolgen sollte, habe ich mal auf Twitter gefragt:
Im Resultat und den Kommentaren haben die meisten gesagt, dass ich nur das generelle Aussehen des Themes übernehmen sollte und genau das werde ich versuchen.
Eine Beitrags-Serie mit Schritt-für-Schritt-Anleitung
Für die zukünftigen Beiträge habe ich geplant, jeden einzelnen Schritt in der Erstellung des neuen Themes zu dokumentieren. Ich hoffe, dass das für viele von euch hilfreich sein wird, die eine ähnliche Idee haben. Und da ich normalerweise in meiner täglichen Arbeit keine (neuen) Themes erstelle, kann ich dabei auch viel lernen und mich besser mit dem Website-Editor vertraut machen.
Meine erste lange Beitrags-Serie
Ich habe schon ein paar Beitrags-Serien gemacht, aber diese hier wird wohl mindestens ins zweite Quartal dieses Jahres reichen. Vielleicht schaffe ich es ja, mit dem neuen Theme zum Blog-Geburtstag im Juni zu starten.
Ich werde auch versuchen, den ganzen Code-Fortschritt öffentlich zu machen und auch eine Staging-Seite des aktuellen Stands erstellen. Aber mehr hierzu im nächsten Beitrag.
Falls ihr das Theme selbst verwendet, würde ich mich sehr freuen, wenn ihr mit Feedback dazu geben könnt, was ihr gerne im neuen Theme sehen möchtet. Oder vielleicht habt ihr selbst mal etwas Ähnliches gemacht, dann hinterlasst sehr gerne einen Kommentar.
Zum wiederholten Male hatte ich diese Woche Probleme, mich per SSH mit einem Server zu verbinden. Es war mit einem anderen User und irgendetwas hat nicht funktioniert. Wenn ich solche Fehler debugge, muss ich immer wieder danach suchen, wie man den Debug-Modus aktivieren kann. Daher schreibe ich das jetzt mal in meinem eigenen Blog auf, damit ich es nächstes Mal schneller wiederfinde.
Starten eines zusätzlichen OpenSSH-Daemon im Debug-Modus
Ihr könnte recht einfach den Debug-Modus im Client aktivieren, aber oft liegt das Problem auch auf dem Server. Um das zu debuggen, könnt ihr den Debug-Modus im Hauptprozess aktivieren. Aber es ist oft einfacher und sicherer, einen zusätzlichen SSH-Daemon unter einem anderen Port und mit aktiviertem Debug-Mode zu starten. Das könnt ihr mit dem folgenden Befehl machen:
/usr/sbin/sshd -ddd -D -p 22222
Ihr müsst hier den vollständigen Pfad zu sshd verwenden. Mit dem -D Parameter wird sshd nicht als Daemon im Hintergrund ausgeführt und ihr könnt die Log-Ausgabe sehen. Mit -ddd wird das maximale Debug-Level aktiviert. Und mit -p 22222 verwenden wir einen anderen Port.
Den Debug-Mode des Clients verwenden
Nachdem wir nun einen Server-Prozess mit aktivierten Debugging haben, der auf einkommende Verbindungen wartet, können wir uns mit einem Client verbinden. Dazu verwenden wir den folgenden Befehl:
In diesem Beispiel verwenden wir den zuvor gesetzten Port 22222. Wir spezifizieren hier auch einen anderen Secret-Key mit -i ~/.ssh/id_ed25519 und schließlich setzen wir mit -vvv auch das maximale Debug-Level für den Client.
Zwei typische Fehler für SSH-Server und Client
Jetzt sollten wir in der Lage sein, die Fehler von Server und/oder Client zu finden. Hier sind zwei typische Fehler, denen ich oft begegne.
Falsche Dateiberechtigungen auf dem Server
Fehler mit SSH sind sehr oft falsch gesetzte Berechtigungen für Dateien und Ordner. Das ist ein typischer:
debug1: trying public key file /home/user/.ssh/authorized_keys
debug1: Could not open authorized keys '/home/user/.ssh/authorized_keys': Permission denied
Wenn ihr diesen Fehler seht, dann habt ihr vielleicht den Public-Key korrekt zu authorized_keys Datei hinzugefügt, die Datei ist aber nicht durch den SSH-Daemon lesbar. Um das zu korrigieren, solltet ihr die Berechtigungen in etwa so anpassen:
Wenn ihr einen Fehler beim letzten Verbindungsversuch bekommen habt, dann wurde der Server-Prozess vermutlich beendet. Ihr solltet also sicherstellen, dass ihr ihn vor dem nächsten Versuch neu startet.
Falsche Dateiberechtigungen im Client
Auch beim Client führen sehr oft falsche Berechtigungen zu Fehlern. Wenn die Berechtigungen „zu offen“ sind, dann bekommt ihr eine Meldung, die in etwa so aussieht:
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
@ WARNING: UNPROTECTED PRIVATE KEY FILE! @
@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
Permissions 0777 for 'id_ed25519' are too open.
It is required that your private key files are NOT accessible by others.
This private key will be ignored.
Load key "id_ed25519": bad permissions
debug2: we did not send a packet, disable method
debug1: No more authentication methods to try.
user@example.com: Permission denied (publickey).
Die Lösung hierfür ist sehr ähnlichen zum Server. Aber in diesem Fall müsst ihr sicherstellen, dass die Berechtigungen nicht zu weitgefasst sind und nur der User Zugriff auf den Private-Key hat:
Der Public-Key kann auch durch andere lesbar sein. Der zweite Befehl ist also optional.
Fazit
Es gibt viele Probleme, auf die ihr bei der Arbeit mit SSH stoßen könnt. SSH ist wirklich sehr strikt, wenn es um Berechtigungen geht. Wenn ihr den Fehler mit einem zu offenen Private-Key hattet und auf einem Client/Computer arbeitet, auf dem es auch andere User gibt, dann solltet ihr den Key am besten wegwerfen und einen neuen erstellen. Wenn ihr hierzu ssh-keygen verwendet, dann hat das eine Schlüsselpaar auch gleich die richtigen Berechtigungen.
Ich verwende zheutztage nur noch SSH um mich per Terminal zu Servern zu verbinden oder Dateien zu übertragen. Die Verwendung von Schlüsselpaaren ist hierbei oft der beste Weg. Aber diese Berechtigungen können echt schwierig sein. Hoffentlich wisst ihr nun, wie ihr solche Fehler debuggen könnt – genau wie ich, denn jetzt kann ich hier nächstes Mal nachlesen, wie ich den Debug-Modus verwenden kann. 😀
Die Befolgung von Coding-Standards ist nicht nur wichtig, wenn man alleine programmiert, sondern noch viel wichtiger, wenn man in einem Team arbeitet. Es bedeutet weniger Fehler und vermeidet unnötige Änderungen bei der Nutzung einer Versionskontrolle, was auch schnell zu Konflikten führen kann.
Ich nutze PhpStorm als meine IDE und bei der Entwicklung von WordPress Plugins und Themes heutzutage „wp-scripts“ um SCSS oder JavaScript zu kompilieren. Dieses Paket kommt auch mit „Stylelint„, einem Kommandozeilen-Tool für das „linten“ eures Codes.
Ausführen des Linters auf der Kommandozeile
Ihr könnt den „lint-style“ Befehl von „wp-scripts“ in eurer package.json Datei konfgurieren. Anschließend könnt ihr ihn wie folgt ausführen:
$ npm run lint:style
> @2ndkauboy/dark-mode-for-astra@1.0.0 lint:style
> wp-scripts lint-style
src/style-dark-mode.scss
5:3 ✖ Expected empty line before comment comment-empty-line-before
11:22 ✖ Expected a leading zero number-leading-zero
22:6 ✖ Expected indentation of 2 tabs indentation
27:9 ✖ Expected indentation of 2 tabs indentation
72:6 ✖ Expected empty line before at-rule at-rule-empty-line-before
5 problems (5 errors, 0 warnings)
Nachdem ihr den Befehl ausgeführt habt, seht ihr eine Liste von Problemen, die gefunden wurden. In der letzten Spalte findet ihr auch den Namen der Regel. Falls ihr eine dieser Regel ignorieren/ausschließen wollt, könnt ihr eine eigene Konfigurationsdatei in eurem Projekt anlegen.
Ausführen der Tests im Code-Editor von PhpStorm
Diese Tools können sehr gut auf der Kommandozeile oder später im CI-Prozess (z.B. in einer GitHub Action) verwendet werden. Aber in der Regel kommen die Tests dann zu spät, denn man hat den Fehler schon gemacht und/oder ihn sogar commitet. Wäre es nicht schön, wenn man schon früher auf die Fehler hingewiesen wird? Glücklicherweise hat PhpStorm eine gute Integration für Stylelint. Ihr findet sie unter „Settings | Languages & Frameworks | Style Sheets | Stylelint“. Hier müsste ihr zuerst „Enable“ auswählen und könnt dann die Parameter konfigurieren.
Wenn ihr mit Windows und WSL2 arbeitet, dann könnte eure Konfiguration in etwa so aussehen (ihr müsst hier natürlich die Pfade entsprechend eures lokalen Setups anpassen):
Stylelint package: \wsl$\Ubuntu\home\bernhard\PhpstormProjects\theme-tests\wp-content\plugins\dark-mode-for-astra\node_modules\stylelint Configuration file: \wsl$\Ubuntu\home\bernhard\PhpstormProjects\theme-tests\wp-content\plugins\dark-mode-for-astra\node_modules\@wordpress\scripts\config.stylelintrc.json Run for files: **/src/{**/*,*}.{css,scss}
Auf Linux/Mac, könnte es so aussehen (auch hier die Pfade anpassen):
Stylelint package: ~/PhpstormProjects/theme-tests/wp-content/plugins/dark-mode-for-astra/node_modules/stylelint Configuration file: ~/PhpstormProjects/theme-tests/wp-content/plugins/dark-mode-for-astra/node_modules/@wordpress/scripts/config.stylelintrc.json Run for files: **/src/{**/*,*}.{css,scss}
In diesem Beispiel habe ich „Run for files“ auf den src Ordner begrenzt. Auf meinem Linux-System hat PhpStorm nämlich ansonsten jede einzelne CSS/SCSS Datei im gesamten Projekt überprüft und mein System lahmlegt. Falls ihr, wie zuvor erwähnt, eine eigene Konfigurationsdatei verwendet, könnt ihr diese bei „Configuration file“ angeben. Ansonsten könnt ihr die Standarddatei, wie hier gezeigt, verwenden. Wenn ihr den Pfad zum „Stylelint package“ richtig konfiguriert habt, dann seht ihr im Einstellungsfenster in dieser Zeile auf die installierte Versionsnummer:
Überprüfung der Fehler beim Tippen
Nachdem wir die Integration für Stylelint eingerichtet haben, können wir die Datei mit den vorhanden Fehlern im Editor öffnen:
In diesem Screenshot sieht man mehrere Dinge bezüglich der von Stylelint gefundenen Fehlern. In der rechten Scrollbar seht ihr eine rote Hervorhebung für jede Zeile mit einem Fehler. Oben rechts können wir 5 Fehler in der Datei sehen (genau wie bei dem Aufruf auf der Kommandozeile). Im Code-Editor selbst sehen wir jeden Fehler als rote Unterstreichung. Wenn man mit der Maus auf einen dieser Fehler geht, werden mehr Details angezeigt, auch hier wieder mit dem Namen der Regel, gegen die verstoßen wurde.
Fehler auf der Kommandozeile beheben
Stylelint bring einen Parameter mit, mit dem man Fehler automatisch beheben kann – falls das möglich ist. Das sind in der Regel „Whitespace-Fehler“. Um solche behebbaren Fehler automatisch zu beheben, kann folgender Befehl verwendet werden:
npm run lint:style -- --fix
Da wir „wp-scripts“ in einem npm Skript verwenden, müssen wir noch zwei Bindestriche zwischen dem Befehl und dem Parameter hinzufügen, damit dieser weitergereicht wird.
Fehler in PhpStorm beheben
Da wir Stylelint ja schon in den Editor integriert haben, können wir die Fehler auch direkt dort beheben. Hierzu klickt ihr auf einen unterstrichenen Fehler. Nach etwa einer Sekunde könnt ihr dann auf den Pfeil nach unten neben der roten Glühbirne klicken. Hier wählt ihr dann „Stylelint: Fix current file“ – das sollte alle behebbaren Fehler in der aktuellen Datei korrigieren:
Fazit
Es ist sehr wichtig, sich an Coding-Standards zu halten. Die richtigen Tools können euch dabei helfen und die Integration vieler dieser „Quality Tools“ durch PhpStorm macht es euch noch leichter. Ich würde mir nur wünschen, dass PhpStorm diese Tools auch automatisch erkennt und „pro Ordner“ anwendet, statt auf dem gesamten Projekt. Aber mir persönlich spart dieser kleine Konfigurationsschritt in der Programmierung und Behebung solcher Fehler viel Zeit ein.