Generating DTD Documentation

See Also 

XHTML documentation describes each of the element declarations in your DTD, including its declared attributes, element content model, and the elements by which it is referenced. The IDE enables you to automatically generate XHTML documentation for any DTDs that are mounted in the IDE.

To generate documentation for a DTD:

  1. Add DTDDoc comments to your DTD if necessary.
  2. Right-click the DTD node in the Files window and choose Generate Documentation.
  3. Type a file name for the documentation file and click OK
  4. In the Select File Name dialog box, type a file name for the documentation to be generated.

    The IDE creates an HTML document that contains the DTD's documentation.

Customizing a Declaration Description

You can add additional information to an element declaration's description by inserting a DTDDoc comment before the element declaration in the DTD. You can format the DTDDoc comment's appearance by using any XHTML tags allowed by the <DIV> element, as shown in the following example:

<!--- 
<b>The root element:</b>
  <ul>
    <li>Contains one or more item elements.</li> 
    <li>Sets attributes for item elements.</li>
  </ul> 
--> 
<!ELEMENT root ANY>
See Also
Creating a DTD
Working With XML Schemas
Creating a Cascading Style Sheet

Legal Notices