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:
Character | Entity |
< |
< |
> |
> |
& |
& |
Note: The encoding will be done only when the output format supports rendering of embedded HTML, and it is switched on (see output format options).
The purpose of this parameter is the following:
1. Suppose you use XHTML elements to format your annotations and some annotation contains a text like this:
A < B
'<'
character as it is.
Since the whole annotation will be converted into HTML, that character needs to be encoded.
In that case, this parameter should be selected.
2. However, some XML schema authors do not rely on XHTML to format annotation (probably because few tools process it). Instead, they insert HTML markup directly into the annotation text, like the following:
<xs:annotation>
<xs:documentation>
This is <b>keyword</b>
</xs:documentation>
</xs:annotation>
This is <b>keyword</b>
Therefore, if you have an XML schema like this, you should unselect this parameter.