Skip to content

Commit b0281d1

Browse files
authored
Merge pull request #43 from admin-shell-io/BiBo/#40
cleanup
2 parents 3151569 + ccc5443 commit b0281d1

4 files changed

Lines changed: 42 additions & 62 deletions

File tree

documentation/IDTA-01005/modules/ROOT/pages/aasx.adoc

Lines changed: 34 additions & 49 deletions
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ The following name spaces are defined:
6868

6969
[cols="18%,82%",options="header"]
7070
|===
71-
|*Namespace* |*Value*
71+
h|Namespace h|Value
7272
|`<rel>` a|`\http://schema.openxmlformats.org/package/2006/relationships`
7373
|`<rel_aas>` a|`\http://admin-shell.io/aasx/relationships`
7474

@@ -80,30 +80,27 @@ and
8080
Each relationship typefootnote:[To avoid the long names of the relationship types, the short name is used in the text.] as denoted in <<aasx-rels>> is described in the following.
8181

8282
[.table-with-appendix-table]
83-
[cols="30%h,70%"]
84-
|===
85-
|*Relationship Type* |
86-
|*Source File of Relationship Type:* |*--*
87-
|*Namespace:* |`<rel>`
88-
|===
89-
[.appendix-table]
9083
[cols="30%,10%,60%",options="header"]
9184
|===
92-
|*Relationship Type* |*Card.* |*Description*
93-
|*metadata/thumbnail* |0..1 a|
85+
h|Relationship Type 2+h|
86+
h|Source File of Relationship Type: 2+h|--
87+
h|Namespace: 2+|`<rel>`
88+
89+
h|Relationship Type h|Card. h|Description
90+
h|metadata/thumbnail |0..1 a|
9491
Required to define a thumbnail for that package (e.g. picture of the administrated device).
9592

9693
The thumbnail picture can be shown instead of the package’s icon based on the extension and/or content type.
9794

98-
|*metadata/core-properties* |0..1 a|
95+
h|metadata/core-properties |0..1 a|
9996
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.
10097

10198
The core properties do not describe the Administration Shell, but the package itself.
10299
Some elements of the core properties may be similar/equal to elements of the Administration Shell.
103100

104101
Some core properties are: Title, Subject, Creator, Keywords, Description, LastModifiedBy, Revision, LastPrinted, Created, Modified, Category, Identifier, ContentType, Language, Version, ContentStatus.
105102

106-
|*digital-signature/origin* |0..1 a|
103+
h|digital-signature/origin |0..1 a|
107104
Required if you need to sign files and relationships inside the package.
108105
Their relationships basically target files that contain the data on signatures (e.g. certificate, digests, etc.).
109106

@@ -113,7 +110,7 @@ Note: see <<digital-signatures>> for more information.
113110
====
114111

115112

116-
|*aasx-origin* |1 a|
113+
h|aasx-origin |1 a|
117114
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.].
118115

119116
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.
122119
|===
123120

124121
[.table-with-appendix-table]
125-
[cols="30%h,70%"]
126-
|===
127-
|*Relationship Type* |
128-
|*Source File of Relationship Type:* |`<rel>/digital-signature/origin`
129-
|*Namespace:* |`<rel>` |
130-
|===
131-
[.appendix-table]
132122
[cols="30%,10%,60%",options="header"]
133123
|===
134-
|*Relationship Type* |*Card.* |*Description*
135-
|*digital-signature/signature* |1..* a|
124+
h|Relationship Type 2+|
125+
h|Source File of Relationship Type: 2+|`<rel>/digital-signature/origin`
126+
h|Namespace: 2+|`<rel>`
127+
128+
h|Relationship Type h|Card. h|Description
129+
h|digital-signature/signature |1..* a|
136130
Required if you need to sign files and relationships inside the package.
137131
Their relationships basically target files that contain the data on signatures (e.g. certificate, digests, …).
138132

@@ -145,17 +139,14 @@ Note: see <<digital-signatures>> for more information.
145139
|===
146140

147141
[.table-with-appendix-table]
148-
[cols="30%h,70%"]
149-
|===
150-
|*Relationship Type* |
151-
|*Source File of Relationship Type:* |`<rel>/digital-signature/signature`
152-
|*Namespace:* |`<rel>` |
153-
|===
154-
[.appendix-table]
155142
[cols="30%,10%,60%",options="header"]
156143
|===
157-
|*Relationship Type* |*Card.* |*Description*
158-
|*digital-signature/certificate* |0..1 a|
144+
h|Relationship Type 2+|
145+
h|Source File of Relationship Type: 2+|`<rel>/digital-signature/signature`
146+
h|Namespace: 2+|`<rel>`
147+
148+
h|Relationship Type h|Card. h|Description
149+
h|digital-signature/certificate |0..1 a|
159150
Required if you need to sign files and relationships inside the package.
160151
Their relationships basically target files that contain the data on signatures (e.g. certificate, digests, …).
161152

@@ -168,17 +159,14 @@ Note: see <<digital-signatures>> for more information.
168159
|===
169160

170161
[.table-with-appendix-table]
171-
[cols="30%h,70%"]
172-
|===
173-
|*Relationship Type* |
174-
|*Source File of Relationship Type:* |`<rel_aas>/aasx-origin`
175-
|*Namespace:* |`<rel_aas>` |
176-
|===
177-
[.appendix-table]
178162
[cols="30%,10%,60%",options="header"]
179163
|===
180-
|*Relationship Type* |*Mandatory* |*Description*
181-
|*aas-spec* |1..* a|
164+
h|Relationship Type 2+|
165+
h|Source File of Relationship Type: 2+|`<rel_aas>/aasx-origin`
166+
h|Namespace: 2+|`<rel_aas>`
167+
168+
h|Relationship Type h|Mandatory h|Description
169+
h|aas-spec |1..* a|
182170
Targets the file that contains the structure/specification of one or more identifiable elements (such as AAS, Submodel or ConceptDescription).
183171

184172
Different formats of the same information can be contained in the container.
@@ -188,17 +176,14 @@ Typical formats contained are XML and/or JSON.
188176
|===
189177

190178
[.table-with-appendix-table]
191-
[cols="30%h,70%"]
192-
|===
193-
|*Relationship Type* |
194-
|*Source File of Relationship Type:* |`<rel_aas>/aas-spec`
195-
|*Namespace:* |`<rel_aas>` |
196-
|===
197-
[.appendix-table]
198179
[cols="30%,10%,60%",options="header"]
199180
|===
200-
|*Relationship Type* |*Mandatory* |*Description*
201-
|*aas-suppl* |0..1 a|
181+
h|Relationship Type 2+|
182+
h|Source File of Relationship Type: 2+|`<rel_aas>/aas-spec`
183+
h|Namespace: 2+|`<rel_aas>`
184+
185+
h|Relationship Type h|Mandatory h|Description
186+
h|aas-suppl |0..1 a|
202187
Targets any additional file, which is referenced from within the data of an AAS via a relative URI reference in the _File_ submodel element.
203188

204189
====

documentation/IDTA-01005/modules/ROOT/pages/changelog.adoc

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,13 @@ Major Changes:
2121

2222
* CHANGE: the provisory MIME-Type application/asset-administration-shell-package was substituted with the newly registered IANA MIME-Type application/aas+zip (https://github.com/admin-shell-io/aas-specs-aasx/issues/41[#41]),
2323

24+
Minor Changes:
25+
26+
* 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])
27+
* REMOVED: abbreviations not used in specification (https://github.com/admin-shell-io/aas-specs-aasx/issues/40[#40])
28+
* CHANGED: editorial changes (https://github.com/admin-shell-io/aas-specs-aasx/issues/39[#39])
29+
30+
2431
== Changes V3.1 vs. V3.0.1
2532

2633
Major Changes:

documentation/IDTA-01005/modules/ROOT/pages/introduction.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ SPDX-License-Identifier: CC-BY-4.0
1313
The document series "Details of the Asset Administration Shell" specifies the different needs of implementing Asset Administration Shells in an Industry 4.0 environment.
1414
A corresponding IEC series is in development, see xref:bibliography.adoc#bib13[[13\]].
1515

16-
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.
16+
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.
1717

1818
<<aas-info-exchange-types>> shows the different ways of exchanging information via Asset Administration Shells.
1919
This part of the "Details of the Asset Administration Shell" series, Part 5, deals with type 1: file exchange.

documentation/IDTA-01005/modules/ROOT/pages/terms-definitions-and-abbreviations.adoc

Lines changed: 0 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -133,13 +133,9 @@ The list of abbreviations is identical in the different parts of the document se
133133
|*Abbreviation* |*Description*
134134
|AAS |Asset Administration Shell
135135
|AASX |Package file format for the Asset Administration Shell
136-
|AML |AutomationML
137-
|API |Application Programming Interface
138-
|BITKOM |Bundesverband Informationswirtschaft, Telekommunikation und neue Medien e. V.
139136
|BLOB |Binary Large Object
140137
|CDD |Common Data Dictionary
141138
|GUID |Globally unique identifier
142-
|I4.0 |Industrie 4.0
143139
|ID |Identifier
144140
|IDTA |Industrial Digital Twin Association
145141
|IEC |International Electrotechnical Commission
@@ -149,22 +145,14 @@ The list of abbreviations is identical in the different parts of the document se
149145
|JSON |JavaScript Object Notation
150146
|MIME |Multipurpose Internet Mail Extensions
151147
|OPC |Open Packaging Conventions (ECMA-376, ISO/IEC 29500-2)
152-
|OPC UA |OPC Unified Architecture
153148
|PDF |Portable Document Format
154-
|RAMI4.0 |Reference Architecture Model Industrie 4.0
155149
|RDF |Resource Description Framework
156-
|REST |Representational State Transfer
157150
|RFC |Request for Comment
158151
|UML |Unified Modeling Language
159152
|URI |Uniform Resource Identifier
160153
|URL |Uniform Resource Locator
161154
|URN |Uniform Resource Name
162155
|UTC |Universal Time Coordinated
163-
|VDE |Verband der Elektrotechnik, Elektronik und Informationstechnik e.V.
164-
|VDI |Verein Deutscher Ingenieure e.V.
165-
|VDMA |Verband Deutscher Maschinen- und Anlagenbau e.V.
166-
|W3C |World Wide Web Consortium
167156
|XML |eXtensible Markup Language
168157
|ZIP |archive file format that supports lossless data compression
169-
|ZVEI |Zentralverband Elektrotechnik- und Elektronikindustrie e. V.
170158
|===

0 commit comments

Comments
 (0)