HelpNDoc offre une capacité de scripting puissante qui utilise l’API HelpNDoc pour automatiser des tâches répétitives. Cette fonctionnalité avancée vous permet de créer de nouveaux scripts et de charger des scripts existants, d’exécuter et de construire des scripts et de sauvegarder des scripts pour un usage futur.

Comment exporter les ID de l’Aide et les numéros de Contexte d’Aide pour vos développeurs

Comment exporter les ID de l'Aide et les numéros de Contexte d'Aide pour vos développeurs
Catégories: articles

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!

Lire la suite →

Créer un nouveau modèle HTML pour personnaliser vos projets de documentation Web

Créer un nouveau modèle HTML pour personnaliser vos projets de documentation Web
Catégories: articles

La toute dernière version de HelpNDoc 6.4 inclut un modèle amélioré HTML à page unique avec la possibilité d'optionnellement ajouter une table des matières à la documentation HTML à page unique produite. Nous avons naturellement utilisé le puissant éditeur de modèles de HelpNDoc pour modifier le modèle à page unique et nous avons pensé que ce pourrait être une bonne idée de documenter ce processus à des fins pédagogiques. Suivez les étapes décrites dans cet article pour apprendre à créer et modifier des modèles de documentation HTML grâce aux outils intégrés de HelpNDoc.

Lire la suite →

Éditer en masse les statuts des chapitres de votre projet de documentation

Éditer en masse les statuts des chapitres de votre projet de documentation
Catégories: articles

HelpNDoc 6.0 a ajouté la prise en charge des statuts de chapitres, ce qui simplifie considérablement la gestion des projets de documentation pour les rédacteurs techniques : les chapitres peuvent être étiquetés comme "Obsolètes", "En cours", "À réviser", "Achevés" ou tout autre statut personnalisé. Vous pourriez être tentés d'utiliser cette fonctionnalité pour mettre à jour un vieux projet et modifier l'état de tous vos chapitres en "À réviser" pour les vérifier un par un. Mais la mise à jour individuelle de tous les chapitres d'un grand projet prendra du temps. Heureusement, la prise en charge de scripts par HelpNDoc permet de mettre à jour la totalité des statuts du projet en une fraction de seconde. Voyons comment le faire.

Lire la suite →

Fusionner automatiquement plusieurs chapitres de votre documentation en utilisant un script

Fusionner automatiquement plusieurs chapitres de votre documentation en utilisant un script
Catégories: articles

Un outil de création d'aide standard, comme HelpNDoc, est un logiciel dans lequel vous rédigez et organisez généralement le contenu afin de produire des fichiers de documentation pour les utilisateurs. Lorsque des modifications sont nécessaires, le contenu doit rester organisé et cela implique généralement beaucoup de labeur tout en étant sujet à des erreurs avec des taches telles que copier/coller du contenu à travers le projet, supprimer du contenu, déplacer et fusionner des chapitres... Heureusement, HelpNDoc dispose d'un puissant processeur de script qui peut aider à automatiser la création, la maintenance, la réorganisation, etc. de la documentation. Voyons comment profiter des fonctions de script de HelpNDoc pour fusionner plusieurs chapitres enfants dans un chapitre parent

Lire la suite →

Mettez à jour facilement le chemin vers vos éléments médias externes lorsqu’ils sont déplacés

Mettez à jour facilement le chemin vers vos éléments médias externes lorsqu'ils sont déplacés
Catégories: articles

Vous pouvez choisir comment vos éléments de bibliothèque (images, films, documents, etc.) sont gérés par HelpNDoc: ils peuvent être inclus dans votre projet, ou ils peuvent être inclus de manière dynamique au moment de la génération, lorsque vous décidez de construire les fichiers de votre documentation finale. Lorsque vous utilisez la seconde option, vous indiquez un chemin vers vos éléments médias afin que HelpNDoc puisse les trouver et les inclure lorsque nécessaire. Il est très utile de pouvoir manipuler ces éléments hors de HelpNDoc, comme de les partager avec un logiciel tiers par exemple... Cependant, un problème peut se présenter si vous devez déplacer ces éléments sur votre disque dur ou le chemin réseau: pour être sûr que HelpNDoc puisse toujours trouver vos éléments médias, il vous faudra tous les mettre à jour manuellement, un par un. Comme cela peut s'avérer une tâche très longue, très fastidieuse et source d'erreurs, c'est une excellente occasion d'utiliser le puissant éditeur de script de HelpNDoc. Voyons comment nous pouvons tirer parti de ce dernier pour mettre à jour rapidement toute la bibliothèque en quelques secondes.

Lire la suite →

Rechercher et remplacer dans l’éditeur de script, prise en charge des mots à un caractère dans le moteur de recherche HTML et bien davantage dans HelpNDoc 7.7

Rechercher et remplacer dans l'éditeur de script, prise en charge des mots à un caractère dans le moteur de recherche HTML et bien davantage dans HelpNDoc 7.7
Catégories: nouvelles

Nous sommes ravis d'annoncer la version 7.7 de HelpNDoc, une importante mise à jour du populaire outil de création d'aides qui peut être téléchargée gratuitement pour un usage personnel et à des fins d'évaluation. Cette révision majeure apporte de nombreuses fonctionnalités et améliorations, dont un éditeur de script considérablement amélioré avec des capacités de recherche/remplacement et plusieurs nouvelles options personnalisables, la possibilité d'indexer des mots à un seul caractère dans le moteur de recherche HTML, de nouvelles options en ligne de commande pour ouvrir un projet à un chapitre spécifique, la prise en charge officielle de Windows 11 et beaucoup plus... Lisez la suite pour en apprendre davantage et téléchargez votre version gratuite de HelpNDoc maintenant.

Lire la suite →

Trier rapidement (par titre) le contenu d’une aide, les chapitres d’une documentation ou d’un livre électronique

Trier rapidement (par titre) le contenu d'une aide, les chapitres d'une documentation ou d'un livre électronique
Catégories: articles

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

Lire la suite →

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

Utilisation des fonctionnalités de script de HelpNDoc pour réinitialiser automatiquement tous les numéros contextuels d'aide
Catégories: articles

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

Lire la suite →

Utiliser des scripts pour automatiser la création d’aides et de documentations

Utiliser des scripts pour automatiser la création d'aides et de documentations
Catégories: articles

HelpNDoc est si facile à utiliser qu'une documentation complète multi-format et multi-device peut être réalisée en quelques minutes après avoir téléchargé et essayé HelpNDoc pour la première fois, grâce à son interface utilisateur intuitive et son éditeur de chapitre de type Microsoft Word. Il est aussi très puissant et offre de nombreux outils de pointe pour simplifier et accélérer la création de fichiers d'aide et de manuels les plus étonnants. Une de ces fonctionnalités avancées est l'éditeur de script qui vous permet de manipuler HelpNDoc par le biais d'un langage de script. Voyons comment l'éditeur de script peut vous aider à créer les fichiers d'aide les plus utiles dans le plus court laps de temps possible

Lire la suite →