Ordenar rápidamente contenido de ayuda, encabezados de documentación o temas de eBooks por título

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.

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

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...

Cómo personalizar la posición y tamaño iniciales de los archivos CHM Help

Con HelpNDoc, crear archivos CHM (Compiled HTML Help) es muy rápido gracias a su interfaz fácil de usar y sus potentes funciones. En este artículo, exploraremos cómo configurar el tamaño y la posición …

Lee Mas →

Equilibrio entre seguridad y usabilidad: los mejores formatos de documentación para compartir a nivel interno

Compartir documentación de manera eficaz y segura es fundamental en el entorno laboral actual. Ya se trate de la distribución interna de manuales, documentación de proyectos o políticas de empresa, la …

Lee Mas →

El arma secreta de los escritores técnicos: las ventajas únicas de usar el Analizador de caracteres de HelpNDoc

HelpNDoc lleva tiempo siendo la solución perfecta para los profesionales que quieren crear documentación fácil de usar, interesante y de alta calidad. Sin embargo, no son solo su interfaz fácil de …

Lee Mas →

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 →