följande komponenter och Mall baseras på inmatningen av många som bidrog till diskussionen ”skapa en README.txt Mall”. För att ha ett köttigt exempel använder vi lite provtext. Det mesta kommer från Administrationsmenymodulens README.txt.

innehållsförteckning

TOCs är valfria men uppskattade för långa README-filer.,

introduktion

introduktionen (krävs) ska bestå av ett kort stycke eller två som sammanfattar syftet och funktionen för detta projekt. Denna introduktion kan vara densamma som första stycket på projektsidan.

introduktionen ska innehålla en länk till projektsidan och problemkön. Om projektet är en sandlåda, bör dessa länkar gå till sandlådan tills marknadsföring.

krav

avsnittet Krav (krävs) ska klargöra om detta projekt kräver något utanför Drupal core att arbeta (moduler, bibliotek, etc.)., Lista alla krav här, inklusive de som följer indirekt från en annan modul etc. Tanken är att informera användarna om vad som krävs, så att allt de behöver kan upphandlas och inkluderas i förväg för att försöka installera modulen. Om det inte finns några krav, skriv ”inga speciella krav”.

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

rekommenderade moduler

detta valfria avsnitt listar moduler som inte krävs, men som kan förbättra användbarheten eller användarupplevelsen av ditt projekt. Se till att beskriva fördelarna med att aktivera dessa moduler.,

Installation

installationsavsnittet (obligatoriskt*) ska klargöra hur modulen installeras. Men om stegen för att installera modulen följer standardinstruktionerna för Drupal 8, Drupal 7, Drupal 6/5 eller ett tema, återuppfinna inte hjulet — helt enkelt ge en länk och förklara i detalj några steg som kan avvika från dessa steg. Ta särskild del av Trush integrationer. I ett fall där många Drush-kommandon läggs till, överväga att lägga till en sektion för Drush.

överväg att ersätta det här avsnittet med en fristående installation.,txt-fil om installationsanvisningarna är särskilt komplexa.

* – krävs om inte en separat installation.txt tillhandahålls.

Drupal 7

Drupal 8

konfiguration

konfigurationssektionen (krävs) är nödvändig även när liten konfiguration krävs. Använd det här avsnittet för att lista speciella anteckningar om konfigurationen av den här modulen-inklusive men inte begränsat till behörigheter. Detta avsnitt är särskilt viktigt om modulen kräver ytterligare konfiguration utanför Drupal UI.,

om modulen har liten eller ingen konfiguration bör du använda det här utrymmet för att förklara hur aktivering/inaktivering av modulen påverkar webbplatsen.

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.

eller

felsökning& FAQ

dessa avsnitt är valfria. Om de är närvarande, bör de ta upp frågor som ställs ofta i frågan kö (detta kommer att spara tid i framtiden). Skissera vanliga problem som människor stöter på tillsammans med lösningar (länkar är okej om stegen är långa, men det är ofta bra att ge en sammanfattning eftersom länkar ibland går inaktuella).,

underhållare

det här avsnittet är valfritt och bör ersätta befintliga fristående underhållare.txt-filen.

avancerad hjälp

avancerad hjälp visar README-filen på skärmen om den är aktiverad.

allt om Markdown

under Drupal-projektets livstid har det aldrig funnits en tydlig konsensus om hur en README-fil ska se ut, och många olika stilar finns som ett resultat (se länkar nedan). Vi föredrar dock att nya projekt använder det format som beskrivs på den här sidan, eller ett format som känns igen av Markdown filtermodulen., Om du använder Markdown ska filen namnges README.md (och använd giltig Markdown syntax), annars bör det namnges README.txt.

Snabbformateringstips

här är en sammanfattning av det föredragna formatet för README.txt:

• rubriker i alla kepsar.
• rubriker understrukna med===/--- till längden på rubriken, följt av en tom linje.
• två rader före rubriker (utom den första).
• kulor betecknas med asterisker (*) med hängande indrag.
• numrerade listor indragna 4 mellanslag.,
• punktlistor indragen 1 Utrymme.
• Text manuellt Word-wrapped inom cirka 80 cols.

prov readme

några prov README-filer:

• Morbus’ README.txt stil (som matchar Drupal core stil närmast).
• enkla brödsmulor README.md (som använder denna mall)