Como dar formato aos artigos de escoitar.org

31 enero 2009

Este artigo é un resumo acerca das estratexias e recursos que tendes a vosa disposición para dar formato aos artigos que publiquedes nesta web. A través do mesmo, vou intentar establecer como mellorar o aspecto dos artigos, de xeito que o HTML resultante sexa compatible cos estándares do W3C e facilite a accesibilidade.

Spip ofrece a posibilidade de utilizar atallos, como o paréntese para facer negrillas e cursivas ao editar os artigos, pero tamén permite introducir directamente etiquetas HTML no texto. É fundamental tratar de economizar os recursos que utilicedes, priorizar o uso de etiquetas lóxicas fronte a etiquetas formais e evitar por todos os medios definir formatos directamente no HTML.

As etiquetas lóxicas son aquelas que se preocupan de clasificar o contido dun documento HTML, e non da estética do mesmo, o fundamental non é que modifiquen o aspecto do texto, senon que aporten información suplementaria acerca do texto.

Algunhas das etiquetas lóxicas que podedes utilizar:

  • Este texto é algo algo mais pequeno porque ten unha etiqueta small.
  • Este texto está emfatizado cunha etiqueta em.
  • Este texto está moi emfatizado cunha etiqueta strong.
  • O seguinte número é un superíndice 1.
  • O seguinte número é un subíndice 1.
  • Pode ser que alguén de vos non saiba o que é o W3C. Para definir un acrónimo de xeito que usuario poda poñer o rato sobre a palabre e ver o seu significado, utilízase a etiqueta acronym.
     
    W3C

    *Esta etiqueta require dun atributo chamado title que permite definir o significado do contido.

  • Para usar a abreviatura dunha palabra de xeito que o usuario poda poñer o rato sobre a mesma e ver o seu significado, utilízase a etiqueta abbr.
     
    abbr

    *Esta etiqueta require do mesmo atributo title que a etiqueta acronym.


  • Para introducir unha dirección postal se pode utilizar a etiqueta address. A vantaxe de esta etiqueta é que ademais de poñer un texto en cursiva informa acerca de que o contido é unha dirección.
  • Para introducir unha definición se pode utilizar a etiqueta dfn. A vantaxe de esta etiqueta é que ademais de poñer un texto en cursiva informa acerca de que o contido é unha definición.

Moitas veces tendese a utilizar as negrillas para emfatizar títulos e subtítulos. Esta estratexia é pouco recomendable, porque dende o punto de vista do código, non se establece ningunha información acerca de cal é a razón pola cal o texto debe ser emfatizado. Para establecer unha xerarquia de títulos e subtítulos estan reservadas unhas etiquetas numeradas, chamadas cabeceiras (header).

Unha das ventaxas engadidas destas etiquetas e que provocan un salto de linha e non hai que preocuparse de se Spip porá ou non dito salto no párrafo seguinte. Dado que a primeira etiqueta header corresponde ao título do artigo, os redactores debedes comezar a utilizalas a partires do número 2, seguindo unha orde lóxica e xerarquica.

Etiquetas header para definir os títulos e subtítulos:


  • Este texto é un título.


  • Este texto é un subtítulo.


  • Este texto é un subtítulo de segundo nivel.


  • Este texto é un subtítulo de terceiro nivel.

  • Este texto é un subtítulo de cuarto nivel.

Como podedes obserbar a maioria das etiquetas HTML teñen un elemento de apertura e un elemento de peche. É moi importante comprobar que todas as etiquetas queden correctamente pechadas. Xa que, do contrario, o navegador pode mal interpretar o código da páxina e facer auténticos desaguisados na presentación final.

Por outra banda, existen algunhas etiquetas HTML que, por non ter contido, so teñen un elemento. Moita xente tende a escribir este tipo de etiquetas, como os saltos de liña, da seguinte maneira:


Pero isto non é normativo e ainda que non afecta a presentación final da páxina non validará como XHTML 1.0 Transitional no W3C. O xeito correcto de escribir este tipo de etiquetas e cunha barra de peche ao final da mesma.


Algúns dos atallos que ofrece Spip para dar formato ao texto son enormemente útiles, pero as veces resulta dificil comprender a súa dinamica e controlar o xeito en que inter-actúan co resto do texto. Vou facer un pequeno resumo dos mesmos e tratar de explicar como utilizalos correctamente.

Atallos de Spip para insertar imaxes:

  • Para insertar unha imaxe normal.
  • Para insertar unha imaxe flotante a esquerda.
  • Para insertar unha imaxe flotante a dereita.
  • Para insertar unha imaxe centrada.

Por defecto as imaxes sitúanse a esquerda, basta con deixar un espacio antes do texto que veña a continuación, para forzar un salto de liña. Pero, cando tratamos de situar as imaxes á esquerada ou á dereita cos filtros |right e |left, o seu comportamentlo é algo diferente. Spip as transforma en elementos flotantes, polo que o texto trata de ocupar o espacio que hai ao seu redor.

En determinadas circunstancias este efecto pode resultar molesto e non resulta nada doado evitalo. Podemos estar tentados a ocupar o espacio ao redor da imaxe con saltos de liña
, pero o que conseguiremos será encher o documento de elementos supérfluos (basoira).

Para resolver este problema, o seguinte parágrafo deberá ter unhas cualidades especiais que impidan que trate de o cupar o espacio ao redor da imaxe. Na CSS de Escoitar.org definimos unha clase chamada «clear» con este obxectivo.

O único que tendes que facer para forzar un salto de liña despois dunha imaxe flotante é poñer un divisor con dita clase. Por exemplo, este texto esta dentro do seguinte divisor:

En xeral as imaxes centradas non ofrecen ningún problema xa que o propio Spip crea un divisor que ocupa todo o espacio ao redor da imaxe centrada. Polo que poderemos centrar as imaxes con facilidade utilizando o atallo correspondente.

Algúns atallos de Spip relativamente descoñecidos e moi útiles:

  • Cando desexamos incluir unha cita no texto, como no exemplo sequinte, e recomendable recurrir a este atallo.

    El poder de la Web se encuentra en su universalidad. El acceso por parte de todos mas allá de la discapacidad es un aspecto esencial.

    Tim Berners-Lee

     

    El poder de la Web se encuentra en su universalidad. El acceso por
    parte de todos mas allá de la discapacidad es un aspecto esencial.

    Tim Berners-Lee


  • code> Para poder introducir fragmentos de código HTML como os que hai neste artigo, sen que Spip os interprete, e necesario utilizar este atallo de Spip. Combinando este atallo coa etiqueta HTML
    
    

    se pode facer unha caixa de código como a anterior.

  • ---- Para introducir unha barra de separación entre dúas partes dun artigo se pode utilizar este atallo, ainda que as barras de separación

    son elementos supérfluos que non aportan ningún contido.


  • -* Para elaborar listaxes de elementos con facilidade existe este atallo.
    • Primeiro elemento da lista
    • Segundo elemento da lista
    • terceiro elemento da lista
     
    -* Primeiro elemento da lista
    -* Segundo elemento da lista
    -* terceiro elemento da lista

A regra fundamental para dar formato aos vosos artigos é que debe ser o contido quen condicione o aspecto final do texto, e non o aspecto final quen condicione o contido. Acumular unha enorme cantidade de etiquetas

,

ou
, xunto coas súas correspondentes clases e estilos, para conseguir unha determinada estética, é contraproducente porque ensucia a páxina e a fai mais pesada. Ademais existen etiquetas HTML como ,

ou que están obsoletas e xa non son válidas, polo que hai que andar con moito ollo.

A limpeza, a economía de recursos e a xerarquía son fundamentais á hora de facer unha boa páxina web, pero as veces fan falta algunhas cores para animar e entreter aos lectores. Co fin de que poidades utilizar algúns recursos estéticos nos vosos textos e que o fagades dun xeito lóxico, definimos unha serie de classes na CSS de escoitar.org que podedes utilizar aplicándoas a calquera etiqueta HTML que utilicedes (lembrade que so se pode usar as clases coas etiquetas HTML, nunca cos atallos de Spip).

Utilizar as cores de xeito lóxico:

  • class="primary" Este texto está emfatizado cunha etiqueta strong da clase primary, porque a súa importancia é clave.
     
  • class="secondary" Este texto está emfatizado cunha etiqueta em da clase secondary porque é secundario.
     
  • class="alert" Este texto está emfatizado cunha etiqueta small da clase alert. O vermello e moi bonito, pero debería utilizarse para avisos realmente importantes!!!
     

Recursos visuais para separar determinados contidos do conxunto:

  • class="apartado"
    Esta parte do texto está separada do resto mediante un marxe vertical, porque é un apartado especial.
     

    ...
  • class="recadro"
    Esta parte do texto está emfatizada mediante un borde gris que á rodea para separala do resto dos contidos do artigo.
     

    ...
  • class="fondo"
    Esta parte do texto está emfatizada mediante unha cor de fondo para separala do resto dos contidos do artigo.
     

    ...