Documentation and Help Management

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

It generates help content in formats such as HTML, Markdown, PDF, and website-ready output for maintaining and distributing documentation.

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.
buildhelptypst
Build help of Nelson's modules as Typst sources.
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.
markdowndisp
Display rendered Markdown text.
xmldocbuild
Internal function to convert xml document files to html.
xmldocchecker
Checks a xml documentation file.
xmldoclinkchecker
Checks unresolved cross-references in Nelson help XML files.
xmldocrenderimages
Render the example images of Nelson help files.
xmldoctohtml
Converts xml Nelson help files to html.
xmldoctomd
Converts xml Nelson help files to markdown format.
xmldoctotypst
Converts xml Nelson help files to Typst sources.