-
Notifications
You must be signed in to change notification settings - Fork 29
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
prepare antora documentation #336
Conversation
BirgitBoss
commented
Jan 31, 2024
- new folder structure for documents
- instead of includes use * xref: in nav.adoc
- chapter structure updated
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)
…ization of metamodel element "Reference" into separate files
…formant to Identifiable + update figures #307
…d formatting changes
…"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)
rammar for semantic ID for metamodel elements #307
+ updated figures for UML Annex (From E/A) + fix that one figure was referenced twice
Now generated link in html works. + Note fixed
ot be displayed as html-link: fixed in examples
+ source made italic without bullet point + added links to metamodel abbreviations
* 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>
(one table instead of two for classes and enumerations) + new table row for metamodel ID
+ add metamodel IDs to Normative Part
- update UML template for table - update metamodel element ID if it uses elements with type "Identifier" or inherits from Referable (change type of idShort)
+ updates in changelog for Referable/idShort et.al.
add :page-partial:
was renamed to IDTA-01001-Metamodel.adoc
pages/includes
pages/sharedAnnex resp.
pages/includes resp.
now use antora for generation
There are some commits which exist in
That's why we have conflicts which we should resolve. @BirgitBoss we can ignore most of them as the same was already done in other commits in |
Thank you for checking The two last commits are also already contained (although AASd-002 is not yet in the final version, we are still in discussion). So my impression we can overwrite everything with this PR? |
conflicts resolved with #337 |