Actualizar fácilmente la ruta de los elementos audiovisuales externos al ser trasladados

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.

El editor de scripts de HelpNDoc al rescate

Todas las ediciones de HelpNDoc incluyen el editor de scripts: puedes usarlo para escribir instrucciones desde la API de HelpNDoc para automatizar tareas repetitivas.

Usar el editor de scripts para actualizar los ítems de biblioteca

Una vez hayas abierto el proyecto que tengas que actualizar y el editor de scripts de HelpNDoc, podrás empezar a escribir el script que utilizaremos para actualizar la biblioteca:

const
  REPLACE_FROM = 'c:\doc';
const
  REPLACE_TO   = 'd:\documentation';

var aList: THndLibraryItemsInfoArray;
var nCnt: Integer;
var sFilePath: string;

begin
  // Obtener todos los ítems de la biblioteca
  aList := HndLibraryItems.GetItemList([]);
  // Repasarlos uno por uno
  for nCnt := 0 to Length(aList) - 1 do
  begin
    // Obtener su ubicación de archivo
    sFilePath := HndLibraryItems.GetItemUrlFile(aList[nCnt].id);
    // ¿Hay que sustituir este ítem?
    if ((sFilePath <> '') and (Pos(UpperCase(REPLACE_FROM), UpperCase(sFilePath)) > 0)) then
    begin
      // Pues sí: actualizar la ruta
      sFilePath := StringReplace(sFilePath, REPLACE_FROM, REPLACE_TO, [rfIgnoreCase]);
      // Guardar
      HndLibraryItems.SetItemUrlFile(aList[nCnt].id, sFilePath);
    end;
  end;
end.

Únicamente tienes que cambiar las constantes REPLACE_FROM y REPLACE_TO para asegurarte de que HelpNDoc encuentre y sustituya los valores correctos, darle a “Ejecutar script” y dejar que HelpNDoc haga el trabajo duro por ti: en unos segundos, toda tu biblioteca estará actualizada para usar la nueva ruta.

Así es cómo funciona este script:

  • Obtiene una lista de todos los ítems de biblioteca que haya en el proyecto abierto
  • Para cada uno de esos ítems, comprueba si está enlazado a una ruta de archivo que tenga que actualizar
  • Si lo está, actualiza la ruta y pasa al siguiente ítem

Otras formas de sacar partido a la API de HelpNDoc para ahorrar tiempo

Casi todos los aspectos de HelpNDoc pueden automatizarse usando la API de HelpNDoc. Hemos visto cómo actualizar automáticamente todos los ítems de biblioteca, pero también se puede utilizar para automatizar la creación de documentación y archivos de ayuda, exportar códigos de ID de Ayuda y Contexto de Ayuda para tus desarrolladores y mucho más…
Puedes revisar la documentación de la API de HelpNDoc para aprender más sobre las capacidades del potente editor de scripts de HelpNDoc.

Ver también

Categorías: artículos
Etiquetas: script biblioteca trucos y consejos