NP_Markdown e NP_MarkdownViewer

Plugin per NucleusCMS

Altri due piccoli plugin per NucleusCMS, questa volta dedicati alla sintassi Markdown, particolare metodo di scrittura intuitiva per il web ideata da John Gruber di cui è stato effettuato un porting in PHP da Michel Fortin.

La sintassi Markdown permette di scrivere pagine web anche complesse in maniera naturale ed altamente leggibile, utilizzando una modalità di scrittura che ricorda molto da vicino lo stile utilizzato per le email di solo testo. Attraverso questo particolare metodo di scrittura è possibile realizzare pagine web contenenti liste, link, caratteri speciali, citazioni, attribuire effetti di enfasi al testo o inserire immagini senza conoscere assolutamente il linguaggio HTML. E’ inoltre possibile mischiare in modalità naturale e trasparente HTML puro e sintassi Markdown senza preoccuparsi di interferenze tra i due “mondi”.

Anche questo articolo, grazie al plugin NP_Markdown, è stato scritto utilizzando la sintassi Markdown e grazie all’altro plugin NP_MarkdownViewer, potrete visualizzarne il codice Markdown sorgente utilizzando il link posto a fine pagina.

NP_Markdown

Le caratteristiche salienti del plugin sono:

  • Multilingua (italiano ed inglese per ora);
  • Possibilità di abilitare o meno la sintassi Markdown per ogni articolo;
  • Nessuna modifica agli articoli preesistenti;
  • Possibilità di poter continuare ad utilizzare altri sistemi di sintassi (HTML puro, Textile, etc.);
  • Possibilità di visualizzare il sorgente Markdown dei propri articoli grazie al plugin aggiuntivo NP_MarkdownViewer;
  • Possibilità di utilizzare il programma SmartyPants PHP per la corretta gestione di alcuni caratteri speciali quali:
    • virgolette singole ' in ‘
    • virgolette doppie '' in ”
    • "virgolette" in “virgolette curve”
    • ellipsi ... in …
    • trattini doppi -- o tripli --- in — e —-

L’installazione del plugin è molto semplice e prevede i seguenti passi:

  • Scaricare il pacchetto contenente il plugin dalla pagina dei download di rbnet.it;
  • Decomprimere l’archivio e caricare i file e le directory ivi contenuti all’interno della directory dei plugin della vostra installazione di NucleusCMS;
  • Scaricare dai relativi siti gli script Markdwon PHP e SmartyPants PHP (quest’ultimo facoltativo), decomprimerne gli archivi e caricare i file risultanti markdown.php e smartypants.php all’interno della directory /markdown del plugin. _Al posto della versione di Markdown già indicata è possibile utilizzare la versione riveduta e potenziata denominata MarkdownExtra PHP;
  • Spostarsi nell’area di amministrazione della propia installazione di NucleusCMS ed installare il plugin selezionando la voce Markdown;
  • Disabilitare l’opzione Converti gli "a capo" del proprio blog (!importante);
  • Il plugin è pronto per l’uso.

Durante l’installazione il plugin rileverà la lingua di default utilizzata nel blog e selezionerà automaticamente la lingua da utilizzare per la sua installazione: se non trova un file della lingua adeguato installerà di default la lingua inglese. Verrà inoltre creata una nuova tabella dove il plugin memorizzerà le sue impostazioni.

screenshot plugin

L’opzione generale Usa i filtri per la sintassi di Markdown\Smartypants come default? permette di impostare il comportamento standard del plugin per quanto riguarda la generazione di nuovi articolo: selezionando Si il programma imposterà i nuovi articoli per l’utilizzo della sintassi Markdown; in ogni caso nella pagina di inserimento/modifica degli articolì sarà presente un’opzione manuale per “marcare” o meno un articolo all’utilizzo del plugin (vedi immagine a lato). E’ da notare che il marcare o meno un articolo all’utilizzo di NP_Markdown non modifica il codice sorgente che verrà memorizzato nel DB, ma istruirà solamente il plugin all’abilitazione o meno del filtro markdown.php durante la visualizzazione dell’articolo sul blog. E’ evidente quindi che scrivere un articolo con sintassi Markdown e non abilitarne l’utilizzo del filtro markdown.php avrà come effetto la visualizzazione in formato sorgente (e senza ritorno a capo!) dell’articolo stesso (comportamento discutibile lo so, ma per ora è il massimo che sono riuscito ad ottenere…);

L’utilizzo di NP_Markdown ha tra gli effetti principali la sostituzione dei caratteri speciali HTML come < e &. In particolare la sostituzione del carattere HTML < rende impossibile l’utilizzo dei tag di Nucleus delimitati con direttamente all’interno degli articoli. Per ovviare a questo inconveniente basta includere tali tag all’interno di codici di blocco quali DIV o P.

Per approfondimenti sulla sintassi di Markdown consultare il sito dell’autore originale oppure la pagina Dingus dell’autore di MarkdownPHP, dove è possibile provare direttamente la sintassi tramite una comoda interfaccia web.

NP_Markdownviewer

Certe volte può essere utile mettere a disposizione il contenuto sorgente di una pagina scritta utilizzando la sintassi Markdown: il plugin NP_MarkdownViewer si occupa proprio di questo. Il suo utilizzo è estremamente semplice: ci si deve limitare all’installazione del plugin ed all’inserimento del tag speciale nel/i template utilizzato/i per la visualizzazione degli articoli. Durante la creazione della pagina NucleusCMS sostituirà il tag con un link che permetterà all’utente di visualizzare a video esclusivamente il codice Markdown dell’articolo. Potete provarne la funzionalità utilizzando il link Visualizza Sintassi Markdown posto a fine pagina.

Anche questo plugin è scaricabile dalla pagina dei download di rbnet.it dedicata a NucleusCMS.

Alla prossima.

Informazioni su Roberto 349 Articoli
Roberto "rbnet" Bolli, (ri)fondatore di rbnet.it con la passione per la tecnologia, Linux ed i meme Internet. La notte giocatore incallito di The Last of US su Playstation 4, di giorno "lavoricchiatore" in Francia, nazione dove cerca di sopravvivere non conoscendone la lingua.

Commenta per primo

Lascia un commento

L'indirizzo email non sarà pubblicato.


*