Nvdaes. Un programa desarrollado en Electron con NVDA

Domingo, 21 de julio de 2019

Nvdaes es un programa desarrollado para facilitar la creación de tablas con información sobre complementos de NVDA actualizados en un periodo de tiempo, para publicarlas en la lista de correo asociada a esta web, normalmente con el hashtag #ComunidadInternacional.

Nota importante

Este proyecto no tiene firma digital y lo inicié para mi uso particular. No obstante, puesto que se encuentra disponible públicamente y al menos lo ha utilizado otro miembro de la lista, comparto información sobre cómo utilizar el programa y colaborar en su desarrollo.

Instalación

El instalador para Windows (fichero .exe) está disponible en la página de la última versión de Nvdaes.

Al ejecutar el instalador, aparecerá una ventana con el texto “Installing”, y es posible localizarla con alt+tab. Al terminar de instalarse, el programa se abrirá automáticamente.

El proceso de instalación puede resultar confuso, ya que no se leerán mensajes que indiquen su progreso… Será cuestión de esperar.

Descripción de la interfaz

Al abrir el programa aparecerá una interfaz similar a una página web, y se conectará a internet para intentar averiguar el número de la versión más reciente disponible. Algunos de sus elementos son:

  • Punto de referencia título: nombre y versión actual de la aplicación y, si se ha podido obtener, un enlace para descargar la versión más reciente (o el mensaje “Última versión no encontrada”).
  • Punto de referencia principal: botón para mostrar y ocultar la ayuda, enlace al wiki de la lista (para pegar la tabla actualizada) y un formulario para introducir los cambios en los complementos actualizados y crear la tabla correspondiente. Los cambios descritos en el formulario aparecerán como comentarios, y el programa proporcionará automáticamente otros datos, como los autores y el enlace para cada complemento actualizado.
  • Información de contenido: enlace al repositorio del programa, enlace a la licencia (GPL 2.0, para su libre uso y modificación, y datos de contacto para proponer mejoras o informar sobre errores.

Ayuda para usar la aplicación (disponible en el programa)

Esta aplicación puede ayudar a crear tablas de complementos actualizados en un periodo de tiempo, para publicarlas en la lista nvdaes de groups.io con el hashtag #ComunidadInternacional.

Procedimiento
  1. Describir los cambios en los cuadros de edición correspondientes a los complementos actualizados.
  2. Activar el botón Crear tabla markdown.

La tabla aparecerá en este documento como un punto de referencia complementario y podrá ser leída automáticamente por lectores de pantalla. También se copiará al portapapeles, precedida por el enlace a latabla de complementos del wiki, de forma que pueda pegarse en un mensaje de correo electrónico.

Es posible editar la tabla en el wiki de la lista mediante el enlace correspondiente o pulsando alt+0. De esta forma la tabla se convertirá a formato HTML.

Mediante los botones Abrir y Guardar archivo de datos se podrán importar y exportar datos almacenados con esta aplicación, para actualizar el formulario con los comentarios introducidos en sesiones anteriores.

(Fin de la ayuda)

Algunos formatos usados por Nvdaes: markdown, HTML y JSON

El formato markdown sirve para escribir y crear fácilmente documentos con elementos como encabezados, listas, enlaces, etc. Este post está creado con un editor de texto, escribiendo en formato markdown.

Aquí hay una guía de markdown en español.

HTML es un lenguaje usado para publicar en la web. Al subir este post a la plataforma GitHub, donde se aloja esta web, el formato markdown se convierte automáticamente en HTML, de forma que los navegadores puedan mostrarlo correctamente.

Para ver esta web convertida en formato HTML, usa la opción “ver código fuente” de tu navegador. Por ejemplo, en Firefox con Windows puede funcionar la combinación de teclas control+u.

Cuando la tabla markdown creada con la aplicación Nvdaes se pega en el wiki de la lista, se convierte automáticamente en HTML y se muestra correctamente en navegadores web.

Ejemplo de tabla markdown

| Complemento | Autor/mantenido por | Enlace | Comentario |
| --- | --- | --- | ---|
| Developer Toolkit | Andy Borka | https://addons.nvda-project.org/addons/developerToolkit | Versión 2019.1.2: mejora la estabilidad, la información sobre valores de posición y tamaño, etc. |
| Outlook extended | Cyrille Bougot, Ralf Kefferpuetz | https://addons.nvda-project.org/addons/outlookExtended | Versión V1.3-dev-20190719: intenta resolver un problema con encabezados en nuevas versiones de Office 365. |

Tabla creada con [aplicación Nvdaes](https://github.com/nvdaes/appNvdaes)

Este es el resultado en el wiki de la lista.

El programa Nvdaes puede guardar datos introducidos en su formulario almacenándolos en ficheros .json. A su vez, al abrir un fichero de datos, generará un formulario en el que se rellenarán automáticamente los campos correspondientes a complementos actualizados en sesiones anteriores. Esto puede ser útil para crear una sola tabla en varias sesiones.

El formato JSON se usa para intercambiar datos.

Consultar información sobre JSON en Wikipedia

Cómo colaborar

Como siempre, los aportes para mejorar este programa o cualquier proyecto activo en mi cuenta de GitHub (@nvdaes) se agradecen y son bienvenidos. Algunas formas de colaborar son:

  • Proponiendo mejoras o informando sobre errores, por ejemplo, en la lista sobre NVDA que aparece en el menú de navegación de esta web.
  • Creando una incidencia o pull request en el repositorio de la aplicación Nvdaes.

Aspectos sobre el desarrollo de la aplicación

La aplicación está desarrollada con Electron, concretamente, Electron-forge.

Electron sirve para crear aplicaciones de escritorio mediante lenguajes usados en la web (HTML, JavaScript y CSS). Ofrece la posibilidad de presentar una interfaz similar a páginas web, accesible mediante el modo exploración de NVDA, y cuadros de diálogo usados habitualmente, para abrir, guardar archivos, etc.

Para trabajar en el desarrollo de esta aplicación, puede ser aconsejable:

  • Instalar npm
  • Instalar Electron-forge: npm install -g electron-forge
  • Clonar el repositorio, por ejemplo, usando Git, ejecutando: git clone https://github.com/nvdaes/appNvdaes
  • Desde el directorio de la aplicación se podrá ejecutar: npm install para disponer de las dependencias necesarias.
  • Para ejecutar la aplicación: npm start

Para modificar la interfaz del programa o añadir nuevos complementos, puedes editar los ficheros “src/index.html” y “src/customScripts/form.js”.

También puedes crear hojas de estilo (ficheros .css) para cambiar la apariencia visual.

Referencias