×
Menu
Index

Publishing HTML help

 
HTML is preferable if your software is platform-independent and users can also open the help file in their web browsers on any operating system. Storing help files as HTML pages on your website is also useful when you update your documentation frequently by adding new topics and pages. In this case, users do not have to download the entire help file after each update.
 
There are several ways to publish your help project to HTML:
 
Once you select this option, the following dialog appears:
 
Publishing HTML help
 
1

Path field

1. Path field
Specify the path to the directory where Dr.Explain should save the HTML files. Use the Browse button to browse for the necessary folder.
2

Validation tool

2. Validation tool
Select this check box if you want to validate your project files before publishing them.
3

Folder cleanup

3. Folder cleanup
Check this option to clear the output folder before export. Beware, this function will delete all files in destination folder.
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
Select this check box if you want 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 optionsClick this button to display the HTML export settings dialog where you can configure the options for the output files.
 
9

Browse button

9. Browse buttonClick this button to browse for the directory where Dr.Explain should save the published HTML files to.
10

Open button

10. Open buttonClick this button to open target folder in Windows Explorer.
11

Start/Stop export button

11. Start/Stop export buttonClick this button to start the publishing process. During the publishing process, this button turns into the Stop export button. Use it when you need to stop the publishing process and add any changes to your project.
12

Close button

12. Close buttonClick this button to close the Batch export to HTML pages dialog.
 
 
Once the publishing process is completed you can use the generated files (from the folder you specified in the path field) to upload them to your website and turn into online help for your application.
 
Upon completion of the publishing process, Dr.Explain will open the generated HTML help in your default browser:
 
 
The web help layout is responsive and is optimized for small screens of mobile and tablet devices as well:
The online help was made with Dr.Explain