următoarele componente și șablon se bazează pe contribuția multora care au contribuit la discuția „creați un README.șablon txt”. De dragul de a avea un exemplu concret, folosim un exemplu de text. Cea mai mare parte provine din README-ul modulului din meniul de administrare.txt.

cuprins

Toc-urile sunt opționale, dar apreciate pentru fișierele README lungi.,

Introducere

introducerea (obligatoriu) va consta dintr-un scurt paragraf sau două care rezumă scopul și funcția acestui proiect. Această introducere poate fi aceeași cu primul paragraf din pagina proiectului.

introducerea ar trebui să includă un link către pagina proiectului și coada de emitere. Dacă proiectul este un sandbox, aceste link-uri ar trebui să meargă la sandbox până la promovare.

cerințe

secțiunea cerințe (obligatoriu) trebuie să clarifice dacă acest proiect necesită ceva în afara Drupal core pentru a lucra (module, biblioteci, etc)., Enumerați toate cerințele aici, inclusiv cele care urmează indirect dintr-un alt modul etc. Ideea este de a informa utilizatorii despre ceea ce este necesar, astfel încât tot ceea ce au nevoie pot fi achiziționate și incluse în avans de a încerca să instalați modulul. Dacă nu există cerințe, scrieți „fără cerințe speciale”.

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

module recomandate

această secțiune opțională listează module care nu sunt necesare, dar care pot îmbunătăți utilitatea sau experiența utilizatorului proiectului dumneavoastră. Asigurați-vă că descrieți beneficiile activării acestor module.,

instalare

secțiunea de instalare (necesar*) trebuie să clarifice modul de instalare a modulului. Cu toate acestea, dacă pașii pentru instalarea modulului urmează instrucțiunile standard pentru Drupal 8, Drupal 7, Drupal 6/5 sau o temă, nu reinventați roata — pur și simplu furnizați un link și explicați în detaliu orice pași care ar putea să se abată de la acești pași. Luați notă specială de integrări Drush. În cazul în care sunt adăugate multe comenzi Drush, luați în considerare adăugarea unei secțiuni pentru Drush.

luați în considerare înlocuirea acestei secțiuni cu o instalare independentă.,fișier txt dacă instrucțiunile de instalare sunt deosebit de complexe.

* – necesar, cu excepția cazului în care o instalare separată.txt este furnizat.

Drupal 7

Drupal 8

configurare

secțiunea de configurare (necesară) este necesară chiar și atunci când este necesară o configurație redusă. Utilizați această secțiune pentru a lista note speciale despre configurația acestui modul-inclusiv, dar fără a se limita la permisiuni. Această secțiune este deosebit de importantă dacă modulul necesită configurare suplimentară în afara UI Drupal.,

dacă modulul are o configurație mică sau deloc, ar trebui să utilizați acest spațiu pentru a explica modul în care activarea/dezactivarea modulului va afecta site-ul.

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.

sau

Depanare & intrebari FRECVENTE

Aceste secțiuni sunt opționale. Dacă sunt prezente, acestea ar trebui să abordeze întrebări care sunt adresate frecvent în coada de emitere (acest lucru vă va economisi timp în viitor). Descrieți problemele comune pe care oamenii le întâmpină împreună cu soluțiile (link-urile sunt în regulă dacă pașii sunt lungi, dar este adesea util să furnizați un rezumat, deoarece link-urile devin uneori învechite).,

întreținători

această secțiune este opțională și ar trebui să înlocuiască orice întreținători autonomi preexistenți.fișier txt.

ajutor avansat

ajutor avansat va afișa fișierul README pe ecran dacă este activat.

totul despre Markdown

în timpul vieții proiectului Drupal, nu a existat niciodată un consens clar despre cum ar trebui să arate un fișier README și există multe stiluri diferite ca rezultat (vezi linkurile de mai jos). Cu toate acestea, preferăm ca proiectele noi să utilizeze formatul descris pe această pagină sau un format recunoscut de modulul filtru Markdown., Dacă utilizați Markdown, fișierul dvs. ar trebui să fie numit README.md (și utilizați sintaxa Markdown validă), altfel ar trebui să fie numit README.txt.

sfaturi pentru formatare rapidă

Iată un rezumat al formatului preferat pentru README.Txt:

• titluri în toate capacele.
• Titluri subliniat cu ===/--- la lungimea de poziție, urmat de un rând liber.
• două linii înainte de titluri (cu excepția primului).
• gloanțe notate cu asteriscuri ( * ) cu liniuțe agățate.
• liste numerotate indentat 4 spații.,
• liste cu marcatori indentat 1 Spațiu.
• Text manual word-înfășurat în jurul valorii de 80 cols.pentru mai multe informații, consultați Notificarea cu privire la cookie-uristilul txt (care se potrivește stilului Drupal core cel mai apropiat).
• pesmet ușor README.md (care utilizează acest șablon)