Traducción de la documentación

La traducción de la documentación se realiza del mismo modo que la traducción de archivos de mensajes de aplicaciones. Los archivos PO de la documentación están en el directorio l10n/es/docmessages/. Un procedimiento automático genera los archivos docbook en el repositorio a partir de los archivos PO traducidos. El modo más sencillo y rápido para traducir la documentación es utilizar KBabel.

Detalles importantes

Se deben observar algunos detalles importantes durante el proceso de traducción:

• Si un archivo PO no está totalmente traducido (es decir, si contiene entradas dudosas o sin traducir) y se deposita en el repositorio, el procedimiento automático no generará el archivo docbook correspondiente.
• Existen documentos que por su tamaño se han dividido en múltiples archivos PO. Por ejemplo, las FAQ. Para que el procedimiento automático genere la documentación correspondiente, deben estar traducidos todos los archivos PO de dicha documentación.
• Aquellas palabras que aparecen entre un signo & y un punto y coma (como &application;) corresponden habitualmente a nombres de aplicaciones definidas en un archivo general. Por tanto es muy importante copiarlas exactamente desde el mensaje original y no traducirlas. El olvido del punto y coma genera errores en la traducción.

Títulos de crédito

Incluiremos nuestro nombre y dirección de correo electrónico en los títulos de crédito de la documentación de una de las dos siguientes maneras:

• Si encontramos una entrada ROLES_OF_TRANSLATORS, la traduciremos, por ejemplo, como:
  

      <othercredit role=\"translator\">
      <firstname>Fulanito</firstname>
      <surname>Pérez</surname>
      <affiliation>
      <address>
      <email>fulanito@miisp.com</email>
      </address>
      </affiliation>
      <contrib>Traductor</contrib>
      </othercredit>
  

• Si, por el contrario, encontramos una entrada marcada como CREDIT_FOR_TRANSLATORS, la traduciremos así:
  

      <para>Traducido por Fulanito Pérez
      <email>fulanito@miisp.com</email></para>
  

Verificando nuestro trabajo

Tras concluir la traducción y realizar las mismas validaciones que para el caso de las aplicaciones, se puede comprobar que nuestro trabajo es correcto. Para ello es necesario ejecutar (desde la carpeta l10n) el procedimiento:

   scripts/update_xml es

Este comando se encuentra situado en la carpeta l10n/scripts (por lo que será necesario disponer de ella en nuestra copia local del repositorio, al igual que de las carpetas l10n/es, l10n/templates y l10n/documentation).

También es posible generar la documentación de un solo paquete. Por ejemplo, para generar la documentación del paquete kdeedu, habrá que ejecutar:

  scripts/update_xml es kdeedu

Incluso es posible generar la documentación de un único programa perteneciente a un paquete. Por ejemplo, para generar la documentación de Kalzium, habrá que ejecutar:

  scripts/update_xml es kalzium

Hay que tener en cuenta que update_xml solo funciona bien si se ha instalado KDE 2.2 o superior. Este procedimiento no solo comprueba la validez de los archivos sino que también genera los archivos docbook.

A modo de ejemplo, para generar y comprobar la documentación de kdeadmin es necesario tener una copia de l10n/documentation/kdeadmin, de l10n/es/docmessages/kdeadmin y de l10n/es/docs/kdeadmin. El procedimiento scripts/update_xml generará los correspondientes mensajes de error si los hubiera. En la mayor parte de los casos, estos mensajes son autoexplicativos y permiten identificar el error y corregirlo. La nueva documentación será generada en la carpeta l10n/es/docs/kdeadmin.

A continuación puedes ejecutar meinproc sobre los archivos docbook (también se puede usar el comando kdb2html en su lugar) y comprobar con un navegador en el directorio HTML los archivos html que se han generado. Lee el texto que has traducido, y en el caso de que encuentres errores, corrige en el archivo PO original los fallos. Después tendrás que repetir el proceso para generar los archivos docbook y html otra vez.

Cuando estés a gusto con la traducción, envíasela al coordinador para que la suba al repositorio y envía un mensaje a la lista de correo de KDE-ES para que el resto sepa que la traducción ya está lista.