de volgende componenten en template zijn gebaseerd op de input van velen die hebben bijgedragen aan de discussie “Create a README.txt template”. Omwille van het hebben van een uitgewerkt voorbeeld, gebruiken we wat voorbeeldtekst. Het meeste komt uit de administratie Menu module README.txt.

inhoudsopgave

TOCs zijn optioneel, maar worden gewaardeerd voor lange README-bestanden.,

Inleiding

De inleiding (vereist) moet bestaan uit een korte alinea of twee waarin het doel en de functie van dit project worden samengevat. Deze inleiding kan dezelfde zijn als de eerste alinea op de projectpagina.

De inleiding moet een link naar de projectpagina en de issue bevatten. Als het project een sandbox is, moeten deze links naar de sandbox gaan tot de promotie.

vereisten

de sectie vereisten (vereist) moet duidelijk maken of dit project iets buiten Drupal core vereist om te werken (modules, bibliotheken, enz.)., Vermeld hier alle vereisten, inclusief die welke indirect volgen uit een andere module, enz. Het idee is om de gebruikers te informeren over wat er nodig is, zodat alles wat ze nodig hebben kan worden aangeschaft en opgenomen voorafgaand aan het proberen om de module te installeren. Als er geen eisen zijn, schrijf dan “geen speciale eisen”.

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

aanbevolen modules

deze optionele sectie bevat modules die niet vereist zijn, maar die het nut of de gebruikerservaring van uw project kunnen verbeteren. Zorg ervoor dat u de voordelen van het inschakelen van deze modules te beschrijven.,

installatie

het installatiegedeelte (vereist*) moet duidelijk maken hoe de module moet worden geïnstalleerd. Echter, als de stappen om de module te installeren Volg de standaard instructies voor Drupal 8, Drupal 7, Drupal 6/5, of een thema, niet opnieuw uitvinden van het wiel — gewoon een link en uitleggen in detail alle stappen die kunnen afwijken van deze stappen. Neem speciale nota van Drush integraties. In een geval waar veel Drush commando ‘ s worden toegevoegd, overweeg dan om een sectie voor Drush toe te voegen.

overweeg deze sectie te vervangen door een standalone installatie.,txt-bestand als uw installatie-instructies zijn bijzonder complex.

* – vereist, tenzij een aparte installatie.txt wordt verstrekt.

Drupal 7

Drupal 8

configuratie

de sectie configuratie (vereist) is noodzakelijk, zelfs als er weinig configuratie nodig is. Gebruik deze sectie om speciale opmerkingen te maken over de configuratie van deze module – inclusief maar niet beperkt tot machtigingen. Deze sectie is vooral belangrijk als de module extra configuratie buiten de Drupal UI vereist.,

als de module weinig of geen configuratie heeft, moet u deze ruimte gebruiken om uit te leggen hoe het in – /uitschakelen van de module de site zal beïnvloeden.

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.

of

probleemoplossing & FAQ

deze secties zijn optioneel. Indien aanwezig, moeten ze vragen behandelen die vaak worden gesteld in de issue queue (dit bespaart u tijd in de toekomst). Schets veelvoorkomende problemen die mensen tegenkomen samen met oplossingen (links zijn oké als de stappen lang zijn, maar het is vaak nuttig om een samenvatting te geven omdat links soms oud worden).,

onderhouders

Deze sectie is optioneel en dient alle bestaande standalone onderhouders te vervangen.txt-bestand.

geavanceerde help

geavanceerde help zal het README-bestand op het scherm weergeven als het is ingeschakeld.

alles over Markdown

tijdens de levensduur van het Drupal-project is er nooit een duidelijke consensus geweest over hoe een README-bestand eruit zou moeten zien, en er bestaan veel verschillende stijlen als gevolg daarvan (zie links hieronder). We geven echter de voorkeur aan nieuwe projecten om het formaat te gebruiken dat op deze pagina wordt beschreven, of een formaat dat wordt herkend door de Markdown filtermodule., Als u Markdown gebruikt, moet uw bestand een naam krijgen README.md (en gebruik geldige Markdown syntaxis), anders zou het README moeten heten.txt.

Tips voor snelle opmaak

Hier is een samenvatting van het gewenste formaat voor README.txt:

• koppen in alle hoofdletters.
• koppen onderstreept met ===/--- tot de lengte van de kop, gevolgd door een lege regel.
• twee regels voorafgaand aan de kop (behalve de eerste).
• opsommingstekens aangeduid met sterretjes (*) met hangende inspringingen.
• genummerde lijsten ingesprongen 4 spaties.,
• lijsten met opsommingstekens ingesprongen 1 spatie.
• tekst handmatig woord-verpakt in ongeveer 80 cols.

Sample readme

sommige sample README-bestanden:

• Morbus ‘ README.txt-stijl (die het dichtst bij Drupal core ‘ s stijl past).
• gemakkelijk paneermeel README.md (die deze sjabloon gebruikt)