a következő összetevők és sablonok azon személyek bemenetén alapulnak, akik hozzájárultak a ” Create a README.txt sablon”. Annak érdekében, hogy egy részletezett példa legyen, néhány minta szöveget használunk. A legtöbb az adminisztrációs menü modul README-jéből származik.txt.

Tartalomjegyzék

Tocs nem kötelező, de értékelik a hosszadalmas README fájlokat.,

Bevezetés

a bevezetés (kötelező) egy-két rövid bekezdésből áll, amely összefoglalja a projekt célját és funkcióját. Ez a bevezetés lehet ugyanaz, mint az első bekezdés a projekt oldalon.

a bevezetésnek tartalmaznia kell egy linket a projekt oldalához és a kiadási sorhoz. Ha a projekt homokozó, akkor ezeknek a linkeknek a promócióig a homokozóba kell menniük.

követelmények

a követelmények szakasz (kötelező) egyértelművé teszi, hogy ez a projekt a Drupal magon kívül bármit is igényel (modulok, könyvtárak stb.)., Itt sorolja fel az összes követelményt, beleértve azokat is, amelyek közvetve egy másik modulból következnek stb. Az ötlet az, hogy tájékoztassuk a felhasználókat arról, hogy mi szükséges, hogy minden szükséges beszerezhető legyen a modul telepítésének megkísérlése előtt. Ha nincsenek követelmények, írja be a “nincs különleges követelmény”szót.

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

ajánlott modulok

Ez az opcionális szakasz felsorolja azokat a modulokat, amelyek nem szükségesek, de amelyek javíthatják a projekt hasznosságát vagy felhasználói élményét. Győződjön meg róla, hogy leírja a modulok engedélyezésének előnyeit.,

telepítés

a telepítési szakasz (kötelező*) egyértelművé teszi a modul telepítését. Ha azonban a modul telepítésének lépései követik a Drupal 8, A Drupal 7, A Drupal 6/5 vagy a téma standard utasításait, ne feltalálja újra a kereket — egyszerűen adjon meg egy linket, és részletesen ismertesse azokat a lépéseket, amelyek eltérhetnek e lépésektől. Vegye figyelembe a Drush integrációkat. Abban az esetben, ha sok Drush parancsot adunk hozzá, fontolja meg egy szakasz hozzáadását a Drush-hoz.

fontolja meg a szakasz önálló telepítéssel történő cseréjét.,txt fájl, ha a telepítési utasítások különösen összetettek.

* – külön telepítés nélkül szükséges.txt biztosított.

Drupal 7

Drupal 8

konfiguráció

a konfigurációs szakasz (szükséges) akkor is szükséges, ha kevés konfigurációra van szükség. Ezzel a szekcióval felsorolhatja a modul konfigurációjával kapcsolatos speciális megjegyzéseket – beleértve, de nem kizárólagosan az engedélyeket. Ez a szakasz különösen fontos, ha a modul további konfigurációt igényel a Drupal felhasználói felületen kívül.,

Ha a modul alig vagy egyáltalán nem rendelkezik konfigurációval, akkor ezt a helyet kell használnia annak magyarázatához, hogy a modul engedélyezése/letiltása hogyan befolyásolja a webhelyet.

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.

vagy

hibaelhárítás & GYIK

ezek a szakaszok nem kötelezőek. Ha jelen van, akkor olyan kérdésekkel kell foglalkozniuk, amelyeket gyakran kérdeznek a kiadási sorban (ez időt takarít meg a jövőben). Vázlat gyakori probléma, hogy az emberek találkozás együtt megoldások (linkek baj, ha a lépések hosszú, de gyakran hasznos összefoglaló, mivel linkek néha állott).,

karbantartók

Ez a szakasz nem kötelező, és minden meglévő önálló karbantartót ki kell cserélni.txt fájl.

Advanced help

Advanced help megjeleníti a README fájlt a képernyőn, ha engedélyezve van.

All about Markdown

a Drupal projekt élettartama alatt még soha nem volt egyértelmű egyetértés abban, hogy a README-fájlnak hogyan kell kinéznie, ennek eredményeként sok különböző stílus létezik (lásd az alábbi linkeket). Azonban inkább az új projekteket részesítjük előnyben az ezen az oldalon leírt formátum vagy a Markdown szűrőmodul által elismert formátum használatával., Ha Markdown-t használ, a fájlt meg kell nevezni README.md (és használja érvényes Markdown szintaxis), különben meg kell nevezni README.txt.

gyors Formázási tippek

itt található a readme preferált formátumának összefoglalása.txt:

• címsorok minden kupakban.
• ===/--- A címsor hosszáig, majd egy üres sorral aláhúzva.
• két sor a címsorok előtt (az első kivételével).
• csillagok (*) által jelölt Golyók lógó behúzásokkal.
• számozott listák behúzott 4 szóköz.,
• felsorolja a behúzott 1 helyet.
• szöveg kézzel szó-köré 80 cols.

Minta readme

néhány minta README-fájlok:

• Morbus’ README.txt stílus (amely megfelel a Drupal core stílusának a legközelebb).
• könnyű zsemlemorzsa README.md (amely ezt a sablont használja)