Documentación/Capturas de pantalla

From The Document Foundation Wiki
Jump to: navigation, search

Capturas de pantalla para la documentación

Esta página describe cómo crear capturas de pantalla de los cuadros de diálogo de LibreOffice e incluirlos en la documentación y la ayuda de LibreOffice. La precondición es tener un clon de Git del repositorio «help» de LibreOffice o compilar el código del repositorio «core» con la opción --with-help. Para crear capturas en varios idiomas, utilice la opción --with-lang=$lista_idiomas, donde $lista_idiomas representa una enumeración de códigos de dos o tres letras separados por espacios: por ejemplo, en-us de fr es ru.

Conceptos básicos

Cada uno de los cuadros de diálogo de LibreOffice tiene un identificador de ayuda único, que sirve para que el explorador de ayuda sepa cuál página mostrar cuando un usuario pulse en el botón de ayuda de un cuadro de diálogo concreto. El identificador suele lucir así:

cui/ui/areatabpage/AreaTabPage

Como puede observarse, es semejante a la ruta donde se almacena el archivo .ui del cuadro de diálogo correspondiente. Decidimos que los identificadores de las capturas (y, por ende, las rutas de archivo donde estas se almacenan) coincidan con los identificadores de ayuda, para evitar tener que mantener una asignación alternative. Por consiguiente, la captura del cuadro de diálogo mencionado más arriba (Formato ▸ Área) puede encontrarse en esta ruta:

cui/ui/areatabpage/AreaTabPage.png

y su versión traducida (donde $código_idioma es el código de dos o tres letras de la lengua dada) se ubica en:

cui/ui/areatabpage/$código_idioma/AreaTabPage.png

En el árbol de fuentes de la ayuda de LibreOffice («help»), los archivos de las capturas que se incluyen en las páginas de ayuda (los archivos .xhp) están almacenados dentro la carpeta siguiente:

helpcontent2/source/media/screenshots

organizados en las rutas correspondientes con sus identificadores de captura, como se describe más arriba.

Crear una serie de capturas automáticamente

Para crear capturas de todos los cuadros de diálogo de LibreOffice de una sola vez, ejecute:

make screenshot

en la carpeta raíz de su árbol de fuentes de LibreOffice. También puede crear capturas por módulos individuales. Por ejemplo, esta orden crea capturas de todos los cuadros de diálogo de LibreOffice Calc («sc»):

make sc.screenshot

Cuando la orden termine de ejecutarse, las capturas se almacenarán en esta carpeta del árbol de fuentes:

workdir/screenshots

bajo las rutas que correspondan con sus identificadores de captura, como ya se describió. Si ha compilado LibreOffice con compatibilidad para varios idiomas (--with-lang, véase más arriba), esta ejecución creará capturas automáticamente en todos los idiomas con que ha compilado.

Crear capturas manualmente

Para capturar ventanas mientras ejecuta LibreOffice, necesitará activar la modalidad de capturas de pantalla (parecida al modo experimental) en Herramientas ▸ Opciones ▸ Avanzado ▸ Abrir configuracion para expertos; la clave de configuración relevante es org.openoffice.Office.Common.Misc.ScreenshotMode. Cuando la modalidad quede activada, pulse con el botón secundario del ratón en la zona de acciones (donde se ubican los botones «Aceptar», «Cancelar», etc.) de cualquier cuadro de diálogo. Aparecerá un menú contextual:

Screenshotmode.png

Pulse en el elemento Captura de pantalla del menú contextual para capturar el cuadro de diálogo actual. En la ventana que aparece se mostrará una previsualización de la imagen y un cuadro de texto. Si le satisface el resultado, pulse en «Guardar captura…» para almacenar la imagen en la carpeta que usted elija; de preferencia, hágalo directamente en la carpeta helpcontent2/source/media/screenshots y la ruta que corresponda con su identificador de captura.

Incluir capturas de pantalla en las páginas de ayuda

  1. Si ha creado la captura con la ayuda de la orden make screenshot, copie la imagen de la carpeta workdir/screenshots a helpcontent2/source/media/screenshot
  2. Si, por el contrario, creó la captura manualmente, lo más conveniente es guardarla directamente en helpcontent/source/media/screenshots, respetando la ruta del identificador de captura.

Ahora puede emplear su método preferido para editar los archivos de ayuda (de forma manual o bien mediante la extensión HelpAuthoring). El fragmento de código necesario que se ha de incluir en el archivo de ayuda .xhp puede asemejarse a este (para el cuadro anterior, con la ruta a la imagen resaltada):

<paragraph id="par_id083120160609088310" role="paragraph" xml-lang="en-US"><image id="img_id083120160608495768" src="media/screenshots/cui/ui/areatabpage/AreaTabPage.png"
 width="9.0417in" height="6.9791in"><alt xml-lang="en-US" id="alt_id083120160608495768">Area dialog</alt></image></paragraph>

Como alternativa, cuando cree una captura manualmente, puede copiar y pegar el fragmento de código tal y como lo genera la ventana de anotación:

ScreenshotMarkup.png

Enviar sus modificaciones

No hay diferencias con respecto del proceso para enviar otras modificaciones al repositorio, pero hay que cerciorarse de que el control de versiones de Git esté informado de los archivos de imagen nuevos:

git add source/media/screenshots/captura/que/ha/añadido.png 
git add source/text/archivo/de/ayuda/que/modificó.xhp
git commit -m "Added new cool screenshots"