následující komponenty a šablony jsou založeny na vstupu mnoha, kteří přispěli k diskusi “ vytvořit README.txt šablona“. Abychom měli dokonalý příklad, používáme nějaký ukázkový text. Většina z nich pochází z README modulu administračního menu.txt.

obsah

Toc jsou volitelné, ale jsou oceňovány pro zdlouhavé soubory README.,

Úvod

úvod (povinné) se skládá z krátké nebo dva odstavce, která shrnuje účel a funkci tohoto projektu. Tento úvod může být stejný jako první odstavec na stránce projektu.

úvod by měl obsahovat odkaz na stránku projektu a frontu vydání. Pokud je projekt pískovištěm, měly by tyto odkazy přejít do karantény až do propagace.

Požadavky

V části požadavky (povinné) musí být jasné, zda tento projekt vyžaduje něco mimo Drupal jádro (moduly, knihovny, atd.)., Zde uveďte všechny požadavky, včetně těch, které následují nepřímo z jiného modulu atd. Cílem je informovat uživatele o tom, co je požadováno, aby bylo možné vše, co potřebují, zakoupit a zahrnout před pokusem o instalaci modulu. Pokud neexistují žádné požadavky, napište „žádné zvláštní požadavky“.

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

Doporučené moduly

Tento nepovinný oddíl seznamy modulů, které nejsou nutné, ale to může zvýšit užitečnost nebo uživatelské zkušenosti vašeho projektu. Nezapomeňte popsat výhody povolení těchto modulů.,

instalace

instalační sekce (povinná*) musí jasně určit, jak modul nainstalovat. Nicméně, pokud kroky k instalaci modulu dodržovat standardní pokyny pro Drupal 8, Drupal 7, Drupal 6/5, nebo téma, nepoužívejte znovu vynalézat kolo — jednoduše poskytnout odkaz a podrobně vysvětlil všechny kroky, které se může odchýlit od těchto kroků. Zvláštní pozornost věnujte integraci Drush. V případě, že je přidáno mnoho příkazů Drush, zvažte přidání sekce pro Drush.

zvažte nahrazení této části samostatnou instalací.,txt soubor, pokud jsou vaše pokyny k instalaci obzvláště složité.

* – vyžadováno, pokud není samostatná instalace.txt je k dispozici.

Drupal 7

Drupal 8

Configuration

konfigurační sekce (povinná) je nutná, i když je vyžadována malá konfigurace. Pomocí této části můžete uvést speciální poznámky o konfiguraci tohoto modulu – včetně, ale bez omezení, oprávnění. Tato část je zvláště důležitá, pokud modul vyžaduje další konfiguraci mimo uživatelské rozhraní Drupal.,

pokud má modul malou nebo žádnou konfiguraci, měli byste tento prostor použít k vysvětlení, jak Povolení/zakázání modulu ovlivní web.

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.

nebo

řešení problémů FAQ

tyto sekce jsou volitelné. Pokud jsou přítomny, měly by řešit otázky, které jsou položeny často v otázce fronty (to vám ušetří čas v budoucnosti). Osnovy společných problémů, které lidé setkávají spolu s řešeními (odkazy jsou v pořádku, pokud kroky jsou dlouhé, ale to je často užitečné poskytnout shrnutí, protože odkazy někdy jít zatuchlý).,

Správce

tato část je volitelná a měla by nahradit všechny již existující samostatné Správce.txt soubor.

Advanced help

Advanced help zobrazí soubor README na obrazovce, pokud je povolen.

vše o Markdown

během životnosti projektu Drupal nikdy neexistoval jasný konsenzus o tom, jak by měl vypadat soubor README a v důsledku toho existuje mnoho různých stylů (viz odkazy níže). Preferujeme však, aby nové projekty používaly formát popsaný na této stránce nebo formát rozpoznaný modulem filtru Markdown., Pokud používáte Markdown, měl by být váš soubor pojmenován README.md (a použijte platnou syntaxi Markdown), jinak by měla být pojmenována README.txt.

Tipy pro rychlé formátování

zde je souhrn preferovaného formátu pro README.txt:

• nadpisy ve všech čepicích.
• nadpisy podtržené ===/--- na délku nadpisu, následované prázdným řádkem.
• dva řádky před nadpisy (kromě prvního).
• kulky označené hvězdičkami ( * ) s visícími odrážkami.
• číslované seznamy odsazené 4 mezery.,
• seznamy odrážek odsazené 1 místo.
• Text ručně Word-zabalené do přibližně 80 kol.

ukázka readme

některé ukázkové README soubory:

• Morbus ‚ README.txt styl (který odpovídá stylu Drupal core nejblíže).
• snadná strouhanka README.md (který používá tuto šablonu)