Esta é a tradução do artigo "Making your website valid: a step by step guide." de autoria de Olivier Thereaux publicado no site do W3C.
1. A versão oficial e original, em inglês, deste artigo, encontra-se em: http://www.w3.org/QA/2002/09/Step-by-step e os seus direitos são conforme:
Copyright ©2002 W3C® (MIT, INRIA, Keio), Todos os direitos reservados. São aplicáveis as disposições do W3C relativas a responsabilidade, marcas, uso de documentos e licença de software
2. A única versão oficial deste documento é a versão em língua inglesa que se encontra no sítio do W3C.
3. O presente documento traduzido para a língua portuguesa do Brasil, pode conter erros de tradução.
Este documento foi traduzido em 20 de dezembro de 2004 por: Maurício Samy Silva e encontra-se hospedado no seu sítio "CSS para WebDesign" em http://www.maujor.com/
A traduçao foi feita somente para este documento, vale dizer, as páginas remetidas pelos links aqui indicados, estão em sua versão original em língua inglesa.
Para desenvolver este artigo, vamos admitir por hipótese que um webmaster pretenda transformar um site todo ele em conformidade com as web standards ((X)HTML válido, CSS válida, etc.) Este artigo descreve a maneira usual de se resolver este problema, bem como sugerir a utilização de uma ferramenta desenvolvida pelo W3C's QA activity para auxiliar nesta tarefa.
Este artigo foi escrito para fazer parte das publicações do grupo de trabalho Quality Assurance Interest Group do W3C. Qualquer comentário sobre este artigo poderá ser enviado para um arquivo público através da lista de discussão public-evangelist@w3.org ou via uma mensagem privada para ot@w3.org.
Criar um Web site --um que esteja em conformidade com as standards para HTML, CSS, ou as regras da Web Acessibilidade --, é a coisa certa a se fazer, e é também uma escolha vantajosa.
Documentação técnica e ferramentas estão a sua disposição para ajudá-lo a criar um Web site em conformidade com as Web standards, trazendo como resultado um site com grande audiência, otimizando custos de desenvolvimento e facilitando as tarefas de manutenção.
Contudo, é difícil a decisão de se transformar um site existente para um site em conformidade com as standards. Seu site já está implementado, existem documentos em várias formas e sem manutenção ou talvez seu site faça uso de múltiplas formatações para os documentos o que dificulta a atualização. Seu site talvez se baseie em um projeto bem definido e faça uso de tecnologias flexíveis o que simplificará a tarefa, contudo em qualquer caso, atualizá-lo demandará o concurso de uma equipe de especialistas.
Os recursos a disponibilizar e como disponibilizá-los, vão depender do método que você escolher para a atualização do site.
Existem dois métodos tradicionais para transformar um Web site existente em um em conformidade com as standards: começar tudo de novo (método errado), ou alterar manualmente cada página e validá-la (método árduo). Para administradores TI nenhum deles é muito atrativo, tornando difícil a decisão de migrar o site para web standards: simplesmente parece que não há valor em dispensar tantas horas de trabalho para realizar a tarefa.
Depois de termos examinado com detalhes estes dois métodos (analizando porquê eles estão errados), vamos ver um terceiro método bem melhor: atualizar sistematicamente uma seção do site por vez.
Abandonar tudo que já existe e começar do zero não é a solução. Este é um método errado.
Este método é tentador pela liberdade que proporciona ao se começar a desenvolver o trabalho em um framework limpo. Contudo além de aumentar os custos inerentes a um redesign completo este método acaba por trazer problemas adicionais, começando com quebra de links.
O método usual é também o mais árduo: o administrador do site relaciona todos os recursos utilizados (identificar as tecnologias empregadas possibilita este leventamento), e lançando mão das ferramentas de "validação" tais como o validador de HTML e o validador das CSS, ou ainda através de filtros corretivos (como o HTML Tidy), checa os documentos, seja um a um seja por lotes.
Este método tem uma série de vantagens e não está expostos a riscos como os vistos para o método anterior. Contudo para sites com milhares de documentos implica em um enorme trabalho e torná-se inviável se pelo menos não houver uma excelente organização. Descobrir por onde começar já é uma questão complicada quando se trata de checar o site.
Não existe um método perfeito para compatibilizar um site, porém alguns são melhores e mais fáceis que outros. Valendo-se do uso das ferramentas que mostrarei a seguir, vou explicar uma maneira relativamente fácil de realizar a tarefa e que acredito seja bastante apropriada.
Este método, infelizmente tem suas limitações: ele é melhor aplicável para conteúdos estáticos ou conteúdos gerados dinamicamente quando você tem controle sobre os templates.
Se você está impedido de gerenciar os templates e eles geram marcação inválida, então nós o incentivamos a enviar um relatório de bugs ao fabricante do software ou ao administrador do gerenciador de conteúdos.
"O método árduo ", sem dúvida é o melhor a utilizar quando tem-se recursos suficientes para dedicar à tarefa. No "mundo real" excetuando-se os casos de pequenos sites este método não é aplicável, a menos que você opte por um processo gradual e metódico.
Com um planejamento cuidadoso e uma disponibilidade de tempo distendida, você pode eventualmente valer-se deste método. Este método requer gerenciamento minucioso com arquivos sendo validados a intervalos de tempo regulares e todas as novas implementações válidas também.
A quantidade (variedade) de tecnologias a validar em cada etapa depende do volume de conteúdos (e da porcentagem de documentos inválidos). Faça para você mesmo as seguintes perguntas quando for dimensionar a alocação de recursos:
Ainda não fizemos qualquer menção ao estabelecimento de datas para o trabalho. Na maioria dos casos você provavelmente não terá idéia da quantidade de documentos inválidos no seu site e talvez nem mesmo saiba qual o total de documentos existentes no site. Como estimar o tempo de trabalho sem estas informações?
Certamente, como em qualquer outro projeto, seu projeto de validação precisa estabelecer metas e prazos. Uma meta que você poderá estabelecer antes mesmo de iniciar seu projeto é: "qual é a percentagem aceitável de documentos inválidos no site?" Se o site é de pequeno ou médio porte sua resposta poderá ser "zero", contudo se o site é grande, sugerimos que você estabeleça um número mais modesto, 10% por exemplo.
Uma vez dimensionada a quantidade de recursos a alocar e estabelecida uma meta a atingir, os próximos rounds do "método passo-a-passo" vão possibilitar a que você tenha uma idéia do tempo necessário para atingir a meta estabelecida. Você estará então com novos dados que permitirão reavaliar a quantidade de tempo estimada e a meta estabelecida.
A seguir um exemplo bem simples para explicar as decisões baseadas no tráfego dos documentos.
Imagine 4 documentos no site (vamos chamá-los de 1,2,3 e 4), responsáveis respectivamente por 40%, 30%, 20% e 10% do tráfego do site.
Imagine que os documentos 1 e 4 são inválidos. Ou seja, 50% dos documentos, e 50% do tráfego é inválido, isto é ruim. Se você dispõe de tempo para corrigir ambos os documentos, ótimo, mas se o tempo for para apenas um, qual deles corrigir?
Sem outras considerações, normalmente poderíamos afirmar que corrigindo qualquer um deles baixaríamos para 25% os documentos inválidos. Baseados no tráfego dos documentos seríamos levados a decidir por validar o documento 1 e com isto tornar 90% do trafégo válido.
Isto é uma análise considerando custo-benifício: face a uma quantidade limitada de recursos, promova as melhorias que tragam melhores resultados.
As decisões baseadas no tráfego dos documentos são também a melhor maneira para se avaliar a qualidade de um site. Como veremos na seção a seguir, para um site qualquer (com uma quantidade desconhecida de documentos, mas cujos logs de acesso tenham sido registrados), o LogValidator classifica os documentos servidos durante um período de tempo por sua popularidade (tráfego) e tenta encontrar X documentos inválidos entre os mais populares.
Vamos imaginar o caso em que 100 documentos tenham sido servidos. A ferramenta (logValidator) examina 20 documentos para encontrar 2 documentos HTML inválidos (considere que nós setamos X=2, por exemplo). Estes 20 documentos são responsáveis por 45% do tráfego. A tabela abaixo fornece uma estimativa da qualidade do site (sob o ponto de vista de HTML válido), com "base em arquivos" ("file approach") e com "base em tráfego" ("traffic approach").
| Baseado em arquivos (Using the file approach) | Baseado no tráfego (Using the traffic approach) | |||
|---|---|---|---|---|
| Estimativa pessimista | Estimativa otimista | Estimativa pessimista | Estimativa otimista | |
| Antes da validação dos 2 documentos | 18% | 98% | 40.5% (45*18/20)% | 95.5% ((45*18/20)% +55%) |
| Após a validação dos 2 documentos | 20% | 100% | 45% | 100% |
As estimativas "baseadas em arquivo" são vagas e não confiáveis ao passo que as baseadas no tráfego são mais precisas. Uma vez que você tenha corrigido os 2 documentos e recomece o processo usando o LogValidator as estimativas vão se tornando mais precisas (e assim gradativamente, à medida que mais tráfego seja validado!)
A seguir vamos a um exemplo prático desta estratégia de correção da marcação usando um conjunto limitado de ferreamentas (de uso livre) com a finalidade de validar um site contra o HTML. Como já foi dito anteriormente, HTML é apenas um exemplo, você pode usar a técnica descrita a seguir (e algumas das ferramentas) para muitos outras casos de validação.
O LogValidator é a primeira (se não a única) ferramenta que você precisará. Você pode fazer o download aqui livremente e instalar em qualquer sistema rodando Perl (o seu servidor Web certamente estará).
Você precisará de alguns poucos outros componentes necessários para rodar o LogValidator. Este podem também ser baixados livremente.
Se você não é um expert em HTML, e marcação correta não é seu hobby, use o tidy para corrigir a marcação. Tidy é uma ferramenta (semi-)automática para correção de marcação e está disponível para variadas plataformas.
O LogValidator checará seu documento com o Validador de marcação online do W3C. Se o seu site é muito grande ou mesmo se você preferir economizar largura de banda, poderá instalar o validador localmente.
Para continuar vamos supor que você instalou o LogValidator, e que leu detalhadamente o seu Manual.
Primeiramente você precisa configurar um arquivo com set up idêntico ao do seu servidor. Para isto, você precisa (essencialmente) ter acesso ao arquivo de logs do seu servidor Web (este arquivo será usado para processar as estatísticas do tráfego). Facilmente você seta este arquivo, copiando o exemplo de configuração que vem com a ferramenta e editando-o como explicado no Manual.
Uma vez feito isto pode-se rodar o LogValidator. Não configure um número muito alto para os resultados, 10 é suficiente para começar o trabalho.
Você deverá ter como resultado uma lista com os 10 "mais populares" documentos inválidos. Dispense um tempo para analizar os resultados. Agora você poderá submeter estes arquivos ao Validador de marcação para identificar os lugares onde há marcação errada. Se você usou templates, há alguma coisa errada com eles? Podem os templates ser chacados com o validador?
A seguir, corrija o primeiro documento listado. Lembre-se que estes documentos são os de maior tráfego do seu site e que não são válidos, portanto este passo de correção é muito importante. Este primeiro passo pode tornar-se bastante difícil, principalmente se a lista contém documentos muito extensos. Tidy pode ajudá-lo nesta tarefa de correção. Alternativamente você pode procurar na Web diretrizes e regras para correção de marcação e também encontrar pessoas que possam orientá-lo na tarefa.
Por exemplo, se você não entendeu uma mensagem de erro do validador, procure nesta documentação ou consulte na lista pública www-validator@w3.org.
Conseguiu? Parabéns! Você agora poderá configurar o LogValidator para "rodar" semanal, diária ou mensalmente (veja as dicas para configurar isto), e reiniciar o ciclo com outros documentos...
Mantenha seu trabalho organizado. Se você tem um site muito grande com documentos estáticos, a chance de você atingir 100% de páginas válidas é pequena, mas isto é perfeitamente aceitável. Decorrido algum tempo, as páginas não válidas remanescentes terão um peso insignificante.
Muito obrigado a Kim Nylander pela revisão e proveitosas sugestões.
Obrigado a Karl Dubost e Dominique Hazael-Massieux do W3C, pelos comentários e sugestões.