Sobald Sie Ihre Hilfe-Datei oder Dokumentations-Webseite verfasst haben, möchten Sie diese sicherlich mit bereits existierenden Produkten integrieren: Falls ein Nutzer Schwierigkeiten dabei hat eine Handlung auszuführen, kann dieser die Hilfedatei aufrufen und wird umgehend zum korrekt assoziierten Thema geleitet, welches die Handlung erklärt. Aus diesem Grund bieten die Hilfeentwicklungstools, wie HelpNDoc, für jedes Thema zwei einmalige Identifikatoren: Eine alphanumerische Hilfe-ID und eine numerische Hilfe-Kontext-Nummer. Dies ermöglicht den Zugriff auf ein spezifisches Thema von einer Software-Applikation oder Webseite aus. Als technischer Autor werden Sie jedoch höchstwahrscheinlich nicht für das “Schreiben” der Applikation oder Webseite mit der Hilfe-Datei verantwortlich sein und bevorzugen deshalb sicherlich den Entwicklern eine Liste mit den Themen-Identifikatoren zuzustellen. Dank HelpNDoc’s leistungsfähigem Skript-Editor, wird Ihnen genau dies ganz einfach gemacht!

Automatisierung mit HelpNDoc’s API

HelpNDoc umfasst eine sehr leistungsstarke API (Programmierschnittstelle), welche vom Skript-Editor aus genutzt werden kann, um Projekte zu veralten und automatisieren.

Use HelpNDoc's script editor to export topic identifiers

Sobald Sie Ihr Projekt geöffnet haben, können Sie von der Registerkarte “Tools” aus auf den HelpNDoc Skript Editor zugreifen. Der Skript-Editor wird dazu verwendet Pascal basierende Codes einzugeben und auszuführen, um die Generierung einer Text-Datei zu automatisieren, welche Listen von Themenbeschriftungen sowie die dazugehörigen Hilfe-IDs und Hilfe-Kontext-Nummern enthält.
Es ist kein Problem, falls Sie kein Entwickler sind. Kopieren Sie einfach das folgende Skript und fügen Sie dieses ein. Klicken Sie danach auf “Skript ausführen” im HelpNDoc Skript-Editor, um die Text-Datei automatisch zu erstellen.

const
  // Define the output file
  OUTPUT_FILE = 'c:\tmp\topics.txt';

var
  // Current topic ID
  aTopicId: string;
  // List of output
  aList: TStringList;

begin
  // Init list
  aList := TStringList.Create;
  aList.Add('Topic Caption | Help ID | Help Context');
  aList.Add('--------------------------------------');
  try
    // Get first topic
    aTopicId := HndTopics.GetTopicFirst();
    // Loop through all topics
    while aTopicId <> '' do
    begin
      // Add the topic to the list
      aList.Add(Format('%s | %s | %d', [
        HndTopics.GetTopicCaption(aTopicId),
        HndTopics.GetTopicHelpId(aTopicId),
        HndTopics.GetTopicHelpContext(aTopicId)
      ]));
      // Get next topic
      aTopicId := HndTopics.GetTopicNext(aTopicId);
    end;
    // Create the file
    aList.SaveToFile(OUTPUT_FILE);
  finally
    aList.Free;
  end;
end.

Durch die Ausführung dieses Skripts wird HelpNDoc eine Datei mit einer Liste aller im aktuellen Projekt verfügbaren Themen erstellen und diese unter “c:\tmp\topics.txt” (dies kann im oben aufgeführten Skript benutzerdefiniert werden) speichern. Jetzt können Sie diese Datei Ihren Entwicklern zustellen, damit diese die Applikation oder Webseite mit der Hilfe-Datei, die Sie zurzeit verfassen, verbinden können. Auf diese Art und Weise müssen Sie nicht die Arbeit des Entwicklers übernehmen und der Entwickler muss nicht auf die Struktur der Hilfe-Datei zugreifen. Hier finden Sie ein Beispiel einer generierten Text-Datei:

Topic Caption | Help ID | Help Context
--------------------------------------
Introduction | Introduction | 0
Welcome | Welcome | 1
What's new | Whatsnew | 2
Getting Started | GettingStarted | 3
System requirements | Systemrequirements | 4
Getting help | Gettinghelp | 5

Wertvolle Zeit sparen dank HelpNDoc’s API

Dank HelpNDoc’s leistungsstarker API und dem Skript-Editor werden Sie Aufgaben schnell und unkompliziert lösen können, die mit einem anderen Hilfeentwicklungs-Tool unmöglich wären. Die Automatisierung der Hilfe- und Dokumentations-Generation, das Exportieren von Themen-Identifiaktoren, die Vereinfachung von zeitaufwendigen Aufgaben, usw. Die Möglichkeiten sind grenzenlos! Schauen Sie sich HelpNDoc’s riesige Liste mit verfügbaren API-Methoden an und beginnen Sie mit der Automatisierung Ihrer Hilfe-Dateien, Dokumentationen und E-Books.

Das könnte Sie auch interessieren


Kategorien: artikel