I seguenti componenti e template si basano sull’input di molti che hanno contribuito alla discussione “Crea un README.modello txt”. Per avere un esempio concreto, stiamo usando del testo di esempio. La maggior parte proviene dal README del modulo del menu di amministrazione.txt.

Sommario

I TOC sono opzionali ma apprezzati per file README lunghi.,

Introduzione

L’introduzione (necessaria) consiste in un breve paragrafo o due che riassume lo scopo e la funzione di questo progetto. Questa introduzione potrebbe essere la stessa del primo paragrafo della pagina del progetto.

L’introduzione dovrebbe includere un link alla pagina del progetto e alla coda dei problemi. Se il progetto è una sandbox, questi collegamenti dovrebbero andare alla sandbox fino alla promozione.

Requisiti

La sezione requisiti (richiesto) deve chiarire se questo progetto richiede qualcosa al di fuori di Drupal core per funzionare (moduli, librerie, ecc.)., Elenca tutti i requisiti qui, inclusi quelli che seguono indirettamente da un altro modulo, ecc. L’idea è di informare gli utenti su ciò che è richiesto, in modo che tutto ciò di cui hanno bisogno possa essere acquistato e incluso prima di tentare di installare il modulo. Se non ci sono requisiti, scrivere “Nessun requisito speciale”.

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

Moduli consigliati

Questa sezione opzionale elenca i moduli che non sono necessari, ma che possono migliorare l’utilità o l’esperienza utente del progetto. Assicurati di descrivere i vantaggi di abilitare questi moduli.,

Installazione

La sezione installazione (richiesta*) deve indicare chiaramente come installare il modulo. Tuttavia, se i passaggi per installare il modulo seguono le istruzioni standard per Drupal 8, Drupal 7, Drupal 6/5 o un tema, non reinventare la ruota: basta fornire un link e spiegare in dettaglio eventuali passaggi che potrebbero divergere da questi passaggi. Prendi nota delle integrazioni Drush. In un caso in cui vengono aggiunti molti comandi Drush, considerare l’aggiunta di una sezione per Drush.

Prendere in considerazione la sostituzione di questa sezione con un’INSTALLAZIONE standalone.,file txt se le istruzioni di installazione sono particolarmente complesse.

* – richiesto a meno che non sia un’INSTALLAZIONE separata.txt è fornito.

Drupal 7

Drupal 8

Configurazione

La sezione di configurazione (richiesta) è necessaria anche quando è richiesta poca configurazione. Utilizzare questa sezione per elencare note speciali sulla configurazione di questo modulo, incluse ma non limitate alle autorizzazioni. Questa sezione è particolarmente importante se il modulo richiede una configurazione aggiuntiva al di fuori dell’interfaccia utente di Drupal.,

Se il modulo ha poca o nessuna configurazione, dovresti usare questo spazio per spiegare come abilitare/disabilitare il modulo influenzerà il sito.

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.

o

Risoluzione dei problemi& FAQ

Queste sezioni sono opzionali. Se presenti, dovrebbero rispondere alle domande che vengono poste frequentemente nella coda dei problemi (questo ti farà risparmiare tempo in futuro). Delineare i problemi comuni che le persone incontrano insieme alle soluzioni (i collegamenti vanno bene se i passaggi sono lunghi, ma è spesso utile fornire un riepilogo poiché i collegamenti a volte diventano obsoleti).,

Manutentori

Questa sezione è facoltativa e dovrebbe sostituire eventuali MANUTENTORI standalone preesistenti.file txt.

Aiuto avanzato

Aiuto avanzato visualizzerà il file README sullo schermo se è abilitato.

Tutto su Markdown

Durante la vita del progetto Drupal, non c’è mai stato un chiaro consenso su come dovrebbe essere un file README, e di conseguenza esistono molti stili diversi (vedi link sotto). Tuttavia, preferiamo che i nuovi progetti utilizzino il formato descritto in questa pagina o un formato riconosciuto dal modulo filtro Markdown., Se si utilizza Markdown, il file deve essere denominato README.md (e usa la sintassi Markdown valida), altrimenti dovrebbe essere chiamato README.txt.

Suggerimenti per la formattazione rapida

Ecco un riepilogo del formato preferito per README.txt:

• Intestazioni in maiuscolo.
• Intestazioni sottolineate con ===/--- alla lunghezza dell’intestazione, seguita da una riga vuota.
• Due righe prima delle intestazioni (tranne la prima).
• Proiettili indicati da asterischi ( * ) con rientri appesi.
• Elenchi numerati rientrati 4 spazi.,
• Elenchi puntati rientrati 1 spazio.
• Testo manualmente word-wrapped all’interno di circa 80 cols.

Esempio di readme

Alcuni file di README di esempio:

• Morbus’ README.stile txt (che corrisponde allo stile di Drupal core il più vicino).
• Pangrattato facile README.md (che utilizza questo modello)