From dbf8619e4752f895127e05e7668cfabd2df24b6d Mon Sep 17 00:00:00 2001 From: birgitboss Date: Mon, 23 Mar 2026 17:18:00 +0100 Subject: [PATCH 1/2] #40 remove mentionging and AML and OPC UA formats and cleanup abbreviations --- .../IDTA-01005/modules/ROOT/pages/changelog.adoc | 7 +++++++ .../IDTA-01005/modules/ROOT/pages/introduction.adoc | 2 +- .../pages/terms-definitions-and-abbreviations.adoc | 12 ------------ 3 files changed, 8 insertions(+), 13 deletions(-) diff --git a/documentation/IDTA-01005/modules/ROOT/pages/changelog.adoc b/documentation/IDTA-01005/modules/ROOT/pages/changelog.adoc index e30e85b..208cb5a 100644 --- a/documentation/IDTA-01005/modules/ROOT/pages/changelog.adoc +++ b/documentation/IDTA-01005/modules/ROOT/pages/changelog.adoc @@ -15,6 +15,13 @@ SPDX-License-Identifier: CC-BY-4.0 This annex lists the changes from version to version of the file exchange format together with major changes in the overall document. Non-backward compatible changes (nc) are marked as such. +== Changes V3.2 vs. V3.1 + +Minor Changes: + +* REMOVED: mentioning of AAS formats AutomationML and OPC UA since not contained any longer in AAS specification itself (https://github.com/admin-shell-io/aas-specs-aasx/issues/40[#40]) +* REMOVED: abbreviations not used in specification (https://github.com/admin-shell-io/aas-specs-aasx/issues/40[#40]) + == Changes V3.1 vs. V3.0.1 Major Changes: diff --git a/documentation/IDTA-01005/modules/ROOT/pages/introduction.adoc b/documentation/IDTA-01005/modules/ROOT/pages/introduction.adoc index 208e17a..be5d1af 100644 --- a/documentation/IDTA-01005/modules/ROOT/pages/introduction.adoc +++ b/documentation/IDTA-01005/modules/ROOT/pages/introduction.adoc @@ -13,7 +13,7 @@ SPDX-License-Identifier: CC-BY-4.0 The document series "Details of the Asset Administration Shell" specifies the different needs of implementing Asset Administration Shells in an Industry 4.0 environment. A corresponding IEC series is in development, see xref:bibliography.adoc#bib13[[13\]]. -Besides a technology-neutral specification of the information model in UML, several different formats are provided to exchange Asset Administration Shells: XML, JSON, RDF, AutomationML, as well as an OPC UA information model. +Besides a technology-neutral specification of the information model in UML, several different formats are provided to exchange Asset Administration Shells: XML, JSON, and RDF. <> shows the different ways of exchanging information via Asset Administration Shells. This part of the "Details of the Asset Administration Shell" series, Part 5, deals with type 1: file exchange. diff --git a/documentation/IDTA-01005/modules/ROOT/pages/terms-definitions-and-abbreviations.adoc b/documentation/IDTA-01005/modules/ROOT/pages/terms-definitions-and-abbreviations.adoc index d87ee35..6c8e51e 100644 --- a/documentation/IDTA-01005/modules/ROOT/pages/terms-definitions-and-abbreviations.adoc +++ b/documentation/IDTA-01005/modules/ROOT/pages/terms-definitions-and-abbreviations.adoc @@ -133,13 +133,9 @@ The list of abbreviations is identical in the different parts of the document se |*Abbreviation* |*Description* |AAS |Asset Administration Shell |AASX |Package file format for the Asset Administration Shell -|AML |AutomationML -|API |Application Programming Interface -|BITKOM |Bundesverband Informationswirtschaft, Telekommunikation und neue Medien e. V. |BLOB |Binary Large Object |CDD |Common Data Dictionary |GUID |Globally unique identifier -|I4.0 |Industrie 4.0 |ID |Identifier |IDTA |Industrial Digital Twin Association |IEC |International Electrotechnical Commission @@ -149,22 +145,14 @@ The list of abbreviations is identical in the different parts of the document se |JSON |JavaScript Object Notation |MIME |Multipurpose Internet Mail Extensions |OPC |Open Packaging Conventions (ECMA-376, ISO/IEC 29500-2) -|OPC UA |OPC Unified Architecture |PDF |Portable Document Format -|RAMI4.0 |Reference Architecture Model Industrie 4.0 |RDF |Resource Description Framework -|REST |Representational State Transfer |RFC |Request for Comment |UML |Unified Modeling Language |URI |Uniform Resource Identifier |URL |Uniform Resource Locator |URN |Uniform Resource Name |UTC |Universal Time Coordinated -|VDE |Verband der Elektrotechnik, Elektronik und Informationstechnik e.V. -|VDI |Verein Deutscher Ingenieure e.V. -|VDMA |Verband Deutscher Maschinen- und Anlagenbau e.V. -|W3C |World Wide Web Consortium |XML |eXtensible Markup Language |ZIP |archive file format that supports lossless data compression -|ZVEI |Zentralverband Elektrotechnik- und Elektronikindustrie e. V. |=== From 88aae10bee08c9f8f63d50806e41846625fd354f Mon Sep 17 00:00:00 2001 From: birgitboss Date: Mon, 23 Mar 2026 17:36:25 +0100 Subject: [PATCH 2/2] #39 editorial changes, table formatting --- .../IDTA-01005/modules/ROOT/pages/aasx.adoc | 83 ++++++++----------- .../modules/ROOT/pages/changelog.adoc | 1 + 2 files changed, 35 insertions(+), 49 deletions(-) diff --git a/documentation/IDTA-01005/modules/ROOT/pages/aasx.adoc b/documentation/IDTA-01005/modules/ROOT/pages/aasx.adoc index ba0bef1..af51fa0 100644 --- a/documentation/IDTA-01005/modules/ROOT/pages/aasx.adoc +++ b/documentation/IDTA-01005/modules/ROOT/pages/aasx.adoc @@ -68,7 +68,7 @@ The following name spaces are defined: [cols="18%,82%",options="header"] |=== -|*Namespace* |*Value* +h|Namespace h|Value |`` a|`\http://schema.openxmlformats.org/package/2006/relationships` |`` a|`\http://admin-shell.io/aasx/relationships` @@ -80,22 +80,19 @@ and Each relationship typefootnote:[To avoid the long names of the relationship types, the short name is used in the text.] as denoted in <> is described in the following. [.table-with-appendix-table] -[cols="30%h,70%"] -|=== -|*Relationship Type* | -|*Source File of Relationship Type:* |*--* -|*Namespace:* |`` -|=== -[.appendix-table] [cols="30%,10%,60%",options="header"] |=== -|*Relationship Type* |*Card.* |*Description* -|*metadata/thumbnail* |0..1 a| +h|Relationship Type 2+h| +h|Source File of Relationship Type: 2+h|-- +h|Namespace: 2+|`` + +h|Relationship Type h|Card. h|Description +h|metadata/thumbnail |0..1 a| Required to define a thumbnail for that package (e.g. picture of the administrated device). The thumbnail picture can be shown instead of the package’s icon based on the extension and/or content type. -|*metadata/core-properties* |0..1 a| +h|metadata/core-properties |0..1 a| There is a schema for describing the package through "core properties," which uses selected Dublin Core metadata elements in addition to some Open Packaging Conventions-specific elements. The core properties do not describe the Administration Shell, but the package itself. @@ -103,7 +100,7 @@ Some elements of the core properties may be similar/equal to elements of the Adm Some core properties are: Title, Subject, Creator, Keywords, Description, LastModifiedBy, Revision, LastPrinted, Created, Modified, Category, Identifier, ContentType, Language, Version, ContentStatus. -|*digital-signature/origin* |0..1 a| +h|digital-signature/origin |0..1 a| Required if you need to sign files and relationships inside the package. Their relationships basically target files that contain the data on signatures (e.g. certificate, digests, etc.). @@ -113,7 +110,7 @@ Note: see <> for more information. ==== -|*aasx-origin* |1 a| +h|aasx-origin |1 a| This relationship targets an aasx origin file which shall be an empty file or a plain text file containing the text "Intentionally empty"footnote:[This will allow extensions of the AASX package format in future versions of this specification.]. It is the entry point for all aas specific relationships and files inside the package. @@ -122,17 +119,14 @@ The source of the aasx origin relationship must be the package root. |=== [.table-with-appendix-table] -[cols="30%h,70%"] -|=== -|*Relationship Type* | -|*Source File of Relationship Type:* |`/digital-signature/origin` -|*Namespace:* |`` | -|=== -[.appendix-table] [cols="30%,10%,60%",options="header"] |=== -|*Relationship Type* |*Card.* |*Description* -|*digital-signature/signature* |1..* a| +h|Relationship Type 2+| +h|Source File of Relationship Type: 2+|`/digital-signature/origin` +h|Namespace: 2+|`` + +h|Relationship Type h|Card. h|Description +h|digital-signature/signature |1..* a| Required if you need to sign files and relationships inside the package. Their relationships basically target files that contain the data on signatures (e.g. certificate, digests, …). @@ -145,17 +139,14 @@ Note: see <> for more information. |=== [.table-with-appendix-table] -[cols="30%h,70%"] -|=== -|*Relationship Type* | -|*Source File of Relationship Type:* |`/digital-signature/signature` -|*Namespace:* |`` | -|=== -[.appendix-table] [cols="30%,10%,60%",options="header"] |=== -|*Relationship Type* |*Card.* |*Description* -|*digital-signature/certificate* |0..1 a| +h|Relationship Type 2+| +h|Source File of Relationship Type: 2+|`/digital-signature/signature` +h|Namespace: 2+|`` + +h|Relationship Type h|Card. h|Description +h|digital-signature/certificate |0..1 a| Required if you need to sign files and relationships inside the package. Their relationships basically target files that contain the data on signatures (e.g. certificate, digests, …). @@ -168,17 +159,14 @@ Note: see <> for more information. |=== [.table-with-appendix-table] -[cols="30%h,70%"] -|=== -|*Relationship Type* | -|*Source File of Relationship Type:* |`/aasx-origin` -|*Namespace:* |`` | -|=== -[.appendix-table] [cols="30%,10%,60%",options="header"] |=== -|*Relationship Type* |*Mandatory* |*Description* -|*aas-spec* |1..* a| +h|Relationship Type 2+| +h|Source File of Relationship Type: 2+|`/aasx-origin` +h|Namespace: 2+|`` + +h|Relationship Type h|Mandatory h|Description +h|aas-spec |1..* a| Targets the file that contains the structure/specification of one or more identifiable elements (such as AAS, Submodel or ConceptDescription). Different formats of the same information can be contained in the container. @@ -188,17 +176,14 @@ Typical formats contained are XML and/or JSON. |=== [.table-with-appendix-table] -[cols="30%h,70%"] -|=== -|*Relationship Type* | -|*Source File of Relationship Type:* |`/aas-spec` -|*Namespace:* |`` | -|=== -[.appendix-table] [cols="30%,10%,60%",options="header"] |=== -|*Relationship Type* |*Mandatory* |*Description* -|*aas-suppl* |0..1 a| +h|Relationship Type 2+| +h|Source File of Relationship Type: 2+|`/aas-spec` +h|Namespace: 2+|`` + +h|Relationship Type h|Mandatory h|Description +h|aas-suppl |0..1 a| Targets any additional file, which is referenced from within the data of an AAS via a relative URI reference in the _File_ submodel element. ==== diff --git a/documentation/IDTA-01005/modules/ROOT/pages/changelog.adoc b/documentation/IDTA-01005/modules/ROOT/pages/changelog.adoc index 208cb5a..31bcbb5 100644 --- a/documentation/IDTA-01005/modules/ROOT/pages/changelog.adoc +++ b/documentation/IDTA-01005/modules/ROOT/pages/changelog.adoc @@ -21,6 +21,7 @@ Minor Changes: * REMOVED: mentioning of AAS formats AutomationML and OPC UA since not contained any longer in AAS specification itself (https://github.com/admin-shell-io/aas-specs-aasx/issues/40[#40]) * REMOVED: abbreviations not used in specification (https://github.com/admin-shell-io/aas-specs-aasx/issues/40[#40]) +* CHANGED: editorial changes (https://github.com/admin-shell-io/aas-specs-aasx/issues/39[#39]) == Changes V3.1 vs. V3.0.1