Modèles de pages – Modifiables page-templates-editable
Les modèles modifiables ont été élaborés pour :
-
Autoriser les auteurs spécialisés à créer et modifier des modèles.
- Ces auteurs spécialisés sont connus sous le nom de créateurs (ou auteurs) de modèles.
- Les créateurs de modèles doivent être membres du groupe
template-authors
.
-
Fournissez des modèles qui conservent une connexion dynamique aux pages qu’ils ont créées. De cette manière, toute modification apportée au modèle est répercutée dans les pages proprement dites.
-
Rendre le composant de page plus générique afin que le composant de page principal puisse être utilisé sans personnalisation.
Avec les modèles modifiables, les éléments qui constituent une page sont isolés au sein des composants. Vous pouvez configurer les combinaisons de composants nécessaires dans une interface utilisateur, rendant ainsi inutile le développement d’un nouveau composant de page pour chaque variante de page.
Ce document :
-
Présentation de la création de modèles modifiables
- Pour plus d’informations, consultez la section Création de modèles de page.
-
Décrit les tâches de l’administrateur/du développeur requises pour créer des modèles modifiables.
-
décrit les bases techniques des modèles modifiables ;
Dans ce document, nous partons du principe que vous êtes déjà rompu à la création et la modification de modèles. Consultez le document Création de modèles de page qui détaille les fonctionnalités des modèles modifiables telles qu’elles sont présentées au créateur d’un modèle.
Prise en main d’AEM Sites Partie 2 - Création d’une page et d’un modèle de base
Création d’un modèle creating-a-new-template
La création de modèles modifiables s’effectue principalement à l’aide de la méthode console de modèles et éditeur de modèles par un créateur de modèles. Cette section vous donne un aperçu de ce processus. Elle décrit ensuite ce qui se passe au niveau technique.
Pour plus d’informations sur l’utilisation de modèles modifiables dans un projet AEM, voir Création d’un projet AEM à l’aide de Lazybones.
Lors de la création d’un modèle modifiable :
-
Créez un dossier des modèles. Cette opération n’est pas obligatoire, mais elle est recommandée.
-
Sélectionnez un type de modèle. Il est copié afin de créer la définition du modèle.
note note NOTE Une sélection de types de modèles prêts à l’emploi est fournie. Vous pouvez également créer vos propres types de modèles spécifiques à un site ; si nécessaire. -
Configurez la structure, les stratégies de contenu, le contenu initial et la mise en page du nouveau modèle.
Structure
-
La structure vous permet de définir les composants et le contenu de votre modèle.
-
Les composants définis dans la structure du modèle ne peuvent pas être déplacés sur une page résultant du processus ni supprimés des pages créées.
- Si vous créez un modèle dans un dossier personnalisé en dehors de l’exemple de contenu We.Retail, vous pouvez sélectionner des composants de base ou utiliser Composants principaux.
-
Si vous souhaitez que les auteurs de pages puissent ajouter et supprimer des composants, ajoutez un système de paragraphes au modèle.
-
Les composants peuvent être déverrouillés (et reverrouillés) pour que vous puissiez définir le contenu initial.
Pour plus d’informations sur la façon dont un créateur de modèles définit la structure, voir Création de modèles de page.
Pour connaître les détails techniques de la structure, consultez la section Structure de ce document.
Stratégies
-
Les stratégies de contenu définissent les propriétés de conception d’un composant.
- Par exemple, les composants disponibles ou les dimensions minimales/maximales.
-
Elles s’appliquent au modèle (et aux pages créées avec le modèle).
Pour plus d’informations sur la façon dont un créateur de modèles définit des stratégies, voir Création de modèles de page.
Pour connaître les détails techniques des stratégies, consultez la section Stratégies de contenu de ce document.
Contenu initial
- Contenu initial définit le contenu qui s’affiche lors de la première création d’une page en fonction du modèle.
- Le contenu initial peut ensuite être modifié par les auteurs de pages.
Pour plus d’informations sur la façon dont un créateur de modèles définit la structure, voir Création de modèles de page.
Pour plus d’informations techniques sur le contenu initial, voir Contenu initial dans ce document.
Disposition
- Vous pouvez définir la disposition du modèle pour différents appareils.
- La mise en page réactive pour les modèles fonctionne de la même manière que pour la création de pages.
Pour plus d’informations sur la façon dont le créateur d’un modèle définit la mise en page de ce dernier, voir Création de modèles de page.
Pour plus d’informations techniques sur la mise en page d’un modèle, voir Disposition dans ce document.
-
-
Activez le modèle, puis autorisez-le pour des arborescences de contenu spécifiques.
- Un modèle peut être activé ou désactivé pour le rendre disponible ou indisponible pour les auteurs de pages.
- Un modèle peut être rendu disponible ou indisponible pour certaines branches de la page.
Pour plus d’informations sur la façon dont un créateur de modèles active un modèle, voir Création de modèles de page.
Pour obtenir des informations techniques sur l’activation d’un modèle, consultez la section Activation et autorisation d’un modèle à utiliser dans ce document
-
Utilisez-le pour créer des pages de contenu.
- Lorsque vous utilisez un modèle pour créer une page, il n’existe aucune différence visible ni indication permettant de distinguer les modèles statiques des modèles modifiables.
- Pour le créateur de pages, le processus est transparent.
Pour plus d’informations sur la façon dont un créateur de pages utilise le modèle afin de créer une page, voir Création et organisation des pages.
Pour obtenir des informations techniques sur la création de pages à l’aide de modèles modifiables, consultez la section Pages de contenu créées de ce document.
cq.shared
existe dans les pages de contenu. Si cet élément est absent, l’erreur JavaScript Uncaught TypeError: Cannot read property 'shared' of undefined
est renvoyée.cq.shared
est inclus dans tous les exemples de pages de contenu. Par conséquent, tout contenu basé sur ces pages inclut automatiquement cq.shared
. Toutefois, si vous décidez de créer vos propres pages de contenu à partir de zéro, sans vous servir de l’exemple de contenu, vous devez veiller à inclure l’espace de noms cq.shared
.Dossiers de modèles template-folders
Pour organiser vos modèles, vous pouvez utiliser les dossiers suivants :
-
Global
-
Spécifique au site
Les dossiers spécifiques au site que vous créez pour organiser vos modèles sont créés avec un compte contenant des privilèges d’administrateur.
Dans une instance AEM standard, le dossier Global existe déjà dans la console de modèles. Il contient les modèles par défaut et fait office de dossier de rechange si le dossier actif ne contient pas de stratégies et/ou de types de modèles. Vous pouvez ajouter vos modèles par défaut à ce dossier ou créer un dossier (recommandé).
admin
.Les types de modèles et les politiques sont hérités dans tous les dossiers selon l’ordre de priorité suivant :
- Dossier actif.
- Parent(s) du dossier actif.
/conf/global
/apps
/libs
Une liste de toutes les entrées autorisées est créée. Si des configurations se chevauchent (path
/label
), seule l’instance la plus proche du dossier actif s’affiche pour l’utilisateur.
Pour créer un dossier, vous pouvez effectuer l’une des opérations suivantes :
- par programmation ou avec CRXDE Lite
- Utilisation de l’explorateur de configurations
Utilisation de CRXDE Lite using-crxde-lite
-
Un nouveau dossier (sous /conf) peut être créé pour votre instance, soit par programmation soit avec CRXDE Lite.
La structure suivante doit être utilisée :
code language-xml /conf <your-folder-name> [sling:Folder] settings [sling:Folder] wcm [cq:Page] templates [cq:Page] policies [cq:Page]
-
Vous pouvez ensuite définir les propriétés suivantes sur le noeud racine du dossier :
<your-folder-name> [sling:Folder]
Nom :
jcr:title
- Type :
String
- Valeur : titre (du dossier) que vous souhaitez afficher dans la console Modèles.
- Type :
-
Outre les autorisations et les droits de création standard (par exemple,
content-authors
), vous devez maintenant affecter les groupes et définir les droits d’accès nécessaires (listes de contrôle d’accès) pour que les créateurs puissent créer des modèles dans le nouveau dossier.Le groupe
template-authors
est le groupe par défaut qui doit être affecté. Pour plus d’informations, consultez la section suivante ACL et groupes.Pour plus d’informations sur la gestion et l’affectation de droits d’accès, consultez la section Gestion des droits d’accès.
Utilisation de l’explorateur de configurations using-the-configuration-browser
-
Accédez à Navigation globale > Outils > Explorateur de configurations.
Les dossiers existants sont répertoriés à gauche, y compris le dossier Global.
-
Cliquez sur Créer.
-
Les champs suivants doivent être configurés dans la boîte de dialogue Créer une configuration :
- Titre: Indiquez un titre pour le dossier de configuration.
- Modèles modifiables: Cochez cette case pour autoriser les modèles modifiables dans ce dossier.
-
Cliquez sur Créer
ACL et groupes acls-and-groups
Une fois vos dossiers de modèles créés (soit via CRXDE, soit à l’aide de l’explorateur de configurations), des listes de contrôle d’accès (ACL) doivent être définies pour les groupes appropriés afin que les dossiers de modèles garantissent une protection adéquate.
Les dossiers de modèles pour le Implémentation de référence We.Retail peut être utilisé comme exemple.
Groupe template-authors the-template-authors-group
Le groupe template-authors
est utilisé pour gérer l’accès aux modèles. Il est fourni en standard avec AEM, mais il est vide. Les utilisateurs doivent donc être ajoutés au groupe pour le projet/site.
template-authors
est destiné uniquement aux utilisateurs qui doivent pouvoir créer des modèles.Le tableau suivant présente les autorisations nécessaires à l’édition de modèles.
Ce groupe template-authors
par défaut couvre les configurations de projet dans lesquelles tous les membres de template-authors
sont autorisés à accéder à l’ensemble des modèles et à en créer. Pour les configurations plus complexes, où plusieurs groupes d’auteurs de modèles sont nécessaires pour séparer l’accès aux modèles, vous devez créer d’autres groupes d’auteurs de modèles personnalisés. Toutefois, les autorisations des groupes d’auteurs de modèles restent les mêmes.
Modèles hérités sous /conf/global legacy-templates-under-conf-global
Les modèles ne doivent normalement plus être stockés dans /conf/global
, cependant, pour certaines installations plus anciennes, il se peut qu’il en reste à cet emplacement. Dans ce cas UNIQUEMENT, les chemins d’accès /conf/global
ci-dessous doivent être configurés explicitement.
Type de modèle template-type
Lors de la création d’un modèle, vous devez indiquer un type de modèle :
-
Les types de modèle fournissent efficacement des modèles pour un modèle. Lors de la création d'un modèle, la structure et le contenu initial du type de modèle sélectionné sont utilisés pour créer le nouveau modèle.
- Le type de modèle est copié pour créer le modèle.
- Une fois la copie effectuée, la seule connexion entre le modèle et le type de modèle est une référence statique à des fins d’information.
-
Les types de modèle permettent de définir :
- Type de ressource du composant de page.
- Stratégie du noeud racine qui définit les composants autorisés dans l’éditeur de modèles.
- Il est recommandé de définir les points d’arrêt pour la grille réactive et la configuration de l’émulateur mobile au niveau du type d’émulateur. Cette option est facultative, car la configuration peut également être définie sur le modèle individuel (voir Type de modèle et groupes d’appareils mobiles).
-
AEM fournit une petite sélection de types de modèle prêts à l’emploi tels que la Page HTML5 et la Page de formulaire adaptatif.
- Des exemples supplémentaires sont fournis dans le cadre de la We.Retail exemple de contenu.
-
Les types de modèle sont généralement définis par les développeurs.
Les types de modèles d'usine sont stockés sous :
/libs/settings/wcm/template-types
/libs
. Cela est dû au fait que le contenu de /libs
sera écrasé la prochaine fois que vous mettrez à niveau votre instance (et éventuellement lors de l’application d’un correctif logiciel ou d’un pack de fonctionnalités).Les types de modèle spécifiques à un site doivent être stockés dans l’emplacement comparable :
/apps/settings/wcm/template-types
Les définitions de vos types de modèle personnalisés doivent être stockées dans des dossiers définis par l’utilisateur (ce qui est recommandé) ou bien dans global
. Par exemple :
/conf/<my-folder-01>/<my-folder-02>/settings/wcm/template-types
/conf/<my-folder>/settings/wcm/template-types
/conf/global/settings/wcm/template-types
/settings/wcm/...
). Dans le cas contraire, ils seront introuvables.Types de modèle et groupes de terminaux mobiles template-type-and-mobile-device-groups
Les groupes de terminaux utilisés pour un modèle modifiable (défini en tant que chemin d’accès relatif de la propriété cq:deviceGroups
) définissent les terminaux mobiles disponibles comme émulateurs dans le mode de mise en page de la création de pages. Vous pouvez définir cette valeur à deux emplacements :
- Sur le type de modèle modifiable
- Sur le de modèle modifiable
Lors de la création d’un modèle modifiable, la valeur est copiée du type de modèle vers le modèle individuel. Si la valeur n’est pas définie sur le type, elle peut être définie sur le modèle. Une fois le modèle créé, il n’hérite d’aucun élément du type.
cq:deviceGroups
doit être définie en tant que chemin d’accès relatif, tel que mobile/groups/responsive
, et non comme chemin d’accès absolu, comme /etc/mobile/groups/responsive
.cq:deviceGroups
peut être définie à la racine du site.Création de types de modèle creating-template-types
Si vous avez créé un modèle qui peut servir de base pour d’autres modèles, vous pouvez le copier en tant que type de modèle.
- Créez un modèle qui servira de base pour votre type de modèle. Pour ce faire, procédez comme vous le feriez pour n’importe quel modèle modifiable, en suivant ces instructions.
- À l’aide de CRXDE Lite, copiez le nouveau modèle depuis le nœud
templates
dans le nœudtemplate-types
sous le dossier de modèles. - Supprimez le modèle du nœud
templates
sous le dossier de modèles. - Dans la copie du modèle qui se trouve sous le nœud
template-types
, supprimez toutes les propriétéscq:template
etcq:templateType
jcr:content
.
Vous pouvez également développer votre propre type de modèle en utilisant un exemple de modèle modifiable comme base (disponible sur GitHub).
CODE SUR GITHUB
Vous pouvez trouver le code de cette page sur GitHub.
- Ouvrez le projet aem-sites-example-custom-template-type sur GitHub.
- Téléchargez le projet sous la forme d’un fichier ZIP.
Définitions de modèle template-definitions
Les définitions des modèles modifiables sont stockées dans des dossiers définis par l’utilisateur (ce qui est recommandé) ou bien dans global
. Par exemple :
/conf/<my-folder>/settings/wcm/templates
/conf/<my-folder-01>/<my-folder-02>/settings/wcm/templates
/conf/global/settings/wcm/templates
Le nœud racine du modèle est de type cq:Template
avec la structure suivante :
<template-name>
initial
jcr:content
root
<component>
...
<component>
jcr:content
@property status
policies
jcr:content
root
@property cq:policy
<component>
@property cq:policy
...
<component>
@property cq:policy
structure
jcr:content
root
<component>
...
<component>
cq:responsive
breakpoints
thumbnail.png
Les éléments principaux sont les suivants :
jcr:content jcr-content
Ce nœud contient des propriétés pour le modèle :
-
Nom :
jcr:title
-
Nom :
status
- Type :
String
- Valeur :
draft
,enabled
oudisabled
- Type :
Structure structure
Définit la structure de la page créée :
-
Est fusionné avec le contenu (
/initial
) lors de la création d’une page. -
Les modifications apportées à la structure sont répercutées dans toute page créée avec le modèle.
-
Le nœud
root
(structure/jcr:content/root
) définit la liste des composants qui seront disponibles dans la page créée.- Les composants définis dans la structure du modèle ne peuvent être ni déplacés ni supprimés dans les pages créées.
- Une fois qu’un composant est déverrouillé, la propriété
editable
est définie surtrue
. - Dès qu’un composant non vide est déverrouillé, son contenu est déplacé vers la branche
initial
.
-
Le nœud
cq:responsive
contient des définitions pour la mise en page réactive.
Contenu initial initial-content
Définit le contenu initial dont une nouvelle page disposera au moment de sa création :
- Contient un nœud
jcr:content
copié dans toute nouvelle page. - Est fusionné avec la structure (
/structure
) lors de la création d’une page. - Aucune page existante n’est mise à jour si le contenu initial est modifié après la création.
- Le nœud
root
contient une liste de composants permettant de définir les éléments qui seront disponibles dans la page créée. - Si du contenu est ajouté à un composant en mode de structure et que ce composant est ensuite déverrouillé (ou inversement), ce contenu est utilisé comme contenu initial.
Mise en page layout
Lors de la modification d’un modèle, vous pouvez définir la mise en page et utiliser une mise en page réactive standard qui peut également être configurée.
Stratégies de contenu content-policies
Les stratégies de contenu (ou de conception) définissent les propriétés de conception d’un composant. Par exemple, les composants disponibles ou les dimensions minimales/maximales. Elles s’appliquent au modèle (et aux pages créées avec le modèle). Les stratégies de contenu peuvent être créées et sélectionnées dans l’éditeur de modèles.
-
La propriété
cq:policy
, sur le nœudroot
/conf/<your-folder>/settings/wcm/templates/<your-template>/policies/jcr:content/root
Fournit une référence relative à la stratégie de contenu pour le système de paragraphes de la page.
-
La propriété
cq:policy
, sur les nœuds component-explicit sousroot
, fournit des liens vers les stratégies relatives aux composants individuels. -
Les définitions de stratégie réelles sont stockées sous :
/conf/<your-folder>/settings/wcm/policies/wcm/foundation/components
cq:policy
contient une référence relative à la configuration proprement dite.policies
d’un modèle modifiable présente la même hiérarchie que la configuration du mode de conception d’un modèle statique sous :/etc/designs/<my-site>/jcr:content/<component-name>
Stratégies de page page-policies
Les stratégies de page vous permettent de définir la stratégie de contenu de la page (système de paragraphes principal), soit dans le modèle soit dans les pages créées.
Activation et autorisation d’un modèle à utiliser enabling-and-allowing-a-template-for-use
-
Activation du modèle
Pour qu’un modèle puisse être utilisé, il doit être activé par :
-
Activation du modèle de la Modèles console.
-
Définir la propriété de statut sur le nœud
jcr:content
.-
Par exemple, sous :
/conf/<your-folder>/settings/wcm/templates/<your-template>/jcr:content
-
Définissez la propriété :
- Nom : status
- Type : chaîne
- Valeur :
enabled
-
-
-
Modèles autorisés
-
Définissez le ou les chemins d’accès des modèles autorisés dans les Propriétés de page de la page appropriée ou de la page racine d’une sous-branche.
-
Définissez la propriété :
cq:allowedTemplates
Sur le
jcr:content
noeud de la branche requise.
Par exemple, avec la valeur suivante :
/conf/<your-folder>/settings/wcm/templates/.*;
-
Pages de contenu créées resultant-content-pages
Les pages créées à partir de modèles modifiables :
-
sont créées avec une sous-arborescence qui est fusionnée à partir de
structure
etinitial
dans le modèle ; -
contiennent des références aux informations contenues dans le modèle et le type de modèle. Pour cela, on utilise un nœud
jcr:content
avec les propriétés suivantes :-
cq:template
Fournit la référence dynamique au modèle proprement dit ; fait en sorte que les modifications apportées au modèle soient répercutées sur les pages proprement dites.
-
cq:templateType
Fournit une référence au type de modèle.
-
Le schéma ci-dessus montre la corrélation entre les modèles, le contenu et les composants :
-
Contrôleur -
/content/<my-site>/<my-page>
Page résultante référençant le modèle. Le contenu contrôle l’ensemble du processus. En fonction des définitions, il accède au modèle et aux composants appropriés.
-
Configuration -
/conf/<my-folder>/settings/wcm/templates/<my-template>
Le modèle et stratégies de contenu associées définissez la configuration de la page.
-
Modèle - Lots OSGi
Le Lots OSGI implémentez la fonctionnalité.
-
Mode -
/apps/<my-site>/components
Dans les environnements de création et de publication, le contenu est rendu par components.
Lors du rendu d’une page :
-
Modèles :
- La propriété
cq:template
du nœudjcr:content
sera référencée afin d’accéder au modèle correspondant à cette page.
- La propriété
-
Composants :
-
Le composant de page fusionnera l’arborescence
structure/jcr:content
du modèle avec l’arborescencejcr:content
de la page. -
Le composant de page autorisera uniquement l’auteur à modifier les nœuds de la structure du modèle qui ont été marqués comme étant modifiables (ainsi que ses éventuels enfants).
-
Lors du rendu d’un composant sur une page, le chemin d’accès relatif de ce composant est prélevé dans le nœud
jcr:content
; une recherche est ensuite effectuée dans le même emplacement sous le nœudpolicies/jcr:content
du modèle.- La propriété
cq:policy
de ce nœud pointe vers la stratégie de contenu proprement dite (en d’autres termes, elle contient la configuration de conception de ce composant). - De cette manière, vous pouvez disposer de plusieurs modèles qui réutilisent les mêmes configurations de stratégie de contenu.
- La propriété
-