From 1b5601fabe4c1e82758617b3f0e722553cfac8e1 Mon Sep 17 00:00:00 2001 From: ArturTomczak Date: Fri, 24 May 2024 09:44:13 +0200 Subject: [PATCH 1/5] add URI documentation #249 --- Development/ids.xsd | 18 +++++++++++++++--- Documentation/classification-facet.md | 2 +- Documentation/material-facet.md | 2 +- Documentation/property-facet.md | 2 +- 4 files changed, 18 insertions(+), 6 deletions(-) diff --git a/Development/ids.xsd b/Development/ids.xsd index 0cb623e..c6d7fec 100644 --- a/Development/ids.xsd +++ b/Development/ids.xsd @@ -159,7 +159,11 @@ - + + Uniform Resource Identifier of the classification. Content should comply with ISO 23386 and can include precise definition, translation, etc. + + + @@ -188,7 +192,11 @@ - + + + Uniform Resource Identifier of the property. Content should comply with ISO 23386 and can include precise definition, translation, etc. + + @@ -203,7 +211,11 @@ - + + + Uniform Resource Identifier of the material. Content should comply with ISO 23386 and can include precise definition, translation, etc. + + diff --git a/Documentation/classification-facet.md b/Documentation/classification-facet.md index daab7e5..a46b7dd 100644 --- a/Documentation/classification-facet.md +++ b/Documentation/classification-facet.md @@ -14,7 +14,7 @@ IFC models keep track of **Classification** names, dates, versions, and other da | ---------- | -------- | -------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **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 | | **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 | -| **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. | +| **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). | If no parameters are specified, then it means that any **Classification** should be present, regardless of **System** name or **Reference** code. diff --git a/Documentation/material-facet.md b/Documentation/material-facet.md index eeebbc6..9bdf31f 100644 --- a/Documentation/material-facet.md +++ b/Documentation/material-facet.md @@ -21,7 +21,7 @@ Many disciplines, such as costing, scheduling, sustainability analysis, or const | Parameter | Required | Restrictions Allowed | Allowed Values | Meaning | | --------- | -------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **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. | -| **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. | +| **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).| If no parameters are specified, then it means that any **Material** should be present, regardless of name or category. diff --git a/Documentation/property-facet.md b/Documentation/property-facet.md index 3fbd49a..c9d5ce6 100644 --- a/Documentation/property-facet.md +++ b/Documentation/property-facet.md @@ -77,7 +77,7 @@ It is encouraged to follow buildingSMART standardised **Properties** wherever po | **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. | | **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. | | **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. | -| **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. | +| **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. | ## Examples From 83b84ddfd575900da03043d21c16f4d2cd712d98 Mon Sep 17 00:00:00 2001 From: ArturTomczak Date: Fri, 24 May 2024 09:50:11 +0200 Subject: [PATCH 2/5] fix node position --- Development/ids.xsd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Development/ids.xsd b/Development/ids.xsd index c6d7fec..dd235d1 100644 --- a/Development/ids.xsd +++ b/Development/ids.xsd @@ -160,8 +160,8 @@ - Uniform Resource Identifier of the classification. Content should comply with ISO 23386 and can include precise definition, translation, etc. + Uniform Resource Identifier of the classification. Content should comply with ISO 23386 and can include precise definition, translation, etc. From d20cf67d76bc4c3b063ba0481c29e804f6f38518 Mon Sep 17 00:00:00 2001 From: ArturTomczak Date: Fri, 24 May 2024 11:07:04 +0200 Subject: [PATCH 3/5] Revert "fix node position" This reverts commit 83b84ddfd575900da03043d21c16f4d2cd712d98. --- Development/ids.xsd | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Development/ids.xsd b/Development/ids.xsd index dd235d1..c6d7fec 100644 --- a/Development/ids.xsd +++ b/Development/ids.xsd @@ -160,8 +160,8 @@ - Uniform Resource Identifier of the classification. Content should comply with ISO 23386 and can include precise definition, translation, etc. + From 92e95838ad5839b63f2f1726a6f02dbe12992b60 Mon Sep 17 00:00:00 2001 From: ArturTomczak Date: Fri, 24 May 2024 11:07:37 +0200 Subject: [PATCH 4/5] Revert "add URI documentation" This reverts commit 1b5601fabe4c1e82758617b3f0e722553cfac8e1. --- Development/ids.xsd | 18 +++--------------- Documentation/classification-facet.md | 2 +- Documentation/material-facet.md | 2 +- Documentation/property-facet.md | 2 +- 4 files changed, 6 insertions(+), 18 deletions(-) diff --git a/Development/ids.xsd b/Development/ids.xsd index c6d7fec..0cb623e 100644 --- a/Development/ids.xsd +++ b/Development/ids.xsd @@ -159,11 +159,7 @@ - - Uniform Resource Identifier of the classification. Content should comply with ISO 23386 and can include precise definition, translation, etc. - - - + @@ -192,11 +188,7 @@ - - - Uniform Resource Identifier of the property. Content should comply with ISO 23386 and can include precise definition, translation, etc. - - + @@ -211,11 +203,7 @@ - - - Uniform Resource Identifier of the material. Content should comply with ISO 23386 and can include precise definition, translation, etc. - - + diff --git a/Documentation/classification-facet.md b/Documentation/classification-facet.md index a46b7dd..daab7e5 100644 --- a/Documentation/classification-facet.md +++ b/Documentation/classification-facet.md @@ -14,7 +14,7 @@ IFC models keep track of **Classification** names, dates, versions, and other da | ---------- | -------- | -------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **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 | | **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 | -| **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). | +| **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. | If no parameters are specified, then it means that any **Classification** should be present, regardless of **System** name or **Reference** code. diff --git a/Documentation/material-facet.md b/Documentation/material-facet.md index 9bdf31f..eeebbc6 100644 --- a/Documentation/material-facet.md +++ b/Documentation/material-facet.md @@ -21,7 +21,7 @@ Many disciplines, such as costing, scheduling, sustainability analysis, or const | Parameter | Required | Restrictions Allowed | Allowed Values | Meaning | | --------- | -------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **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. | -| **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).| +| **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. | If no parameters are specified, then it means that any **Material** should be present, regardless of name or category. diff --git a/Documentation/property-facet.md b/Documentation/property-facet.md index c9d5ce6..3fbd49a 100644 --- a/Documentation/property-facet.md +++ b/Documentation/property-facet.md @@ -77,7 +77,7 @@ It is encouraged to follow buildingSMART standardised **Properties** wherever po | **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. | | **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. | | **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. | -| **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. | +| **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. | ## Examples From 4c87893f8a0809a3b8539215d75e7b793549095e Mon Sep 17 00:00:00 2001 From: ArturTomczak Date: Fri, 24 May 2024 11:23:31 +0200 Subject: [PATCH 5/5] improve URI documentation --- Documentation/classification-facet.md | 2 +- Documentation/material-facet.md | 3 ++- Documentation/property-facet.md | 2 +- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/Documentation/classification-facet.md b/Documentation/classification-facet.md index daab7e5..a263642 100644 --- a/Documentation/classification-facet.md +++ b/Documentation/classification-facet.md @@ -14,7 +14,7 @@ IFC models keep track of **Classification** names, dates, versions, and other da | ---------- | -------- | -------------------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **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 | | **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 | -| **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. | +| **URI** | ❌ | ❌ | Uniform Resource Identifier of the class. The resource should include a name and a definition, and preferably comply with ISO 23386. | One source of valid URIs is [the bSDD](https://search.bsdd.buildingsmart.org/). An example URI for a "beam": [https://identifier.buildingsmart.org/uri/buildingsmart/ifc/4.3/class/IfcBeam](https://identifier.buildingsmart.org/uri/buildingsmart/ifc/4.3/class/IfcBeam). | If no parameters are specified, then it means that any **Classification** should be present, regardless of **System** name or **Reference** code. diff --git a/Documentation/material-facet.md b/Documentation/material-facet.md index eeebbc6..15ff40f 100644 --- a/Documentation/material-facet.md +++ b/Documentation/material-facet.md @@ -21,7 +21,8 @@ Many disciplines, such as costing, scheduling, sustainability analysis, or const | Parameter | Required | Restrictions Allowed | Allowed Values | Meaning | | --------- | -------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **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. | -| **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. | +| **URI** | ❌ | ❌ | Uniform Resource Identifier of the material. The resource should include a name and a definition, and preferably comply with ISO 23386. | One source of valid URIs is [the bSDD](https://search.bsdd.buildingsmart.org/). An example URI for a "Plywood": [https://identifier.buildingsmart.org/uri/cei-bois.org/wood/1.0.0/class/8dca70a2-01a2-489b-9381-fbeff09db8dc](https://identifier.buildingsmart.org/uri/cei-bois.org/wood/1.0.0/class/8dca70a2-01a2-489b-9381-fbeff09db8dc). | + If no parameters are specified, then it means that any **Material** should be present, regardless of name or category. diff --git a/Documentation/property-facet.md b/Documentation/property-facet.md index 3fbd49a..6814117 100644 --- a/Documentation/property-facet.md +++ b/Documentation/property-facet.md @@ -77,7 +77,7 @@ It is encouraged to follow buildingSMART standardised **Properties** wherever po | **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. | | **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. | | **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. | -| **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. | +| **URI** | ❌ | ❌ | Uniform Resource Identifier of the property. The resource should include a name and a definition, and preferably comply with ISO 23386. | One source of valid URIs is [the bSDD](https://search.bsdd.buildingsmart.org/). An example URI for a "Fire Rating": [https://identifier.buildingsmart.org/uri/buildingsmart/ifc/4.3/prop/FireRating](https://identifier.buildingsmart.org/uri/buildingsmart/ifc/4.3/prop/FireRating). | ## Examples