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

[BUG] Editorial inconsistencies #313

Closed
BirgitBoss opened this issue Dec 15, 2023 · 0 comments · Fixed by #317
Closed

[BUG] Editorial inconsistencies #313

BirgitBoss opened this issue Dec 15, 2023 · 0 comments · Fixed by #317
Labels
accepted accepted in principle to be fixed bug Something isn't working
Milestone

Comments

@BirgitBoss
Copy link
Collaborator

BirgitBoss commented Dec 15, 2023

Describe the bug
This issue is serving to track editorial inconsistencies that have impact on documentation only.

  • Explanation of HasKind/kind – not type but template
  • MultiLanguageNameType inconsistent description, maxLength=128 (schemata were correct)
  • Referable: Referable elements can be referenced via the idShort. For details on referencing, see Clause 5.3.9. This is not true for elements within SubmodelElementList. E.g. Referables are element that can be unambiguously referenced within the context of an Identifiable or
    Referables are elements within the information model that have the attribute “idShort” or are numerically identifiable
  • Metamodel of HasKind shall be part of chapter “HasKind”, not at the end of previous chapter
  • Non-identifiable referable elements can be referenced. However, this requires the context of the element. A referable that is not identifiable has a short identifier (idShort) that is unique just in its context, its name space.  this does not hold for SubmodelElementList
    A Referable not being Identifiable has either a short identifier (idShort) or a numerical identifier that is unique just in its context, its name space.
    also here: Referable elements can be referenced via the idShort. Or a numerical identifier
    also here: Note1 : an element that is referable by its idShort. This ID is not globally unique. This ID is unique within the name space of the element.
  • remove <<DataType>> from Annex UML since not used any longer
  • Link to Now ECLASS has mapping https://eclass.eu/support/technical-specification/data-model/datatype-to-xsd-mapping again, put to Part 3a? available again
  • the display name is selected in the following order, if available: could and NOTE
  • Examples for ModelReferences: add information for the grammar used to describe the examples
@BirgitBoss BirgitBoss added bug Something isn't working accepted accepted in principle to be fixed labels Dec 15, 2023
@BirgitBoss BirgitBoss added this to the V3.1 milestone Dec 15, 2023
BirgitBoss added a commit that referenced this issue Dec 15, 2023
…th=128 (schemata were correct) ([#313](#313))

* (Editorial) HasKind/kind explanataroy text: use template, not type ([#313](#313))
* (Editorial) DataTypeDefXsd links now correctly to xmlschema11-2, not to xsd V1.1 ([#312](#312))
+ minor editorial changes
@BirgitBoss BirgitBoss linked a pull request Dec 15, 2023 that will close this issue
BirgitBoss added a commit that referenced this issue Dec 18, 2023
@BirgitBoss BirgitBoss linked a pull request Dec 18, 2023 that will close this issue
BirgitBoss added a commit that referenced this issue Jan 29, 2024
* * (Editorial) MultiLanguageNameType inconsistent description, maxLength=128 (schemata were correct) ([#313](#313))
* (Editorial) HasKind/kind explanataroy text: use template, not type ([#313](#313))
* (Editorial) DataTypeDefXsd links now correctly to xmlschema11-2, not to xsd V1.1 ([#312](#312))
+ minor editorial changes

* New value "Role" in Enumeration AssetKind (#294)

* add new value "AssetKind" enumeration "Role"  #294
Change PathType to allow not only file:  #299

* Identifier: change length from 2000 to 2024 characters #299

* allow hyphens in idShort of Referables #295

* make Entity/entityType optional #287

* editorial change, add missing link to issue #295

* Update Constraint AASd-014 (part 2 of #287)

* EmbeddedDataSpecification/dataSpecification now mandatory #296

* Update Change Appendix w.r.t. EmbeddedDataSpecifcation/dataSpecification (now mandatory) #296

* #296 update Changes Section

* Editorial changes
#313

* semanticId of specificAssetId with name "globalAssetId"
#298

* Correct AASd-002

see #295 
for backward compatibility reasons idShort can end with an underscore. Additionally also 1 char idShorts are allowed.

* path .Specification.pdf

remove \

* fix typo
@BirgitBoss BirgitBoss modified the milestones: V3.1, V3.0.1 Feb 29, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
accepted accepted in principle to be fixed bug Something isn't working
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant