Documentation

Table of Contents:


    Exporting documentation to HTML

    Applies to: 7.x (current), Article available also for: 6.x, 5.x

    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.

    Learn more:

    1. Publishing on web server
    2. Publishing documentation on Confluence
    Found issue with this article? Comment below
    Comments (0)