Generatore di Readme WordPress

Un generatore di readme WordPress costruisce il file readme.txt che la directory del plugin WordPress.org legge per creare l'elenco pubblico di un plugin Compili i campi dell'intestazione e le sezioni ed emette il file nel formato esatto analizzato dalla directory: `=== Nome plugin ===titolo`, blocco dell'intestazione separato da due punti e `== Sezione ==corpo` - con un'anteprima dal vivo accanto che mostra come sarà la pagina dell'elenco.

Il formato è pignolo in modi invisibili finché qualcosa non è sbagliato. `Stable tag` nomina la versione effettivamente servita dalla directory, quindi un tag sbagliato o mancante non spedisce nulla indipendentemente da ciò che hai commesso. `Tested up to` è ciò che produce l'avviso "non testato con la tua versione di WordPress" sulla scheda quando è in ritardo rispetto al core. `Tag` indicizza i primi cinque e ignora silenziosamente il resto. La breve descrizione viene ridotta a 150 caratteri nei risultati di ricerca Nessuno di questi produce un errore che vedi durante la scrittura del file; producono un elenco che sembra sbagliato o un download che non avviene, giorni dopo Questo strumento indica ogni limite accanto al campo a cui appartiene ed elenca cosa farebbe la directory con il tuo file prima di scaricarlo.

Tutto funziona lato client Nulla viene caricato, non viene creato alcun account e la bozza viene mantenuta nel tuo browser in modo che un ricaricamento non lo perda Puoi anche importare un readme.txt esistente - incolla in quello che il tuo plugin già spedisce e viene analizzato di nuovo nel modulo, che è il modo più veloce per correggere un vecchio file o portare un readme fino ai requisiti attuali senza ridigitarlo Sezioni in un ordine insolito, linee di intestazione questo strumento non modella e spaziatura incoerente vengono tutte lette anziché rifiutate, perché questo è l'aspetto dei veri file readme.

Due cose che il file stesso non può trasportare vale la pena dire chiaramente Le immagini del banner e delle icone non fanno parte di readme.txt: vivono nella cartella `/assets/` del plugin come `banner-1544x500.png` e `icon-256x256.png`, e i campi qui esistono quindi l'anteprima mostra l'elenco che otterrai effettivamente Gli screenshot funzionano allo stesso modo: readme.txt trasporta le didascalie numerate e i file `screenshot-1.png` corrispondenti vanno in `/assets/` in quest'ordine. L'anteprima è onesta a riguardo piuttosto che fingere che un URL dell'immagine nel modulo apparirà su WordPress.org. Una volta che il file è corretto, scaricalo, rilascialo nella radice del plugin e inseriscilo nel trunk del tuo repository SVN.