Tiempo de lectura: 3 minutos

GNU/Linux Valencia es una asociación enfocada a la difusión del software libre. Cada mes hacen como mínimo una charla en las Naves de la Universidad de Valencia. En esta ocasión me ha tocado a mí y me gustaría comentar un poco el evento. Para la charla preparé una presentación que explica los conceptos básicos de Sphinx así como los escenarios en los que vale la pena usarlo. ¿Queréis conocer más? Sólo tenéis que leer el resto de la entrada.

Introducción

Sphinx es una herramienta que permite gestionar la documentación de un proyecto. Se puede usar tanto para proyectos de programación como para proyectos generales. Por ejemplo, en el primer caso entraría un Curso de programación de Qt mientras que en el segundo caso podríamos encontrar los apuntes de una asignatura. Para escribir la documentación hay muchas herramientas: procesadores de textos, aplicaciones Web o editores de texto. Cada una de estas herramientas tiene ventajas e inconvenientes como se puede ver en las transparencias.

Una diferencia de Sphinx respecto a las otras herramientas es que facilita mucho las tareas colaborativas. Supongamos que tenemos un documento que está relacionado con un proyecto de software libre. El documento se escribe en el idioma del autor y de forma manual se va traduciendo a otros idiomas. Cuando el documento es pequeño es sencillo de gestionar. La cosa se complica cuando el documento alcanza un tamaño y se dedica una parte importante del tiempo a tareas de organización.

Proyecto Sphinx

Partimos de un proyecto en Sphinx que está escrito en un idioma. Usando herramientas nativas de GNU/Linux, extraemos todas las cadenas de texto y las guardamos en un archivo .po. Este tipo de archivos se usan mucho en las traducciones de aplicaciones y la documentación. Su ventaja principal es que otra persona puede trabajar en la traducción sin necesidad de conocer ni el lenguaje de programación ni la estructura del documento original. Traduce los términos del archivo y después se puede usar para generar la traducción. Si a esta ventaja le añadimos la posibilidad de usarlo en entornos de integración continúa, es posible tener actualizaciones de las traducciones que se generar de forma automática.

La charla en las Naves de la Universidad de Valencia

Las charlas empiezan a las 19:00 del último viernes de cada mes y suelen durar hora y media. La temática de las charlas es variada y se puede ver la programación en la Web de GNU/Linux Valencia. Puede asistir cualquier usuario y normalmente no hay que registrarse.

Charla en GNU/Linux Valencia

Aunque la charla era un poco técnica, la gente aguantó despierta sin muchos problemas. Para hacerla más razonable de seguir se tocaron por encima los conceptos más importantes de Sphinx. No se llegó a entrar mucho en detalle para no hacerlo muy denso. Es posible que se dé algún taller en LinuxCenter (siempre que el maestro pingüino tenga tiempo libre).

Lord Tux
Lord Tux

Transparencias de la charla

Podéis descargar la transparencia del siguiente enlace. Con mantener la autoría es suficiente. Aunque no es obligatorio, si que sería interesante avisarme si se han usado las transparencias para otro proyecto. Lo mismo se aplica a los comentarios y las sugerencias.

Emparejado con Sphinx se encuentra también Markdown. Ambos elementos (Markdown y RST con Sphinx) no son opuestos sino que se complementan. Es posible escribir la documentación con RST o Sphinx. Tenéis todos los detalles en la transparencia. Hay algunas cosas que no aparecen en el documento y que sólo pueden conocer los que asistieron a la charla. Una de estas cosas, que tendrá un artículo en breve, es el bloc de notas Joplin, una aplicación de código abierto que puede remplazar a Evernote sin demasiados problemas. Añade la posibilidad de sincronizar los datos con NextCloud para tener una pareja ganadora.

Conclusiones

Por los comentarios de los asistentes, parece que la charla se hizo corta y para nada pesada. No es sencillo conseguir eso cuando empiezas a tratar con cosas técnicas. Para otras entregas quedaría entrar más en detalle de Sphinx. No es complicado de utilizar (la salud mental se pierde más despacio que con LaTeX) y se pueden conseguir resultados bastante interesantes. Habrá casos en los que será una herramienta más compleja de lo necesario. En esos casos puede ser suficiente con Markdown y Joplin.

0 comentarios

Dejar un comentario

¿Quieres unirte a la conversación?
Siéntete libre de contribuir!

Deja un comentario

Tu dirección de correo electrónico no será publicada. Los campos obligatorios están marcados con *

Este sitio usa Akismet para reducir el spam. Aprende cómo se procesan los datos de tus comentarios.