Ieteikuma numurs
SK-09
Obligātums
Obligāta
Paskaidrojums
Elementa annotation apakšelements documentation eksistē, lai palīdzētu dokumentēt shēmas. Priekšrocība, izmantojot šo elementu, nevis iekļaujot tekstu komentāros, ir tā, ka elements, būdams daļa no XML dokumenta satura, atvieglo iespēju apstrādāt tekstu ar stila lapu (stylesheet), piemēram, lai sagatavotu lietotāja dokumentāciju. Komentāru informāciju nevajag pārnest no XML procesora uz lietojumu, tādu kā, XSLT procesors, jo tā var tikt pazaudēta.
Informācija par shēmas elementiem latviešu valodā tiek iekļauta documentation elementā ar xml:lang=”lv” atribūtu.
Shēmas elementu dokumentāciju, jāieliek uzreiz pēc elementa deklarācijas. Ja elementa dokumentācija satur vienu teikumu, tad „.” galā nevajag, ja vairākus, tad vajag.
Piemēri
Jāizmanto documentation tags dokumentācijas elementā:
<xs:simpleType name="PersonCodeType">
<xs:annotation>
<xs:documentation xml:lang="lv">Tips personas kods</xs:documentation>
</xs:annotation>
<xs:restriction base="xs:string">
<xs:pattern value="[0-9]{11}" />
</xs:restriction>
</xs:simpleType>