Improve documentation structure for antora #329
Closed
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
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.
Template for Enumeration updated to also contain metamodel ID for single values of the enumeration
metamodel IDs added for Primitives
+ bugfix Enumerations: add value "Referable" to FragmentsKeys and AasReferableNonIdentifiables
(otherwise errors in grammar due to special charc.)
http not valid resources, special char. used
As IDTA-01001_Constraints.adoc is not a page in terms of Antora, but an adoc file containing content snippets namely contstraint definitions it should be treated as partial. See https://docs.antora.org/antora/latest/partials-directory/
Place IDTA-01xxx_Conformance.adoc and IDTA-01xxx_Versioning.adoc to partials, as they will be used to save a content which will be shown in Preamble page.
|
index.adoc is useful in antora: https://docs.antora.org/antora/latest/page/start-page/ or did you only remove it from nav.adoc? The latter is ok I am using AsciidocFX for generating html on my local machine: the two partials IDTA-01xxx_Versioning.adoc and IDTA-01xxx_Conformance.adoc included in IDTA-01001_Preamble.adoc do not show up in the generated html file. |
Base automatically changed from
BiBo/IDTA-01001-3-1_working
to
IDTA-01001-3-1_working
January 29, 2024 13:08
|
I will close the PR because structure will change again |
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.
as it is easier to handle all adoc filkes in one module rather than two.
but rathe only include some contents.
See https://docs.antora.org/antora/latest/partials-directory/
IDTA-01xxx_TermsDefinitionsAbbreviations.adoc