følgende komponenter og malen er basert på innspill fra mange som har bidratt til diskusjon «Opprette en README fil.txt-mal». Av hensyn til å ha en fleshed ut eksempel, bruker vi noen eksempler på tekst. De fleste av dem kommer fra Administrasjonen meny modul er VIKTIG.txt.

innholdsfortegnelse

TOCs er valgfritt, men verdsatt for lengre README-filer.,

Innledning

innføring (obligatorisk) skal bestå av en kort avsnitt eller to som oppsummerer formål og funksjon av dette prosjektet. Denne innledningen kan være den samme som den første avsnitt på prosjektet siden.

innledningen skal inneholde en kobling til prosjektet side og problemet køen. Hvis prosjektet er en sandkasse, disse lenkene skal gå til sandkassen til kampanjen.

Krav

Den delen krav (påkrevd) skal gjøre det klart om dette prosjektet krever noe utenfor Drupal core arbeid (moduler, biblioteker, etc.)., Liste over alle kravene her, inkludert de som følger indirekte fra en annen modul, etc. Ideen er at du skal informere brukerne om hva som kreves, slik at alt de trenger kan være anskaffet og tatt i forkant av du forsøker å installere modulen. Hvis det er ingen krav, skriv «Ingen spesielle krav».

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

Anbefalte moduler

Dette valgfrie delen viser en liste over moduler som ikke er nødvendige, men som kan øke nytten eller brukerens opplevelse av prosjektet. Sørg for å beskrive fordelene ved å aktivere disse modulene.,

Installasjon

installasjonen delen (påkrevd*) skal gjøre det klart hvordan å installere modulen. Imidlertid, hvis trinnene for å installere modulen følge standard instruksjoner for Drupal 8, Drupal 7, Drupal 6/5, eller et tema, trenger ikke finne opp hjulet på nytt — bare gi en link og forklare i detalj alle tiltak som kan avvike fra disse trinnene. Vær spesielt oppmerksom på Drush integrasjoner. I et tilfelle hvor mange Drush kommandoene er lagt til, vurdere å legge en del for Drush.

Vurdere å erstatte denne delen med en frittstående INSTALLERE.,txt-fil hvis installasjonen din instruksjoner er spesielt komplisert.

* – ikke nødvendig med mindre en egen INSTALLERE.txt er gitt.

Drupal 7

Drupal 8

Konfigurering

konfigurasjon (påkrevd) er nødvendig, selv når lille konfigurasjon er nødvendig. Bruk denne delen til å liste spesielle merknader om konfigurasjon av denne modulen, inkludert, men ikke begrenset til rettigheter. Denne delen er spesielt viktig hvis modulen krever ekstra konfigurering utsiden av Drupal UI.,

Hvis modulen har liten eller ingen konfigurasjon, bør du bruke dette feltet til å forklare hvordan aktivere/deaktivere modul vil påvirke området.

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

Feilsøking & FAQ

Disse delene er valgfritt. Hvis den finnes, bør de ta opp spørsmål som er spurt ofte i problemet kø (dette vil spare deg tid i fremtiden). Skissere vanlige problemer folk møter sammen med løsninger (koblinger er i orden hvis trinnene er lang, men det er ofte nyttig å gi en oppsummering siden koblinger noen ganger gå i glemmeboken).,

Vedlikeholdspersonell

Dette avsnittet er valgfritt, og skal erstatte eventuelle pre-eksisterende frittstående VEDLIKEHOLDSPERSONELL.txt-fil.

Avanserte help

Avansert hjelp vil vise README-filen på skjermen (hvis den er aktivert.

Alt om Markdown

i Løpet av Drupal prosjektets levetid, det har aldri vært en klar konsensus om hva en README-filen skal se ut, og mange forskjellige stiler eksisterer som et resultat (se lenker nedenfor). Men vi foretrekker nye prosjekter for å bruke formatet som er beskrevet på denne siden, eller et format som er anerkjent av Markdown filter module., Hvis du vil bruke Markdown, filen bør være oppkalt VIKTIG.md (og bruke gyldig Markdown syntaks), ellers bør det nevnes VIKTIG.txt.

Rask formatering tips

Her er en oppsummering av de foretrukne formatet for VIKTIG.txt:

• Overskrifter i alle caps.
• Overskrifter understreket med ===/--- til lengden av overskriften, etterfulgt av en blank linje.
• To linjer før overskrifter (unntatt den første).
• Kuler som er merket med en stjerne (*) med hengende innrykk.
• Nummererte lister med innrykk 4 felt.,
• Punktmerkede lister rykket inn 1 plass.
• Tekst manuelt word-innpakket i rundt 80 kolonner.

Eksempel readme

Noen eksempler på README-filer:

• Morbus’ README.txt-stil (som samsvarer med Drupal core stil nærmeste).
• Lett Brødsmuler VIKTIG.md (som bruker denne malen)