FlexDoc/XML - XSDDoc - Parameter Tree
About XSDDoc parameters
«Processing | Annotations» parameter group
This parameter group controls processing and formatting of annotations (the content of<xs:annotation>
elements specified in XML schemas).
The annotation text, which appears in a particular «Annotation» section of the generate documentation,
is produced from all <xs:documentation>
elements found by the path:
-
xs:annotated/xs:annotation/xs:documentation
'xs:annotated'
is an XSD element that defines either the XML schema
itself (xs:schema
) or a schema component (e.g. xs:complexType
) being documented.
Multiple <xs:documentation>
elements will produce different sections of the annotation text.
Parameter | Name / Type / Description | ||||||||
---|---|---|---|---|---|---|---|---|---|
<appinfo> |
proc.annotation.appinfo : boolean
Specify whether to process
If Nested Parameters:
|
||||||||
<documentation> |
proc.annotation.documentation : boolean
Specify whether to process
The Nested Parameters:
|
||||||||
proc.annotation.documentation.lang :
list of strings {separators: ';', newline}
When you annotate your XML schema simultaneously in different languages, this parameter will allow you to generate the documentation localized for only one of them (that is, only the annotations written in the selected language will be included in the documentation). Parameter Value:
The 2- or 3-letter code identifying the language.
This must be the same code which you have specified in the You may also specify multiple language codes separated with semicolons (';'). For example:
'xml:lang' attribute assigned with one of the specified language codes.
When this parameter is not specified (empty string), all sibling <xs:documentation> elements are processed, which will produce a single (however, multi-sectional) annotation text. Example:
"de" in this parameter, you will get in the documentation only this text:
"Die deutsche Beschreibung..."
Nested Parameter:
|
|||||||||
proc.annotation.documentation.lang.alt :
list of strings {separators: ';', newline}
When the “Language” parameter is specified, only the <xs:documentation> elements marked with the specified language code(s) will be process. All others will be ignored. However, you may have a situation that not all annotations in your XML schema are translated into a specific language. When you generate the documentation targeted to that language, it is preferable to have all descriptions written in it. However, when such a localized description is missing, a description written in some basic language (e.g. English) would also suffice. Using this parameter you may specify such an alternative language. The value of this parameter must be specified the same way as of “Language” parameter.
For example, let's suppose that in the “Language”
parameter you have specified |
|||||||||
proc.annotation.documentation.source : enum {"as_see_link", "as_title", "no"}
Specifies how to process the value of Possible Choices:
|
|||||||||
Tags |
The parameter group to control processing of any non-XSD element tags embedded in annotation text
(i.e. within the content of <xs:documentation> elements).
|
||||||||
proc.annotation.tags.xhtml : boolean
Specify whether to process XHTML tags embedded in the annotation text. XHTML tags are considered any XML elements that belong to XHTML namespace, which is associated with the following URI:
'xsddoc.xmltype' configuration file, where you can change it when you need.)
When this parameter is
When this parameter is Important:
|
|||||||||
Specify for which schemas the XHTML markup in annotations should be processed. | |||||||||
proc.annotation.tags.xhtml.schemas.include :
list of strings {separators: ';', newline}
Specify the list of XML schemas whose annotations may contain XHTML markup. Each XML schema is specified with its file name (the last name in the pathname's name sequence, e.g. "xml.xsd"). Multiple file names should be separated with the allowed item separator (e.g. newline). When this parameter is assigned (with a non-empty string specifying the schema list), the XHTML tags will be processed in annotations of only those schemas whose file names are found in that list. |
|||||||||
proc.annotation.tags.xhtml.schemas.exclude :
list of strings {separators: ';', newline}
Specify the list of XML schemas whose annotations contain no XHTML markup (or it should ignored). Each XML schema is specified with its file name (the last name in the pathname's name sequence, e.g. "xml.xsd"). Multiple file names should be separated with an allowed item separator (e.g. newline). When this parameter is assigned (with a non-empty string specifying the schema list), the XHTML tags will be processed in annotations of only those schemas whose file names are not found in that list. |
|||||||||
proc.annotation.tags.xhtml.images : boolean
Controls whether to include images specified with the XHTML
If this parameter is
When the parameter is Nested Parameter:
|
|||||||||
proc.annotation.tags.xhtml.images.copy : boolean
Specifies whether the images embedded in the annotation text must be copied to the documentation destination directory.
If this parameter is
When the parameter is |
|||||||||
proc.annotation.tags.other : enum {"show", "xhtml", "no"}
Controls what to do with any other XML tags that have not been specifically processed as XHTML markup. Possible Choices:
|
|||||||||
Encode markup characters |
proc.annotation.encode.markup.chars : boolean
Specifies whether to encode HTML markup characters contained in the annotation text. The following table shows all such characters and the entities into which they are encoded:
The purpose of this parameter is the following:
|
||||||||
Show part headings |
proc.annotation.show.part.headings : boolean
Specify, whether to generate multipart annotation headings.
A human-written description of an XML schema or schema component is generated from the content of an
<xs:annotation> elements are allowed to have multiple <xs:documentation>
children (and <xs:schema> element may have even multiple <xs:annotation> children).
In that case, the result description text will be produced from the content of all <xs:documentation>
element found by the path:
<xs:documentation> elements, each of them will produce a separate part of the entire description text. In that case, each part will have a separate heading, so the whole text will look like the following:
|