Editoria11y para Drupal

Funcionalidades principais

O módulo Drupal liga a biblioteca do verificador ao backend editorial e acrescenta várias ferramentas do lado do servidor para relatórios, governação e configuração

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

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

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

Instale como qualquer outro módulo e, em seguida, efetue estes passos essenciais:

1. Verifique as permissões. Os autores de confiança devem ter "Marcar como OK," "Marcar como ignorado" e "Ver o painel."
2. Verifique as páginas principais em busca de alertas repetitivos ou inúteis. Marque-os como OK na dica de ferramenta ou ajuste a configuração para ignorar elementos por seletor.
3. Procure sugestões difíceis de visualizar — fora do ecrã, truncadas, atrás de outros elementos ou em elementos ocultos. Utilize as dicas em "Corrigir posicionamento de sugestões" abaixo para resolver.
4. Se o sítio já tiver conteúdo e tiver uma subscrição CSA, aceda ao separador "reverificação" do painel e rastreie o sítio para pré-carregar os relatórios. Este passo é opcional, mas as páginas mais antigas não aparecerão nos relatórios até serem rastreadas ou visitadas por um utilizador autenticado.

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

Ocultar alertas inúteis

Boas configurações suprimem alertas inúteis, para que os autores de conteúdo possam concentrar-se nos problemas que devem corrigir.

Embora seja possível desativar testes por completo, geralmente é preferível ocultar alertas em elementos ou páginas específicos.

Em cada execução de testes, o Editoria11y reúne um único conjunto de elementos a partir da definição "Verificar conteúdo nestes contentores" e filtra-o várias vezes. Eis o aspeto de uma execução de testes:

1. Cancelar a verificação se a configuração impedir a verificação nesta página ou para este utilizador.
2. Recolher elementos nas regiões de página especificadas, por exemplo:
   body > *:not('.ed11y-element')
   Para utilizadores do Editoria11y CSA, estas são as regiões no separador Testes de programador.
3. Remover elementos que correspondam aos seletores de ignorar, por exemplo:
   .widgets, .utility-menu
   Para utilizadores do Editoria11y CSA, estes são os seletores no separador Testes de programador.
4. Executar testes e sincronizar resultados com o painel.
5. Se a configuração dividida estiver ativa e o utilizador for um editor de conteúdo, filtrar os resultados de programador:
   • Remover resultados de testes definidos como "Apenas para programadores."
   • Remover resultados em elementos fora das regiões de conteúdo especificadas, por exemplo:
     main, footer
   • Remover resultados em elementos que correspondam aos seletores de ignorar de conteúdo.
   Note que não existe uma segunda fase de "recolha". As regiões de página do programador devem incluir as regiões de conteúdo.
6. Abrir o painel e apresentar alertas se a configuração corresponder a uma definiçã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. Existem dois tipos de dispensa disponíveis no rodapé de cada dica de ferramenta:

• "Ignorar" fica guardado como preferência do utilizador: o alerta fica oculto para o utilizador atual, mas apenas para esse utilizador.
• "Marcar como OK" oculta o alerta para todos os utilizadores.

A capacidade de um utilizador dispensar um alerta é controlada ao nível da função nas permissões de utilizador do Drupal. A maioria dos autores deve poder 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 definições de configuração são as mais importantes!

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

Utilize o segundo para "excluir" subsecções. Por exemplo, se main contiver vários widgets e conteúdos incorporados que apenas os programadores podem modificar, liste-os: .widget-1, .social-embed;

Se estiver a utilizar a configuração dividida, verá um par semelhante de definições no separador Testes de Programador:

O aspeto mais importante a saber sobre as áreas de verificação de programador é que não são independentes das áreas de verificação de conteúdo. Numa configuração dividida, as áreas de programador são verificadas e os resultados são depois filtrados para corresponder às áreas de conteúdo. Quaisquer áreas excluídas para programadores também serão excluídas 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: Ligações a verificar
• Testes de conteúdo: Conteúdos incorporados a verificar
• Testes de conteúdo: Detetar conteúdo dinâmico e shadow content
• Testes de programador: Contraste

Ocultar para páginas ou utilizadores específicos

A forma mais simples de o fazer é passar classes CSS ou IDs a estas opções:

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

A segunda opção inicia o verificador minimizado e marca automaticamente (para o utilizador atual) todos os problemas como "Ignorado", mesmo que sejam erros. Isto permite que os testes sejam executados e atualizem o painel sem incomodar o utilizador.

Para utilizar estas opções no controlo dos utilizadores que vêem o verificador, poderá ter de ajustar o seu tema para que emita uma classe, por exemplo .user-247

Gerir resultados de todo o sítio

Corrigir sugestões ocultas ou fora do ecrã

O módulo disponibiliza campos para duas das opções de configuração da biblioteca, de modo a alterar o posicionamento das sugestões:

Alguns temas têm colunas ou widgets que ocultam o overflow horizontal ou vertical. A biblioteca deteta automaticamente quando um botão de alternância ficaria fora da parte visível da página. Ao informar a biblioteca de que determinados contentores ocultam o overflow, esta tentará também posicionar as sugestões para elementos nesses contentores dentro das suas margens.

Alguns temas têm widgets que alternam a visibilidade do conteúdo, tais como acordeões, separadores e apresentações de diapositivos. As sugestões dentro destes elementos também ficarão ocultas. Ao fornecer uma lista de seletores para estes widgets, o Editoria11y fará uma breve pausa quando um utilizador tentar saltar para essas sugestões utilizando um botão de avançar ou recuar. Os temas e módulos Drupal podem então seguir as instruções da secção da biblioteca sobre como lidar com sugestões em conteúdo oculto para revelar o conteúdo oculto.

Escrever a sua própria configuração

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

Modificar drupalSettings só é útil se o JS do módulo já estiver configurado para passar esse valor à biblioteca. Para adicionar parâmetros adicionais, é necessário modificar o objeto JS options diretamente. O módulo verifica a existência de uma variável JS global chamada editoria11yOptionsOverride. Se estiver definida, passará o objeto options a uma função editoria11yOptions que tenha fornecido no seu módulo ou tema. Pode agora definir qualquer um dos parâmetros da biblioteca.