Gestire HTML nella descrizione di una estensione per Joomla

Quando creiamo il pacchetto di installazione per una estensione Joomla, una delle procedure da fare è compilare in file XML che contiene tutte le informazioni di installazione: nome, versione, licenza, e così via.

Tra le varie informazioni che possiamo offrire c’è anche la descrizione, identificata dal tag <description>; questa parte verrà visualizzata immediatamente dopo l’installazione, quindi è molto comoda per fornire agli utenti delle informazioni essenziali sull’utilizzo della nostra estensione.

Per sfruttare al massimo tale possibilità e creare una descrizione chiara e completa, l’ideale è poter usare del codice HTML. Se però inseriamo il codice così com’è all’interno del tag description, viene interpretato come parte dell’XML e non otteniamo il risultato sperato, anzi: rischiamo che una parte del testo non venga visualizzata.

CDATA

La soluzione è abbastanza semplice per chi conosce un poco il formato XML, ma per chi non lo sapesse, si tratta di inserire il nostro HTML all’interno di un tag CDATA.

Esempio:

<description><![CDATA[
Questa estensione è stato realizzata da da
<a href="http://www.gibilogic.com"> GiBiLogic</a><br />
Si occupa di effettuare la <strong>registrazione tramite
indirizzo e-mail</strong><br/>
Ricordarsi di creare una voce di menù apposita<br/>
<small>Copyright 2011 GiBiLogic</small>
]]></description>

Il testo contenuto all’interno del CDATA non verrà interpretato dal parser XML durante l’installazione ma passato pari pari al browser, che ovviamente lo produce come output HTML. Questo è quello che vedremmo dopo l’installazione:

Questa estensione è stato realizzata da da GiBiLogic
Si occupa di effettuare la registrazione tramite indirizzo e-mail
Ricordarsi di creare una voce di menù apposita
Copyright 2011 GiBiLogic

 

estensioni, joomla, programmatore