Scripty

Scripty son un conjunto de scripts de utilidades que se ejecutan desde la consola y permiten realizar ciertas tareas complejas, como descargar la documentación original de una parte o de la totalidad del repositorio de KDE, generar archivos de documentación de aplicaciones en formato DocBook, etc.

Instalación

Scripty se puede descargar directamente desde su repositorio.

Para descargar Scripty deberemos de instalar previamente la herramienta cliente de Git. Luego podemos usar una ventana de terminal, en la que crearemos en primer lugar un directorio para instalarlo y cambiaremos a él. Posteriormente ejecutaremos la siguiente orden:

  git clone git@invent.kde.org:sysadmin/l10n-scripty.git

Esta orden creará en el directorio actual un subdirectorio llamado scripty que contendrá nuestra instalación de Scripty.

Para actualizarlo cada vez que nos interese hacerlo, volveremos al directorio donde lo habíamos descargado y ejecutaremos en él la siguiente orden desde la consola:

  git pull scripty

Dentro del directorio scripty existen diversos scripts que deberemos ejecutar desde la consola. Por ello, tal vez sea conveniente añadir dicho directorio a nuestra variable del sistema $PATH. En caso contrario tendremos que indicar la ubicación completa de cada orden cada vez que vayamos a ejecutarla.

Uso de Scripty

Scripty contiene varias herramientas, aunque la principal de ellas es update_xml, que es la que permite generar los archivos de documentación en formato DocBook a partir de los archivos PO completamente traducidos.

El directorio contiene un archivo README con una breve descripción en inglés de las utilidades más importantes.

A continuación se describen algunas de las herramientas que nos proporciona Scripty.

Descargar documentación

Si deseamos generar en nuestro equipo los archivos de documentación en formato DocBook de un programa una vez hayamos traducido completamente todos los correspondientes archivos en formato PO, necesitaremos descargar previamente su documentación completa en inglés. Para ello ejecutaremos desde la consola la siguiente orden:

  /ruta/a/scripty/populate_documentation.sh nombre-de-repositorio

Si se indica un nombre de repositorio, se descargará solo la documentación de dicho repositorio (por ejemplo, kstars, para descargar la documentación original en inglés del programa KStars).

Si no se indica ningún repositorio, se descargará la documentación de todos los repositorios (es decir, de todos los programas) de dicha rama.

Generar documentación

Si lo que deseamos es generar en nuestro equipo el correspondiente archivo DocBook tras haber completado la traducción de todos sus archivos PO (y tras haber descargado su documentación original en inglés), ejecutaremos en una consola la siguiente orden:

  /ruta/a/scripty/update_xml idioma repositorio programa

Los parámetros repositorio y programa son opcionales. Si no se indica ninguno de ellos, se generará la documentación de todos los programas que tengamos descargados en nuestra copia local del repositorio para el idioma indicado (en la rama en la que se ejecute la orden). Esto puede tardar bastante tiempo y generar muchos errores si la documentación no está completamente traducida o si contiene errores.

Si se indican solo los parámetros idioma y repositorio, se generará la documentación de todos los programas que componen dicho repositorio para el idioma indicado (por ejemplo, si se indica ark, se generará la documentación del manual de usuario de Ark y su página man, ya que ambos se encuentran en el mismo repositorio).

Si se indican los tres parámetros, se generará la documentación del programa indicado dentro del repositorio indicado para el idioma en cuestión (por ejemplo, y siguiendo con el ejemplo del párrafo anterior, si se indica ark ark_man-ark, se generará la página man del programa Ark, pero no su manual de usuario).