Skip to content

Latest commit

 

History

History
79 lines (59 loc) · 3.3 KB

README.md

File metadata and controls

79 lines (59 loc) · 3.3 KB
Raw

Einführung

Dieses zentrale Repository stellt Metainformationen für die Pakete innerhalb des Contao Managers bereit.

Es erlaubt das Übersetzen und Anreichern von Paketinformationen jedes beliebigen Composer Pakets. Daher können auch Pakete die nicht vom Typ contao-bundle sind (wie bspw. eine allgemeine PHP Excel Exportbibliothek) übersetzt werden.

Die Metadaten werden im YAML-Format gespeichert und es kann ein Logo im SVG-Format angegeben werden. Es wird empfohlen, das Logo beispielsweise mittels SVGO bzw. dem GUI-Tool SVGOMG entsprechend zu optimieren.

Beispiel einer Paketstruktur

meta/[vendor]/[paket-name]
    - de.yml
    - en.yml
    - ru.yml
    - ...
    - logo.svg (optional)

Hinweis: Das logo.svg kann auch direkt innerhalb von [vendor] liegen, es wird dann als Fallback für alle Pakete dieses [vendor] verwendet, sofern kein Logo für das explizite Paket angegeben wurde.

Beispiel einer YAML Sprachdatei

de:
    title: Titel des Bundles oder des Moduls
    description: >
        Lange Beschreibung des Bundles oder des Moduls mit Zeilenumbrüchen.

        Lorem ipsum dolor sit amet, consetetur sadipscing elitr, sed diam nonumy eirmod tempor invidunt ut labore et dolore magna aliquyam erat, sed diam voluptua.
        At vero eos et accusam et justo duo dolores et ea rebum.
    keywords:
      - keyword1
      - lorem ipsum
      - keyword2
      ...

Bitte verwendet 4 Leerzeichen zum Einrücken oder Verschachteln und sprecht den Nutzer mit "du" an. Für weitere Informationen zum Dateiformat, sieh dir die Transifex Dokumentation an.

Öffentliche vs. private/proprietäre Pakete

Das Metadaten-Repository füttert den Suchindex des Contao Managers und erlaubt die Suche sowohl nach öffentlichen als auch nach privaten bzw. proprietären Paketen. Entsprechend kannst du für beide Pakettypen Beschreibungen einreichen. Die Definition eines öffentlichen Pakets ist dessen Verfügbarkeit via packagist.org. Für private Pakete bietet der Contao Manager aktuell noch keinen automatisierten Installationsprozess. Deshalb ist eine "homepage" Pflichtangabe und soll Angaben zur Installation und ggf. zum Erwerb eines Lizenzschlüssels etc. enthalten.

Rechtschreibprüfung

Die Metadaten werden automatisch auf korrekte Rechtschreibung überprüft. Wenn die Überprüfung fehlschlägt, du dir aber sicher bist, dass das Wort korrekt ist, musst du womöglich die Whitelists aktualisieren. Diese werden im Ordner linter/whitelists nach Sprache gepflegt. Eigennamen und andere Begriffe, die in jeder Sprache identisch sind, werden in default.txt gepflegt.

Unterstützte Sprachen

Siehe https://github.com/contao/contao-manager/blob/master/src/i18n/locales.js

Wie kannst Du beitragen

  1. Klone das Repo
  2. Wähle ein vorhandenes Paket oder erstelle einen neuen Ordner für ein nicht existierendes Paket wie "meta/vendor/package"
  3. Erstelle einen Pull Request
  4. Dein Pull Request wird automatisch überprüft.
  5. Sobald alle Checks grün sind, kann ein Mitglied des Review-Teams deinen Pull Request freigeben.