Modèles modifiables editable-templates
Découvrez comment les modèles modifiables sont utilisés lors de la création d’une page, de la définition de son contenu initial, de son contenu structuré, de ses stratégies de création et de sa mise en page.
Vue d’ensemble overview
Lors de la création d’une page, vous devez sélectionner un modèle. Le modèle de page est utilisé comme base pour la nouvelle page. Le modèle peut définir la structure de la page créée, tout contenu initial et les composants qui peuvent être utilisés (propriétés de conception).
-
Les modèles modifiables permettent aux auteurs de créer et d’utiliser des modèles.
-
Les modèles modifiables peuvent être utilisés pour créer des pages modifiables avec les
Les modèles de pages utilisés pour créer des pages modifiables avec l’éditeur universel utilisent un sous-ensemble limité de fonctionnalités de modèle modifiables. Par conséquent, le reste de ce document se concentre sur les modèles modifiables utilisés pour créer des pages modifiables avec l’éditeur de page.
Modèles et pages modifiables Modifiés à l’aide de l’éditeur de page page-editor
Lors de la création de modèles destinés à la création de pages modifiables à l’aide de l’éditeur de page, des auteurs normalement spécialisés sont identifiés.
- 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
. - Les modèles modifiables conservent une connexion dynamique à toutes les pages créées à partir de ces derniers. De cette manière, toute modification apportée au modèle est répercutée dans les pages proprement dites.
- Les modèles modifiables rendent 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 :
- Donne un aperçu de la création d’un modèle modifiable.
- décrit les tâches d’administration ou de développement requises pour créer des modèles modifiables ;
- décrit les bases techniques des modèles modifiables ;
- décrit comment AEM évalue la disponibilité d’un modèle.
Création d’un modèle modifiable creating-a-new-template
La création de modèles modifiables s’effectue essentiellement à l’aide de la console de modèles et de l’éditeur de modèles. Cette tâche est de la responsabilité d’une personne spécialisée dans la création de modèles. Cette section vous donne un aperçu de ce processus. Elle décrit ensuite ce qui se passe au niveau technique.
Lors de la création d’un modèle modifiable :
-
Créez un dossier pour les modèles. Cela n’est pas obligatoire, mais cela fait partie des bonnes pratiques recommandées.
-
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èle spécifiques au site si nécessaire. -
Configurez la structure, les politiques 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 créée ni supprimés des pages créées.
- Si vous souhaitez que les personnes créant les 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 Modèles de création de pages modifiables avec l’éditeur de page.
Pour connaître les détails techniques de la structure, consultez la section Structure de ce document.
Politiques
-
Les politiques de contenu définissent les propriétés de conception d’un composant.
- Par exemple, les composants disponibles ou les dimensions minimales/maximales.
-
Ces politiques 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 Modèles de création de pages modifiables avec l’éditeur de page.
Pour connaître les détails techniques des politiques, consultez la section Politiques de contenu de ce document.
Contenu initial
- Le 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 personnes créant les pages.
Pour plus d’informations sur la façon dont un créateur de modèles définit la structure, voir Modèles de création de pages modifiables avec l’éditeur de page.
Pour plus d’informations techniques sur le contenu initial, reportez-vous à la rubrique Contenu initial de 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 un créateur de modèles définit la mise en page du modèle, voir Modèles de création de pages modifiables avec l’éditeur de page.
Pour plus d’informations techniques sur la mise en page d’un modèle, reportez-vous à la rubrique mise en page de 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é afin de le rendre disponible ou indisponible pour les personnes créant les 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 Modèles de création de pages modifiables avec l’éditeur 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.
- Lors de l’utilisation d’un modèle pour créer une page, il n’y a aucune différence visible et aucune indication entre les modèles statiques et 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
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 politiques et/ou de types de modèles. Vous pouvez ajouter vos modèles par défaut à ce dossier ou créer un dossier (recommandé).
global
.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 nœud 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.
- Nom :
-
Outre les autorisations et les droits de création standard (par exemple,
content-authors
), vous devez maintenant attribuer le(s) groupe(s) et définir les droits d’accès nécessaires (listes de contrôle d’accès, ACL) 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 attribué. Pour plus d’informations, consultez la section ACL et groupes.
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 : sélectionnez cette option 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 destinés au tutoriel WKND peuvent être utilisés à titre d’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, lorsque plusieurs groupes de personnes créant des modèles sont nécessaires pour séparer l’accès aux modèles, vous devez créer davantage de groupes de personnes créant des modèles personnalisés. Toutefois, les autorisations des groupes de personnes créant des modèles restent les mêmes.
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 de façon efficace 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 :
- Le type de ressource du composant de page.
- La politique du nœud 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.
-
AEM fournit une petite sélection de types de modèle prêts à l’emploi tels que Page HTML5 et Page de formulaire adaptatif.
- Des exemples supplémentaires sont fournis dans le tutoriel WKND.
-
Les types de modèle sont généralement définis par les développeurs et les développeuses.
Les types de modèles prêts à l’emploi sont stockés sous :
/libs/settings/wcm/template-types
/libs
. En effet, le contenu de /libs
peut être remplacé à tout moment par une mise à jour d’AEM.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.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 comme vous le feriez pour n’importe quel modèle de page. Voir Modèles de création de pages modifiables avec l’éditeur de page. Cela servira de base à votre type de modèle.
- À l’aide de CRXDE Lite, copiez le modèle créé à partir du noeud
templates
vers le noeudtemplate-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
de tous les nœudsjcr: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 :
-
<template-name>
[initial](#initial-content)
jcr:content
[structure](#structure)
[policies](#policies)
thumbnail.png
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ée avec le contenu (
/initial
) lors de la création d’une page. -
Les modifications apportées à la structure sont répercutées dans toutes les pages créées 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 ayant déjà du contenu 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.
Disposition layout
Lorsque vous modifiez un modèle, vous pouvez définir la mise en page, celle-ci utilise la mise en page réactive standardqui peut être configurée sur la page par l'auteur du contenu.
Politiques de contenu content-policies
Les politiques de contenu définissent les propriétés de conception d’un composant. Par exemple, les composants disponibles ou les dimensions minimales/maximales. Ces politiques s’appliquent au modèle (et aux pages créées avec le modèle). Les politiques 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 politique 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 politiques relatives aux composants individuels. -
Les définitions de politique 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.Politiques de page page-policies
Les politiques de page vous permettent de définir la politique 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
-
Activer le modèle
Pour qu’un modèle puisse être utilisé, il doit être activé par l’un des moyens suivants :
-
Activer le modèle à partir de la console des Modèles.
-
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 : statut
- 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 nœudjcr:content
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 les politiques de contenu associées définissent la configuration de la page. - Modèle – Lots OSGi – Les lots OSGi mettent en œuvre la fonctionnalité.
- Vue –
/apps/<my-site>/components
– Dans les environnements de création et de publication, le contenu est rendu par des composants.
Lors du rendu d’une page :
-
Modèles :
- La propriété
cq:template
de son 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 ou l’autrice à modifier les nœuds de la structure du modèle qui ont été marqués comme étant modifiables (ainsi que leurs é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 sera ensuite effectuée dans le même chemin sous le nœudpolicies/jcr:content
du modèle.- La propriété
cq:policy
de ce nœud pointe vers la politique de contenu proprement dite (en d’autres termes, elle contient la configuration de conception de ce composant).- Cela vous permet de disposer de plusieurs modèles qui réutilisent les mêmes configurations de stratégie de contenu.
- La propriété
-
Disponibilité des modèles template-availability
Lors de la création d’une page dans l’interface d’administration du site, la liste des modèles disponibles dépend de l’emplacement de la nouvelle page et des restrictions d’emplacement spécifiées dans chaque modèle.
Les propriétés suivantes déterminent si un modèle T
peut être utilisé pour qu’une nouvelle page soit placée en tant qu’enfant de la page P
. Chacune de ces propriétés est une chaîne à valeurs multiples contenant aucune ou plusieurs expressions régulières utilisées pour la correspondance avec les chemins :
-
La propriété
cq:allowedTemplates
du sous-nœudjcr:content
deP
ou un ancêtre deP
. -
La propriété
allowedPaths
deT
. -
La propriété
allowedParents
deT
. -
La propriété
allowedChildren
du modèle deP
.
L’évaluation fonctionne comme suit :
-
La première propriété
cq:allowedTemplates
non vide détectée dans la hiérarchie de page commençant parP
est comparée au chemin deT
. Si aucune des valeurs ne correspond,T
est rejeté. -
Si
T
a une propriétéallowedPaths
non vide, mais qu’aucune des valeurs ne correspond au chemin deP
,T
est rejeté. -
Si les deux propriétés ci-dessus sont vides ou inexistantes,
T
est rejeté sauf s’il appartient à la même application queP
.T
appartient à la même application queP
si et seulement si le nom du deuxième niveau du chemin deT
est identique à celui du deuxième niveau du chemin deP
. Par exemple, le modèle/apps/wknd/templates/foo
appartient à la même application que la page/content/wknd
. -
Si
T
a une propriétéallowedParents
non vide, mais qu’aucune des valeurs ne correspond au chemin deP
,T
est rejeté. -
Si le modèle de
P
a une propriétéallowedChildren
non vide, mais qu’aucune des valeurs ne correspond au chemin deT
,T
est rejeté. -
Dans tous les autres cas,
T
est autorisé.
Le diagramme suivant illustre le processus d’évaluation de modèle :
-
uniquement la propriété
cq:allowedTemplates
; -
uniquement sur la racine du site.
/content/wknd/jcr:content
allowedPaths
, allowedParents
et allowedChildren
peuvent également être placées sur les modèles pour définir des règles plus élaborées. Cependant, dans la mesure du possible, il est beaucoup plus simple de définir d’autres propriétés cq:allowedTemplates
dans des sous-sections du site si des restrictions supplémentaires des modèles autorisés s’imposent.cq:allowedTemplates
peuvent être mises à jour par un auteur dans l’onglet Avancé des Propriétés de la page. Les autres propriétés de modèle ne peuvent pas être mises à jour à l’aide de l’interface utilisateur (standard). Il faudrait donc qu’un développeur conserve les règles et qu’un déploiement du code soit effectué pour chaque modification.Limitation des modèles utilisés dans les pages enfants limiting-templates-used-in-child-pages
Pour limiter les modèles servant à créer des pages enfants sous une page donnée, utilisez la propriété cq:allowedTemplates
du nœud jcr:content
de la page pour spécifier la liste des modèles à autoriser en tant que pages enfants. Chaque valeur de la liste doit être un chemin absolu vers un modèle pour une page enfant autorisée, par exemple /apps/wknd/templates/page-content
.
Vous pouvez utiliser la propriété cq:allowedTemplates
sur le noeud jcr:content
du modèle pour que cette configuration soit appliquée à toutes les pages créées qui utilisent ce modèle.
Si vous souhaitez ajouter d’autres contraintes, par exemple concernant la hiérarchie des modèles, vous pouvez appliquer les propriétés allowedParents/allowedChildren
sur le modèle. Vous pouvez ensuite spécifier explicitement que les pages créées à partir d’un modèle T doivent être des parents/enfants de pages créées à partir d’un modèle T.