Escribiendo artículos de opinión para ZonSiete.ORG

Un artículo de opinión es una breve reflexión y evaluación personla de un programa, distribución, método, libro, o lo que se te ocurra, en el que cuentes lo que te ha parecido, los problemas que has tenido, si crees que merece la pena probarlo, sus puntos fuertes y sus puntos flacos, en definitiva todo lo que se te ocurra.

En un principio no sabíamos qué formato usar para nuestros artículos de opinión, y al final nos decantamos por DocBook, debido a que está ampliamente difundido, hay mucha documentación y sobre todo por la facilidad para convertirlo a muchos formatos. Para esta ocasión nos hemos decantado por la DTD "article" de DocBook, y para ser más exactos, el lenguaje a usar será XML. Con lo que los documentos tienen que ser documentos XML válidos.

Lo ideal sería aprenderse las pocas etiquetas que se necesitan para escribir un documento. (Las explicamos más adelante en este mismo artículo) De todas formas si no tienes tiempo o no quieres escribir un DocBook, puedes mandarnos un fichero de texto plano bien organizado, y nosotros lo pasaremos a DocBook. Si optas por escribir tu mismo el DocBook el artículo aparecerá publicado en nuestra sección de Opinión en poco tiempo, si por el contrario prefieres q lo hagamos nosotros por ti, la cosa se retrasará algo más.

Voy a ir explicando un poco como se empieza y estructura un artículo de opinión. Lo primero que haremos será crear un documento XML. En mi caso el editor vim es el que me va a ayudar. Si vim no os gusta, hay alternativas muy buenas como anjuta o Quanta+ si usais KDE. Todo documento DocBookX tiene que ser un documento XML válido así que la primera cosa que haremos será crear ese documento:

                        
<?xml version="1.0" standalone="no"?>
                        
                

Lo siguiente que haremos, será definir el tipo de documento XML que vamos a escribir, en nuestro caso es un DocBookX tipo article:

                        
<?xml version="1.0" standalone="no"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V4.1//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<article lang="es">

</article>
                        
                

Bien, ya tenemos un documento DocBookX válido, pero no nos sirve de nada.... porque no tiene ninguna información. Lo primero que haremos será incluir la meta-información del artículo. Esta se compone del nombre y apellidos del autor, así como un email de contacto y el copyright del mismo. Esto lo haremos con la etiqueta articleinfo:

                        
<?xml version="1.0" standalone="no"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V4.1//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<article lang="es">
        <articleinfo>
                <title>Nuevo art&iacute;iculo de opini&oacute;n</title>
                <author>
                        <firstname>Fernando J.</firstname>
                        <surname>Pereda Garcimart&iacute;n</surname>
                        <affiliation>
                                <address><email>fernando@ferdyx.org</mail></address>
                        </affiliation>
                </author>
                <publisher>
                        <publishername><ulink url="http://www.zonasiete.org">ZonaSiete.ORG</ulink></publishername>
                </publisher>
                <copyright>
                        <year>2002</year>
                        <holder>ZonaSiete.ORG Editors Team</holder>
                </copyright>
        </articleinfo>
</article>
                        
                

En mi caso el propietario del copyright es el ZonaSiete.ORG Editors Team puedes poner un copyright tuyo, o cedérnoslo a ZonaSiete.ORG. Lo siguiente será ir añadiendo secciones con los diferentes apartados que en ZonaSiete hemos creido necesarios, estos son:

Estas secciones son necesarias, para dar a nuestros usuarios información detallada sobre lo que se ha probado. Las secciones en un documento de DocBook las creamos con la etiqueta sect1:

                        
<?xml version="1.0" standalone="no"?>
<!DOCTYPE article PUBLIC "-//OASIS//DTD DocBook V4.1//EN" "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">
<article lang="es">
        <articleinfo>
                <title>Nuevo art&iacute;iculo de opini&oacute;n</title>
                <author>
                        <firstname>Fernando J.</firstname>
                        <surname>Pereda Garcimart&iacute;n</surname>
                        <affiliation>
                                <address><email>fernando@ferdyx.org</mail></address>
                        </affiliation>
                </author>
                <publisher>
                        <publishername><ulink url="http://www.zonasiete.org">ZonaSiete.ORG</ulink></publishername>
                </publisher>
                <copyright>
                        <year>2002</year>
                        <holder>ZonaSiete.ORG Editors Team</holder>
                </copyright>
        </articleinfo>
        <sect1>
                <title>Introducc&ioacute;n</title>

                <para>
                        P&aacute;rrafo de ejemplo bla bla bla
                </para>
        </sect1>
</article>
                        
                

Cada párrafo que queramos escribir lo haremos entre etiquetas para. Si queremos simular el interactuar con una terminal, lo haremos con el conjunto de etiquetas screen, prompt, computeroutput y userinput. Un ejemplo normal serí algo así:

                
<screen>
<prompt>--(ferdy@posidon$ opinion-como )--</prompt><userinput>su -</userinput>
<computeroutput>Password:<computeroutput><userintput>[ password ]</userinput>
<prompt>posidon:/root#</prompt>
</screen>
                
                

Para crear listas lo hacemos con las etiquetas itemizedlist, listitem y para, por ejemplo la lista que hay antes con las secciones de cada artí serí así:

                
<itemizedlist mark="opencircle">
        <listitem><para>Introducci&oacute;n</para></listitem>
        <listitem><para>Instalaci&oacute;n</para></listitem>
        <listitem><para>Problemas encontrados</para></listitem>
        <listitem>
                <para>Valoraci&oacute;n</para>
                <itemizedlist mark="bullet">
                        <listitem><para>Puntos flacos</para></listitem>
                        <listitem><para>Puntos fuertes</para></listitem>
                        <listitem><para>Comentario personal</para></listitem>
                </itemizedlist>
        </listitem>
        <listitem><para>Texto libre</para></listitem>
</itemizedlist>
                
                

Si se quiere resaltar algo, utilizaremos la etiqueta emphasis.

Para hacer subsecciones (como se necesitará para la sección de Valoración) lo hacemos con la etiqueta sect2, por ejemplo:

                
<sect1>
        <title>Algo de prueba ;)</title>
        
        <sect2>
                <title>Subsecci&oacute;n</title>

                <sect3>
                        <title>Subsecci&oacute;n de la Subsecci&oacute;n</title>
                        
                        <para>
                                Aunque esta no la vamos a utilizar, no est&aacute; de m&aacute;s saber que hay
                                hasta la sect5.
                        </para>
                </sect3>
        </sect2>
        <sect2>
                <title>Otra subsecci&oacute;n de la secci&oacute;n principal</title>
        </sect2>
</sect1>
                
                

Dentro de ellas seguiremos usando los para y las etiquetas vistas hasta ahora para darle formato a nuestro documento

Para validar los documentos usaremos xmllint, que es parte del paquete libxslt. El uso de xmllint es muy sencillo, un ejemplo claro de uso serí el siguiente:

--(ferdy@posidon$ opinion  )-- xmllint --valid --noout errores.xml

opinion-como.xml:6: error: Entity 'oacutre' not defined
                Escribiendo artículos de opini&oacutre;n para Zon
                                                              ^

                

Ahí vemos como el autor (en este caso un servidor) se ha equivocado en la línea 6 del documento. Si xmllint no devuelve nada, es que el documento está bien formado y es válido.

Aquí hemos visto las cosas básicas del uso de DocBook orientado a escribir artículos de opinión para ZonaSiete.ORG. Nosotros preferimos que nos mandes el documento en XML, así que si teneis algún tipo de problema no dudéis en contactarnos y os ayudaremos.