Editoria11y para Drupal

Funcionalidades principais

O módulo Drupal conecta a biblioteca do verificador ao backend editorial e adiciona diversas ferramentas no servidor para relatórios, governança e configuração

Instalação e etapas essenciais de configuração

O instalador integrado no Drupal.org inclui vários módulos:

• Editoria11y: o verificador de conteúdo principal e o painel.
• Editoria11y CSA: testes para desenvolvedores e ferramentas de manutenção do painel.
• Editoria11y Export: ferramentas de relatórios em CSV.

Instale como qualquer outro módulo e, em seguida, execute estas etapas essenciais:

1. Verifique as permissões. Autores confiáveis devem ter "Mark OK," "Mark as Ignored" e "View the dashboard."
2. Verifique as páginas principais em busca de alertas repetitivos ou inúteis. Marque-os como OK na dica ou ajuste a configuração para ignorar elementos por seletor.
3. Procure dicas difíceis de visualizar — fora da tela, truncadas, atrás de outros elementos ou em elementos ocultos. Use as sugestões em "Corrigir posicionamento de dicas" abaixo para resolver.
4. Se o site já tiver conteúdo e você possuir uma assinatura CSA, acesse a aba "recheck" do painel e rastreie o site para pré-carregar os relatórios do site. Isso é opcional, mas páginas mais antigas não aparecerão nos relatórios até serem rastreadas ou visitadas por um usuário autenticado.

Assista a uma introdução em vídeo às opções de configuração (v2.4).

Ocultar alertas desnecessários

Boas configurações suprimem alertas inúteis, para que os autores de conteúdo possam focar nos problemas que precisam corrigir.

Embora seja possível desativar testes completamente, em geral é melhor ocultar alertas em elementos ou páginas específicos.

A cada execução de teste, o Editoria11y coleta um conjunto único de elementos a partir da configuração "Verificar conteúdo nestes contêineres" e o filtra várias vezes. Veja como funciona uma execução de teste:

1. Cancelar a verificação se a configuração impedir a execução nesta página ou para este usuário.
2. Coletar elementos nas regiões de página especificadas, p. ex.:
   body > *:not('.ed11y-element')
   Para usuários do Editoria11y CSA, estas são as regiões na aba Testes de desenvolvedor.
3. Descartar elementos que correspondam aos seletores de ignorar, p. ex.:
   .widgets, .utility-menu
   Para usuários do Editoria11y CSA, estes são os seletores na aba Testes de desenvolvedor.
4. Executar os testes e sincronizar os resultados com o painel.
5. Se a configuração dividida estiver ativa e o usuário for um editor de conteúdo, filtrar os resultados do desenvolvedor:
   • Descartar resultados de testes definidos como "Apenas para desenvolvedor."
   • Descartar resultados em elementos fora das regiões de conteúdo especificadas, p. ex.:
     main, footer
   • Descartar resultados em elementos que correspondam aos seletores de ignorar de conteúdo.
   Observe que não há uma segunda fase de "coleta". As regiões de página do desenvolvedor devem incluir as regiões de conteúdo.
6. Abrir o painel e exibir alertas se a configuração corresponder a uma configuração de abertura automática.

Dispensar alertas

Os testes podem ser configurados na biblioteca como erros ou avisos ("verificações manuais"). Os avisos podem ser dispensados. Há dois tipos de dispensa disponíveis no rodapé de cada dica:

• "Ignore" é armazenado como preferência do usuário: o alerta fica oculto apenas para o usuário atual.
• "Mark OK" oculta o alerta para todos os usuários.

A capacidade de um usuário dispensar um alerta é controlada no nível da função nas permissões de usuário do Drupal. A maioria dos autores deve ter permissão para dispensar alertas. Não faz sentido atribuir uma verificação manual a alguém que não pode marcar o item como verificado.

Ignorar elementos

Estas duas configurações são as mais importantes!

Defina o primeiro para incluir todas as partes da página que os autores de conteúdo podem editar. Por exemplo, se eles podem editar a área de conteúdo main, .sidebar e .footer-column-two, defina esses seletores como sua área de verificação de conteúdo.

Use o segundo para "excluir" subseções. Por exemplo, se main contém vários widgets e incorporações que apenas desenvolvedores podem modificar, liste-os: .widget-1, .social-embed;

Se você estiver usando a configuração dividida, verá um par semelhante de configurações na aba Testes de desenvolvedor:

O ponto essencial sobre as áreas de verificação do desenvolvedor é que elas não são independentes das áreas de verificação de conteúdo. Em uma configuração dividida, as áreas do desenvolvedor são verificadas e, em seguida, esses resultados são filtrados para corresponder às áreas de conteúdo. Qualquer área excluída para desenvolvedores também será excluída para editores de conteúdo. Não exclua áreas de conteúdo editáveis!

Alguns testes permitem uma configuração mais precisa, para ocultar apenas determinados alertas nos elementos afetados. Procure-os em:

• Testes de conteúdo: Links a verificar
• Testes de conteúdo: Incorporações a verificar
• Testes de conteúdo: Detecção de conteúdo dinâmico e shadow content
• Testes de desenvolvedor: Contraste

Ocultar em páginas ou usuários específicos

A maneira mais fácil de fazer isso é passando classes CSS ou IDs para estas opções:

A primeira opção impedirá a execução das verificações e a barra de ferramentas não será exibida.

A segunda iniciará o verificador minimizado e marcará automaticamente (para o usuário atual) todos os problemas como "Ignorados", mesmo que sejam erros. Isso permite que os testes sejam executados e atualizem o painel sem incomodar o usuário.

Se quiser usar essas opções para controlar quais usuários veem o verificador, pode ser necessário ajustar seu tema para gerar uma classe, p. ex. .user-247

Gerenciar resultados de todo o site

Corrigir dicas ocultas ou fora da tela

O módulo fornece campos para duas das opções de configuração da biblioteca para alterar como as dicas são posicionadas:

Alguns temas têm colunas ou widgets que ocultam o overflow horizontal ou vertical. A biblioteca detecta automaticamente quando um indicador ficaria fora da parte visível da página. Informar à biblioteca que determinados contêineres ocultam o overflow faz com que ela também tente posicionar as dicas para elementos nesses contêineres dentro de suas bordas.

Alguns temas têm widgets que alternam a visibilidade do conteúdo, como acordeões, abas e apresentações de slides. As dicas dentro desses elementos também ficam ocultas. Fornecer uma lista de seletores para esses widgets faz com que o Editoria11y pause brevemente quando um usuário tenta saltar para essas dicas usando um botão de próximo ou anterior. Os temas e módulos do Drupal podem então seguir as instruções da seção da biblioteca sobre como lidar com dicas em conteúdo oculto para revelar o conteúdo oculto.

Escreva sua própria configuração

Em PHP: o módulo Drupal fornece um hook_editoria11y_alter_config para alterar o conteúdo de drupalSettings.editoria11y em um módulo ou tema. Por exemplo:

Modificar drupalSettings só ajuda se o JS do módulo já estiver configurado para passar esse valor à biblioteca. Para adicionar parâmetros extras, você precisa modificar o objeto options do JS diretamente. O módulo verifica a existência de uma variável JS global chamada editoria11yOptionsOverride. Se ela estiver definida, o módulo passará o objeto options para uma função editoria11yOptions que você tiver criado no seu módulo ou tema. Agora você pode definir qualquer um dos parâmetros da biblioteca.