Merge changes antora + references (#324)

* Fix refs to AasReferableNonIdentifiables * Rename "Sections" dir to "pages" as standard in Antora * Rename "Sections" dir to "pages" as standard in Antora * Move Annex dirs in pages dir Annex should be a subdir of pages * Fix include refs acc. to Antora See https://docs.antora.org/antora/latest/page/include-a-page/ * Remove definition of imagesdir, as already done by Antora * Fix xref macro reference See: https://docs.antora.org/antora/latest/page/xref/ * Fix examples for valid model references * Move images as they belong to IDTA-01xxx_UML.adoc * Remove refs from Abbreviations table * Fix all xrefs acc. to Antora See: https://docs.antora.org/antora/latest/page/xref/ * Add example ref to an image --------- Co-authored-by: zrgt <[email protected]>
admin-shell-io · Dec 27, 2023 · ac25751 · ac25751
1 parent b4534fa
commit ac25751
Show file tree

Hide file tree

Showing 27 changed files with 182 additions and 201 deletions.
diff --git a/documentation/IDTA-01001/modules/ROOT/nav.adoc b/documentation/IDTA-01001/modules/ROOT/nav.adoc
@@ -21,7 +21,7 @@ Plattform Industrie 4.0; Anna Salari, Publik. Agentur für Kommunikation GmbH, d
 :xrefstyle: short
 
 
-include::../Constraints/constraints.adoc[]
+include::./IDTA-01001_Constraints.adoc[]
 
 
 = image:../../idta-logo.png[width=100%]
@@ -30,30 +30,30 @@ include::../Constraints/constraints.adoc[]
 include::Sections/index.adoc[]
 ////
 
-include::../Shared/Sections/IDTA-01xxx_TermsDefinitionsAbbreviations.adoc[]
+include::Shared:IDTA-01xxx_TermsDefinitionsAbbreviations.adoc[]
 
-include::Sections/IDTA-01001_Preamble.adoc[]
+include::./IDTA-01001_Preamble.adoc[]
 
 
-include::Sections/IDTA-01001.adoc[]
+include::./IDTA-01001.adoc[]
 
 
 
-include::Annex/IDTA-01001_ConceptsAAS.adoc[]
+include::./Annex/IDTA-01001_ConceptsAAS.adoc[]
 
-include::Annex/IDTA-01001_Requirements.adoc[]
+include::./Annex/IDTA-01001_Requirements.adoc[]
 
-include::../Shared/Annex/IDTA-01xxx_BackusNaurForm.adoc[]
+include::Shared:Annex/IDTA-01xxx_BackusNaurForm.adoc[]
 
-include::../Shared/Annex/IDTA-01xxx_UMLTemplates.adoc[]
+include::Shared:Annex/IDTA-01xxx_UMLTemplates.adoc[]
 
-include::../Shared/Annex/IDTA-01xxx_UML.adoc[]
+include::Shared:Annex/IDTA-01xxx_UML.adoc[]
 
-include::Annex/IDTA-01001_UsageMetamodel.adoc[]
+include::./Annex/IDTA-01001_UsageMetamodel.adoc[]
 
-include::Annex/IDTA-01001_MetamodelWithInheritance.adoc[]
+include::./Annex/IDTA-01001_MetamodelWithInheritance.adoc[]
 
-include::Annex/IDTA-01001_ChangeLog.adoc[]
+include::./Annex/IDTA-01001_ChangeLog.adoc[]
 
-include::../Shared/Annex/IDTA-01xxx_Bibliography.adoc[]
+include::Shared:Annex/IDTA-01xxx_Bibliography.adoc[]
 
diff --git a/...ules/ROOT/Annex/IDTA-01001_ChangeLog.adoc → ...OOT/pages/Annex/IDTA-01001_ChangeLog.adoc b/...ules/ROOT/Annex/IDTA-01001_ChangeLog.adoc → ...OOT/pages/Annex/IDTA-01001_ChangeLog.adoc
diff --git a/...es/ROOT/Annex/IDTA-01001_ConceptsAAS.adoc → ...T/pages/Annex/IDTA-01001_ConceptsAAS.adoc b/...es/ROOT/Annex/IDTA-01001_ConceptsAAS.adoc → ...T/pages/Annex/IDTA-01001_ConceptsAAS.adoc
@@ -11,8 +11,6 @@ Plattform Industrie 4.0; Anna Salari, Publik. Agentur für Kommunikation GmbH, d
 ////
 
 
-:imagesdir: ../images/
-
 
 [appendix]
 == Concepts of the Administration Shell

diff --git a/.../IDTA-01001_MetamodelWithInheritance.adoc → .../IDTA-01001_MetamodelWithInheritance.adoc b/.../IDTA-01001_MetamodelWithInheritance.adoc → .../IDTA-01001_MetamodelWithInheritance.adoc
@@ -10,7 +10,6 @@ Illustrations:
 Plattform Industrie 4.0; Anna Salari, Publik. Agentur für Kommunikation GmbH, designed by Publik. Agentur für Kommunikation GmbH
 ////
 
-:imagesdir: ../images/
 
 [appendix]
 == Metamodel UML with Inherited Attributes

diff --git a/...s/ROOT/Annex/IDTA-01001_Requirements.adoc → .../pages/Annex/IDTA-01001_Requirements.adoc b/...s/ROOT/Annex/IDTA-01001_Requirements.adoc → .../pages/Annex/IDTA-01001_Requirements.adoc
@@ -10,7 +10,6 @@ Illustrations:
 Plattform Industrie 4.0; Anna Salari, Publik. Agentur für Kommunikation GmbH, designed by Publik. Agentur für Kommunikation GmbH
 ////
 
-:imagesdir: ../images/
 
 [appendix]
 == Requirements

diff --git a/...ROOT/Annex/IDTA-01001_UsageMetamodel.adoc → ...ages/Annex/IDTA-01001_UsageMetamodel.adoc b/...ROOT/Annex/IDTA-01001_UsageMetamodel.adoc → ...ages/Annex/IDTA-01001_UsageMetamodel.adoc
@@ -11,8 +11,6 @@ Plattform Industrie 4.0; Anna Salari, Publik. Agentur für Kommunikation GmbH, d
 ////
 
 
-:imagesdir: ../images/
-
 
 [appendix]
 == How to Use the Metamodel

diff --git a/...001/modules/ROOT/Sections/IDTA-01001.adoc → ...-01001/modules/ROOT/pages/IDTA-01001.adoc b/...001/modules/ROOT/Sections/IDTA-01001.adoc → ...-01001/modules/ROOT/pages/IDTA-01001.adoc
@@ -17,11 +17,10 @@ Plattform Industrie 4.0; Anna Salari, Publik. Agentur für Kommunikation GmbH, d
 :toc-title: Specification of the Asset Administration Shell. Part 1: Metamodel
 :sectlinks:
 :sectnums:
-:imagesdir: ../images/
 :nofooter:
 
 
-include::../../Constraints/constraints.adoc[]
+include::IDTA-01001_Constraints.adoc[]
 
 
 
@@ -2348,8 +2347,9 @@ image::image49.png[]
 
 Keys are used to define references (_Reference_).
 
-Figure 49 presents a logical model of key types. These logical enumerations are used to formulate constraints.
+<<model_for_refs_keys>> presents a logical model of key types. These logical enumerations are used to formulate constraints.
 
+[#model_for_refs_keys]
 .Logical Model for Keys of References (non-normative)
 image::image50.png[]
 
@@ -2469,7 +2469,7 @@ Note: not used as type but in constraints.
 ====
 
 
-|Set of: |xref:AASReferableNonIdentifiables[AASReferableNonIdentifiables], xref:GenericFragmentKeys[GenericFragmentKeys]
+|Set of: |xref:AasReferableNonIdentifiables[AASReferableNonIdentifiables], xref:GenericFragmentKeys[GenericFragmentKeys]
 |===
 [cols="30%,70%"],options="header"]
 |===
@@ -2678,7 +2678,7 @@ Note: not used as type but in constraints.
 ====
 
 
-|Set of: |xref:AASReferableNonIdentifiables[AASReferableNonIdentifiables], xref:AasIdentifiables[AasIdentifiables]
+|Set of: |xref:AasReferableNonIdentifiables[AASReferableNonIdentifiables], xref:AasIdentifiables[AasIdentifiables]
 |===
 [cols="30%,70%"],options="header"]
 |===
@@ -2846,7 +2846,7 @@ identifiers for the corresponding resource referenced.
 {aasd128}
 
 In the following examples for valid und invalid model references and external references are given.
-The notation follows the grammar as defined in section xref:#trueserialization-of-values-of-type-reference[].
+The notation follows the grammar as defined in section xref:#_serialization_of_values_of_type_reference[].
 
 [.underline]#Examples for valid references:#
 
@@ -3532,7 +3532,7 @@ Blobs require the following encoding: base64 string.
 
 ====  Serialization of Values of Type "Reference"
 
-include::IDTA-01001_GrammarSerializationReference.adoc[] 
+include::IDTA-01001_GrammarSerializationReference.adoc[]
 
 
 ====  Semantic Identifiers for Metamodel and Data Specifications

diff --git a/...1001/modules/Constraints/constraints.adoc → ...es/ROOT/pages/IDTA-01001_Constraints.adoc b/...1001/modules/Constraints/constraints.adoc → ...es/ROOT/pages/IDTA-01001_Constraints.adoc
diff --git a/...ctions/IDTA-01001_DataSpecifications.adoc → .../pages/IDTA-01001_DataSpecifications.adoc b/...ctions/IDTA-01001_DataSpecifications.adoc → .../pages/IDTA-01001_DataSpecifications.adoc
@@ -2,7 +2,6 @@
 == Data Specification Templates (normative)
 ////
 
-:imagesdir: ../images/
 
 === Introduction
 
@@ -41,9 +40,9 @@ A template consists of the _DataSpecificationContent_ containing the additional
 |===
 |Attribute |Explanation |Type |Card.
 
-|idShort | Name of the data specification |xref:NameType[NameType] |0..1
+|idShort | Name of the data specification |xref:page$IDTA-01001.adoc#NameType[NameType] |0..1
 
-|description |Description of how and in which context the data specification template is applicable; can be provided in several languages. |xref:MultiLanguageTextType[MultiLanguageTextType] |0..1
+|description |Description of how and in which context the data specification template is applicable; can be provided in several languages. |xref:page$IDTA-01001.adoc#MultiLanguageTextType[MultiLanguageTextType] |0..1
 
 |administration a|
 Administrative information of an identifiable element
@@ -53,17 +52,17 @@ Administrative information of an identifiable element
 Note: some of the administrative information like the version number might need to be part of the identification.
 ====
 
-|xref:AdministrativeInformation[AdministrativeInformation] |0..1
+|xref:page$IDTA-01001.adoc#AdministrativeInformation[AdministrativeInformation] |0..1
 
 |id a|
 The globally unique identification of the data specification
 
 
 ====
-Note: This identifier is used as value for xref:HasDataSpecification[HasDataSpecification/dataSpecification] 
+Note: This identifier is used as value for xref:page$IDTA-01001.adoc#HasDataSpecification[HasDataSpecification/dataSpecification]
 ====
 
-|xref:Identifier[Identifier] |1
+|xref:page$IDTA-01001.adoc#Identifier[Identifier] |1
 
 |dataSpecificationContent |The content of the template without meta data
 |xref:DataSpecificationContent[DataSpecificationContent] |1

diff --git a/...DTA-01001_EmbeddedDataSpecifications.adoc → ...DTA-01001_EmbeddedDataSpecifications.adoc b/...DTA-01001_EmbeddedDataSpecifications.adoc → ...DTA-01001_EmbeddedDataSpecifications.adoc
@@ -2,7 +2,6 @@
 ====  Embedded Data Specifications
 ////
 
-:imagesdir: ../images/
 
 The document series "Specification Asset Administration Shell" predefines data specifications that can be used within an Asset Administration Shell to ensure interoperability (see Part 3 documents).
 

diff --git a/...TA-01001_GrammarSemanticIdsMetamodel.adoc → ...TA-01001_GrammarSemanticIdsMetamodel.adoc b/...TA-01001_GrammarSemanticIdsMetamodel.adoc → ...TA-01001_GrammarSemanticIdsMetamodel.adoc
@@ -2,7 +2,6 @@
 ====  Semantic Identifiers for Metamodel and Data Specifications
 ////
 
-:imagesdir: ../images/
 
 Rules for creating identifiers are defined to enable the unique identification of concepts as used and defined in the metamodel of the Asset Administration Shell.
 

diff --git a/...-01001_GrammarSerializationReference.adoc → ...-01001_GrammarSerializationReference.adoc b/...-01001_GrammarSerializationReference.adoc → ...-01001_GrammarSerializationReference.adoc
@@ -2,7 +2,6 @@
 ====  Serialization of Values of Type "Reference"
 ////
 
-:imagesdir: ../images/
 
 Some mappings or serializations convert the type "Reference" into a single string. In this case, the following serialization is required:
 

diff --git a/...es/ROOT/Sections/IDTA-01001_Preamble.adoc → ...dules/ROOT/pages/IDTA-01001_Preamble.adoc b/...es/ROOT/Sections/IDTA-01001_Preamble.adoc → ...dules/ROOT/pages/IDTA-01001_Preamble.adoc
@@ -10,7 +10,6 @@ Illustrations:
 Plattform Industrie 4.0; Anna Salari, Publik. Agentur für Kommunikation GmbH, designed by Publik. Agentur für Kommunikation GmbH
 ////
 
-:imagesdir: ../images/
 
 == Preamble
 
@@ -34,9 +33,9 @@ The first version of this document was produced September 2017 to July 2018 by a
 
 For better readability the abbreviation "I4.0" is consistently used for "Industrie 4.0" in compound terms. The term "Industrie 4.0" continues to be used when standing on its own.
 
-include::../../Shared/Sections/IDTA-01xxx_Versioning.adoc[]
+include::../../Shared/pages/IDTA-01xxx_Versioning.adoc[]
 
-include::../../Shared/Sections/IDTA-01xxx_Conformance.adoc[]
+include::../../Shared/pages/IDTA-01xxx_Conformance.adoc[]
 
 
 ===  Scope of this Document

diff --git a/...TA-01001/modules/ROOT/Sections/index.adoc → .../IDTA-01001/modules/ROOT/pages/index.adoc b/...TA-01001/modules/ROOT/Sections/index.adoc → .../IDTA-01001/modules/ROOT/pages/index.adoc
diff --git a/...DTA-01001/modules/ROOT/images/image81.png → ...A-01001/modules/Shared/images/image81.png b/...DTA-01001/modules/ROOT/images/image81.png → ...A-01001/modules/Shared/images/image81.png
diff --git a/...DTA-01001/modules/ROOT/images/image82.png → ...A-01001/modules/Shared/images/image82.png b/...DTA-01001/modules/ROOT/images/image82.png → ...A-01001/modules/Shared/images/image82.png
diff --git a/...DTA-01001/modules/ROOT/images/image83.png → ...A-01001/modules/Shared/images/image83.png b/...DTA-01001/modules/ROOT/images/image83.png → ...A-01001/modules/Shared/images/image83.png
diff --git a/...DTA-01001/modules/ROOT/images/image84.png → ...A-01001/modules/Shared/images/image84.png b/...DTA-01001/modules/ROOT/images/image84.png → ...A-01001/modules/Shared/images/image84.png
diff --git a/...DTA-01001/modules/ROOT/images/image85.png → ...A-01001/modules/Shared/images/image85.png b/...DTA-01001/modules/ROOT/images/image85.png → ...A-01001/modules/Shared/images/image85.png
diff --git a/...DTA-01001/modules/ROOT/images/image86.png → ...A-01001/modules/Shared/images/image86.png b/...DTA-01001/modules/ROOT/images/image86.png → ...A-01001/modules/Shared/images/image86.png
diff --git a/...ared/Annex/IDTA-01xxx_BackusNaurForm.adoc → ...ages/Annex/IDTA-01xxx_BackusNaurForm.adoc b/...ared/Annex/IDTA-01xxx_BackusNaurForm.adoc → ...ages/Annex/IDTA-01xxx_BackusNaurForm.adoc
@@ -10,7 +10,6 @@ Illustrations:
 Plattform Industrie 4.0; Anna Salari, Publik. Agentur für Kommunikation GmbH, designed by Publik. Agentur für Kommunikation GmbH
 ////
 
-:imagesdir: ../images/
 
 [appendix]
 == Backus-Naur-Form

diff --git a/...Shared/Annex/IDTA-01xxx_Bibliography.adoc → .../pages/Annex/IDTA-01xxx_Bibliography.adoc b/...Shared/Annex/IDTA-01xxx_Bibliography.adoc → .../pages/Annex/IDTA-01xxx_Bibliography.adoc
diff --git a/.../modules/Shared/Annex/IDTA-01xxx_UML.adoc → ...es/Shared/pages/Annex/IDTA-01xxx_UML.adoc b/.../modules/Shared/Annex/IDTA-01xxx_UML.adoc → ...es/Shared/pages/Annex/IDTA-01xxx_UML.adoc
@@ -10,8 +10,6 @@ Illustrations:
 Plattform Industrie 4.0; Anna Salari, Publik. Agentur für Kommunikation GmbH, designed by Publik. Agentur für Kommunikation GmbH
 ////
 
-:imagesdir: ../images/
-
 
 [appendix]
 == Legend for UML Modelling

diff --git a/...Shared/Annex/IDTA-01xxx_UMLTemplates.adoc → .../pages/Annex/IDTA-01xxx_UMLTemplates.adoc b/...Shared/Annex/IDTA-01xxx_UMLTemplates.adoc → .../pages/Annex/IDTA-01xxx_UMLTemplates.adoc
@@ -10,7 +10,6 @@ Illustrations:
 Plattform Industrie 4.0; Anna Salari, Publik. Agentur für Kommunikation GmbH, designed by Publik. Agentur für Kommunikation GmbH
 ////
 
-:imagesdir: ../images/
 
 [appendix]
 == Templates for UML Tables
@@ -74,23 +73,23 @@ Note 3: optional lists, i.e. attributes with cardinality > 1 and minimum 0, are
 
 [.underline]#Examples for valid model references#
 
-If class type equal to "ModelReference<xref:Submodel[Submodel]>", the following reference would be a valid reference (using the text serialization as defined in Clause 7.2.3):
+If class type equal to "ModelReference<Submodel>", the following reference would be a valid reference (using the text serialization as defined in Clause 7.2.3):
 
 *(Submodel)https://example.com/aas/1/1/1234859590*
 
-If class type equal to "ModelReference<xref:Referable[Referable]>", the following references would be valid references (using the text serialization as defined in Clause 7.2.3):
+If class type equal to "ModelReference<Referable>", the following references would be valid references (using the text serialization as defined in Clause 7.2.3):
 
 *(Submodel)https://example.com/aas/1/1/1234859590*
 
 *(Submodel)https://example.com/aas/1/1/1234859590, (Property)temperature*
 
 *(Submodel)https://example.com/aas/1/1/1234859590, (File)myDocument*
 
-This would be an invalid reference for "ModelReference<xref:Referable[Referable]>", instead type "Reference" shall be used:
+This would be an invalid reference for "ModelReference<Referable>", instead type "Reference" shall be used:
 
 *(Submodel)https://example.com/aas/1/1/1234859590, (File)myDocument (FragmentReference)Hints*
 
-This would be an invalid reference for "ModelReference<xref:Submodel[Submodel]>"
+This would be an invalid reference for "ModelReference<Submodel>"
 
 *(Submodel)https://example.com/aas/1/1/1234859590, (Property)temperature*
 

diff --git a/...ared/Sections/IDTA-01xxx_Conformance.adoc → .../Shared/pages/IDTA-01xxx_Conformance.adoc b/...ared/Sections/IDTA-01xxx_Conformance.adoc → .../Shared/pages/IDTA-01xxx_Conformance.adoc
@@ -10,8 +10,6 @@ Illustrations:
 Plattform Industrie 4.0; Anna Salari, Publik. Agentur für Kommunikation GmbH, designed by Publik. Agentur für Kommunikation GmbH
 ////
 
-:imagesdir: ../images/
-
 
 === Conformance
 

diff --git a/...-01xxx_TermsDefinitionsAbbreviations.adoc → ...-01xxx_TermsDefinitionsAbbreviations.adoc b/...-01xxx_TermsDefinitionsAbbreviations.adoc → ...-01xxx_TermsDefinitionsAbbreviations.adoc
@@ -486,28 +486,28 @@ The following abbreviations are not used in the document but may be used as abbr
 [cols="33%,67%",options=header]
 |===
 |*Abbreviation* |*Description*
-|AAS |xref:AssetAdministrationShell[]
-|Cap |xref:Capability[]
-|CD |xref:ConceptDescription[]
-|DE |xref:DataElement[]
-|DST |xref:DataSpecification[] Template
-|InOut |xref:inoutputVariable[]
-|In |xref:inputVariable[]
-|Prop |xref:Property[]
-|MLP |xref:MultiLanguageProperty[]
-|Range |xref:Range[]
-|Ent |xref:Entity[]
-|Evt |xref:Event[]
-|File |xref:File[]
-|Blob |xref:Blob[]
-|Opr |xref:Operation[]
-|Out |xref:outputVariable[]
-|Qfr |xref:Qualifier[]
-|Ref |xref:ReferenceElement[]
-|Rel |xref:RelationshipElement[]
-|RelA |xref:AnnotatedRelationshipElement[]
-|SM |xref:Submodel[]
-|SMC |xref:SubmodelElementCollection[]
-|SME |xref:SubmodelElement[]
-|SML |xref:SubmodelElementList[]
+|AAS |AssetAdministrationShell
+|Cap |Capability
+|CD |ConceptDescription
+|DE |DataElement
+|DST |DataSpecification Template
+|InOut |inoutputVariable
+|In |inputVariable
+|Prop |Property
+|MLP |MultiLanguageProperty
+|Range |Range
+|Ent |Entity
+|Evt |Event
+|File |File
+|Blob |Blob
+|Opr |Operation
+|Out |outputVariable
+|Qfr |Qualifier
+|Ref |ReferenceElement
+|Rel |RelationshipElement
+|RelA |AnnotatedRelationshipElement
+|SM |Submodel
+|SMC |SubmodelElementCollection
+|SME |SubmodelElement
+|SML |SubmodelElementList
 |===
diff --git a/...hared/Sections/IDTA-01xxx_Versioning.adoc → ...s/Shared/pages/IDTA-01xxx_Versioning.adoc b/...hared/Sections/IDTA-01xxx_Versioning.adoc → ...s/Shared/pages/IDTA-01xxx_Versioning.adoc
@@ -10,8 +10,6 @@ Illustrations:
 Plattform Industrie 4.0; Anna Salari, Publik. Agentur für Kommunikation GmbH, designed by Publik. Agentur für Kommunikation GmbH
 ////
 
-:imagesdir: ../images/
-
 
 === Versioning
-Original file line number
+Diff line change
@@ Expand Up @@
     ////
-    :imagesdir: ../images/
     [appendix]
     == Concepts of the Administration Shell
@@ Expand Down @@