Export documentation to HTML

Applies to: 5.x versions, Article available also for: 9.x (current), 8.x, 7.x, 6.x
You are looking at documentation for an older release.
Switch to the documentation for Dataedo 9.x (current).

Dataedo enables exporting your documentation to an interactive HTML site. To export the documentation select chosen documentation in the navigation tree and click Export documentation button in the ribbon.

Export button

It opens Export documentation wizard. The first step is to choose a format. Choose 'HTML' and click Next.

Export HTML

Then select a site template. There are two standard formats:

  1. Web server - creates one HTML file per page and is more natural and effective. This one should be your default choice if you want to host documentation on a web server (internal or external). It will not work properly when used locally (Chrome, Edge)

  2. Local disk - If you prefer to use documentation on local disk then this format is advised.

When chosen, click Next.

HTML template

Now you may choose modules you want to exclude from your documentation, just uncheck them. 'Other' module means all unassigned objects. By default, all modules are selected.

Choose modules

Now you may define which elements you want in your documentation.

Choose object types

In last step, you can choose a destination folder and file name. Click Export to start.

Choose file

Your document is being generated:

Generating documentation

When ready you will be asked if you want to open a browser.

Open file

Your export is complete.

Found issue with this article? Comment below
0
There are no comments. Click here to write the first comment.