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

Add XML/JSON/RDF mappings to AsciiDoc Documentation #490

Open
wants to merge 5 commits into
base: IDTA-01001-3-1_working
Choose a base branch
from

Conversation

zrgt
Copy link
Collaborator

@zrgt zrgt commented Nov 28, 2024

In this PR we integrated XML/JSON/RDF mapping descriptions in our Antora Documentation based on AsciiDoc:

  • Transformed README.md contents of XML/JSON/RDF mapping descriptions to .adoc files
  • Integrated the XML/JSON/RDF Mapping description .adoc files in mappings.adoc with include::
  • Adjusted schemas/{XML/JSON/RDF }/README.md contents: added reference to the .adoc files where the mapping will be described

Refactoring:

  • Renamed spec-metamodel/nav-spec.adoc to index.adoc
  • Added some tags for referencing
  • Create mappings folder for mappings.adoc and all includes
  • Moved all included parts of mappings.adoc#Encoding from folder includes to mappings folder

The example how it looks now: https://rwth-iat.github.io/aas-specs-antora/IDTA-01001/v3.1/mappings/mappings.html

- Rename `nav-spec.adoc` to `index.adoc`
- Add some tags
- Move all parts of #Encoding
from `includes` to `mappings` folder
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant