Ein Theme verteilen #

Teil 6, Kapitel 8. Ein Theme ist die sichtbarste Erweiterung überhaupt und die am leichtesten wiederverwendbare. Bevor Sie eines veröffentlichen, müssen Sie sicher sein, dass Sie alles darin weitergeben dürfen: Code ist nur ein Teil eines Themes. Dieses Kapitel behandelt, was beim Veröffentlichen eines Themes anders ist; das allgemeine Vorgehen für Releases beschreibt Teil 7.

Alles in einem Theme hat eine Lizenz #

Bei den letzten beiden Zeilen gehen Themes schief. Für eine Website gekaufte Demofotos dürfen womöglich nicht weitergegeben werden. Ein Theme, das mit dem Logo eines Kunden ausgeliefert wird, gibt dieses Logo jedem. Ersetzen Sie sie durch freie Bilder (mit ihrem Nachweis) oder einfache Platzhalter.

Beachten Sie, dass ein aus dem Kernel kopiertes Template GPL ist, auch wenn der Rest Ihres Themes unter einer anderen Lizenz steht; die einfachste Wahl für ein Theme ist deshalb GPL-2.0-or-later für alles.

Nachweise im Theme #

• Eine Datei LICENSE für das Theme.
• Die Lizenzdatei jeder Bibliothek, jeder Schrift und jedes Symbolsatzes daneben (sevenx_themes_simple hält sein CSS von Dritten unter stylesheets/libs/).
• Ein Eintrag Includes in ezinfo.php für jede mitgelieferte Bibliothek oder Schrift, damit die Infoseite sie aufführt (Namensnennung und Copyright-Hinweise).
• Ein Abschnitt „Credits“ in der README, der Bilder und ihre Urheber nennt, wo deren Lizenz das verlangt.

Inhaltsklassen: Pakete #

Die Templates eines Themes erwarten Inhaltsklassen (article, blog_post, event). Eine Website, die das Theme installiert, hat sie womöglich nicht. Liefern Sie sie als Pakete aus: Exportieren Sie jede Klasse als .ezpkg-Datei in den Ordner packages/ des Themes, wie es sevenx_themes_simple tut, und beschreiben Sie in der README, wie man sie importiert (Pakete und der Paketersteller). Liefern Sie nie einen Datenbank-Dump aus.

Einstellungen, die die Website vornehmen muss #

Die Website muss Ihr Design immer noch auswählen (Themes und Siteaccesses). Schreiben Sie die genauen Zeilen in die README. Liefern Sie settings/siteaccess/<name>/ im Theme mit, nennen Sie die Namen der Siteaccesses, die es erwartet.

composer.json #

Ein Theme wird wie jede Erweiterung installiert (composer.json modernisieren):

{
    "name": "your-account/mytheme",
    "description": "My theme: a clean, responsive theme for Exponential 6 sites, with dark mode.",
    "type": "ezpublish-legacy-extension",
    "license": "GPL-2.0-or-later",
    "keywords": ["exponential", "theme", "design"],
    "require": {
        "php": "^8.0",
        "se7enxweb/ezpublish-legacy-installer": "*"
    },
    "extra": {
        "ezpublish-legacy-extension-name": "mytheme"
    }
}

Die README eines Themes #

Die README eines Themes sollte das Theme zeigen. Nehmen Sie auf:

1. einen Screenshot der Startseite und einer Inhaltsseite, im hellen und im dunklen Modus;
2. was es braucht (Inhaltsklassen, andere Erweiterungen wie ezjscore);
3. die Installation: Composer, Aktivierung, die Siteaccess-Einstellungen, der Import der Pakete;
4. was sich über Einstellungen anpassen lässt und wie man darauf eine Variante baut (Themes und Siteaccesses, „Ein Theme auf einem Theme“);
5. Nachweise und Lizenzen.

Vor dem ersten Release #

• To do: Jedes Bild, jede Schrift, jedes Symbol und jede Bibliothek ist für die Weitergabe lizenziert, mit ihrer Lizenzdatei.
• To do: Kein echtes Firmenlogo, keine Kundeninhalte, keine Fotos echter Personen ohne deren Erlaubnis.
• To do: Keine Knoten-IDs oder Hostnamen Ihrer eigenen Website in Templates oder Einstellungen.
• To do: Keine Sicherungsdateien des Editors und keine ungenutzten minimierten Kopien.
• To do: Funktioniert im hellen und im dunklen Modus und in Smartphone-Breite.
• To do: Funktioniert unter einer Content Security Policy mit 'self' (Theme-Assets, der Packer und CSP).
• To do: ezinfo.php, extension.xml und composer.json enthalten Version und Lizenz.
• To do: Die README hat Screenshots und Installationsschritte.

Veröffentlichen Sie es dann so, wie Teil 7 es beschreibt, und sagen Sie den Leuten dort Bescheid, wo sie nach Themes suchen (Die Community durch Code wachsen lassen).

Verwandte Seiten #

• Zurück: Dunkler Modus und Design-Tokens in Themes
• Weiter: Wo die Hilfe für Designer weitergeht
• Lizenzen und wie sie zusammenpassen
• Pakete
• Freie Dokumentation: Diese Seite darf unter der GNU FDL 1.3 frei kopiert, übersetzt und verbessert werden.