HelpNDoc comprend un gestionnaire de modèles très puissant où vous pouvez personnaliser n’importe quelle partie de la documentation générée. Il offre aux rédacteurs techniques un large éventail d’options de personnalisation, notamment la possibilité de modifier l’apparence des titres, du texte, des tableaux, des images et d’autres éléments de leur documentation. Les concepteurs peuvent également ajouter des logos personnalisés, modifier la couleur de l’arrière-plan et ajuster la taille et le style de la police pour créer un style de documentation unique et personnalisé.
PHP est un puissant langage de script côté serveur qui constitue un outil essentiel du développement Web depuis des décennies. Grâce à sa capacité à générer dynamiquement du contenu, à améliorer l'expérience utilisateur, à gérer les restrictions de sécurité, à augmenter l'interactivité ou à collecter des données sur les utilisateurs, il constitue un excellent complément à la documentation utilisateur en ligne. Grâce au système de modèles puissant et polyvalent de l'outil de création d'aide HelpNDoc, ces avantages sont désormais facilement réalisables : explorons comment l'intégration de PHP dans la documentation utilisateur en ligne peut contribuer à améliorer l'expérience utilisateur et à fournir un meilleur engagement et un meilleur retour d'information. Que vous soyez un développeur web, un rédacteur technique ou quelqu'un qui cherche à améliorer sa documentation en ligne, cet article vous fournira des informations et des conseils précieux sur la façon d'utiliser HelpNDoc pour tirer le meilleur parti de PHP dans votre documentation en ligne.
Les rédacteurs techniques peuvent utiliser un fichier robots.txt spécial ou définir des balises méta robots dans leur documentation HTML pour spécifier comment les moteurs de recherche courants, tels que Google ou Bing, doivent indexer et présenter les pages individuelles dans les résultats de recherche. Dans cet article, nous verrons comment mettre à jour le modèle HTML par défaut, fourni par l’outil de création d’aide HelpNDoc, pour générer un fichier robots.txt, spécifier une valeur par défaut à l’échelle du projet pour la balise méta robots et remplacer son contenu pour des pages de documentation spécifiques.
La création de la documentation la plus complète, exhaustive et actualisée est le souci premier des rédacteurs techniques. Mais les lecteurs veulent un design épuré et moderne, et les entreprises doivent souvent intégrer des sites web de documentation à leur support existant, adoptant ainsi une apparence prédéfinie. Heureusement, l'outil de création d'aide HelpNDoc vous permet d'ajouter rapidement un logo ou un code CSS sur mesure pour une personnalisation rapide, ou même de créer un tout nouveau modèle pour personnaliser entièrement vos productions. Voyons, dans cet article, comment utiliser des icônes personnalisées dans la table des matières de la documentation HTML générée.
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.
HelpNDoc dispose d'un puissant gestionnaire de modèles avec lequel vous pouvez personnaliser n'importe quelle partie de la documentation générée. Vous utiliserez la plupart du temps le modèle par défaut du format de documentation à personnaliser comme point de départ. Mais, après la sortie d'une nouvelle version de HelpNDoc, le modèle par défaut peut avoir évolué avec de nouvelles fonctionnalités et des correctifs, et vous voudrez peut-être inclure ces modifications dans vos modèles personnalisés. La solution est de comparer et fusionner le modèle par défaut (mis à jour) et le vôtre. Nous allons voir comment accomplir cette tâche sans peine et en toute sécurité
HelpNDoc est un puissant outil de création d'aide pouvant générer plusieurs formats de documentation (dont CHM, HTML, Word, PDF, ePub, Kindle, Aide Qt) à partir d'une seule source. Il dispose d'un très puissant système de modèles fournissant le moyen de personnaliser presque n'importe quel aspect de la documentation créée. Une fois un modèle personnalisé créé, il peut facilement être partagé entre plusieurs collaborateurs ou sauvegardé. Voyons comment faire cela
On nous a demandé sur FaceBook, s'il était possible d'attribuer un favicon à une construction d'aide HTML générée par HelpNDoc. C'est une excellente question et la réponse est oui, tout à fait, grâce au puissant système de modèle d'HelpNDoc. Voyons comment cela peut être fait en créant d'abord notre favicon, puis notre propre modèle personnalisé qui utilisera ce favicon
HelpNDoc vous offre un éditeur de modèle intuitif qui permet de personnaliser facilement l'aspect et l'impression que donne votre documentation PDF et Word afin de répondre à des besoins spécifiques. Vous pouvez façonner n'importe lesquels des paramètres et des propriétés des modèles PDF et Word que vous avez créés entièrement, ainsi que de ceux que vous avez copiés à partir d'autres modèles.
Quand un modèle devient obsolète, il est facile de l'effacer. Lorsque vous effacez un modèle, vous éliminez définitivement le modèle de même que ses paramètres et ses propriétés.
Il est recommandé d'assigner un nom qui vous aide à vous souvenir de l'objet d'un modèle. Quand vous mettez à jour les paramètres et les propriétés de vos modèles, il peut aussi être nécessaire de mettre à jour les noms de vos modèles. Cela est très simple à faire.
