×

Copyright © 2004 - 2025, Indigo Byte Systems LLC. All rights reserved.

Publishing HTML help

 
Documentation in HTML format can be viewed by the end-users in a web browser on any operating system. If you upload exported HTML files to your website, you can update them at any time, without having to ship an updated version of the documentation with a new version of your software.
 
HTML files generated by Dr.Explain can be viewed locally, without having to upload them to your website.
 
https://www.youtube.com/watch?v=i_OZsIF_K-s
 
 
There are several ways to publish your help project to HTML:
  • click button in the application toolbar;
  • go to the Options menu and click the Export to HTML menu option;
  • use the Alt+Shift+L keyboard shortcut.
 
The following dialog window will appear:
 
Publishing HTML help
 
1

Path field

1. Path field
 
Click Choose folder... to select the target folder. Exported files will be placed into this folder.
 
Click button to open target folder in Windows Explorer.
2

Validation tool

2. Validation tool
 
Check this option to validate your project files before publishing them.
3

Folder cleanup

3. Folder cleanup
 
Check this option to clear the output folder before export.
 
If you enable this option, all files in the destination folder will be deleted!
4

Automatic publishing

4. Automatic publishing
 
Check this option to upload output files onto your web server automatically via FTP or onto your Tiwri site.
5

Index file

5. Index file
 
Check this option to add the index file to the generated HTML files. The index file is usually the starting page of the online manual.
6

Progress bar

 
This bar shows the progress of the publishing process.
7

Process log

 
This section shows the log messages of the publishing processes.
8

More options

8. More options
 
Press this button to display the HTML export settings dialog where you can configure the options for the output files.
9

Start/stop export

9. Start/stop export
 
Press this button to start the publishing process. Once it started, this button turns into the Stop export button. Click Stop export to stop the publishing process (e.g. if you need to make changes to your project).
10

Close

10. Close
 
Press this button to close the Batch export to HTML pages dialog.
 
After the publishing process finishes, the generated files will be available in the folder you specified in the path field. You can upload these files to your web server using a third-party software or ship them with your application.
 
If you selected Open index page when finished, Dr.Explain will open the exported HTML files in default browser:
 
 
HTML layout is responsive, ensuring it displays perfectly on devices like smartphones and tablets:
 
Made by Dr.Explain, software documentation tool