Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

README.md - fix broken link to developer-guide #348

Merged
merged 4 commits into from
Oct 28, 2024
Merged

README.md - fix broken link to developer-guide #348

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
37e8ee5
README.md - fix broken link to developer-guide
I-Sokolov Sep 26, 2024
860e64a
developer-guide.md - fix broken link
I-Sokolov Sep 26, 2024
8838670
specifications.md - according ids.xsd simple and conditional cardinal…
I-Sokolov Sep 26, 2024
56c0b9d
Update developer-guide.md paths
atomczak Sep 26, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions Documentation/ImplementersDocumentation/developer-guide.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -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:

Expand Down
2 changes: 1 addition & 1 deletion Documentation/UserManual/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
6 changes: 3 additions & 3 deletions Documentation/UserManual/specifications.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand Down
Loading