følgende komponenter og skabelon er baseret på input fra mange, der har bidraget til diskussionen “Opret en README-fil.t templatet skabelon”. Af hensyn til at have en konkretiseret-out eksempel, Vi bruger nogle prøve tekst. Det meste kommer fra Administrationsmenumodulets README.t .t.
indholdsfortegnelse
TOCs er valgfri, men værdsat for lange README-filer.,
introduktion
introduktionen (påkrævet) skal bestå af et kort afsnit eller to, der opsummerer formålet med og funktionen af dette projekt. Denne introduktion kan være den samme som første afsnit på projektsiden.
introduktionen skal indeholde et link til projektsiden og problemkøen. Hvis projektet er en sandkasse, skal disse links gå til sandkassen indtil forfremmelse.
krav
afsnittet Krav (påkrævet) skal gøre det klart, om dette projekt kræver noget uden for Drupal core at arbejde (moduler, biblioteker osv.)., Angiv alle krav her, inklusive dem, der følger indirekte fra et andet modul osv. Ideen er at informere brugerne om, hvad der kræves, så alt, hvad de har brug for, kan anskaffes og inkluderes, inden de forsøger at installere modulet. Hvis der ikke er nogen krav, skriv “ingen særlige krav”.
REQUIREMENTS------------This module requires no modules outside of Drupal core.anbefalede moduler
dette valgfrie afsnit viser moduler, der ikke er nødvendige, men som kan forbedre nytten eller brugeroplevelsen af dit projekt. Sørg for at beskrive fordelene ved at aktivere disse moduler.,
Installation
installationsafsnittet (påkrævet*) skal gøre det klart, hvordan modulet installeres. Men, hvis trinene til at installere modulet følge standard instruktioner for Drupal 8, Drupal 7, Drupal 6/5, eller et tema, ikke genopfinde hjulet-blot give et link og forklare i detaljer eventuelle trin, der kan afvige fra disse trin. Vær særlig opmærksom på Drush integrationer. I et tilfælde, hvor mange Drush-kommandoer tilføjes, skal du overveje at tilføje et afsnit til Drush.
overvej at udskifte dette afsnit med en selvstændig installation.,t .t-fil, hvis dine installationsinstruktioner er særligt komplekse.
* – påkrævet, medmindre en separat installation.t .t leveres.
Drupal 7
Drupal 8
konfiguration
konfigurationsafsnittet (påkrævet) er nødvendigt, selv når der kræves lidt konfiguration. Brug dette afsnit til at liste specielle noter om konfigurationen af dette modul – inklusive men ikke begrænset til tilladelser. Dette afsnit er især vigtigt, hvis modulet kræver yderligere konfiguration uden for Drupal UI.,
hvis modulet har ringe eller ingen konfiguration, skal du bruge dette mellemrum til at forklare, hvordan aktivering/deaktivering af modulet vil påvirke siteebstedet.
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
Fejlfinding & ofte stillede spørgsmål
Disse afsnit er valgfri. Hvis de er til stede, skal de adressere spørgsmål, der ofte stilles i problemkøen (dette sparer dig tid i fremtiden). Skitsere almindelige problemer, som folk støder på sammen med løsninger (links er okay, hvis trinene er lange, men det er ofte nyttigt at give et resum., da links undertiden bliver forældede).,
vedligeholdere
dette afsnit er valgfrit og bør erstatte eventuelle allerede eksisterende standalone vedligeholdere.t filet-fil.
Avanceret hjælp
Avanceret hjælp viser README-filen på skærmen, hvis den er aktiveret.
Alt om Markdown
i Løbet af Drupal projektets levetid, har der aldrig været en klar konsensus om, hvad en README-fil skal se ud, og mange forskellige stilarter der findes som følge heraf (se links nedenfor). Vi foretrækker dog, at nye projekter bruger det format, der er beskrevet på denne side, eller et format, der genkendes af Markdo .n-filtermodulet., Hvis du bruger Markdo ,n, skal din fil navngives README.md (og brug gyldig Markdo .n syntaks), ellers skal det hedde README.t .t.
hurtige formateringstips
Her er en oversigt over det foretrukne format for README.t Headingst:
- overskrifter i alle caps.
- overskrifter understreget med
===/---til overskriftens længde efterfulgt af en tom linje. - to linjer før overskrifter (undtagen den første).kugler betegnet med stjerner ( * ) med hængende indrykk.
- nummererede lister indrykket 4 mellemrum.,
- Punkttegnede lister indrykket 1 mellemrum.
- tekst manuelt wordord-pakket inden omkring 80 cols.
Prøve readme
Nogle eksempler README-filer:
- Morbus’ README.t .t stil (som matcher Drupal core stil tættest).
- let brødkrummer README.md (som bruger denne skabelon)