Déclarations Jdoc

From Joomla! Documentation

This page is a translated version of the page Jdoc statements and the translation is 100% complete.

Other languages:
English • ‎español • ‎فارسی • ‎français • ‎Bahasa Indonesia • ‎Nederlands • ‎русский • ‎中文(台灣)‎

Les déclarations jdoc sont incluses dans tout template Joomla et indiquent où le rendu des autres éléments Joomla! ou ses extensions doit se positionner sur une page web. Une déclaration jdoc typique ressemble à cela : <jdoc:include type="component" />

jdoc:include

La déclaration <jdoc:include /> est une méthode de template Joomla! pour afficher le contenu spécifique de la page en cours de visualisation. Il existe différentes déclarations <jdoc:include />, chacune renvoyant une partie différente d'une page Joomla!. Le remplacement lui-même est fait dans JDocumentHTML::_renderTemplate. Voir également _parseTemplate.

L'attribut type

L'attribut type spécifie le type de contenu à utiliser à la place de l'élément <jdoc:include />. Par exemple, la déclaration <jdoc:include type="head" /> utilise l'attribut type head (type="head"). (Remarque: les expressions Jdoc requiert des guillemets doubles entourant les attributs, et ne fonctionneront pas avec des guillemets simples. L'espace avant la fermeture /> est également obligatoire.)

Component

<jdoc:include type="component" />

Cet élément ne doit apparaître qu'une seule fois dans l'élément <body> du Template pour afficher le contenu principal de la page en cours de visualisation.

Head

<jdoc:include type="head" />

Cet élément ne doit apparaître qu'une seule fois dans l'élément <head> du Template pour afficher le contenu du style, script et éléments méta associés à la page en cours de visualisation.

Installation

<jdoc:include type="installation" />

Cet élément est utilisé uniquement par l'Installateur de Template Joomla pour Joomla Joomla 2.5 et précédents et n'a pas d'utilité particulière dans un template de Front-end ou de Back-end. C'est un peu l'équivalent du type 'component' qui affiche le contenu principal d'une étape d'installation.

Message

<jdoc:include type="message" />

Cet élément ne doit apparaître qu'une seule fois dans l'élément <body> du Template pour afficher les messages système et messages d'erreurs qui se sont produits lors de la requête.

Les styles CSS pour les messages système sont situés dans templates\system\css\system.css

Module

<jdoc:include type="module" name="breadcrumbs" title="Breadcrumbs" />
<jdoc:include type="module" name="mainmenu" title="Main Menu" />

Cet élément affiche un module unique indiqué par les attributs name et title : name doit correspondre au type de module (mod_breadcrumbs et mod_menu dans les exemples ci-dessus) tandis que title doit correspondre au nom du module souhaité. Le module en question doit être publié et accessible par l'utilisateur en ligne afin de pouvoir être visible. Des attributs supplémentaires peuvent être ajoutés pour contrôler la mise en page et l'apparence du module, si supportés.

Modules

Les modules s'affichent sur une page en utilisant un des exemples de code suivants. Les modules sont séparés dans différentes zones utilisant les positions de templates indiquées dans le fichier templatedetails.xml. En utilisant l'attribut name="[nom de la position de template]" de jdoc:include, les différents modules, dans leurs positions respectives, peuvent être appelés, rendus et stylisés séparément. Des attributs supplémentaires peuvent être utilisés pour contrôler la mise en page et l'apparence des modules, si supportés.

Voici quelques exemples de déclarations de modules avec les positions de modules fréquemment utilisées par les développeurs de thème pour Joomla!.

<jdoc:include type="modules" name="debug" />
<jdoc:include type="modules" name="icon" />
<jdoc:include type="modules" name="left" style="rounded" />
<jdoc:include type="modules" name="left" style="xhtml" />
<jdoc:include type="modules" name="right" style="xhtml" />
<jdoc:include type="modules" name="status"  />
<jdoc:include type="modules" name="syndicate" />
<jdoc:include type="modules" name="title" />
<jdoc:include type="modules" name="toolbar" />
<jdoc:include type="modules" name="top" />
<jdoc:include type="modules" name="top" style="xhtml" />
<jdoc:include type="modules" name="user1" style="xhtml" />
<jdoc:include type="modules" name="user2" style="xhtml" />
<jdoc:include type="modules" name="user3" />
<jdoc:include type="modules" name="user4" />

Remarque : La position de module name="user3" est normalement (et par défaut) utilisée pour le menu haut.

L'attribut style

L'attribut optionnel style="" est disponible pour les types module et modules des déclarations <jdoc:include />. La valeur de l'attribut fait référence au style du module chrome utilisé pour envelopper le rendu généré par le Module. Si aucun style n'est indiqué, alors une valeur "none" est utilisée par défaut.

Les designers de Template peuvent ajouter des noms chrome supplémentaires comme décrit dans Appliquer un module chrome personnalisé.

Voir également