Modelos de fragmentos do conteúdo

CUIDADO

A API AEM GraphQL, para o Delivery de fragmento de conteúdo, será lançada no início de 2021.

A documentação relacionada já está disponível para fins de pré-visualização.

Os Modelos de fragmento de conteúdo definem a estrutura do conteúdo para seus fragmentos de conteúdo.

Para usar os Modelos de fragmento de conteúdo, faça o seguinte:

  1. Ativar a funcionalidade do Modelo de fragmento de conteúdo para sua instância
  2. Crie e configure seus Modelos de fragmento de conteúdo
  3. Ative seus Modelos de fragmento de conteúdo para uso ao criar Fragmentos de conteúdo para uso ao criar Fragmentos de conteúdo

Criação de um modelo de fragmento de conteúdo

  1. Navegue até Ferramentas, Ativos e abra Modelos de fragmento de conteúdo.

  2. Navegue até a pasta apropriada para sua configuração.

  3. Use Criar para abrir o assistente.

    CUIDADO

    Se o uso de modelos de fragmento de conteúdo não tiver sido ativado, a opção Criar não estará disponível.

  4. Especifique o título do modelo. Você também pode adicionar Tags e Descrição, se necessário.

    título e descrição

  5. Use Create para salvar o modelo vazio. Uma mensagem indicará o sucesso da ação. Você pode selecionar Abrir para editar imediatamente o modelo ou Concluído para retornar ao console.

Definição do modelo de fragmento de conteúdo

O modelo de fragmento de conteúdo define efetivamente a estrutura dos fragmentos de conteúdo resultantes usando uma seleção de Tipos de dados. Usando o editor de modelo, você pode adicionar instâncias dos tipos de dados e configurá-las para criar os campos necessários:

CUIDADO

Editar um modelo de fragmento de conteúdo existente pode afetar fragmentos dependentes.

  1. Navegue até Ferramentas, Ativos e abra Modelos de fragmento de conteúdo.

  2. Navegue até a pasta que contém o modelo de fragmento do conteúdo.

  3. Abra o modelo necessário para Editar; use a ação rápida ou selecione o modelo e a ação na barra de ferramentas.

    Depois de abrir o editor de modelo, é mostrado:

    • esquerda: campos já definidos
    • direito: Tipos de dados disponíveis para criar campos (e Propriedades para uso depois que os campos forem criados)
    Observação

    Quando um campo é Obrigatório, o Rótulo indicado no painel à esquerda é marcado com um asterisco (*).

  4. Para adicionar um campo

    • Arraste um tipo de dados necessário para o local desejado para um campo.

    • Depois que um campo for adicionado ao modelo, o painel direito mostrará as Propriedades que podem ser definidas para esse tipo de dados específico. Aqui você pode definir o que é necessário para esse campo.
      Muitas propriedades são autoexplicativas, para obter detalhes adicionais, consulte Propriedades.

  5. Como remover um campo

    Selecione o campo desejado e clique/toque no ícone lixeira. Você receberá uma solicitação para confirmar a ação.

  6. Adicione todos os campos obrigatórios e defina as propriedades relacionadas, conforme necessário.

  7. Selecione Salvar para persistir na definição.

Tipos de dados

Uma seleção de tipos de dados está disponível para definir seu modelo:

  • Texto em linha única
    • Adicione um ou mais campos de uma única linha de texto; o comprimento máximo pode ser definido
  • Texto multilinha
    • Uma área de texto que pode ser Rich Text, Plain Text ou Markdown
  • Número
    • Adicionar um ou mais campos numéricos
  • Booleano
    • Adicionar uma caixa de seleção booleana
  • Data e hora
    • Adicionar uma data e/ou hora
  • Enumeração
    • Adicionar um conjunto de caixas de seleção, botões de opção ou campos suspensos
  • Tags
    • Permite que os autores de fragmentos acessem e selecionem áreas de tags
  • Referência de conteúdo

Propriedades

Muitas propriedades são autoexplicativas, para certas propriedades, mais detalhes são os seguintes:

  • Renderizar
    comoAs várias opções para realizar/renderizar o campo em um fragmento. Geralmente, isso permite definir se o autor verá uma única instância do campo ou poderá criar várias instâncias.

  • Rótulo
    do campoInserir um
    O Rótulo de campo gerará automaticamente um Nome de propriedade, que pode ser atualizado manualmente se necessário.

  • A validação
    ValidationBasic está disponível por mecanismos como a propriedade ​Requirements. Alguns tipos de dados têm campos de validação de adição. Consulte Validação para obter mais detalhes.

  • No tipo de dados Texto de várias linhas, é possível definir o Tipo padrão como:

    • Texto formatado
    • Markdown
    • Texto sem formatação

    Se não for especificado, o valor padrão Rich Text será usado para esse campo.

    Alterar o Tipo padrão em um modelo de fragmento de conteúdo só terá efeito em um fragmento de conteúdo existente relacionado depois que esse fragmento for aberto no editor e salvo.

Validação

Vários tipos de dados agora incluem a possibilidade de definir requisitos de validação para quando o conteúdo é inserido no fragmento resultante:

  • Texto em linha única
    • Compare com um regex predefinido.
  • Número
    • Verifique valores específicos.

Ativar ou desativar um modelo de fragmento de conteúdo

Para ter total controle sobre o uso dos Modelos de fragmento de conteúdo, eles têm um status que pode ser definido.

Habilitar um modelo de fragmento de conteúdo

Depois que um modelo é criado, ele precisa ser habilitado para que:

  • Está disponível para seleção ao criar um novo Fragmento de conteúdo.
  • Pode ser referenciado em um Modelo de fragmento de conteúdo.
  • Está disponível para GraphQL; então o schema é gerado.

Para habilitar um Modelo sinalizado como:

  • Rascunho : mew (nunca ativado).
  • Desativado : foi especificamente desativado.

Use a opção Ativar de:

  • A barra de ferramentas superior, quando o Modelo necessário for selecionado.
  • A Ação rápida correspondente (passe o mouse sobre o Modelo necessário).

Ativar um rascunho ou modelo desativado

Desabilitando um Modelo de Fragmento de Conteúdo

Um modelo também pode ser desativado para que:

  • O modelo não está mais disponível como base para a criação de novos Fragmentos de conteúdo.
  • No entanto:
    • O schema GraphQL continua sendo gerado e ainda pode ser consultado (para evitar o impacto da API JSON).
    • Todos os Fragmentos de conteúdo baseados no modelo ainda podem ser consultados e retornados do ponto de extremidade GraphQL.
  • O modelo não pode mais ser referenciado, mas as referências existentes são mantidas intocadas e ainda podem ser consultadas e retornadas do ponto final GraphQL.

Para desativar um Modelo sinalizado como Ativado, use a opção Desativar de:

  • A barra de ferramentas superior, quando o Modelo necessário for selecionado.
  • A Ação rápida correspondente (passe o mouse sobre o Modelo necessário).

Desativar um modelo ativado

Excluindo um modelo de fragmento de conteúdo

CUIDADO

A exclusão de um modelo de fragmento de conteúdo pode afetar fragmentos dependentes.

Para excluir um modelo de fragmento de conteúdo:

  1. Navegue até Ferramentas, Ativos e abra Modelos de fragmento de conteúdo.

  2. Navegue até a pasta que contém o modelo de fragmento do conteúdo.

  3. Selecione seu modelo, seguido por Excluir na barra de ferramentas.

    Observação

    Se o modelo for referenciado, um aviso será dado. Agir adequadamente.

Publicar um modelo de fragmento de conteúdo

Os modelos de fragmento de conteúdo precisam ser publicados quando/antes que qualquer fragmento de conteúdo dependente seja publicado.

Para publicar um modelo de fragmento de conteúdo:

  1. Navegue até Ferramentas, Ativos e abra Modelos de fragmento de conteúdo.

  2. Navegue até a pasta que contém o modelo de fragmento do conteúdo.

  3. Selecione seu modelo, seguido por Publicar na barra de ferramentas.
    O status publicado será indicado no console.

    Observação

    Se você publicar um fragmento de conteúdo para o qual o modelo ainda não foi publicado, uma lista de seleção indicará isso e o modelo será publicado com o fragmento.

Cancelamento de publicação de um modelo de fragmento de conteúdo

Os modelos de fragmento de conteúdo podem ser despublicados se não forem referenciados por nenhum fragmento.

Para cancelar a publicação de um modelo de fragmento de conteúdo:

  1. Navegue até Ferramentas, Ativos e abra Modelos de fragmento de conteúdo.

  2. Navegue até a pasta que contém o modelo de fragmento do conteúdo.

  3. Selecione seu modelo, seguido por Cancelar a publicação na barra de ferramentas.
    O status publicado será indicado no console.

Nesta página