DocumentaçãoAEM GuidesDocumentação do AEM Guides

Controle da qualidade do conteúdo no editor da Web

Last update: Fri Jul 12 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • Tópicos:

Criado para:

  • undefined
  • undefined

Este artigo fornece uma visão geral das possibilidades de validação no editor da Web do AEM Guides.
Por design, o editor da Web aproveita a configuração do esquema DITA no sistema para forçar os usuários a criar conteúdo compatível com DITA. Com isso, todo o conteúdo armazenado no sistema é estruturado, reutilizável e válido conteúdo DITA.

Além do suporte para regras DITA, o editor da Web também oferece suporte à validação de conteúdo com base nas regras "Schematron".

"Schematron" refere-se a uma linguagem de validação baseada em regras usada para definir testes para um arquivo XML. É possível importar os arquivos do Schematron e editá-los no Editor da Web. Usando um arquivo de "Esquematron", você pode definir determinadas regras e validá-las para um tópico DITA ou um mapa. As regras de esquema podem garantir a consistência da estrutura XML, impondo restrições definidas como regras. Estas restrições são impostas por PME que detêm a qualidade e a coerência do conteúdo.

OBSERVAÇÃO: o editor da Web oferece suporte ao Esquematron ISO.

Saber como o "Schematron" funciona no editor da Web

Configuração de regras do Schematron

Consulte a seção "Suporte para arquivos do Schematron" no Guia do Usuário

Aplicar regras de validação ao salvar arquivo

As configurações do Editor da Web permitem que os usuários avançados configurem regras/arquivos de esquema que serão executados sempre que um usuário atualizar o conteúdo. Para obter mais detalhes, consulte a seção "Validação" no Guia do Usuário

Definir regras nas configurações do editor da Web

Você pode executar a validação manualmente?

Sim, como autor/usuário ao criar conteúdo, você pode usar o painel Esquematron no editor da Web para fazer upload de um arquivo de esquematron e executar validações no arquivo aberto no editor.

Para que isso funcione, o administrador de perfil da pasta deve permitir que todos os usuários adicionem arquivos do Schemtron no painel Validação. Ver configurações do editor (captura de tela fornecida acima)

Escolher arquivo do Schematron
Executar validação

Regras compatíveis

A versão atual da validação de suporte do AEM Guides usa somente regras baseadas em "Asserção". (consulte ativo vs. relatório)
Quaisquer regras baseadas em "Relatórios" ainda não são compatíveis.

Exemplos e mais ajuda sobre as regras do Schematron

Casos de uso de exemplo

  • Verifique se um link é externo e se tem escopo "externo"

    code language-none 
    <sch:pattern>
    <sch:rule context="xref[contains(@href, 'http') or contains(@href, 'https')]">
        <sch:assert test="@scope = 'external' and @format = 'html'">
            All external xref links must be with scope='external' and format='html'
        </sch:assert>
    </sch:rule>
</sch:pattern>

  • Verifique se há pelo menos um "topicref" em um mapa ou pelo menos um "li" em um "ul"

    code language-none 
    <sch:pattern>
    <sch:rule context="map">
        <sch:assert test="count(topicref) > 0">
            There should be atleast one topicref in map
        </sch:assert>
    </sch:rule>

    <sch:rule context="ul">
        <sch:assert test="count(li) > 1" >
            A list must have more than one item.
        </sch:assert>
    </sch:rule>
</sch:pattern>

  • O elemento "indexterm" deve estar sempre presente em um "prólogo"

    code language-none 
    <sch:pattern>
    <sch:rule context="*[contains(@class, ' topic/indexterm ')]">
        <sch:assert test="ancestor::node()/local-name() = 'prolog'">
            The indexterm element should be in a prolog.
        </sch:assert>
    </sch:rule>
</sch:pattern>

Recursos

recommendation-more-help
11125c99-e1a1-4369-b5d7-fb3098b9b178