Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve documentation structure for antora #329

Closed
Closed
Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
43 commits
Select commit Hold shift + click to select a range
7b0a45e
Split document (#320)
BirgitBoss Dec 20, 2023
fb06fcd
Extract Grammar for Semantic IDS for Metamodel and Grammar for Serial…
BirgitBoss Dec 20, 2023
3ad2b29
Add idShort to DataSpecification + change order of elements to be con…
BirgitBoss Dec 20, 2023
42e2257
extract data specification chapter
BirgitBoss Dec 20, 2023
1f08421
update figure image59 for embedded data specifications + editorial an…
BirgitBoss Dec 20, 2023
3b378db
DataSpecifications.adoc contained also other chapters that belong to …
BirgitBoss Dec 20, 2023
e5e19e0
change path from DataSpecifications to DataSpecificationTemplates in g
BirgitBoss Dec 20, 2023
8c54c30
put titles before include so that better formatting in github
BirgitBoss Dec 20, 2023
f552f0b
toclevel=4 (table of contents with 4 levels)
BirgitBoss Dec 20, 2023
ff25f4d
fix toclevels
BirgitBoss Dec 20, 2023
3ea12b3
toclevels added (4)
BirgitBoss Dec 20, 2023
5679b11
correct imagedir
BirgitBoss Dec 20, 2023
9361c65
correct path and add some more formatting options
BirgitBoss Dec 21, 2023
db9a6ac
move figures used in Shared document parts to separate folder
BirgitBoss Dec 21, 2023
36a21cd
fix grammar syntax (generation error)
BirgitBoss Dec 21, 2023
385c382
change reference to chapter
BirgitBoss Dec 21, 2023
8be834a
logical IDs starting with http or https should
BirgitBoss Dec 21, 2023
5ede304
bugfix fix paths
BirgitBoss Dec 21, 2023
b4534fa
update glossary with glossary style of asciidoc
BirgitBoss Dec 21, 2023
ac25751
Merge changes antora + references (#324)
BirgitBoss Dec 27, 2023
7a848f1
Table formatting
BirgitBoss Dec 27, 2023
a243ef1
split into General, Mappings, Summary + Normative Part
BirgitBoss Dec 27, 2023
18f5866
update table enumeration to contain metamodel ID
BirgitBoss Dec 27, 2023
b29196a
- merge two-folded tables into one
BirgitBoss Dec 28, 2023
3d6d1e7
fix AASd-002 typo hyphen and formatting error
BirgitBoss Dec 28, 2023
36d1bc9
merge class template into one
BirgitBoss Jan 1, 2024
4fca544
Enumeration EntityType did not change, /3/0
BirgitBoss Jan 1, 2024
2a53e34
bugfix typo: FragmentKeys, not FragementKeys
BirgitBoss Jan 1, 2024
9f86a52
update Editorial Notes V3.0
BirgitBoss Jan 1, 2024
0efd395
update changelog
BirgitBoss Jan 1, 2024
22264d3
Template for Primitives updated to also contain metamodel ID +
BirgitBoss Jan 1, 2024
cd1b429
Explanatory text of some enumerations updated +
BirgitBoss Jan 1, 2024
307e63e
metamodel IDs added to enumeration in References Clause
BirgitBoss Jan 1, 2024
83e81c1
Add metamodel IDs to enumerations
BirgitBoss Jan 1, 2024
845d461
formatting of grammars to listing blocks + usage of example blocks
BirgitBoss Jan 1, 2024
94e2286
formatting of grammar +
BirgitBoss Jan 1, 2024
e2a97d9
formatting of examples, using example blocks
BirgitBoss Jan 1, 2024
156b30c
Move Constraints.adoc to partials
zrgt Jan 4, 2024
620933b
Remove index.adoc as not needed for antora
zrgt Jan 4, 2024
75c565b
Move all files from Shared to ROOT
zrgt Jan 5, 2024
3504916
Fix section titles in IDTA-01xxx_TermsDefinitionsAbbreviations.adoc
zrgt Jan 5, 2024
4c78191
Revert "Remove index.adoc as not needed for antora"
zrgt Jan 12, 2024
8a85079
Move Conformance and Versioning adoc to pages
zrgt Jan 12, 2024
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
fix AASd-002 typo hyphen and formatting error
+ updates in changelog for Referable/idShort et.al.
  • Loading branch information
BirgitBoss committed Dec 28, 2023
commit 3d6d1e7716bfc8b8d1a21833b8ec190f41efba84
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ Bugfixes:
* (Editorial) MultiLanguageNameType inconsistent description, maxLength=128 (schemata were correct) ([#313](https://github.com/admin-shell-io/aas-specs/issues/313))
* (Editorial) HasKind/kind explanataroy text: use template, not type ([#313](https://github.com/admin-shell-io/aas-specs/issues/313))
* (Editorial) DataTypeDefXsd links now correctly to xmlschema11-2, not to xsd V1.1 ([#312](https://github.com/admin-shell-io/aas-specs/issues/312) (as implemented in schemata)
* (Editorial) make mbeddedDataSpecification/dataSpecification mandatory (as implemented in schemata) [#296](https://github.com/admin-shell-io/aas-specs/issues/296)
* (Editorial) make EmbeddedDataSpecification/dataSpecification mandatory (as implemented in schemata) [#296](https://github.com/admin-shell-io/aas-specs/issues/296)
* (Editorial) Qualifier/Kind changed to Qualifier/kind (typo in table, UML and schema correct)
* (Editorial) BasicEventElement/Direction and BasicEventElement/State changed to BasicEventElement/direction and BasicEventElement/state typo in table, UML and schema correct)

Expand All @@ -68,14 +68,18 @@ Bugfixes:
[cols="5%,42%,48%",options="header",]
|===
|*Nc* |*V3.0 Change w.r.t. V2.0.1* |*Comment*
| | AssetKind | Add new value "Role" to enumeration AssetKind
| | DataTypeDefXsd | (bugfix in Text only) values in enumeration now reference xsd V1.0, not V1.1
| | EmbeddedDataSpecification/dataSpecification | (bugfix in Text only) now mandatory
| | Entity/entityType | now optional
| | Identifier | change length from 2000 to 2024 characters
| | MultiLanguageNameType | (bugfix in Text only) maxLength=128 (as derived and implemented)
| | NameType | change due to change of Constraint AASd-002
| | PathType | extend data type to support complete URI scheme for files RFC3986/RFC3987
| | AssetKind a| Add new value "Role" to enumeration AssetKind
| | BasicEventElement/Direction a| (bugfix in Text only) attribute starts with small letter
| | BasicEventElement/State a| (bugfix in Text only) attribute starts with small letter
| | DataTypeDefXsd a| (bugfix in Text only) values in enumeration now reference xsd V1.0, not V1.1
| | EmbeddedDataSpecification/dataSpecification a| (bugfix in Text only) now mandatory
| | Entity/entityType a| now optional
| | Identifier a| change length from 2000 to 2024 characters
| | MultiLanguageNameType a| (bugfix in Text only) maxLength=128 (as derived and implemented)
| | NameType a| change due to change of Constraint AASd-002
| | PathType a| extend data type to support complete URI scheme for files RFC3986/RFC3987
| | Qualifier/Kind a| (bugfix in Text only) attribute starts with small letter
| | Referable/idShort a| changed constraint AASd-002 to also allow hyphen
|===

.New Elements in Metamodel
Expand All @@ -93,7 +97,7 @@ Bugfixes:
| |AASd-002 |Update a|
now also allows hyphens to be included in name

Constraint AASd-002: _idShort_ of __Referable__s shall only feature letters, digits, hyphen ("-") and underscore ("_"); starting mandatory with a letter, and not ending with a hypen or underscore, i.e. ^[a-zA-Z][a-zA-Z0-9_-]*[a-zA-Z0-9_]+$.].
Constraint AASd-002: _idShort_ of __Referable__s shall only feature letters, digits, hyphen ("-") and underscore ("\_"); starting mandatory with a letter, and not ending with a hyphen or underscore, i.e. ^[a-zA-Z][a-zA-Z0-9_-]*[a-zA-Z0-9_]+$.].
| | AASd-014 | Update a|
Change since Entity/entityType is now optional

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ SPDX-License-Identifier: CC-BY-4.0
////

// Constraints
:aasd002: pass:q[[underline]#Constraint AASd-002:# _idShort_ of __Referable__s shall only feature letters, digits, hyphen ("-") and underscore ("_"); starting mandatory with a letter, and not ending with a hypen or underscore, i.e. ^[a-zA-Z][a-zA-Z0-9_-]*[a-zA-Z0-9_]+$.]
:aasd002: pass:q[[underline]#Constraint AASd-002:# _idShort_ of __Referable__s shall only feature letters, digits, hyphen ("-") and underscore ("\_"); starting mandatory with a letter, and not ending with a hyphen or underscore, i.e. ^[a-zA-Z][a-zA-Z0-9_-]*[a-zA-Z0-9_]+$.]
:aasd005: pass:q[[underline]#Constraint AASd-005:# If _AdministrativeInformation_/version is not specified, _AdministrativeInformation/revision_ shall also be unspecified. This means that a revision requires a version. If there is no version, there is no revision. Revision is optional.]
:aasd006: pass:q[[underline]#Constraint AASd-006:# If both, the _value_ and the _valueId_ of a _Qualifier_ are present, the value needs to be identical to the value of the referenced coded value in _Qualifier/valueId_.]
:aasd007: pass:q[[underline]#Constraint AASd-007:# If both the _Property/value_ and the _Property/valueId_ are present, the value of _Property/value_ needs to be identical to the value of the referenced coded value in _Property/valueId_.]
Expand Down