Documentation et gestion de l'aide

Le module Help Tools fournit des fonctions pour créer, convertir et gérer la documentation pour Nelson.

Il prend en charge la génération de contenu d'aide dans plusieurs formats, y compris HTML, Markdown, PDF et formats prêts pour le web, permettant aux développeurs de maintenir et de distribuer efficacement une documentation complète.

Functions

• Aide Nelson - Comment rédiger des fichiers XML d'aide pour Nelson (éléments, attributs, exemples, conseils).

• buildhelp - Génère l'aide des modules de Nelson.

• buildhelpjson - Construire l'aide de Nelson au format JSON.

• buildhelpmd - Génère l'aide des modules de Nelson pour GitBook.

• buildhelpweb - Génère l'aide des modules de Nelson pour un site web.

• deployhelp - Installer, désinstaller et gérer le système d'aide local de Nelson et les fichiers d'aide des modules.

• doc - Affiche la documentation.

• docroot - Récupère ou met à jour le répertoire racine du système d'aide de Nelson.

• headcomments - Affiche les commentaires d'en-tête d'une fonction Nelson.

• help - Aide pour les fonctions dans la fenêtre de commande.

• htmltopdf - Convertit une page HTML en PDF.

• markdown - Convertit le Markdown en HTML.

• xmldocbuild - Fonction interne pour convertir des fichiers XML en HTML.

• xmldocchecker - Vérifie un fichier de documentation XML.

• xmldoctohelp - Convertit des fichiers d'aide XML Nelson au format Nelson.

• xmldoctohtml - Convertit des fichiers d'aide XML Nelson en HTML.

• xmldoctomd - Convertit des fichiers d'aide XML Nelson au format Markdown.