From 975e754f0876e573ced6bdb00054035758cf44e7 Mon Sep 17 00:00:00 2001
From: Andreas Kraft <akr@mheg.org>
Date: Mon, 4 May 2015 14:40:02 +0200
Subject: [PATCH] Moved documentation to the 2.0 directory. Added Domain to
component documentation.
---
README.md | 14 ++++-----
FAQ.md => SDT/schema2.0/docs/FAQ.md | 0
Links.md => SDT/schema2.0/docs/Links.md | 0
.../schema2.0/docs/SDT Build System.md | 0
.../schema2.0/docs/SDT_Components.md | 27 ++++++++++++++++++
SDT_UML.uxf => SDT/schema2.0/docs/SDT_UML.uxf | 0
.../schema2.0/docs/images}/SDT2.0_UML.png | Bin
7 files changed, 34 insertions(+), 7 deletions(-)
rename FAQ.md => SDT/schema2.0/docs/FAQ.md (100%)
rename Links.md => SDT/schema2.0/docs/Links.md (100%)
rename SDT Build System.md => SDT/schema2.0/docs/SDT Build System.md (100%)
rename SDT_Components.md => SDT/schema2.0/docs/SDT_Components.md (55%)
rename SDT_UML.uxf => SDT/schema2.0/docs/SDT_UML.uxf (100%)
rename {images => SDT/schema2.0/docs/images}/SDT2.0_UML.png (100%)
diff --git a/README.md b/README.md
index 431d2dd..0030242 100644
--- a/README.md
+++ b/README.md
@@ -2,23 +2,23 @@
Repository for the Smart Home Device Template (SDT).
-Note that this project runs under Apache 2.0 license. Read the [LICENSE](LICENSE) in this repository, or refer to [http://www.apache.org/licenses/LICENSE-2.0.html](http://www.apache.org/licenses/LICENSE-2.0.html)
+Note that this project runs under Apache 2.0 license. Read the [LICENSE](LICENSE) in this repository, or refer to [http://www.apache.org/licenses/LICENSE-2.0](http://www.apache.org/licenses/LICENSE-2.0)
Any contributions made to this project must comply with the forementioned license.
## Quick Links
- ['domain.xsd' Version 2.0](SDT/schema2.0/src/domain.xsd)
-- [UML Diagram of the SDT 2.0](images/SDT2.0_UML.png)
+- [UML Diagram of the SDT 2.0](SDT/schema2.0/docs/images/SDT2.0_UML.png)
## Content
You can find further Information here:
-- [SDT Components](SDT_Components.md)
-- [SDT Build System](SDT%20Build%20System.md)
-- [FAQ](FAQ.md)
-- [Links & References](Links.md)
+- [SDT Components](SDT/schema2.0/docs/SDT_Components.md)
+- [SDT Build System](SDT/schema2.0/docs/SDT%20Build%20System.md)
+- [FAQ](SDT/schema2.0/docs/FAQ.md)
+- [Links & References](SDT/schema2.0/docs/Links.md)
- [LICENSE](LICENSE)
@@ -28,7 +28,7 @@ You can find further Information here:
- Added attributes to data points (readable, eventable)
- Added otional ``<SerialNumber>``, ``<VendorURL>`` and ``<FirmwareVersion>`` elements to DeviceInfo
- Added optional ``<Doc>`` element to Event
-- Added [UML diagram](SDT_Components.md)
+- Added [UML diagram](SDT/schema2.0/docs/SDT_Components.md)
diff --git a/FAQ.md b/SDT/schema2.0/docs/FAQ.md
similarity index 100%
rename from FAQ.md
rename to SDT/schema2.0/docs/FAQ.md
diff --git a/Links.md b/SDT/schema2.0/docs/Links.md
similarity index 100%
rename from Links.md
rename to SDT/schema2.0/docs/Links.md
diff --git a/SDT Build System.md b/SDT/schema2.0/docs/SDT Build System.md
similarity index 100%
rename from SDT Build System.md
rename to SDT/schema2.0/docs/SDT Build System.md
diff --git a/SDT_Components.md b/SDT/schema2.0/docs/SDT_Components.md
similarity index 55%
rename from SDT_Components.md
rename to SDT/schema2.0/docs/SDT_Components.md
index f4c7d81..7c99878 100644
--- a/SDT_Components.md
+++ b/SDT/schema2.0/docs/SDT_Components.md
@@ -1,4 +1,5 @@
# SDT Components
+
In this document an overview about the SDT 2.0 ødefinitions and component hierarchy is given.
## SDT Overview
@@ -11,9 +12,35 @@ The syntax used in the diagram to model an XML Schema Definition (XSD) as an UML
- [Design XML schemas using UML](http://www.ibm.com/developerworks/library/x-umlschem/)
- [UML For W3C XML Schema Design](http://www.xml.com/pub/a/2002/08/07/wxs_uml.html)
+
## Components
+-TBD
+
+---
### Domain
+The *Domain* is the top-level component that defines all modules and devices of a domain. A *Domain* can import definitions of other domains.
+
+
+
+#### Example
+
+ <Domain xmlns:xi="http://www.w3.org/2001/XInclude"
+ xmlns="http://hgi.org/xml/dal/2.0"
+ id="org.hgi">
+ <Imports>
+ <xi:include href="./dal-core.xml" parse="xml" />
+ </Imports>
+ <Modules>
+ <!-- Modules go here -->
+ </Modules>
+ <RootDevices>
+ <!-- RootDevices go here -->
+ </RootDevices>
+ </Domain>
+
+
+---
### RootDevice
#### DeviceInfo
diff --git a/SDT_UML.uxf b/SDT/schema2.0/docs/SDT_UML.uxf
similarity index 100%
rename from SDT_UML.uxf
rename to SDT/schema2.0/docs/SDT_UML.uxf
diff --git a/images/SDT2.0_UML.png b/SDT/schema2.0/docs/images/SDT2.0_UML.png
similarity index 100%
rename from images/SDT2.0_UML.png
rename to SDT/schema2.0/docs/images/SDT2.0_UML.png
--
GitLab