DocumentaciónAEM 6.4Guía de desarrollo

Plantillas de página: editables page-templates-editable

Last update: Fri May 05 2023 00:00:00 GMT+0000 (Coordinated Universal Time)

Creado para:

  • Developer
CAUTION
AEM 6.4 ha llegado al final de la compatibilidad ampliada y esta documentación ya no se actualiza. Para obtener más información, consulte nuestra períodos de asistencia técnica. Buscar las versiones compatibles here.

Se han introducido plantillas editables para:

  • Permitir que los autores especializados crear y editar plantillas.

    • A estos autores especializados se les llama autores de plantillas
    • Los autores de plantillas deben ser miembros del template-authors grupo.

  • Proporcione plantillas que mantengan una conexión dinámica con cualquier página creada a partir de ellas. Esto garantiza que cualquier cambio en la plantilla se refleje en las propias páginas.

  • Consiga que el componente de página sea más genérico para que el componente de página principal se pueda utilizar sin personalización.

Con las plantillas editables, los elementos que crean una página están aislados dentro de los componentes. Puede configurar las combinaciones necesarias de componentes en una interfaz de usuario, eliminando así la necesidad de desarrollar un nuevo componente de página para cada variación de página.

NOTE
Se requiere AEM 6.4.5.0 o posterior para utilizar plantillas editables con la variable Editor SPA.
NOTE
Plantillas estáticas también están disponibles.

Este documento:

  • Proporciona información general sobre la creación de plantillas editables

  • Describe las tareas de administrador/desarrollador necesarias para crear plantillas editables

  • Describe los fundamentos técnicos de las plantillas editables

Este documento supone que ya está familiarizado con la creación y edición de plantillas. Consulte el documento de creación Creación de plantillas de página, que detalla las capacidades de las plantillas editables tal y como se exponen al autor de la plantilla.

NOTE
El siguiente tutorial también puede ser de interés para configurar una plantilla de página editable en un nuevo proyecto:
Introducción a AEM Sites, parte 2: Creación de una página base y una plantilla

Creación de una plantilla nueva creating-a-new-template

La creación de plantillas editables se realiza principalmente con la variable consola de plantillas y editor de plantillas por un autor de plantillas. Esta sección ofrece información general sobre este proceso y a continuación una descripción de lo que ocurre a nivel técnico.

Para obtener información sobre cómo utilizar plantillas editables en un proyecto AEM, consulte Creación de un proyecto de AEM con Lazybones.

Al crear una plantilla editable nueva, debe:

  1. Cree un carpeta de las plantillas. Esto no es obligatorio, pero se recomienda una práctica recomendada.

  2. Seleccione un tipo de plantilla. Esto se copia para crear la variable definición de plantilla.

    note note
    NOTE
    Se proporciona una selección de tipos de plantillas listas para usar. También puede crear sus propios tipos de plantilla específicos del sitio si es necesario.

  3. Configure la estructura, las políticas de contenido, el contenido inicial y el diseño de la nueva plantilla.

    Estructura

    • La estructura permite definir componentes y contenido para la plantilla.

    • Los componentes definidos en la estructura de la plantilla no se pueden mover a una página resultante ni eliminarse de ninguna página resultante.

      • Si está creando una plantilla en una carpeta personalizada fuera del contenido de muestra de We.Retail, puede elegir Componentes básicos o utilizar Componentes principales.

    • Si desea que los autores de la página puedan añadir y eliminar componentes, agregue un sistema de párrafos a la plantilla.

    • Los componentes pueden volver a desbloquearse y bloquearse para que pueda definir el contenido inicial.

    Para obtener más información sobre cómo define un autor de plantillas la estructura, consulte Creación de plantillas de página.

    Para obtener detalles técnicos de la estructura, consulte Estructura en este documento.

    Políticas

    • Las políticas de contenido definen las propiedades de diseño de un componente.

      • Por ejemplo, los componentes disponibles o las dimensiones mínimas/máximas.

    • Esto se aplica a la plantilla (y a las páginas creadas con la plantilla).

    Para obtener más información sobre cómo define las políticas un autor de plantillas, consulte Creación de plantillas de página.

    Para obtener detalles técnicos sobre las directivas, consulte Políticas de contenido en este documento.

    Contenido inicial

    • El contenido inicial define el contenido que aparecerá cuando se cree una página por primera vez en función de la plantilla.
    • Los autores de páginas pueden editar el contenido inicial.

    Para obtener más información sobre cómo define un autor de plantillas la estructura, consulte Creación de plantillas de página.

    Para obtener información técnica sobre el contenido inicial, consulte Contenido inicial en este documento.

    Diseño

    • Puede definir el diseño de la plantilla para una amplia gama de dispositivos.
    • El diseño interactivo para las plantillas funciona tal como lo hace para la creación de páginas.

    Para obtener más información sobre cómo define un autor de plantillas el diseño de la plantilla, consulte Creación de plantillas de página.

    Para obtener información técnica sobre el diseño de la plantilla, consulte Diseño en este documento.

  4. Habilite la plantilla y luego déjela para árboles de contenido específicos.

    • Una plantilla se puede habilitar o deshabilitar para que esté disponible o no disponible para los autores de páginas.
    • Una plantilla puede estar disponible o no disponible para determinadas ramas de la página.

    Para obtener más información sobre cómo un autor de plantillas habilita una plantilla, consulte Creación de plantillas de página.

    Para obtener información técnica sobre cómo activar una plantilla, consulte Activación y autorización de una plantilla para nosotrose en este documento

  5. Utilícelo para crear páginas de contenido.

    • Al utilizar una plantilla para crear una página nueva, no hay ninguna diferencia visible ni ninguna indicación entre las plantillas estáticas y las editables.
    • Para el autor de la página, el proceso es transparente.

    Para obtener más información sobre cómo un autor de páginas utiliza plantillas para crear una página, consulte Creación y organización de páginas.

    Para obtener información técnica sobre la creación de páginas con plantillas editables, consulte Páginas de contenido resultantes en este documento.

TIP
No introduzca nunca en una plantilla información que deba internacionalizarse. Para fines de internalización, la variable características de localización de los componentes principales se recomienda.
NOTE
Las plantillas son herramientas útiles para optimizar el flujo de trabajo de creación de páginas. Sin embargo, demasiadas plantillas pueden saturar a los autores y hacer que la creación de páginas sea confusa. Una buena regla general es mantener el número de plantillas por debajo de 100.
Adobe no recomienda tener más de 1000 plantillas debido a posibles impactos en el rendimiento.
NOTE
La biblioteca de cliente del editor asume la presencia de la variable cq.shared espacio de nombres en páginas de contenido y si no hay el error de JavaScript Uncaught TypeError: Cannot read property 'shared' of undefined será el resultado.
Todas las páginas de contenido de ejemplo contienen cq.shared, por lo que cualquier contenido basado en ellos se incluye automáticamente cq.shared. Sin embargo, si decide crear sus propias páginas de contenido desde cero sin basarlas en contenido de muestra, debe asegurarse de incluir la variable cq.shared espacio de nombres.
Consulte Uso de bibliotecas del lado del cliente para obtener más información.

Carpetas de plantilla template-folders

Para organizar las plantillas, puede utilizar las siguientes carpetas:

  • global

  • Específico del sitio

    Las carpetas específicas del sitio que crea para organizar las plantillas se crean con una cuenta que tiene privilegios de administrador.

NOTE
Aunque puede anidar sus carpetas, cuando el usuario las vea en la Plantillas se presentan como una estructura plana.

En una instancia estándar de AEM, la carpeta Global ya existe en la consola de plantillas. Contiene plantillas predeterminadas y actúa como alternativa en caso de que no se encuentre ninguna política ni ningún tipo de plantilla en la carpeta actual. Puede añadir las plantillas predeterminadas a esta carpeta o crear una nueva carpeta (recomendado).

NOTE
Se recomienda crear una nueva carpeta que contenga las plantillas personalizadas y no utilizar la carpeta global.
CAUTION
Las carpetas deben ser creadas por un usuario con admin derechos.

Los tipos de plantilla y las directivas se heredan en todas las carpetas según el siguiente orden de prioridad:

  1. La carpeta actual.
  2. Principales de la carpeta actual.
  3. /conf/global
  4. /apps
  5. /libs

Se crea una lista de todas las entradas permitidas. Si alguna configuración se superpone ( path/ label), solo se presenta al usuario la instancia más cercana a la carpeta actual.

Para crear una carpeta nueva, puede hacer lo siguiente:

  • Programado o con CRXDE Lite
  • Uso del explorador de configuración

Uso del CRXDE Lite using-crxde-lite

  1. Se puede crear una nueva carpeta (en /conf) para su instancia mediante programación o con CRXDE Lite.

    Se debe utilizar la siguiente estructura:

    code language-xml 
    /conf
    <your-folder-name> [sling:Folder]
        settings [sling:Folder]
            wcm [cq:Page]
                templates [cq:Page]
                policies [cq:Page]

  2. A continuación, puede definir las siguientes propiedades en el nodo raíz de la carpeta:

    <your-folder-name> [sling:Folder]

    Nombre: jcr:title

    • Tipo: String
    • Valor: El título (para la carpeta) que desea que aparezca en la Plantillas consola.

  3. En adición a los permisos y privilegios de creación estándar (p. ej. content-authors) ahora debe asignar grupos y definir los derechos de acceso (ACL) necesarios para que sus autores puedan crear plantillas en la nueva carpeta.

    La variable template-authors grupo es el grupo predeterminado que debe asignarse. Consulte la siguiente sección ACL y grupos para obtener más información.

    Consulte Gestión de derechos de acceso para obtener más información sobre la administración y asignación de derechos de acceso.

Uso del explorador de configuración using-the-configuration-browser

  1. Vaya a Navegación global -> Herramientas > Explorador de configuración.

    Las carpetas existentes se muestran a la izquierda, incluido el global carpeta.

  2. Haga clic en Crear.

  3. En el Crear configuración es necesario configurar los siguientes campos:

    • Título: Proporcionar un título para la carpeta de configuración
    • Plantillas editables: Haga clic para permitir plantillas editables dentro de esta carpeta

  4. Haga clic en Crear

NOTE
En el Explorador de configuración, puede editar la carpeta global y activar el Plantillas editables si desea crear plantillas dentro de esta carpeta, esta no es la práctica recomendada.
Consulte la documentación del 🔗Explorador de configuración para obtener más información.

ACL y grupos acls-and-groups

Una vez creadas las carpetas de plantillas (a través de CRXDE o con el navegador de configuración), las ACL deben definirse para los grupos adecuados para las carpetas de plantillas para garantizar la seguridad adecuada.

Las carpetas de plantillas para la variable Implementación de referencia de We.Retail se puede usar como ejemplo.

El grupo de autores de plantillas the-template-authors-group

La variable template-authors grupo es el grupo que se utiliza para administrar el acceso a las plantillas y viene estándar con AEM, pero está vacío. Los usuarios deben agregarse al grupo para el proyecto o sitio.

CAUTION
La variable template-authors grupo es only para usuarios que deben poder crear nuevas plantillas.
La edición de plantillas es muy potente y, si no se realiza correctamente, se pueden romper las plantillas existentes. Por lo tanto, esta función debe centrarse y solo incluir a usuarios cualificados.

La siguiente tabla detalla los permisos necesarios para la edición de plantillas.

Ruta
Función/Grupo
Permisos
Descripción
/conf/<your-folder>/settings/wcm/templates
Template Autores
leer, escribir, replicar
Creadores de plantillas que crean, leen, actualizan, eliminan y replican plantillas en sitios específicos /conf espacio
Usuario web anónimo
leer
El usuario web anónimo debe leer las plantillas mientras procesa una página
Autores de contenido
replicar
replicateLos autores de contenido deben activar las plantillas de una página al activar una página
/conf/<your-folder>/settings/wcm/policies
Template Author
leer, escribir, replicar
Creadores de plantillas que crean, leen, actualizan, eliminan y replican plantillas en sitios específicos /conf espacio
Usuario web anónimo
leer
El usuario web anónimo debe leer las directivas mientras procesa una página
Autores de contenido
replicar
Los autores de contenido deben activar las políticas de una plantilla de una página al activar una página
/conf/<site>/settings/template-types
Autor de plantillas
leer
El autor de plantillas crea una nueva plantilla basada en uno de los tipos de plantilla predefinidos.
Usuario web anónimo
ninguno
El usuario web anónimo no debe acceder a los tipos de plantilla

Esta opción predeterminada template-authors El grupo solo cubre la configuración del proyecto, donde todas las template-authors los miembros pueden acceder y crear todas las plantillas. Para configuraciones más complejas, donde se necesitan varios grupos de autores de plantillas para separar el acceso a las plantillas, se deben crear más grupos de autores de plantillas personalizadas. Sin embargo, los permisos para los grupos de autores de plantillas seguirían siendo los mismos.

Plantillas heredadas en /conf/global legacy-templates-under-conf-global

Las plantillas ya no deben almacenarse en /conf/global, sin embargo, para algunas instalaciones heredadas puede que todavía haya plantillas en esta ubicación. SOLO en estas situaciones heredadas debería ser /conf/global las rutas de acceso se deben configurar explícitamente.

Ruta
Función/Grupo
Permisos
Descripción
/conf/global/settings/wcm/templates
Template Autores
leer, escribir, replicar
Creadores de plantillas que crean, leen, actualizan, eliminan y replican plantillas en /conf/global
Usuario web anónimo
leer
El usuario web anónimo debe leer las plantillas mientras procesa una página
Autores de contenido
replicar
Los autores de contenido deben activar las plantillas de una página al activar una página
/conf/global/settings/wcm/policies
Template Author
leer, escribir, replicar
Creadores de plantillas que crean, leen, actualizan, eliminan y replican plantillas en /conf/global
Usuario web anónimo
leer
El usuario web anónimo debe leer las directivas mientras procesa una página
Autores de contenido
replicar
Los autores de contenido deben activar las políticas de una plantilla de una página al activar una página
/conf/global/settings/wcm/template-types
Autor de plantillas
leer
El autor de plantillas crea una nueva plantilla basada en uno de los tipos de plantilla predefinidos
Usuario web anónimo
ninguno
El usuario web anónimo no debe acceder a los tipos de plantilla

Tipo de plantilla template-type

Al crear una plantilla nueva, debe especificar un tipo de plantilla:

  • Los tipos de plantilla proporcionan plantillas para una plantilla. Al crear una plantilla nueva, la estructura y el contenido inicial del tipo de plantilla seleccionado se utilizan para crear la plantilla nueva.

    • El tipo de plantilla se copia para crear la plantilla.
    • Una vez que se ha producido la copia, la única conexión entre la plantilla y el tipo de plantilla es una referencia estática con fines informativos.

  • Los tipos de plantilla le permiten definir:

    • Tipo de recurso del componente de página.
    • La directiva del nodo raíz, que define los componentes permitidos en el editor de plantillas.
    • Se recomienda definir los puntos de interrupción para la cuadrícula adaptable y la configuración del emulador móvil en el tipo de plantilla. Esto es opcional, ya que la configuración también se puede definir en la plantilla individual (consulte Tipo de plantilla y grupos de dispositivos móviles).

  • AEM ofrece una pequeña selección de tipos de plantillas listos para usar, como Página HTML5 y Página de formulario adaptable.

    • Se proporcionan ejemplos adicionales como parte del We.Retail contenido de muestra.

  • Los desarrolladores suelen definir los tipos de plantilla.

Los tipos de plantilla predeterminados se almacenan en:

  • /libs/settings/wcm/template-types
CAUTION
No debe cambiar nada en la variable /libs ruta. Esto se debe a que el contenido de /libs se sobrescribe la próxima vez que actualice la instancia (y se puede sobrescribir al aplicar una corrección o un paquete de funciones).

Los tipos de plantilla específicos del sitio se deben almacenar en una ubicación comparable de:

  • /apps/settings/wcm/template-types

Las definiciones de los tipos de plantillas personalizadas deben almacenarse en carpetas definidas por el usuario (recomendadas) o, alternativamente, en global. Por ejemplo:

  • /conf/<my-folder-01>/<my-folder-02>/settings/wcm/template-types
  • /conf/<my-folder>/settings/wcm/template-types
  • /conf/global/settings/wcm/template-types
CAUTION
Los tipos de plantilla deben respetar la estructura de carpetas correcta (es decir, /settings/wcm/...); de lo contrario, no se encontrarán los tipos de plantilla.

Tipo de plantilla y grupos de dispositivos móviles template-type-and-mobile-device-groups

La variable grupos de dispositivos se utiliza para una plantilla editable (se establece como ruta relativa de la propiedad) cq:deviceGroups) defina qué dispositivos móviles están disponibles como emuladores en la variable modo de diseño de creación de páginas. Este valor se puede configurar en dos lugares:

  • En el tipo de plantilla editable
  • En la plantilla editable

Al crear una nueva plantilla editable, el valor se copia del tipo de plantilla a la plantilla individual. Si el valor no se define en el tipo , se puede configurar en la plantilla . Una vez creada una plantilla, no hay herencia del tipo a la plantilla.

CAUTION
El valor de cq:deviceGroups debe configurarse como una ruta relativa como mobile/groups/responsive y no como una ruta absoluta como /etc/mobile/groups/responsive.
NOTE
con plantillas estáticas, el valor de cq:deviceGroups se puede establecer en la raíz del sitio.
Con las plantillas editables, este valor ahora se almacena en el nivel de plantilla y no se admite en el nivel de raíz de la página.

Creación de tipos de plantilla creating-template-types

Si ha creado una plantilla que puede servir de base para otras plantillas, puede copiar esta plantilla como un tipo de plantilla.

  1. Cree una plantilla como lo haría con cualquier plantilla editable tal como se documenta aquí, que servirá de base para su tipo de plantilla.
  2. Con el CRXDE Lite , copie la plantilla recién creada del templates al nodo template-types en el nodo carpeta de plantillas.
  3. Elimine la plantilla de la sección templates en el nodo carpeta de plantillas.
  4. En la copia de la plantilla que se encuentra en el template-types nodo, eliminar todo cq:template y cq:templateType jcr:content propiedades.

También puede desarrollar su propio tipo de plantilla utilizando una plantilla editable de ejemplo como base, disponible en GitHub.

CÓDIGO DE GITHUB

Puede encontrar el código de esta página en GitHub

Definiciones de plantillas template-definitions

Se almacenan las definiciones de las plantillas editables carpetas definidas por el usuario (recomendado) o alternativamente en global. Por ejemplo:

  • /conf/<my-folder>/settings/wcm/templates
  • /conf/<my-folder-01>/<my-folder-02>/settings/wcm/templates
  • /conf/global/settings/wcm/templates

El nodo raíz de la plantilla es del tipo cq:Template con una estructura esquelética de:

<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

Los elementos principales son:

jcr:content jcr-content

Este nodo contiene propiedades para la plantilla:

  • Nombre: jcr:title

  • Nombre: status

    • Tipo: String
    • Valor: draft, enabled o disabled

Estructura structure

Define la estructura de la página resultante:

  • Se combina con el contenido inicial ( /initial) al crear una página nueva.

  • Los cambios realizados en la estructura se reflejarán en cualquier página creada con la plantilla.

  • La variable root ( structure/jcr:content/root) define la lista de componentes que estarán disponibles en la página resultante.

    • Los componentes definidos en la estructura de la plantilla no se pueden mover ni eliminar de ninguna página resultante.
    • Una vez desbloqueado el componente, se desbloquea la variable editable la propiedad se establece en true.
    • Una vez desbloqueado un componente que ya contiene contenido, este contenido se moverá al initial rama.

  • La variable cq:responsive contiene definiciones para el diseño interactivo.

Contenido inicial initial-content

Define el contenido inicial que tendrá una página nueva al crearla:

  • Contiene un jcr:content que se copia en cualquier página nueva.
  • Se combina con la estructura ( /structure) al crear una página nueva.
  • Las páginas existentes no se actualizarán si el contenido inicial se cambia después de la creación.
  • La variable root contiene una lista de componentes para definir qué estará disponible en la página resultante.
  • Si el contenido se añade a un componente en modo de estructura y ese componente se desbloquea posteriormente (o viceversa), este contenido se utiliza como contenido inicial.

Diseño layout

When editar una plantilla, puede definir el diseño, utiliza diseño adaptable estándar que también puede configurado.

Políticas de contenido content-policies

Las políticas de contenido (o diseño) definen las propiedades de diseño de un componente. Por ejemplo, los componentes disponibles o las dimensiones mínimas/máximas. Esto se aplica a la plantilla (y a las páginas creadas con la plantilla). Las políticas de contenido se pueden crear y seleccionar en el editor de plantillas.

  • La propiedad cq:policy, en el root node

    /conf/<your-folder>/settings/wcm/templates/<your-template>/policies/jcr:content/root

    Proporciona una referencia relativa a la política de contenido para el sistema de párrafos de la página.

  • La propiedad cq:policy, en los nodos explícitos del componente debajo de root, proporcione vínculos a las políticas de los componentes individuales.

  • Las definiciones de directiva reales se almacenan en:

    /conf/<your-folder>/settings/wcm/policies/wcm/foundation/components

NOTE
Las rutas de las definiciones de políticas dependen de la ruta del componente. cq:policy contiene una referencia relativa a la configuración misma.
NOTE
Las páginas creadas a partir de plantillas editables no ofrecen un modo de diseño en el editor de páginas.
La variable policies el árbol de una plantilla editable tiene la misma jerarquía que la configuración del modo de diseño de una plantilla estática en:
/etc/designs/<my-site>/jcr:content/<component-name>
La configuración del modo de diseño de una plantilla estática se definió por componente de página.

Políticas de la página page-policies

Las políticas de página permiten definir la variable política de contenido para la página (parsys principal), en la plantilla o en las páginas resultantes.

Activación y autorización de una plantilla para su uso enabling-and-allowing-a-template-for-use

  1. Habilitar la plantilla

    Para poder utilizar una plantilla, debe habilitarla:

    • Activación de la plantilla de la variable Plantillas consola.

    • Configuración de la propiedad de estado en la variable jcr:content nodo .

      • Por ejemplo, en:

        /conf/<your-folder>/settings/wcm/templates/<your-template>/jcr:content

      • Defina la propiedad:

        • Nombre: status
        • Tipo: cadena
        • Valor: enabled

  2. Plantillas permitidas

    /conf/<your-folder>/settings/wcm/templates/.*;

Páginas de contenido resultantes resultant-content-pages

Páginas creadas a partir de plantillas editables:

  • Se crean con un subárbol que se combina a partir de structure y initial en la plantilla

  • Tienen referencias a información contenida en la plantilla y el tipo de plantilla. Esto se logra con un jcr:content con las propiedades:

    • cq:template

      Proporciona la referencia dinámica a la plantilla real; permite que los cambios realizados en la plantilla se reflejen en las páginas reales.

    • cq:templateType

      Proporciona una referencia al tipo de plantilla.

chlimage_1-250

El diagrama anterior muestra cómo las plantillas, el contenido y los componentes se interrelacionan:

  • Controlador - /content/<my-site>/<my-page>

    La página resultante que hace referencia a la plantilla. El contenido controla todo el proceso. Según las definiciones, accede a la plantilla y los componentes adecuados.

  • Configuración - /conf/<my-folder>/settings/wcm/templates/<my-template>

    La variable plantilla y políticas de contenido relacionadas defina la configuración de página.

  • Modelo: paquetes OSGi

    La variable Paquetes OSGI implemente la funcionalidad .

  • Ver - /apps/<my-site>/components

    Tanto en los entornos de autor como de publicación, el contenido se representa mediante componentes.

Al procesar una página:

  • Plantillas:

    • La variable cq:template propiedad de su jcr:content se hará referencia al nodo para acceder a la plantilla que corresponde a esa página.

  • Componentes:

    • El componente de página combinará el structure/jcr:content árbol de la plantilla con la variable jcr:content de la página.

    • El componente de página solo permite al autor editar los nodos de la estructura de la plantilla que se han marcado como editables (así como los secundarios).

    • Al procesar un componente en una página, la ruta relativa de ese componente se toma de la jcr:content nodo; la misma ruta debajo de policies/jcr:content de la plantilla se buscará.

      • La variable cq:policy La propiedad de este nodo apunta a la política de contenido real (es decir, contiene la configuración de diseño para ese componente).
      • Esto le permite tener varias plantillas que reutilizan las mismas configuraciones de directiva de contenido.
recommendation-more-help
2315f3f5-cb4a-4530-9999-30c8319c520e