diff --git a/Documentation/ImplementersDocumentation/developer-guide.md b/Documentation/ImplementersDocumentation/developer-guide.md index 09dc027..1ca2bef 100644 --- a/Documentation/ImplementersDocumentation/developer-guide.md +++ b/Documentation/ImplementersDocumentation/developer-guide.md @@ -5,7 +5,7 @@ An IDS file is simply an XML file, with its schema defined in XSD. You may open An IDS is considered valid if it passes the XSD-based validation check. All sample IDS files available in the buildingSMART directory of public IDS templates are guaranteed to be valid. 1. [Download the latest IDS XSD schema](https://github.com/buildingSMART/IDS/blob/master/Development/ids.xsd) -2. Download sample IDS files from the `Documentation/testcases` folder +2. Download sample IDS files from the `Documentation/ImplementersDocumentation/TestCases` folder There are many freely available online tools and programming libraries that can perform XSD validation. However, a valid IDS file requires more than bare XML schema compliance; buildingSMART provides an [IDS auditing tool](https://github.com/buildingSMART/IDS-Audit-tool/) to help ensure that the IDS files that you produce or receive are fully valid. The same tool is also available at [Xbim IDS auditing service](https://www.xbim.it/ids), which is executed locally in your web browser and does not upload your IDS files to any server. @@ -34,7 +34,7 @@ In addition, it is highly recommended to also provide the following features for ## Checking IDS against IFC -Any software implementing IDS checking **must** comply with the test suite of IFC/IDS pairs available in the `Documentation/testcases` folder (see [test cases documentation](testscases/scripts.md)). +Any software implementing IDS checking **must** comply with the test suite of IFC/IDS pairs available in the `Documentation/ImplementersDocumentation/TestCases` folder (see [test cases documentation](TestCases/scripts.md)). In addition, it is highly recommended to also provide the following features for users: diff --git a/Documentation/UserManual/README.md b/Documentation/UserManual/README.md index ad244f5..14f6db8 100644 --- a/Documentation/UserManual/README.md +++ b/Documentation/UserManual/README.md @@ -35,4 +35,4 @@ If you need help, please feel free to ask for help on the [buildingSMART Forums] 1. [Learn how to use the **Property Facet**](property-facet.md) 1. [Learn how to use the **Material Facet**](material-facet.md) 1. [Learn how to use the **PartOf Facet**](partof-facet.md) - 1. [Are you a software developer? Read the developer guide!](developer-guide.md) + 1. [Are you a software developer? Read the developer guide!](../ImplementersDocumentation/developer-guide.md) diff --git a/Documentation/UserManual/specifications.md b/Documentation/UserManual/specifications.md index 9c39f8b..59a5f50 100644 --- a/Documentation/UserManual/specifications.md +++ b/Documentation/UserManual/specifications.md @@ -97,9 +97,9 @@ the following interpretation applies: | Type | Meaning | Success criteria | | -------------- | ------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------- | -| **Required** | A matching property is required in the model | Matching entities have a ePset_SpaceOMA/TravelDirection property of type IFCLABEL and non null value | -| **Prohibited** | A matching property cannot be present in the model | Matching entities don't have a property TravelDirection in the ePset_SpaceOMA property set | -| **Optional** | Expectations of a propertySet/property and value constrains are defined, but optional | Matching entities either don't have the property, or if they do, it is of the expected datatype and value | +| **required** | A matching property is required in the model | Matching entities have a ePset_SpaceOMA/TravelDirection property of type IFCLABEL and non null value | +| **prohibited** | A matching property cannot be present in the model | Matching entities don't have a property TravelDirection in the ePset_SpaceOMA property set | +| **optional** | Expectations of a propertySet/property and value constrains are defined, but optional | Matching entities either don't have the property, or if they do, it is of the expected datatype and value | As a complete example, you might have a **Required** specification that applies to wall entities, that are **Prohibited** from being load-bearing, if you wanted your model to not contain any load-bearing walls. diff --git a/Schema/ids.xsd b/Schema/ids.xsd index edab179..047c348 100644 --- a/Schema/ids.xsd +++ b/Schema/ids.xsd @@ -80,7 +80,7 @@ Depending on the dataType attribute, values are expressed in the default unit documented at - https://github.com/buildingSMART/IDS/blob/master/Documentation/units.md, and unit conversion might be required. + https://github.com/buildingSMART/IDS/blob/master/Documentation/UserManual/units.md, and unit conversion might be required. @@ -98,7 +98,7 @@ Depending on the IFC type of the attribute, values are expressed in the default unit documented at - https://github.com/buildingSMART/IDS/blob/master/Documentation/units.md, and unit conversion might be required. + https://github.com/buildingSMART/IDS/blob/master/Documentation/UserManual/units.md, and unit conversion might be required.