Home >
Online Product Documentation >
Table of Contents >
Options - Module Settings - XML Schema Editor - Documentation
Options - Module Settings - XML Schema Editor - Documentation
|
|
|
The XSD
Documentation tab is available only in Stylus Studio XML Enterprise Edition and Stylus Studio XML Professional Edition.
|
You use the
Documenation page of the
Options dialog box to specify the layout and contents of the XML Schema documentation displayed on the
Documentation tab of the XML Schema Editor.
Fields
Documentation Style
Determines the format that Stylus Studio uses to display and print the XML Schema shown on the
Documentation tab. The default is XS3P. A sample is shown here:
|
|
Figure 417. XS3P XML Schema Display Style
Options - XS3P
Note that options vary based on the documentation style you select. The following options pertain to the XS3P style.
baseURL
The base URL used to resolve links in the XML Schema.
base_IMG_URL
The base URL used to resolve diagrams in the XML Schema documentation.
DEFAULT_DOCUMENT_EXT
The extension you want to use for the saved XML Schema documentation. The default is
.html.
externalCSSURL
The external CSS stylesheet used to render the XML Schema documentation. If no value is specified, Stylus Studio uses internally-declared CSS properties.
linksFile
URL of an XML document that maps the XML Schema's URL to the related documentation URL for imported and included schemas.
printAllSubTypes
Controls which sub-types are displayed in the XML Schema documentation.
-
True - All sub-types that appear in the XML Instance Representation tables in the XML Schema documentation are displayed.
-
False - Only direct sub-types are displayed.
printAllSuperTypes
Controls which super-types are displayed in the XML Schema documentation.
-
True - All super-types that appear in the XML Instance Representation tables in the XML Schema report are displayed.
-
False - Only direct super-types are displayed.
printDiagram
-
True - Displays/ schema diagrams in the XML Schema documentation.
-
False - Does not display schema diagrams in the XML Schema documentation.
print Glossary
-
True - Displays the XML Schema documentation's Glossary.
-
False - Does not display the XML Schema documentation's Glossary.
|
Tip
|
|
You can hide the Glossary by clicking the
Printer-friendly Version check box.
|
printLegend
-
True - Displays the XML Schema documentation's Legend.
-
False - Does not display the XML Schema documentation's Legend.
|
Tip
|
|
You can hide the Legend by clicking the
Printer-friendly Version check box.
|
printNSPrefixes
-
True - Displays the prefix that matches the namespace of schema components in XML Instance Representation tables.
-
False - Prefixes of matching namespaces are not displayed.
searchImportedSchemas
-
True - `imported' schemas are searched for schema components when generating links and XML Instance Representation tables.
-
False - `imported' schemas are not searched.
searchIncludedSchemas
-
True - `included' schemas are searched for schema components when generating links and XML Instance Representation tables.
-
False - `included' schemas are not searched.
sortByComponent
Determines how report content is sorted:
-
True - Sorts the top-level schema components by type, then name.
-
False - Displays the components in the order in which they appear in the schema.
title
The title of the XML Schema documentation. The default, which is not displayed in the
Options dialog box, is
XML Schema Documentation.
useJavaScript
Some Internet browsers do not support JavaScript. This option allows you to specify whether you want Stylus Studio to generate the XML Schema documentation as plain HTML or as HTML plus JavaScript.
Options - XSDDOC
Note that options vary based on the documentation style you select. The following options pertain to the XSDdoc style.
Doctitle
Document title. The text you enter here is displayed on the overview page (
index.html).
Footer
The text you enter here is displayed at the bottom of every page. The default is
http://www.stylusstudio.com.
Header
The text you enter here is displayed in the
Namespaces frame (if you are displaying the XML Schema documentation using frames) and in the navigational header that appears at the top and bottom of every page, an example of which is shown here:
|
|
Figure 418. XSDdoc Header Text
HideAttributes
Whether or not attributes are hidden in the XML Schema documentation.
-
True - Attributes are hidden in the XML Schema documentation.
-
False - Attributes are not hidden in the XML Schema documentation. This is the default.
HideGroups
Whether or not groups are hidden in the XML Schema documentation.
-
True - Groups are hidden in the XML Schema documentation.
-
False - Groups are not hidden in the XML Schema documentation. This is the default.
HideLocalUsage
Whether or not local type definitions are hidden in the XML Schema documentation.
-
True - Local type definitions are hidden in the XML Schema documentation.
-
False - Local type definitions are not hidden in the XML Schema documentation. This is the default.
HideSubTypes
Whether or not subtypes are hidden in the XML Schema documentation.
-
True - Subtypes are hidden in the XML Schema documentation.
-
False - Subtypes are not hidden in the XML Schema documentation. This is the default.
HideTypes
Whether or not ypes are hidden in the XML Schema documentation.
-
True - Types are hidden in the XML Schema documentation.
-
False - Types are not hidden in the XML Schema documentation. This is the default.
ProxyHost
The name or network address of the proxy host server. The proxy host, if needed in your environment, is used to access the Internet in order to resolve imported or included stylesheets.
ProxyPort
The port on the proxy server to which Stylus Studio attaches.
Description
Displays a description of the currently selected option.
For More Information
Generating Documentation for XML Schema
Printing XML Schema Documentation
Cart
