Joomla! Documentation™

Die Dokumentation von Joomla! wird durch die Plattform MediaWiki ermöglicht. Das Wachstum und der Erfolg von Joomla! hängt von Menschen wie Dir ab. Vielen Dank, dass Du den ersten Schritt zum Mithelfen bei unserem Joomla!-Projekt gemacht hast. Diese Seite zeigt, wie man anfangen und die Dokumentation unterstützen kann.

Neue Dokumentation

Erste Schritte!

Es gibt ein paar Dinge, die man zuerst erledigen muss.

Die Wiki-Nutzungsbedingung lesen

Du solltest die Joomla-Docs Wiki-Nutzungsbedingungen lesen, bevor du mit der Bearbeitung beginnst.

Benutzerkonto einrichten

Um im Joomla!-Dokumentations-Wiki mitzuarbeiten, benötigst du ein Benutzerkonto. Du kannst hier einen Account anlegen. Bestätige anschließend unbedingt deine E-Mail-Adresse. Mit der Bestätigung der E-Mail-Adresse erhältst du die Berechtigung, jede Seite, mit Ausnahme einiger geschützten Seiten zu bearbeiten.

Hinweis: Wenn man innerhalb von 5 Tagen nach der Erstellung des Kontos keine Änderungen/Bearbeitungen vornimmt, wird das Konto aus Sicherheitsgründen automatisch wieder gelöscht.

Benutzerseite erstellen

Nachdem man ein Benutzer-Konto erstellt, die E-Mail-Adresse bestätigt und sich angemeldet hat, empfiehlt es sich, sich ein paar Augenblicke Zeit zu nehmen, um eine Benutzer-Seite zu erstellen. Das Erstellen einer Benutzerseite dient mehreren Zielen:

• So können Benutzer mehr über dich erfahren.
• Damit kannst du einige erste Eingaben machen, damit der Wiki-Spammer- und Missbrauchsfilter erkennen kann, dass du kein Fake-Benutzer bist. Beachte, bei deinen ersten Bearbeitungen keine externen Links einzufügen, da diese wahrscheinlich die Filter auslösen werden.

Ein schneller Einstieg für die Benutzerseite:

• Gehe im Benutzermenü auf die Seite mit deinem Benutzernamen (oder nimm den ersten Menüpunkt ganz rechts oben im Dropdown-Menü)
• Klick auf die Dropdown-Schaltfläche "Aktionen"
  
• Klicke "Bearbeiten"
• Füge den Code zum Editor hinzu {{subst:Newuser}}
• Zusammenfassung ausfüllen (z.B. Das ist meine neue User-Seite)
  
• Klicke "Seite speichern"

Anmelden bei den Kommunikationskanälen der Dokumentation

Das offizielle Kommunikationswerkzeug von Joomla ist Mattermost. Auf dieser Seite findest Du Informationen darüber, wie man der Unterhaltung beitreten kann. Wenn man einmal dabei ist, kann man dem PD Documentation-Kanal beitreten und an der Diskussion über die Joomla!-Dokumentation teilnehmen.

Was sollte man zuerst tun?

Es gibt mehrere Bereiche der Dokumentation, die immer wieder Aufmerksamkeit brauchen. Man könnte damit beginnen, Dokumente auszuwählen, die für einen am bequemsten sind. Oder man engagiert sich mehr, indem man an mehreren gleichzeitig arbeitet. Sobald man ein Wiki-Konto hat, kann an jedem Aspekt der Dokumentation gearbeitet werden, der einem gefällt. Selbst die einfachsten Beiträge wie Rechtschreib-Korrekturen und Grammatik-Korrekturen sind eine große Hilfe!

1. Unterstützung bei den Dokumentations-Inhalten.
2. Wiki Wartungsaufgaben.
3. Dokumentations-Projekte.
4. Hilfeseiten.
5. Page Translation Explained.

Unterstützung bei den Dokumentations-Inhalten

1. Bearbeiten, Überschreiben und Umstrukturieren von Seiten. In unserem Wiki gibt es Needs-Seiten für Bereiche, die sofortige Hilfe benötigen. Sie werden 'Needs-Seiten' genannt, weil sie kleine Aufgaben benötigen, um sie zu vervollständigen. Einige von ihnen sind so einfach wie die Überprüfung des Inhalts oder das Hinzufügen eines Bildes. Andere erfordern mehr Inhalt oder Verbesserungen. Nimm ein paar davon und schenke ihnen ein wenig Zuwendung. Dies ist eine enorme Hilfe für Joomla! Benutzer, die sich auf unsere Dokumentation verlassen.
2. Hast du Spaß beim Suchen nach Seiten, die überflüssig sind (z.B. über die Versionen 1.0 und 1.5), oder die wegen versionsspezifischer Informationen aufgeteilt werden müssen? Dann verwende die Marker-Templates {{delete}}, {{merge}} oder {{JSplit}} auf den betreffenden Seiten. Um zu erfahren, wie man sie einsetzt, klicke auf die vorherigen Template-Links. Dort erfährst du, wie man sie auf Seiten anwenden kann, von denen du denkst, dass diese die Markierungen benötigen. Füge sie ganz oben auf einer Seite ein und die Seite ist markiert.
3. Erstelle eine neue Seite oder Tutorial Mach vor der Erstellung einer neuen Seite erst eine intensive Suche. Erstelle keine weitere Seite, wenn bereits eine existiert. Benutze die Suche des JDocs Wiki, um zu sehen, ob der Begriff bereits auf einer Seite existiert. Duplikate werden zusammengeführt und / oder gelöscht. Habe keine Angst, die Arbeit eines Anderen an der Joomla-Dokumentation zu verändern, neu zu formatieren oder zu verbessern! Dies ist ein kollaboratives Dokumentations-Wiki, stelle einfach sicher, dass den Grundsätzen und Richtlinien gefolgt wird.
   1. Wiki-Links einsetzen. Es ist sehr einfach, Seiten mit einer Standardsyntax zu verlinken. Wenn man einen Link zu einer Seite erstellt, die noch nicht existiert, wird der Link rot eingefärbt. Ein Klick auf einen roten Link führt direkt zur Bearbeitungsseite der neuen Seite. Gib einfach den gewünschten Inhalts-Text ein, klicke auf Speichern und die neue Seite wird erstellt. Danach wechselt der Link von rot auf blau und zeigt damit an, dass die Seite nun existiert.
   2. URL einsetzen. Einzusetzen, wenn man eine Seite von Grund auf neu erstellen möchte. Man kann die URL des Wikis zum Erstellen einer neuen Seite verwenden. Die URL zu einem Artikel des Wikis ist normalerweise ähnlich wie: https://docs.joomla.org/YOURTITLE. Wenn man YOURTITLE durch den Namen der Seite ersetzt, die man erstellen möchte, gelangt man auf eine leere Seite, die anzeigt, dass noch keine Seite dieses Namens existiert. Ein Klick auf den Seite erstellen-Link führt zur Bearbeitungs-Seite der neuen Seite. Hier kann der Inhalt eingegeben werden, durch Klick auf Speichern wird die Seite angelegt.
4. Hilfe durch Aktualisieren von Bildern in Seiten. Schau in die Kategorie Zu aktualisierende Bilder um die Liste an Seiten zu sehen, in denen Bilder aktualisiert werden müssen. Vorgaben dafür finden sich in den Richtlinien zur Bildbenennung.

Wiki Wartungsaufgaben

Ein Wiki zu warten und zu organisieren bedarf eine Menge an kontinuierlicher Arbeit der Administratoren, Redakteure und Benutzer. Es gibt immer Aufgaben, die Aufmerksamkeit benötigen wie z.B.: Nicht kategorisierte Seiten, Joomla! Wiki Seiten, die Hilfe brauchen oder auch Seite befindet sich in Bearbeitung, das Markieren von Seiten für Löschung, Zusammenführung oder Aufteilung. Für alle Wartungsaufgaben und Ideen wie man den JDocs helfen kann, besuche bitte unsere Wartungsseite.

Dokumentations-Projekte

• Das JDocs-Team arbeitet an den Einsteiger Tutorials. Unser Ziel ist es, diese leicht verständlich und gut navigierbar zu machen, damit ein Anfänger die Dinge leicht nachvollziehen und Grundkonzepte erlernen kann. Denke mal daran, als du neu bei Joomla warst und füge ein Thema über etwas hinzu, mit dem man als Anfänger zu kämpfen hatte. Noch besser wäre es, dem Einsteiger-Tutorial-Projekt beizutreten.
• Tritt dem Entwickler-Tutorial-Projekt bei und teile dein Wissen. Hinterlege Deinen Namen mit 4 Tilden ( ~~~~ ) auf der Seite Developer Tutorials Project und liste auf, was du tun kannst. Gerne kannst du einige Topics zur Liste der vorgeschlagenen Themen hinzufügen.

Hilfeseiten

Für viele unbekannt, werden alle Hilfe Seiten zu jeder Joomla-Installation weltweit von diesem Wiki aus erstellt und zur Verfügung gestellt! Diese sind für Anfänger und auch für die mit fortgeschrittenen Kenntnissen über Joomla notwendig.

Die Joomla! 4.x Hilfe-Seiten müssen komplett überarbeitet werden. Jeder Beitrag, den du leisten kannst, wird von vielen Benutzern weltweit geschätzt und wir suchen Freiwillige, die uns bei dieser wichtigen Aufgabe helfen können. Eine Matrix und ein Aktionsplan müssen noch erstellt werden.

Wichtige Dinge

Hier ein paar Dinge, die man sich als Helfer bei den Joomla-Docs merken sollte.

• Hab keine Angst, eine Seite zu beschädigen. Wenn du das tust und etwas wirklich schief gelaufen ist, kehre zum Editieren zurück. Klick auf die Registerkarte Versionsgeschichte der Seite und du siehst Links zum Widerrufen und Wiederherstellen.
• Schreibe die Beiträge in dem Bewusstsein, dass sie in eine andere Sprache übersetzt werden sollen. Die Verwendung von Slangausdrücken oder lokalen Dialekten kann dazu führen, dass diese nicht in eine andere Sprache übersetzt oder ihre Zusammenhänge nicht verstanden werden. Weitere Informationen findest du unter Übersetzen der Joomla!-Dokumentation.
• Die Joomla! en-GB User Interface Text Guidelines lesen, der für alle Joomla-Dokumentationen gilt. Er gibt hilfreiche Hinweise, wie man für die Joomla Dokumentation schreibt.
• Beim Schreiben sollte auf die korrekte Rechtschreibung geachtet werden. Für eine sofortige Rückmeldung sollten Sie die Browser Google Chrome oder Mozilla Firefox verwenden. Beide haben eine integrierte Rechtschreibprüfung, die ein falsch geschriebenes Wort unterstreicht.
• Vergiss nicht das {{inuse}}-Template an einen Artikel anzuwenden, den du für länger als eine Minute bearbeitest. Es hilft, Bearbeitungs-Konflikte zu vermeiden.

Hilfe, ich kenne Wiki Markup nicht!

Wenn du neu beim Wiki und der einfachen Markup für Seiten bist, kannst du Folgendes als Hilfe verwenden.

• Der neue WikiEditor hat Buttons und Links, um den Seitenbau einfach zu machen. Klick auf das Wort 'Advanced' für mehr Buttons und Formatierungs-Links.
• Verwende JDOC's Wiki Cheatsheet um grundlegende Syntax-Kommandos zu lernen. Es gibt auch ein Aufklappmenü mit den gebräuchlichen Markup im Editor. Klick auf das Wort Hilfe, um sie aufzurufen.
• Noch unschlüssig? Diese Werkzeuge für die Wiki-Seiten versuchen

• Microsoft Word Add-on for Wiki Markup, speichert Word-Dokumente als Wiki-Markup
• OpenOffice.org versions 2.4 und später haben einen eingebauten MediaWiki-Exportfilter. Öffne das Writer-Dokument, klick auf "Datei → Export" und ändere das Dateiformat auf MediaWiki.
• Hier eine Liste von Werkzeugen um andere Formate wie HTML, Excel, CSV in Wiki-Markup umzuwandeln. Einige konvertieren ausgeschnittenes und eingefügtes HTML online in Wiki-Markup.

• Hilfe finden auf Mattermost, (Wir haben dort eine Menge Kanäle. Beispielsweise einen für die JDocs Translation Group und einen für die JDocs Working Group).
• Eine Frage an einen Administrator oder Editor auf deren Diskussionsseite posten.