Surcharge des pages virtuelles

Cette fonctionnalité est disponible à partir de la version 4.8.

Les pages virtuelles ont des configurations par défaut. Ces configurations contiennent un contenu et/ou des services. Ces pages virtuelles sont surchargeables par projet et par charte graphique.

  1. Format XML d'une configuration de pages virtuelles :
  2. Surcharge de la configuration de pages virtuelles
  3. Les pages virtuelles surchargeables

Format XML d'une configuration de pages virtuelles :

A partir de Ametys 4.9

<model template="page">
   <zone id="default">
     <service id="org.ametys.web.service.SitemapService">
        <parameters>
           <!-- paramètres du service sous la forme <paramName>value</paramName> -->
       </parameters>
       <view-parameters>
           <!-- paramètres de vues du service sous la forme <paramName>value</paramName> -->     
       </view-parameters>
     </service>
     <content view="main">
        <view-parameters>
         <!-- paramètres de vues du contenu sous la forme <paramName>value</paramName> -->     
     </view-parameters>
    </content>
 </zone>
</model>

Ametys 4.8

<model template="page">
   <zone id="default">
     <service id="org.ametys.web.service.SitemapService">
        <!-- paramètres du service -->
     </service>
     <content view="main"/>
 </zone>
</model>

L'attribut template de la balise <model> définit le gabarit à utiliser pour les pages virtuelles. S'il n'est pas renseigné, le gabarit "page" sera utilisé par défaut.

La balise <zone> définit dans quel zone seront ajouté le ou les contenus/services définis. L'attribut id permet d'identifier la zone.

La balise <service> permet d'ajouter un service dans la zone. L'attribut id permet d'identifier le service.
Les éventuels paramètres du service sont définis à l'intérieur de la balise sous la forme <paramName>value</paramName>:

  • sous une balise <parameters> à partir de Ametys 4.9
  • directement sous la balise <service> en Ametys 4.8

Ametys 4.9 supporte les paramètres de vue du service. Ils doivent être valués dans une balise <view-parameters> sous la forme <paramName>value</paramName>

La balise <content> permet de configurer l'endroit ou le contenu sera inséré dans la page, ainsi que la vue du contenu utilisée via l'attribut view. 

Ametys 4.9 supporte les paramètres de vue du contenu. Ils doivent être valués dans une balise <view-parameters> sous la forme <paramName>value</paramName>

Note
La balise <content> n'est obligatoire que si la page virtuelle est une page virtuelle devant afficher un contenu.
Si la balise est présente mais non supportée par la page virtuelle, vous obtiendrez une erreur du type « Java.lang.UnsupportedOperationException: This virtual page does not have a content and the overriding configuration requires one. »

Surcharge de la configuration de pages virtuelles

Par défaut Ametys propose une configuration pour chaque ensemble/type de pages virtuelles. Celles-ci se trouvent dans les plugins dans le répertoire"main/<nomPlugin>/virtual-pages/".

Ces configurations par défaut sont toutes surchargeables.

Les surcharges sont lues dans cet ordre : 

  1. Surcharge par charte graphique
    • Trouver le nom du fichier XML associé au type de page qu'on veut surcharger (nomDuFichier.xml)
    • Redéfinir ce fichier XML dans {skin}/virtual-pages/nomDuFichier.xml
  2. Surcharge par projet
    • Trouver le nom du fichier XML associé au type de page qu'on veut surcharger (nomDuFichier.xml)
    • Redéfinir ce fichier XML dans {AmetysHome}/WEB-INF/param/view/virtual-pages/nomDuFichier.xml
  3. Configuration par défaut.

La configuration de charte sera donc prioritaire à la configuration du projet et toutes deux seront prioritaires sur la configuration par défaut.

Les pages virtuelles surchargeables

 

Retour en haut

Manuel de paramétrage et d'intégration