Design combinations -- Combinaisons de designs

Date de publication: le mardi 22 mars 2011 à 10h31
Dernière modification: par Pascal BOYER le lundi 28 mars 2011 à 12h42

28/09/2010 11:09

versions 3.9, 3.10, 4.x

A siteaccess may make use of several designs. This means that the final result generated by eZ Publish (the actual HTML) can be a combination of files originating from various designs. A siteaccess is capable of using a combination of the following:
Un siteaccess peut utiliser plusieurs designs, ce qui signifie que le résultat final généré par eZ Publish (le code HTML) peut être une combinaison de fichiers provenant de divers designs. Un siteaccess peut en fait utiliser l'une des combinaisons suivantes:

• One main design 
  Un design principal

• None or several additional designs 
  Aucun ou plusieurs designs supplémentaires

• One standard design 
  Un design standard

A siteaccess should always have at least a main design and a standard design. While the main design can be set to anything, the standard design should not be modified. The default configuration is to use the built-in standard design. It ensures that eZ Publish always finds the necessary templates and thus any kind of content can be rendered without problems. A more in-depth explanation is presented below.
Un siteaccess devrait toujours être lié à au moins un design principal et à un design standard. Alors que le design principal peut être configuré pour répondre à n'importe qu'elle circonstance, le design standard, lui, ne doit pas être modifié. La configuration par défaut de eZ Publish utilise le design standard qui l'assure de toujours trouver les templates nécessaires et, par conséquent, de pouvoir afficher sans problème n'importe quel type de contenu. De plus amples informations sont proposées ci-après.

Automatic fallback / Système de repli automatique

If eZ Publish is unable to find a design specific file (a stylesheet, a template, an image, etc.) within the main design, it will automatically attempt to locate the file elsewhere. The system will sequentially go through all the additional designs (if specified), looking for the requested file. At last, if the requested file still hasn't been found, eZ publish will attempt to locate the missing file within the standard design. The following diagram illustrates this functionality.
Lorsqu'eZ Publish ne trouve pas un fichier de design particulier (une feuille de styles, un template, une image, etc...) dans le design principal, alors il essaie automatiquement de le chercher ailleurs. Le système parcourra tous les designs supplémentaires (s'ils existent) à la recherche du fichier demandé. Finalement, si ce fichier ne peut être localisé, eZ Publish essaiera de le trouver dans le design standard. Le diagramme suivant illustre cette fonctionnalité de repli automatique:

The design fallback mechanism
Mécanisme de designs de repli

Configuration

The different designs to be used by must be defined in the "[DesignSettings]" block within an override for the "site.ini" configuration file. The following directives can be used:
Les différents designs disponibles doivent être définis sous la section [DesignSettings] de l'une des surcharges du fichier de configuration site.ini. Les paramètres suivantes peuvent être utilisés:

• SiteDesign 
• AdditionalSiteDesignList 
• StandardDesign 

The "SiteDesign" directive specifies the main design. The "AdditionalSiteDesignList" directive specifies an array of additional site designs. The "StandardDesign" directive specifies the standard design. Even though it is possible to change the standard fallback design, it is not a good idea to do so. The "StandardDesign" directive should always be set to the built-in standard design. This is already defined in the default "site.ini" file and thus there is no need to set the standard design from within an override. If there is a need for a custom fallback design, it should be specified using the "AdditionalSiteDesignList" setting. The automatic fallback mechanism opens up for a lot of possibilities and flexibility. For example, it makes the reuse and combination of designs an easy matter.
Le paramètre SiteDesign définit le design principal, le paramètre AdditionalSiteDesignList est un tableau de valeurs contenant la liste des designs supplémentaires et le paramètre StandardDesign définit le design standard. Bien que cela soit possible, il n'est pas recommandé de modifier le design standard de repli. Le paramètre StandardDesign devrait donc toujours avoir pour valeur standard (nom du design standard fourni par eZ Publish) et c'est d'ailleurs ainsi que cela est toujours défini dans le fichier par défaut site.ini. Il devient par conséquent inutile de redéfinir le design standard dans une surcharge du fichier site.ini. En cas de besoin d'un design de repli personnalisé, il doit être spécifié par le biais du paramètre AdditionalSiteDesignList. Le mécanisme de repli automatique permet un grand nombre de possibilités et beaucoup de flexibilité. Il permet par exemple de réutiliser et de combiner facilement les designs.

Exemple

The following example shows how to configure the following design settings in an override for the "site.ini" configuration file:
L'exemple qui suit montre comment configurer, dans une surcharge du fichier de configuration site.ini , les designs listés ci-dessous:

• "my_design" should be the main design 
  my_design doit être le design principal

• "fallback_one" should be the first additional design 
  fallback_one doit être le premier design de repli

• "fallback_two" should be the second additional design 
  fallback_two doit être le deuxième design de repli

• "standard" should be the standard fallback design 
  standard doit être le design standard de repli

...
[DesignSettings]
SiteDesign=my_design
AdditionalSiteDesignList[]=fallback_one
AdditionalSiteDesignList[]=fallback_two
StandardDesign=standard
...

In this particular case, if eZ Publish is unable to find the requested file within the main design "my_design", it will automatically fallback to the additional designs. At first, the system will look for the requested file within the "fallback_one" design directory. If the requested file is not found, the system will look in the "fallback_two" design directory. If the file still hasn't been found, the system will attempt to locate it within the "standard" design directory. The standard directory will most likely contain the requested file (unless a custom template/override is requested).
Dans ce cas particulier, si eZ Publish ne trouve pas le fichier demandé dans le design principal my_design, il se repliera automatiquement vers les designs supplémentaires. Tout d'abord, le système cherchera le fichier demandé dans le sous-répertoire design/fallback_one/. Si le fichier ne s'y trouve pas, le système cherchera dans le sous-répertoire design/fallback_two/. Si le fichier ne s'y trouve pas non plus, le système essaiera alors de le trouver dans le sous-répertoire design/standard/ qui contiendra vraisemblablement le fichier demandé (à moins qu'un template ou une surcharge personnalisée ne soit demandé).

Commentaires