Modelos editáveis foram introduzidos em:
Permita que autores especializados criem e editem modelos.
template-authors
.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 SPA Editor.
Estão também disponíveis modelos estáticos.
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 Criação de 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 - Criação de uma página básica e um modelo
A criação de modelos editáveis é feita principalmente com o console 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 AEM, consulte Criar um projeto AEM usando Lazybones.
Ao criar um novo modelo editável:
Crie uma pasta para os modelos. Isso não é obrigatório, mas é uma prática recomendada.
Selecione um tipo de modelo a1/>. Isso é copiado para criar a definição do modelo a1/>.
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.
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 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.
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 Criando Modelos de Página.
Para obter detalhes técnicos das políticas, consulte Políticas de conteúdo neste documento.
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 sobre o conteúdo inicial, consulte Conteúdo inicial neste documento.
Layout
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.
Habilite o modelo e, em seguida, permita-o para árvores de conteúdo específicas.
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 ativar um modelo, consulte Ativar e Permitir um Modelo para Use neste documento
Use-o para criar páginas de conteúdo.
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.
Nunca insira qualquer informação que precise ser internacionalizada em um modelo. Para fins de internalização, os recursos de localização dos Componentes Principais são recomendados.
Os modelos são ferramentas poderosas para simplificar o fluxo de trabalho de criação de página. No entanto, muitos modelos podem sobrecarregar os autores e tornar a criação da página confusa. Uma boa regra é manter o número de modelos abaixo de 100.
O Adobe não recomenda ter mais de 1000 modelos devido a possíveis impactos no desempenho.
A biblioteca do cliente do editor assume a presença da namespace cq.shared
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 namespace cq.shared
.
Consulte Usando bibliotecas do lado do cliente para obter mais informações.
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 que possui 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 direitos admin
.
Os tipos de modelo e as políticas são herdados em todas as pastas de acordo com a seguinte ordem de precedência:
/conf/global
/apps
/libs
Uma lista de todas as entradas permitidas é criada. Se qualquer configuração se sobrepuser ( path
/ label
), somente a instância mais próxima da pasta atual será apresentada ao usuário.
Para criar uma nova pasta, você pode:
Uma nova pasta (em /conf) pode ser criada para sua instância de forma programática ou com 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]
Em seguida, é possível definir as seguintes propriedades no nó raiz da pasta:
<your-folder-name> [sling:Folder]
Nome: jcr:title
String
Em adicione às 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 grupo template-authors
é o grupo padrão que precisa ser atribuído. Consulte a seção a seguir ACLs e grupos para obter detalhes.
Consulte Gerenciamento de direitos de acesso para obter detalhes completos sobre como gerenciar e atribuir direitos de acesso.
Vá para Navegação Global -> Ferramentas > Navegador de Configuração.
As pastas existentes são listadas à esquerda, incluindo a pasta global.
Clique em Criar.
Na caixa de diálogo Criar configuração, os seguintes campos precisam ser configurados:
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.
Consulte a documentação do Navegador de configuração para obter mais informações.
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 template-authors
é o grupo usado para gerenciar o acesso aos modelos e vem como padrão com AEM, mas está vazio. Os usuários devem ser adicionados ao grupo para o projeto/site.
O grupo template-authors
é only para usuários que devem ser capazes de 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 espaço /conf 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 espaço /conf 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 grupo padrão template-authors
abrange apenas as configurações do projeto, onde todos os membros template-authors
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.
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 caminhos /conf/global
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 |
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.
Os tipos de modelo permitem que você defina:
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.
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 caminho /libs
. Isso ocorre porque o conteúdo de /libs
é 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).
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.
Os grupos de dispositivos usados para um modelo editável (definidos 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:
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 estáticos, o valor de cq:deviceGroups
pode 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.
Se você tiver criado um modelo que possa servir como a base de outros modelos, poderá copiar esse modelo como um tipo de modelo.
templates
para o nó template-types
na pasta de modelo 🔗.templates
na pasta de modelo 🔗.template-types
, exclua todas as propriedades cq:template
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
As definições para modelos editáveis são armazenadas pastas 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:
Este nó contém propriedades para o modelo:
Nome: jcr:title
Nome: status
String
draft
, enabled
ou disabled
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 de componentes que estarão disponíveis na página resultante.
editable
é definida como true
.initial
.O nó cq:responsive
contém definições para o layout responsivo.
Define o conteúdo inicial que uma nova página terá na criação:
jcr:content
que é copiado para qualquer nova página./structure
) ao criar uma nova página.root
contém uma lista de componentes para definir o que estará disponível na página resultante.Quando editar um modelo você pode definir o layout, isso usa layout responsivo padrão que também pode ser configurado.
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 nó 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 de componentes 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 em um modo de Design no editor de páginas.
A árvore policies
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.
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.
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 nó jcr:content
.
Por exemplo, em:
/conf/<your-folder>/settings/wcm/templates/<your-template>/jcr:content
Defina a propriedade:
enabled
Modelos permitidos
Defina os caminhos de modelo permitidos nas Propriedades da página da página ou da página raiz apropriada de uma subramificação.
Defina a propriedade:
cq:allowedTemplates
No nó jcr:content
da ramificação necessária.
Por exemplo, com um valor de:
/conf/<your-folder>/settings/wcm/templates/.*;
Páginas criadas a partir de modelos editáveis:
São criados com uma subárvore que é 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 nó jcr:content
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:
Controlador - /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
O pacote OSGI implementa a funcionalidade.
Exibir - /apps/<my-site>/components
Nos ambientes autor e publicação, o conteúdo é renderizado por components.
Ao renderizar uma página:
Modelos:
cq:template
do nó jcr:content
será referenciada para acessar o modelo que corresponde a essa página.Componentes:
O componente de página unirá a árvore structure/jcr:content
do modelo à árvore jcr:content
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 nó jcr:content
; o mesmo caminho sob o nó policies/jcr:content
do modelo será então pesquisado.
cq:policy
desse nó aponta para a política de conteúdo real (isto é, ela contém a configuração de design desse componente).