HelpNDoc te ofrece una potente función de creación de scripts que utiliza la API HelpNDoc para automatizar tareas repetitivas. Esta función avanzada te permite escribir nuevos scripts y cargar scripts existentes, ejecutar y crear scripts y guardar scripts para su uso futuro.
Puedes elegir cómo quieres que HelpNDoc procese tus ítems de biblioteca (imágenes, vídeos, documentos…): pueden incluirse dentro del proyecto, o ser incluidos dinámicamente en el momento de la generación, cuando decidas crear tus archivos finales de documentación. Con esta segunda opción, indicas una ruta a tus ítems audiovisuales, de manera que HelpNDoc pueda encontrarlos e incluirlos cuando sea necesario. Esto es muy útil para tener controlados los ítems desde fuera de HelpNDoc, compartirlos con un software de terceros… No obstante, puede producirse un problema si es necesario trasladar esos ítems en tu disco duro o en la ruta de red. Para garantizar que HelpNDoc pueda seguir encontrando tus elementos audiovisuales, tendrás que actualizarlos todos manualmente, uno a uno. Como esta puede ser una tarea bastante larga, aburrida y propensa a los errores, es la oportunidad perfecta para utilizar el potente editor de scripts de HelpNDoc. Veamos cómo podemos sacarle partido para actualizar con rapidez la biblioteca completa en sólo unos segundos
Nos complace anunciar el lanzamiento de HelpNDoc 7.7, una importante actualización de la popular herramienta de creación de documentación de ayuda que puedes descargar de forma totalmente gratuita para uso personal y de evaluación. Esta importante actualización incluye muchas nuevas funciones y mejoras, como un editor de scripts muy mejorado con funciones buscar/reemplazar y múltiples opciones nuevas personalizables, la capacidad para indexar palabras de una sola letra en el motor de búsqueda HTML, nuevas opciones de línea de comandos para abrir un proyecto en temas específicos, soporte Windows 11 oficial y mucho más… Sigue leyendo para saber más y descarga ahora tu versión gratuita de HelpNDoc.
Una herramienta de creación de documentación de ayuda estándar como HelpNDoc es un programa de software en el que generalmente se escribe y organiza contenido para producir archivos de documentación para el usuario final. Según van haciendo falta revisiones, es imprescindible que el contenido permanezca organizado, algo que habitualmente implica gran cantidad de tareas pesadas y propensas a los errores, como pueda ser copiar y pegar contenido por todo el proyecto, eliminar contenido, desplazar o combinar temas… Por suerte, HelpNDoc incluye un poderoso procesador de scripts que puede ayudar a automatizar la creación de documentación, el mantenimiento, la reorganización… Ahora veremos cómo sacar partido a las funciones de creación de scripts de HelpNDoc para combinar varios temas hijos en un tema padre
Cuando terminas de escribir un archivo de ayuda o una página web de documentación, normalmente te gustaría poder integrarlos con tus productos existentes: cuando los usuarios encuentren dificultades al realizar una acción, deberían poder abrir el archivo de ayuda y ver directamente el tema asociado correspondiente que explica esa acción específica. Con este propósito, las herramientas de creación de documentación de ayuda como HelpNDoc ofrecen dos identificadores únicos para cada tema: una ID de Ayuda alfanumérica y un número de Contexto de Ayuda. Con esto se puede llegar a un tema específico desde la aplicación de software o desde la página web. Pero como escritor técnico, es probable que no sea responsabilidad tuya "cablear" esa aplicación o página web con el archivo de ayuda, por lo que quizá prefieras enviar una lista de identificadores de temas a los desarrolladores encargados de ello. Gracias al potentísimo editor de scripts de HelpNDoc, ¡puedes hacerlo fácilmente!
Para acceder al editor de scripts, haz clic en Editor de Scripts en la pestaña Herramientas de HelpNDoc. Con esto se abrirá la ventana “Redacción y ejecución de scripts”. Tienes dos opciones:
Introducir un nuevo script manualmente, o Cargar un script existente haciendo clic en Cargar script, en la esquina inferior izquierda de la ventana, para importar el script. La API HelpNDoc ofrece una diversidad de funciones y procedimientos para ayudarte a automatizar tareas.
El reciente lanzamiento de HelpNDoc 6.4 incluye una plantilla mejorada HTML de una página que ofrece la opción de añadir una tabla de contenido a la documentación HTML de una página producida. Obviamente, hemos utilizado el potente editor de plantillas de HelpNDoc para modificar la plantilla de una página, y hemos pensado que sería buena idea documentar este proceso con efectos didácticos. Sigue los pasos descritos en este artículo para aprender a crear y a modificar plantillas de documentación basadas en HTML utilizando las herramientas integradas de HelpNDoc.
HelpNDoc 6.0 contiene mayor soporte para estatus de temas, simplificando enormemente el mantenimiento de proyectos de documentación para los autores técnicos: se pueden etiquetar los temas como "Sin Actualizar", "En Progreso", "Por Revisar", "Completo", o cualquier estatus personalizado que definas. Es posible que te apetezca sacar partido a esta función para actualizar un antiguo proyecto y cambiar el estatus de todos tus temas a "Por Revisar" para empezar a revisarlos uno por uno. Pero actualizar individualmente cada tema es un gran proyecto que llevará tiempo. Por suerte, las funciones de scripts de HelpNDoc permiten actualizar los estatus de todo el proyecto de documentación en un instante. Vamos a ver cómo podemos hacerlo.
Escribir un archivo de ayuda online, un manual de usuario, un eBook o cualquier otro formato admitido por HelpNDoc suele ser un proceso prolongado, continuo y no lineal. Con frecuencia, a medida que evoluciona el contenido, la jerarquía de los temas en general puede degradarse, por lo que es necesaria una reorganización para hacer la documentación más fácil de leer y de navegar. Aunque HelpNDoc ofrece herramientas para reorganizar fácilmente la tabla de contenido, en algunas ocasiones este puede ser un proceso largo y susceptible a los errores, como cuando es necesaria una ordenación alfabética de los temas. Afortunadamente, HelpNDoc incluye scripts para reordenar automáticamente los temas por título. Comprobemos lo rápido y fácil que puede hacerse esto
HelpNDoc incluye un editor de scripts muy potente con acceso a múltiples métodos API que ofrece un medio para automatizar prácticamente todas las partes del proceso de creación y mantenimiento de la documentación. Ya hemos visto cómo usar las funciones con scripts de HelpNDoc para automatizar la creación de documentos y archivos de ayuda, actualizar la ruta de los elementos audiovisuales externos cuando los mismos son trasladados y exportar códigos de ID de Ayuda y Contexto de Ayuda para tus desarrolladores. Veamos ahora cómo podemos crear un script muy conveniente para restablecer de manera automática los números de Contexto de Ayuda para todos los temas del proyecto de documentación
HelpNDoc es tan fácil de usar, que es posible producir una documentación completa multiformato y multidispositivo sólo unos minutos después de descargar y probar HelpNDoc por primera vez, gracias a su intuitiva interfaz de usuario y al editor de temas de aspecto similar a Microsoft Word. También es extremadamente potente y ofrece muchas herramientas avanzadas para simplificar y acelerar la creación de impresionantes manuales y archivos de ayuda. Una de esas funciones avanzadas es el editor de scripts, que te permite manipular HelpNDoc mediante un lenguaje de scripts. Veamos ahora cómo puede ayudarte el editor de scripts a crear los archivos de ayuda más útiles en la menor cantidad de tiempo posible
