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.

Ejecutar el script de ordenación de temas

HelpNDoc no sólo incluye potentes funciones con scripts, también viene provisto de útiles fuentes de scripts, como los scripts “SortAllTopics” (para ordenar todos los temas) y “SortChildTopics” (para ordenar los temas hijos), capaces de ordenar automáticamente los temas por título.

Script de ordenación de temas

Una vez hayas añadido algunos temas a tu documentación, y quizá los hayas organizado, las funciones con scripts de HelpNDoc son útiles para automatizar la tarea de ordenación de temas:

  1. Desde la pestaña “Herramientas” de HelpNDoc, haz clic en “Editor de scripts”
  2. Desde la ventana del editor de scripts, haz clic en la flecha que hay junto al botón “Cargar script”
  3. Haz clic en “SortAllTopics.hnd.pas” para cargar el script de ordenación
  4. Haz clic en “Ejecutar script”… ¡y listo! Toda la tabla de contenido está ordenada por título

Hasta aquí todo es bastante fácil. Pero, ¿qué sucede si sólo necesitas ordenar algunos temas, y no todos ellos? Sencillamente, selecciona un tema en la tabla de contenido, carga y ejecuta el script “SortChildTopics.hnd.pas” de la manera explicada anteriormente, y se ordenarán alfabéticamente todos sus hijos.

Orden personalizado y requisitos especiales

Editor de scripts

Ordenar los temas por título no siempre resulta útil, y algunos proyectos podrían necesitar una ordenación automatizada de los temas en base a ciertos atributos diferentes, como puedan ser los identificadores de ayuda de los temas. En el caso de estos atributos especiales, los scripts incorporados pueden servir de punto de partida y personalizarse fácilmente utilizando la potente y amplia API de HelpNDoc.

De su interfaz de usuario clara y directa a sus funciones avanzadas de creación de scripts, HelpNDoc contiene todas las herramientas necesarias para producir increíbles archivos de ayuda, manuales de producto, eBooks… con toda la rapidez y facilidad posibles. Y lo mejor es que HelpNDoc es completamente para uso personal y de evaluación. ¡Pruébalo ahora y disfruta creando documentación!

Ver también...

Escritor técnico contento usando HelpNDoc [happy] [Featured]
Aprovechar HelpNDoc al máximo: Beneficios de la función "Mantener Archivos Temporales" para los escritores técnicos

Al trabajar creando documentación técnica, toda herramienta y función de la que dispongamos puede marcar una diferencia considerable en la productividad y la eficacia. En HelpNDoc, una de estas …

Lee Mas →
Convertir archivos antiguos de WinHelp en documentación moderna [converting] [Featured]
Revitaliza tus archivos de ayuda: convierte archivos antiguos WinHelp HLP en documentación moderna con HelpNDoc

En una época en la que la información se consume en una enorme variedad de dispositivos y plataformas, los archivos clásicos WinHelp HLP (que en su momento fueron la documentación de ayuda estándar …

Lee Mas →
HelpNDoc vs WordPress [versus] [Featured]
Dominar la publicación multicanal: Por qué HelpNDoc es mucho mejor que WordPress

En el mundo digital interconectado de hoy en día, el concepto de publicación multicanal se ha hecho más esencial que nunca. Al buscar el público información a través de diversas plataformas y …

Lee Mas →
Cuadro de diálogo Generar documentación de HelpNDoc [generate] [Featured]
Empoderando a los escritores técnicos: saca partido a las funciones de anulación de HelpNDoc para obtener variaciones ilimitadas de tu documentación

En el siempre cambiante paisaje de la escritura técnica, la necesidad de flexibilidad, personalización y eficacia es más importante que nunca. Como escritores técnicos, a veces tenemos entre manos …

Lee Mas →

Categorías: artículos