<?xml version="1.0" encoding="UTF-8"?>

<!--

Free Telco Dictionary

Copyright © 2013 František Kučera (frantovo.cz)

This program is free software: you can redistribute it and/or modify

it under the terms of the GNU General Public License as published by

the Free Software Foundation, version 3 of the License.

This program is distributed in the hope that it will be useful,

but WITHOUT ANY WARRANTY; without even the implied warranty of

MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

GNU General Public License for more details.

You should have received a copy of the GNU General Public License

along with this program.  If not, see <http://www.gnu.org/licenses/>.

-->

<xs:schema xmlns="https://telco.frantovo.cz/xmlns/dictionary"

           targetNamespace="https://telco.frantovo.cz/xmlns/dictionary"

           xmlns:xs="http://www.w3.org/2001/XMLSchema"

           elementFormDefault="qualified"

           attributeFormDefault="unqualified">

	<xs:element name="dictionary" type="dictionaryType"/>

	<xs:complexType name="dictionaryType">

		<xs:sequence>

			<xs:element name="id" type="ID"  minOccurs="0" maxOccurs="1"/>

			<xs:element name="tags" type="tagsDefinitionType"  minOccurs="0" maxOccurs="1"/>

			<xs:element name="concept" type="conceptType"  minOccurs="0" maxOccurs="unbounded">

				<xs:annotation>

					<xs:documentation>

						Concept is an item of a dictionary – a term.

						If an abbreviation or a word have two different meanings

						it is two different concepts i.e. different meaning should not be mixed in a single concept.

						Example: CLI (command-line interface) and CLI (call level interface) are two different concepts.

					</xs:documentation>

				</xs:annotation>

			</xs:element>

		</xs:sequence>

	</xs:complexType>

	<xs:complexType name="tagsDefinitionType">

		<xs:sequence>

			<xs:element name="tag" type="tagDefinitionType" minOccurs="0" maxOccurs="unbounded"/>

		</xs:sequence>

	</xs:complexType>

	<xs:complexType name="tagDefinitionType">

		<xs:attribute name="id" type="xs:string">

			<xs:annotation>

				<xs:documentation>

					Tag IDs are not globally unique

					(they are short and simple, so they can be easily added to concepts while editing the document by hand)

					so when the disctionary is merged into another XML document, theese IDs should be prefixed e.g. with the dictionary ID.

				</xs:documentation>

			</xs:annotation>

		</xs:attribute>

		<xs:attribute name="name" type="xs:string"/>

		<xs:attribute name="description" type="xs:string"/>

	</xs:complexType>

	<xs:complexType name="conceptType">

		<xs:sequence>

			<xs:element name="id" type="ID"  minOccurs="0" maxOccurs="1">

				<xs:annotation>

					<xs:documentation>

						This should be globally unique ID of the concept.

						Concepts shared among multiple dictionaries should have same ID.

					</xs:documentation>

				</xs:annotation>

			</xs:element>

			<xs:element name="term" type="termType" minOccurs="1" maxOccurs="unbounded"/>

			<xs:element name="explanation" type="explanationType"/>

			<xs:element name="tag" type="tagRefType"  minOccurs="0" maxOccurs="unbounded"/>

		</xs:sequence>

	</xs:complexType>

	<xs:complexType name="termType">

		<xs:sequence>

			<xs:element name="tag" type="tagRefType"  minOccurs="0" maxOccurs="unbounded"/>

		</xs:sequence>

		<xs:attribute name="abbreviation" type="xs:string"/>

		<xs:attribute name="completeForm" type="xs:string"/>

		<xs:attribute name="language" type="languageType"/>

	</xs:complexType>

	<xs:complexType name="explanationType">

		<xs:all>

			<xs:element name="text" type="textType"/>

		</xs:all>

		<xs:attribute name="language" type="languageType"/>

	</xs:complexType>

	<xs:simpleType name="languageType">

		<xs:restriction base="xs:string"/>

	</xs:simpleType>

	<xs:simpleType name="textType">

		<xs:restriction base="xs:string"/>

	</xs:simpleType>

	<xs:simpleType name="tagRefType">

		<xs:restriction base="xs:string"/>

	</xs:simpleType>

	<xs:simpleType name="ID">

		<xs:annotation>

			<xs:documentation>

				UUID, but must start with a letter, to comply with XML ID rules;

				use e.g. uuidgen | grep ^[a-f];

				Never reuse the ID if one chapter/item is removed and another with different meaning is added.

			</xs:documentation>

		</xs:annotation>

		<xs:restriction base="xs:ID">

			<xs:pattern value="[a-f][a-f0-9]{7}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}"/>

		</xs:restriction>

	</xs:simpleType>

</xs:schema>