Traducción de documentación en línea

La traducción de la documentación en línea se realiza del mismo modo que la traducción de aplicaciones y que la traducción de documentación de las aplicaciones.

La documentación en línea no es la misma documentación que acompaña a las aplicaciones. Aunque ambas sirven, en última instancia, para generar el manual de las aplicaciones, la documentación en línea no está escrita en formato DocBook y tampoco reside en el directorio docmessages, sino en el directorio típico de las aplicaciones messages. El nombre de estos paquetes comienza por documentation-.

No obstante, no conviene olvidar que se trata de manuales del usuario, por lo que deberemos tener en cuenta los mismos detalles importantes que cuando se traducen archivos de documentación de aplicaciones.

reStructuredText

Por lo general, la documentación en línea de las aplicaciones está escrita usando el lenguaje de marcas ligero reStructuredText y también hace uso de la sintaxis de Sphinx, el generador de documentación para Python. Además de todos los requisitos necesarios para traducir KDE al español, conviene estar familiarizado con este lenguaje para tener una idea clara de lo que se debe y de lo que no se debe traducir.

Enlaces

Una de las principales fuentes de errores que nos podemos encontrar al traducir estos archivos son los enlaces. Podemos encontrarnos tres tipos de enlaces: externos, implícitos a títulos y explícitos a etiquetas.

Un enlace externo, comienza con un acento grave seguido del texto que se mostrará como etiqueta, un espacio en blanco, el enlace externo entre llaves angulares, y termina con un acento grave más un signo de subrayado:

  The `KDE website <https://www.kde.org>`_

En este caso, podemos traducir la etiqueta del enlace (que es el texto que hay entre el primer acento grave y el espacio anterior al símbolo <, respetando siempre ese espacio en blanco). No hay que olvidar que el símbolo de subrayado final es necesario. Hay que tener en cuenta que es posible que no contenga un texto a mostrar, en cuyo caso tampoco habrá un espacio entre el primer acento grave y el símbolo <.

Un enlace implícito a un título es similar al anterior, aunque se omite la dirección del enlace, ya que apunta a algún lugar del mismo archivo:

  This is a link to `reStructuredText`_ on this page.

En este caso, podemos traducir el contenido del enlace, que apuntaría a la sección del mismo nombre de esta página.

Un enlace explícito apunta a una etiqueta definida en otro archivo:

  This is a link to a sectionlabel_ on another page.

En este caso, no traduciremos sectionlabel_, ya que es la etiqueta del enlace. También es posible que aparezca con la forma:

  This is a link to a :ref:`sectionlabel` on another page.

En este caso, además de no traducir la etiqueta del enlace, tampoco traduciríamos el elemento :ref:. También hay que observar que en este caso no existe un signo de subrayado al final del enlace.

Notas

Existen diversos elementos que no se deben traducir. En general, cualquier palabra que vaya encerrada entre signos de dos puntos (:).

También hay que recordar que las palabras encerradas entre signos de dos puntos no pueden contener espacios en blanco.

A veces veremos dos signos de dos puntos seguidos al final de una frase (::). No se trata de un error y hay que dejarlos tal y como están.