FlexDoc/XML - XSDDoc - FAQ
- Running XSDDoc
- Generator Settings
- Working with annotations
- Formatting annotations with XHTML
- Where to learn more about XML schemas?
<xs:annotation>element that allows you to add descriptions/comments into any XML Schema.
<xs:annotation> is a container of two other elements:
<xs:appinfo>, which is supposed for some custom instructions that may be used by a software processing the schema.
<xs:documentation>, which is where you should insert your description text.
element you can place any text containing any number of lines.
Note also that some XML markup character must be encoded with the corresponding entities:
Along with the text, you can insert also other XML elements from various namespaces. Particularly important are XHTML elements, which allow you to enrich your annotations with very sophisticated formatting and images that will appear in the generated documentation. For more details, please see: Formatting annotations with XHTML.
<xs:annotation>element you can look also by these links:
<xs:annotation>elements can be inserted in almost any other XML Schema elements, XSDDoc currently processes only those specified at the following locations:
|In definition of the entire XML schema||
|In definitions of global components||
That will produce the «Annotation» section of the «Component Documentation».
|In definitions of anonymous Simple/Complex Types of elements/attributes||
|In definitions of local elements or global element references||
|In definitions of local attributes or global attribute references||
|In facet definitions||
This annotation will appear in the corresponding «Facet Documentation».
<xs:documentation>element may contain any number of lines. You may create the new lines simply for convenience during writing that text. However, you may also use the new lines as a way to format your comments. In that case, you will likely want to have your text broken into the same lines in the «Annotation» sections of the generated documentation. Click on the following screenshot to see how it may look:
That means that the generator must interpret the line breaks found in the raw XML
with the markup coding appropriate to the given output format (e.g. with
<br> in HTML or
\line in RTF).