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.
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 :
- Depuis l’onglet “Outils” du ruban de HelpNDoc, cliquez sur “Éditeur de script”
- Dans la fenêtre éditeur de script, cliquez sur la flèche après le bouton “Charger un script”
- Cliquez sur “SortAllTopics.hnd.pas” pour charger le script de tri de chapitres
- 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
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
- Combler le fossé entre les enseignants et les élèves : Exploiter la puissance des outils d'aide à la rédaction pour une création de contenu engageante
- Comment les rédacteurs techniques peuvent inclure du code PHP dans leur documentation en ligne
- Comment créer un fichier d'aide CHM : utilisez un logiciel moderne de création d'aide au lieu du dépassé HTML Help Workshop
- Pourquoi préférer un outil de création d'aide à Microsoft Word pour produire une documentation de qualité ?
- Comment configurer et mettre à jour les propriétés des images à travers vos projets de documentation