Utiliser des scripts pour automatiser la création d’aides et de documentations

HelpNDoc est si facile à utiliser qu’une documentation complète multi-format et multi-device peut être réalisée en quelques minutes après avoir téléchargé et essayé HelpNDoc pour la première fois, grâce à son interface utilisateur intuitive et son éditeur de chapitre de type Microsoft Word. Il est aussi très puissant et offre de nombreux outils de pointe pour simplifier et accélérer la création de fichiers d’aide et de manuels les plus étonnants. Une de ces fonctionnalités avancées est l’éditeur de script qui vous permet de manipuler HelpNDoc par le biais d’un langage de script. Voyons comment l’éditeur de script peut vous aider à créer les fichiers d’aide les plus utiles dans le plus court laps de temps possible.

Scriptes vos projets de documentation

Le moteur de script de HelpNDoc fournit un accès pour gérer chaque fonctionnalité de HelpNDoc: table des matières, éditeur de chapitre, mots-clés, éléments de bibliothèque … les possibilités sont infinies.

Le moteur de script de HelpNDoc est basé sur le langage de programmation Pascal qui est très facile à comprendre et à taper. Il donne accès à un large éventail de méthodes pour contrôler vos projets de documentation.
Pour utiliser les fonctionnalités de script de HelpNDoc, vous devrez entrer un script ou en charger un dans l’éditeur de script. L’éditeur de script fournit un éditeur avec coloration syntaxique ainsi que les capacités de construction et d’opération de script. Il peut être consulté en utilisant le bouton “Éditeur de Script” dans l’onglet du ruban “Outils”.

Utilisez des scripts pour gérer la table des matières

La table des matières est le principal point d’entrée de votre aide, vos manuels et du contenu de votre documentation. Le moteur de script de HelpNDoc peut vous aider à automatiser la création d’une table des matières complexe en une fraction de seconde.

Imaginons que vous avez un fichier texte contenant une liste de noms de rubriques que vous souhaitez intégrer rapidement dans HelpNDoc. C’est le travail idéal pour le moteur de script de HelpNDoc: nous allons charger ce fichier, et pour chaque ligne, nous allons créer un nouveau chapitre et définir son titre. Voyons comment cela peut être fait en utilisant l’éditeur de script de HelpNDoc:

var
  // List of lines in the file
  oList: TStringList;
var
  // Current line number
  nLine: Integer;
var
  // ID for the newly created topic
  sTopicId: string;

begin
  // Create objects
  oList := TStringList.Create();
  try
    // Load the lines from a file
    oList.LoadFromFile('c:\tmp\topics.txt');
    // Iterate through each line
    for nLine := 0 to oList.Count - 1 do
    begin
      // Create a new topic
      sTopicId := HndTopics.CreateTopic();
      // Set its caption based on the current line
      HndTopics.SetTopicCaption(sTopicId, oList[nLine]);
    end;
  finally
    // Free objects
    oList.Free;
  end;
end.

Ajouter du contenu via des scripts

Le moteur de script de HelpNDoc peut également être utilisé pour gérer le contenu d’un chapitre. Voyons à quel point il est facile d’utiliser cette fonctionnalité.

Nous avons maintenant automatisé la création de la table des matières mais nous pourrions également utiliser un script pour la création du contenu de ces chapitres. Nous allons étendre notre exemple précédent et imaginer que le contenu de chaque chapitre est dans un fichier HTML nommé d’après le titre du chapitre. Tout notre script deviendrait quelque chose comme:

var
  // List of lines in the file
  oList: TStringList;
var
  // Current line number
  nLine: Integer;
var
  // ID for the newly created topic
  sTopicId: string;  
var
  // Editor
  oEditor: TObject;

begin
  // Create objects
  oList := TStringList.Create();
  oEditor := HndEditor.CreateTemporaryEditor();
  try
    // Load the lines from a file
    oList.LoadFromFile('c:\tmp\topics.txt');
    // Iterate through each line
    for nLine := 0 to oList.Count - 1 do
    begin
      // Create a new topic
      sTopicId := HndTopics.CreateTopic();
      // Set its caption based on the current line
      HndTopics.SetTopicCaption(sTopicId, oList[nLine]);  
      // Load the content from another file
      HndEditor.Clear(oEditor);
      HndEditor.InsertFile(oEditor, 'c:\tmp\' + oList[nLine] + '.html');
      // Set the content of the topic
      HndEditor.SetAsTopicContent(oEditor, sTopicId);
    end;
  finally
    // Free objects
    HndEditor.DestroyTemporaryEditor(oEditor);
    oList.Free;
  end;
end.

Possibilités infinies grâce au moteur de script de HelpNDoc

Avec ces exemples, nous n’avons exploré qu’une infime partie de ce dont le moteur de script de HelpNDoc est capable. Grâce à ce système de script puissant, vous serez en mesure de facilement laisser votre ordinateur faire ce qu’il est censé faire: automatiser les tâches répétitives et vous simplifier la vie. En tant que rédacteur technique, il y a beaucoup de tâches qui peuvent être automatisées et nous vous encourageons à jeter un œil à l’énorme liste des méthodes disponibles à travers le système de script de HelpNDoc pour commencer à automatiser vos tâches répétitives et créer l’aide et les projets de documentation les plus incroyables.

Voir aussi...