Une fois que vous avez rédigé votre fichier d’aide ou votre site web de documentation, vous souhaitez généralement être en mesure de l’intégrer avec vos produits existants: lorsque les utilisateurs ont des difficultés à réaliser une action quelconque, ils doivent pouvoir lancer le fichier d’aide; et le bon chapitre expliquant cette action spécifique doit leur être présenté. À cet effet, les Outils de Création d’Aide comme HelpNDoc fournissent deux identifiants uniques pour chaque chapitre: un ID d’Aide alphanumérique et un numéro de Contexte d’Aide. Cela permet d’atteindre un chapitre spécifique depuis votre application logicielle ou votre site web. Mais en tant que rédacteur technique, vous ne serez probablement pas chargé de “lier” cette application ou ce site web avec le fichier d’aide et vous enverrez plutôt une liste d’identifiants de chapitre aux développeurs responsables. Grâce au très puissant éditeur de script, d’HelpNDoc vous pouvez le faire très facilement!

Utiliser l’API d’HelpNDoc pour automatiser ce travail

HelpNDoc inclut une API très puissante qui peut être utilisée depuis l’Éditeur de Script pour maintenir et automatiser vos projets. Nous allons l’utiliser pour créer un fichier avec une liste d’identifiants de chapitre.

Utiliser l'éditeur de script pour exporter les identifiants de chapitres

Une fois votre projet ouvert, vous pouvez accéder à l’Éditeur de Script d’HelpNDoc depuis l’onglet de ruban “Outils”. L’Éditeur de script sera utilisé pour saisir et exécuter du code basé sur le langage pascal pour automatiser la génération d’un fichier texte contenant une liste de légendes de chapitres ainsi que les ID d’Aide et les numéros de Contexte d’Aide qui leurs sont associés.
Si vous n’êtes pas développeur, pas d’inquiétude: copiez et collez simplement le script qui suit, puis cliquez sur “Exécuter le script” dans l’éditeur de script d’HelpNDoc pour générer automatiquement ce fichier texte.

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

var
  // Current topic ID
  aTopicId: string;
var
  // 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.

En lançant ce script, HelpNDoc va générer un fichier situé à l’emplacement “c:\tmp\topics.txt” (cela peut être personnalisé dans le script ci-dessus) avec une liste de tous les chapitres disponibles dans le projet actuel. Vous pouvez maintenant envoyer ce fichier à vos développeurs afin qu’ils puissent relier l’application ou le site web avec le fichier d’aide que vous êtes entrain de rédiger. De cette manière, vous n’aurez pas à faire le travail du développeur et le développeur n’aura pas besoin d’avoir accès à la structure du fichier d’aide. Voici un exemple de fichier texte généré:

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

L’API d’HelpNDoc vous aidera à gagner du temps

Grâce à l’API et à l’éditeur de script très puissant d’HelpNDoc, vous serez en mesure de réaliser rapidement et facilement des choses qui sont impossible avec n’importe quel autre Outils de Création d’Aide: Automatiser la génération d’aide et de documentation, exporter des identifiants de chapitre, simplifier des tâches chronophages… les possibilités sont infinies! Alors jetez un œil à la liste énorme des méthodes d’API disponibles d’HelpNDoc et commencez à automatiser la rédaction de votre aide, documentation et livres électroniques dès maintenant.

Voir aussi...

Un rédacteur technique heureux d'utiliser HelpNDoc [happy] [Featured]
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 →
Conversion de l'ancienne version de WinHelp HLP en documentation moderne [converting] [Featured]
Revitalisez vos fichiers d'aide : Convertir les anciens fichiers WinHelp HLP en documentation moderne avec HelpNDoc

À une époque où l’information est consommée sur une pléthore d’appareils et de plateformes, les fichiers WinHelp HLP classiques - autrefois la norme en matière de documentation d’aide basée sur …

Lire la suite →
HelpNDoc vs WordPress [versus] [Featured]
Maîtriser la publication multicanal : pourquoi HelpNDoc laisse WordPress dans la poussière

Dans le monde numérique interconnecté d’aujourd’hui, le concept de publication multicanal est devenu plus critique que jamais. Alors que le public recherche des informations sur différentes …

Lire la suite →
Boîte de dialogue Générer la documentation de HelpNDoc [generate] [Featured]
Donner du pouvoir aux rédacteurs techniques : Exploiter les fonctionnalités de remplacement de HelpNDoc pour des variations de documentation illimitées

Dans le paysage en constante évolution de la rédaction technique, le besoin de flexibilité, de personnalisation et d’efficacité est plus crucial que jamais. En tant que rédacteurs techniques, nous …

Lire la suite →

Catégories: articles