Joomla! Documentation™

Die Richtlinien für Mitwirkenden der Dokumentationsgruppe regeln die Benennung hochgeladener Bilder, die von Joomla! Help screens nicht verwendet werden. Die Richtlinien sind nicht obligat, dienen aber Informationszwecken. Sie sind eine Anleitung für Mitwirkende, passende Bildnamen zu vergeben. Die Benennung der Bilder in der Joomla-Dokumentation ist nicht schwer wenn man verstanden hat, wie Bilder verarbeitet und gespeichert werden. Vorteile der Mediawiki-Methode der Bildspeicherung sind die Historie, zusätzliche Informationen und einfaches Aktualisieren.

These guidelines are not absolute, but for informative purposes. They should only be used as a reference for helping contributors form a good image file name.

Naming an image for use in Joomla documentation is not difficult once you understand how the images are processed and stored. Some of the benefits of Mediawiki's method of image storage are an

• image history,

• extra image data,

• and easy image updating.

Benennung eines hochgeladenen Bildes

Die Mediawiki Software ermöglicht hochgeladene Bilder durch zwei Methoden zu benennen.

The Mediawiki software allows uploaded images to be named by 2 methods.

Uploading an image directly

Direktes Hochladen eines Bildes, das auf der Seite nicht referenziert wird, aber verwendet werden soll. Der Standardname des Bildes wird dann der "lokale" (Name aus Deinem Dateisystem), aber er kann auch vor dem Hochladen geändert werden.

Clicking on a red link

Klicken auf einen roten Link, dieser referenziert auf der Seite einen bereits vorhandenem Bilderlink wie

Von den beiden Methoden ist die Zweite einfacher zu verwenden.

Namensmuster Vorschläge

Bildnamen sollten aus einer durch Unterstriche oder Bindestriche getrennten Liste von beschreibenden Wörtern bestehen. Stell Dir den Namen als eine zusammenfassende Beschreibung des Bildes vor.

Vorschläge für die Bildnamen bei Joomla Bildern

Der erste Teil jedes Joomla-Bildnamens sollte auf seine Version hinweisen. Dies ermöglicht sofort zu erkennen welche Joomla Version zu diesem Bild gehört. Zum Beispiel: j3x oder j25. Es gibt keine Notwendigkeit den .(Punkt) in die Version einzufügen. Bitte lasse ihn weg.

<jver>-<admin>-<view>.<extension('png' | 'jpg' | 'jpeg' | 'gif')>

Joomla Bildbennungsbeispiele

Ein Bildschirmfoto der Joomla 3.x- oder 2.5-Administration mit Übersicht der Beiträge kann folgendermaßen benannt werden:

j3x_admin_content_article_manager_articles.png

Ein Bildschirmfoto der Joomla 3.x- oder 2.5-Frontend-Ansicht des Anmelde-Moduls, könnte so benannt werden:

j3x_site_protostar_log_in_module.png

Vorschläge für Bildnamen bei Nicht-Joomla-Bildern

Der gesunde Menschenverstand und eine beschreibende Zusammenfassung sollten Richtlinie für Nicht-Jooomla-Bilder sein. Auch hier werden Unterstrich _ oder Bindestrich - zu Trennung der Begriffe verwendet. Bei Bildern von Personen sollte der Personenname verwendet werden. Für Bilder von Software oder Webauftritten sollten diese innerhalb eines vernünftigen Rahmens eingefügt werden.

Nicht-Joomla-Bilder Benennung, Beispiele

Ein GitHub pull request, das Firefox-Firebug-Werkzeug, oder andere Beispiele könnten folgendermaßen benannt werden:

github-pull-request-how-to.png
eclipse_indigo_interface_egit_browsing_veiw.png
joomla-event-Nov-2013-John-Smith.png
firefox_addon_firebug_colour_picker.png

Sie sind kurz, beschreibend und informieren den Betrachter beim Bildaufruf, um was es auf dem Bild geht.

Lokalisierung der Bildnamen

In Vorbereitung der Übersetzung der Dokumentation, muss festgelegt werden wie Bilder den verschiedenen Sprachen zugeordnet werden können. Wenn eine Dokumentation übersetzt wird, ist es notwendig, dass Benutzer und die Mitglieder der Dokumentations Arbeitsgruppe Bilder einer anderen Sprache schnell erkennen. Daher sollte keine Muttersprache in der Bildbeschreibung verwendet werden. Stattdessen wird an das Ende des Bildnamens der zweibuchstabige Sprachcode angehängt und danach das Bild mit einem Bildnamen in der 'Basis'-Sprache hochgeladen werden.

Übersetzer der Joomla! Dokumentation sollten folgendes lesen: Bilder übersetzen. Übersetzer finden detailierte Informationen über das Übersetzen von Bildern. Hier ist das Basis Beispiel:

<jver>-<admin>-<view>-<language code>.<extension('png' | 'jpg' | 'jpeg' | 'gif')>

Einige der Beispiel von oben.

j3x_admin_content_article_manager_articles_es.png

Ein Screenshot der Joomla 3.x oder 2.5 Frontend Ansicht des Anmelde Moduls, könnte so benannt werden:

j3x_site_protostar_log_in_module_fr.png