xml - Where to put copyright information in an XSD? -
when placing copyright information in xml schema definition (xsd), there official (or semi-official, universally accepted) location doing so?
based on where add version xsd schema?, there's official version
attribute in xs:schema
element - there similar copyright information?
i have seen people using annotation/documentation elements (e.g. here) - accepted way of doing this?
<xsd:annotation> <xsd:documentation xml:lang="en"> copyright 2015 example.com. rights reserved. </xsd:documentation> </xsd:annotation>
xsd has no specific, direct support copyright information. 3 methods used in practice:
xml-level comments:
<!-- copyright 2015 example.com. rights reserved. -->
this ok may run afoul of policies preferring see documentation in proper xsd annotations. also, sure not add such line above xml declaration (
<?xml version="1.0" encoding="utf-8" ?>
) present in xsd keep xsd well-formed.xsd-level documentation (as mention):
<xsd:annotation> <xsd:documentation xml:lang="en"> copyright 2015 example.com. rights reserved. </xsd:documentation> </xsd:annotation>
this improves upon xml-level comments still lacking in area of semantic markup: fine human readers non-ideal automated/application processing.
xsd-level appinfo markup:
<xsd:annotation> <xsd:appinfo> <copyright-notice> copyright 2015 example.com. rights reserved. <copyright-notice> <license uri="http://www.apache.org/licenses/license-2.0" version="2.0">apache license, version 2.0</license> <author>j smith</author> <!-- ... --> </xsd:appinfo> </xsd:annotation>
this improves further upon generic xsd-level documentation.
these work follow first lead of established policies or conventions @ organization before embarking on new approach sort of metadata.
Comments
Post a Comment