diff --git a/SDT/schema2.0/docs/SDT Build System.md b/SDT/schema2.0/docs/SDT Build System.md index 817ec3e7b03f9adfaecb1848d2deee9dc6ea1da8..22e57b5ca6d7e8ad5a2721e06130aa359af7e3e8 100644 --- a/SDT/schema2.0/docs/SDT Build System.md +++ b/SDT/schema2.0/docs/SDT Build System.md @@ -4,15 +4,15 @@ This document describes the SDT build system and how to build the SDT and valida The files referenced in this document point to version **2.0** of the SDT. ## Directory Structure and Important Files -- [SDT/schema2.0/](SDT/schema2.0/) : Base directory -- [SDT/schema2.0/src/](SDT/schema2.0/src/) : Source files of the SDT. - - [domain.rng](SDT/schema2.0/src/domain.rng) : RELAX NG file with the SDT schema definition. This is the source file that is converted to the actual schema definition *domain.xsd* during the build. See also [http://en.wikipedia.org/wiki/RELAX_NG](http://en.wikipedia.org/wiki/RELAX_NG). +- [SDT/schema2.0/](..) : Base directory +- [SDT/schema2.0/src/](src/) : Source files of the SDT. + - [domain.rng](src/domain.rng) : RELAX NG file with the SDT schema definition. This is the source file that is converted to the actual schema definition *domain.xsd* during the build. See also [http://en.wikipedia.org/wiki/RELAX_NG](http://en.wikipedia.org/wiki/RELAX_NG). **Only edit this file when one wants to make changes to the SDT!** - - [domain.xsd](SDT/schema2.0/src/domain.xsd) : The SDT schema defintion that is generated from *domain.rng*. - - [xml.xsd](SDT/schema2.0/src/xml.xsd) : General schema definitions for the SDT -- [SDT/schema2.0/test/](SDT/schema2.0/test/) : This directory contains all XML files with SDT definitions that should be validated whether they conform to the SDT schema. This could be example definitions or contributions. -- [SDT/schema2.0/build.xml](SDT/schema2.0/build.xml) : This is the definition file for the ant build system. -- [SDT/schema2.0/etc/](SDT/schema2.02.0/etc/), [SDT/schema2.0/lib/](SDT/schema2.0/lib/), [SDT/schema2.0/style/](SDT/schema2.0/style/) : internal directories for the build system. Please, don't make unnecessary changes to these files. + - [domain.xsd](src/domain.xsd) : The SDT schema defintion that is generated from *domain.rng*. + - [xml.xsd](src/xml.xsd) : General schema definitions for the SDT +- [SDT/schema2.0/test/](test/) : This directory contains all XML files with SDT definitions that should be validated whether they conform to the SDT schema. This could be example definitions or contributions. +- [SDT/schema2.0/build.xml](build.xml) : This is the definition file for the ant build system. +- [SDT/schema2.0/etc/](etc/), [SDT/schema2.0/lib/](lib/), [SDT/schema2.0/style/](style/) : internal directories for the build system. Please, don't make unnecessary changes to these files. ## Installation - Install Java on your computer @@ -25,7 +25,7 @@ The files referenced in this document point to version **2.0** of the SDT. After cloning the repository go to the directoy *SDT/schema* and run commands depending on what you want to achieve. ### Build the Schema -Running *ant* without any parameter builds the schema definition from the rng-definition [SDT/schema/src/domain.rng](SDT/schema2.0/src/domain.rng) and writes it to [SDT/schema/src/domain.xsd](SDT/schema/src/domain.xsd) +Running *ant* without any parameter builds the schema definition from the rng-definition [SDT/schema2.0/src/domain.rng](src/domain.rng) and writes it to [SDT/schema2.0/src/domain.xsd](src/domain.xsd) $ cd SDT/schema $ ant @@ -50,17 +50,17 @@ Otherwise you most likely receive a stacktrace or some other error messages. Sea --- ## Editing -As mentioned above, the actual schema definition is defined in the file [domain.rng](SDT/schema2.0/src/domain.rng) and converted to the XML schema definition [domain.xsd](SDT/schema2.0/src/domain.xsd) during the build process. +As mentioned above, the actual schema definition is defined in the file [domain.rng](src/domain.rng) and converted to the XML schema definition [domain.xsd](src/domain.xsd) during the build process. -**All changes to the schema must therefore be made in [domain.rng](SDT/schema2.0/src/domain.rng), NOT [domain.xsd](SDT/schema2.0/src/domain.xsd) !** +**All changes to the schema must therefore be made in [domain.rng](src/domain.rng), NOT [domain.xsd](src/domain.xsd) !** You may need to make additional changes in the following files, e.g. when the name space or the version number need to be adjusted. PLEASE ONLY EDIT THESE FILES IF NECESSARY. -- [SDT/schema2.0/build.xml](SDT/schema2.0/build.xml) +- [SDT/schema2.0/build.xml](build.xml) e.g. in the *ant* target "validate" -- [SDT/schema2.0/etc/dal.rnc](SDT/schema2.0/etc/dal.rnc) +- [SDT/schema2.0/etc/dal.rnc](etc/dal.rnc) e.g. the entry "default namespace xsl" -- [SDT/schema2.0/etc/schema.xmlns](SDT/schema2.0/etc/schema.xmlns) -- [SDT/schema2.0/etc/schemas.xml](SDT/schema2.0/etc/schemas.xml) +- [SDT/schema2.0/etc/schema.xmlns](etc/schema.xmlns) +- [SDT/schema2.0/etc/schemas.xml](etc/schemas.xml)