Webdesign : Construyendo ficheros de texto con macros de m4

por John Perr

Sobre el Author:

Usuario de linux desde 1994; es uno de los editores franceses de LinuxFocus.

Contenidos:

Introducciï¿½n
Definition
Un ejemplo
Versiï¿½n HTML
Versiï¿½n con macros
Definiciones de macros
Descripciï¿½n
Creando pï¿½ginas
Sumario
Conclusiï¿½n
Enlaces

Construyendo ficheros de texto con macros de m4

Resumen:

Este tutorial describe como facilitar el mantenimiento de ficheros de texto o HTML, usando el preprocesador de macros M4.

Introducciï¿½n

Un lenguaje de macros se necesita con frecuencia cuando se usa un editor de texto. La mayorï¿½a de ellos ya tienen lenguajes de ese tipo entre sus caracterï¿½sticas. Incluso el compilador de C provee ese tipo facilidades a los programadores a traves del preprocesador de C CPP. Cuando se usa para mantener ficheros de configuaciï¿½n o pequeï¿½os sitios web, el procesador de macros GNU/m4 puede ayudarnos a reducir la carga de trabajo. El procesador de macros GNU/m4 es parte de todas las distribuciones de linux y es estandar entre los usuarios de Unix.

De aquï¿½ en adelante, mostraremos como utilizar el procesador de macros GNU/m4 para mantener un conjunto de pï¿½ginas HTML de un pequeï¿½o sitio web. Este sistema ayudarï¿½ a mantener coherente el sitio entero. Por supuesto, hay docenas de maneras de obtener el mismo resultado con herramientas Unix; ï¿½esa es la belleza de Unix!.

Esta tï¿½cnica se usa para la construcciï¿½n del bien conocido sendamil.cf. Hay un kit de macros m4 disponible en la universidad de Berkley diseï¿½ado por Eric Allman.

El procesador de macros GNU/m4 no estï¿½ limitado a ediciï¿½n de texto y HTML. Puede demostrar ser muy util para programadores que quieran extender las caracterï¿½sticas de CPP o a aquellos quieran tener caracterï¿½sticas equivalentes a las del CPP en otros lenguajes.

Definition

Un procesador de macros en un programa que interpreta comandos (llamados macros) definidos por el usuario. La macros estï¿½n normalmente inmersas en el texto a procesar. Por ejemplo, la siguiente definiciï¿½n:

define(AUTHOR,`Agatha Christie<[email protected]>')

permite usar la palabra "AUTHOR" en cualquier lugar del texto. Esta palabra serï¿½ reemplazada con "Agatha Christie<[email protected]>" despuï¿½s de ser procesado el fichero con m4. Desde luego, se le puede dar mï¿½s usos prï¿½cticos, como se verï¿½ despuï¿½s.

Un ejemplo

Supongamos que tenemos que mantener un sitio web que tiene las mismas pï¿½ginas pero con idiomas diferentes. Ademï¿½s, cada pï¿½gina tiene la misma cabecera y el mismo pie con el objetivo de dar al sitio un aspecto coherente. A fin de mantener la cosas lo mï¿½s simples posibles y para ello evitar el uso de un navegador en concreto para ver el resultado, nuestro ejemplo constarï¿½ solo de texto. Esto permitirï¿½ a la gente que use lynx ver con facilidad nuestro sitio. Este es cï¿½digo HTML de una de las pï¿½ginas:

Versiï¿½n HTML

  
<!-- Start of header -->
<HTML>
<HEAD>
<TITLE>Lynx homepage</TITLE>
<META name="description" content="Site lynx et m4"> 
</HEAD>
<BODY BGCOLOR="#FFFFFF" LINK="#008000" VLINK="#808080" ALINK="#8080FF">
<TABLE>
  <TBODY>
  <TR><TD align=middle colspan="2">
      <H1>Lynx a fully-featured World Wide Web client for character-cell
displays</H1>
  <TR><TD align="left" valign="top" width="15%">
      <a href="./index-en.html">English</A><BR>
      <a href="./index-fr.html">French</A><BR>
      <a href="./index-es.html">Italian</A><BR>
      <a href="./index-it.html">Spanish</A><BR>
      <a href="./index-de.html">German</A><BR>
      <TD align=left>
<!-- End of header -->

      <P>Links to the current sources and support materials for Lynx are
   maintained at <A HREF="http://www.crl.com/~subir/lynx.html">Lynx
   links</A></P>
      <P> and at the Lynx homepage
      <A HREF="http://lynx.browser.org/">Lynx
      Information.</A></P>
      <P>View these pages for information about Lynx, including new
      updates.</P>

      <P>Lynx is distributed under the GNU General Public License (GPL) without
   restrictions on usage or redistribution.  The Lynx copyright statement,
   "COPYHEADER", and GNU GPL, "COPYING", are included in the top-level
   directory of the distribution.  Lynx is supported by the Lynx user
   community, an entirely volunteer (and unofficial) organization.</P>

<!-- Start of footer -->
</TBODY>
</TABLE>
<HR size="0" noshadow>
<FONT SIZE=-2>
<EM>Page maintained by John Perr.<BR>
Page updated on 25/07/99
- © <A HREF="mailto:[email protected]">lynx.browser.org</A>1999
</EM></FONT>
</BODY>
</HTML>
<!-- End of footer -->

Aquï¿½ estï¿½ el resultado:


con Lynx	con netscape

Todas las pï¿½ginas tendran el mismo estilo de cabecera y de pie, solo el idioma y el cuerpo de la pï¿½gina cambiaran. Ahora vamos a diseï¿½ar macros de m4 que se insertarï¿½n en el texto HTML de nuestras pï¿½ginas para reemplazar todos los datos repetitivos.
Antes de entrar en detalles con las macros, echemosle una ojeada al siguiente ejemplo escrito con ese tipo de macros:

Versiï¿½n con macros

  
LYNX_TITRE(Lynx a fully-featured World Wide Web
            client for character-cell displays)
LYNX_ENTETE(Lynx homepage)

      <P>Links to the current sources and support materials
      for Lynx are maintained at
      <A HREF="http://www.crl.com/~subir/lynx.html">
      Lynx links</A></P>
      <P> and at the Lynx homepage
      <A HREF="http://lynx.browser.org/">
      Lynx Information.</A></P>
      <P>View these pages for information about Lynx,
      including new updates.</P>

      <P>Lynx is distributed under the
      GNU General Public License (GPL) without
   restrictions on usage or redistribution.
   The Lynx copyright statement, "COPYHEADER",
   and GNU GPL, "COPYING", are included in the top-level
   directory of the distribution.
   Lynx is supported by the Lynx user community,
   an entirely volunteer (and unofficial) organization.</P>
LYNX_PIED

De esa manera, escribir pï¿½ginas HTML es mï¿½s sencillo y el texto no se pierde entre etiquetas (tags) HTML. Para escribir con otros idiomas, se tendrï¿½n que hacer traducciones de este fichero. La versiï¿½n francesa serï¿½a:

  
LYNX_TITRE(Lynx un navigateur en mode console)
LYNX_ENTETE(Un site pour les utilisateurs de lynx)

   <P>Visitez le
   <A HREF="http://lynx.browser.org/">
   site officiel de lynx</A>
   pour plus d'informations sur Lynx,
   y compris les nouvelles mises ï¿½ jour.</P>
       
   <P>Les liens vers les sources de la version
   courante et divers supports pour Lynx sont
   tenus ï¿½ jour sur le site
   <A HREF="http://www.crl.com/~subir/lynx.html">
   liens Lynx</A>.</P>

   <P>Lynx est distribue dans le cadre de la lisence GNU
   (General Public License - GPL)
   sans restriction sur son utilisation ni sa distribution.
   Les mentions des droits de reproduction de Lynx, "COPYHEADER",
   et GNU GPL, "COPYING", sont inclus dans la racine de
   l'arborescence de la distribution. Lynx est supporte par
   la communaute des utilisateurs de Lynx, une communaute
   entiï¿½rement benevole (et non-officielle).</P>
LYNX_PIED

Para cada idioma, las mismas macros LYNX_TITRE, LYNX_ENTETE y LYNX_PIED se usan con argumentos diferentes. Estas 3 macros serï¿½n un sustituto eficiente para el cï¿½digo HTML de la cabecera y el pie. Esta es la principal ventaja de este sistema: la definiciï¿½n de la cabecera y el pie es consistente para todas las pï¿½ginas del sitio. Si el estilo de la cabecera o el pie tiene que ser cambiado, solo habrï¿½ que cambiar la definiciï¿½n de la macro, en vez de editar cada pï¿½gina a mano.

Definiciones de macros

Arriba, se han usado 3 macros para conseguir la mayorï¿½a del formateo. Aquï¿½ esta el fichero de definiciï¿½n de esas macros. Los comentarios estï¿½n despuï¿½s:

  
divert(-1)
# Fichero mac.css
# Version 1.0 M4 macros para Lynx
#
# Se define un fichero trans-LANG.m4 para cada
# idioma, basado en del idioma frances.
# Si no existe fichero de traducciï¿½n,
# Francï¿½s es la opciï¿½n por defecto.
#
divert(0)
changequote({,})dnl # Cambia los caracteres de citas o comillas (quotes) a llaves
ifdef({LANG},,{define({LANG},{fr})})dnl # Por defecto = french
include({trans-}LANG{.m4})dnl	  # Llama al fichero de traducciï¿½n
undefine({format})dnl		  # Elimanr la definiciï¿½n de format
define({_ANNEE_},esyscmd(date +%Y))dnl 	  #Aï¿½o actual
define({LYNX_TITRE},{define(_TITLE_,$1)})dnl # Primera macro
dnl # Segunda macro
define({LYNX_ENTETE},{<!-- Header start -->
<HTML>
<HEAD>
<TITLE>$1</TITLE>
<META name="description" content="Site lynx and m4"> 
<META name="keywords" content="m4, lynx, GPL">
</HEAD>
<BODY BGCOLOR="#FFFFFF" LINK="#008000" VLINK="#808080" ALINK="#8080FF">
<TABLE>
  <TBODY>
  <TR><TD align=middle colspan="2">
      <H1>_TITLE_</H1>
  <TR><TD align="left" valign="top" width="15%">
      <a href="./index-en.html">_ANGLAIS_</A><BR>
      <a href="./index-fr.html">_FRANCAIS_</A><BR>
      <a href="./index-es.html">_ESPAGNOL_</A><BR>
      <a href="./index-it.html">_ITALIEN_</A><BR>
      <a href="./index-de.html">_ALLEMAND_</A><BR>
      <TD align=left>
<!-- end of header -->})dnl
dnl # Tercera macro
define({LYNX_PIED},{<!-- Start of footer -->
</TBODY>
</TABLE>
<HR size="0" noshadow>
<FONT SIZE=-2>
<EM>_MAINTENEUR_.<BR>
_MAJ_
esyscmd(date +%d/%m/%y)
- &copy <A HREF="mailto:[email protected]">
lynx.browser.org</A>
_ANNEE_</EM></FONT>
</BODY>
</HTML>
<!-- End of footer -->})dnl

Descripciï¿½n

Las lineas entre "divert(-1)" y "divert(0)" son comentarios. "Divert" es una de las macros predefinidas del procesador m4. Estï¿½ diseï¿½ada para desviar la salida del procesador. Usando -1, le decimos al procesador que no escriba las lineas siguientes al final del fichero HTML, que es lo que el quiere.

La macro "changequote" redefine los "quotes" (comillas) que se usan normalmente para citar (quote) los argumentos de las macros. Son reemplazados aquï¿½ con llaves porque en ficheros de texto, y especialmente en los escritos en francï¿½s, las comillas (simples en este caso) se usan con frecuencia y conducirï¿½an a malinterpretaciones de las macros. Las llaves se usan con menos frecuencia en texto o en HTML, es por eso por lo que se han elegido aquï¿½. (N. del Traductor: quotes son tanto las comillas simples como las dobles, tanto abiertas como cerradas, o en definitiva cualquier cosa que se use para que lo de dentro se tome tal cual. En m4 se usan por defecto las comillas simples de abrir y cerrar y eso es lo que el autor cambia en este caso).

La macro "ifdef" se usa para comprobar si la macro LANG estï¿½ definida y para, en caso de que no lo estï¿½, darle el valor "fr" que es el valor por defecto. El objetivo de la macro LANG es fijar el idioma o lenguaje. En las lineas de abajo, veremos como definirla cuando se llama a m4 (en la linea de comadn), a fin de elegir el lenguaje de la pï¿½gina HTML.

La linea "include" tiene el mismo significado que en C y se usa para incluir un fichero externo. La usamos para cargar las definiciones de macros especï¿½ficas del idioma usadas en la cabecera y en el pie. Aquï¿½ estï¿½ su contenido en funciï¿½n del lenguaje:

  
divert(-1)
# Fichero trans-fr.m4
# Definiciones para francï¿½s
divert(0)
define({_ANGLAIS_},{Anglais})dnl
define({_FRANCAIS_},{Franï¿½ais})dnl
define({_ITALIEN_},{Espagnol})dnl
define({_ESPAGNOL_},{Italien})dnl
define({_ALLEMAND_},{Allemand})dnl
define({_WEBMASTER_},{John Perr})dnl
define({_MAINTENEUR_},{Page maintenue par _WEBMASTER_})dnl 
define({_MAJ_},{Date de mise à jour:})dnl

  
divert(-1)
# File trans-en.m4
# Definitions for english
divert(0)
define({_ANGLAIS_},{English})dnl
define({_FRANCAIS_},{French})dnl
define({_ITALIEN_},{Spanish})dnl
define({_ESPAGNOL_},{Italian})dnl
define({_ALLEMAND_},{German})dnl
define({_WEBMASTER_},{John Perr})dnl
define({_MAINTENEUR_},{Page maintained by _WEBMASTER_})dnl
define({_MAJ_},{Page updated on })dnl

Si tu hablas Espaï¿½ol, Italiano o Alemï¿½n, deberï¿½s ser capaz de escribir ficheros similares para esos lenguajes.

La linea "undefine" elimina la definiciï¿½n por defecto de la macro predefinida "format" porque no se usa aquï¿½. Si esta linea se omitiese, cada vez que la palabra "format" apareciese en el texto desaparecerï¿½a a menos que estuviera entrecomillada (con las quotes o comillas que tengamos establecidas), por ejemplo, rodeada con llaves. Ese tipo de practicas no son aconsejables cuando se edita una simple pï¿½gina web.

Ahora viene la definiciï¿½n del aï¿½o actual. Se obtiene de la macro "easycmd" que llama al comando unix "date". Este comando se usa tambiï¿½n dentro de la definiciï¿½n del pie a fin de imprimir la fecha en la que se actualizï¿½ la pï¿½gina.

La linea siguiente define la primera de las tres macros principales: LYNX_TITRE. Esta macro define otra macro llamada _TITRE_. Esta doble definiciï¿½n es necesaria para poder usar el tï¿½tulo varias veces dentro de la cabecera y el pie de la pï¿½gina partiendo de una sola definiciï¿½n. Fï¿½jate en el uso de $1 para referirse al primer parï¿½metro de la macro.

Las lineas siguientes definen las otras dos macros principales: LYNX_ENTETE y LYNX_PIED que corresponden a los contenidos de la cabecera y el pie de nuestra pï¿½gina HTML, excepto por los elementos variables de la pï¿½gina. Estos son:

Palabras a ser traducidas desde el fichero de traducciï¿½n.
Elementos que se pueden modificar cuando se edita la pï¿½gina, como la fecha o el nombre del webmaster.

El "dnl" que aparece al final de cada linea es una macro predefinida que significa "Delete to New Line" (borra hasta nueva linea). Con "dnl" m4 no genera una linea vacia cuando interpreta una macro.

Creando pï¿½ginas

Ahora que nuestro sistema estï¿½ construido, la generaciï¿½n de una pï¿½gina Web a partir de los ficheros se hace con el siguiente comando:

m4 -DLANG=XX mac.css index-XX.m4 > index-XX.html

Donde "XX" es el cï¿½digo a usar para cada idioma. Fijate que la opciï¿½n -D se usa, como con gcc, para definir una macro desde la linea de comando.

Sumario

La tabla siguiente presenta los ficheros y su uso en esta apliaciï¿½n.

Los siguientes ficheros se usan para generar pï¿½ginas HTML:

index-XX.html El cuerpo de la pï¿½gina, que es el texto escrito por el autor o el traductor. Es diferente para cada pï¿½gina y cada idioma. (el cï¿½digo es XX=en para Inglï¿½s, es para Espaï¿½ol, etc...)
mac.css Definiciones estandar. ESte fichero es comï¿½n a todas las pï¿½ginas y todos los idiomas. se puede ver como un tipo de hoja de estilos.
trans-XX.m4 Definiciones estandar para un idioma. este fichero es comï¿½n a todas las pï¿½ginas de un idioma,(el cï¿½digo es XX=en para Inglï¿½s, es para Espaï¿½ol, etc...)

Conclusiï¿½n

A pesar de su potencia, el procesador de macros m4 no se puede comparar con un lenguaje de scripting como Perl o Tcl. De todas formas, una vez conoces sus peculiaridades, es una herramiente rï¿½pida y maï¿½osa para ayudar a procesar ficheros de texto. Para aprender mï¿½s, consulta la documentaciï¿½n incluida con tu distribuciï¿½n. Deberï¿½as encontrar un tutorial de m4, de cerca de 30 pï¿½ginas de longitud, que cubre todos los aspectos del procesador de macros GNU/m4. Tambiï¿½n puedes echarle una ojeada al sitio del Linux User Group of Bordeaux (ABUL) que se mantiene con un kit de macros m4, similares a las presentadas aquï¿½.

Enlaces

GNU/m4 esta disponible desde ftp://prep.ai.mit.edu/pub/gnu/m4-1.4.tar.gz
Bajar los ficheros presentados aquï¿½: The Lynx m4 macro kit

Gracias a Paul Kienzle por revisar este artï¿½culo.

Translation information:

fr	->	--	John Perr
fr	->	en	John Perr
en	->	es	David Abilleira Freijeiro

1999-05-23, generated by lfparser version 0.6

index-XX.html	El cuerpo de la pï¿½gina, que es el texto escrito por el autor o el traductor. Es diferente para cada pï¿½gina y cada idioma. (el cï¿½digo es XX=en para Inglï¿½s, es para Espaï¿½ol, etc...)
mac.css	Definiciones estandar. ESte fichero es comï¿½n a todas las pï¿½ginas y todos los idiomas. se puede ver como un tipo de hoja de estilos.
trans-XX.m4	Definiciones estandar para un idioma. este fichero es comï¿½n a todas las pï¿½ginas de un idioma,(el cï¿½digo es XX=en para Inglï¿½s, es para Espaï¿½ol, etc...)