HelpNDoc User Manual

Field

Description

Clean output directory

Optionally clean the output directory before generation starts. Warning: this will delete any file and folder in the output directory.

Custom CSS

Add custom CSS in all generated HTML files

Custom JavaScript

Add custom JavaScript code in all generated HTML files

Export normal style

Define the normal style as the default style. Use web browser's default otherwise

Font size as percent

Use percent values for font sizes

Footer (HTML)

Custom HTML code which will be added at the bottom of each topic

Force image size generation

Generated HTML code will contain image's width and height to avoid content shifting and enhanced Core Web Vitals

Google Analytics Id

Google Analytics property tracking Id to collect user stats. Google Analytics code is not added if Id is not specified

Google Tag Manager Id

Google Tag Manager (GTM) container ID which installs marketing tags without modifying the documentation's code. See Setup Google tag manager 

Inline table of content's width

Define the preferred width of the inline table of contents. Note: can be any CSS units such as "auto", "250x", "50vw"...

Keywords expand level

The default keywords tree expansion level: 1 will expand root level keywords, 2 will also expand first level keywords...

Keywords tab title

The title of the keywords tab. See: How to localize your documentation output

Library item directory

Define the sub-directory where library items are generated

Link format to anchors override

Override the template defined link format to anchors. Available variables include %topicid%, %helpid% and %anchorname%. See Handle the generated topic links 

Link format to topics override

Override the template defined link format to topics. Available variables include %topicid%, %helpid% and %anchorname%. See Handle the generated topic links 

Logo

A custom image from the project's library to use as a logo. See also "Logo URL". Note: if both "Logo" and "Logo URL" are indicated, "Logo URL" will be used

Logo alt

Alternative text for the logo

Logo link

Link to redirect to when clicking the logo

Logo URL

The URL of a picture to use as a logo. See also "Logo". Note: if both "Logo" and "Logo URL" are indicated, "Logo URL" will be used

Numbering as text

Use text instead of OL/LI elements when generating lists

Search tab title

The title of the search tab. See: How to localize your documentation output

Show BreadCrumbs

Show or hide the breadcrumbs at the top of each topic

Show inline table of contents

Show or hide the topic's inline table of contents. See: Inline table of contents

Show navigation arrows

Show or hide the navigation arrows at the top of each topic

Show splitter bar

Show or hide the resizable bar between the table of contents and topic content

Show the keywords tab

Show or hide the keywords tab

Show the search tab

Show or hide the search tab

Show the table of contents tab

Show or hide the table of contents tab

Sitemap base URL

The URL of the generated documentation. Will be used to generate the sitemap links

Sitemap change frequency: home

How often will the home page change

Sitemap change frequency: others

How often will the topics change

Sitemap priority: home

Priority of the home page in the sitemap

Sitemap priority: others

Priority of the topics in the sitemap

Sitemap: Generate ?

Generate or not the sitemap file

Table of contents expand level

The default table of contents expansion level: 1 will expand root level topics, 2 will also expand second level topics...

Table of contents tab title

The title of the table of contents tab. See: How to localize your documentation output

Table of contents width

The width of the table of contents in pixels

Theme

The color theme to use

Topic file extension override

Override the template's topic file extension. Templates usually use this to generate individual topic filenames. Note: Use space characters for empty extensions. See: HTML Based templates' general settings 

Translation for...

The translation for the specified English term