System templates -- Les templates système

Date de publication: le lundi 28 mars 2011 à 20h56
Dernière modification: par Pascal BOYER le lundi 4 avril 2011 à 14h07

28/09/2010 12:08

versions 3.9, 3.10, 4.x

Whenever eZ Publish is requested to do something else than displaying a node (in other words the URL does not contain "/content/view" or isn't the virtual URL of a node), it will use a system template. There are two main differences between system templates and node templates:
Chaque fois que l'on demande à eZ Publish de faire autre chose que d’afficher un nœud (c’est à dire chaque fois que l’URI ne contient pas /content/view ou qu’il n’est pas un URI virtuel), eZ Publish utilise un template système. Les deux principales différences entre template système et template de nœud sont:

• System templates provide access to various variables (depending on the view that was requested). A node template only provides access to a $node variable representing the node that was requested.
  Les templates système permettent l’accès à de nombreuses variables (en fonction de la vue demandée). Un template de nœud ne permet l’accès qu’à la variable $node qui représente le nœud qui a été demandé.

• The override rules for node templates are much more flexible than the override rules for system templates.
  Les règles de surcharge des templates de nœud sont bien plus flexibles que celles des templates système.

An eZ Publish distribution provides default templates for all views. These templates are located in the "templates" directory of the standard design. A view typically uses a template that is located in a subdirectory that has the same name as the module which the view belongs to. The name of the template is usually the same as the name of the view (with a ".tpl" extension). For example, the "login" view of the "user" module is looks for a template called "login.tpl" inside a directory called "user". Another example would be the "basket" view of the "shop" module. This view looks for a template called "basket.tpl" within the "shop" directory.
Une distribution eZ Publish fournit des templates de base pour chaque vue. Ces templates sont placés dans le sous-répertoire design/standard/template/ du design standard. Typiquement, une vue utilise un template placé dans un sous-répertoire portant le même nom que celui du module auquel appartient la vue. Le nom du template est couramment le même que celui de la vue suivi de l’extension .tpl. Par exemple, la vue login du module user est recherchée dans un template nommé login.tpl placé dans un répertoire nommé user/. Un autre exemple serait la vue basket (panier) du module shop. Cette vue recherche un template nommé basket.tpl dans un répertoire shop/

Custom system templates / Templates système personnalisés

Although eZ Publish provides all the necessary system templates (by the way of the standard design), a typical eZ Publish site always makes use of customized system templates. The main reason for this is because the default templates usually need to be tailored in order to fit perfectly in with the style of a custom design. Unlike custom node templates which are mostly provided using the template override system, custom system templates are usually just modified copies of the standard templates located in the custom design. These are not connected with the override system and must be placed in the "templates" directory of a custom design (not in the "override/templates" directory). For example, a custom template for the "login" view of the "user" module in a design called "example" would be "/design/example/templates/user/login.tpl". A custom template for the "search" view of the "content" module would be "/design/example/templates/content/search.tpl".
Bien qu'eZ Publish fournisse tous les templates système nécessaires (par le biais du design standard), un site eZ Publish utilise toujours des templates système personnalisés. La principale raison de ceci est que les templates de base (ceux fournis par défaut) ont besoin d’être adaptés/modifiés pour coller au mieux au design personnalisé du site. A l’inverse des templates de nœud personnalisés qui sont le plus souvent fournis par le système de surcharge des templates, les templates système personnalisés sont souvent de simples copies des templates de base placés dans le design personnalisé et ne sont donc pas liés au système de surcharge. Pour cela, ils doivent être placés dans le sous-répertoire templates/ du design personnalisé (et non dans le sous-répertoire override/templates/). Par exemple, un template personnalisé pour la vue login du module user d’un design personnalisé nommé exemple sera placé dans /design/exemple/templates/user/login.tpl. Un template personnalisé pour la vue search du module content sera placé dans /design/exemple/templates/content/search.tpl

Design combinations / Combinaisons de design

As mentioned in the text above, a custom design typically contains a set of customized system templates. However, creating a custom design that provides templates for all possible scenarios would be too much / unnecessary work. This is why the standard design always should be used as the last fallback resort. The automatic fallback system makes it possible to combine several designs so that the main design (which is usually a custom design) does not have to provide all the necessary templates. Whenever eZ Publish is unable to find a template within the main design of the siteaccess, the system will look for it in the additional designs and the standard design.
Comme mentionné précédemment, un design personnalisé contient un jeu de templates système personnalisés. Cependant, créer un design personnalisé proposant des templates pour tous les scénarios possibles serait un travail important et inutile. C’est pourquoi le design standard doit toujours être utilisé en dernier ressort. Le système de repli automatique rend possible la combinaison de plusieurs designs et inutile que le design principal (qui est souvent un design personnalisé) ait à fournir tous les templates nécessaires. Chaque fois qu'eZ Publish ne trouve pas le template dans le design principal du siteaccess utilisé, il le recherche dans les designs alternatifs puis dans le design standard.

Commonly used system templates / Templates système couramment utilisés

The following table shows some of the most commonly used system templates.
Le tableau suivant présente quelques uns des templates système les plus utilisés:

Commentaires