From 9d4eaa31da008c857db6c32fd8e3f7e11800a6bd Mon Sep 17 00:00:00 2001 From: zrgt Date: Thu, 5 Dec 2024 23:05:12 +0100 Subject: [PATCH 1/3] Fix xrefs and tags --- .../modules/ROOT/pages/spec-metamodel/overview.adoc | 4 ++-- .../modules/ROOT/pages/spec-metamodel/submodel-elements.adoc | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/documentation/IDTA-01001/modules/ROOT/pages/spec-metamodel/overview.adoc b/documentation/IDTA-01001/modules/ROOT/pages/spec-metamodel/overview.adoc index e9ea3e62f..f1e8c890f 100644 --- a/documentation/IDTA-01001/modules/ROOT/pages/spec-metamodel/overview.adoc +++ b/documentation/IDTA-01001/modules/ROOT/pages/spec-metamodel/overview.adoc @@ -85,8 +85,8 @@ The elements of package "Core" are specified as first class citizens in Clause x Elements of package "Common" are specified in Clause xref:spec-metamodel/common.adoc[]. The elements of package "Referencing" are specified in Clause xref:spec-metamodel/referencing.adoc[]. Elements from package "Types" are specified in Clause xref:spec-metamodel/datatypes.adoc[]. -Elements from package "Envirnonment" are specified in Clause xref:spec-metamodel/environment.adoc[]. -Elements from package "ConceptDescriptions" are specified in Clause xref:spec-metamodel/concept-descriptions.adoc[]. +Elements from package "Environment" are specified in Clause xref:spec-metamodel/environment.adoc[]. +Elements from package "ConceptDescriptions" are specified in Clause xref:spec-metamodel/concept-description.adoc[]. The only package that is not listed is "Data Specifications (Templates)" because data specifications are handled differently. Data specification templates are explained in Clause xref:data-specifications.adoc[]. diff --git a/documentation/IDTA-01001/modules/ROOT/pages/spec-metamodel/submodel-elements.adoc b/documentation/IDTA-01001/modules/ROOT/pages/spec-metamodel/submodel-elements.adoc index 2ca3e91c4..dbc6b1ec5 100644 --- a/documentation/IDTA-01001/modules/ROOT/pages/spec-metamodel/submodel-elements.adoc +++ b/documentation/IDTA-01001/modules/ROOT/pages/spec-metamodel/submodel-elements.adoc @@ -221,7 +221,7 @@ Note: it is recommended to use an external reference. .2+e|[[EventPayload-observableReference]]observableReference 3+| `\https://admin-shell.io/aas/3/1/EventPayload/observableReference` a|Reference to the referable, which defines the scope of the event. |ModelReference |1 -.2+e|[[EventPayload-sourceSemanticId]]observableSemanticId 3+| `\https://admin-shell.io/aas/3/1/EventPayload/observableSemanticId` +.2+e|[[EventPayload-observableSemanticId]]observableSemanticId 3+| `\https://admin-shell.io/aas/3/1/EventPayload/observableSemanticId` a| semanticId of the referable, which defines the scope of the event, if available. From 985771de406bc531a1a376c1c336c0da6cfc1b0a Mon Sep 17 00:00:00 2001 From: zrgt Date: Fri, 13 Dec 2024 15:30:43 +0100 Subject: [PATCH 2/3] Fix `aasd127` variable --- .../IDTA-01001/modules/ROOT/pages/includes/constraints.adoc | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/documentation/IDTA-01001/modules/ROOT/pages/includes/constraints.adoc b/documentation/IDTA-01001/modules/ROOT/pages/includes/constraints.adoc index 73035156e..c747c0027 100644 --- a/documentation/IDTA-01001/modules/ROOT/pages/includes/constraints.adoc +++ b/documentation/IDTA-01001/modules/ROOT/pages/includes/constraints.adoc @@ -43,8 +43,7 @@ every entry needs to be in one line, no \ :aasd124: pass:q[[underline]#Constraint AASd-124:# For external references, i.e. xref:ROOT:spec-metamodel/referencing.adoc#Reference[Reference]s with _Reference/type_ = xref:ROOT:spec-metamodel/referencing.adoc#ReferenceTypes[ExternalReference], the last _key_ of _Reference/keys_ shall be either one of _GenericGloballyIdentifiables_ or one of xref:ROOT:spec-metamodel/referencing.adoc#GenericFragmentKeys[GenericFragmentKeys].] :aasd125: pass:q[[underline]#Constraint AASd-125:# For model references, i.e. xref:ROOT:spec-metamodel/referencing.adoc#Reference[Reference]s with xref:ROOT:spec-metamodel/referencing.adoc#Reference[Reference/type] = xref:ROOT:spec-metamodel/referencing.adoc#ReferenceTypes[ModelReference] with more than one key in _Reference/keys_, the value of xref:ROOT:spec-metamodel/referencing.adoc#Key[Key/type] of each of the keys following the first key of _Reference/keys_ shall be one of xref:ROOT:spec-metamodel/referencing.adoc#FragmentKeys[FragmentKeys].] :aasd126: pass:q[[underline]#Constraint AASd-126:# For model references, i.e. xref:ROOT:spec-metamodel/referencing.adoc#Reference[Reference]s with _Reference/type_ = xref:ROOT:spec-metamodel/referencing.adoc#ReferenceTypes[ModelReference] with more than one key in _Reference/keys,_ the value of xref:ROOT:spec-metamodel/referencing.adoc#Key[Key/type] of the last xref:ROOT:spec-metamodel/referencing.adoc#Key[Key] in the reference key chain may be one of xref:ROOT:spec-metamodel/referencing.adoc#GenericFragmentKeys[GenericFragmentKeys] or no key at all shall have a value out of xref:ROOT:spec-metamodel/referencing.adoc#GenericFragmentKeys[GenericFragmentKeys].] -:aasd127: pass:q[[underline]#Constraint AASd-127:# For model references, i.e. xref:ROOT:spec-metamodel/referencing.adoc#Reference[Reference]s with _Reference/type_ = xref:ROOT:spec-metamodel/referencing.adoc#ReferenceTypes[ModelReference] with more than one key in _Reference/keys,_ a key with xref:ROOT:spec-metamodel/referencing.adoc#Key[Key/type] _FragmentReference_ shall be preceded by a key with xref:ROOT:spec-metamodel/referencing.adoc#Key[Key/type] _File_ or _Blob_. -All other Asset Administration Shell fragments, i.e. xref:ROOT:spec-metamodel/referencing.adoc#Key[Key/type] values out of xref:ROOT:spec-metamodel/referencing.adoc#AasSubmodelElements[AasSubmodelElements] , do not support fragments.] +:aasd127: pass:q[[underline]#Constraint AASd-127:# For model references, i.e. xref:ROOT:spec-metamodel/referencing.adoc#Reference[Reference]s with _Reference/type_ = xref:ROOT:spec-metamodel/referencing.adoc#ReferenceTypes[ModelReference] with more than one key in _Reference/keys,_ a key with xref:ROOT:spec-metamodel/referencing.adoc#Key[Key/type] _FragmentReference_ shall be preceded by a key with xref:ROOT:spec-metamodel/referencing.adoc#Key[Key/type] _File_ or _Blob_. All other Asset Administration Shell fragments, i.e. xref:ROOT:spec-metamodel/referencing.adoc#Key[Key/type] values out of xref:ROOT:spec-metamodel/referencing.adoc#AasSubmodelElements[AasSubmodelElements] , do not support fragments.] :aasd128: pass:q[[underline]#Constraint AASd-128:# For model references, i.e. xref:ROOT:spec-metamodel/referencing.adoc#Reference[Reference]s with _Reference/type_ = xref:ROOT:spec-metamodel/referencing.adoc#ReferenceTypes[ModelReference], the xref:ROOT:spec-metamodel/referencing.adoc#Key[Key/value] of a xref:ROOT:spec-metamodel/referencing.adoc#Key[Key] preceded by a xref:ROOT:spec-metamodel/referencing.adoc#Key[Key] with xref:ROOT:spec-metamodel/referencing.adoc#Key[Key/type] = xref:ROOT:spec-metamodel/submodel-elements.adoc#SubmodelElementList[SubmodelElementList] is an integer number denoting the position in the array of the submodel element list.] :aasd129: pass:q[[underline]#Constraint AASd-129:# If any xref:ROOT:spec-metamodel/common.adoc#Qualifier[Qualifier/kind] value of a xref:ROOT:spec-metamodel/submodel-elements.adoc#SubmodelElement[SubmodelElement/qualifier] (attribute _qualifier_ inherited via xref:ROOT:spec-metamodel/common.adoc#Qualifiable[Qualifiable]) is equal to xref:ROOT:spec-metamodel/common.adoc#QualifierKind[TemplateQualifier], the submodel element shall be part of a submodel template, i.e. a _Submodel_ with xref:ROOT:spec-metamodel/core.adoc#Submodel[Submodel/kind] (attribute _kind_ inherited via xref:ROOT:spec-metamodel/common.adoc#HasKind[HasKind]) value equal to xref:ROOT:spec-metamodel/common.adoc#ModellingKind[Template].] :aasd130: pass:q[[underline]#Constraint AASd-130:# An attribute with data type "string" shall be restricted to the characters as defined in XML Schema 1.0, i.e. the string shall consist of these characters only: ^[\x09\x0A\x0D\x20-\uD7FF\uE000-\uFFFD\u00010000-\u0010FFFF]*$.] From 9eec51a42d23b071b113f87bd9cd6fc0b7c8ef26 Mon Sep 17 00:00:00 2001 From: zrgt Date: Fri, 13 Dec 2024 15:58:57 +0100 Subject: [PATCH 3/3] Fix unresolved xrefs --- .../IDTA-01001/modules/ROOT/pages/annex/usage-metamodel.adoc | 2 +- documentation/IDTA-01001/modules/ROOT/pages/changelog.adoc | 4 ++-- documentation/IDTA-01001/modules/ROOT/pages/general.adoc | 1 + .../mappings/encodings/grammar-serialization-reference.adoc | 2 +- .../modules/ROOT/pages/mappings/encodings/valueonly.adoc | 4 ++-- .../modules/ROOT/pages/spec-metamodel/referencing.adoc | 5 +++-- .../modules/ROOT/pages/spec-metamodel/submodel-elements.adoc | 2 +- 7 files changed, 11 insertions(+), 9 deletions(-) diff --git a/documentation/IDTA-01001/modules/ROOT/pages/annex/usage-metamodel.adoc b/documentation/IDTA-01001/modules/ROOT/pages/annex/usage-metamodel.adoc index dd1afbe85..1dbd668e0 100644 --- a/documentation/IDTA-01001/modules/ROOT/pages/annex/usage-metamodel.adoc +++ b/documentation/IDTA-01001/modules/ROOT/pages/annex/usage-metamodel.adoc @@ -18,7 +18,7 @@ Plattform Industrie 4.0; Anna Salari, Publik. Agentur für Kommunikation GmbH, d == Composite I4.0 Components -As described in Clause xref:general.adoc#life_cycle_with_type_assets_and_instance_assets[], there is a class of relationships between assets of different hierarchy levels. +As described in Clause xref:general.adoc#life-cycle-with-type-assets-and-instance-assets[], there is a class of relationships between assets of different hierarchy levels. In this class of relationships, automation equipment is explained as a complex, interrelated graph of automation devices and products, performing intelligent production and self-learning/optimization tasks. Details and examples for composite I4.0 Components can be found in xref:bibliography.adoc#bib13[[13\]]. diff --git a/documentation/IDTA-01001/modules/ROOT/pages/changelog.adoc b/documentation/IDTA-01001/modules/ROOT/pages/changelog.adoc index 0f612d0e5..2eb8c2877 100644 --- a/documentation/IDTA-01001/modules/ROOT/pages/changelog.adoc +++ b/documentation/IDTA-01001/modules/ROOT/pages/changelog.adoc @@ -122,10 +122,10 @@ Minor Changes: |=== |{empty} |*New Elements V3.1 vs V3.0.1* |*Comment* -|{empty} | xref:spec-metamodel/referencing.adoc#AasContainerElements[AasContainerSubmodelElements] | New enumeration for container submodel elements +|{empty} | xref:spec-metamodel/referencing.adoc#AasContainerSubmodelElements[AasContainerSubmodelElements] | New enumeration for container submodel elements |{empty} | xref:spec-metamodel/core.adoc#AssetKind[AssetKind/Role] | New value in enumeration |{empty} | xref:spec-metamodel/submodel-elements.adoc#ContainerElement[ContainerElement] | New abstract class -|{empty} | xref:spec-metamodel/referencing.adoc#AasNonContainerElements[AasNonContainerSubmodelElements] | New enumeration for non-container submodel elements +|{empty} | xref:spec-metamodel/referencing.adoc#AasNonContainerSubmodelElements[AasNonContainerSubmodelElements] | New enumeration for non-container submodel elements |=== .New, Changed or Removed Constraints diff --git a/documentation/IDTA-01001/modules/ROOT/pages/general.adoc b/documentation/IDTA-01001/modules/ROOT/pages/general.adoc index 47ae695dc..75b596fc7 100644 --- a/documentation/IDTA-01001/modules/ROOT/pages/general.adoc +++ b/documentation/IDTA-01001/modules/ROOT/pages/general.adoc @@ -33,6 +33,7 @@ Subclause xref:general.adoc#events[Events] discusses aspects of event handling. [#types-and-instances] == Types and Instances +[#life-cycle-with-type-assets-and-instance-assets] === Life Cycle with Type Assets and Instance Assets Industry 4.0 utilizes an extended understanding of assets, comprising elements such as factories, production systems, equipment, machines, components, produced products and raw materials, business processes and orders, immaterial assets (such as processes, software, documents, plans, intellectual property, standards), services, human personnel, etc.. diff --git a/documentation/IDTA-01001/modules/ROOT/pages/mappings/encodings/grammar-serialization-reference.adoc b/documentation/IDTA-01001/modules/ROOT/pages/mappings/encodings/grammar-serialization-reference.adoc index 52d4f4f59..af0724bea 100644 --- a/documentation/IDTA-01001/modules/ROOT/pages/mappings/encodings/grammar-serialization-reference.adoc +++ b/documentation/IDTA-01001/modules/ROOT/pages/mappings/encodings/grammar-serialization-reference.adoc @@ -73,6 +73,6 @@ The examples in this document therefore do not use this prefix. .... -In the last example the xref:spec-metamodel/common.adoc##HasSemantics[semanticId] of the property with idShort "Temperature" is expected to be "0173-1#02-BAA120#008", the xref:spec-metamodel/referencing.adoc##Reference[referredSemanticId]. +In the last example the xref:spec-metamodel/common.adoc#HasSemantics[semanticId] of the property with idShort "Temperature" is expected to be "0173-1#02-BAA120#008", the xref:spec-metamodel/referencing.adoc#Reference[referredSemanticId]. For further examples including invalid examples please see xref:spec-metamodel/referencing.adoc#constraints[Constraints for Referencing in Asset Administration Shells]. diff --git a/documentation/IDTA-01001/modules/ROOT/pages/mappings/encodings/valueonly.adoc b/documentation/IDTA-01001/modules/ROOT/pages/mappings/encodings/valueonly.adoc index 71ce50c9a..1a2d30138 100644 --- a/documentation/IDTA-01001/modules/ROOT/pages/mappings/encodings/valueonly.adoc +++ b/documentation/IDTA-01001/modules/ROOT/pages/mappings/encodings/valueonly.adoc @@ -28,7 +28,7 @@ Two separate requests make it possible to build up a user interface (UI) and sho Values are only available for * All subtypes of abstract type xref:spec-metamodel/submodel-elements.adoc#DataElement[DataElement], -* xref:spec-metamodel/submodel-elements.adoc#SubmodelElementList[SubmodelElementList] and xref:spec-metamodel/submodel-elements.adoc#SubmodelElementCollection[SubmodelElementCollection] SubmodelElementCollection resp. for their included xref:spec-metamodel/core.adoc#SubmodelElement[SubmodelElement]s, +* xref:spec-metamodel/submodel-elements.adoc#SubmodelElementList[SubmodelElementList] and xref:spec-metamodel/submodel-elements.adoc#SubmodelElementCollection[SubmodelElementCollection] resp. for their included xref:spec-metamodel/core.adoc#SubmodelElement[SubmodelElement]s, * xref:spec-metamodel/submodel-elements.adoc#ReferenceElement[ReferenceElement], * xref:spec-metamodel/submodel-elements.adoc#RelationshipElement[RelationshipElement] + xref:spec-metamodel/submodel-elements.adoc#AnnotatedRelationshipElement[AnnotatedRelationshipElement], * xref:spec-metamodel/submodel-elements.adoc#Entity[Entity], @@ -47,7 +47,7 @@ A leaf submodel element follows the rules for the different submodel elements co If it is not a leaf element, the serialization rules must be transitively followed until the value is a leaf submodel element. * xref:spec-metamodel/referencing.adoc#Reference[Reference] is serialized in format "Normal". * xref:spec-metamodel/core.adoc#SpecificAssetId[SpecificAssetId] is serialized in format "Normal". -* xref:spec-metamodel/submodel-elements.adoc#SubmodelElement[SubmodelElement]s without a value are not serialized. +* xref:spec-metamodel/core.adoc#SubmodelElement[SubmodelElement]s without a value are not serialized. * For each submodel element within the submodel, the submodel collection or submodel list: diff --git a/documentation/IDTA-01001/modules/ROOT/pages/spec-metamodel/referencing.adoc b/documentation/IDTA-01001/modules/ROOT/pages/spec-metamodel/referencing.adoc index 7c7aa6f92..c7bccdb68 100644 --- a/documentation/IDTA-01001/modules/ROOT/pages/spec-metamodel/referencing.adoc +++ b/documentation/IDTA-01001/modules/ROOT/pages/spec-metamodel/referencing.adoc @@ -168,7 +168,7 @@ include::partial$diagrams/52-aas-submodel-elements.puml[] |=== |Enumeration: e|[[KeyTypes]]KeyTypes h|Explanation: a|Enumeration of different key value types within a key -|Set of: |xref:FragmentKeys[FragmentKeys], xref:AasReferables[AasReferables], xref:spec-metamodel/datatypes.adoc#GloballyIdentifiables[GloballyIdentifiables] +|Set of: |xref:FragmentKeys[FragmentKeys], xref:AasReferables[AasReferables], xref:spec-metamodel/referencing.adoc#GloballyIdentifiables[GloballyIdentifiables] h|ID: | `\https://admin-shell.io/aas/3/1/KeyTypes` .2+h|Literal h| ID @@ -632,7 +632,7 @@ a|List of submodel elements [.table-with-appendix-table] [cols="30%h,70%"] |=== -h|Enumeration: e|[[AasNonContainerElements]]AasNonContainerSubmodelElements +h|Enumeration: e|[[AasNonContainerSubmodelElements]]AasNonContainerSubmodelElements h|Explanation: a|Enumeration of non-container submodel element types including abstract submodel element types ==== @@ -1023,6 +1023,7 @@ a|Submodel {empty} + +[#constraints] == Constraints {aasd121} diff --git a/documentation/IDTA-01001/modules/ROOT/pages/spec-metamodel/submodel-elements.adoc b/documentation/IDTA-01001/modules/ROOT/pages/spec-metamodel/submodel-elements.adoc index a8545bade..6e92adb1a 100644 --- a/documentation/IDTA-01001/modules/ROOT/pages/spec-metamodel/submodel-elements.adoc +++ b/documentation/IDTA-01001/modules/ROOT/pages/spec-metamodel/submodel-elements.adoc @@ -349,7 +349,7 @@ include::partial$diagrams/container-element-subtypes.puml[] A container element is a submodel element that is composed of other submodel elements. -Container elements include xref:spec-metamodel/submodel-elements.adoc#AnnotatedRelationshipElement[AnnotatedRelationshipElement], xref:spec-metamodel/submodel-elements.adoc#Entity[Entity], xref:spec-metamodel/submodel-elements.adoc#SubmodelElementCollection[SubmodelElementCollection] and xref:spec-metamodel/submodel-elements.adoc#SubmodelElementList[SubmodelElementList], see <>. +Container elements include xref:spec-metamodel/submodel-elements.adoc#AnnotatedRelationshipElement[AnnotatedRelationshipElement], xref:spec-metamodel/submodel-elements.adoc#Entity[Entity], xref:spec-metamodel/submodel-elements.adoc#SubmodelElementCollection[SubmodelElementCollection] and xref:spec-metamodel/submodel-elements.adoc#SubmodelElementList[SubmodelElementList], see <>. [.table-with-appendix-table] [cols="25%,40%,25%,10%"]