Jdoc statements: comprendere come Joomla! visualizza l'output in un sito

I Jdoc statements sono inclusi in tutti i templates di Joomla! ed indicano dove deve apparire l'output, per esempio di un modulo o di una qualsiasi altra estensione, all'interno delle pagine web. Un tipico jdoc statement (che possiamo definire "dichiarazione") lo troviamo nella forma seguente: <jdoc:include type="component" />

Jdoc:include

Lo statement <jdoc:include /> è un metodo di visualizzazione per presentare specifici contenuti nelle pagine di un sito web realizzato con Joomla! Ci sono diversi tipi di statements ed ognuno di essi presenta differenti contenuti a seconda del tipo che viene invocato nel file index.php.

L'attributo type dello statement Jdoc:include

L'attributo type specifica come deve essere presentato il tipo di contenuto al posto dello statement <jdoc:include />. Per esempio, lo statement <jdoc:include type="head" /> usa il tipo di attributo "head". Tale statement visualizza, una volta eseguita la pagina nel browser, tutti gli elementi situati nella sezione head della pagina.

N.B.: L'espressione Jdoc deve essere sempre scritta all'interno di apici doppi e non apici singoli.

Jdoc:include Component

<jdoc:include type="component" />

L'elemento component si riferisce a tutto il contenuto del sito e deve apparire una sola volta all'interno della pagina index.php del template.

Jdoc:include Head

<jdoc:include type="head" />

L'elemento head, al pari di component, deve apparire una sola volta nel file del template ed esattamente nella sezione <head> </head> della pagina. Lo statement head visualizza richiami a files css, javascript, titolo della pagina, tag meta ecc.

Jdoc:include Installation

<jdoc:include type="installation" />

L'elemento installation è utilizzato prevalentemente dall'Installer di Joomla! e non ha particolari impieghi nel frontend del template. Si potrebbe definire l'equivalente di component, visualizzando i contenuti durante gli step di installazione.

Jdoc:include Message

<jdoc:include type="message" /> 

Anche l'elemento message deve apparire una volta sola all'interno del file del template ed esattamente nella zona del <body>, al fine di visualizzare messaggi di errore scaturiti da richieste fatte tramite browser. I messaggi di errore possono essere formattati con l'ausilio dei foglio di stile il cui file si trova nella cartella templates/system/css/system.css.

Jdoc:include Module

<jdoc:include type="module" name="head" />
<jdoc:include type="module" name="banner" />

L'elemento module visualizza un singolo modulo contraddistinto dal nome dell'attributo. Il modulo in oggetto deve essere pubblicato e reso accessibile dall'amministratore del sito a seconda di come è stato dichiarato nel file index.php. Ulteriori attributi scritti nello statement possono conferire aspetti diversi, controllare il layout del modulo stesso.

Jdoc:include Modules

I Moduli sono visualizzati nella pagina adottando la sintassi tipo gli esempi di seguito riportati. Essi sono separati nelle diverse aree del template avvalendosi della Posizione, dichiarata nel file templateDetails.xml. La dichiarazione <jdoc:include name="nome posizione" attributo="valore" />, serve ai vari moduli per essere richiamati nelle rispettive posizioni, stilizzati separatamente. Attributi addizionali danno un controllo maggiore nel layout del sito soprattutto per quanto riguarda la modalità di visualizzazione.

<jdoc:include type="modules" name="left" style="rounded" />
<jdoc:include type="modules" name="right" style="xhtml" />
<jdoc:include type="modules" name="user1" />
<jdoc:include type="modules" name="user2" />
<jdoc:include type="modules" name="right" style="raw" />

L'attributo style

L'attributo opzionale style è disponibile sia per il tipo module che per modules all'interno di uno statement <jdoc:include />.

Il valore fa riferimento allo style chrome, usato per visualizzare l'outpout generato dal modulo. Se lo stile non esiste (o non è previsto), un valore "none" viene applicato di default.