Split document #320
Merged
Split document #320
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…es in overall document
…lude other subsections of preamble
… Shared + further splitting of Preamble + Minor updates in documents
BirgitBoss
added a commit
that referenced
this pull request
Jan 29, 2024
* Split document (#320) The following changes were made: * Introduce nav.adoc as entry point with includes * Split Annex: into shared parts (UML, UML Templates, Back-Naur-Form, Bibliography, Terms & Definitions) and specific parts (ChangeLog, Concepts AAS, Metamodel with Inheritance, Requirements, Usage Metamodel) * Extract Preamble from rest of document * Within Preamble extract Conformance and Versioning and move to Shared Sections * add index.adoc as start page for antora (preparation) * Extract Grammar for Semantic IDS for Metamodel and Grammar for Serialization of metamodel element "Reference" into separate files * Add idShort to DataSpecification + change order of elements to be conformant to Identifiable + update figures #307 * extract data specification chapter * update figure image59 for embedded data specifications + editorial and formatting changes * DataSpecifications.adoc contained also other chapters that belong to "General Rules". So new file for embedded data specifications was created and text was moved to original file again. Figure embedded data spec was updated (note arrow between EmbeddedDataSpecification and DataSpecification) * change path from DataSpecifications to DataSpecificationTemplates in g rammar for semantic ID for metamodel elements #307 * put titles before include so that better formatting in github * toclevel=4 (table of contents with 4 levels) * fix toclevels * toclevels added (4) * correct imagedir * correct path and add some more formatting options * move figures used in Shared document parts to separate folder + updated figures for UML Annex (From E/A) + fix that one figure was referenced twice * fix grammar syntax (generation error) * change reference to chapter Now generated link in html works. + Note fixed * logical IDs starting with http or https should ot be displayed as html-link: fixed in examples * bugfix fix paths * update glossary with glossary style of asciidoc + source made italic without bullet point + added links to metamodel abbreviations * 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 <garmaev@gmx.de> * Table formatting (one table instead of two for classes and enumerations) + new table row for metamodel ID * split into General, Mappings, Summary + Normative Part + add metamodel IDs to Normative Part * update table enumeration to contain metamodel ID * - merge two-folded tables into one - update UML template for table - update metamodel element ID if it uses elements with type "Identifier" or inherits from Referable (change type of idShort) * fix AASd-002 typo hyphen and formatting error + updates in changelog for Referable/idShort et.al. * merge class template into one * Enumeration EntityType did not change, /3/0 * bugfix typo: FragmentKeys, not FragementKeys * update Editorial Notes V3.0 * update changelog * Template for Primitives updated to also contain metamodel ID + Template for Enumeration updated to also contain metamodel ID for single values of the enumeration * Explanatory text of some enumerations updated + metamodel IDs added for Primitives * metamodel IDs added to enumeration in References Clause + bugfix Enumerations: add value "Referable" to FragmentsKeys and AasReferableNonIdentifiables * Add metamodel IDs to enumerations * formatting of grammars to listing blocks + usage of example blocks (otherwise errors in grammar due to special charc.) * formatting of grammar + http not valid resources, special char. used * formatting of examples, using example blocks * add semantic ID to all attributes in class tables * add semantic ID to all attributes in class tables * Move ValueOnly etc. from Part 2 to Part 1 (see #326) * absolute path added (although perhaps not the final solution) * formatting and semantic ID for class attributes * Chapters from Part 2 that are moved to Part 1 + generated .html * Annex "Handling of Constraints" added (part of UML Annex) + generated html * add HandlingConstraints * formatting editorial --------- Co-authored-by: zrgt <garmaev@gmx.de>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The document was split into smaller maintainable parts
closes #318