Dokumentation/Dateien zur erweiterten Hilfe

    From The Document Foundation Wiki
    This page is a translated version of the page Documentation/CollateralFiles and the translation is 100% complete.
    Other languages:

    Was sind Dateien zur erweiterten Hilfe?

    Erweiterte Hilfe

    Das neue Hilfe-System von LibreOffice ermöglicht das bereits existierende <object> Element, das es erlaubt, Objekte in die HTML Hilfe Seiten einzufügen. Objekte können eingebettet werden, oder externe Videos, Audios und auch Dateien mit spezifischen MIME-Typen.

    Ab LibreOffice 6.1 hatte das Hilfe System Unterstützung durch die erweiterten Dateien um dem Nutzer beim Verständnis der schriftlichen Beschreibung der aktuellen Seite zu helfen.

    Was die erweiterten Dateien NICHT sind

    Die erweiterten Dateien sind nicht dazu da, die schriftliche Beschreibung eines Merkmales zu ersetzen oder überflüssig zu machen. Z. Bsp. wird eine unterstützende Datei zu Calc's trigonomischen Funktionen nicht die Hilfe-Seite der trigonomischen Funktionen ersetzen. Genausowenig sie die erweiterte Datei zu Pivot-Tabellen.

    Die erweiterte Datei soll keine Alternative zum lexikalischen Text zu einem Merkmal gelten. Es gibt keinen Grund, ein berechnendes Lehrbuch zu verwenden um den trigonomischen Cosinus zu erklären. Das Hilfe-System erwartet vom Nutzer, sein Wissen in Lehrbüchern zu suchen und stellt einfache Beispiele als schnelle Gedankenstütze zur Verfügung oder zeigt die Syntax der Funktion.

    = Wie stelle ich eine neue erwiterte Datei in der LibreOffice Hilfe zur Verfügung?

    Deine Hilfe ist selbstverständlich willkommen.

    Falls Du eine neue erweiterte Hilfedatei für eine bestimmte Hilfe Seite beisteuern willst, dann mach bitte ein neues Ticket in unserem Bugzilla System auf und stelle dort die Datei ein.

    Hier ist das Verfahren:

    1. Stelle sicher, dass Du alle Berechtigungen hast, um einen Fehler in unserem Bugzilla zu melden. Wenn nicht, dann beachte bitte die Anweisungen auf dieser Seite.
    2. Öffne einen neuen Fehler mit folgenden Einstellungen:
      Component: Documentation
      Version: unspecified
      Zusammenfassung: Gib eine Zusammenfassung ein. Zum Beispiel [Erweiterte_Dateien] Datei zur Hilfe Seite zu Merkmal XYZ
      Beschreibung: beschreibe den Zweck der erweiterten Datei und gib so viele Einzelheiten wie möglich an. Wenn Du die Hilfe-Seite kennst, die die Datei betrifft, dann umso besser. Du kannst die Hilfe Seite mit angeben, indem Du einen Link zur Seite in der Online-Hilfe mit angibst. Z. Bsp. https://help.libreoffice.org/latest/de/text/scalc/01/04060101.html
    3. Anhänge: Hänge Deine Datei an den Bugzilla Bericht an
    4. WICHTIG: gib 117613 im Feld Block: an (dies gibt Deinen Bezug Deines Beitrag zum Metabug an).
    5. Sende Deinen Fehlerbericht ab.

    Das war's.

    Note pin.svg

    Anmerkung:
    Erweiterte Dateien sind in der Offline-Hilfe nicht verfügbar.

    Regeln zur Erstellung von Erweiterten Dateien

    "KISS" : Keep It Simple, Stupid. (Halte es einfach und dumm!)

    Sortiere aus.

    Das Hilfe-System hilft dem Nutzer. Klingt offensichtlich, aber es gibt keinen Grund, eine komplizierte erweiterte Datei einzustellen, wenn die Absicht darin besteht, ein einfaches Konzept zu erkären. Z. Bsp. braucht eine Grafik keine Hunderte von Datenpunkten und keine ausgefallen gefärbten Grafikelemente.

    Versuche eine Datei mit einem Minimum an Text zu erzeugen. Manchmal ist es nicht möglich, aber einige Tricks reduzieren den Aufwand für die Übersetzer:

    1. Halte die Datei klein
    2. Verwende immer Open Document Formate nach ISO-IEC 26300 wie *.odt, *.ods, *.odp, *.odg, *.odf, *.odb., solange es nicht anderweitig gerechtfertigt ist.
    3. In Calc Funktionen kannst Du immer =FORMULA(<ref>) verwenden, um den Namen der Funktion im Gebietschema zu verwenden.
    4. Falls eine Funktion in Calc zu einer Kategorie von Funktionen gehört, erwäge, eine Datei mit vielen Beispielen zu nutzen (siehe 1 weiter oben). Z. Bsp. können die Datenbank Funktionen DBSUMME, DBANZAHL, DBMAX, etc... in einer erweiterten Datei abgehandelt werden.
    5. Erzeuge keine Dateien mit Makros. Sogar bei sicheren Makros können Sicherheitswarnungen Probleme für den Nutzer bringen.
    6. Verwende kein kompliziertes Styling, es sei denn, es ist unbedingt nötig.
    7. Vermeide Dateien mit externen Bezügen, externen Links (diese können Probleme mit firmeninternen Firewalls erzeugen) etc.
    8. Es gibt keinen Grund, viele Dateien zum selben Thema zu verbreiten. Verbessere die bestehende.

    Themen, um erweiterte Dateien anzuhängen

    Calc

    • Die Datenbank Funktionen DBSUMME, DBMAX, DBANZAHL, etc. Die Hilfe Seiten haben bereits ein schriftliches Beispiel, das in einer erweiterten Datei verwendet werden kann.
    • Statistische Funktionen (stelle ein kleines, aber signifikantes Datenbeispiel mit Verwendung der statistischen Funktionen zur Verfügung)
    • Finanzmathematische Funktionen
    • Zielerreichung
    • Löser
    • Mehrfache Operationen
    • Szenarien

    Writer

    • Indizes
    • Inhaltsangabe
    • Seitenausrichtung (Quer-/Hochformat)
    • Formatvorlagen

    Impress

    • Diashow
    • Objektanimierungen

    Draw

    • Schichten
    • Objekte
    • Größenlinien
    • Objekt Beleuchtung
    • Verteilung

    Base

    • Beispielsdatenbank

    Math

    • Beispielsgleichungen

    Übersetzung

    Einige Länder benötigen die Hilfe in einer oder mehrerer ihrer offiziellen Sprachen. Das erfordert die Übersetzung der erweiterten Datei, wenn sie hinzugefügt wird.

    Die Standard und Rückfallsprache ist en-US.

    Note pin.svg

    Anmerkung:
    Die Quell-Dateien sind in den unten angeführten Tickets angesiedelt.

    Calc

    • Datei imtrigon.ods für komplexe trigonometrische Funktionen: tdf#117579
    • Datei trigon.ods für trigonometrische Funktionen: tdf#117592
    • Datei pivot.ods Pivot Tabellen und Grafiken: tdf#117593

    Writer

    Impress

    Draw

    Base

    Math

    Hochladen in die Hauptversion

    Das Hochladen der Dateien wird mittels gerrit durchgeführt.