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!

Usar la API de HelpNDoc para automatizar el trabajo

HelpNDoc incluye una API muy potente que se puede utilizar desde el Editor de Scripts para modificar y automatizar tus proyectos. Vamos a usarla para crear un archivo con una lista de identificadores de tema.

Usar el editor de scripts de HelpNDoc para exportar identificadores de tema

Una vez abierto tu proyecto, puedes acceder al Editor de Scripts de HelpNDoc desde la pestaña “Inicio”. El editor de scripts se usará para introducir y ejecutar código basado en Pascal para automatizar la generación de un archivo de ayuda que contenga una lista de las leyendas de los temas, así como sus códigos de ID de Ayuda y Contexto de Ayuda. Si no eres desarrollador, no te preocupes: sólo tienes que copiar y pegar el siguiente script y luego hacer clic en “Ejecutar script” en el editor de scripts de HelpNDoc para generar automáticamente ese archivos de ayuda.

const
  // Definir el archivo de resultado
  OUTPUT_FILE = 'c:\tmp\topics.txt';

var
  // ID de tema actual
  aTopicId: string;
var
  // Lista de resultados
  aList: TStringList;

begin
  // Iniciar lista
  aList := TStringList.Create;
  aList.Add('Topic Caption | Help ID | Help Context');
  aList.Add('--------------------------------------');
  try
    // Obtener el primer tema
    aTopicId := HndTopics.GetTopicFirst();
    // Repasar cíclicamente todos los temas
    while aTopicId <> '' do
    begin
      // Añadir el tema a la lista
      aList.Add(Format('%s | %s | %d', [
        HndTopics.GetTopicCaption(aTopicId),
        HndTopics.GetTopicHelpId(aTopicId),
        HndTopics.GetTopicHelpContext(aTopicId)
      ]));
      // Obtener el siguiente tema
      aTopicId := HndTopics.GetTopicNext(aTopicId);
    end;
    // Crear el archivo
    aList.SaveToFile(OUTPUT_FILE);
  finally
    aList.Free;
  end;
end.

Al ejecutar este script, HelpNDoc generará un archivo ubicado en “c:\tmp\topics.txt” (esta ruta se puede personalizar en el script anterior) con una lista de todos los temas disponibles en el proyecto actual. Ahora podrás enviar ese archivo a tus desarrolladores, para que puedan integrar el archivo de ayuda que estás escribiendo en la aplicación o página web. De esta manera, ni tú tendrás que hacer el trabajo del desarrollador, ni el desarrollador tendrá que acceder a la estructura del archivo de ayuda. He aquí un ejemplo de archivo de texto generado:

Leyenda de tema | ID de Ayuda | Contexto de Ayuda
--------------------------------------
Introducción | Introducción | 0
Bienvenida | Bienvenida | 1
Novedades | Novedades | 2
Primeros pasos | Primerospasos | 3
Requisitos del sistema | Requisitosdelsistema | 4
Obtener ayuda | Obtenerayuda | 5

La API HelpNDoc te ayudará a ahorrar tiempo

Gracias a la alta potencia de la API y el editor de scripts de HelpNDoc, podrás lograr fácil y rápidamente cosas que resultarían imposibles con otras herramientas HAT de creación de documentación de ayuda: Automatizar la generación de documentación y archivos de ayuda, exportar identificadores de tema, simplificar tareas que ocupan tiempo… ¡las posibilidades son infinitas! Así que echa un vistazo a la enorme lista de métodos API disponibles y empieza a automatizar tu documentación y archivos de ayuda y a escribir eBooks ahora mismo.

Ver también...

Produce MarkDown con la Herramienta de Documentación HelpNDoc [markdown] [featured]
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 →
Ilustración del analizador de caracteres de HelpNDoc [illustration] [Featured]
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 →
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 →

Categorías: artículos