Personalização e extensão de fragmentos de conteúdo customizing-and-extending-content-fragments

Criação e gerenciamento de fragmentos de conteúdo e Criação de página com fragmentos de conteúdo para obter mais informações sobre fragmentos de conteúdo.

Gerenciando o Assets e Personalizando e estendendo o Assets para obter mais informações sobre os ativos padrão.

Modelos de fragmentos do conteúdo:

• Usado para definir fragmentos de conteúdo que contêm conteúdo estruturado.
• Os modelos de fragmento de conteúdo definem a estrutura de um fragmento de conteúdo quando ele é criado.
• Um fragmento faz referência ao modelo; portanto, as alterações no modelo podem/afetarão qualquer fragmento dependente.
• Os modelos são compostos de tipos de dados.
• As funções para adicionar novas variações, e assim por diante, precisam atualizar o fragmento de acordo.

Modelos de fragmentos do conteúdo:

• Usado para definir fragmentos de conteúdo simples.
• Os modelos definem a estrutura (básica, somente texto) de um fragmento de conteúdo quando ele é criado.
• O modelo é copiado para o fragmento quando é criado; portanto, outras alterações no modelo não serão refletidas nos fragmentos existentes.
• As funções para adicionar novas variações, e assim por diante, precisam atualizar o fragmento de acordo.
• Os modelos de fragmento de conteúdo operam de maneira diferente dos outros mecanismos de modelo no ecossistema AEM (por exemplo, modelos de página e assim por diante). Por conseguinte, devem ser consideradas separadamente.
• Quando baseado em um modelo, o tipo MIME do conteúdo é gerenciado no conteúdo real; isso significa que cada elemento e variação pode ter um tipo MIME diferente.

Todo o conteúdo é armazenado no nó jcr:content/data do ativo:

• Os dados do elemento são armazenados no subnó principal:

  jcr:content/data/master

• As variações são armazenadas em um subnó que carrega o nome da variação:
  por exemplo, jcr:content/data/myvariation

• Os dados de cada elemento são armazenados no respectivo subnó como uma propriedade com o nome do elemento:
  por exemplo, o conteúdo do elemento text é armazenado como a propriedade text em jcr:content/data/master

Os metadados e o conteúdo associado estão armazenados abaixo de jcr:content/metadata
Exceto o título e a descrição, que não são considerados metadados tradicionais e armazenados em jcr:content

Todas as informações não relacionadas ao conteúdo de um fragmento (como título, descrição, metadados, estrutura) são gerenciadas exclusivamente no ativo principal.

O conteúdo do primeiro elemento de um fragmento é mapeado para a representação original do ativo principal.

• As variações (se houver alguma) do primeiro elemento são mapeadas para outras representações do ativo principal.

Os elementos adicionais (se existirem) são mapeados para os subativos do ativo principal.

• O conteúdo principal desses elementos adicionais é mapeado para a representação original do respectivo subativo.
• Outras variações (se aplicável) de quaisquer elementos adicionais são mapeadas para outras representações do respectivo subativo.

O componente usa a propriedade fragmentPath para fazer referência ao fragmento de conteúdo real. A propriedade fragmentPath é tratada da mesma forma que as propriedades semelhantes de outros tipos de ativos; por exemplo, quando o fragmento de conteúdo é movido para outro local.

O componente permite selecionar a variação a ser exibida.

Além disso, um intervalo de parágrafos pode ser selecionado para restringir a saída; por exemplo, isso pode ser usado para saída de várias colunas.

O componente permite conteúdo intermediário:

• Aqui, o componente permite colocar outros ativos (imagens e assim por diante) entre os parágrafos do fragmento referenciado.

• Para conteúdo intermediário, é necessário:

  • esteja ciente da possibilidade de referências instáveis; o conteúdo intermediário (adicionado ao criar uma página) não tem relação fixa com o parágrafo ao lado do qual está posicionado, inserindo um novo parágrafo (no editor de fragmento de conteúdo) antes que a posição do conteúdo intermediário possa perder a posição relativa
  • considere os parâmetros adicionais (como variação e filtros de parágrafo) para evitar falsos positivos nos resultados da pesquisa

Tipos de recursos
Uma lista de sling:resourceTypes pode ser fornecida para definir componentes que são usados para renderizar fragmentos de conteúdo e onde o processamento em segundo plano deve ser aplicado.

Propriedades de Referência
Uma lista de propriedades pode ser configurada para especificar onde a referência ao fragmento é armazenada para o respectivo componente.

O nome da propriedade em que os elementos a serem renderizados são definidos deve ser element ou elementNames.

O nome da propriedade onde a variação a ser renderizada está definida deve ser variation ou variationName.

Se houver suporte para a saída de vários elementos (usando elementNames para especificar vários elementos), o modo de exibição real será definido pela propriedade displayMode:

• Se o valor for singleText (e houver apenas um elemento configurado), o elemento será renderizado como um texto com conteúdo intermediário, suporte de layout e assim por diante. Esse é o padrão para fragmentos em que apenas um único elemento é renderizado.
• Caso contrário, uma abordagem muito mais simples será usada (pode ser chamada de "exibição de formulário"), em que nenhum conteúdo intermediário é compatível e o conteúdo do fragmento é renderizado "como está".

Se o fragmento for renderizado para displayMode == singleText (implícita ou explicitamente), as seguintes propriedades adicionais serão exibidas:

• paragraphScope define se todos os parágrafos, ou somente um intervalo de parágrafos, devem ser renderizados (valores: all vs. range)

• se paragraphScope == range então a propriedade paragraphRange define o intervalo de parágrafos a ser renderizado

Traduções

Os fragmentos de conteúdo são totalmente integrados ao fluxo de trabalho de tradução do AEM. Em um nível arquitetônico, isso significa:

• As traduções individuais de um fragmento de conteúdo são fragmentos separados; por exemplo:

  • eles estão localizados em raízes de idioma diferentes:

    /content/dam/<path>/en/<to>/<fragment>

    vs.

    /content/dam/<path>/de/<to>/<fragment>

  • mas compartilham exatamente o mesmo caminho relativo abaixo da raiz de idioma:

    /content/dam/<path>/en/<to>/<fragment>

    vs.

    /content/dam/<path>/de/<to>/<fragment>

• Além dos caminhos com base em regras, não há mais conexão entre as diferentes versões de idioma de um fragmento de conteúdo; elas são tratadas como dois fragmentos separados, embora a interface forneça os meios para navegar entre as variantes de idioma.

Esquemas de metadados

• Os fragmentos de conteúdo (re)usam os esquemas de metadados, que podem ser definidos com ativos padrão.

• O CFM fornece seu próprio esquema específico:

  /libs/dam/content/schemaeditors/forms/contentfragment

  isso pode ser estendido, se necessário.

• O respectivo formulário de esquema é integrado ao editor de fragmentos.

Modelo de fragmento (ModeloDeFragmento)

Use FragmentTemplate.createFragment() para criar um fragmento.

Resource templateOrModelRsc = resourceResolver.getResource("...");
FragmentTemplate tpl = templateOrModelRsc.adaptTo(FragmentTemplate.class);
ContentFragment newFragment = tpl.createFragment(parentRsc, "A fragment name", "A fragment description.");

Essa interface representa:

• um modelo de fragmento de conteúdo ou um modelo de fragmento de conteúdo a partir do qual criar um fragmento de conteúdo,
• e (após a criação) a informação estrutural desse fragmento

Essas informações podem incluir:

• Acessar dados básicos (título, descrição)

• Acesse modelos/modelos para os elementos do fragmento:

  • Listar modelos de elementos
  • Obter informações estruturais de um determinado elemento
  • Acessar o modelo de elemento (consulte ElementTemplate)

• Acesse modelos para as variações do fragmento:

  • Listar modelos de variação
  • Obter informações estruturais para uma determinada variação
  • Acessar o modelo de variação (consulte VariationTemplate)

• Obter conteúdo associado inicial

Interfaces que representam informações importantes:

• ElementTemplate

  • Obter dados básicos (nome, título)
  • Obter conteúdo do elemento inicial

• VariationTemplate

  • Obter dados básicos (nome, título, descrição)

Fragmento de Conteúdo (Fragmento de Conteúdo)

Essa interface permite trabalhar com um fragmento de conteúdo de forma abstrata.

A interface fornece os meios para:

• Gerenciar dados básicos (por exemplo, obter nome; obter/definir título/descrição)

• Acessar metadados

• Acessar elementos:

  • Listar elementos

  • Obter elementos por nome

  • Criar novos elementos (consulte Avisos)

  • Acessar dados do elemento (consulte ContentElement)

• Variações de lista definidas para o fragmento

• Criar novas variações globalmente

• Gerenciar conteúdo associado:

  • Listar coleções
  • Adicionar coleções
  • Remover coleções

• Acessar o modelo ou modelo do fragmento

As interfaces que representam os elementos principais de um fragmento são:

• Elemento de Conteúdo (ElementoConteúdo)

  • Obter dados básicos (nome, título, descrição)

  • Obter/definir conteúdo

  • Acessar variações de um elemento:

    • Variações de lista
    • Obter variações por nome
    • Criar novas variações (consulte Avisos)
    • Remover variações (consulte Avisos)
    • Acessar dados de variação (consulte ContentVariation)

  • Atalho para resolver variações (aplicar alguma lógica de fallback adicional específica de implementação se a variação especificada não estiver disponível para um elemento)

• Variação de Conteúdo (VariaçãoDeConteúdo)

  • Obter dados básicos (nome, título, descrição)
  • Obter/definir conteúdo
  • Sincronização simples, com base nas informações da última modificação

Todas as três interfaces ( ContentFragment, ContentElement, ContentVariation) estendem a interface Versionable, o que adiciona recursos de controle de versão, necessários para fragmentos de conteúdo:

• Criar nova versão do elemento
• Listar versões do elemento
• Obter o conteúdo de uma versão específica do elemento com versão

ContentFragment pode ser adaptado para:

• Resource - o recurso Sling subjacente; observe que a atualização direta do Resource subjacente, requer a recompilação do objeto ContentFragment.

• Asset - a abstração Asset do DAM que representa o fragmento de conteúdo; observe que a atualização direta do Asset requer a reconstrução do objeto ContentFragment.

ContentElement pode ser adaptado para:

• ElementTemplate - para acessar as informações estruturais do elemento.

FragmentTemplate pode ser adaptado para:

• Resource - o Resource determinando o modelo referenciado ou o modelo original que foi copiado;

  • as alterações feitas por meio do Resource não são refletidas automaticamente no FragmentTemplate.

Resource pode ser adaptado para:

• ContentFragment
• FragmentTemplate

A API é implementada para fornecer a funcionalidade compatível com a interface do usuário do.

A API inteira foi projetada para não manter as alterações automaticamente (a menos que indicado de outra forma no JavaDoc da API). Portanto, sempre é necessário confirmar o resolvedor de recursos da respectiva solicitação (ou o resolvedor que você está usando na verdade).

Tarefas que podem exigir esforço adicional:

• Criar/remover novos elementos não atualizará a estrutura de dados de fragmentos simples (com base em um modelo de fragmento).

• Criar novas variações a partir de ContentElement não atualizará a estrutura de dados (mas criá-las globalmente a partir de ContentFragment atualizará).

• A remoção de variações existentes não atualizará a estrutura de dados.

filter.xml

O filter.xml para gerenciamento de fragmento de conteúdo está configurado de forma que não se sobreponha ao pacote de conteúdo principal do Assets.

Iniciar uma sessão

• Uma nova versão do fragmento de conteúdo é criada.
• Salvamento automático iniciado.
• Os cookies são definidos; eles definem o fragmento editado no momento e uma sessão de edição aberta.

Finalizando uma sessão

• Salvamento automático interrompido.

• Na confirmação:

  • As informações da última modificação são atualizadas.
  • Os cookies são removidos.

• Na reversão:

  • A versão do fragmento de conteúdo criada quando a sessão de edição foi iniciada é restaurada.
  • Os cookies são removidos.

Edição

• Todas as alterações (salvamento automático incluído) são feitas no fragmento de conteúdo ativo - não em uma área separada e protegida.
• Portanto, essas alterações são refletidas imediatamente nas páginas AEM que fazem referência ao respectivo fragmento de conteúdo

Inserção de uma página

• Verifique se uma sessão de edição já está presente; verificando o respectivo cookie.

  • Se existir, verifique se a sessão de edição foi iniciada para o fragmento de conteúdo que está sendo editado no momento

    • Se for o fragmento atual, restabeleça a sessão.
    • Caso contrário, tente cancelar a edição do fragmento de conteúdo editado anteriormente e remover os cookies (nenhuma sessão de edição presente posteriormente).

  • Se não houver uma sessão de edição, aguarde a primeira alteração feita pelo usuário (veja abaixo).

• Verifique se o fragmento de conteúdo já está referenciado em uma página e exiba as informações apropriadas em caso positivo.

Alteração de conteúdo

• Sempre que o usuário altera o conteúdo e não há nenhuma sessão de edição presente, uma nova sessão de edição é criada (consulte Iniciando uma sessão).

Sair de uma página

• Se uma sessão de edição estiver presente e as alterações não forem persistentes, uma caixa de diálogo de confirmação modal será exibida para notificar o usuário sobre conteúdo potencialmente perdido e permitir que ele permaneça na página.

Nó: <*conf-root*>/settings/dam/cfm/jcr:content

Nome da Propriedade: autoSaveInterval

Tipo: Long

Padrão: 600 (10 minutos); definido em /libs/settings/dam/cfm/jcr:content

Nó: /conf/global/settings/dam/cfm/jcr:content

Nome da Propriedade: autoSaveInterval

Tipo: Long

Valor: 300 (5 minutos equivale a 300 segundos)