Skip to content

Commit 1b5601f

Browse files
atomczakatomczak
committed
add URI documentation
#249
1 parent 6893df1 commit 1b5601f

File tree

4 files changed

+18
-6
lines changed

4 files changed

+18
-6
lines changed

‎Development/ids.xsd

+15-3
Original file line numberDiff line numberDiff line change
@@ -159,7 +159,11 @@
159159
<xs:complexType>
160160
<xs:complexContent>
161161
<xs:extension base="ids:classificationType">
162-
<xs:attribute name="uri" type="xs:anyURI" use="optional"/>
162+
<xs:attribute name="uri" type="xs:anyURI" use="optional">
163+
<xs:documentation>Uniform Resource Identifier of the classification. Content should comply with ISO 23386 and can include precise definition, translation, etc.</xs:documentation>
164+
<xs:annotation>
165+
</xs:annotation>
166+
</xs:attribute>
163167
<xs:attribute name="cardinality" type="ids:conditionalCardinality" use="optional" default="required"/>
164168
<xs:attribute name="instructions" type="xs:string" use="optional">
165169
<xs:annotation>
@@ -188,7 +192,11 @@
188192
<xs:complexType>
189193
<xs:complexContent>
190194
<xs:extension base="ids:propertyType">
191-
<xs:attribute name="uri" type="xs:anyURI" use="optional"/>
195+
<xs:attribute name="uri" type="xs:anyURI" use="optional">
196+
<xs:annotation>
197+
<xs:documentation>Uniform Resource Identifier of the property. Content should comply with ISO 23386 and can include precise definition, translation, etc.</xs:documentation>
198+
</xs:annotation>
199+
</xs:attribute>
192200
<xs:attribute name="cardinality" type="ids:conditionalCardinality" use="optional" default="required"/>
193201
<xs:attribute name="instructions" type="xs:string" use="optional">
194202
<xs:annotation>
@@ -203,7 +211,11 @@
203211
<xs:complexType>
204212
<xs:complexContent>
205213
<xs:extension base="ids:materialType">
206-
<xs:attribute name="uri" type="xs:anyURI" use="optional"/>
214+
<xs:attribute name="uri" type="xs:anyURI" use="optional">
215+
<xs:annotation>
216+
<xs:documentation>Uniform Resource Identifier of the material. Content should comply with ISO 23386 and can include precise definition, translation, etc.</xs:documentation>
217+
</xs:annotation>
218+
</xs:attribute>
207219
<xs:attribute name="cardinality" type="ids:conditionalCardinality" use="optional" default="required"/>
208220
<xs:attribute name="instructions" type="xs:string" use="optional">
209221
<xs:annotation>

‎Documentation/classification-facet.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ IFC models keep track of **Classification** names, dates, versions, and other da
1414
| ---------- | -------- | -------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
1515
| **System** | ✔️ | ✔️ | The name of the **Classification System** | The element must be classified with a reference that is part of a classification system with this name |
1616
| **Value** | ❌ | ✔️ | The value of a **Refeference** code in the **Classification System** | The element must be classified with a **Reference** which has a code that matches this value. The value is typically a short code with a separating character that denotes the level of classification |
17-
| **URI** | ❌ | ❌ | A URI identifying the classification compliant with ISO 23386 | You may find valid URIs using the [buildingSMART Data Dictionary](https://search.bsdd.buildingsmart.org/), for example for a [Uniclass-based aluminium window walls](https://identifier.buildingsmart.org/uri/nbs/uniclass2015-1/class/Pr_30_59_99_02 ) classification. |
17+
| **URI** | ❌ | ❌ | Uniform Resource Identifier of the class. Content should comply with ISO 23386 and can include precise definition, translation, etc. | You may find valid URIs using the [buildingSMART Data Dictionary](https://search.bsdd.buildingsmart.org/), for example for a [Beam](https://identifier.buildingsmart.org/uri/buildingsmart/ifc/4.3/class/IfcBeam). |
1818

1919
If no parameters are specified, then it means that any **Classification** should be present, regardless of **System** name or **Reference** code.
2020

‎Documentation/material-facet.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Many disciplines, such as costing, scheduling, sustainability analysis, or const
2121
| Parameter | Required | Restrictions Allowed | Allowed Values | Meaning |
2222
| --------- | -------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
2323
| **Value** | ❌ | ✔️ | Any material name or material category. The material name is typically specific to the project or local convention. The material category is recommended to be one of 'concrete', 'steel', 'aluminium', 'block', 'brick', 'stone', 'wood', 'glass', 'gypsum', 'plastic', or 'earth'. | The element must be made out of a **Material** with the specified name or category. If there are multiple **Materials**, then any **Material**, **Layer**, **Profile** or **Constituent** with that name or category will also satisfy the requirement. |
24-
| **URI** | ❌ | ❌ | A URI identifying the material compliant with ISO 23386 | You may find valid URIs using the [buildingSMART Data Dictionary](https://search.bsdd.buildingsmart.org/). Materials are found in the data dictionary as classifications with the keyword "/mat/" in the URI. |
24+
| **URI** | ❌ | ❌ | Uniform Resource Identifier of the material. Content should comply with ISO 23386 and can include precise definition, translation, etc. | You may find valid material URIs using the [buildingSMART Data Dictionary](https://search.bsdd.buildingsmart.org/), for example for a [Plywood](https://identifier.buildingsmart.org/uri/cei-bois.org/wood/1.0.0/class/8dca70a2-01a2-489b-9381-fbeff09db8dc).|
2525

2626
If no parameters are specified, then it means that any **Material** should be present, regardless of name or category.
2727

‎Documentation/property-facet.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ It is encouraged to follow buildingSMART standardised **Properties** wherever po
7777
| **Base Name** | ✔️ | ✔️ | Any text property name. Standardised buildingSMART property names can be found in the buildingSMART documentation. | The property must exist in the specified property set and have a non-empty value. |
7878
| **Data Type** | ❌ | ✔️ | A valid data type compatible with the referenced schema version, expressed in UPPERCASE. | The value must use the specified data type. The units specified in the IDS use the [IDS units table](units.md), though the project may use any unit, so project values will have to be converted to the SI unit before comparison. User Interfaces are permitted to display any unit that the developers or the users prefer. |
7979
| **Value** | ❌ | ✔️ | Any value appropriate to the data type of the property. If not specified, any non-empty value is allowed. The value of measures types will be stored according to the unit defined in the [IDS units table](units.md) | The value of the property must match, see [DataType documentation](DataTypes.md#xml-base-types) for more information. |
80-
| **URI** | ❌ | ❌ | A URI identifying the property compliant with ISO 23386 | You may find valid URIs using the [buildingSMART Data Dictionary](https://search.bsdd.buildingsmart.org/), for example for a [Fire Rating](https://search.bsdd.buildingsmart.org/Property/Index/115666) property. |
80+
| **URI** | ❌ | ❌ | Uniform Resource Identifier of the property. Content should comply with ISO 23386 and can include precise definition, translation, etc. | You may find valid URIs using the [buildingSMART Data Dictionary](https://search.bsdd.buildingsmart.org/), for example for a [Fire Rating](https://identifier.buildingsmart.org/uri/buildingsmart/ifc/4.3/prop/FireRating) property. |
8181

8282
## Examples
8383

0 commit comments

Comments
 (0)