Documentation and Help Management

The Help Tools module provides functions to create, convert, and manage documentation for Nelson.

It supports generating help content in multiple formats, including HTML, Markdown, PDF, and website-ready formats, enabling developers to maintain and distribute comprehensive documentation efficiently.

nelson help reference
How to write help XML files for Nelson (elements, attributes, examples, tips).
buildhelp
Build help of Nelson's modules.
buildhelpjson
Build help of Nelson JSON format.
buildhelpmd
Build help of Nelson's modules for GitBook.
buildhelpweb
Build help of Nelson's modules for website.
deployhelp
Install, uninstall and manage the local Nelson help system and module help files.
doc
Displays documentation.
docroot
Retrieve or update the root directory for Nelson Help system.
headcomments
Display Nelson function header comments.
help
Help for functions in Command Window.
htmltopdf
Convers html page to pdf.
markdown
Converts markdown to html.
xmldocbuild
Internal function to convert xml document files to html.
xmldocchecker
Checks a xml documentation file.
xmldoctohelp
Converts xml Nelson help files to Nelson format.
xmldoctohtml
Converts xml Nelson help files to html.
xmldoctomd
Converts xml Nelson help files to markdown format.