Domando el Sistema de Ayuda de LibreOffice
El sistema de ayuda de LibreOffice necesita evolucionar y ser más efectivo para los usuarios.
por Olivier Hallot
Fue diseñado en 2003-2004 y liberado en 2005. Desde entonces no ha evolucionado, excepto por la introducción de una versión online alojada en un servidor wiki (y accesible desde LibreOffice cuando la ayuda local no está instalada).
Recientemente trabajé para transformar nuestro antiguo sistema de ayuda en una versión moderna basada en un navegador web. El resultado parcial está disponible en el sitio web (temporal) https://helponline.libreoffice.org – por favor tenga en cuenta que se trata de un trabajo aún en progreso.
Las páginas de ayuda XML son transformadas en HTML puro, casi estático y responsivo. Este enfoque tiene algunas ventajas:
- Funciona en cualquier navegador web
- Provee la funcionalidad actual del sistema de ayuda
- Preserva el desarrollo actual, la autoría de la ayuda, ingeniería de lanzamiento y proceso de traducción como está
- Puede leer las páginas de ayuda en su teléfono móvil o tableta
- Resulta sencillo agregar marcado adicional para mejorar la indexación de los motores de búsqueda
La desventaja es un incremento en el espacio ocupado en el servidor.
Transformar XML en HTML para todos los navegadores
Las páginas de ayuda fueron diseñadas cuando el estándar HTML mínimo era la versión 3.2 y, desde entonces, muchos desarrollos nos han traído HTML5 en todos los navegadores principales. Ahora existe una pequeña ventaja para mantener el XML actual, y toda su funcionalidad diseñada puede ser reemplazada y mejorada mediante HTML, CSS y JavaScript, por ejemplo, agregando mejor navegación y contenidos multimedia.
La nueva disposición de la página de ayuda se beneficia de muchas tecnologías modernas
Funcionalidad del sistema de ayuda preservada
Con el uso de hojas de estilo en cascada (CSS) y JavaScript, fue posible emular y preservar la funcionalidad del sistema de ayuda offline.
Uso móvil
Puede preguntarse por qué un software de escritorio necesita un sistema de ayuda que quepa en un teléfono móvil o tableta. Actualmente, las paginas de ayuda online non solo pueden ser abiertas por LibreOffice en su navegador de escritorio, sino también ser una referencia de LibreOffice para otros usos – tales como una simple navegación web y respuestas a una búsqueda web.
¿Sistema de ayuda en un teléfono móvil?
Búsqueda desde la web
Muchos de nosotros estamos familiarizados con el hecho de que las páginas devueltas por un mecanismo dependen de la cuidadosa configuración de páginas HTML. El dominio de la optimización de motores de búsqueda (SEO) es una avenida abierta para mejoras en el sentido de que escribimos contenido de ayuda y usamos la configuración adecuada. Las opiniones y consejos de la comunidad son bienvenidas. Como un comienzo la ayuda online contiene un conjunto de microdatos de schema.org bajo el esquema TechArticle.
El camino por delante para la ayuda de LibreOffice
Se puede hallar aún una mejor solución para la ayuda de LibreOffice. El tema principal continua siendo encontrar una mejor herramienta para editar XML de manera confortable, facilitar la incorporación de multimedia y otro tipo de contenido. Editar archivos XML no es una tarea divertida para la mayoría de nosotros, y se lleva a cabo con editores de texto o la vieja extensión de Autoría de Ayuda. Aquí dos enfoques posibles para facilitar el trabajo de creación:
Mejorar la Extensión de Autoría para manejar las mejoras de contenido para la ayuda de LibreOffice (ej. multimedia), o mudar de manera progresiva a HTML(5) puro, para aprovechar los cientos de editores HTML WYSIWYG disponibles tanto online como offline…
Extensión de Autoría de Ayuda instalada en LibreOffice Writer
La Extensión de Autoría de Ayuda se instala en LibreOffice para permitir la edición de páginas en Writer. Tiene la ventaja de realizar muchas verificaciones de XML, pero al mismo tiempo se convierte en un desafío modernizar su conjunto de macros BASIC, transformaciones XSLT y estilos.
Por otro lado, la estrategia es agregar progresivamente nuevas etiquetas de HTML puro en el DTD (Definición de Tipo de Documento) XML, eliminando de manera lenta y cuidadosa algunos de los complejos marcados del XML actual. Como ejemplo, la actual etiqueta XML
<paragraph id=”hd_id3147331″ role=”heading” level=”1″ xml-lang=”en-US”>
puede ser reemplazada por la etiqueta HTML bien conocida
<h1 id=”hd_id3147331″>
porque ya sabemos que role=”heading” y level=”1” significan unívocamente <h1> y xml-lang ya no se utiliza. En la wiki se puede encontrar un mapeo parcial de etiquetas XHP a HTML5.
Conclusión
Queremos que nuestra aplicación de ayuda sea más amigable con el usuario, brindar contenido moderno y ser una referencia para LibreOffice en la web. La nueva disposición de la ayuda online constituye un paso en esta dirección, pero aún resta mucho camino y la comunidad de LibreOffice está invitada a ayudarnos. Únete al Equipo de Documentación
Acerca del Autor
Daniel A. Rodriguez
Colaboro de manera voluntaria con The Document Foundation desde el año 2011, me ocupo de mantener el sitio en español, de este blog y también de canalizar las consultas de usuarios a los canales apropiados. Soy, además, uno de los administradores del grupo hispano en Matrix (libreoffice_es:matrix.cuates.net) y en Telegram (https://t.me/libreoffice_es).
