Generating HTML documentation from an XML schema file

HTML documentation contains information about the XML schema. You can open it in the HTML editor to view it.

The following instructions were written for the Resource perspective, but they will also work in many other perspectives.

To generate HTML documentation based on an XML schema file:

1. In the Outline view, right-click the XML schema.

2. Click Generate > HTML Doc. The Generate XML schema documentation dialog opens.

3. Select the style of the HTML documentation
   1. If you want one HTML file to contain all the information, select Single HTML file with no frames.

   2. Otherwise, select Multiple HTML file with frames

4. If you selected Single HTML file with no frames, you can either click Finish and the HTML file will automatically be generated with the same name as the source file and in the same location, or you can click Next to select the folder you want the HTML documentation created in and specify the name of the HTML file, then click Finish. The HTML file is created. You can now open it in the HTML editor.

5. If you selected Multiple HTML file with frames, click Next to specify the target folder for your HTML files, then click Finish. The HTML files are created in the location you specified.

The HTML documentation contains the following information:

• The schema name.

• The schema location.

• The schema's target namespace.

• Any documentation supplied in the schema.

• Information about each component in the schema, such as the type of the component and its source code. Additional information about the component may be supplied depending on the component.

When Hebrew Logical (ISO-8859-8-I) encoding is selected as a preference for encoding of HTML files (Window > Preferences > Web and XML Files > HTML files in the "When creating files" section), the HTML documentation files generated from an XML schema file will still have a UTF-8 encoding. This is a known problem.

 

Related tasks

Creating XML schemas