Escolar Documentos
Profissional Documentos
Cultura Documentos
Cartilha de Codificao
Verso 2.1
Julho de 2010
48 p.: color.
1. Informtica - codificao de paginas 2. Sites da Web Projetos. 3. Sites na Web - Desenvolvimento 4. Programao
para Internet 5. Informtica - Servio Pblico I. Ttulo.
CDU 004.5:35
CDD 004.678
Esta obra foi licenciada com uma Licena Creative Commons - Atribuio Partilha nos Mesmos Termos 3.0 No Adaptada
http://creativecommons.org/licenses/by-sa/3.0/br/
Voc tem a liberdade de:
Atribuio Voc deve creditar a obra da forma especificada pelo autor ou licenciante (mas no
de maneira que sugira que estes concedem qualquer aval a voc ou ao seu uso da obra).
Compartilhamento pela mesma licena Se voc alterar, transformar ou criar em cima desta
obra, voc poder distribuir a obra resultante apenas sob a mesma licena, ou sob uma licena
similar presente.
Renncia Qualquer das condies acima pode ser renunciada se voc obtiver permisso do
titular dos direitos autorais.
Domnio Pblico Onde a obra ou qualquer de seus elementos estiver em domnio pblico sob o
direito aplicvel, esta condio no , de maneira alguma, afetada pela licena.
Outros Direitos Os seguintes direitos no so, de maneira alguma, afetados pela licena:
Direitos que outras pessoas podem ter sobre a obra ou sobre a utilizao da obra, tais como
direitos de imagem ou privacidade.
Aviso Para qualquer reutilizao ou distribuio, voc deve deixar claro a terceiros os termos da
licena a que se encontra submetida esta obra.
Agradecimentos
ndice
Padres Web em Governo Eletrnico e-PWG.......................................................5
Objetivos desse Guia.......................................................................................5
Responsabilidade e manuteno.......................................................................6
1. Introduo.....................................................................................................7
1.1 Diretrizes..................................................................................................8
2. Padres Web..................................................................................................9
2.1 Cdigo em camadas..................................................................................11
2.2 HTML e XHTML.........................................................................................12
2.3 CSS (cascating style sheets)......................................................................13
3. Recomendaes ...........................................................................................17
3.1 Recomendaes gerais..............................................................................17
3.2 Elementos do cabealho............................................................................21
3.3 Corpo..................................................................................................... 24
3.4 Folhas de estilo........................................................................................27
3.5 Uso de scripts e cookies............................................................................ 30
3.6 Arquivos em outros formatos e uso de plugins............................................. 31
4. Orientaes gerais sobre testes ..................................................................... 33
4.1 Validao................................................................................................ 33
4.2 Resolues de vdeo................................................................................. 33
4.3 Navegadores e sistema............................................................................. 33
4.4 Outros dispositivos................................................................................... 34
4.5 Teste em camadas....................................................................................35
4.6 Teste de acessibilidade..............................................................................35
5. Problemas mais comuns................................................................................ 37
6. Lista de verificao....................................................................................... 40
7. Lista de formatos de arquivos e plugins........................................................... 41
8. Recursos.....................................................................................................45
9. Leitura Complementar...................................................................................48
10. Glossrio...................................................................................................49
Responsabilidade e manuteno
A manuteno desse documento responsabilidade do Departamento de Governo
Eletrnico - DGE. Questes sobre aspectos desse documento devem ser enviados para
padroesegov@governoeletronico.gov.br
1. Introduo
As Tecnologias de Informao e Comunicao (TICs) so instrumentos cada vez mais
importantes no desenvolvimento de ferramentas que melhorem a prestao de
servios e a disponibilizao de informaes primordiais para os cidados. A adoo
dessas tecnologias permite o aumento da eficcia, da eficincia e da transparncia
governamental.
A adoo de meios eletrnicos para a prestao dos servios governamentais exige
que os stios e portais desenvolvidos e mantidos pela administrao pblica sejam
fceis de usar, relevantes e efetivos. Somente por meio da eficincia possvel
aumentar a satisfao dos usurios de servios eletrnicos e conquistar,
gradativamente, uma parcela cada vez maior da populao.
, portanto, responsabilidade da administrao pblica oferecer ao cidado, a
melhor experincia possvel de acesso ao governo eletrnico, respeitando
inclusive, as particularidades da populao atingida.
Entre os vrios aspectos relacionados ao uso da Internet para a prestao de servios
por meios eletrnicos, destaca-se a questo da codificao de pginas dos stios e
portais que deve seguir os padres Web e de boas prticas de implementao, para
garantir seu desenvolvimento estruturado e evolutivo.
Stios e portais que seguem as melhores recomendaes de codificao so mais geis
e versteis, alm de oferecer facilidades para o transporte das mesmas solues para
outros meios eletrnicos como aparelhos celulares, computadores de mo e outros. A
soluo dos problemas mais comuns de formatao gera ganhos imediatos e, em
geral, custa muito pouco para resolver.
para orientar e facilitar o desenvolvimento de stios e portais governamentais
seguindo as melhores prticas da Web que o Departamento de Governo Eletrnico
(DGE) lana esse guia.Trata-se de uma primeira verso que reflete um acmulo de
conhecimento e experincias difundidas internacionalmente at o momento. Assim,
esse documento se oferece, sobretudo como uma referncia para o debate e
contribuies que devero ser incorporadas s prximas verses.
1.1 Diretrizes
As orientaes desse guia seguem quatro diretrizes:
Pginas leves
As pginas devem ter preferencialmente at 50 kb, somados cdigo, contedo
e imagens. Recomenda-se que as pginas no ultrapassem 70kb de tamanho.
2. Padres Web
Padres Web so especificaes abertas estabelecidas pelo W3C que so utilizadas
para criar e interpretar o contedo web. Essas tecnologias so desenvolvidas prevendo
a acessibilidade desses documentos ao maior grupo de indivduos possvel.
Quando um documento segue os padres web, significa que:
10
DE
CONTEDO
DE APRESENTAO
A camada de apresentao a parte visual do contedo. Ela deve ser construda aps
a camada de contedo. A camada de apresentao utiliza as linguagens CSS e XSLT.
O desenvolvimento da camada de apresentao deve primar pela simplicidade. Devese evitar propriedades que causem problemas em dispositivos ou alterar a camada de
contedo apenas para satisfazer uma necessidade especfica da apresentao.
O resultado da apresentao deve ser testado em diversos navegadores,
principalmente os mais usados. Para maiores detalhes veja o captulo Orientaes
gerais sobre testes.
11
DE
COMPORTAMENTO
No exemplo acima <p> uma tag de abertura de pargrafo e </p> uma tag de
fechamento. H elementos que no utilizam tags de fechamento, como o IMG <img>,
por exemplo. Todos os elementos podem ter atributos. Os atributos definem uma
propriedade do elemento, so colocados sempre na tag de abertura logo aps o nome
do elemento.
Ex: o atributo alt que indica a substituio da imagem pelo texto alternativo.
<img src="/img/bandeira.png" alt="A bandeira do Brasil">.
12
Nenhum atributo pode ser abreviado: Em HTML alguns atributos podem ser
minimizados, mas em XHTML isso no permitido.
errado: <input type="checkbox" id="checkbox1" name="checkbox1"
checked>
certo:
checked="checked" />
Alguns elementos
13
SINTAXE CSS
Uma regra CSS consiste em um seletor com uma ou mais declaraes. O seletor
determina qual elemento HTML afetado pela regra. Cada declarao consiste em
uma propriedade e seu valor. O bloco de declarao encapsulado por chaves { } e
cada declarao encerrada por um ponto-e-vrgula ;
EX: h1 { font-weight:bold; color: #fc0; }
Onde: h1 o seletor que significa que a regra afeta o elemento <h1>, a regra contm
duas declaraes que indicam que o elemento est em negrito e tem a cor laranja.
MEDIA TYPES
possvel, atravs dos media type, criar uma folha de estilos para cada dispositivo
que o usurio for acessar, otimizando a apresentao para cada dispositivo.
A especificao prev diversos dispositivos, nem todos com implementao plena:
screen computadores;
print impressoras;
tv televises;
14
CHAMADAS
DE
CSS
A chamada de vrias folhas de estilo para diferentes dispositivos pode ser feita das
seguintes formas:
15
Interna Utilizando o @media. Nessa caso pode ser construdo tanto dentro
do documento HTML (no recomendado) quanto dentro do documento CSS.
No HTML
<style>
@media screen { p {font-family:verdana,sans-serif; font-size:1em;}}
@media print { p {font-family:times,serif; font-size:10pt;}}
</style>
No CSS
@media screen {p {font-family:verdana,sans-serif; font-size:1em;}}
@media print { p { font-family:times,serif; font-size:10pt;}}
16
3. Recomendaes
As recomendaes oferecem um grupo abrangente de boas prticas para o
desenvolvimento da codificao, levando em conta as necessidades de acessibilidade e
usabilidade. As recomendaes esto separadas em: gerais; para o cabealho; para o
corpo do documento; para a apresentao do documento e para utilizao de outros
formatos.
17
O texto, o contedo principal, nunca deve ser cortado ou de alguma forma prejudicado
na impresso.
O CSS tem uma folha prpria para impresso, atravs da media type print, prevendo
margens, mudana do valor de pixel para pontos, mudana de fonte e quebras de
pgina. Para a criao de folhas de estilo para impresso consulte a especificao
CSS no stio do W3C.
18
6. Documente o cdigo.
O cdigo deve ser documentado de forma que qualquer membro da equipe consiga
entend-lo. Blocos de informao devem ser separados com comentrios.
Comentrio (X)HTML
<!-- isso um comentrio html -->
Comentrio CSS
/* isso um comentario css */
19
<div id="main">
<div class="maincontent">
<p class="maincontenttext">O texto.</p>
</div>
</div>
20
Ex:
HTML 4.01 Strict
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01//EN"
"http://www.w3.org/TR/html4/strict.dtd">
Ex:
HTML 4.01 Transitional
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
21
Ex:
HTML 4.01 Strict Frameset
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN"
"http://www.w3.org/TR/html4/frameset.dtd">
22
23
Para HTML ou XHTML pode-se usar a tag <meta> dentro do cabealho <head> do
documento. Sendo que em XHTML, deve-se colocar uma barra "/" no final.
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" >
<meta http-equiv="Content-Type" content="text/html;charset=utf-8" / >
3.3 Corpo
1. Utilize os elementos corretos para a marcao do cdigo.
Utilize os elementos de marcao de acordo com a sua finalidade. Para marcar ttulos
utilize <h1>, <h2>, <h3>, <h4>, <h5> ou <h6> dependendo do nvel do ttulo ou
subttulo, sendo <h1> o ttulo mais alto. Use o elemento <p> para demarcar os
pargrafos. No crie classes de CSS para apresentar um elemento em um formato no
condizente com seu objetivo.
EX: Um ttulo de nvel dois.
Errado:
<div id="main">
<p class="titulosec">
O subttulo
</p>
</div>
24
Lista Sem Ordem (unordered list Tag UL): Utilizar quando a necessidade
for listar itens sem uma ordem de colocao. a forma ideal para a codificao
de menus e barras de navegao.
Ex:
<ul>
<li>Quem somos</li>
<li>Projetos</li>
<li>Servios</li>
</ul>
Lista de Definies (definition list tags DL, DT e DD): Tem por objetivo
exibir uma lista de itens e suas respectivas definies. A lista de definies
possui duas partes distintas. O termo a ser definido ou descrito (tag DT), e a
descrio propriamente dita (tag DD). o formato ideal para glossrios.
25
Ex:
<dl>
<dt>Navegador</dt>
<dd>Programa que permite ao usurio consultar e interagir com o material
publicado na Internet. </dd>
<dt>Padres Web (Web standards)</dt>
<dd>Padres Web so regras de tecnologia definidos pelo W3C e outros
rgos da rea utilizados para criar e interpretar o contedo Web.</dd>
</dl>
26
Um formulrio bem estruturado recebe, sem problemas, sua formatao via CSS.
Para maiores detalhes da marcao acessvel em formulrios consulte a cartilha
tcnica do e-MAG.
*/}
*/}
*/}
*/}
27
4. Ordem e organizao.
Organize a folha de estilos de forma que ela faa sentido aos diversos
desenvolvedores do projeto. Crie blocos de regras lgicos, separados por comentrios
no incio e no final de cada um. Uma lista lgica de regras pode ser separada da
seguinte forma:
1. Regras para estrutura geral do cdigo (*, html, body, cabecalho, rodap, etc);
2. Regras para navegao;
3. Regras para as divs na ordem que aparecem no cdigo;
4. Regras gerais para seletores (H1, H2, etc...);
5. Regras para links;
6. Regras CSS para listas;
7. Regras CSS para elementos dentro das divs;
8. Regras CSS para classes gerais;
9. Outras regras;
Dentro de cada regra defina uma ordem de propriedades (ex: alfabtica) e mantenha
essa ordem para todos os seletores.
Abrevie as regras CSS para as propriedades que assim as admitem. Algumas
propriedades como margin e padding permitem que se abrevie seus valores, seguindo
sempre a ordem de topo, direita, fundo e esquerda:
EX: Dada a declarao:
#contedo {
margin-top: 10px;
margin-right: 8px;
margin-bottom: 0;
margin-left: 20px;
}
Ela pode ser abreviada da seguinte forma:
#contedo {margin: 10px 8px 0 20px; }
Especifique sempre unidades para valores no iguais a zero. O CSS requer que se
especifique as unidades (pixels, ems, percentagem, etc...) em propriedades como
padding, width, height e font-size. A exceo quando esse valor igual a zero (ex:
28
padding=0;). Nesse caso zero zero e no importa que unidade esteja sendo
utilizada.
Links e suas pseudo-classes devem ter regras CSS declaradas em ordem correta para
funcionarem corretamente:
1.
2.
3.
4.
29
alternativas. Uma famlia de trs fontes, terminando com uma genrica o ideal.
Deve-se testar o desenho com as fontes alternativas para verificar se h problemas de
leitura.
EX:
30
31
32
4.1 Validao
Validao a verificao que se faz para saber se um documento obedece s regras
de linguagem em que foi escrito. Pode-se comparar a validao com a busca por
erros gramaticais e de concordncia em um texto escrito.
As ferramentas de validao permitem verificar no-conformidades no cdigo ou CSS
e til para o diagnstico de erros no cdigo que podem estar interferindo em seu
funcionamento. No entanto, a validao no garante a qualidade da marcao, nem
previne o uso inadequado e o abuso de tags.
Alm das ferramentas de validao para verificao do cdigo, existem outras que
aferem a acessibilidade do contedo.
Para uma lista de alguns validadores disponveis consulte o captulo Recursos.
33
34
Uma forma de ofertar o servio de forma diferenciada para esse novo meio o uso de
folhas de estilo (CSS).
Para uma consulta sobre folhas de estilo prprias para cada meio consulte o Captulo
3 Padres Web 3.4 CSS. Para ferramentas de teste veja o captulo Recursos.
Visualizao de impresso
Esse um teste relativamente simples, mas que no deve ser negligenciado. Deve-se
verificar se o contedo central do documento foi impresso satisfatoriamente, se no
h desperdcio de tinta ou papel para o usurio.
35
36
DO
MODELO
37
CUIDADOS
Substituir textos escritos em ttulos e cabealhos por imagens utilizando-se para tanto
das propriedades text-indent e background-image do CSS, visando uma melhoria
esttica da pgina um recurso bastante utilizado no desenho de pginas.
No entanto esse recurso costuma apresentar problemas nos casos em que no
navegador, as imagens esto desabilitadas, mas a folha de estilo est ativa. A forma
encontrada at o momento a adio da tag SPAN vazia e o uso do atributo title.
Para evitar que o mesmo problema ocorra nos leitores de tela, deve-se utilizar a
media screen na chamada da folha de estilos.
Cdigo HTML
<h1 id="cabecalho" title=Governo Federal>
<span></span>Governo Federal</h1>
CSS
#cabecalho {
width: 329px;
height: 25px;
position: relative;
}
#cabecalho span {
background: url(tituloemimagem.gif) no-repeat;
position: absolute;
width: 100%;
height: 100%;
}
LAPSO
NA RENDERIZAO DO
IE
Por vezes, quando se utiliza a regra @import para CSS externo, o Internet Explorer
por um lapso de tempo pisca o contedo sem a renderizao do CSS.
Esse problema facilmente contornado utilizando o elemento LINK ou SCRIPT dentro
do cabealho <HEAD></HEAD>. Outras duas formas de solucionar o lapso da
renderizao so:
Padres Web em Governo Eletrnico e-PWG Cartilha de Codificao
38
39
6. Lista de verificao
A lista de verificao um recurso para avaliar se as recomendaes esto sendo
seguidas no desenvolvimento, evoluo ou manuteno do stio ou portal:
1.
2.
3.
4.
5.
6.
7.
H links quebrados?
8.
9.
40
DE TEXTO
41
TABULAO
DE DADOS
FORMATOS
DE APRESENTAO
DE IMAGEM
42
FORMATOS
DE COMPRESSO
ZIP (.zip)
O ZIP um dos formatos de compresso mais popular. Um arquivo ZIP contm um ou
mais arquivos que podem estar organizados em pastas e subpastas. Ao descompactar
o arquivo ZIP o usurio tem acesso aos arquivos na sua formatao e organizao
original. Existem diversos programas que criam e extraem contedos de arquivos ZIP.
Alguns so gratuitos outros pagos.
Roshal ARchive (.rar)
O RAR um formato proprietrio de compactao de arquivos. Tem como principais
caractersticas a alta taxa de compresso e o suporte a arquivos grandes (mais de 4
Gb).
MULTIMDIA
Independentemente da escolha do formato multimdia, devem ser fornecidas verses
acessveis para o contedo: trilhas de udio e legenda para vdeos, verses
alternativas em HTML, etc.
43
44
8. Recursos
ORGANIZAES
E ESPECIFICAES
DE CDIGO
DE ACESSIBILIDADE
http://www.governoeletronico.gov.br
http://www.acessobrasil.org.br
DE TELA
45
DISPOSITIVOS
MVEIS
TIPO
TEXTO
DE IMPRESSES DE NAVEGADOR
DE ARQUIVOS E PLUGINS
ANLISE
DE PERFORMANCE
YSlow - http://developer.yahoo.com/yslow/
Anlise de performance de carregamento da pgina e dicas para melhor-la.
46
EDITORES (X)HTML
CSS
EXTENSES FIREFOX
Extenses (extensions) so pequenos programas que adicionam funcionalidades ao
Firefox. Para ter acesso as extenses, basta ir a Ferramentas >Complementos>
Extenses > Mais extenses.
Navegador Firefox http://br.mozdev.org/firefox
Web Developer - https://addons.mozilla.org/firefox/60
Vrias ferramentas de desenvolvimento e teste.
HTML validator - https://addons.mozilla.org/firefox/249
Validador HTML baseado no TIDY, permite correes no cdigo.
ColorZilla - https://addons.mozilla.org/firefox/271
Exibe a informao da cor selecionada.
HTML Tidy Library Project - http://tidy.sourceforge.net
Converte HTML para XHTML
Firefox Accessibility Extension
https://addons.mozilla.org/en-US/firefox/addon/1891?
Firebug - http://www.getfirebug.com/
ferramentas para anlise cdigo, folhas de estilo, testes e debug de javascript.
DOM Inspector - http://www.mozilla.org/projects/inspector/
Ferrramenta para visualizar e editar o DOM de um documento.
Padres Web em Governo Eletrnico e-PWG Cartilha de Codificao
47
9. Leitura Complementar
e-MAG Modelo de acessibilidade de Governo Eletrnico
http://www.governoeletronico.gov.br/acoese-projetos/e-MAG/
CSS para Webdesign
http://www.maujor.com
O bsico da Web
http://www.obasicodaweb.com/
Revoluo etc
http://www.revolucao.etc.br
Tableless
http://www.tableless.com.br
A List Apart
http://www.alistapart.com
CSS Play
http://www.cssplay.co.uk/
CSS Discuss
http://www.css-discuss.org/
W3 schools
http://www.w3schools.com/
CSS Zen Garden
http://www.csszengarden.com/
48
10. Glossrio
Acessibilidade
Significa permitir o acesso por todos, independente do tipo de usurio, situao ou
ferramenta. Significa ainda, criar ou tornar as ferramentas e pginas web acessveis a
um maior nmero de usurios, inclusive pessoas portadoras de deficincias.
CSS (Cascading Style Sheets Folhas de estilo em cascata)
Linguagem que descreve a apresentao, visual ou sonora, de um documento.
Hack
Hacks so subterfgios utilizados pelos desenvolvedores como forma de contornar
problemas apresentados na apresentao de uma pgina devido deficincia de um
dado navegador entender os padres Web.
Navegador
Programa que permite ao usurio consultar e interagir com o material publicado na
Internet.
Padres Web (Web standards)
Padres Web so regras de tecnologia definidos pelo W3C e outros rgos da rea
utilizados para criar e interpretar o contedo Web.
URI (Uniform Resource Identifier - Identificador Unificado de Recurso)
, basicamente, uma string (conjunto de caracteres) que seguem uma certa sintaxe e
usado para definir identificar um recurso na web. O tipo mais comum de URI a
URL.
URL (Uniform Resource Locator - Localizador Unificado de Recurso)
Um tipo especfico de URI, usado para definir a localizao de um recurso na web.
Geralmente dizemos que a URL o endereo de uma pgina web. Um exemplo de
URL: http://www.exemplo.com/pagina/
W3C (World Wide Web Consortium)
Consrcio de mbito internacional com a finalidade de desenvolver especificaes,
guias e ferramentas para web.
49
50