Die To-do-Liste für die Dokumentation

Hier stellen wir Themen vor, an denen für die Benutzerdokumentation gearbeitet werden kann.

Während des PBF stellen wir eine Tabelle mit allen Themen zur Verfügung, an denen gearbeitet werden kann. In dieser Tabelle kann der eigene Name hinter ein Thema eingetragen werden, an dem gerade gearbeitet wird, um Doppelarbeit zu vermeiden.

Eine detaillierte Liste findet sich unter https://github.com/joomla/documentation/issues. Dort finden sich auch Diskussionen zu einem Thema und Hintergrundinformationen. Dort kann ebenfalls vermerkt werden, dass gerade an einem bestimmten Artikel gearbeitet wird, um zu vermeiden, dass jemand anderes am selben Thema arbeitet.

Im Rampenlicht: Übersichtsseiten

Ein Blick auf die Erklärungen im Benutzerhandbuch zeigt, dass diese nach Themen gruppiert sind. Jedes Thema hat eine Übersichtsseite, die informiert, welche Art von Informationen auf den darunterliegenden Seiten zu finden sind. Unter Beiträge finden sich beispielsweise 25 Seiten, die alle möglichen Dinge rund um Beiträge erklären. Auf der Übersichtsseite werden diese Seiten in strukturierter Form vorgestellt.

Hier ist eine Liste fehlender Übersichtsseiten. Je mehr Artikel unter dieser Übersichtsseite liegen, desto größer ist der Bedarf an einer guten Übersichtsseite.

Im Rampenlicht: Tutorials zum Website-Aufbau

Im Moment liegt der Fokus auf Tutorials zum Website-Aufbau. Schritt-für-Schritt-Anleitungen, die alle Konzepte zeigen, die beim Aufbau einer Website mit Joomla verwendet werden.

Wie diese Tutorials zum Website-Aufbau aufgebaut sind und welche vorhandenen Artikel des Benutzerhandbuchs dafür verwendet werden können, findet sich in diesem Tabellenblatt (in Arbeit).

Weitere Informationen finden sich in allen Unterpunkten dieses Issues: ... todo...

Siehe das Menü auf der linken Seite der Tutorials-Seite. Dort lässt sich sehen, wie ein Tutorial aussehen kann.

Über Tutorials

Ein Tutorial ist fast nie vollständig. Es zeigt nur einen Weg, etwas zu tun, nicht alle alternativen Möglichkeiten dafür.
Hauptziel ist es, einige Konzepte zu vermitteln. Keine langen Erklärungen. Ein Tutorial bedeutet Lernen durch Ausprobieren.
Das Tutorial bietet eine Reihe von Schritten, die der Leser nachvollziehen kann und die zu einem reproduzierbaren Ergebnis führen. Der Weg ist dabei jedoch wichtiger als das Ergebnis.
feste Reihenfolge:
- Beginn mit einer Übersicht der Voraussetzungen: welche Tutorials vorher durchgeführt werden müssen.
- Dann eine Zusammenfassung, worum es in diesem Tutorial geht (kurze Beschreibung des Beispiels).
- Dann die zu befolgenden Schritte
- Abschluss mit einem Fazit: Zusammenfassung der behandelten Konzepte.

Weitere Themen, an denen gearbeitet werden könnte:

Benutzerdefinierte Felder.
Anleitungen mit mod_articles.
Tutorial: Ein Modul zum Dashboard hinzufügen.
Template-Overrides.
Nützliche Magazinartikel.

Benutzerdefinierte Felder

Benötigt:

ein Tutorial, das erklärt, wie benutzerdefinierte Felder verwendet werden; derzeit: https://docs-core.sandbox.joomla.org/user-manual/fields/fields-fields-and-field-groups
Von allen Artikeln, die sich derzeit unter „Felder“ befinden, gibt es 4 allgemeine Artikel (Felder und Feldgruppen, Feldparameter, mehrsprachige Websites und Template-Overrides). Sie befinden sich auf derselben Ebene wie die 15 Typen benutzerdefinierter Felder und ein Artikel über ein spezielles benutzerdefiniertes Feld: Subform. Könnt ihr euch eine bessere Struktur ausdenken, anstatt all diese Artikel auf dieselbe Ebene zu stellen? Falls eine tiefere Ebene benötigt wird, die Übersichtsseite nicht vergessen.
eine Anleitung, wie man benutzerdefinierte Felder wiederholt (mittels Subform).
Beispiel für die Verwendung verschachtelter Subforms in benutzerdefinierten Feldern (neu seit 5.2).
eine Referenz (Übersicht) aller benutzerdefinierten Felder + Kurzbeschreibung.
Tutorial über Template-Overrides. Siehe https://docs-core.sandbox.joomla.org/user-manual/fields/fields-adding-custom-fields-overrides

Siehe die Serie über benutzerdefinierte Felder von Marc Dechèvre im Magazine:

JCM März 2018, Folge 1: How far can we go with Joomla! and Custom Fields?
JCM Mai 2018, Folge 2: how to manage your Custom Fields
JCM Oktober 2018, Folge 3: all the parameters one can wish for
JCM April 2020, Folge 4: a step by step tutorial
JCM Juli 2021, Folge 5: List of Resources (müssen hier nicht erneut aufgelistet werden, aber das ist eine sehr nützliche Referenz)
JCM August 2021, Folge 6: Make more with extensions
JCM Oktober 2021, Folge 7.1: one Custom Field to rule them all
JCM November 2021, Folge 7.2: without limits

Gibt es in diesen Artikeln etwas, das in die Dokumentation aufgenommen werden sollte?

Anleitungen mit mod_articles

Außerdem: aktualisieren https://docs-core.sandbox.joomla.org/user-manual/modules/modules-site-modules für mod_articles.

Tutorial: Ein Modul zum Dashboard hinzufügen

https://www.inmotionhosting.com/support/edu/joomla/joomla-4/add-a-module-to-the-dashboard/

Template-Overrides und alternative Ansichts-Templates

Joomla Improved Override Management
Template Overrides - Recycle and reuse
Managing Template Overrides in Joomla (2024-12)
Hier ist ein guter Blogbeitrag von Viviana (auf Deutsch) über Template-Overrides für die Frontend-Bearbeitung: https://www.dr-menzel-it.de/blog/override-challenge-beitrag-einreichen-im-frontend. Das sollte unbedingt in die Dokumentation aufgenommen werden!

Nützliche Magazine-Beiträge

Einige davon können als Grundlage für einen Dokumentationsbeitrag verwendet werden.

https://docs.joomla.org/J4.x:Magazine_Articleshttps://docs.joomla.org/J4.x:Magazine_Articleshttps://docs.joomla.org/J4.x:Magazine_Articles