nelson help reference

How to write help XML files for Nelson (elements, attributes, examples, tips).

📝 Syntax

• (root) — REQUIRED child:

• Header:, <language>, <module_name>, <chapter>, <short_description>

• Sections: <syntax>, <param_input>, <param_output>, <description>, <examples>, <see_also>, <history>, <authors>, <bibliography>

📥 Input argument

• language - Locale used by the XSLT to select labels and localized text. Examples: en_US, fr_FR. This element is required on the root .

• keyword - Main identifier shown as the page title by the XSLT. If absent, the XSLT falls back to or "Documentation".

📤 Output argument

• html - The XSLT generates an HTML file using local assets: highlight.css, nelson_common.css and nelson_help.js. Images are copied via the extension ext:copy_img.

📄 Description

A human-readable reference and definitive example set describing the XML help file format defined by nelson_help.xsd, and how nelson_html.xslt transforms its elements into HTML.

Use to provide the main documentation body. It accepts paragraphs (

), lists (

• ,

• ), tables (), inline markup (, , ), images () and LaTeX ().Inline elements and their XSLT rendering:— bold text.— italic text.— inline code rendering.— external links (rendered as HTML anchors).— internal cross reference. If linkend contains a module in braces {module}name it becomes ../module/name.html, otherwise name.html.— math expressions; rendered as MathJax display math by the XSLT template (wrapped with $...$). — images. XSLT calls ext:copy_img(@src); SVGs are rendered with a large fixed frame and other formats are responsive. Block elements:and— lists. Usewith nested inline/block markup as needed.— use , , ,