ApplicationExportDataInterfacesToHTML

This command exports the current script, class, and object data interfaces to a series of directories containing HTML documentation. Class EditModel3D is a good example.

Using This Command For The First Time

Make sure your C++ data interfaces are properly documented and string tables are present.

1. Load \PROGRAM FILES\SCENOMICS\SCRIPTS\APPLICATION_SCRIPTS.SSL in a text editor.
2. Find the line: Application.LogInterfacesHtml( "c:\\docs", "c:\\business\\source\\ExternalDocs" );
3. Set the first path to the desired path for the output documentation.
4. Set the second path to the desired path for the example/sample code. This must not be the same directory [ don't use a subdirectory either ] as the first path.
5. Save the file.
6. Start Scenome.
7. If Scenome is already running, select Desktop » Refresh Scripts from the main menu.
8. Select Desktop » Log Data Interfaces: HTML from the main menu.
9. The software builds the data interface documentation and example/sample directories.
10. Explore the folder created in the second parameter.
11. This contains a list of folders for each object type.
    NOTE: This creates a complete list of data interfaces active in Scenome, including data interfaces that have already been documented by us. You do not have to create example/sample files for any data interfaces except your own.
12. Insert EXAMPLE.TXT and SAMPLE.TXT into the appropriate directory.

Using This Command Again

To generate a new version of your HTML documentation after you have run the command once.

1. Select Desktop » Log Data Interfaces: HTML from the main menu.
2. The software builds the data interface documentation.
3. Create a table of contents.
4. Upload the documentation to a web server.
5. Implement the necessary server side includes.
6. Implement a stylesheet.

Server Side Includes

You need to implement the server side include files or your server will display an error message in the output documentation. View a sample document without server side includes.

Stylesheets

You need to implement a stylesheet or your web browser will display unstyled help. View a sample document without a stylesheet. You can still read the documentation without a stylesheet.

Registration

Command registration information is as follows:

• Corporate
• |
• RSS/XML
• |
• Legal
• |
• Validate XHTML
• |
• Copyright © 2008 Scenomics. All Rights Reserved.