Added list of XML base types to DataTypes.md

buildingSMART · May 4, 2024 · 850abe5 · 850abe5
1 parent 8e9d212
commit 850abe5
Show file tree

Hide file tree

Showing 2 changed files with 45 additions and 7 deletions.
diff --git a/ids-lib.codegen/IfcSchema_DocumentationGenerator.cs b/ids-lib.codegen/IfcSchema_DocumentationGenerator.cs
@@ -11,31 +11,51 @@ internal class IfcSchema_DocumentationGenerator
 	{
 		internal static string Execute(Dictionary<string, typeMetadata> dataTypeDictionary)
 		{
-			StringBuilder sb = new StringBuilder();
 			var schemas = new string[] { "Ifc2x3", "Ifc4", "Ifc4x3" };
 
+			StringBuilder sbDataTypes = new StringBuilder();
 			foreach (var dataType in dataTypeDictionary.Values.OrderBy(x=>x.Name))
 			{
 				var checks = schemas.Select(x => dataType.Schemas.Contains(x) ? "✔️     " : "❌     ");
+				sbDataTypes.AppendLine($"| {dataType.Name,-45} | {string.Join(" | ", checks),-24} | {dataType.XmlBackingType,-21} |");
+			}
+
 
-				sb.AppendLine($"| {dataType.Name,-45} | {string.Join(" | ", checks),-24} | {dataType.XmlBackingType,-21} |");
+			StringBuilder sbXmlTypes = new StringBuilder();
+			var xmlTypes = dataTypeDictionary.Values.Select(x => x.XmlBackingType).Where(str => !string.IsNullOrWhiteSpace(str)).Distinct();
+			foreach (var dataType in xmlTypes.OrderBy(x => x))
+			{
+				sbXmlTypes.AppendLine($"| {dataType,-11} |");
 			}
-			
+
 			var source = stub;
-			source = source.Replace($"<PlaceHolderTable>", sb.ToString());
+			source = source.Replace($"<PlaceHolderDataTypes>", sbDataTypes.ToString().TrimEnd('\r', '\n'));
+			source = source.Replace($"<PlaceHolderXmlTypes>", sbXmlTypes.ToString().TrimEnd('\r', '\n'));
 			return source;
 			// Program.Message($"no change.", ConsoleColor.Green);
 		}
 
-		private const string stub = @"# DataTypes
+		private const string stub = @"# Type constraining
+
+## DataTypes
 
 Property dataTypes can be set to any values according to the following table.
 
 Columns of the table determine the validity of the type depending on the schema version and the required `xs:base` type for any `xs:restriction` constraint.
 
 | dataType                                      | Ifc2x3 | Ifc4   | Ifc4x3 | Restriction base type |
 | --------------------------------------------- | ------ | ------ | ------ | --------------------- |
-<PlaceHolderTable>
+<PlaceHolderDataTypes>
+
+## XML base types
+
+The list of valid XML base types for the `base` attribute of `xs:restriction` is:
+
+| Base type   |
+| ----------- |
+<PlaceHolderXmlTypes>
+
+## Notes
 
 Please note, this document has been automatically generated via the IDS Audit Tool repository, any changes should be initiated there.
 ";

diff --git a/ids-lib.codegen/buildingSMART/DataTypes.md b/ids-lib.codegen/buildingSMART/DataTypes.md
@@ -1,4 +1,6 @@
-# DataTypes
+# Type constraining
+
+## DataTypes
 
 Property dataTypes can be set to any values according to the following table.
 
@@ -399,5 +401,21 @@ Columns of the table determine the validity of the type depending on the schema
 | IFCWORKSCHEDULETYPEENUM                       | ❌      | ✔️      | ✔️      | xs:string             |
 | IFCYEARNUMBER                                 | ✔️      | ❌      | ❌      | xs:integer            |
 
+## XML base types
+
+The list of valid XML base types for the `base` attribute of `xs:restriction` is:
+
+| Base type   |
+| ----------- |
+| xs:boolean  |
+| xs:date     |
+| xs:dateTime |
+| xs:double   |
+| xs:duration |
+| xs:integer  |
+| xs:string   |
+| xs:time     |
+
+## Notes
 
 Please note, this document has been automatically generated via the IDS Audit Tool repository, any changes should be initiated there.