Cómo iniciar un proyecto en TLDP-ES

1. Introducción

Este breve artículo está especialmente dirigido a los editores/coordinadores de esfuerzos de documentación bien originales o bien de traducción. Tampoco está de más que los voluntarios lo lean para que conozcan cómo puede desarrollarse el trabajo y como implicarse al máximo de sus intereses y objetivos.

El documento está en plena fase de desarrollo, así que es probable que cambie de forma sensible en el futuro.

Si cree que alguna parte puede ser mejorada, por favor, no deje de indicárselo al autor. El objetivo es facilitar al máximo su comprensión y uso.

Recuerde que las herramientas que vamos a presentar están destinadas a facilitar el trabajo de traductores y redactores. Aunque en un primer momento la cantidad de información nueva pueda parecer abrumadora, comprobará lo fácil que es familiarizarse con ellas y cómo ayudan a llevar adelante su proyecto.

Estamos trabajando en la construcción de herramientas que mejoren el automatismo del proceso de publicación y gestión bibliotecaria de los documentos (imprenta-e, bibliotecario-e). También estamos ocupados construyendo Forja, un sistema que en el futuro lo hará todo todavía más sencillo, pero por ahora no es posible su uso (por cierto necesitamos la colaboración de voluntarios para escribir código, diseñar especificaciones y probar los prototipos de herramientas).

Una condición previa es importante: los documentos que se aporten a TLDP deben ser libres. Debe saberse también que las traducciones son documentos independientes con entidad legal propia, y son consideradas modificaciones del documento original. No importa que se traduzca un documento sobre alguna aplicación comercial o de fuente abierta, lo importante es la licencia del documento, si aparece algo como: “Queda prohibido cualquier cambio, almacenamiento, distribución…”, etc. dentro del documento original, no es documentación libre y no la podremos aceptar en TLDP, pero si la licencia permite modificarlo (su traducción en este caso), almacenarlo y reproducirlo, es de los nuestros.

Para saber más sobre el tema, puede consultar el artículo Licencias libres de documentación y aspectos de traducción escrito por Javier Fernández-Sanguino Peña.

Y recuerde: no hay proyecto pequeño. Cada contribución viene a sumarse al gran volumen de documentación que genera la comunidad del software libre, y su tamaño ya es gigantesco.

2. Pasos

1. Elección de la obra y de su título: plantear el objetivo de la obra y de su estructura y elegir un título que la identifique clara y concisamente.

   Por ejemplo supongamos que hemos decido traducir los treinta tomos de la edición completa de las obras de Kant. El título de nuestro primer proyecto sería «Crítica de la razón pura».

2. Consulta a la lista TLDP-ES sobre el proyecto.

   Es más que conveniente asegurarse de que no hay un trabajo previo en marcha o material disponible para ser reutilizado.

3. Elección del editor.

   Es necesario que una persona se haga cargo de los trabajos de coordinación y seguimiento de las asignaciones de trabajos y de la supervisión general. Si hay más de uno, pues mejor que mejor.

   Es el momento de que pida ayuda en lucas-voluntarios.

   El editor enlazará directamente con los coordinadores de TLDP-ES y para poder hacer su tarea debe abrírsele una cuenta CVS en cvs.hispalinux.es.

4. Elección del nombre normalizado del proyecto.

   Para conseguir un poco de orden en la masa de documentos que esperamos alojar y publicar, TLDP-ES sigue la política de normalizar los nombres de los proyectos. De esta manera los documentos comienzan por el prefijo «doc-», a su vez seguido de «curso-» si el documento pertenece a un curso, «informe-» si es un informe, etc. A este nombre le llamamos NOMBRECODIGO.

   Este nombre codificado ha sido tradicionalmente alguna clase de acrónimo del título (quizás es más importante que sea explicativo) y es necesario para que haya coherencia a la hora de crear los directorios de publicación, la url del proyecto, el módulo CVS, los partes Bugzilla y la lista de correo, si es que se precisa. Un ejemplo sería «doc-kant-critica-razon-pura».

   Es conveniente que se examine el listado de módulos de TLDP-ES (se puede examinar fácilmente ), por dos motivos principales: para crear un nombre que siga los convenios establecidos y para que cada módulo tenga un nombre suficientemente distinto de los demás (además de que de este modo puede comprobarse que el proyecto que pretende crearse no repite trabajo ya hecho).

   Estos primeros pasos los realiza el propio equipo de trabajo. Esta información es necesaria para los pasos siguientes, que deben ser realizados por los coordinadores de TLDP-ES.

5. Crear módulo CVS.

   CVS es una herramienta maravillosa para compartir y modificar código fuente en grupo. Su control de versiones puede ser un alivio incluso cuando lo usa una única persona. Además es el medio ideal para el intercambio de originales entre las diferentes etapas del ciclo de edición.

   Como el uso del cvs se comparte con otros proyectos se recomienda también usar el nombre normalizado NOMBRECODIGO.

   Se procura mantener un fichero LEAME.txt para identificar al proyecto y al coordinador del trabajo.

   Este trabajo deberá hacerlo alguno de los coordinadores de TLDP-ES.

6. Creación de cuentas CVS.

   Cada colaborador que use el CVS necesitará una cuenta para acceder a él. Si es sólo para lectura bastará el acceso anónimo pero si necesita escribir necesitará una cuenta propia. Ambas cuestiones se explican en nuestras páginas sobre cvs.

   Este trabajo deberá hacerlo necesariamente alguno de los coordinadores de TLDP-ES a petición de los miembros del equipo de trabajo.

   Si nunca ha trabajado con CVS es probable que necesite del documento de introducción que hemos preparado.

7. Creación de la página web de presentación del proyecto.

   Creemos conveniente que las páginas del proyecto cuelguen de http://es.tldp.org, para favorecer el crecimiento de la comunidad de desarrolladores de documentación electrónica.

   Es muy sencillo integrar una página HTML sencilla en las páginas de TLDP-ES. A día de hoy se usa la tecnología WML en las fuentes del sitio web de TLDP-ES.

   Para el nombre de los ficheros se recomienda el convenio proy-NOMBRECODIGO.wml. Puede usarse como ejemplo cualquiera de los ficheros wml ya creados en el módulo web-lucas/wml/ .

   El prototipo lo puede realizar cualquier colaborador. Basta con que sea una sencilla página que describa los detalles e informaciones importantes del proyecto. Puede ver el resultado en este ejemplo, la del proyecto garl.

   Si el encargado de la página no se atreve a integrarla en el web TLDP-ES, a pesar de lo fácil que es utilizando cvs, se la hace llegar a alguno de los coordinadores de TLDP-ES y él se encargará de hacerlo. A partir de ese momento los miembros del proyecto con acceso de escritura al cvs podrán mantener directamente esa página.

   El servidor principal de TLDP-ES se actualiza automática y directamente desde el cvs cada 15 minutos, y las réplicas cada 24 horas a horarios diferentes.

8. Registro en la web TLDP-ES.

   Registrar el proyecto en TLDP-ES, en función de las características del trabajo.

   • En la página de proyectos (web-lucas/wml/proyectos.wml), si es un proyecto con desarrollo activo.

   • Categorización en el menú principal, encartándolo en la sección más adecuada (tutoriales, informes, cursos, conferencias…), si ya hay disponible para publicar alguna versión.

   Este debe ser hecho o, mejor, supervisado por uno de los coordinadores de TLDP-ES, para asegurar la homogeneidad de la web. El mantenimiento de la información lo podrán hacer los propios miembros del equipo de trabajo.

9. Abrir producto Bugzilla.

   Bugzilla es una utilidad para gestionar tareas pendientes que Hispalinux pone a nuestra disposición y que compartimos con otras campañas y proyectos. Es la forma más sencilla de saber en cada momento qué hay hecho, qué hay por hacer, quien hace cada cosa y disponer de un histórico completo de todo el proyecto.

   Aunque sería altamente deseable, actualmente existen problemas para la apertura de nuevos productos Bugzilla. Por lo tanto es imprescindible el uso de los productos existentes (que siguen el convenio establecido: su nombre es doc-NOMBRECODIGO) y, en caso de no ser adecuados, utilizar los productos genéricos «TLDP-ES (LuCAS)» y «TLDP-ES I+D».

   Se contemplan los siguientes componentes bugzilla para cada producto de desarrollo de documentación:

   • 1.- Creación, asuntos relativos a la escritura o traducción y revisión de los textos.

   • 2.- Reproducción, asuntos relacionados con la creación de los formatos de reproducción, la maquetación y el uso de filtros para obtener los formatos finales de publicación.

   • 3.- Publicación, asuntos relacionados con la publicación en TLDP-ES de las versiones finales.

   • 4.- Errata, erratas en el documento.

   • 5.- Puede ser necesario abrir un componente Otros, para el resto de cuestiones no categorizadas arriba.

   Este trabajo deberá hacerlo necesariamente alguno de los coordinadores de TLDP-ES.

   Si nunca ha trabajado con Bugzilla es probable que necesite del documento de introducción que hemos preparado.

10. Lista de correo.

    En la mayoría de los casos bastará el uso de las listas ya abiertas. Si durante el desarrollo del proyecto resultase obvio la necesidad de crear una nueva lista se realizará sin mayor problema. Se piden, mediante Bugzilla, al producto «Hispalinux», componente «mailman».

3. Recomendaciones

Recomendaciones y consejos para el desarrollo de proyectos de documentación en TLDP-ES y mejor aprovechamiento de los recursos disponibles.