Modelos de fragmentos do conteúdo content-fragment-templates

Last update: Mon Jul 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

Tópicos:

Criado para:

Desenvolvedor

CAUTION

Modelos de fragmento de conteúdo são recomendados para criar todos os novos fragmentos de conteúdo.

Os modelos de fragmento de conteúdo são usados para todos os exemplos no WKND.

NOTE

Antes do AEM 6.3, os fragmentos de conteúdo eram criados com base em modelos em vez de modelos.

Os modelos de Fragmento de conteúdo agora estão obsoletos. Eles ainda podem ser usados para criar fragmentos, mas é recomendável usar Modelos de fragmento de conteúdo. Nenhum novo recurso será adicionado aos modelos de fragmento e será removido em uma versão futura.

Os modelos são selecionados ao criar um fragmento de conteúdo. Eles fornecem o novo fragmento com a estrutura básica, os elementos e a variação. Os modelos usados para fragmentos de conteúdo estão sujeitos ao Granite Configuration Manager.

Os templates prontos para uso são mantidos em:

/libs/settings/dam/cfm/templates

Você pode criar modelos específicos do site para fragmentos de conteúdo em:

/apps/settings/dam/cfm/templates
O local para sobrepor modelos prontos para uso ou fornecer modelos do aplicativo específicos do cliente que não devem ser estendidos/alterados no tempo de execução.
/conf/global/settings/dam/cfm/templates
O local para modelos específicos do cliente em toda a instância que precisam ser alterados no tempo de execução.

A ordem de precedência é (em ordem decrescente) /conf, /apps, /libs.

CAUTION

Você deve não 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 um hotfix ou pacote de recursos).

O método recomendado para configuração e outras alterações é:

Recriar o item necessário (isto é, como ele existe em /libs) em /apps
Fazer alterações em /apps

A estrutura básica de um modelo é mantida em:

conf
  global
    settings
      dam
        cfm
          templates
            <template-name>
              ...

Sendo a estrutura específica:

+ <template-name>
    - jcr:primaryType
    - jcr:title
    - jcr:description
    - initialAssociatedContent
    - precreateElements
    - version
    + elements
        - jcr:primaryType
        + <element-name>
            - jcr:primaryType
            - jcr:title
            - defaultContent
            - initialContentType
            - name
        ... + other element definitions
    + variations
        - jcr:primaryType
        + <variation-name>
            - jcr:primaryType
            - jcr:title
            - jcr:description
            - name
        ... + other variation definitions

Mais detalhes sobre os nós e suas propriedades são:

Modelo

table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 6-row-3 html-authored
Nome	Tipo	Valor
`<template-name>`	`nt:unstructured`	Este nó é a raiz de cada modelo. É obrigatório e deve ter um nome exclusivo.
`jcr:title`	`String` obrigatório	O título do modelo (exibido no assistente Criar fragmento).
`jcr:description`	`String` opcional	Um texto que descreve a finalidade do modelo (exibido no assistente Criar fragmento).
`initialAssociatedContent`	`String[]` opcional	Uma matriz com caminhos para coleções que devem ser associados a um fragmento de conteúdo recém-criado por padrão.
`precreateElements`	`Boolean` obrigatório	`true`, se os subativos que representam os elementos (exceto o elemento mestre) do fragmento de conteúdo tiverem que ser criados quando o fragmento de conteúdo for criado; false se tiverem que ser criados "instantaneamente". Observação: atualmente, este parâmetro deve ser definido como `true`.
`version`	`Long` obrigatório	Versão da estrutura de conteúdo; atualmente compatível: Observação: atualmente, este parâmetro deve ser definido como `2`.

Elementos

table 0-row-3 1-row-3 html-authored

Nome Tipo Valor

elements

nt:unstructured

obrigatório

Nó que contém a definição dos elementos do fragmento de conteúdo. É obrigatório e precisa conter pelo menos um nó filho para o elemento Main, mas pode conter [1.n] nós-filhos.

Quando o modelo é usado, a sub-ramificação dos elementos é copiada para a sub-ramificação do modelo do fragmento.

O primeiro elemento (conforme exibido em CRXDE Lite) é automaticamente considerado como o elemento main. O nome do nó é irrelevante e o próprio nó não tem um significado especial, exceto pelo fato de que é representado pelo ativo principal; os outros elementos são tratados como sub-ativos.

Nome do elemento

table 0-row-3 1-row-3 2-row-3 3-row-3 4-row-3 5-row-3 html-authored
Nome	Tipo	Valor
`<element-name>`	`nt:unstructured`	Este nó define um elemento. É obrigatório e deve ter um nome exclusivo.
`jcr:title`	`String` obrigatório	O título do elemento (exibido no seletor de elementos do editor de fragmentos).
`defaultContent`	`String` opcional padrão: ""	Conteúdo inicial do elemento; usado somente se `precreateElements` = `true`
`initialContentType`	`String` opcional padrão: `text/html`	Tipo de conteúdo inicial do elemento; usado somente se `precreateElements` = `true`; atualmente com suporte: `text/html` `text/plain` `text/x-markdown`
`name`	`String` obrigatório	O nome interno do elemento; deve ser exclusivo para o tipo de fragmento.

Variações

table 0-row-3 1-row-3 html-authored

Nome Tipo Valor

variations

nt:unstructured

opcional

Esse nó opcional contém a definição das variações iniciais do fragmento de conteúdo.

Nome da Variação

table 0-row-3 1-row-3 2-row-3 3-row-3 html-authored
Nome	Tipo	Valor
`<variation-name>`	`nt:unstructured` obrigatório se um nó de variação estiver presente	Define uma variação inicial. A variação é adicionada a todos os elementos do fragmento de conteúdo por padrão. A variação terá o mesmo conteúdo inicial que o respectivo elemento (consulte `defaultContent/ initialContentType` )
`jcr:title`	`String` obrigatório	O título da variação (exibido na guia Variação do editor de fragmentos (painel esquerdo)).
`jcr:desciption`	`String` opcional padrão: ""	Um texto que fornece uma descrição da variação (exibida na guia Variação do editor de fragmento (painel esquerdo)).

recommendation-more-help

19ffd973-7af2-44d0-84b5-d547b0dffee2