JDOC

Wie man die Joomla!-Dokumentation unterstützt

From Joomla! Documentation

This page is a translated version of the page JDOC:How to Contribute to Joomla! Documentation and the translation is 100% complete.

Other languages:
বাংলা • ‎Deutsch • ‎English • ‎español • ‎eesti • ‎فارسی • ‎français • ‎हिन्दी • ‎Bahasa Indonesia • ‎italiano • ‎Nederlands • ‎português • ‎português do Brasil • ‎Türkçe

Die Joomla!-Dokumentation wird mit der gleichen Software wie sie auch Wikipedia verwendet, betrieben. Wachstum und Erfolg ist abhängig von Menschen wie Dir. 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.

Erste Schritte!

Es gibt ein paar Dinge, die zuerst zu erledigen sind.

Lies die Wiki-Richtlinie

Bevor man mit dem Bearbeiten der Joomla! Docs beginnt, muss man die Wiki-Richtlinie gelesen haben.

Benutzerkonto erstellen

Um das Joomla!-Dokumentations-Wiki zu bearbeiten, benötigt man ein Benutzerkonto. Man kann hier die Registrierung durchführen. Wichtig ist, anschließend die E-Mail-Adresse zu bestätigen. Die Bestätigung der E-Mail-Adresse erlaubt, mit Ausnahme einiger weniger geschützter Seiten jede Seite 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 das Konto erstellt, die E-Mail-Adresse bestätigt und man angemeldet ist, sollte man eine Benutzerseite erstellen. Hier ein schneller Weg, sie zu starten:
  • Iim Benutzermenü die Benutzername-Seite aufrufen (oder den ersten Menüpunkt ganz rechts benutzen).
  • Auf die Schaltfläche "Aktionen" klicken.
    JDOCS-actions-create-page-de.png
  • Klicke "Bearbeiten"
  • Füge den Code zum Editor hinzu {{subst:Newuser}}
  • Zusammenfassung ausfüllen (z.B. Das ist meine neue User-Seite)
    JDOCS-summary-form-input-de.png
  • Klicke "Seite speichern"

In die Mailingliste der Dokumentation eintragen

Man sollte sich der Docs mail list' anschließen. Es ist zwar nicht erforderlich, aber es gibt für die Dokumentation relevante Diskussionen, die man sonst verpassen würde.

Was sollte man zuerst tun?

Es gibt mehrere Bereiche der Dokumentation, die immer wieder beachtet werden müssen. 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 habt, 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. Hilfe Seiten.

Unterstützung bei den Dokumentations-Inhalten

  1. Bearbeiten, Überschreiben und Umstrukturieren von Seiten. Besuche unsere Kategorie Joomla! Wiki Seiten, die Hilfe brauchen für Bereiche, die dringend Hilfe benötigen. Diese werden 'Bedürftige Seiten' genannt, weil sie kleine Aufgaben benötigen um sie zu vervollständigen. Einige dieser sind so einfach wie die Überprüfung von Inhalten oder das Hinzufügen eines Bildes. Andere erfordern mehr Inhalt oder Verbesserungen. Suche ein paar aus und gib ihnen ein wenig Zuwendung. Dies ist eine enorme Hilfe für alle 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 Aufgrund von versionsspezifischen Informationen aufgeteilt werden müssen? Dann verwende die Markierungsvorlagen {{delete}}, {{merge}} oder {{JSplit}} auf den betreffenden Seiten. Um zu erfahren wie man diese einsetzt, klicke auf die vorherigen Vorlagen-Links. Dort erfährst Du, wie man diese auf Seiten anwenden kann, von denen Du denkst, dass diese die Markierungen benötigen. Füge diese ganz oben auf einer Seite hinzu und die Seite ist markiert.
  3. Erstelle eine neue Seite oder Tutorial Vor der Erstellung einer neuen Seite, mache 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 exisiert. 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 policy and guidelines 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. Gebe einfach den gewünschten Inhalts-Text ein, klicke auf Speichern und die neue Seite wird erstellt. Sobald die Seite erstellt wurde, 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. Durch Klick auf den Seite erstellen Link führt zur Bearbeitungs-Seite für die neue Seite. Hier kann der Inhalt eingegeben werden und 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. Unsere Richtlinienvorschläge sind auf der Seite Richtlinien zur Bildbenennung zu finden.

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, das sind auch Seite befindet sich in Bearbeitung, oder durch 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 Dokumentation 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 Beginner Tutorials Project beizutreten.
  • Trete dem Developer Tutorials Project 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 Übungsthemen zur Liste der vorgeschlagenen Themen hinzufügen.

Hilfeseiten

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

  • Die Joomla! 4.x Hilfe-Seiten müssen komplett erstellt 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 erstellt werden.

Wichtige Dinge

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

  • Habe keine Angst, eine Seite kaputt zu machen, wenn es passiert und etwas wirklich schief gelaufen ist, kannst Du deine Bearbeitung rückgängig machen. Klicke auf die Registerkarte Versionsgeschichte und Du siehst Links zum Rückgängig machen und Zurücksetzen.
  • Schreibe Beiträge mit dem Gefühl, dass sie auch in eine andere Sprache übersetzt werden müssen. Die Verwendung von Slang-Ausdrücken oder einem lokalen Dialekt kann meistens nicht in eine andere Sprache übersetzt werden.
  • 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 zu beachtende Wörter, read the full guideline … oder verwende Google Chrome, Mozilla Firefox für schnelles Feedback. Beide haben eine Rechtschreibprüfung eingebaut, die falsch geschriebene Wörter markiert.
  • 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 bei Wikis und der einfachen Markup für Seiten bist, kannst Du Folgendes als Hilfe verwenden.

  • Der neue WikiEditor hat Buttons und Links, um den Seitnbau 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 'Help', um es 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 and later hat einen eingebauten MediaWiki-Exportfilter. Öffne Dein 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 auf Glip (es gibt dort 2 Gruppen: eine für die Jdocs Übersetzungsgruppe und eine für die Jdocs Working Group).
  • Eine Frage an einen Administrator oder Editor auf deren Diskussionsseite posten.