HelpNDoc's generated HTML documentation can be used as a context sensitive help source by using either a topic's Help ID or Help Context number


Using Help IDs

It is possible to show a specific topic using its Help ID. As an example, HelpNDoc's online topic "Change topic properties" (whose Help Id is "Changetopicproperties") can be shown as follows: https://www.helpndoc.com/sites/default/files/documentation/html/Changetopicproperties.html


The pattern is http://www.WEB-SITE.com/HELP-ID.html


Where:

  • "www.WEB-SITE.com" is the full address of your web site
  • "HELP-ID" is the unique help id of the topic to show


Help IDs are unique topics identifiers (alpha-numeric) which you can customize. Learn more on how to get and define topic's Help Ids.


Using Context numbers

The default HTML template also generate redirects to access topics via their Help Context numbers. As an example, HelpNDoc's online topic "Change topic properties" (whose Help Context number is "78") can be shown as follows: https://www.helpndoc.com/sites/default/files/documentation/html/context/78.html


The pattern is http://www.WEB-SITE.com/context/HELP-CONTEXT.html


Where:

  • "www.WEB-SITE.com" is the full address of your web site
  • "HELP-CONTEXT" is the unique help context of the topic to show


Help context numbers are unique topics identifiers (numeric) which you can customize. Learn more on how to get and define topic's Help Ids.


See the How to manage your topic identifiers in HelpNDoc step-by-step guide.