Utilisation des fonctionnalités de script de HelpNDoc pour réinitialiser automatiquement tous les numéros contextuels d’aide

HelpNDoc dispose d’un éditeur de script très puissant avec un accès à plusieurs méthodes API, fournissant le moyen d’automatiser presque toutes les étapes des processus de création et de maintenance de votre documentation. Nous avons déjà vu comment utiliser les fonctionnalités de script HelpNDoc pour automatiser la création de l’aide et de la documentation, mettre à jour le chemin de vos éléments multimédias externes lorsqu’ils sont déplacés et exporter les numéros d’aide et les numéros contextuels d’aide pour vos développeurs.
Voyons maintenant comment créer un script pratique pour réinitialiser automatiquement les numéros contextuels d’aide pour tous les chapitres du projet de documentation.

Que sont les numéros contextuels d’aide ?

Les identifiants de chapitre (identifiant d’aide et numéros contextuels d’aide) peuvent être utilisés pour accéder à un chapitre spécifique à partir d’une application tierce : HelpNDoc garantit que chaque chapitre aura un identifiant d’aide et un numéro contextuel d’aide.

HelpNDoc crée automatiquement deux identifiants uniques pour chaque chapitre que vous ajoutez à votre projet :

• Un identifiant d’aide alphanumérique qui est définie sur une version filtrée de la légende du chapitre ;
• Un contexte d’aide numérique est défini par l’entier positif unique le plus bas disponible dans le projet.

Lorsque le premier chapitre est créé, son numéro contextuel d’aide est défini à “0”. Le deuxième est défini à “1”, le troisième à “2” et ainsi de suite. Lorsqu’un chapitre est supprimé, disons le deuxième, son numéro contextuel d’aide est disponible pour le prochain chapitre créé : lorsque le quatrième chapitre est créé, son numéro contextuel d’aide sera défini à “1”. À la longue, les numéros contextuels d’aide peuvent perturber, car ils ne sont pas toujours indentés d’un chapitre à l’autre.
Heureusement, nous pouvons créer un script pour réinitialiser automatiquement le numéro contextuel d’aide de tous les chapitres pour nous assurer que le premier chapitre commence à “0” et que les numéros contextuels d’aide des chapitres suivants évoluent en conséquence.

Script HelpNDoc pour réinitialiser les numéros contextuels d’aide

Au lieu de mettre à jour manuellement le numéro contextuel d’aide de chaque chapitre, nous allons exploiter les fonctionnalités de script de HelpNDoc pour automatiser cette tâche répétitive et sujette à erreur

Comme HelpNDoc s’assure de l’unicité des numéros contextuels d’aide, nous ne pouvons pas itérer pour chaque chapitre en commençant à partir de 0 : d’autres chapitres pourraient déjà utiliser ces nombres, brisant l’itération recherchée. C’est pourquoi nous commençons par définir des numéros contextuels élevés pour chaque chapitre. Ensuite, nous définissons les valeurs finales. Voici le script complet.

Attention : cette action est irréversible. Si vous, ou vos collègues, comptez sur les numéros contextuels d’aide pour accéder à des chapitres spécifiques de votre fichier d’aide, vous ne devez pas mettre à jour ces nombres. Cette action ne doit être effectuée que lorsque vous créez votre document d’aide et souhaitez avoir un ensemble cohérent de numéros contextuels d’aide.

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.

Copier / Coller ce script dans l’éditeur de script HelpNDoc, appuyez sur “Exécuter le script” et voilà ! Le numéro contextuel d’aide de votre chapitre est automatiquement créé de façon progressive.

Encore une fois, nous avons vu combien le moteur de script de HelpNDoc peut être puissant et rapide : en automatisant ce processus long et sujet à erreur, nous avons pu assainir rapidement et efficacement les numéros contextuels d’aide de notre projet.
Et l’API de HelpNDoc ne se limite pas qu’aux chapitres et à leurs identifiants d’aide : vous pouvez l’utiliser pour automatiser diverses étapes de votre processus de création de documentation. Donc, si vous ne l’avez pas déjà fait, téléchargez votre édition de HelpNDoc personnelle gratuite maintenant pour commencer à essayer ses incroyables capacités et assurez-vous de consulter les différents guides vidéo et textuels détaillés pour rapidement maîtriser tous les aspects de HelpNDoc !

Voir aussi...

Comment Personnaliser la Position et la Taille Initiales des Fichiers d'Aide CHM

Créer des fichiers CHM (Compiled HTML Help) avec HelpNDoc est un jeu d’enfant, grâce à son interface conviviale et à ses puissantes fonctionnalités. Dans cet article, nous examinerons comment vous …

Lire la suite →

Équilibrer la sécurité et la facilité d'utilisation : Les meilleurs formats de documentation pour le partage interne

Le partage efficace et sécurisé de la documentation est essentiel sur le lieu de travail moderne. Que vous distribuiez des manuels internes, de la documentation sur des projets ou des directives …

Lire la suite →

L'arme secrète des rédacteurs techniques : les avantages uniques de l'analyseur de caractères de HelpNDoc

HelpNDoc est une solution de choix pour les professionnels qui cherchent à créer une documentation de haute qualité, attrayante et conviviale. Cependant, ce n’est pas seulement son interface …

Lire la suite →

Obtenir le meilleur de HelpNDoc : Comment la fonctionnalité "Conserver les fichiers temporaires" peut-elle aider les rédacteurs techniques ?

Lorsque l’on travaille sur de la documentation technique, chaque outil et chaque fonctionnalité à notre disposition peut faire une grande différence en termes de productivité et d’efficacité. L’une de …

Lire la suite →