Die folgenden Komponenten und Vorlagen basieren auf den Eingaben vieler, die zur Diskussion beigetragen haben “ Erstellen Sie eine README.txt-Vorlage“. Um ein konkretes Beispiel zu haben, verwenden wir einen Beispieltext. Das meiste davon stammt aus der README des Verwaltungsmenümoduls.txt.

Inhaltsverzeichnis

TOCs sind optional, werden jedoch für lange README-Dateien geschätzt.,

Einführung

Die Einführung (erforderlich) besteht aus einem kurzen Absatz oder zwei, die den Zweck und die Funktion dieses Projekts zusammenfasst. Diese Einführung kann mit dem ersten Absatz auf der Projektseite identisch sein.

Die Einführung sollte einen Link zur Projektseite und zur Ausgabewarteschlange enthalten. Wenn das Projekt eine Sandbox ist, sollten diese Links bis zur Promotion in die Sandbox gehen.

Requirements

Im Abschnitt requirements (requirements) muss klargestellt werden, ob für dieses Projekt etwas außerhalb von Drupal core erforderlich ist (Module, Bibliotheken usw.)., Listen Sie hier alle Anforderungen auf,einschließlich derjenigen, die indirekt von einem anderen Modul stammen usw. Die Idee ist, die Benutzer darüber zu informieren, was benötigt wird, damit alles, was sie brauchen, beschafft und vor dem Versuch, das Modul zu installieren, aufgenommen werden kann. Wenn es keine Anforderungen gibt, schreiben Sie „Keine besonderen Anforderungen“.

REQUIREMENTS------------This module requires no modules outside of Drupal core.

Empfohlene Module

In diesem optionalen Abschnitt werden Module aufgelistet, die nicht erforderlich sind, die jedoch die Nützlichkeit oder Benutzererfahrung Ihres Projekts verbessern können. Beschreiben Sie unbedingt die Vorteile der Aktivierung dieser Module.,

Installation

Der Installationsabschnitt (erforderlich*) soll deutlich machen, wie das Modul installiert wird. Wenn die Schritte zur Installation des Moduls jedoch den Standardanweisungen für Drupal 8, Drupal 7, Drupal 6/5 oder ein Thema folgen, erfinden Sie das Rad nicht neu-stellen Sie einfach einen Link bereit und erläutern Sie detailliert alle Schritte, die von diesen Schritten abweichen können. Beachten Sie besonders Drush Integrationen. In einem Fall, in dem viele Drush-Befehle hinzugefügt werden, sollten Sie einen Abschnitt für Drush hinzufügen.

Erwägen Sie, diesen Abschnitt durch eine eigenständige INSTALLATION zu ersetzen.,txt-Datei, wenn Ihre Installationsanweisungen besonders komplex sind.

* – erforderlich, es sei denn, eine separate INSTALLATION.txt wird bereitgestellt.

Drupal 7

Drupal 8

Konfiguration

Der Konfigurationsabschnitt (erforderlich) ist auch bei geringer Konfiguration erforderlich. Verwenden Sie diesen Abschnitt, um spezielle Hinweise zur Konfiguration dieses Moduls aufzulisten-einschließlich, aber nicht beschränkt auf Berechtigungen. Dieser Abschnitt ist besonders wichtig, wenn das Modul eine zusätzliche Konfiguration außerhalb der Drupal-Benutzeroberfläche erfordert.,

Wenn das Modul wenig oder keine Konfiguration hat, sollten Sie diesen Bereich verwenden, um zu erklären, wie sich das Aktivieren/Deaktivieren des Moduls auf die Site auswirkt.

CONFIGURATION------------- * Configure the user permissions in Administration " People " Permissions: - Use the administration pages and help (System module) The top-level administration categories require this permission to be accessible. The administration menu will be empty unless this permission is granted. - Access administration menu Users with this permission will see the administration menu at the top of each page. - Display Drupal links Users with this permission will receive links to drupal.org issue queues for all enabled contributed modules. The issue queue links appear under the administration menu icon. * Customize the menu settings in Administration " Configuration and modules " Administration " Administration menu. * To prevent administrative menu items from appearing twice, you may hide the "Management" menu block.

oder

Fehlerbehebung & FAQ

Diese Abschnitte sind optional. Falls vorhanden, sollten sie Fragen beantworten, die häufig in der Problemwarteschlange gestellt werden (dies spart Ihnen in Zukunft Zeit). Skizzieren Sie häufige Probleme, auf die Menschen zusammen mit Lösungen stoßen (Links sind in Ordnung, wenn die Schritte lang sind, aber es ist oft hilfreich, eine Zusammenfassung bereitzustellen, da Links manchmal veraltet sind).,

Betreuer

Dieser Abschnitt ist optional und sollte alle bereits vorhandenen eigenständigen BETREUER ersetzen.txt-Datei.

Erweiterte Hilfe

Erweiterte Hilfe zeigt die README-Datei auf dem Bildschirm an, wenn sie aktiviert ist.

Alles über Markdown

Während der Lebensdauer des Drupal-Projekts gab es nie einen klaren Konsens darüber, wie eine README-Datei aussehen sollte, und viele verschiedene Stile existieren als Ergebnis (siehe Links unten). Wir bevorzugen jedoch neue Projekte, um das auf dieser Seite beschriebene Format oder ein vom Markdown-Filtermodul erkanntes Format zu verwenden., Wenn Sie Markdown verwenden, sollte Ihre Datei benannt werden README.md (und verwenden Sie gültige Markdown-Syntax), sonst sollte es README heißen.txt.

Tipps zur schnellen Formatierung

Hier finden Sie eine Zusammenfassung des bevorzugten Formats für README.txt:

• Überschriften in Großbuchstaben.
• Überschriften unterstrichen mit === / --- auf die Länge der Überschrift, gefolgt von einer Leerzeile.
• Zwei Zeilen vor den Überschriften (außer der ersten).
• Kugeln mit Sternchen (*) mit hängenden Einrückungen.
• Nummerierte Listen eingerückt 4 Leerzeichen.,
• Aufzählungslisten eingerückt 1 Leerzeichen.
• Text manuell Word-wrapped innerhalb von rund 80 Spalten.

Beispiel readme

Einige Beispiel-README-Dateien:

• Morbus‘ README.txt-Stil (der dem Drupal Core-Stil am nächsten kommt).
• Einfache Semmelbrösel README.md (die diese Vorlage verwendet)