Mit Scripts die Erstellung von Hilfe-Dateien und Dokumentationen automatisieren

HelpNDoc ist dermaßen benutzerfreundlich, dass es möglich ist, innerhalb kürzester Zeit, eine vollständige Dokumentation in mehreren Formaten und für mehrere Geräte zu produzieren. Dies ist sogar schon wenige Minuten nach dem Downloaden und dem ersten Austesten von HelpNDoc möglich und zwar dank der intuitiven Benutzeroberfläche und dem Themen-Editor, der Microsoft Word sehr ähnelt. HelpNDoc ist extrem Leistungsstark und bietet seinen Nutzern viele fortschrittliche Instrumente, um die Erstellung von fantastischen Hilfe-Dateien und Handbüchern zu vereinfachen und zu beschleunigen. Bei einer dieser fortgeschrittenen Funktionen handelt es sich um den Script-Editor, dank welchem Sie HelpNDoc mit einer Scriptsprache manipulieren können. Gerne zeigen wir Ihnen, wie der Script-Editor Ihnen dabei helfen kann, die zweckmäßigsten Hilfe-Dateien in möglichst kurzer Zeit zu erstellen.

Scripting der Dokumentations-Projekten

Der Script-Editor von HelpNDoc ermöglicht das Verwalten aller HelpNDoc-Funktionen: Inhaltsverzeichnisse, Themen-Editor, Stichwörter, Bibliothek-Elemente… die Möglichkeiten sind unendlich.

Das HelpNDoc Script-Engine basiert auf der Pascal Programmiersprache, die sehr einfach zu verstehen und schreiben ist. Das Engine bietet Zugriff auf eine Vielfalt an Methoden, um die Dokumentations-Projekte zu kontrollieren.
Um die Script-Fähigkeiten von HelpNDoc verwenden zu können, müssen Sie ein Script eingeben oder in den Script-Editor laden. Der Script-Editor bietet Syntax-Hervorhebung sowie Script-Erstellung und Script-Ausführung. Sie finden den “Script-Editor” unter der Registerkarte “Tools”.

Scripts verwenden, um das Inhaltsverzeichnis zu verwalten

Das Inhaltsverzeichnis ist die wichtigste Eingabestelle für Inhalte der meisten Ihrer Hilfe-Dateien, Handbücher und Dokumentationen. Das HelpNDoc Script-Engine kann Ihnen dabei behilflich sein, die Erstellung eines komplexen Inhaltsverzeichnisses in Sekundenschnelle zu automatisieren.

Nehmen wir an, dass Sie eine Text-Datei mit einer Liste an Themen-Namen besitzen, welche Sie schnell in HelpNDoc integrieren möchten. Hierbei handelt es sich um eine perfekte Aufgabe für das HelpNDoc Script-Engine: Die Datei wird geladen und für jede Zeile wird ein neues Thema erstellt und die Beschriftung festgelegt. Wir zeigen Ihnen nun, wie dies mit dem HelpNDoc Script-Editor funktioniert:

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.

Inhalte mit Scripts hinzufügen

Das HelpNDoc Script-Engine kann ebenfalls zum Verwalten von Inhalten eines Themas verwendet werden. Die Nutzung dieser Funktion ist sehr unkompliziert.

Wir haben nun bereits die Erstellung des Inhaltsverzeichnisses automatisiert aber wir könnten die Erstellung der Inhalte für diese Themen ebenfalls mit Scripts ausführen. Hierzu erweitern wir das oben aufgezeigte Beispiel und stellen uns vor, dass jeder Themeninhalt in einer HTML-Datei enthalten ist, die nach der Themenbeschriftung benannt wurde. Unser gesamtes Script würde wie folgt aussehen:

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.

Unzählige Möglichkeiten dank dem HelpNDoc Script-Engine

Wir haben mit diesen Beispielen lediglich einen kleinen Teil von dem erforscht, was das HelpNDoc Script-Engine zu bieten hat. Dank diesem leistungsstarken Scripting-System werden Sie sich zurücklehnen und Ihren Computer für sich arbeiten lassen können: Automatisieren Sie repetitive Aufgaben und vereinfachen Sie so Ihr Leben. Ein/e Technische/r Redakteur/in findet bestimmt unzählige Aufgaben, die automatisiert werden können. Schauen Sie sich auch unsere riesige Liste mit den im HelpNDoc Scripting-System verfügbaren Methoden an, um mit dem Automatisieren der repetitiven Aufgaben und der Erstellung fantastischer Hilfe- und Dokumentations-Projekten zu beginnen.

Das könnte Sie auch interessieren...