Options Tab

When you click on the Options Tab, the following dialog will appear:

Options Tab

XML Schema Options

The XML Schema Options allow you to control how attributes are documented.

Other Option Description

Include schema descriptions Indicates whether schema descriptions should be included.

Include namespace definitions Indicates whether namespace definitions should be documented.

Include namespace prefixes on schema overviews Indicates whether namespace prefixes should be documented in the schema overview.

Include namespace prefixes on schema objects Indicates whether namespace prefixes should be included on schema objects.

Include remarks Indicates whether remarks for the schema should be included.

Other Option	Description
Include schema descriptions	Indicates whether schema descriptions should be included.
Include namespace definitions	Indicates whether namespace definitions should be documented.
Include namespace prefixes on schema overviews	Indicates whether namespace prefixes should be documented in the schema overview.
Include namespace prefixes on schema objects	Indicates whether namespace prefixes should be included on schema objects.
Include remarks	Indicates whether remarks for the schema should be included.

Content Model Options

The Content Model Options allow you to control how attributes are documented.

Content Model Option Description

Include content model descriptions Indicates whether content model descriptions should be included.

Include content model type Indicates whether the type of content model should be documented.

Sort non-sequenced contents Indicates whether the non-sequenced elements within the model should be sorted by name.

Include compositors Indicates whether compositors should be documented.

Include default Indicates whether the default value for a component element should be documented.

Include occurrences Indicates whether the minimum and maximum occurrences in the content model should be documented.

Include nillable indicator Indicates whether the nillable indicator for an element should be documented.

Content Model Option	Description
Include content model descriptions	Indicates whether content model descriptions should be included.
Include content model type	Indicates whether the type of content model should be documented.
Sort non-sequenced contents	Indicates whether the non-sequenced elements within the model should be sorted by name.
Include compositors	Indicates whether compositors should be documented.
Include default	Indicates whether the default value for a component element should be documented.
Include occurrences	Indicates whether the minimum and maximum occurrences in the content model should be documented.
Include nillable indicator	Indicates whether the nillable indicator for an element should be documented.

Element Options

The Elements Options allow you to control how elements are documented.

Element Option Description

Include element descriptions Indicates whether element descriptions should be included.

Include element type Indicates whether the element type should be documented.

Include enumerations Indicates whether enumerated element values should be documented.

Include default value Indicates whether the default value for the element should be documented.

Include references Indicates whether references by other elements and complex types should be documented.

Include remarks Indicates whether remarks for the element should be included.

Include restrictions Indicates whether value restrictions should be documented.

Include definition Indicates whether the XSD tags or DTD statements that define the element should be documented.

Include example Indicates whether an example section should be documented.

Merge topics Merges documentation for all elements under a single topic.

Element Option	Description
Include element descriptions	Indicates whether element descriptions should be included.
Include element type	Indicates whether the element type should be documented.
Include enumerations	Indicates whether enumerated element values should be documented.
Include default value	Indicates whether the default value for the element should be documented.
Include references	Indicates whether references by other elements and complex types should be documented.
Include remarks	Indicates whether remarks for the element should be included.
Include restrictions	Indicates whether value restrictions should be documented.
Include definition	Indicates whether the XSD tags or DTD statements that define the element should be documented.
Include example	Indicates whether an example section should be documented.
Merge topics	Merges documentation for all elements under a single topic.

Simple Type Options

The Simple Type Options allow you to control how simple types are documented.

Simple Type Option Description

Include descriptions Indicates whether simple type descriptions should be included.

Include base type Indicates whether the type that the simple type is based on should be documented.

Include enumerations Indicates whether enumerated simple type values should be documented.

Include references Indicates whether references by other simple types, complex types, attributes and elements should be documented.

Include remarks Indicates whether remarks for the simple type should be included.

Include restrictions Indicates whether value restrictions should be documented.

Include definition Indicates whether the XSD tags or DTD statements that define the simple type should be documented.

Merge topics Merges documentation for all simple types under a single topic.

Simple Type Option	Description
Include descriptions	Indicates whether simple type descriptions should be included.
Include base type	Indicates whether the type that the simple type is based on should be documented.
Include enumerations	Indicates whether enumerated simple type values should be documented.
Include references	Indicates whether references by other simple types, complex types, attributes and elements should be documented.
Include remarks	Indicates whether remarks for the simple type should be included.
Include restrictions	Indicates whether value restrictions should be documented.
Include definition	Indicates whether the XSD tags or DTD statements that define the simple type should be documented.
Merge topics	Merges documentation for all simple types under a single topic.

Complex Type Options

The Complex Type Options allow you to control how complex types are documented.

Complex Type Option Description

Include descriptions Indicates whether complex type descriptions should be included.

Include base type Indicates whether the type that the complex type is based on should be documented.

Include references Indicates whether references by other complex types and elements should be documented.

Include remarks Indicates whether remarks for the complex type should be included.

Include definition Indicates whether the XSD tags or DTD statements that define the complex type should be documented.

Merge topics Merges documentation for all complex types under a single topic.

Complex Type Option	Description
Include descriptions	Indicates whether complex type descriptions should be included.
Include base type	Indicates whether the type that the complex type is based on should be documented.
Include references	Indicates whether references by other complex types and elements should be documented.
Include remarks	Indicates whether remarks for the complex type should be included.
Include definition	Indicates whether the XSD tags or DTD statements that define the complex type should be documented.
Merge topics	Merges documentation for all complex types under a single topic.

Attribute Options

The Attribute Options allow you to control how attributes are documented.

Attribute Option Description

Include attribute descriptions Indicates whether attribute descriptions should be included.

Include attribute type Indicates whether the attribute type should be documented.

Include enumerations Indicates whether enumerated attribute values should be documented.

Include required indicator Indicates whether attributes that require a value are flagged in the document.

Include references Indicates whether references by elements and complex types should be documented.

Include remarks Indicates whether remarks for the attribute should be included.

Include restrictions Indicates whether value restrictions should be documented.

Include definition Indicates whether the XSD tags or DTD statements that define the attribute should be documented.

Include default value Indicates whether the default value for the attribute should be documented.

Merge topics Merges documentation for all attributes under a single topic.

Omit all attribute topics and references to filtered attributes By default, when you use the Filter tab to exclude an attribute, only the topic page for the attribute is omitted. The filtered attribute will still be listed under any element or complex type topic page that includes that attribute. By setting this option, TechWriter will omit all topic pages for attributes, and omit filtered attributes from the element and complex type topic pages.

Attribute Option	Description
Include attribute descriptions	Indicates whether attribute descriptions should be included.
Include attribute type	Indicates whether the attribute type should be documented.
Include enumerations	Indicates whether enumerated attribute values should be documented.
Include required indicator	Indicates whether attributes that require a value are flagged in the document.
Include references	Indicates whether references by elements and complex types should be documented.
Include remarks	Indicates whether remarks for the attribute should be included.
Include restrictions	Indicates whether value restrictions should be documented.
Include definition	Indicates whether the XSD tags or DTD statements that define the attribute should be documented.
Include default value	Indicates whether the default value for the attribute should be documented.
Merge topics	Merges documentation for all attributes under a single topic.
Omit all attribute topics and references to filtered attributes	By default, when you use the Filter tab to exclude an attribute, only the topic page for the attribute is omitted. The filtered attribute will still be listed under any element or complex type topic page that includes that attribute. By setting this option, TechWriter will omit all topic pages for attributes, and omit filtered attributes from the element and complex type topic pages.