Joomla! Documentation™

Zurück zu den Joomla 3.10 Hilfe-Seiten

Die Richtlinien sind eine Anleitung für die Erstellung der Hilfe-Seiten. Die Hilfe-Seiten des Joomla Docs Wiki werden von jeder Joomla-Installation als Standard verwendet. Den Richtlinien zu folgen bedeutet für das Joomla-Projekt, gleichartige Hilfe-Seiten und einfache Navigation anbieten zu können.

Fragen zur Hilfe-Seite bitte auf der zugehörigen Talk-Seite stellen. Dafür die Button "Aktionen  →  Diskussion" drücken.

Beschreibung

Jede Hilfe-Seite soll mit einer ins Detail gehenden Beschreibung der Anwendungsmöglichkeiten beginnen. Hier ein Anwendungsbeispiel.

Für diesen Abschnitt gibt es keine Empfehlung, da die Beschreibung in direktem Zusammenhang mit Zweck und Funktionalität der Hilfe-Seite stehen soll. Es kann Unterabschnitte geben, die spezifischere Details beschreiben.

Die Beschreibung soll kurz und prägnant sein. Wenn die Beschreibung lang ist, sollten Aufzählungszeichen verwenden werden, um den Inhalt zu gliedern.

Wie darauf zugreifen

Jede Hilfe-Seite soll einen Abschnitt Zugriff haben, der die Schritte zum Aufrufen der Hilfe-Seite enthält. Dies kann redundant sein, da man sich im Administratorbereich befinden muss, um die Hilfe-Seite aufrufen zu können.

Hilfe-Seiten können jedoch auf verschiedene Arten abgerufen werden. Beispielsweise könnte jemand, der eine Suchmaschine verwendet, um herauszufinden, wie etwas zu tun ist, auf eine Hilfe-Seite im Wiki stoßen, ohne jemals auf das Hilfesystem zugegriffen zu haben.

Hier ein Beispiel:

• Select Content → Articles from the dropdown menu of the Administrator Panel

Chunks und Parameter des Beispiels:

• {{Chunk30:Help_screen_How_To_Access_By_Menu/<translate>en</translate>|<translate>Content,Articles</translate>}}
  Mehr über Chunks in Joomla-Hilfe-Seiten lernen.

Hinweis:

• Man "klickt" auf Schaltflächen (einschließlich Werkzeugleiste), aber "wählt" Menüpunkte aus. Konsequente Verwendung der Terminologie hilft Benutzern.

Bildschirmfoto

Ein Bildschirmfoto soll die gesamte Hilfe-Seite zeigen.

Allgemeine Informationen

Hinweise:

• Der Dateiname soll den Richtlinien zur Bildbenennung für Hilfe-Seiten entsprechen.

• Der Dateiname muss immer den Sprachcode am Ende des Namens enthalten; für Englisch wird -en verwendet.

• Es können .png- oder .jpg-Dateien verwendet werden.

Spalten-Überschriften

Dieser Abschnitt wird in Hilfe-Seiten eingefügt, die eine Liste mit Elementen zeigen. Jede Listenspalte wird erklärt.

Spalten Filter

Dieser Abschnitt beschreibt die Dropdown-Eingabefelder über den Spalten Überschriften.

Details

Dieser Abschnitt soll in Hilfe-Seiten zum Hinzufügen und Bearbeiten von Elementen und Seiten wie Konfiguration oder Beitrags-Optionen enthalten sein.

In Feldsätzen oder Registerkarten gruppierte Felder unter Unterüberschriften gruppieren.

Listen Filter

Dieser Abschnitt soll in Hilfe-Seiten enthalten sein, in der angezeigte Elemente gefiltert werden können. Dieser Abschnitt soll die Verwendung der einzelnen Listenfilter beschreiben.

Suchwerkzeuge

Viele Hilfe-Seiten verfügen über Suchwerkzeuge zum Filtern nach Status, Zugriff, …. Ein Bildschirmfoto zeigt jedes Dropdown-Listenfeld und beschreibt es. Hier ein Anwendungsbeispiel.

Seitennavigation

Dieser Abschnitt soll in Hilfe-Seiten enthalten sein, in der Elemente in einer Liste angezeigt werden.

Werkzeugleiste

Dieser Abschnitt soll auf Hilfe-Seiten enthalten sein, die eine Werkzeugleiste zeigen. Er beschreibt die verfügbaren Buttons, ihre zugehörige Funktion und zeigt ein Bildschirmfoto der Werkzeugleiste.

Button-Beschreibung

The first word should always be a verb and, unless it is an irregular verb, it should also end in the letter "s". This means you should structure the description as if you are using the word "this" as the subject, but leave the subject out of the sentence. This will make the sentence actually a sentence fragment.

Zum Beispiel:

• Anstelle von "To find buried treasures, click this button."
  • Verwendung von: "Finds buried treasures."

• Anstelle von "You can click this button to insert a picture of John Stamos into the current document."
  • Verwendung von: "Inserts a picture of John Stamos."

• Anstelle von "Inform yourself that a picture of John Stamos is the same thing as a buried treasure."
  • Verwendung von: "Informs you that a picture of John Stamos is the same thing as buried treasure."

Vorgaben für Bildnamen

Werkzeugleisten sind in Hilfe-Seiten häufig gleich. Die Vorgaben für Bildnamen erleichtern die Wiederverwendung von Bildschirmfotos der Werkzeugleisten.

Bilder der Werkzeugleisten folgen dieser Namenskonvention: 'Help32-<iconslist>-toolbar-en.png'. <iconslist> ist eine durch - getrennte Liste der Werkzeugleisten-Buttons. Jedes Wort wird groß geschrieben, Leerzeichen und & werden entfernt.

Hier ein Beispiel:

• Help32-Save-SaveClose-SaveNew-SaveAsCopy-Version-Close-toolbar-en.png

Stapelverarbeitung

Dieser Abschnitt soll in Hilfe-Seiten enthalten sein, die über einen Button "Stapelverarbeitung" verfügen.

Tipps

Dieser Abschnitt soll Tipps, Hinweise und Vorschläge enthalten, die Benutzern bei Aufgaben im Zusammenhang mit der Hilfe-Seite helfen können.

Verwandte Informationen

Im Allgemeinen eine Liste mit Links zu weiterführenden oder verwandten Informationen. Alle Links sollen zu Seiten dieses Wiki führen. Externe Links nur mit triftigem Grund verwenden.

Hilfe-Seiten

Eine Tabelle verwandter Hilfe-Seiten.

Anmerkungen für Redakteure

Hilfe-Seiten verändern

Einen Fehler gefunden oder sind zusätzliche Informationen sinnvoll? Hilfe-Seiten können gerne bearbeitet werden. Danach bitte den Status der Hilfe-Seite ändern:

• Ist der Status im Moment 'Ready' oder 'To be moved'? Dann in 'Modified by [name]' ändern ([name] durch den Benutzernamen im Joomla-Docs-Wiki ersetzen)

• Ist der Status im Moment 'To be reviewed' muß er nicht geändert werden.

Richtlinien zur Bildbenennung

Help30-[menu-system-path-separated_by_dashes]-[screenElementType]-en.png

• [menu-system-path-separated_by_dashes] mit den Namen der Menüeinträge ersetzen, die man auswählen muss, um zum Bildschirmfoto zu gelangen.
  Menüeinträge mit einem Bindestrich - trennen. Enthält der Name des Menüeintrages mehr als ein Wort, die Wörter mittels Unterstrich _ trennen.
  Keine Leerzeichen in Dateinamen verwenden. Leerzeichen durch einen Unterstrich _ ersetzen.
• [screenElementType] durch den Typ des Seitenelements des Bildes ersetzen.
  Seitenelement-Typen sind:
  • screen: Ein Bildschirmfoto des gesamten Menüeintrages.
  • toolbar: Ein Bildschirmfoto der Werkzeugleiste des Menüeintrages.
  • menu: Ein Bildschirmfoto der Menüleiste des Menüeintrages.

  Hinweis: Weitere Seitenelement-Typen bitte dem Leitfaden hinzufügen. Damit können Entwickler der Hilfe-Dokumentation auf diesen Leitfaden verweisen und konsistent bleiben.

Beispiele für die Verwendung des Leitfadens:

• Ein Bildschirmfoto der "Überprüfen"-Seite von "Erweiterungen → Verwalten" lautet:

  Help30-extensions-manage-discover-screen-en.png

• Ein Bildschirmfoto der Werkzeugleiste der "Überprüfen"-Seite von "Erweiterungen → Verwalten" lautet:

  Help30-extensions-manage-discover-toolbar-en.png