From f6820ddf70af7ed161cf02c4f5c146c1940a1d42 Mon Sep 17 00:00:00 2001 From: madsik Date: Mon, 16 Nov 2026 10:35:14 +0200 Subject: [PATCH] Docs: write booleans in lowercase in the user manual restrictions.md and specifications.md wrote boolean values as "TRUE" and "FALSE". IDS reads booleans as xs:boolean, whose values are lowercase (DataTypes.md), and the test cases say so: attribute/invalid-booleans_must_be_specified_as_lowercase_strings_2_3 and property/invalid-booleans_must_be_specified_as_lowercase_strings_3_3 are invalid because they use "FALSE". A reader who follows the manual writes an invalid IDS. This changes the four places to "true" and "false". Co-Authored-By: Claude Opus 5.5 --- Documentation/UserManual/restrictions.md | 4 ++-- Documentation/UserManual/specifications.md | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/Documentation/UserManual/restrictions.md b/Documentation/UserManual/restrictions.md index b9c271a6..c95683a5 100644 --- a/Documentation/UserManual/restrictions.md +++ b/Documentation/UserManual/restrictions.md @@ -1,6 +1,6 @@ # Complex restrictions -When specifying a **Facet Parameter**, you may either specify a **Simple Value** or a **Complex Restriction**. A **Simple Value** may be text, a number, or a boolean (TRUE / FALSE). In contrast, a **Complex Restriction** may represent pick lists of valid values, naming schemes and conventions, numeric ranges, or more. A restriction may be specified in four different ways: +When specifying a **Facet Parameter**, you may either specify a **Simple Value** or a **Complex Restriction**. A **Simple Value** may be text, a number, or a boolean ("true" / "false", in lowercase). In contrast, a **Complex Restriction** may represent pick lists of valid values, naming schemes and conventions, numeric ranges, or more. A restriction may be specified in four different ways: - Enumeration - Pattern @@ -13,7 +13,7 @@ An **Enumeration** restriction means that the value must be one of a list of all Numbers may also be specified as a list. For example, you may specify that a concrete strength grade may be either "25", "30", "35, or "40". If the user has the value of "30", then that will comply with your **Enumeration**. However, if they choose "31", then it does not. -Booleans may also be specified, such as "TRUE" or "FALSE". However, it is generally meaningless to specify a boolean as an enumeration because the nature of a boolean implies that the user always has to choose either "TRUE" or "FALSE". +Booleans may also be specified, such as "true" or "false". However, it is generally meaningless to specify a boolean as an enumeration because the nature of a boolean implies that the user always has to choose either "true" or "false". Note that even if you specify a list of allowed values, the user can still only choose one value from that list. diff --git a/Documentation/UserManual/specifications.md b/Documentation/UserManual/specifications.md index 59a5f503..de8f31f6 100644 --- a/Documentation/UserManual/specifications.md +++ b/Documentation/UserManual/specifications.md @@ -38,7 +38,7 @@ There are six different **Facets** of information: | **Entity** | **IFC Class** and **Predefined Type** | Applies to "IfcWall" with predefined type of "SHEAR" | Must be an "IfcWall" with a predefined type of "SHEAR" | | **Attribute** | **Name** and **Value** | Applies to elements with the attribute "Name" having the value "W01" | Must have the attribute "Name" with the value "W01" | | **Classification** | **System** and **Value** | Applies to elements classified under "Uniclass 2015" as "EF_25_10_25" | Must have a "Uniclass 2015" classification reference of "EF_25_10_25" | -| **Property** | **Property Set**, **Name**, and **Value** | Applies to elements with a property set of "Pset_WallCommon" with a "LoadBearing" property set to "TRUE" | Must have a "Pset_WallCommon" property set with a "LoadBearing" property set to "TRUE" | +| **Property** | **Property Set**, **Name**, and **Value** | Applies to elements with a property set of "Pset_WallCommon" with a "LoadBearing" property set to "true" | Must have a "Pset_WallCommon" property set with a "LoadBearing" property set to "true" | | **Material** | **Value** | Applies to "concrete" elements | Must have a "concrete" material | | **Parts** | **Entity** and **Relationship** | Applies to elements that are "contained in" an "IfcSpace" | Must be "contained in" an "IfcSpace" | @@ -53,7 +53,7 @@ Here are a few examples to wet your appetite: | Intent | Applicability | Requirements | | ----------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| External load bearing walls need to have a fire rating property for code compliance | | | +| External load bearing walls need to have a fire rating property for code compliance | | | | Bedrooms should have a minimum area of 10m2 | | | | All brick wall types must be classified and follow the approved naming convention | | |