Utilizar scripts para automatizar la creación de documentos y archivos de ayuda

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.

Uso de scripts en tus proyectos de documentación

El motor de scripts de HelpNDoc te da acceso a la administración de cualquiera de las funciones de HelpNDoc: tabla de contenido, editor de temas, palabras clave, ítems de biblioteca… las posibilidades son infinitas.

El motor de scripts de HelpNDoc está basado en el lenguaje de programación Pascal, que es muy fácil de entender y de escribir. El motor te permite acceder a una amplia gama de métodos para controlar tus proyectos de documentación. Para usar las funciones con scripts de HelpNDoc, primero tienes que introducir o cargar un script en el editor de scripts. El editor de scripts ofrece un editor con resaltado de sintaxis además de las funciones de creación y ejecución de scripts. Se puede acceder al mismo con el botón “Editor de scripts” que hay en la pestaña “Herramientas”.

Utilizar scripts para administrar la tabla de contenido

La tabla de contenido es el punto de entrada principal para la mayoría de tu contenido de ayuda, manuales y documentación. El motor de scripts de HelpNDoc te puede ayudar a automatizar la creación de una compleja tabla de contenido en un instante.

Supongamos que tienes un archivo de texto con una lista de nombres de temas que te gustaría integrar rápidamente en HelpNDoc. Esta es la tarea perfecta para el motor de scripts: vamos a cargar ese archivo y, para cada línea, crearemos un tema nuevo y estableceremos su leyenda. Veamos cómo podemos hacerlo usando el editor de scripts:

var
  // Lista de líneas en el archivo
  oList: TStringList;
var
  // Número actual de líneas
  nLine: Integer;
var
  // ID para el tema recién creado
  sTopicId: string;

begin
  // Crear objetos
  oList := TStringList.Create();
  try
    // Cargar las líneas de un archivo
    oList.LoadFromFile('c:\tmp\topics.txt');
    // Repasar cada línea cíclicamente
    for nLine := 0 to oList.Count - 1 do
    begin
      // Crear un nuevo tema
      sTopicId := HndTopics.CreateTopic();
      // Establecer su leyenda en base a la línea actual
      HndTopics.SetTopicCaption(sTopicId, oList[nLine]);
    end;
  finally
    // Liberar objetos
    oList.Free;
  end;
end.

Añadir contenido con scripts

El motor de scripts de HelpNDoc también puede utilizarse para administrar el contenido de un tema. Veamos lo fácil que es utilizar esta función.

Ahora hemos automatizado la creación de la tabla de contenido, pero también podríamos haber usado un script para la creación del contenido de dichos temas. Vamos a ampliar el ejemplo anterior, imaginando que el contenido de cada tema está en un archivo HTML nombrado como la leyenda del tema. Nuestro script se convertiría en algo como:

var
  // Lista de líneas en el archivo
  oList: TStringList;
var
  // Número actual de líneas
  nLine: Integer;
var
  // ID para el tema recién creado
  sTopicId: string;  
var
  // Editor
  oEditor: TObject;

begin
  // Crear objetos
  oList := TStringList.Create();
  oEditor := HndEditor.CreateTemporaryEditor();
  try
    // Cargar las líneas de un archivo
    oList.LoadFromFile('c:\tmp\topics.txt');
    // Repasar cada línea cíclicamente
    for nLine := 0 to oList.Count - 1 do
    begin
      // Crear un nuevo tema
      sTopicId := HndTopics.CreateTopic();
      // Establecer su leyenda en base a la línea actual
      HndTopics.SetTopicCaption(sTopicId, oList[nLine]);  
      // Cargar el contenido de otro archivo
      HndEditor.Clear(oEditor);
      HndEditor.InsertFile(oEditor, 'c:\tmp\' + oList[nLine] + '.html');
      // Establecer como contenido del tema
      HndEditor.SetAsTopicContent(oEditor, sTopicId);
    end;
  finally
    // Liberar objetos
    HndEditor.DestroyTemporaryEditor(oEditor);
    oList.Free;
  end;
end.

Las posibilidades son infinitas gracias al motor de scripts de HelpNDoc

En los ejemplos anteriores no hemos explorado más que una minúscula fracción de lo que es capaz de hacer el motor de scripts de HelpNDoc. Gracias a este potente sistema de uso de scripts, podrás dejar fácilmente que el ordenador haga lo que se supone que tiene que hacer: automatizar tareas repetitivas y simplificarte la vida. Como escritor técnico, encontrarás muchísimas tareas que se pueden automatizar, y te animamos a que le eches un vistazo a la enorme lista de métodos disponibles a través del sistema de scripts de HelpNDoc para empezar a automatizar tus tareas repetitivas y crear los proyectos de documentación y archivos de ayuda más espectaculares.

Ver también...