Anwendung von HelpNDocs Scripting-Fähigkeiten zum automatischen Zurücksetzen aller Hilfe-Kontext-Nummern

HelpNDoc beinhaltet einen äußerst leistungsstarken Skript-Editor mit Zugriff auf mehrere API-Methoden, mit dem Sie nahezu alle Aspekte der Erstellung und Wartung Ihrer Dokumentationen automatisieren können. Wir haben uns bereits angesehen, wie Sie HelpNDocs Scripting-Fähigkeiten zum Automatisieren der Erstellung von Hilfe-Dokumentationen, zum Aktualisieren des Pfads externer Medienelemente, die verschoben wurden, und zum Exportieren von Hilfe-IDs und Hilfe-Kontext-Nummern für Ihre Entwickler verwenden können.
Hier erklären wir Ihnen, wie Sie ein praktisches Skript zum automatischen Zurücksetzen der Hilfe-Kontext-Nummern für alle Themen eines Dokumentationsprojekts erstellen können.

Was sind Hilfe-Kontext-Nummern?

Themen-Identifikatoren (Hilfe-IDs und Hilfe-Kontext-Nummern) können zum Zugriff auf ein spezifisches Thema von einer Drittanwendung aus verwendet werden: HelpNDoc stellt sicher, dass jedem Thema eine eindeutige Hilfe-ID und Hilfe-Kontext-Nummer zugeordnet wird.

HelpNDoc erstellt automatisch zwei eindeutige Identifikatoren für jedes Thema, die Sie Ihrem Projekt hinzufügen:

• eine alphanumerische Hilfe-ID, die als eine gefilterte Version der Themenüberschrift definiert wird, und
• eine numerische Hilfe-Kontext-Nummer, die als die niedrigste eindeutige, positive Ganzzahl des Projekts definiert wird.

Wenn das erste Thema erstellt wird, wird seine Hilfe-Kontext-Nummer als “0” definiert. Die zweite wird als “1” definiert, die dritte wird als “2” definiert und so weiter. Wenn ein Thema, z. B. das zweite Thema, gelöscht wird, steht seine Hilfe-Kontext-Nummer für das nächste erstellte Thema zur Verfügung: Wenn das vierte Thema erstellt wird, wird seine Hilfe-Kontext-Nummer als “1” definiert werden. Im Laufe der Zeit können die Hilfe-Kontext-Nummern verwirrend sein, da sie nicht immer von einem Thema zum nächsten hochgezählt werden.
Zum Glück können wir ein Skript zum automatischen Zurücksetzen der Hilfe-Kontext-Nummer jedes Themas erstellen, um zu gewährleisten, dass das erste Thema bei “0” beginnt und die Hilfe-Kontext-Nummern der nächsten Themen entsprechend hochgezählt werden.

HelpNDocs Skript zum Zurücksetzen der Hilfe-Kontext-Nummern

Anstelle einer manuellen Aktualisierung der Hilfe-Kontext-Nummer jedes einzelnen Themas können Sie HelpNDocs Scripting-Fähigkeiten zum Automatisieren dieser repetitiven und fehleranfälligen Aufgabe nutzen.

Da HelpNDoc dafür sorgt, dass die Hilfe-Kontext-Nummern eindeutig sind, können wir nicht über jedes Thema iterieren und die Hilfe-Kontext-Nummer jedes Themas als bei 0 und höher beginnend definieren: Andere Themen könnten diese Nummern bereits verwenden, was die saubere Iteration, die wir anstreben, unterbrechen kann. Deshalb definieren wir in einem ersten Arbeitsschritt hohe Kontext-Nummern für jedes Thema. Im zweiten Arbeitsschritt werden die endgültigen Werte definiert. Hier ist das vollständige Skript.

Warnung: Diese Aktion kann nicht rückgängig gemacht werden. Wenn Sie oder Ihre Kollegen sich für den Zugriff auf bestimmte Themen Ihrer Hilfe-Datei auf Hilfe-Kontext-Nummern verlassen, sollten Sie diese Nummern nicht aktualisieren. Diese Aktion sollte nur durchgeführt werden, wenn Sie Ihr Hilfe-Dokument erstellen und ein einheitliches Set von Hilfe-Kontext-Nummern haben wollen.

const
  // Temporary context number used. MaxInt is the maximum possible number.
  TEMP_MAX = MaxInt div 2;

  // Update context number for all topics starting with "StartingAtNb"
  procedure UpdateContextNumbers(const StartingAtNb: Integer);
  var
    aTopicId: string;
    aCurrentNb: Integer;
  begin
    // Init
    aCurrentNb := StartingAtNb;
    // Get first topic
    aTopicId := HndTopics.GetTopicFirst();
    // Iterate over topics
    while aTopicId <> '' do
    begin
      // Set the context number for the current topic
      HndTopics.SetTopicHelpContext(aTopicId, aCurrentNb);
      // Set next number
      Inc(aCurrentNb);
      // Move to next topic
      aTopicId := HndTopics.GetTopicNext(aTopicId);
    end;
  end;

begin
  // Make sure all topics have unique large context numbers
  UpdateContextNumbers(TEMP_MAX);
  // Update all topics with context numbers starting at 0
  UpdateContextNumbers(0);
end.

Kopieren Sie dieses Skript und fügen Sie es in HelpNDocs Skript-Editor ein, klicken Sie auf “Skript ausführen” und fertig! Die Hilfe-Kontext-Nummern Ihrer Themen werden automatisch inkrementell definiert.

Wir haben also gesehen, wie leistungsfähig und schnell HelpNDocs Skriptmaschine sein kann: Durch die Automatisierung dieses langwierigen und fehleranfälligen Vorgangs konnten wir die Hilfe-Kontext-Nummern unseres Projekts schnell und zuverlässig bereinigen.
Und HelpNDocs API ist nicht auf Themen und deren Hilfe-Identifikatoren beschränkt: Sie können sie zum Automatisieren verschiedener Aspekte des Erstellungsvorgangs Ihrer Dokumentationen verwenden. Falls Sie es nicht bereits getan haben, sollten Sie Ihre kostenlose persönliche HelpNDoc-Ausgabe jetzt herunterladen, um HelpNDocs erstaunlichen Funktionen auszutesten. Und vergessen Sie nicht, unsere zahlreichen Online-Artikel und -Videos mit Schritt-für-Schritt-Anleitungen zurate zu ziehen, um alle Funktionen von HelpNDoc schnell zu lernen!

Das könnte Sie auch interessieren...

Die Geheimwaffe technischer Redakteure: Die einzigartigen Vorteile des Zeichen-Analysators von HelpNDoc

HelpNDoc hat sich als eine Lösung für Fachleute etabliert, die hochwertige, ansprechende und benutzerfreundliche Dokumentationen erstellen möchten. Es sind nicht nur die benutzerfreundliche Oberfläche …

Mehr lesen →

Optimale Anwendung von HelpNDoc: Wie die Funktion "Temporäre Dateien behalten" technischen Redakteuren helfen kann

Bei der Arbeit an technischen Dokumentationen können die uns zur Verfügung stehenden Werkzeuge und Funktionen einen großen Unterschied hinsichtlich unserer Produktivität und Effizienz ausmachen. Eine …

Mehr lesen →

Revitalisieren Sie Ihre Hilfedateien: Konvertieren von älteren WinHelp-HLP-Dateien in moderne Dokumentationen mit HelpNDoc

In einem Zeitalter, in dem Informationen auf einer Vielzahl von Geräten und Plattformen genutzt werden, sind die klassischen WinHelp-HLP-Dateien – einst der Standard Windows-basierter …

Mehr lesen →

Multi-Channel-Publishing leicht gemacht: Warum HelpNDoc WordPress gegenüber deutlich überlegen ist

In der vernetzten digitalen Welt von heute ist das Konzept des Multi-Channel-Publishing wichtiger denn je. Da ihre Zielgruppen Informationen über verschiedene Plattformen und Formate abrufen, stehen …

Mehr lesen →