DocumentaçãoAEM 6.5Guia do usuário

Modelos de página - Editável page-templates-editable

Last update: Thu Aug 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Criado para:

  • Desenvolvedor

Foram introduzidos modelos editáveis para:

  • Permitir que autores especializados criem e editem modelos.

    • Esses autores especializados são chamados de autores de modelo
    • Os autores do modelo devem ser membros do grupo template-authors.

  • Forneça modelos que mantenham uma conexão dinâmica com qualquer página criada a partir deles. Isso garante que qualquer alteração no modelo seja refletida nas próprias páginas.

  • Torne o componente da página mais genérico para que o componente da página principal possa ser usado sem personalização.

Com modelos editáveis, as partes que fazem uma página são isoladas dentro de componentes. Você pode configurar as combinações necessárias de componentes em uma interface de usuário, de modo a eliminar a necessidade de um novo componente de página ser desenvolvido para cada variação de página.

NOTE
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 de 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 conforme expostos ao autor do modelo.

NOTE
O tutorial a seguir também pode ser interessante 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 Base e um Modelo

Criação de um novo 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 fornece uma visão geral desse processo e segue com uma descrição do que ocorre em nível técnico.

Para obter informações sobre como usar modelos editáveis em um projeto AEM, consulte Criação de um projeto AEM usando Lazybones.

Ao criar um modelo editável, você:

  1. Criar uma pasta para os modelos. Esta pasta não é obrigatória, mas é uma prática recomendada.

  2. Selecione um tipo de modelo. Este tipo foi copiado para criar a definição do modelo.

    note note
    NOTE
    Uma seleção de tipos de modelo é fornecida pronta para uso. 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 definir os componentes e o conteúdo para o modelo.

    • Os componentes definidos na estrutura do modelo não podem ser movidos em uma página resultante nem excluídos de qualquer página resultante.

      • Se você estiver criando um modelo em uma pasta personalizada fora do conteúdo de exemplo do We.Retail, poderá escolher Componentes de base ou usar Componentes principais.

    • Se desejar que os autores de 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 Criando 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ínima/máxima.

    • Essas políticas são aplicáveis ao modelo (e 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

    • O Conteúdo inicial define o conteúdo que aparece quando uma página é 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 Criando Modelos de Página.

    Para obter detalhes técnicos sobre o conteúdo inicial, consulte Conteúdo inicial neste documento.

    Layout

    • Você pode 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 Criando Modelos de Página.

    Para obter detalhes técnicos sobre o layout do modelo, consulte Layout neste documento.

  4. Ative o modelo e, em seguida, aguarde-o para árvores de conteúdo específicas.

    • Um modelo pode ser ativado ou desativado para disponibilizá-lo ou indisponibilizá-lo para os autores da 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 habilita um modelo, consulte Criando Modelos de Página.

    Para obter detalhes técnicos sobre como habilitar um modelo, consulte Habilitando e Permitindo um Modelo para Nóse neste documento

  5. Use-a para criar páginas de conteúdo.

    • Ao usar um modelo para criar uma página, não há diferença visível e nenhuma indicação entre 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 Criar e organizar páginas.

    Para obter detalhes técnicos sobre como criar páginas com modelos editáveis, consulte as Páginas de Conteúdo Resultante neste documento.

TIP
Nunca insira qualquer informação que deve ser internacionalizada em um modelo. Para fins de internalização, o recurso de localização dos Componentes Principais é recomendado.
NOTE
Os modelos são ferramentas eficientes para simplificar o fluxo de trabalho de criação de página. No entanto, usar modelos em excesso pode sobrecarregar os autores e tornar confusa a criação da página. Uma boa regra geral é manter o número de modelos abaixo de 100.
A Adobe não recomenda ter mais de 1000 modelos devido a possíveis impactos no desempenho.
NOTE
A biblioteca cliente do editor presume a presença do namespace cq.shared nas páginas de conteúdo. Se estiver ausente, resultará no erro de JavaScript Uncaught TypeError: Cannot read property 'shared' of undefined.
Todas as páginas de conteúdo de exemplo 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 exemplo, certifique-se de incluir o namespace cq.shared.
Consulte Usando bibliotecas do lado do cliente para obter mais informações.

Pastas de Modelos template-folders

Para organizar os templates, 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 tem privilégios de administrador.
NOTE
Embora você possa aninhar suas pastas, quando o usuário as visualiza no console Modelos, elas são apresentadas como uma estrutura simples.

Em uma instância padrão do AEM, a pasta global existe no console modelo. Essa pasta retém modelos padrão e atua como um fallback se nenhuma política e/ou tipo de modelo for encontrado na pasta atual. Você pode adicionar seus modelos padrão a esta pasta ou criar uma pasta (recomendado).

NOTE
É uma prática recomendada criar uma pasta para armazenar seus modelos personalizados e não usar a pasta global.
CAUTION
As pastas devem ser criadas por um usuário com direitos de 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:

  1. A pasta atual.
  2. Pai ou pais da pasta atual.
  3. /conf/global
  4. /apps
  5. /libs

Uma lista de todas as entradas permitidas é criada. Se alguma configuração se sobrepõe ( path/ label), somente a instância mais próxima à pasta atual é apresentada ao usuário.

Para criar uma pasta, faça o seguinte:

  • Programaticamente ou com CRXDE Lite
  • Usar o navegador de configuração

Uso do CRXDE Lite using-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:

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

  2. Em seguida, você pode definir as seguintes propriedades no nó raiz da pasta:

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

    Nome: jcr:title

    • Tipo: String

    • Valor: o título (da pasta) que você deseja exibir no console Modelos.

  3. Em adição às permissões e privilégios de criação padrão (por exemplo, content-authors), atribua grupos e defina 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 deve ser atribuído. Consulte a seguinte seção ACLs e grupos para obter detalhes.

    Consulte Gerenciamento de Direitos de Acesso para obter detalhes completos sobre como gerenciar e atribuir direitos de acesso.

Usar o navegador de configuração using-the-configuration-browser

  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 devem ser configurados:

    • Título: forneça um título para a pasta de configuração
    • Modelos editáveis: selecione para permitir modelos editáveis nesta pasta

  4. Clique em Criar

NOTE
No Navegador de Configuração, você pode editar a pasta global e ativar a opção Modelos editáveis se quiser criar modelos dentro dessa pasta. No entanto, essa prática não é uma prática recomendada.
Consulte a documentação do Navegador de Configuração para obter mais informações.

ACLs e grupos acls-and-groups

Depois que as pastas de modelo forem criadas (por meio do CRXDE ou com o Navegador de configuração), as ACLs deverão ser definidas para os grupos apropriados para as pastas de modelo, a fim de garantir a segurança adequada.

As pastas de modelo para a We.Retail implementação de referência podem ser usadas como exemplo.

O grupo de autores de modelo the-template-authors-group

O grupo template-authors é o grupo usado para gerenciar o acesso a modelos e vem com o AEM como padrão, mas está vazio. Os usuários devem ser adicionados ao grupo para o projeto/site.

CAUTION
O grupo template-authors é only para usuários que devem poder criar modelos.
A edição de modelos é avançada e, se não for feita corretamente, os modelos existentes poderão ser corrompidos. Portanto, essa função deve ser focalizada 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, gravar, replicar
Autores de modelo que criam, leem, atualizam, excluem e replicam modelos no espaço /conf específico do site
Usuário da Web Anônimo
ler
O usuário da Web anônimo deve ler os modelos ao renderizar uma página
Autores de conteúdo
replicar
replicateContent autores devem ativar os modelos de uma página ao ativar uma página
/conf/<your-folder>/settings/wcm/policies
Template Author
ler, gravar, replicar
Autores de modelo que criam, leem, atualizam, excluem e replicam modelos no espaço /conf específico do site
Usuário da Web Anônimo
ler
O Usuário Anônimo da Web deve ler as políticas ao renderizar uma página
Autores de conteúdo
replicar
Os autores de conteúdo devem ativar as políticas de um modelo de uma página ao ativar uma página
/conf/<site>/settings/template-types
Autor do modelo
ler
O autor do modelo cria um modelo com base em um dos tipos de modelo predefinidos.
Usuário da Web Anônimo
nenhum
O usuário da Web anônimo não deve acessar os tipos de modelo

Este grupo template-authors padrão cobre 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, em que há necessidade de vários grupos de autores de modelo para separar o acesso aos 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 legacy-templates-under-conf-global

Não armazenar modelos em /conf/global. No entanto, para algumas instalações herdadas, ainda pode haver modelos neste local. Somente em tais situações herdadas deve ser configurado explicitamente os caminhos /conf/global a seguir.

Caminho
Função/Grupo
Permissões
Descrição
/conf/global/settings/wcm/templates
Autores do modelo
ler, gravar, replicar
Autores de modelos que criam, leem, atualizam, excluem e replicam modelos no /conf/global
Usuário da Web Anônimo
ler
O usuário da Web anônimo deve ler os modelos ao renderizar uma página
Autores de conteúdo
replicar
Os autores de conteúdo devem ativar os modelos de uma página ao ativar uma página
/conf/global/settings/wcm/policies
Template Author
ler, gravar, replicar
Autores de modelos que criam, leem, atualizam, excluem e replicam modelos no /conf/global
Usuário da Web Anônimo
ler
O Usuário Anônimo da Web deve ler as políticas ao renderizar uma página
Autores de conteúdo
replicar
Os autores de conteúdo devem ativar as políticas de um modelo de uma página ao ativar uma página
/conf/global/settings/wcm/template-types
Autor do modelo
ler
O autor do modelo cria um modelo com base em um dos tipos de modelo predefinidos
Usuário da Web Anônimo
nenhum
O usuário da Web anônimo não deve acessar os tipos de modelo

Tipo de modelo template-type

Ao criar um modelo, especifique um tipo de modelo:

  • Os tipos de modelo fornecem modelos para um modelo de maneira eficaz. Ao criar um template, a estrutura e o conteúdo inicial do tipo de template selecionado são usados para criar o template.

    • O tipo de modelo é copiado para criar o modelo.
    • Depois que a cópia ocorre, 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 definir:

    • O tipo de recurso do componente de página.
    • A política do nó raiz, que define os componentes permitidos no editor de modelo.
    • A Adobe recomenda que você defina os pontos de interrupção para a grade responsiva e a configuração do emulador móvel em no tipo de modelo. Esta etapa é 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 normalmente são definidos pelos desenvolvedores.

Os tipos de template prontos para uso são armazenados em:

  • /libs/settings/wcm/template-types
CAUTION
Não altere nada no caminho /libs. O motivo é que 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 um hotfix ou pacote de recursos).

Os tipos de modelo específicos do site devem ser armazenados no local comparável do:

  • /apps/settings/wcm/template-types

As definições dos tipos de modelos personalizados devem ser armazenadas em pastas definidas pelo usuário (recomendado) ou, como alternativa, 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
CAUTION
Os tipos de modelo devem respeitar a estrutura de pasta correta (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 template-type-and-mobile-device-groups-br

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 lugares:

  • No tipo de modelo editável
  • No modelo editável

Ao criar um modelo editável, o valor é copiado do tipo de modelo para o modelo individual. Se o valor não estiver definido no tipo, ele poderá ser definido no template. Depois que um modelo é criado, não há herança do tipo para o modelo.

CAUTION
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.
NOTE
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 é compatível no nível raiz da página.

Criação de Tipos de Modelo creating-template-types

Se você tiver criado um modelo que possa servir como base de outros modelos, poderá copiá-lo como um tipo de modelo.

  1. Crie um modelo como faria com qualquer modelo editável. Consulte Criação de Modelos de Página. Isso pode servir como base para o tipo de template.
  2. Usando o CRXDE Lite, copie o modelo recém-criado do nó templates para o nó template-types na pasta de modelo.
  3. Exclua o modelo do nó templates na pasta de modelo.
  4. Na cópia do modelo que está sob o nó template-types, exclua todas as propriedades cq:template e cq:templateType de todos os nós 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 template-definitions

As definições dos modelos editáveis estão armazenadas em pastas definidas pelo usuário (recomendado) ou, como alternativa, 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:

  • <template-name>

    • [initial](#initial-content)
    • jcr:content
    • [structure](#structure)
    • [policies](#policies)
    • thumbnail.png

jcr:content jcr-content

Este nó retém propriedades para o modelo:

  • Nome: jcr:title

  • Nome: status

    • Tipo: String

    • Valor: draft, enabled ou disabled

Estrutura structure

Define a estrutura da página resultante:

  • É mesclado com o conteúdo inicial ( /initial) ao criar uma página.

  • As alterações feitas na estrutura são refletidas em qualquer página criada com o modelo.

  • O nó root ( structure/jcr:content/root) define a lista de componentes que estão disponíveis na página resultante.

    • Os componentes definidos na estrutura do modelo não podem ser movidos para ou excluído de qualquer página resultante.

    • Após um componente ser desbloqueado, a propriedade editable é definida como true.

    • Após desbloquear um componente que já contém conteúdo, esse conteúdo é movido para a ramificação initial.

  • O nó cq:responsive contém definições para o layout responsivo.

Conteúdo inicial initial-content

Define o conteúdo inicial que uma nova página tem na criação:

  • Contém um nó jcr:content que é copiado para quaisquer páginas novas.
  • É mesclado com a estrutura ( /structure) ao criar uma página.
  • Quaisquer páginas existentes serão atualizadas se o conteúdo inicial for alterado após a criação.
  • O nó root contém uma lista de componentes para definir o que está disponível na página resultante.
  • Se o conteúdo for adicionado a um componente no modo de estrutura e esse componente for posteriormente desbloqueado (ou vice-versa), esse conteúdo será usado como conteúdo inicial.

Layout layout

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

Políticas de conteúdo content-policies

As políticas de conteúdo (ou design) definem as propriedades de design de um componente, como a disponibilidade do componente ou as dimensões mínimas/máximas. Essas políticas são aplicáveis ao modelo (e páginas criadas com o modelo). As políticas de conteúdo podem ser criadas e selecionadas no editor de modelo.

  • 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ágrafos da página.

  • A propriedade cq:policy, nos nós de componente explícito em root, fornece links para as políticas dos componentes individuais.

  • As definições de políticas reais são armazenadas em:
    /conf/<your-folder>/settings/wcm/policies/wcm/foundation/components

NOTE
Os caminhos das definições de política dependem do caminho do componente. O cq:policy contém uma referência relativa à própria configuração.
NOTE
As páginas criadas a partir de modelos editáveis não oferecem um modo Design no editor de páginas.
A árvore policies de um modelo editável tem a mesma hierarquia da configuração de 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 page-policies

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

Ativação e permissão de um modelo para uso enabling-and-allowing-a-template-for-use

  1. Habilitar o Modelo

    Antes de ser usado, um template deve ser ativado por um dos seguintes:

    • Habilitando o modelo do console Modelos.

    • Definindo a propriedade de status no nó jcr:content.

      • 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

    Por exemplo, com um valor de:

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

Páginas de conteúdo resultante resultant-content-pages

Páginas criadas a partir de modelos editáveis:

  • São criados com uma subárvore que é mesclada de structure e initial no modelo

  • Ter referências às informações mantidas no modelo e no tipo de modelo. Você pode obter essa funcionalidade 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 template.

chlimage_1-71

O diagrama acima mostra como os modelos, o conteúdo e os componentes se inter-relacionam:

  • 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, ele 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 do autor e de publicação, o conteúdo é renderizado por componentes.

Ao processar uma página:

  • Modelos:

    • A propriedade cq:template de seu nó jcr:content é referenciada para acessar o modelo que corresponde a essa página.

  • Componentes:

    • O componente de página mescla a árvore structure/jcr:content do modelo com a árvore jcr:content da página.

    • O componente de Página permite que o autor edite apenas os nós da estrutura do modelo que foram sinalizados como editáveis (e quaisquer secundários).

    • Ao renderizar um componente em uma página, o caminho relativo desse componente é retirado do nó jcr:content; o mesmo caminho no nó policies/jcr:content do modelo é então pesquisado.

      • A propriedade cq:policy desse nó aponta para a política de conteúdo real (ou seja, ele contém a configuração de design desse componente).

      • Essa funcionalidade permite que você tenha vários templates que reutilizam as mesmas configurações de política de conteúdo.

recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2