La rédaction d’un fichier d’aide en ligne, d’un manuel d’utilisation, d’un livre électronique ou de tout autre format pris en charge par HelpNDoc est généralement un processus long et non-linéaire. Souvent, au fur et à mesure que le contenu progresse, la hiérarchie générale des chapitres peut devenir peu satisfaisante et une réorganisation est nécessaire pour faciliter la lecture et la navigation dans la documentation. Même si HelpNDoc fournit des outils pour facilement réorganiser la table des matières, dans certains cas, le processus peut être long et sujet à erreurs, comme lorsqu’un tri alphabétique des chapitres est nécessaire. Heureusement, HelpNDoc dispose de scripts pour réorganiser automatiquement les chapitres par titre. Voyons comment le faire rapidement et facilement.

Exécuter le script de tri de chapitres

Non seulement HelpNDoc dispose de puissantes capacités de script, il inclus également avec les sources de scripts utiles ; comme les scripts “SortAllTopics” et “SortChildTopics” qui peuvent automatiquement trier les chapitres par titre.

Script de tri de chapitres

Une fois que vous avez ajouté quelques chapitres à votre documentation et que peut-être vous les avez organisées, les capacités de script de HelpNDoc s’avèrent utiles pour automatiser le tri de chapitre :

  1. Depuis l’onglet “Outils” du ruban de HelpNDoc, cliquez sur “Éditeur de script”
  2. Dans la fenêtre éditeur de script, cliquez sur la flèche après le bouton “Charger un script”
  3. Cliquez sur “SortAllTopics.hnd.pas” pour charger le script de tri de chapitres
  4. Cliquez sur “Exécuter le script”… et voilà ! L’intégralité de la table des matières sera triée par titre

C’était assez facile. Mais que faire si vous ne voulez trier que certaines chapitres ?
Il suffit de sélectionner un chapitre dans la table des matières, charger et exécuter le script “SortChildTopics.hnd.pas” comme expliqué ci-dessus, et tous les sous-chapitres seront triées par ordre alphabétique.

Tri personnalisé et besoins particuliers

Éditeur de script

Le tri des chapitres par titre n’est pas toujours utile et certains projets peuvent nécessiter un tri de chapitres automatisé selon des attributs différents comme les identifiants de chapitres d’aide. Pour ces besoins particuliers, les scripts fournis peuvent servir de base de départ et être facilement personnalisés avec la puissante et complète API de HelpNDoc.

De son interface utilisateur simple à ses capacités de script avancées, HelpNDoc fournit tous les outils pour produire de magnifiques fichiers d’aide, manuels d’utilisation, livres électroniques… aussi rapidement et facilement que possible. Et le meilleur, HelpNDoc est entièrement gratuit pour des usages personnels et à des fins d’évaluation. Essayez-le maintenant et aimez documenter !

Voir aussi...

Produire du MarkDown avec l'outil de création d'aide HelpNDoc [markdown] [featured]
É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 →
Illustration de l'analyseur de caractères de HelpNDoc [illustration] [Featured]
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 →
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 →

Catégories: articles