Show Menu
TÓPICOS×

Modelos de página - Editável

Modelos editáveis foram introduzidos em:
  • Permitir que autores especializados criem e editem modelos .
    • Esses autores especializados são chamados de autores modelo
    • Os autores do modelo devem ser membros do template-authors grupo.
  • Forneça modelos que mantenham uma conexão dinâmica com quaisquer páginas criadas a partir delas. Isso garante que quaisquer alterações no modelo sejam refletidas nas próprias páginas.
  • Torne o componente de página mais genérico para que o componente de página principal possa ser usado sem personalização.
Com modelos editáveis, as partes que fazem uma página são isoladas dentro dos componentes. Você pode configurar as combinações necessárias de componentes em uma interface do usuário, eliminando a necessidade de um novo componente de página ser desenvolvido para cada variação de página.
AEM 6.4.5.0 ou posterior é necessário para usar modelos editáveis com o Editor Visão geral do editor SPA SPA.
Modelos estáticos também estão disponíveis.
Este documento:
  • Fornece uma visão geral da criação de modelos editáveis
  • Descreve as tarefas de administrador/desenvolvedor necessárias para criar modelos editáveis
  • Descreve os fundamentos técnicos dos modelos editáveis
Este documento supõe que você já esteja familiarizado com a criação e edição de modelos. Consulte o documento de criação Criando modelos de página, que detalha os recursos de modelos editáveis como expostos ao autor do modelo.
O tutorial a seguir também pode ser de interesse para configurar um modelo de página editável em um novo projeto: Introdução ao AEM Sites Parte 2 - Criar uma página básica e um modelo

Creating a New Template

A criação de modelos editáveis é feita principalmente com o console de modelo e o editor de modelo por um autor de modelo. Esta seção apresenta uma visão geral deste processo e apresenta uma descrição do que ocorre a nível técnico.
Para obter informações sobre como usar modelos editáveis em um projeto do AEM, consulte Criar um projeto do AEM usando Lazybones .
Ao criar um novo modelo editável:
  1. Crie uma pasta para os modelos . Isso não é obrigatório, mas é uma prática recomendada.
  2. Selecione um tipo de modelo. Isso é copiado para criar a definição do modelo.
    Uma seleção de tipos de modelo é fornecida prontamente. Você também pode criar seus próprios tipos de modelo específicos do site, se necessário.
  3. Configure a estrutura, as políticas de conteúdo, o conteúdo inicial e o layout do novo modelo.
    Estrutura
    • A estrutura permite que você defina componentes e conteúdo para seu modelo.
    • Os componentes definidos na estrutura do modelo não podem ser movidos em uma página resultante ou excluídos de qualquer página resultante.
      • Se você estiver criando um modelo em uma pasta personalizada fora do conteúdo de amostra We.Retail, poderá escolher Componentes básicos ou usar Componentes developing.htmlprincipais.
    • Se desejar que os autores da página possam adicionar e remover componentes, adicione um sistema de parágrafo ao modelo.
    • Os componentes podem ser desbloqueados e bloqueados novamente para permitir que você defina o conteúdo inicial.
    Para obter detalhes sobre como um autor de modelo define a estrutura, consulte Criação de modelos de página.
    Para obter detalhes técnicos da estrutura, consulte Estrutura neste documento.
    Políticas
    • As políticas de conteúdo definem as propriedades de design de um componente.
      • Por exemplo, os componentes disponíveis ou as dimensões mínimas/máximas.
    • Eles são aplicáveis ao modelo (e às páginas criadas com o modelo).
    Para obter detalhes sobre como um autor de modelo define políticas, consulte Criação de modelos de página.
    Para obter detalhes técnicos das políticas, consulte Políticas de conteúdo neste documento.
    Conteúdo inicial
    • O Conteúdo inicial define o conteúdo que será exibido quando uma página for criada pela primeira vez com base no modelo.
    • O conteúdo inicial pode ser editado pelos autores da página.
    Para obter detalhes sobre como um autor de modelo define a estrutura, consulte Criação de modelos de página.
    Para obter detalhes técnicos sobre o conteúdo inicial, consulte Conteúdo Conteúdo inicial inicial neste documento.
    Layout
    • É possível definir o layout do modelo para um intervalo de dispositivos.
    • O Layout responsivo para modelos funciona como na criação de página.
    Para obter detalhes sobre como um autor de modelo define o layout do modelo, consulte Criação de modelos de página.
    Para obter detalhes técnicos sobre o layout do modelo, consulte Layout neste documento.
  4. Habilite o modelo e, em seguida, permita-o para árvores de conteúdo específicas.
    • Um modelo pode ser ativado ou desativado para torná-lo disponível ou indisponível para autores de página.
    • Um modelo pode ser disponibilizado ou indisponibilizado para determinadas ramificações de página.
    Para obter detalhes sobre como um autor de modelo ativa um modelo, consulte Criação de modelos de página.
    Para obter detalhes técnicos sobre como habilitar um modelo, consulte Habilitar e permitir um modelo para uso neste documento
  5. Use-o para criar páginas de conteúdo.
    • Ao usar um modelo para criar uma nova página, não há diferenças visíveis e nenhuma indicação entre os modelos estáticos e editáveis.
    • Para o autor da página, o processo é transparente.
    Para obter detalhes sobre como um autor de página usa modelos para criar uma página, consulte Criação e organização de páginas .
    Para obter detalhes técnicos sobre como criar páginas com modelos editáveis, consulte Páginas de conteúdo resultante neste documento.
A biblioteca do cliente do editor assume a presença da cq.shared namespace nas páginas de conteúdo e, se ela não estiver presente, o erro do JavaScript Uncaught TypeError: Cannot read property 'shared' of undefined resultará.
Todas as páginas de conteúdo de amostra contêm cq.shared , portanto, qualquer conteúdo baseado nelas inclui automaticamente cq.shared . No entanto, se você decidir criar suas próprias páginas de conteúdo do zero sem baseá-las no conteúdo de amostra, deverá incluir a cq.shared namespace.
Consulte Uso de bibliotecas do lado do cliente para obter mais informações.
Nunca insira qualquer informação que precise ser internacionalizada em um modelo.

Pastas de modelo

Para organizar seus modelos, você pode usar as seguintes pastas:
  • global
  • Específico do site
    As pastas específicas do site que você cria para organizar seus modelos são criadas com uma conta com privilégios de administrador.
Mesmo que você possa aninhar suas pastas, quando o usuário as visualização no console Modelos , elas são apresentadas como uma estrutura simples.
Em uma instância padrão do AEM, a pasta global  já existe no console modelo. Isso mantém modelos padrão e atua como um fallback se nenhuma política e/ou tipo de modelo for localizado na pasta atual. Você pode adicionar seus modelos padrão a esta pasta ou criar uma nova pasta (recomendado).
É prática recomendada criar uma nova pasta para manter seus modelos personalizados e não usar a pasta global.
As pastas devem ser criadas por um usuário com admin direitos.
Os tipos de modelo e as políticas são herdados em todas as pastas de acordo com a seguinte ordem de precedência:
  1. A pasta atual.
  2. Pai(s) da pasta atual.
  3. /conf/global
  4. /apps
  5. /libs
Uma lista de todas as entradas permitidas é criada. Se qualquer configuração se sobrepuser ( path / label ), somente a instância mais próxima à pasta atual será apresentada ao usuário.
Para criar uma nova pasta, você pode:
  • Programaticamente ou com o CRXDE Lite
  • Usando o navegador de configuração

Uso do CRXDE Lite

  1. Uma nova pasta (em /conf) pode ser criada para sua instância de forma programática ou com o CRXDE Lite.
    Deve ser utilizada a seguinte estrutura:
    /conf
        <your-folder-name> [sling:Folder]
            settings [sling:Folder]
                wcm [cq:Page]
                    templates [cq:Page]
                    policies [cq:Page]
    
    
  2. Em seguida, é possível definir as seguintes propriedades no nó raiz da pasta:
    <your-folder-name> [sling:Folder]
    Nome: jcr:title
    • Tipo: String
    • Valor: O título (para a pasta) que você deseja exibir no console Modelos .
  3. Além ** das permissões e privilégios de criação padrão (por exemplo, content-authors ), agora é necessário atribuir grupos e definir os direitos de acesso (ACLs) necessários para que seus autores possam criar modelos na nova pasta.
    O template-authors grupo é o grupo padrão que precisa ser atribuído. Consulte a seção ACLs e grupos a seguir para obter detalhes.
    Consulte Gerenciamento de direitos de acesso para obter detalhes completos sobre como gerenciar e atribuir direitos de acesso.

Usando o navegador de configuração

  1. Vá para Navegação ​global -> Ferramentas > Navegador de configuração.
    As pastas existentes são listadas à esquerda, incluindo a pasta ​global.
  2. Clique em Criar .
  3. Na caixa de diálogo Criar configuração , os seguintes campos precisam ser configurados:
    • Título : Fornecer um título para a pasta de configuração
    • Modelos editáveis: Clique para permitir modelos editáveis nesta pasta
  4. Clique em Criar
No Navegador de configuração, você pode editar a pasta global e ativar a opção Modelos ​editáveis se desejar criar modelos dentro dessa pasta, no entanto, essa não é a prática recomendada.

ACLs e grupos

Depois que as pastas de modelo são criadas (via CRXDE ou com o Navegador de configuração), as ACLs devem ser definidas para os grupos apropriados para as pastas de modelo para garantir a segurança adequada.
As pastas de modelo para a implementação de referência We.Retail podem ser usadas como exemplo.

O Grupo de autores-modelo

O template-authors grupo é o grupo usado para gerenciar o acesso aos modelos e vem como padrão com o AEM, mas está vazio. Os usuários devem ser adicionados ao grupo para o projeto/site.
O template-authors grupo é apenas para usuários que precisam criar novos modelos.
A edição de modelos é muito poderosa e, se não for feita corretamente, os modelos existentes podem ser quebrados. Portanto, essa função deve ser focada e incluir apenas usuários qualificados.
A tabela a seguir detalha as permissões necessárias para a edição de modelos.
Caminho Função / Grupo Permissões Descrição
/conf/< your-folder >/settings/wcm/templates Autores do modelo ler, escrever, replicar Criadores de modelos que criam, leem, atualizam, excluem e replicam modelos em um /conf espaço específico do site
Usuário da Web anônimo leitura Usuário da Web anônimo deve ler modelos ao renderizar uma página
Autores de conteúdo replicar replicateOs autores de conteúdo precisam ativar os modelos de uma página ao ativar uma página
/conf/< your-folder >/settings/wcm/policies Template Author ler, escrever, replicar Criadores de modelos que criam, leem, atualizam, excluem e replicam modelos em um /conf espaço específico do site
Usuário da Web anônimo leitura Usuário da Web anônimo deve ler as políticas ao renderizar uma página
Autores de conteúdo replicar Os autores de conteúdo precisam ativar as políticas de um modelo de página ao ativar uma página
/conf/<site>/settings/template-types Autor do modelo leitura O autor do modelo cria um novo modelo com base em um dos tipos de modelo predefinidos.
Usuário da Web anônimo nenhum O Usuário Anônimo da Web não deve acessar os tipos de modelo
Este template-authors grupo padrão cobre apenas as configurações do projeto, onde todos os template-authors membros têm permissão para acessar e criar todos os modelos. Para configurações mais complexas, onde vários grupos de autores de modelo são necessários para separar o acesso a modelos, mais grupos de autores de modelo personalizados devem ser criados. No entanto, as permissões para os grupos de autores de modelo ainda seriam as mesmas.

Modelos herdados em /conf/global

Os modelos não devem mais ser armazenados em /conf/global , no entanto, para algumas instalações herdadas ainda pode haver modelos neste local. SOMENTE nessas situações herdadas os seguintes /conf/global caminhos devem ser configurados explicitamente.
Caminho Função / Grupo Permissões Descrição
/conf/global/settings/wcm/templates Autores do modelo ler, escrever, replicar Criadores de modelos que criam, leem, atualizam, excluem e replicam modelos em /conf/global
Usuário da Web anônimo leitura Usuário da Web anônimo deve ler modelos ao renderizar uma página
Autores de conteúdo replicar Os autores de conteúdo precisam ativar os modelos de uma página ao ativar uma página
/conf/global/settings/wcm/policies Template Author ler, escrever, replicar Criadores de modelos que criam, leem, atualizam, excluem e replicam modelos em /conf/global
Usuário da Web anônimo leitura Usuário da Web anônimo deve ler as políticas ao renderizar uma página
Autores de conteúdo replicar Os autores de conteúdo precisam ativar as políticas de um modelo de página ao ativar uma página
/conf/global/settings/wcm/template-types Autor do modelo leitura O autor do modelo cria um novo modelo com base em um dos tipos de modelo predefinidos
Usuário da Web anônimo nenhum O Usuário Anônimo da Web não deve acessar os tipos de modelo

Template Type

Ao criar um novo modelo, é necessário especificar um tipo de modelo:
  • Os tipos de modelo fornecem modelos para um modelo. Ao criar um novo modelo, a estrutura e o conteúdo inicial do tipo de modelo selecionado são usados para criar o novo modelo.
    • O tipo de modelo é copiado para criar o modelo.
    • Após a cópia, a única conexão entre o modelo e o tipo de modelo é uma referência estática para fins de informação.
  • Os tipos de modelo permitem que você defina:
    • O tipo de recurso do componente de página.
    • A política do nó raiz, que define os componentes permitidos no editor de modelo.
    • É recomendável definir os pontos de interrupção para a grade responsiva e a configuração do emulador móvel no tipo de modelo. Isso é opcional, pois a configuração também pode ser definida no modelo individual (consulte Tipo de modelo e Grupos de dispositivos móveis).
  • O AEM fornece uma pequena seleção de tipos de modelo prontos para uso, como Página HTML5 e Página de formulário adaptável.
    • Exemplos adicionais são fornecidos como parte do conteúdo de amostra We.Retail .
  • Os tipos de modelo são tipicamente definidos pelos desenvolvedores.
Os tipos de modelo predefinidos são armazenados em:
  • /libs/settings/wcm/template-types
Você não deve alterar nada no /libs caminho. Isso ocorre porque o conteúdo do é substituído na próxima vez que você atualizar sua instância (e pode ser substituído quando você aplicar uma correção ou um pacote de recursos). /libs
Os tipos de modelo específicos do site devem ser armazenados no local comparável de:
  • /apps/settings/wcm/template-types
As definições para seus tipos de modelos personalizados devem ser armazenadas em pastas definidas pelo usuário (recomendado) ou, alternativamente, em global . Por exemplo:
  • /conf/<my-folder-01>/<my-folder-02>/settings/wcm/template-types
  • /conf/<my-folder>/settings/wcm/template-types
  • /conf/global/settings/wcm/template-types
Os tipos de modelo devem respeitar a estrutura correta de pastas (ou seja, /settings/wcm/... ), caso contrário, os tipos de modelo não serão encontrados.

Tipo de modelo e grupos de dispositivos móveis

Os grupos de dispositivos usados para um modelo editável (definido como caminho relativo da propriedade cq:deviceGroups ) definem quais dispositivos móveis estão disponíveis como emuladores no modo de layout da criação de página. Esse valor pode ser definido em dois locais:
  • No tipo de modelo editável
  • No modelo editável
Ao criar um novo modelo editável, o valor é copiado do tipo de modelo para o modelo individual. Se o valor não for definido no tipo, ele poderá ser definido no modelo. Depois que um modelo é criado, não há herança do tipo para o modelo.
O valor de cq:deviceGroups deve ser definido como um caminho relativo, como mobile/groups/responsive e não como um caminho absoluto, como /etc/mobile/groups/responsive .
Com modelos Modelos de página - Estáticos estáticos, o valor de cq:deviceGroups poderia ser definido na raiz do site.
Com modelos editáveis, esse valor agora é armazenado no nível do modelo e não é suportado no nível raiz da página.

Criando Tipos de Modelo

Se você tiver criado um modelo que possa servir como a base de outros modelos, poderá copiar esse modelo como um tipo de modelo.
  1. Crie um modelo como faria com qualquer modelo editável como documentado aqui , que servirá de base para o seu tipo de modelo.
  2. Usando o CRXDE Lite, copie o modelo recém-criado do templates nó para o template-types nó na pasta Pastas de modelo de modelo.
  3. Exclua o modelo do templates nó na pasta Pastas de modelo de modelo.
  4. Na cópia do modelo que está sob o template-types nó, exclua todas as cq:template propriedades e cq:templateType``jcr:content .
Você também pode desenvolver seu próprio tipo de modelo usando um modelo editável de exemplo como base, disponível no GitHub.
CÓDIGO NO GITHUB
Você pode encontrar o código desta página no GitHub

Definições de modelo

As definições para modelos editáveis são pastas armazenadas definidas pelo usuário (recomendado) ou, alternativamente, em global . Por exemplo:
  • /conf/<my-folder>/settings/wcm/templates
  • /conf/<my-folder-01>/<my-folder-02>/settings/wcm/templates
  • /conf/global/settings/wcm/templates
O nó raiz do modelo é do tipo cq:Template com uma estrutura de esqueleto 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

Os principais elementos são:

jcr:content

Este nó contém propriedades para o modelo:
  • Nome : jcr:title
  • Nome : status
    • Tipo : String
    • Valor : draft , enabled ou disabled

Estrutura

Define a estrutura da página resultante:
  • É unido ao conteúdo inicial ( /initial ) ao criar uma nova página.
  • As alterações feitas na estrutura serão refletidas em qualquer página criada com o modelo.
  • O nó root ( structure/jcr:content/root ) define a lista dos componentes que estarão disponíveis na página resultante.
    • Os componentes definidos na estrutura do modelo não podem ser movidos para nenhuma página resultante ou excluídos dela.
    • Quando um componente é desbloqueado, a editable propriedade é definida como true .
    • Quando um componente que já contém conteúdo for desbloqueado, esse conteúdo será movido para a initial ramificação.
  • O cq:responsive nó contém definições para o layout responsivo.

Conteúdo inicial

Define o conteúdo inicial que uma nova página terá na criação:
  • Contém um jcr:content nó que é copiado para qualquer página nova.
  • É unida à estrutura ( /structure ) ao criar uma nova página.
  • Nenhuma página existente será atualizada se o conteúdo inicial for alterado após a criação.
  • O root nó contém uma lista de componentes para definir o que estará disponível na página resultante.
  • Se o conteúdo for adicionado a um componente no modo de estrutura e esse componente for desbloqueado posteriormente (ou vice-versa), esse conteúdo será usado como conteúdo inicial.

Layout

Ao editar um modelo, você pode definir o layout , isso usa o layout responsivo padrão que também pode ser configurado .

Content Policies

As políticas do conteúdo (ou design) definem as propriedades do design de um componente. Por exemplo, os componentes disponíveis ou as dimensões mínimas/máximas. Eles são aplicáveis ao modelo (e às páginas criadas com o modelo). As políticas de conteúdo podem ser criadas e selecionadas no editor de modelos.
  • A propriedade cq:policy , no root
    /conf/<your-folder>/settings/wcm/templates/<your-template>/policies/jcr:content/root
    Fornece uma referência relativa à política de conteúdo para o sistema de parágrafo da página.
  • A propriedade cq:policy , nos nós explícitos do componente em root , fornece links para as políticas dos componentes individuais.
  • As definições de política reais são armazenadas em:
    /conf/<your-folder>/settings/wcm/policies/wcm/foundation/components
Os caminhos das definições de política dependem do caminho do componente. cq:policy contém uma referência relativa à configuração propriamente dita.
As páginas criadas a partir de modelos editáveis não ofertas um modo de Design no editor de páginas.
A policies árvore de um modelo editável tem a mesma hierarquia que a configuração do modo de design de um modelo estático em:
/etc/designs/<my-site>/jcr:content/<component-name>
A configuração do modo de design de um modelo estático foi definida por componente de página.

Políticas da página

As políticas de página permitem que você defina a política de conteúdo para a página (parsys principal), no modelo ou nas páginas resultantes.

Habilitar e permitir um modelo para uso

  1. Ativar o modelo
    Antes que um modelo possa ser usado, ele deve ser habilitado por:
    • Habilitando o modelo do console Modelos .
    • Definindo a propriedade status no jcr:content nó.
      • Por exemplo, em:
        /conf/<your-folder>/settings/wcm/templates/<your-template>/jcr:content
      • Defina a propriedade:
        • Nome: status
        • Tipo: String
        • Valor: enabled
  2. Modelos permitidos
    /conf/<your-folder>/settings/wcm/templates/.*;

Páginas de conteúdo resultantes

Páginas criadas a partir de modelos editáveis:
  • São criados com uma subárvore unida de structure e initial no modelo
  • Ter referências às informações contidas no modelo e no tipo de modelo. Isso é obtido com um jcr:content nó com as propriedades:
    • cq:template
      Fornece a referência dinâmica ao modelo real; permite que as alterações no modelo sejam refletidas nas páginas reais.
    • cq:templateType
      Fornece uma referência ao tipo de modelo.
O diagrama acima mostra como os modelos, o conteúdo e os componentes se interrelacionam:
  • Controladora - /content/<my-site>/<my-page>
    A página resultante que faz referência ao modelo. O conteúdo controla todo o processo. De acordo com as definições, acessa o modelo e os componentes apropriados.
  • Configuração - /conf/<my-folder>/settings/wcm/templates/<my-template>
    O modelo e as políticas de conteúdo relacionadas definem a configuração da página.
  • Modelo - pacotes OSGi
    Os pacotes OSGI implementam a funcionalidade.
  • Exibir - /apps/<my-site>/components
    Nos ambientes autor e publicação, o conteúdo é renderizado pelos componentes .
Ao renderizar uma página:
  • Modelos :
    • A cq:template propriedade de seu jcr:content nó será referenciada para acessar o modelo que corresponde a essa página.
  • Componentes :
    • O componente de página mesclará a structure/jcr:content árvore do modelo com a jcr:content árvore da página.
    • O componente de página permitirá que o autor edite apenas os nós da estrutura do modelo que foram sinalizados como editáveis (bem como quaisquer filhos).
    • Ao renderizar um componente em uma página, o caminho relativo desse componente será retirado do jcr:content nó; o mesmo caminho sob o policies/jcr:content nó do modelo será então pesquisado.
      • A cq:policy propriedade desse nó aponta para a política de conteúdo real (isto é, ela contém a configuração de design desse componente).
      • Isso permite que você tenha vários modelos que reusam as mesmas configurações de política de conteúdo.