From 7a9c15f5450daad37e820714de8826dbdc1993ed Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Tue, 6 Sep 2022 17:47:53 +0200 Subject: [PATCH 01/48] Initial setup for Antora --- .antora/antora.yml | 45 ++++++ .antora/modules/specification/images | 1 + .../specification/nav_contribution.adoc | 76 +++++++++ .../specification/nav_introduction.adoc | 9 ++ .antora/modules/specification/pages | 1 + content/_config.adoc | 57 +++++++ .../_static}/images/osi-context.png | Bin .../osi-traffic-participant-advanced.png | Bin .../osi-traffic-participant-principle.png | Bin .../osi-traffic-participant-use-case-1.png | Bin .../osi-traffic-participant-use-case-2.png | Bin .../osi-traffic-participant-use-case-3.png | Bin .../osi-traffic-participant-use-case-4.png | Bin .../_static}/images/osilogo.png | Bin .../appendix}/releases/compatibility.adoc | 5 + .../appendix}/releases/v02.00.adoc | 8 +- .../appendix}/releases/v02.01.adoc | 7 +- .../appendix/releases/v02.02.00.adoc | 18 +-- content/appendix/releases/v02.02.01.adoc | 17 ++ .../appendix/releases/v03.00.00.adoc | 27 +--- content/appendix/releases/v03.00.01.adoc | 26 +++ .../appendix/releases/v03.01.00.adoc | 20 +-- content/appendix/releases/v03.01.01.adoc | 13 ++ content/appendix/releases/v03.01.02.adoc | 12 ++ .../appendix}/releases/v03.02.adoc | 7 +- .../appendix/releases/v03.03.00.adoc | 15 +- content/appendix/releases/v03.03.01.adoc | 14 ++ .../appendix}/releases/v03.04.adoc | 7 +- .../appendix}/releases/v03.05.adoc | 7 +- .../contributing}/branching_member.adoc | 9 +- .../commenting_fields_enums.adoc | 8 +- .../contributing}/commenting_messages.adoc | 6 + .../contributing}/contributing_docs.adoc | 5 + .../contributing}/contribution_rules.adoc | 16 +- .../contributing}/creating_images.adoc | 5 + .../contributing}/creating_references.adoc | 6 + .../contributing}/dco.adoc | 6 + .../contributing}/forking_no_member.adoc | 9 +- .../contributing}/licensing.adoc | 5 + .../contributing}/naming_conventions.adoc | 6 + .../contributing}/reporting_issues.adoc | 8 +- .../contributing}/review_author.adoc | 5 + .../contributing}/review_reviewer.adoc | 5 + .../contributing}/signing_off_commits.adoc | 8 +- .../contributing}/start_contributing.adoc | 5 + .../writing_commit_messages.adoc | 6 + .../general_docs}/bibliography.bib | 0 content/general_docs/changes.adoc | 8 + .../general_docs}/conventions.adoc | 7 +- .../general_docs}/deliverables.adoc | 7 +- .../general_docs}/foreword.adoc | 5 + .../general_docs}/glossary.adoc | 5 + .../general_docs}/osi_repos.adoc | 5 +- .../general_docs}/statements.adoc | 8 +- .../general_docs}/versioning.adoc | 7 +- .../relations_to_other_standards.adoc | 5 + content/index.adoc | 25 +++ general_docs/changes.adoc | 3 - index.adoc | 148 ------------------ local_build_tools/asciidoctor.bat | 3 + local_build_tools/compose.yml | 8 + .../windows_convert_symlinks(ADMIN).bat | 13 ++ 62 files changed, 537 insertions(+), 230 deletions(-) create mode 100644 .antora/antora.yml create mode 120000 .antora/modules/specification/images create mode 100644 .antora/modules/specification/nav_contribution.adoc create mode 100644 .antora/modules/specification/nav_introduction.adoc create mode 120000 .antora/modules/specification/pages create mode 100644 content/_config.adoc rename {_static => content/_static}/images/osi-context.png (100%) rename {_static => content/_static}/images/osi-traffic-participant-advanced.png (100%) rename {_static => content/_static}/images/osi-traffic-participant-principle.png (100%) rename {_static => content/_static}/images/osi-traffic-participant-use-case-1.png (100%) rename {_static => content/_static}/images/osi-traffic-participant-use-case-2.png (100%) rename {_static => content/_static}/images/osi-traffic-participant-use-case-3.png (100%) rename {_static => content/_static}/images/osi-traffic-participant-use-case-4.png (100%) rename {_static => content/_static}/images/osilogo.png (100%) rename {appendix => content/appendix}/releases/compatibility.adoc (86%) rename {appendix => content/appendix}/releases/v02.00.adoc (92%) rename {appendix => content/appendix}/releases/v02.01.adoc (73%) rename appendix/releases/v02.02.adoc => content/appendix/releases/v02.02.00.adoc (53%) create mode 100644 content/appendix/releases/v02.02.01.adoc rename appendix/releases/v03.00.adoc => content/appendix/releases/v03.00.00.adoc (68%) create mode 100644 content/appendix/releases/v03.00.01.adoc rename appendix/releases/v03.01.adoc => content/appendix/releases/v03.01.00.adoc (55%) create mode 100644 content/appendix/releases/v03.01.01.adoc create mode 100644 content/appendix/releases/v03.01.02.adoc rename {appendix => content/appendix}/releases/v03.02.adoc (93%) rename appendix/releases/v03.03.adoc => content/appendix/releases/v03.03.00.adoc (82%) create mode 100644 content/appendix/releases/v03.03.01.adoc rename {appendix => content/appendix}/releases/v03.04.adoc (93%) rename {appendix => content/appendix}/releases/v03.05.adoc (89%) rename {contributing => content/contributing}/branching_member.adoc (87%) rename {contributing => content/contributing}/commenting_fields_enums.adoc (92%) rename {contributing => content/contributing}/commenting_messages.adoc (90%) rename {contributing => content/contributing}/contributing_docs.adoc (86%) rename {contributing => content/contributing}/contribution_rules.adoc (72%) rename {contributing => content/contributing}/creating_images.adoc (86%) rename {contributing => content/contributing}/creating_references.adoc (95%) rename {contributing => content/contributing}/dco.adoc (93%) rename {contributing => content/contributing}/forking_no_member.adoc (88%) rename {contributing => content/contributing}/licensing.adoc (73%) rename {contributing => content/contributing}/naming_conventions.adoc (91%) rename {contributing => content/contributing}/reporting_issues.adoc (84%) rename {contributing => content/contributing}/review_author.adoc (89%) rename {contributing => content/contributing}/review_reviewer.adoc (96%) rename {contributing => content/contributing}/signing_off_commits.adoc (77%) rename {contributing => content/contributing}/start_contributing.adoc (77%) rename {contributing => content/contributing}/writing_commit_messages.adoc (94%) rename {general_docs => content/general_docs}/bibliography.bib (100%) create mode 100644 content/general_docs/changes.adoc rename {general_docs => content/general_docs}/conventions.adoc (85%) rename {general_docs => content/general_docs}/deliverables.adoc (72%) rename {general_docs => content/general_docs}/foreword.adoc (94%) rename {general_docs => content/general_docs}/glossary.adoc (97%) rename {general_docs => content/general_docs}/osi_repos.adoc (93%) rename {general_docs => content/general_docs}/statements.adoc (72%) rename {general_docs => content/general_docs}/versioning.adoc (89%) rename {general_standard => content/general_standard}/relations_to_other_standards.adoc (93%) create mode 100644 content/index.adoc delete mode 100644 general_docs/changes.adoc delete mode 100644 index.adoc create mode 100644 local_build_tools/asciidoctor.bat create mode 100644 local_build_tools/compose.yml create mode 100644 local_build_tools/windows_convert_symlinks(ADMIN).bat diff --git a/.antora/antora.yml b/.antora/antora.yml new file mode 100644 index 00000000..ef7cebf2 --- /dev/null +++ b/.antora/antora.yml @@ -0,0 +1,45 @@ +# Component name (without spaces!). All content repositories with the same component name are merged in Antora. +name: asamosi +# CENTRAL DOCUMENT ONLY!!! Display name of the component. Define only once per component! +title: ASAM OSI +version: + # Update version number accordingly. This is the version for the main branch + main: 'current' + v(*): V$1 + V(*): V$1 + # Update version number accordingly. This is the version for any other activated branch (branch must be added in the generator site.yml!). Schema = 0.0.x- (only works for branches starting with "feature/") + (*): '3.6.0-$1' +# CENTRAL DOCUMENT ONLY!!! First page of the component. Define only once per component! +start_page: specification:index.adoc + +# THE FOLLOWING MAY ONLY DEFINED FOR THE CENTRAL DOCUMENT!!! +asciidoc: # Sets global AsciiDoc attributes that are applied for every page of this component (from all repositories with the same version and component name!) + attributes: + # START - Mandatory ASAM attributes + use-antora-rules: true + THIS_STANDARD: ASAM OSI® + asciidoc-resources: general:ROOT:partial$asciidoc-resources + partials-path: partial$ + root-path: page$ + appendix-caption: Annex + appendix-offset: 1 + asam-terminology: v0.0.1@ASAM_Terminology:ROOT:partial$terms_and_definitions_opendrive.adoc + topicdir: topics + reusedir: reuse + imagesoutdir: ./images/generated_images + images_open_simulation_interface: 'interface:' + doc_open_simulation_interface: 'interface:' + doc_osi-sensor-model-packaging: 'sensor-model:' + # page-download-links: [["opendrive-examples-and-use-cases.zip", "Examples and use cases"],["xsd_schema.zip","XSD schema files"],["ASAM_OpenDRIVE.EAP","Enterprise Architect file"],["example-implementations.zip","Implementation examples"]] + + # END - Mandatory ASAM attributes + +nav: +- modules/specification/nav_introduction.adoc +- modules/interface/nav.adoc +- modules/sensor-model/nav.adoc +- modules/specification/nav_contribution.adoc +# Add more items here as required. +# Recommended: One navigation file per document/repository! +# Recommended: Name your module (folder) as your document type, e.g. "standard" or "concept" or "topic-guidelines" +# Format: - modules//.adoc \ No newline at end of file diff --git a/.antora/modules/specification/images b/.antora/modules/specification/images new file mode 120000 index 00000000..e4084286 --- /dev/null +++ b/.antora/modules/specification/images @@ -0,0 +1 @@ +../../../content/_static/images \ No newline at end of file diff --git a/.antora/modules/specification/nav_contribution.adoc b/.antora/modules/specification/nav_contribution.adoc new file mode 100644 index 00000000..7ef3c1ae --- /dev/null +++ b/.antora/modules/specification/nav_contribution.adoc @@ -0,0 +1,76 @@ +* Contributing to ASAM OSI + +** xref:contributing/start_contributing.adoc[] + +** xref:contributing/reporting_issues.adoc[] + +** Contributing changes + +*** xref:contributing/licensing.adoc[] + +*** xref:contributing/dco.adoc[] + +*** xref:contributing/signing_off_commits.adoc[] + +*** xref:contributing/writing_commit_messages.adoc[] + +*** xref:contributing/contribution_rules.adoc[] + +*** xref:contributing/naming_conventions.adoc[] + +*** xref:contributing/branching_member.adoc[] + +*** xref:contributing/forking_no_member.adoc[] + +// *** xref:contributing/contributing_docs.adoc[] + +*** xref:contributing/commenting_messages.adoc[] + +*** xref:contributing/commenting_fields_enums.adoc[] + +*** xref:contributing/creating_references.adoc[] + +// *** xref:contributing/creating_images.adoc[] + +** Reviewing contributions + +*** xref:contributing/review_author.adoc[] + +*** xref:contributing/review_reviewer.adoc[] + +* xref:general_docs/glossary.adoc[] + + +[bibliography] +* Bibliography +bibliography::[] + +[appendix] +* Release Notes + +:sectnums!: +** xref:appendix/releases/v03.04.adoc[] +:sectnums!: +** xref:appendix/releases/v03.03.01.adoc[] +:sectnums!: +** xref:appendix/releases/v03.03.00.adoc[] +:sectnums!: +** xref:appendix/releases/v03.02.adoc[] +:sectnums!: +** xref:appendix/releases/v03.01.02.adoc[] +:sectnums!: +** xref:appendix/releases/v03.01.01.adoc[] +:sectnums!: +** xref:appendix/releases/v03.01.00.adoc[] +:sectnums!: +** xref:appendix/releases/v03.00.01.adoc[] +:sectnums!: +** xref:appendix/releases/v03.00.00.adoc[] +:sectnums!: +** xref:appendix/releases/v02.02.01.adoc[] +:sectnums!: +** xref:appendix/releases/v02.02.00.adoc[] +:sectnums!: +** xref:appendix/releases/v02.01.adoc[] +:sectnums!: +** xref:appendix/releases/v02.00.adoc[] diff --git a/.antora/modules/specification/nav_introduction.adoc b/.antora/modules/specification/nav_introduction.adoc new file mode 100644 index 00000000..93ae8db2 --- /dev/null +++ b/.antora/modules/specification/nav_introduction.adoc @@ -0,0 +1,9 @@ + +* Introduction +** xref:general_docs/changes.adoc[] +** xref:general_docs/deliverables.adoc[] +** xref:general_docs/osi_repos.adoc[] +** xref:general_docs/statements.adoc[] +** xref:general_docs/conventions.adoc[] +** xref:general_docs/versioning.adoc[] +** xref:general_standard/relations_to_other_standards.adoc[] diff --git a/.antora/modules/specification/pages b/.antora/modules/specification/pages new file mode 120000 index 00000000..f0bfb077 --- /dev/null +++ b/.antora/modules/specification/pages @@ -0,0 +1 @@ +../../../content \ No newline at end of file diff --git a/content/_config.adoc b/content/_config.adoc new file mode 100644 index 00000000..13ea7a1c --- /dev/null +++ b/content/_config.adoc @@ -0,0 +1,57 @@ + +// This file contains AsciiDoc attributes that shall be used in every AsciiDoc file. +// NOTE: Its content is only applied for Asciidoctor! +// If the same attribute is defined in the antora.yml (without @), the antora.yml definition takes precedence for Antora. + +ifndef::root-path[:root-path: ./] + +:partials-path: {root-path}../_additional_content +:asciidoc-resources: ../asciidoc-resources +:appendix-caption: Annex + +// ifndef::use-antora-rules,include-only-once[] +ifndef::include-only-once[] +:GLO_VAR_STA_ASAM_OpenCRG: ASAM OpenCRG +:glo_var_sta_asam_opencrg: {GLO_VAR_STA_ASAM_OpenCRG} +:GLO_VAR_STA_ASAM_OpenDRIVE: ASAM OpenDRIVE +:GLO_VAR_STA_ASAM_OpenLABEL: ASAM OpenLABEL +:GLO_VAR_STA_ASAM_OpenODD: ASAM OpenODD +:GLO_VAR_STA_ASAM_OSI: ASAM OSI® +:GLO_VAR_STA_ASAM_OpenSCENARIO: ASAM OpenSCENARIO +:GLO_VAR_STA_ASAM_OpenXOntology: ASAM OpenXOntology +:GLO_VAR_STA_BSI_PAS_1883: BSI PAS 1883 +:revnumber: --localbuild-- +:revdate: {docdate} +:bibtex-file: ./content/general_docs/bibliography.bib +// Replace PLACEHOLDER with the name of your standard, e.g. OpenDRIVE +:THIS_STANDARD: {GLO_VAR_STA_ASAM_OSI} +:asam-terminology: https://code.asam.net/common/asam-terminology/-/raw/main/terms_and_definitions_opendrive.adoc +:imagesdir: {root-path}/_static/images +:include-only-once: true +:topicdir: topics +:reusedir: reuse +:toclevels: 3 +:xrefstyle: full +:images_open_simulation_interface: ./open-simulation-interface/doc/images +// :images_osi-sensor-model-packaging: ./osi-sensor-model-packaging/doc/images +:doc_open_simulation_interface: ../../open-simulation-interface/doc/ +:doc_osi-sensor-model-packaging: ../../osi-sensor-model-packaging/doc/ +// Since a document spanning multiple repos is rendered here, the pathing regarding images is a bit involved. +// We create a variable for every repo that is included. It point to the repo in question. +// If the subrepo is rendered seperatly, then the variable is set to just "./images" with ifdef. +// Please note that this variable has to used in all image includes. Includes here have to use "image::./images..." +// :images_osi_sensor_model_packaging: ./osi-sensor-model-packaging/doc/images // example +:imagesoutdir: ./images/generated_images + +endif::[] + +ifndef::use-antora-rules[] +include::{asciidoc-resources}/preamble.adoc[] +endif::[] + +ifdef::env-gitlab[] +:relfilesuffix: .adoc +endif::[] + + +:asciidoc-resources: ../0_resources \ No newline at end of file diff --git a/_static/images/osi-context.png b/content/_static/images/osi-context.png similarity index 100% rename from _static/images/osi-context.png rename to content/_static/images/osi-context.png diff --git a/_static/images/osi-traffic-participant-advanced.png b/content/_static/images/osi-traffic-participant-advanced.png similarity index 100% rename from _static/images/osi-traffic-participant-advanced.png rename to content/_static/images/osi-traffic-participant-advanced.png diff --git a/_static/images/osi-traffic-participant-principle.png b/content/_static/images/osi-traffic-participant-principle.png similarity index 100% rename from _static/images/osi-traffic-participant-principle.png rename to content/_static/images/osi-traffic-participant-principle.png diff --git a/_static/images/osi-traffic-participant-use-case-1.png b/content/_static/images/osi-traffic-participant-use-case-1.png similarity index 100% rename from _static/images/osi-traffic-participant-use-case-1.png rename to content/_static/images/osi-traffic-participant-use-case-1.png diff --git a/_static/images/osi-traffic-participant-use-case-2.png b/content/_static/images/osi-traffic-participant-use-case-2.png similarity index 100% rename from _static/images/osi-traffic-participant-use-case-2.png rename to content/_static/images/osi-traffic-participant-use-case-2.png diff --git a/_static/images/osi-traffic-participant-use-case-3.png b/content/_static/images/osi-traffic-participant-use-case-3.png similarity index 100% rename from _static/images/osi-traffic-participant-use-case-3.png rename to content/_static/images/osi-traffic-participant-use-case-3.png diff --git a/_static/images/osi-traffic-participant-use-case-4.png b/content/_static/images/osi-traffic-participant-use-case-4.png similarity index 100% rename from _static/images/osi-traffic-participant-use-case-4.png rename to content/_static/images/osi-traffic-participant-use-case-4.png diff --git a/_static/images/osilogo.png b/content/_static/images/osilogo.png similarity index 100% rename from _static/images/osilogo.png rename to content/_static/images/osilogo.png diff --git a/appendix/releases/compatibility.adoc b/content/appendix/releases/compatibility.adoc similarity index 86% rename from appendix/releases/compatibility.adoc rename to content/appendix/releases/compatibility.adoc index c81058eb..1a6aed77 100644 --- a/appendix/releases/compatibility.adoc +++ b/content/appendix/releases/compatibility.adoc @@ -1,5 +1,10 @@ = Compatibility +ifndef::include-only-once[] +:root-path: ../ +include::{root-path}_config.adoc[] +endif::[] + Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Et malesuada fames ac turpis egestas. Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi. diff --git a/appendix/releases/v02.00.adoc b/content/appendix/releases/v02.00.adoc similarity index 92% rename from appendix/releases/v02.00.adoc rename to content/appendix/releases/v02.00.adoc index 65d0d0a3..09c11ddd 100644 --- a/appendix/releases/v02.00.adoc +++ b/content/appendix/releases/v02.00.adoc @@ -1,7 +1,11 @@ +:reftext: v2.0.0 - OSI Initial Commit += https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v2.0.0[{reftext}] -= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v2.0.0[v2.0.0 - OSI Initial Commit] - +ifndef::include-only-once[] +:root-path: ../ +include::{root-path}_config.adoc[] +endif::[] This is the initial version of the Open Simulation Interface (OSI). diff --git a/appendix/releases/v02.01.adoc b/content/appendix/releases/v02.01.adoc similarity index 73% rename from appendix/releases/v02.01.adoc rename to content/appendix/releases/v02.01.adoc index 13d2d25d..0520cca9 100644 --- a/appendix/releases/v02.01.adoc +++ b/content/appendix/releases/v02.01.adoc @@ -1,6 +1,11 @@ +:reftext: v2.1.0 - OSI "Agile Andretti" += https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v2.1.0[{reftext}] -= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v2.1.0[v2.1.0 - OSI "Agile Andretti"] +ifndef::include-only-once[] +:root-path: ../ +include::{root-path}_config.adoc[] +endif::[] *Purpose* diff --git a/appendix/releases/v02.02.adoc b/content/appendix/releases/v02.02.00.adoc similarity index 53% rename from appendix/releases/v02.02.adoc rename to content/appendix/releases/v02.02.00.adoc index 5ea3a328..f90a175a 100644 --- a/appendix/releases/v02.02.adoc +++ b/content/appendix/releases/v02.02.00.adoc @@ -1,6 +1,11 @@ +:reftext: v2.2.0 - OSI "Brave Brabham" += https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v2.2.0[{reftext}] -= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v2.2.0[v2.2.0 - OSI "Brave Brabham"] +ifndef::include-only-once[] +:root-path: ../ +include::{root-path}_config.adoc[] +endif::[] *Purpose* @@ -15,14 +20,3 @@ This release focuses on optimizing the build process and documentation. * Redefined precipitation and added a fog definition to the environmental conditions message. * Added layer id to low level point cloud data. * Reworked large parts of the build instructions in the WIKI. - -= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v2.2.1[v2.2.1 - OSI "Brave Brabham", Update 1] - -*Purpose* - -This release focuses on optimizing the build process and ensures the proper installation of different versions of OSI on a single system. - -*https://github.com/OpenSimulationInterface/open-simulation-interface/compare/maintenance/v2.2.x[Content/Changes]* - -* Allowing several OSI versions on the same computer. -* Improves CI builds to also test the installation cmake targets for proper completion. diff --git a/content/appendix/releases/v02.02.01.adoc b/content/appendix/releases/v02.02.01.adoc new file mode 100644 index 00000000..aaadccbb --- /dev/null +++ b/content/appendix/releases/v02.02.01.adoc @@ -0,0 +1,17 @@ + +:reftext: v2.2.1 - OSI "Brave Brabham", Update 1 += https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v2.2.1[{reftext}] + +ifndef::include-only-once[] +:root-path: ../ +include::{root-path}_config.adoc[] +endif::[] + +*Purpose* + +This release focuses on optimizing the build process and ensures the proper installation of different versions of OSI on a single system. + +*https://github.com/OpenSimulationInterface/open-simulation-interface/compare/maintenance/v2.2.x[Content/Changes]* + +* Allowing several OSI versions on the same computer. +* Improves CI builds to also test the installation cmake targets for proper completion. diff --git a/appendix/releases/v03.00.adoc b/content/appendix/releases/v03.00.00.adoc similarity index 68% rename from appendix/releases/v03.00.adoc rename to content/appendix/releases/v03.00.00.adoc index dde9b0fd..b83c7d15 100644 --- a/appendix/releases/v03.00.adoc +++ b/content/appendix/releases/v03.00.00.adoc @@ -1,6 +1,11 @@ +:reftext: v3.0.0 - OSI "Cosmic Coulthard" += https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.0.0[{reftext}] -= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.0.0[v3.0.0 - OSI "Cosmic Coulthard"] +ifndef::include-only-once[] +:root-path: ../ +include::{root-path}_config.adoc[] +endif::[] *Purpose* @@ -37,23 +42,3 @@ We are aligned with the ongoing discussions for the upcoming ISO 23150 cite:[iso * AND MUCH MORE ENJOY!!! https://github.com/OpenSimulationInterface/open-simulation-interface/files/2297162/osi_overview_v2.2_vs_v3.0.pdf>[See for more information the `changelog`] - -= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.0.1[v3.0.1 - OSI "Cosmic Coulthard", Update 1] - -https://www.youtube.com/watch?v=yG0oBPtyNb0[Summertime :)] - -*Purpose* - -This release is a patch reworking parts of the documentation in order to avoid ambiguities and improving the build/installation process of OSI. - -*https://github.com/OpenSimulationInterface/open-simulation-interface/pulls?page=1&q=is%3Apr+is%3Aclosed+milestone%3Av3.0.1[Content/Changes]* - -* Added script to automatically convert the messages from proto2 to proto3 with on the wire compatibility -* cmake enhancements to enable multi-version support of OSI 2 and OSI 3 -* Added Python 3 support -* Clarification of multiple comments -* Added explanatory images in the documentation -* centerline definition improved -* signal_strength definition in LidarSensorView corrected -* FeatureData::ambiguity_id definition clarified -* RadarSensorViewConfiguration::AntennaDiagram::response definition clarified diff --git a/content/appendix/releases/v03.00.01.adoc b/content/appendix/releases/v03.00.01.adoc new file mode 100644 index 00000000..d064d9a8 --- /dev/null +++ b/content/appendix/releases/v03.00.01.adoc @@ -0,0 +1,26 @@ + +:reftext: v3.0.1 - OSI "Cosmic Coulthard", Update 1 += https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.0.1[{reftext}] + +ifndef::include-only-once[] +:root-path: ../ +include::{root-path}_config.adoc[] +endif::[] + +https://www.youtube.com/watch?v=yG0oBPtyNb0[Summertime :)] + +*Purpose* + +This release is a patch reworking parts of the documentation in order to avoid ambiguities and improving the build/installation process of OSI. + +*https://github.com/OpenSimulationInterface/open-simulation-interface/pulls?page=1&q=is%3Apr+is%3Aclosed+milestone%3Av3.0.1[Content/Changes]* + +* Added script to automatically convert the messages from proto2 to proto3 with on the wire compatibility +* cmake enhancements to enable multi-version support of OSI 2 and OSI 3 +* Added Python 3 support +* Clarification of multiple comments +* Added explanatory images in the documentation +* centerline definition improved +* signal_strength definition in LidarSensorView corrected +* FeatureData::ambiguity_id definition clarified +* RadarSensorViewConfiguration::AntennaDiagram::response definition clarified diff --git a/appendix/releases/v03.01.adoc b/content/appendix/releases/v03.01.00.adoc similarity index 55% rename from appendix/releases/v03.01.adoc rename to content/appendix/releases/v03.01.00.adoc index a6450d11..f8cf37fa 100644 --- a/appendix/releases/v03.01.adoc +++ b/content/appendix/releases/v03.01.00.adoc @@ -1,6 +1,11 @@ +:reftext: v3.1.0 - OSI "Dynamic Duncan" += https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.1.0[{reftext}] -= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.1.0[v3.1.0 - OSI "Dynamic Duncan"] +ifndef::include-only-once[] +:root-path: ../ +include::{root-path}_config.adoc[] +endif::[] https://www.youtube.com/watch?v=fu3uA8K6ApQ>[(O SI)lent night] @@ -24,16 +29,3 @@ Trust me - it's amazing! * Added proj4 string for coordinate transformations. * Introduced raster_lidar_proposal from innoviz. * Improved documentation with HTML tables and images for all traffic signs. - -= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.1.1[v3.1.1 - OSI "Dynamic Duncan", Update 1] - -*https://github.com/OpenSimulationInterface/open-simulation-interface/pulls?q=is%3Apr+is%3Aclosed+milestone%3Av3.1.1[Content/Changes]* - -* **Bug Fix**: Changed open_simulation_interface target back from being a static library to a shared library, as before (this reverts an inadvertent change in v3.1.0 from previous releases). -v3.1.0 breaks all users of the shared library (i.e. everyone building on Linux/Unix systems, and even some using the DLL on Windows). - -= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.1.2[v3.1.2 - OSI "Dynamic Duncan", Update 2] - -*https://github.com/OpenSimulationInterface/open-simulation-interface/pulls?q=is%3Apr+is%3Aclosed+milestone%3Av3.1.2[Content/Changes]* - -* **Bugfix**: The version number is now correct in the VERSION file. diff --git a/content/appendix/releases/v03.01.01.adoc b/content/appendix/releases/v03.01.01.adoc new file mode 100644 index 00000000..ecd9dcd3 --- /dev/null +++ b/content/appendix/releases/v03.01.01.adoc @@ -0,0 +1,13 @@ + +:reftext: v3.1.1 - OSI "Dynamic Duncan", Update 1 += https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.1.1[{reftext}] + +ifndef::include-only-once[] +:root-path: ../ +include::{root-path}_config.adoc[] +endif::[] + +*https://github.com/OpenSimulationInterface/open-simulation-interface/pulls?q=is%3Apr+is%3Aclosed+milestone%3Av3.1.1[Content/Changes]* + +* **Bug Fix**: Changed open_simulation_interface target back from being a static library to a shared library, as before (this reverts an inadvertent change in v3.1.0 from previous releases). +v3.1.0 breaks all users of the shared library (i.e. everyone building on Linux/Unix systems, and even some using the DLL on Windows). diff --git a/content/appendix/releases/v03.01.02.adoc b/content/appendix/releases/v03.01.02.adoc new file mode 100644 index 00000000..677c1e33 --- /dev/null +++ b/content/appendix/releases/v03.01.02.adoc @@ -0,0 +1,12 @@ + +:reftext: v3.1.2 - OSI "Dynamic Duncan", Update 2 += https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.1.2[{reftext}] + +ifndef::include-only-once[] +:root-path: ../ +include::{root-path}_config.adoc[] +endif::[] + +*https://github.com/OpenSimulationInterface/open-simulation-interface/pulls?q=is%3Apr+is%3Aclosed+milestone%3Av3.1.2[Content/Changes]* + +* **Bugfix**: The version number is now correct in the VERSION file. diff --git a/appendix/releases/v03.02.adoc b/content/appendix/releases/v03.02.adoc similarity index 93% rename from appendix/releases/v03.02.adoc rename to content/appendix/releases/v03.02.adoc index e783f38c..1bf1ea21 100644 --- a/appendix/releases/v03.02.adoc +++ b/content/appendix/releases/v03.02.adoc @@ -1,6 +1,11 @@ +:reftext: v3.2.0 - OSI "Editorial Eaton" += https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.2.0[{reftext}] -= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.2.0[v3.2.0 - OSI "Editorial Eaton"] +ifndef::include-only-once[] +:root-path: ../ +include::{root-path}_config.adoc[] +endif::[] https://www.youtube.com/watch?v=SJUhlRoBL8M[Think p(OSI)tive!] diff --git a/appendix/releases/v03.03.adoc b/content/appendix/releases/v03.03.00.adoc similarity index 82% rename from appendix/releases/v03.03.adoc rename to content/appendix/releases/v03.03.00.adoc index 633e6e02..0d5f07c5 100644 --- a/appendix/releases/v03.03.adoc +++ b/content/appendix/releases/v03.03.00.adoc @@ -1,6 +1,11 @@ +:reftext: v3.3.0 - OSI "Fabulous Fangio" += https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.3.0[{reftext}] -= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.3.0[v3.3.0 - OSI "Fabulous Fangio"] +ifndef::include-only-once[] +:root-path: ../ +include::{root-path}_config.adoc[] +endif::[] Stay p(OSI)tive! @@ -31,11 +36,3 @@ This minor release highlights the work that has been done on several working pac * Make handling of enums in rules check more robust, especially ones. * Set the default compiler to C++ 11 to support protobuf>3.6. - -= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.3.1[v3.3.1 - OSI "Fabulous Fangio", Update 1] - -*https://github.com/OpenSimulationInterface/open-simulation-interface/milestone/18?closed=1[Content/Changes]* - -* **Bug Fix**: Fixed outdated version information in VERSION file in 3.3.0. -This led to wrong versioning in proto definitions and Doxygen documentation. -* **Bug Fix**: Removed outdated picture in README.md. diff --git a/content/appendix/releases/v03.03.01.adoc b/content/appendix/releases/v03.03.01.adoc new file mode 100644 index 00000000..254fa3d0 --- /dev/null +++ b/content/appendix/releases/v03.03.01.adoc @@ -0,0 +1,14 @@ + +:reftext: v3.3.1 - OSI "Fabulous Fangio", Update 1 += https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.3.1[{reftext}] + +ifndef::include-only-once[] +:root-path: ../ +include::{root-path}_config.adoc[] +endif::[] + +*https://github.com/OpenSimulationInterface/open-simulation-interface/milestone/18?closed=1[Content/Changes]* + +* **Bug Fix**: Fixed outdated version information in VERSION file in 3.3.0. +This led to wrong versioning in proto definitions and Doxygen documentation. +* **Bug Fix**: Removed outdated picture in README.md. diff --git a/appendix/releases/v03.04.adoc b/content/appendix/releases/v03.04.adoc similarity index 93% rename from appendix/releases/v03.04.adoc rename to content/appendix/releases/v03.04.adoc index 69d450c7..260b7679 100644 --- a/appendix/releases/v03.04.adoc +++ b/content/appendix/releases/v03.04.adoc @@ -1,6 +1,11 @@ +:reftext: v3.4.0 - OSI "Gallant Glock" += https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.4.0[{reftext}] -= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.4.0[v3.4.0 - OSI "Gallant Glock"] +ifndef::include-only-once[] +:root-path: ../ +include::{root-path}_config.adoc[] +endif::[] Stay p(OSI)tive! diff --git a/appendix/releases/v03.05.adoc b/content/appendix/releases/v03.05.adoc similarity index 89% rename from appendix/releases/v03.05.adoc rename to content/appendix/releases/v03.05.adoc index b1e270ba..587b256b 100644 --- a/appendix/releases/v03.05.adoc +++ b/content/appendix/releases/v03.05.adoc @@ -1,6 +1,11 @@ +:reftext: v3.5.0 - OSI "Hard-fighting Hunt" += https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.5.0[{reftext}] -= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.5.0[v3.5.0 - OSI "Hard-fighting Hunt"] +ifndef::include-only-once[] +:root-path: ../ +include::{root-path}_config.adoc[] +endif::[] L(OSI)ng is not an option! diff --git a/contributing/branching_member.adoc b/content/contributing/branching_member.adoc similarity index 87% rename from contributing/branching_member.adoc rename to content/contributing/branching_member.adoc index 898e86a2..cae4a1f1 100644 --- a/contributing/branching_member.adoc +++ b/content/contributing/branching_member.adoc @@ -1,5 +1,10 @@ = Branching workflow for member contributors +ifndef::include-only-once[] +:root-path: ../ +include::{root-path}_config.adoc[] +endif::[] + Members of the OSI project can contribute to the ASAM OSI repositories directly. **Prerequisites** @@ -26,5 +31,5 @@ This label indicates that the changes in the pull request can be merged. **Related topics** -- <<_reporting_issues>> -- <<_guidelines_for_contributions>> \ No newline at end of file +- <> +- <> \ No newline at end of file diff --git a/contributing/commenting_fields_enums.adoc b/content/contributing/commenting_fields_enums.adoc similarity index 92% rename from contributing/commenting_fields_enums.adoc rename to content/contributing/commenting_fields_enums.adoc index 24b07ebe..efa734c6 100644 --- a/contributing/commenting_fields_enums.adoc +++ b/content/contributing/commenting_fields_enums.adoc @@ -1,5 +1,11 @@ +[#top-commenting_on_fields_and_enums] = Commenting on fields and enums +ifndef::include-only-once[] +:root-path: ../ +include::{root-path}_config.adoc[] +endif::[] + The {THIS_STANDARD} reference documentation is created using _Doxygen_. The reference documentation's content is generated from comments in the `.proto` files. Follow these steps when creating comments on fields and enums to keep the documentation style consistent. @@ -56,4 +62,4 @@ message EnvironmentalConditions **Related topics** -- <<_guidelines_for_creating_literary_references>> \ No newline at end of file +- <> \ No newline at end of file diff --git a/contributing/commenting_messages.adoc b/content/contributing/commenting_messages.adoc similarity index 90% rename from contributing/commenting_messages.adoc rename to content/contributing/commenting_messages.adoc index 67424c52..2893c06e 100644 --- a/contributing/commenting_messages.adoc +++ b/content/contributing/commenting_messages.adoc @@ -1,5 +1,11 @@ +[#top-commenting_on_messages] = Commenting on messages +ifndef::include-only-once[] +:root-path: ../ +include::{root-path}_config.adoc[] +endif::[] + The {THiS_STANDARD} reference documentation is created using _Doxygen_. The content of the reference documentation is generated from comments in the `.proto` files. Follow these steps when creating comments on messages to keep the documentation style consistent. diff --git a/contributing/contributing_docs.adoc b/content/contributing/contributing_docs.adoc similarity index 86% rename from contributing/contributing_docs.adoc rename to content/contributing/contributing_docs.adoc index de1bd6e6..fefcb0c8 100644 --- a/contributing/contributing_docs.adoc +++ b/content/contributing/contributing_docs.adoc @@ -1,5 +1,10 @@ = Contributing to the documentation +ifndef::include-only-once[] +:root-path: ../ +include::{root-path}_config.adoc[] +endif::[] + Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Et malesuada fames ac turpis egestas. Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi. diff --git a/contributing/contribution_rules.adoc b/content/contributing/contribution_rules.adoc similarity index 72% rename from contributing/contribution_rules.adoc rename to content/contributing/contribution_rules.adoc index 9aea6940..33ee7721 100644 --- a/contributing/contribution_rules.adoc +++ b/content/contributing/contribution_rules.adoc @@ -1,5 +1,11 @@ +[#top-guidelines_for_contributions] = Guidelines for contributions +ifndef::include-only-once[] +:root-path: ../ +include::{root-path}_config.adoc[] +endif::[] + Commit guidelines exist to ensure the transparency and intelligibility of the commit history. {THIS_STANDARD} enforces the following commit guidelines: @@ -15,8 +21,8 @@ Commit guidelines exist to ensure the transparency and intelligibility of the co **Related topics** -- <<_guidelines_for_writing_commit_messages>> -- <<_interface_conventions>> -- <<_commenting_on_messages>> -- <<_commenting_on_fields_and_enums>> -- <<_signing_off_commits>> \ No newline at end of file +- <> +- <> +- <> +- <> +- <> \ No newline at end of file diff --git a/contributing/creating_images.adoc b/content/contributing/creating_images.adoc similarity index 86% rename from contributing/creating_images.adoc rename to content/contributing/creating_images.adoc index ad23656f..7d493ffe 100644 --- a/contributing/creating_images.adoc +++ b/content/contributing/creating_images.adoc @@ -1,5 +1,10 @@ = Creating vector images +ifndef::include-only-once[] +:root-path: ../ +include::{root-path}_config.adoc[] +endif::[] + Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Et malesuada fames ac turpis egestas. Mauris pharetra et ultrices neque ornare aenean euismod elementum nisi. diff --git a/contributing/creating_references.adoc b/content/contributing/creating_references.adoc similarity index 95% rename from contributing/creating_references.adoc rename to content/contributing/creating_references.adoc index e2e41bf4..b0fbbf9c 100644 --- a/contributing/creating_references.adoc +++ b/content/contributing/creating_references.adoc @@ -1,5 +1,11 @@ +[#top-guidelines_for_creating_literary_references] = Guidelines for creating literary references +ifndef::include-only-once[] +:root-path: ../ +include::{root-path}_config.adoc[] +endif::[] + When citing literature in the reference documentation, adhere to the following guidelines: * All sources shall be primary sources. Sources like Wikipedia are not allowed. diff --git a/contributing/dco.adoc b/content/contributing/dco.adoc similarity index 93% rename from contributing/dco.adoc rename to content/contributing/dco.adoc index a43aeba1..64a12605 100644 --- a/contributing/dco.adoc +++ b/content/contributing/dco.adoc @@ -1,5 +1,11 @@ +[#top-developer_certificate_of_origin_dco] = Developer Certificate of Origin (DCO) +ifndef::include-only-once[] +:root-path: ../ +include::{root-path}_config.adoc[] +endif::[] + To make a good-faith effort to ensure licensing criteria are met, the Developer-Certificate-of-Origin (DCO) process shall be followed. When contributing a change, the contributor must agree to the DCO. diff --git a/contributing/forking_no_member.adoc b/content/contributing/forking_no_member.adoc similarity index 88% rename from contributing/forking_no_member.adoc rename to content/contributing/forking_no_member.adoc index 740adfc8..555d8e3f 100644 --- a/contributing/forking_no_member.adoc +++ b/content/contributing/forking_no_member.adoc @@ -1,5 +1,10 @@ = Forking for non-member contributors +ifndef::include-only-once[] +:root-path: ../ +include::{root-path}_config.adoc[] +endif::[] + External contributors must fork the OSI repositories and contribute their changes via a pull request. **Prerequisites** @@ -26,5 +31,5 @@ This label indicates that the changes in the pull request can be merged. **Related topics** -- <<_reporting_issues>> -- <<_guidelines_for_contributions>> \ No newline at end of file +- <> +- <> \ No newline at end of file diff --git a/contributing/licensing.adoc b/content/contributing/licensing.adoc similarity index 73% rename from contributing/licensing.adoc rename to content/contributing/licensing.adoc index 04ee6f46..b44518c7 100644 --- a/contributing/licensing.adoc +++ b/content/contributing/licensing.adoc @@ -1,5 +1,10 @@ = License +ifndef::include-only-once[] +:root-path: ../ +include::{root-path}_config.adoc[] +endif::[] + OSI uses the https://www.mozilla.org/en-US/MPL/2.0/[Mozilla Public License, v. 2.0]. All contributions are released under this license. diff --git a/contributing/naming_conventions.adoc b/content/contributing/naming_conventions.adoc similarity index 91% rename from contributing/naming_conventions.adoc rename to content/contributing/naming_conventions.adoc index 6af2b224..1bb92bc3 100644 --- a/contributing/naming_conventions.adoc +++ b/content/contributing/naming_conventions.adoc @@ -1,5 +1,11 @@ +[#top-interface_conventions] = Interface conventions +ifndef::include-only-once[] +:root-path: ../ +include::{root-path}_config.adoc[] +endif::[] + OSI messages, enums, field messages, and field enums shall comply with OSI interface conventions. These conventions ensure that message definitions and the corresponding classes are consistently named and easy to read. diff --git a/contributing/reporting_issues.adoc b/content/contributing/reporting_issues.adoc similarity index 84% rename from contributing/reporting_issues.adoc rename to content/contributing/reporting_issues.adoc index d0f5588e..6496d38a 100644 --- a/contributing/reporting_issues.adoc +++ b/content/contributing/reporting_issues.adoc @@ -1,5 +1,11 @@ +[#top-reporting_issues] = Reporting issues +ifndef::include-only-once[] +:root-path: ../ +include::{root-path}_config.adoc[] +endif::[] + Reporting issues is a simple way of contributing to OSI. **Prerequisites** @@ -22,4 +28,4 @@ Reporting issues is a simple way of contributing to OSI. **Related topics** -- <<_asam_osi_repositories>> \ No newline at end of file +- <> \ No newline at end of file diff --git a/contributing/review_author.adoc b/content/contributing/review_author.adoc similarity index 89% rename from contributing/review_author.adoc rename to content/contributing/review_author.adoc index a4201781..5f2b5440 100644 --- a/contributing/review_author.adoc +++ b/content/contributing/review_author.adoc @@ -1,5 +1,10 @@ = Review guidelines for authors +ifndef::include-only-once[] +:root-path: ../ +include::{root-path}_config.adoc[] +endif::[] + Code review enhances the quality of the code and reduces the likelihood of introducing new bugs in the code base. Reviewing code is a technical discussion, not an exam. It is a common effort to learn from each other. diff --git a/contributing/review_reviewer.adoc b/content/contributing/review_reviewer.adoc similarity index 96% rename from contributing/review_reviewer.adoc rename to content/contributing/review_reviewer.adoc index cc42a775..19abc15b 100644 --- a/contributing/review_reviewer.adoc +++ b/content/contributing/review_reviewer.adoc @@ -1,5 +1,10 @@ = Review guidelines for reviewers +ifndef::include-only-once[] +:root-path: ../ +include::{root-path}_config.adoc[] +endif::[] + Code reviews can be challenging at times. Follow these suggestions when reviewing code to avoid common pitfalls: diff --git a/contributing/signing_off_commits.adoc b/content/contributing/signing_off_commits.adoc similarity index 77% rename from contributing/signing_off_commits.adoc rename to content/contributing/signing_off_commits.adoc index 1195d96d..cf5a541a 100644 --- a/contributing/signing_off_commits.adoc +++ b/content/contributing/signing_off_commits.adoc @@ -1,5 +1,11 @@ +[#top-signing_off_commits] = Signing off commits +ifndef::include-only-once[] +:root-path: ../ +include::{root-path}_config.adoc[] +endif::[] + Contributing to OSI projects, it is necessary to agree to the Developer Certificate of Origin (DCO). Contributors agree to the DCO by adding a ``Signed-off-by`` statement to the commit message. @@ -18,4 +24,4 @@ git commit -m "Commit message" -s **Related topics** -- <<_developer_certificate_of_origin_dco>> \ No newline at end of file +- <> \ No newline at end of file diff --git a/contributing/start_contributing.adoc b/content/contributing/start_contributing.adoc similarity index 77% rename from contributing/start_contributing.adoc rename to content/contributing/start_contributing.adoc index 8d826be5..e0cc2793 100644 --- a/contributing/start_contributing.adoc +++ b/content/contributing/start_contributing.adoc @@ -1,5 +1,10 @@ = Getting started with contributing +ifndef::include-only-once[] +:root-path: ../ +include::{root-path}_config.adoc[] +endif::[] + Before you start, familiarize yourself with {THIS_STANDARD} and how to contribute by reading this documentation and the reference documentation of {THIS_STANDARD}. You should also familiarize yourself with the following topics: diff --git a/contributing/writing_commit_messages.adoc b/content/contributing/writing_commit_messages.adoc similarity index 94% rename from contributing/writing_commit_messages.adoc rename to content/contributing/writing_commit_messages.adoc index ad0408cd..eb53189d 100644 --- a/contributing/writing_commit_messages.adoc +++ b/content/contributing/writing_commit_messages.adoc @@ -1,5 +1,11 @@ +[#top-guidelines_for_writing_commit_messages] = Guidelines for writing commit messages +ifndef::include-only-once[] +:root-path: ../ +include::{root-path}_config.adoc[] +endif::[] + Apart from a sign-off message, {THIS_STANDARD} requires commit messages to follow a specific format. This format enables other people to understand the motivation behind your commits more easily. OSI enforces these requirements only for commits to protected branches. diff --git a/general_docs/bibliography.bib b/content/general_docs/bibliography.bib similarity index 100% rename from general_docs/bibliography.bib rename to content/general_docs/bibliography.bib diff --git a/content/general_docs/changes.adoc b/content/general_docs/changes.adoc new file mode 100644 index 00000000..caed677c --- /dev/null +++ b/content/general_docs/changes.adoc @@ -0,0 +1,8 @@ += What has changed + +ifndef::include-only-once[] +:root-path: ../ +include::{root-path}_config.adoc[] +endif::[] + +include::../appendix/releases/v03.04.adoc[lines=14..50] diff --git a/general_docs/conventions.adoc b/content/general_docs/conventions.adoc similarity index 85% rename from general_docs/conventions.adoc rename to content/general_docs/conventions.adoc index caf60766..4cfc1c1c 100644 --- a/general_docs/conventions.adoc +++ b/content/general_docs/conventions.adoc @@ -1,9 +1,14 @@ = Conventions +ifndef::include-only-once[] +:root-path: ../ +include::{root-path}_config.adoc[] +endif::[] + == Units Every field has its own unit that is defined in the proto files. -For more information, see <<_commenting_on_fields_and_enums, the example in the contribution guidelines.>> +For more information, see <> [#sec-273d9649-afab-45d3-b6c9-73c0e64971a0] include::../{asciidoc-resources}/modal_verbs.adoc[leveloffset=+1] diff --git a/general_docs/deliverables.adoc b/content/general_docs/deliverables.adoc similarity index 72% rename from general_docs/deliverables.adoc rename to content/general_docs/deliverables.adoc index 9f996037..1f06fe85 100644 --- a/general_docs/deliverables.adoc +++ b/content/general_docs/deliverables.adoc @@ -1,5 +1,10 @@ = Deliverables +ifndef::include-only-once[] +:root-path: ../ +include::{root-path}_config.adoc[] +endif::[] + The following deliverables are provided for {THIS_STANDARD}: * User guide, that is, this document (partly normative) @@ -9,5 +14,5 @@ The following deliverables are provided for {THIS_STANDARD}: **Related topics** -- <<_normative_and_non_normative_statements>> +- <> - <> \ No newline at end of file diff --git a/general_docs/foreword.adoc b/content/general_docs/foreword.adoc similarity index 94% rename from general_docs/foreword.adoc rename to content/general_docs/foreword.adoc index 3c632f68..bedaaf8c 100644 --- a/general_docs/foreword.adoc +++ b/content/general_docs/foreword.adoc @@ -1,5 +1,10 @@ = Foreword +ifndef::include-only-once[] +:root-path: ../ +include::{root-path}_config.adoc[] +endif::[] + The {THIS_STANDARD} (Open Simulation Interface) is a specification for interfaces between models and components of a distributed simulation. OSI is strongly focused on the environmental perception of automated driving functions. diff --git a/general_docs/glossary.adoc b/content/general_docs/glossary.adoc similarity index 97% rename from general_docs/glossary.adoc rename to content/general_docs/glossary.adoc index 888a5c7f..22c783f6 100644 --- a/general_docs/glossary.adoc +++ b/content/general_docs/glossary.adoc @@ -1,6 +1,11 @@ [glossary] = Terms and definitions +ifndef::include-only-once[] +:root-path: ../ +include::{root-path}_config.adoc[] +endif::[] + //Writing style adopted from https://www.iso.org/glossary.html Co-simulation:: Type of Functional Mockup Unit (FMU). + diff --git a/general_docs/osi_repos.adoc b/content/general_docs/osi_repos.adoc similarity index 93% rename from general_docs/osi_repos.adoc rename to content/general_docs/osi_repos.adoc index 52b5ed6d..cc1a6ba7 100644 --- a/general_docs/osi_repos.adoc +++ b/content/general_docs/osi_repos.adoc @@ -1,4 +1,7 @@ - +ifndef::include-only-once[] +:root-path: ../ +include::{root-path}_config.adoc[] +endif::[] [#top-repositories] = {THIS_STANDARD} repositories diff --git a/general_docs/statements.adoc b/content/general_docs/statements.adoc similarity index 72% rename from general_docs/statements.adoc rename to content/general_docs/statements.adoc index 674a8aba..8bc5399e 100644 --- a/general_docs/statements.adoc +++ b/content/general_docs/statements.adoc @@ -1,9 +1,15 @@ +[#top-normative_and_non_normative_statements] = Normative and non-normative statements +ifndef::include-only-once[] +:root-path: ../ +include::{root-path}_config.adoc[] +endif::[] + This specification uses a standard information structure. The following rules apply regarding normativity of the different sections: -* Statements expressed as requirements, permissions, or prohibitions according to the use of modal verbs, as defined in <>, are normative. +* Statements expressed as requirements, permissions, or prohibitions according to the use of modal verbs, as defined in <>, are normative. * Rules in "Rules" sections are normative. * .proto files are normative. * Examples, use case descriptions, and instructions are non-normative. diff --git a/general_docs/versioning.adoc b/content/general_docs/versioning.adoc similarity index 89% rename from general_docs/versioning.adoc rename to content/general_docs/versioning.adoc index f8d347b4..63d9cb77 100644 --- a/general_docs/versioning.adoc +++ b/content/general_docs/versioning.adoc @@ -1,8 +1,13 @@ = Versioning and compatibility +ifndef::include-only-once[] +:root-path: ../ +include::{root-path}_config.adoc[] +endif::[] + The version number is defined in `InterfaceVersion::version_number` in `osi_version.proto` as the field's default value. -OSI uses https://semver.org/[Semantic Versioning]. +OSI uses https://semver.org/[Semantic Versioning^]. Major:: A change in the major version makes the code and recorded proto messages incompatible. diff --git a/general_standard/relations_to_other_standards.adoc b/content/general_standard/relations_to_other_standards.adoc similarity index 93% rename from general_standard/relations_to_other_standards.adoc rename to content/general_standard/relations_to_other_standards.adoc index 7319e6c9..19a67486 100644 --- a/general_standard/relations_to_other_standards.adoc +++ b/content/general_standard/relations_to_other_standards.adoc @@ -1,5 +1,10 @@ = Relationships with other standards +ifndef::include-only-once[] +:root-path: ../ +include::{root-path}_config.adoc[] +endif::[] + == Positioning of {THIS_STANDARD} within ASAM activities {THIS_STANDARD} (Open Simulation Interface) is part of the ASAM simulation standards that focus on simulation data for the automotive environment. diff --git a/content/index.adoc b/content/index.adoc new file mode 100644 index 00000000..1968227b --- /dev/null +++ b/content/index.adoc @@ -0,0 +1,25 @@ +:root-path: ./ +include::{root-path}_config.adoc[] += {THIS_STANDARD} (Open Simulation Interface) + +[IMPORTANT] +.Disclaimer +==== +This document is the copyrighted property of ASAM e.V. +Any use is limited to the scope described in the https://www.asam.net/license[license terms]. +==== + +ifndef::use-antora-rules[] +<<< +toc::[] + +endif::[] + +[preface] +include::./general_docs/foreword.adoc[leveloffset=+1] + + +ifndef::use-antora-rules[] + + +endif::[] diff --git a/general_docs/changes.adoc b/general_docs/changes.adoc deleted file mode 100644 index fb94e1a7..00000000 --- a/general_docs/changes.adoc +++ /dev/null @@ -1,3 +0,0 @@ -= What has changed - -include::../appendix/releases/v03.04.adoc[lines=14..50] diff --git a/index.adoc b/index.adoc deleted file mode 100644 index 29318b62..00000000 --- a/index.adoc +++ /dev/null @@ -1,148 +0,0 @@ - -:THIS_STANDARD: ASAM OSI® - -:asciidoc-resources: ./asciidoc-resources -include::{asciidoc-resources}/preamble.adoc[] - -:revnumber: --localbuild-- -:revdate: {docdate} - -:topicdir: topics -:reusedir: reuse - -// as decided in the project -:toclevels: 3 -:xrefstyle: full - -//embed images into html -:imagesdir: . -// Since a document spanning multiple repos is rendered here, the pathing regarding images is a bit involved. -// We create a variable for every repo that is included. It point to the repo in question. -// If the subrepo is rendered seperatly, then the variable is set to just "./images" with ifdef. -// Please note that this variable has to used in all image includes. Includes here have to use "image::./images..." -:images_open_simulation_interface: ./open-simulation-interface/doc/images -// :images_osi_sensor_model_packaging: ./osi-sensor-model-packaging/doc/images // example - -:imagesoutdir: ./images/generated_images - -// attention: bibtex requires pathing relative to asciidoc command, not main.adoc! -:bibtex-file: ./general_docs/bibliography.bib - - - -= {THIS_STANDARD} (Open Simulation Interface) - -[IMPORTANT] -.Disclaimer -==== -This document is the copyrighted property of ASAM e.V. -Any use is limited to the scope described in the https://www.asam.net/license[license terms]. -==== - -<<< -toc::[] - - -[foreword] -include::./general_docs/foreword.adoc[leveloffset=+1] - -== Introduction - -include::./general_docs/changes.adoc[leveloffset=+2] - -include::./general_docs/deliverables.adoc[leveloffset=+2] - -include::./general_docs/osi_repos.adoc[leveloffset=+2] - -include::./general_docs/statements.adoc[leveloffset=+2] - -include::./general_docs/conventions.adoc[leveloffset=+2] - -include::./general_docs/versioning.adoc[leveloffset=+2] - -include::./general_standard/relations_to_other_standards.adoc[leveloffset=+2] - -// START: including the documentation of other osi repositories - -include::./open-simulation-interface/doc/open-simulation-interface_user_guide.adoc[leveloffset=+1] - -include::./osi-sensor-model-packaging/doc/osi-sensor-model-packaging_spec.adoc[leveloffset=+1] - -// osi-validation and osi-visualizer are considered supplementary tooling that is not normative. They are therefore not part of the ASAM standard release. -// include::./osi-validation/doc/osi-validator_user_guide.adoc[leveloffset=+1,opts=optional] - -// include::./osi-visualizer/doc/osi-visualizer_user_guide.adoc[leveloffset=+1,opts=optional] - -// proto2cpp is an tooling that is internally used to create the DOXYGEN documentation. It doc shall not the part of the OSI specification. -// include::./proto2cpp/doc/proto2ccp_user_guide.adoc[leveloffset=+1] - -// END: including the documentation of other osi repositories - -== Contributing to ASAM OSI - -include::./contributing/start_contributing.adoc[leveloffset=+2] - -include::./contributing/reporting_issues.adoc[leveloffset=+2] - -=== Contributing changes - -include::./contributing/licensing.adoc[leveloffset=+3] - -include::./contributing/dco.adoc[leveloffset=+3] - -include::./contributing/signing_off_commits.adoc[leveloffset=+3] - -include::./contributing/writing_commit_messages.adoc[leveloffset=+3] - -include::./contributing/contribution_rules.adoc[leveloffset=+3] - -include::./contributing/naming_conventions.adoc[leveloffset=+3] - -include::./contributing/branching_member.adoc[leveloffset=+3] - -include::./contributing/forking_no_member.adoc[leveloffset=+3] - -//include::./contributing/contributing_docs.adoc[leveloffset=+3] - -include::./contributing/commenting_messages.adoc[leveloffset=+3] - -include::./contributing/commenting_fields_enums.adoc[leveloffset=+3] - -include::./contributing/creating_references.adoc[leveloffset=+3] - -//include::./contributing/creating_images.adoc[leveloffset=+3] - -=== Reviewing contributions - -include::./contributing/review_author.adoc[leveloffset=+3] - -include::./contributing/review_reviewer.adoc[leveloffset=+3] - - -include::./general_docs/glossary.adoc[leveloffset=+1] - - -[bibliography] -== Bibliography -bibliography::[] - -[appendix] -== Release Notes -:sectnums!: - -include::./appendix/releases/v03.04.adoc[leveloffset=+2] -include::./appendix/releases/v03.03.adoc[leveloffset=+2] -include::./appendix/releases/v03.02.adoc[leveloffset=+2] -include::./appendix/releases/v03.01.adoc[leveloffset=+2] -include::./appendix/releases/v03.00.adoc[leveloffset=+2] -include::./appendix/releases/v02.02.adoc[leveloffset=+2] -include::./appendix/releases/v02.01.adoc[leveloffset=+2] -include::./appendix/releases/v02.00.adoc[leveloffset=+2] - - - - - - - - diff --git a/local_build_tools/asciidoctor.bat b/local_build_tools/asciidoctor.bat new file mode 100644 index 00000000..a5dd7d2a --- /dev/null +++ b/local_build_tools/asciidoctor.bat @@ -0,0 +1,3 @@ +@ECHO OFF +docker-compose up -d +PAUSE \ No newline at end of file diff --git a/local_build_tools/compose.yml b/local_build_tools/compose.yml new file mode 100644 index 00000000..a37849c1 --- /dev/null +++ b/local_build_tools/compose.yml @@ -0,0 +1,8 @@ +version: "2" + +services: + asciidoctor: + image: asciidoctor/docker-asciidoctor + volumes: + - ../:/documents + entrypoint: asciidoctor --failure-level WARN -r asciidoctor-kroki -a mathjax -r asciidoctor-bibtex --trace content/index.adoc -o local_build_tools/HTML_content_local_build.html \ No newline at end of file diff --git a/local_build_tools/windows_convert_symlinks(ADMIN).bat b/local_build_tools/windows_convert_symlinks(ADMIN).bat new file mode 100644 index 00000000..a6c0463b --- /dev/null +++ b/local_build_tools/windows_convert_symlinks(ADMIN).bat @@ -0,0 +1,13 @@ +@ECHO OFF +SET Targetpath=..\.antora\modules\specification +SET Symlinkroot=..\..\.. + +mklink /D %Targetpath%\images %Symlinkroot%\content\_static\images + +mklink /D %Targetpath%\pages %Symlinkroot%\content + +@REM mklink /D %Targetpath%\partials %Symlinkroot%\_additional_content + +@REM mklink /D %Targetpath%\attachments %Symlinkroot%\_attachments + +PAUSE \ No newline at end of file From b17f563369ebe040c1aa2a383085358bd80115cc Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Tue, 6 Sep 2022 18:10:27 +0200 Subject: [PATCH 02/48] Fixed config and updated links --- .antora/antora.yml | 1 - content/_config.adoc | 5 +---- content/contributing/review_author.adoc | 6 +++--- content/general_docs/conventions.adoc | 2 +- 4 files changed, 5 insertions(+), 9 deletions(-) diff --git a/.antora/antora.yml b/.antora/antora.yml index ef7cebf2..2b07cb5e 100644 --- a/.antora/antora.yml +++ b/.antora/antora.yml @@ -18,7 +18,6 @@ asciidoc: # Sets global AsciiDoc attributes that are applied for every page of t # START - Mandatory ASAM attributes use-antora-rules: true THIS_STANDARD: ASAM OSI® - asciidoc-resources: general:ROOT:partial$asciidoc-resources partials-path: partial$ root-path: page$ appendix-caption: Annex diff --git a/content/_config.adoc b/content/_config.adoc index 13ea7a1c..6b90579e 100644 --- a/content/_config.adoc +++ b/content/_config.adoc @@ -6,7 +6,7 @@ ifndef::root-path[:root-path: ./] :partials-path: {root-path}../_additional_content -:asciidoc-resources: ../asciidoc-resources +:asciidoc-resources: {root-path}../asciidoc-resources :appendix-caption: Annex // ifndef::use-antora-rules,include-only-once[] @@ -52,6 +52,3 @@ endif::[] ifdef::env-gitlab[] :relfilesuffix: .adoc endif::[] - - -:asciidoc-resources: ../0_resources \ No newline at end of file diff --git a/content/contributing/review_author.adoc b/content/contributing/review_author.adoc index 5f2b5440..a25c3e6c 100644 --- a/content/contributing/review_author.adoc +++ b/content/contributing/review_author.adoc @@ -20,6 +20,6 @@ Before asking for a review, make sure your changes meet the following requiremen **Related topics** -- <<_interface_conventions>> -- <<_guidelines_for_writing_commit_messages>> -- <<_signing_off_commits>> +- <> +- <> +- <> diff --git a/content/general_docs/conventions.adoc b/content/general_docs/conventions.adoc index 4cfc1c1c..259e32fc 100644 --- a/content/general_docs/conventions.adoc +++ b/content/general_docs/conventions.adoc @@ -11,7 +11,7 @@ Every field has its own unit that is defined in the proto files. For more information, see <> [#sec-273d9649-afab-45d3-b6c9-73c0e64971a0] -include::../{asciidoc-resources}/modal_verbs.adoc[leveloffset=+1] +include::{asciidoc-resources}/modal_verbs.adoc[leveloffset=+1] == Typographic conventions From d19b5e1ce6f1e31086e9fb432849653145c51515 Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Wed, 7 Sep 2022 14:32:16 +0200 Subject: [PATCH 03/48] Added THIS_STANDARD_TITLE for osi_repos.adoc --- content/general_docs/osi_repos.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/general_docs/osi_repos.adoc b/content/general_docs/osi_repos.adoc index cc1a6ba7..dfbeebd6 100644 --- a/content/general_docs/osi_repos.adoc +++ b/content/general_docs/osi_repos.adoc @@ -3,7 +3,7 @@ ifndef::include-only-once[] include::{root-path}_config.adoc[] endif::[] [#top-repositories] -= {THIS_STANDARD} repositories += {THIS_STANDARD_TITLE} repositories {THIS_STANDARD} is an open-source standardization project. OSI and its supporting tools are developed publicly on GitHub. From 2fa6032be22b786345f3bf052792373699a9c242 Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Wed, 7 Sep 2022 14:32:32 +0200 Subject: [PATCH 04/48] Switched to tags for releases --- content/appendix/releases/v03.04.adoc | 4 +++- content/general_docs/changes.adoc | 2 +- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/content/appendix/releases/v03.04.adoc b/content/appendix/releases/v03.04.adoc index 260b7679..fab83774 100644 --- a/content/appendix/releases/v03.04.adoc +++ b/content/appendix/releases/v03.04.adoc @@ -16,6 +16,7 @@ Moreover, this release provides a first glance on the on-going efforts for OSI's *https://github.com/OpenSimulationInterface/open-simulation-interface/milestone/14?closed=1[Content/Changes]* +//tag::content[] Documentation Updates:: - Updated the documentation's structure and migrated it to AsciiDoc. - Updated the description of OSI's top level messages. @@ -34,4 +35,5 @@ Technical Updates:: - Extended LidarDetection message under feature data to include echo pulse width information to better support several sensor outputs that are currently on the market. - Extended OSI to include a generic external reference message to enable traceability for data from other standards, including other ASAM OpenX standards. - Added support for using OSI with Flatbuffers encoding for OSI messages instead of ProtoBuffers, in preparation for a potential switch of default encoding in a future major release. -- Extended LaneBoundary message to include additional types, to better align with ASAM OpenDRIVE. \ No newline at end of file +- Extended LaneBoundary message to include additional types, to better align with ASAM OpenDRIVE. +//end::content[] diff --git a/content/general_docs/changes.adoc b/content/general_docs/changes.adoc index caed677c..22ddd1c0 100644 --- a/content/general_docs/changes.adoc +++ b/content/general_docs/changes.adoc @@ -5,4 +5,4 @@ ifndef::include-only-once[] include::{root-path}_config.adoc[] endif::[] -include::../appendix/releases/v03.04.adoc[lines=14..50] +include::../appendix/releases/v03.04.adoc[tag=content] From 8e5123255993a397d5e24c0968e25ad68789bf07 Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Wed, 7 Sep 2022 14:32:47 +0200 Subject: [PATCH 05/48] Moved bib to file --- .antora/antora.yml | 8 +++++++- .antora/modules/specification/nav_contribution.adoc | 3 +-- content/general_docs/bibliography.adoc | 6 ++++++ 3 files changed, 14 insertions(+), 3 deletions(-) create mode 100644 content/general_docs/bibliography.adoc diff --git a/.antora/antora.yml b/.antora/antora.yml index 2b07cb5e..6b48bcb8 100644 --- a/.antora/antora.yml +++ b/.antora/antora.yml @@ -17,7 +17,8 @@ asciidoc: # Sets global AsciiDoc attributes that are applied for every page of t attributes: # START - Mandatory ASAM attributes use-antora-rules: true - THIS_STANDARD: ASAM OSI® + THIS_STANDARD: ASAM OSI® + THIS_STANDARD_TITLE: 'ASAM OSI^®^' partials-path: partial$ root-path: page$ appendix-caption: Annex @@ -32,12 +33,17 @@ asciidoc: # Sets global AsciiDoc attributes that are applied for every page of t # page-download-links: [["opendrive-examples-and-use-cases.zip", "Examples and use cases"],["xsd_schema.zip","XSD schema files"],["ASAM_OpenDRIVE.EAP","Enterprise Architect file"],["example-implementations.zip","Implementation examples"]] # END - Mandatory ASAM attributes + # doxygen_interface_version: "v3.2.0" # The interface version that needs to be retrieved + # doxygen_document_date: "01.01.2000" # The date associated with the document (optional) + doxygen_module: "gen" # The module in which the output is stored + # doxygen_module_path: "gen" # Path within module nav: - modules/specification/nav_introduction.adoc - modules/interface/nav.adoc - modules/sensor-model/nav.adoc - modules/specification/nav_contribution.adoc +- modules/gen/doxynav.adoc # Add more items here as required. # Recommended: One navigation file per document/repository! # Recommended: Name your module (folder) as your document type, e.g. "standard" or "concept" or "topic-guidelines" diff --git a/.antora/modules/specification/nav_contribution.adoc b/.antora/modules/specification/nav_contribution.adoc index 7ef3c1ae..3ef2c0d4 100644 --- a/.antora/modules/specification/nav_contribution.adoc +++ b/.antora/modules/specification/nav_contribution.adoc @@ -42,8 +42,7 @@ [bibliography] -* Bibliography -bibliography::[] +* xref:general_docs/bibliography.adoc[] [appendix] * Release Notes diff --git a/content/general_docs/bibliography.adoc b/content/general_docs/bibliography.adoc new file mode 100644 index 00000000..a2a6f7dc --- /dev/null +++ b/content/general_docs/bibliography.adoc @@ -0,0 +1,6 @@ +ifndef::include-only-once[] +:root-path: ../ +include::{root-path}_config.adoc[] +endif::[] += Bibliography +bibliography::[] \ No newline at end of file From eb101348737c72c7dad6e7cc1e6c6a9ed79d6019 Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Wed, 7 Sep 2022 16:18:27 +0200 Subject: [PATCH 06/48] Fixed link to included partial from separate repo --- content/general_docs/statements.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/general_docs/statements.adoc b/content/general_docs/statements.adoc index 8bc5399e..0565bcdc 100644 --- a/content/general_docs/statements.adoc +++ b/content/general_docs/statements.adoc @@ -9,7 +9,7 @@ endif::[] This specification uses a standard information structure. The following rules apply regarding normativity of the different sections: -* Statements expressed as requirements, permissions, or prohibitions according to the use of modal verbs, as defined in <>, are normative. +* Statements expressed as requirements, permissions, or prohibitions according to the use of modal verbs, as defined in <>, are normative. * Rules in "Rules" sections are normative. * .proto files are normative. * Examples, use case descriptions, and instructions are non-normative. From cfda76ae564716df5e7486e39e2930e0314cb4bc Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Wed, 7 Sep 2022 16:20:00 +0200 Subject: [PATCH 07/48] Removed appendix offset --- .antora/antora.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.antora/antora.yml b/.antora/antora.yml index 6b48bcb8..acb607a7 100644 --- a/.antora/antora.yml +++ b/.antora/antora.yml @@ -22,7 +22,7 @@ asciidoc: # Sets global AsciiDoc attributes that are applied for every page of t partials-path: partial$ root-path: page$ appendix-caption: Annex - appendix-offset: 1 + # appendix-offset: 1 asam-terminology: v0.0.1@ASAM_Terminology:ROOT:partial$terms_and_definitions_opendrive.adoc topicdir: topics reusedir: reuse From 0d4618a894b62ab6f3eb4aae6ce341011a9ea4ba Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Wed, 7 Sep 2022 17:29:00 +0200 Subject: [PATCH 08/48] Added tab anchors --- content/general_docs/conventions.adoc | 1 + 1 file changed, 1 insertion(+) diff --git a/content/general_docs/conventions.adoc b/content/general_docs/conventions.adoc index 259e32fc..76a027f5 100644 --- a/content/general_docs/conventions.adoc +++ b/content/general_docs/conventions.adoc @@ -17,6 +17,7 @@ include::{asciidoc-resources}/modal_verbs.adoc[leveloffset=+1] This documentation uses the following typographical conventions: +[#tab-typographical-conventions] .Typographical conventions [%header, cols=2*] |=== From 9f59f105ecc23add5c9a7066ceca6aa0f127ef9e Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Wed, 7 Sep 2022 17:29:09 +0200 Subject: [PATCH 09/48] Added separate loft nav file --- .antora/antora.yml | 1 + .antora/modules/specification/nav_loft.adoc | 0 2 files changed, 1 insertion(+) create mode 100644 .antora/modules/specification/nav_loft.adoc diff --git a/.antora/antora.yml b/.antora/antora.yml index acb607a7..55f2cbfd 100644 --- a/.antora/antora.yml +++ b/.antora/antora.yml @@ -44,6 +44,7 @@ nav: - modules/sensor-model/nav.adoc - modules/specification/nav_contribution.adoc - modules/gen/doxynav.adoc +- modules/specification/nav_loft.adoc # Add more items here as required. # Recommended: One navigation file per document/repository! # Recommended: Name your module (folder) as your document type, e.g. "standard" or "concept" or "topic-guidelines" diff --git a/.antora/modules/specification/nav_loft.adoc b/.antora/modules/specification/nav_loft.adoc new file mode 100644 index 00000000..e69de29b From d65907bb29b4469aba56cf49efb4e8a959bf076d Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Thu, 8 Sep 2022 14:37:17 +0200 Subject: [PATCH 10/48] Updated feedback button feature --- content/_config.adoc | 5 +++-- content/appendix/releases/compatibility.adoc | 5 ++--- content/appendix/releases/v02.00.adoc | 8 +++----- content/appendix/releases/v02.01.adoc | 8 +++----- content/appendix/releases/v02.02.00.adoc | 8 +++----- content/appendix/releases/v02.02.01.adoc | 8 +++----- content/appendix/releases/v03.00.00.adoc | 8 +++----- content/appendix/releases/v03.00.01.adoc | 8 +++----- content/appendix/releases/v03.01.00.adoc | 8 +++----- content/appendix/releases/v03.01.01.adoc | 8 +++----- content/appendix/releases/v03.01.02.adoc | 8 +++----- content/appendix/releases/v03.02.adoc | 8 +++----- content/appendix/releases/v03.03.00.adoc | 8 +++----- content/appendix/releases/v03.03.01.adoc | 8 +++----- content/appendix/releases/v03.04.adoc | 8 +++----- content/appendix/releases/v03.05.adoc | 8 +++----- content/contributing/branching_member.adoc | 3 +-- content/contributing/commenting_fields_enums.adoc | 5 ++--- content/contributing/commenting_messages.adoc | 5 ++--- content/contributing/contributing_docs.adoc | 3 +-- content/contributing/contribution_rules.adoc | 5 ++--- content/contributing/creating_images.adoc | 3 +-- content/contributing/creating_references.adoc | 5 ++--- content/contributing/dco.adoc | 5 ++--- content/contributing/forking_no_member.adoc | 3 +-- content/contributing/licensing.adoc | 3 +-- content/contributing/naming_conventions.adoc | 5 ++--- content/contributing/reporting_issues.adoc | 5 ++--- content/contributing/review_author.adoc | 3 +-- content/contributing/review_reviewer.adoc | 3 +-- content/contributing/signing_off_commits.adoc | 5 ++--- content/contributing/start_contributing.adoc | 3 +-- content/contributing/writing_commit_messages.adoc | 5 ++--- content/general_docs/changes.adoc | 3 +-- content/general_docs/conventions.adoc | 3 +-- content/general_docs/deliverables.adoc | 3 +-- content/general_docs/foreword.adoc | 3 +-- content/general_docs/glossary.adoc | 5 ++--- content/general_docs/statements.adoc | 6 +++--- content/general_docs/versioning.adoc | 3 +-- .../general_standard/relations_to_other_standards.adoc | 3 +-- 41 files changed, 84 insertions(+), 136 deletions(-) diff --git a/content/_config.adoc b/content/_config.adoc index 6b90579e..29f434f7 100644 --- a/content/_config.adoc +++ b/content/_config.adoc @@ -5,8 +5,8 @@ ifndef::root-path[:root-path: ./] -:partials-path: {root-path}../_additional_content -:asciidoc-resources: {root-path}../asciidoc-resources +// :asciidoc-resources: {root-path}../asciidoc-resources +:asciidoc-resources: ../asciidoc-resources :appendix-caption: Annex // ifndef::use-antora-rules,include-only-once[] @@ -42,6 +42,7 @@ ifndef::include-only-once[] // Please note that this variable has to used in all image includes. Includes here have to use "image::./images..." // :images_osi_sensor_model_packaging: ./osi-sensor-model-packaging/doc/images // example :imagesoutdir: ./images/generated_images +:page-feedbackurl: https://github.com/OpenSimulationInterface/osi-documentation/issues/new endif::[] diff --git a/content/appendix/releases/compatibility.adoc b/content/appendix/releases/compatibility.adoc index 1a6aed77..73571095 100644 --- a/content/appendix/releases/compatibility.adoc +++ b/content/appendix/releases/compatibility.adoc @@ -1,9 +1,8 @@ -= Compatibility - ifndef::include-only-once[] -:root-path: ../ +:root-path: ../../ include::{root-path}_config.adoc[] endif::[] += Compatibility Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Et malesuada fames ac turpis egestas. diff --git a/content/appendix/releases/v02.00.adoc b/content/appendix/releases/v02.00.adoc index 09c11ddd..2d5fe079 100644 --- a/content/appendix/releases/v02.00.adoc +++ b/content/appendix/releases/v02.00.adoc @@ -1,11 +1,9 @@ - -:reftext: v2.0.0 - OSI Initial Commit -= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v2.0.0[{reftext}] - ifndef::include-only-once[] -:root-path: ../ +:root-path: ../../ include::{root-path}_config.adoc[] endif::[] +:reftext: v2.0.0 - OSI Initial Commit += https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v2.0.0[{reftext}] This is the initial version of the Open Simulation Interface (OSI). diff --git a/content/appendix/releases/v02.01.adoc b/content/appendix/releases/v02.01.adoc index 0520cca9..fc0546a3 100644 --- a/content/appendix/releases/v02.01.adoc +++ b/content/appendix/releases/v02.01.adoc @@ -1,11 +1,9 @@ - -:reftext: v2.1.0 - OSI "Agile Andretti" -= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v2.1.0[{reftext}] - ifndef::include-only-once[] -:root-path: ../ +:root-path: ../../ include::{root-path}_config.adoc[] endif::[] +:reftext: v2.1.0 - OSI "Agile Andretti" += https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v2.1.0[{reftext}] *Purpose* diff --git a/content/appendix/releases/v02.02.00.adoc b/content/appendix/releases/v02.02.00.adoc index f90a175a..6389f366 100644 --- a/content/appendix/releases/v02.02.00.adoc +++ b/content/appendix/releases/v02.02.00.adoc @@ -1,11 +1,9 @@ - -:reftext: v2.2.0 - OSI "Brave Brabham" -= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v2.2.0[{reftext}] - ifndef::include-only-once[] -:root-path: ../ +:root-path: ../../ include::{root-path}_config.adoc[] endif::[] +:reftext: v2.2.0 - OSI "Brave Brabham" += https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v2.2.0[{reftext}] *Purpose* diff --git a/content/appendix/releases/v02.02.01.adoc b/content/appendix/releases/v02.02.01.adoc index aaadccbb..cba5b58b 100644 --- a/content/appendix/releases/v02.02.01.adoc +++ b/content/appendix/releases/v02.02.01.adoc @@ -1,11 +1,9 @@ - -:reftext: v2.2.1 - OSI "Brave Brabham", Update 1 -= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v2.2.1[{reftext}] - ifndef::include-only-once[] -:root-path: ../ +:root-path: ../../ include::{root-path}_config.adoc[] endif::[] +:reftext: v2.2.1 - OSI "Brave Brabham", Update 1 += https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v2.2.1[{reftext}] *Purpose* diff --git a/content/appendix/releases/v03.00.00.adoc b/content/appendix/releases/v03.00.00.adoc index b83c7d15..021d4a48 100644 --- a/content/appendix/releases/v03.00.00.adoc +++ b/content/appendix/releases/v03.00.00.adoc @@ -1,11 +1,9 @@ - -:reftext: v3.0.0 - OSI "Cosmic Coulthard" -= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.0.0[{reftext}] - ifndef::include-only-once[] -:root-path: ../ +:root-path: ../../ include::{root-path}_config.adoc[] endif::[] +:reftext: v3.0.0 - OSI "Cosmic Coulthard" += https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.0.0[{reftext}] *Purpose* diff --git a/content/appendix/releases/v03.00.01.adoc b/content/appendix/releases/v03.00.01.adoc index d064d9a8..947ec08c 100644 --- a/content/appendix/releases/v03.00.01.adoc +++ b/content/appendix/releases/v03.00.01.adoc @@ -1,11 +1,9 @@ - -:reftext: v3.0.1 - OSI "Cosmic Coulthard", Update 1 -= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.0.1[{reftext}] - ifndef::include-only-once[] -:root-path: ../ +:root-path: ../../ include::{root-path}_config.adoc[] endif::[] +:reftext: v3.0.1 - OSI "Cosmic Coulthard", Update 1 += https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.0.1[{reftext}] https://www.youtube.com/watch?v=yG0oBPtyNb0[Summertime :)] diff --git a/content/appendix/releases/v03.01.00.adoc b/content/appendix/releases/v03.01.00.adoc index f8cf37fa..23034150 100644 --- a/content/appendix/releases/v03.01.00.adoc +++ b/content/appendix/releases/v03.01.00.adoc @@ -1,11 +1,9 @@ - -:reftext: v3.1.0 - OSI "Dynamic Duncan" -= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.1.0[{reftext}] - ifndef::include-only-once[] -:root-path: ../ +:root-path: ../../ include::{root-path}_config.adoc[] endif::[] +:reftext: v3.1.0 - OSI "Dynamic Duncan" += https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.1.0[{reftext}] https://www.youtube.com/watch?v=fu3uA8K6ApQ>[(O SI)lent night] diff --git a/content/appendix/releases/v03.01.01.adoc b/content/appendix/releases/v03.01.01.adoc index ecd9dcd3..a491de5c 100644 --- a/content/appendix/releases/v03.01.01.adoc +++ b/content/appendix/releases/v03.01.01.adoc @@ -1,11 +1,9 @@ - -:reftext: v3.1.1 - OSI "Dynamic Duncan", Update 1 -= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.1.1[{reftext}] - ifndef::include-only-once[] -:root-path: ../ +:root-path: ../../ include::{root-path}_config.adoc[] endif::[] +:reftext: v3.1.1 - OSI "Dynamic Duncan", Update 1 += https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.1.1[{reftext}] *https://github.com/OpenSimulationInterface/open-simulation-interface/pulls?q=is%3Apr+is%3Aclosed+milestone%3Av3.1.1[Content/Changes]* diff --git a/content/appendix/releases/v03.01.02.adoc b/content/appendix/releases/v03.01.02.adoc index 677c1e33..4f496b66 100644 --- a/content/appendix/releases/v03.01.02.adoc +++ b/content/appendix/releases/v03.01.02.adoc @@ -1,11 +1,9 @@ - -:reftext: v3.1.2 - OSI "Dynamic Duncan", Update 2 -= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.1.2[{reftext}] - ifndef::include-only-once[] -:root-path: ../ +:root-path: ../../ include::{root-path}_config.adoc[] endif::[] +:reftext: v3.1.2 - OSI "Dynamic Duncan", Update 2 += https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.1.2[{reftext}] *https://github.com/OpenSimulationInterface/open-simulation-interface/pulls?q=is%3Apr+is%3Aclosed+milestone%3Av3.1.2[Content/Changes]* diff --git a/content/appendix/releases/v03.02.adoc b/content/appendix/releases/v03.02.adoc index 1bf1ea21..9baf0743 100644 --- a/content/appendix/releases/v03.02.adoc +++ b/content/appendix/releases/v03.02.adoc @@ -1,11 +1,9 @@ - -:reftext: v3.2.0 - OSI "Editorial Eaton" -= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.2.0[{reftext}] - ifndef::include-only-once[] -:root-path: ../ +:root-path: ../../ include::{root-path}_config.adoc[] endif::[] +:reftext: v3.2.0 - OSI "Editorial Eaton" += https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.2.0[{reftext}] https://www.youtube.com/watch?v=SJUhlRoBL8M[Think p(OSI)tive!] diff --git a/content/appendix/releases/v03.03.00.adoc b/content/appendix/releases/v03.03.00.adoc index 0d5f07c5..325a01d3 100644 --- a/content/appendix/releases/v03.03.00.adoc +++ b/content/appendix/releases/v03.03.00.adoc @@ -1,11 +1,9 @@ - -:reftext: v3.3.0 - OSI "Fabulous Fangio" -= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.3.0[{reftext}] - ifndef::include-only-once[] -:root-path: ../ +:root-path: ../../ include::{root-path}_config.adoc[] endif::[] +:reftext: v3.3.0 - OSI "Fabulous Fangio" += https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.3.0[{reftext}] Stay p(OSI)tive! diff --git a/content/appendix/releases/v03.03.01.adoc b/content/appendix/releases/v03.03.01.adoc index 254fa3d0..97b51bed 100644 --- a/content/appendix/releases/v03.03.01.adoc +++ b/content/appendix/releases/v03.03.01.adoc @@ -1,11 +1,9 @@ - -:reftext: v3.3.1 - OSI "Fabulous Fangio", Update 1 -= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.3.1[{reftext}] - ifndef::include-only-once[] -:root-path: ../ +:root-path: ../../ include::{root-path}_config.adoc[] endif::[] +:reftext: v3.3.1 - OSI "Fabulous Fangio", Update 1 += https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.3.1[{reftext}] *https://github.com/OpenSimulationInterface/open-simulation-interface/milestone/18?closed=1[Content/Changes]* diff --git a/content/appendix/releases/v03.04.adoc b/content/appendix/releases/v03.04.adoc index fab83774..0116bb70 100644 --- a/content/appendix/releases/v03.04.adoc +++ b/content/appendix/releases/v03.04.adoc @@ -1,11 +1,9 @@ - -:reftext: v3.4.0 - OSI "Gallant Glock" -= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.4.0[{reftext}] - ifndef::include-only-once[] -:root-path: ../ +:root-path: ../../ include::{root-path}_config.adoc[] endif::[] +:reftext: v3.4.0 - OSI "Gallant Glock" += https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.4.0[{reftext}] Stay p(OSI)tive! diff --git a/content/appendix/releases/v03.05.adoc b/content/appendix/releases/v03.05.adoc index 587b256b..ff3a769f 100644 --- a/content/appendix/releases/v03.05.adoc +++ b/content/appendix/releases/v03.05.adoc @@ -1,11 +1,9 @@ - -:reftext: v3.5.0 - OSI "Hard-fighting Hunt" -= https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.5.0[{reftext}] - ifndef::include-only-once[] -:root-path: ../ +:root-path: ../../ include::{root-path}_config.adoc[] endif::[] +:reftext: v3.5.0 - OSI "Hard-fighting Hunt" += https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.5.0[{reftext}] L(OSI)ng is not an option! diff --git a/content/contributing/branching_member.adoc b/content/contributing/branching_member.adoc index cae4a1f1..3f924c94 100644 --- a/content/contributing/branching_member.adoc +++ b/content/contributing/branching_member.adoc @@ -1,9 +1,8 @@ -= Branching workflow for member contributors - ifndef::include-only-once[] :root-path: ../ include::{root-path}_config.adoc[] endif::[] += Branching workflow for member contributors Members of the OSI project can contribute to the ASAM OSI repositories directly. diff --git a/content/contributing/commenting_fields_enums.adoc b/content/contributing/commenting_fields_enums.adoc index efa734c6..7f8649ae 100644 --- a/content/contributing/commenting_fields_enums.adoc +++ b/content/contributing/commenting_fields_enums.adoc @@ -1,10 +1,9 @@ -[#top-commenting_on_fields_and_enums] -= Commenting on fields and enums - ifndef::include-only-once[] :root-path: ../ include::{root-path}_config.adoc[] endif::[] +[#top-commenting_on_fields_and_enums] += Commenting on fields and enums The {THIS_STANDARD} reference documentation is created using _Doxygen_. The reference documentation's content is generated from comments in the `.proto` files. diff --git a/content/contributing/commenting_messages.adoc b/content/contributing/commenting_messages.adoc index 2893c06e..73e18c1a 100644 --- a/content/contributing/commenting_messages.adoc +++ b/content/contributing/commenting_messages.adoc @@ -1,10 +1,9 @@ -[#top-commenting_on_messages] -= Commenting on messages - ifndef::include-only-once[] :root-path: ../ include::{root-path}_config.adoc[] endif::[] +[#top-commenting_on_messages] += Commenting on messages The {THiS_STANDARD} reference documentation is created using _Doxygen_. The content of the reference documentation is generated from comments in the `.proto` files. diff --git a/content/contributing/contributing_docs.adoc b/content/contributing/contributing_docs.adoc index fefcb0c8..bf05bac4 100644 --- a/content/contributing/contributing_docs.adoc +++ b/content/contributing/contributing_docs.adoc @@ -1,9 +1,8 @@ -= Contributing to the documentation - ifndef::include-only-once[] :root-path: ../ include::{root-path}_config.adoc[] endif::[] += Contributing to the documentation Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Et malesuada fames ac turpis egestas. diff --git a/content/contributing/contribution_rules.adoc b/content/contributing/contribution_rules.adoc index 33ee7721..13e6b07e 100644 --- a/content/contributing/contribution_rules.adoc +++ b/content/contributing/contribution_rules.adoc @@ -1,10 +1,9 @@ -[#top-guidelines_for_contributions] -= Guidelines for contributions - ifndef::include-only-once[] :root-path: ../ include::{root-path}_config.adoc[] endif::[] +[#top-guidelines_for_contributions] += Guidelines for contributions Commit guidelines exist to ensure the transparency and intelligibility of the commit history. {THIS_STANDARD} enforces the following commit guidelines: diff --git a/content/contributing/creating_images.adoc b/content/contributing/creating_images.adoc index 7d493ffe..06610a8d 100644 --- a/content/contributing/creating_images.adoc +++ b/content/contributing/creating_images.adoc @@ -1,9 +1,8 @@ -= Creating vector images - ifndef::include-only-once[] :root-path: ../ include::{root-path}_config.adoc[] endif::[] += Creating vector images Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Et malesuada fames ac turpis egestas. diff --git a/content/contributing/creating_references.adoc b/content/contributing/creating_references.adoc index b0fbbf9c..e63deb3f 100644 --- a/content/contributing/creating_references.adoc +++ b/content/contributing/creating_references.adoc @@ -1,10 +1,9 @@ -[#top-guidelines_for_creating_literary_references] -= Guidelines for creating literary references - ifndef::include-only-once[] :root-path: ../ include::{root-path}_config.adoc[] endif::[] +[#top-guidelines_for_creating_literary_references] += Guidelines for creating literary references When citing literature in the reference documentation, adhere to the following guidelines: diff --git a/content/contributing/dco.adoc b/content/contributing/dco.adoc index 64a12605..44b6a1d9 100644 --- a/content/contributing/dco.adoc +++ b/content/contributing/dco.adoc @@ -1,10 +1,9 @@ -[#top-developer_certificate_of_origin_dco] -= Developer Certificate of Origin (DCO) - ifndef::include-only-once[] :root-path: ../ include::{root-path}_config.adoc[] endif::[] +[#top-developer_certificate_of_origin_dco] += Developer Certificate of Origin (DCO) To make a good-faith effort to ensure licensing criteria are met, the Developer-Certificate-of-Origin (DCO) process shall be followed. diff --git a/content/contributing/forking_no_member.adoc b/content/contributing/forking_no_member.adoc index 555d8e3f..a0524980 100644 --- a/content/contributing/forking_no_member.adoc +++ b/content/contributing/forking_no_member.adoc @@ -1,9 +1,8 @@ -= Forking for non-member contributors - ifndef::include-only-once[] :root-path: ../ include::{root-path}_config.adoc[] endif::[] += Forking for non-member contributors External contributors must fork the OSI repositories and contribute their changes via a pull request. diff --git a/content/contributing/licensing.adoc b/content/contributing/licensing.adoc index b44518c7..66885083 100644 --- a/content/contributing/licensing.adoc +++ b/content/contributing/licensing.adoc @@ -1,9 +1,8 @@ -= License - ifndef::include-only-once[] :root-path: ../ include::{root-path}_config.adoc[] endif::[] += License OSI uses the https://www.mozilla.org/en-US/MPL/2.0/[Mozilla Public License, v. 2.0]. All contributions are released under this license. diff --git a/content/contributing/naming_conventions.adoc b/content/contributing/naming_conventions.adoc index 1bb92bc3..344009ef 100644 --- a/content/contributing/naming_conventions.adoc +++ b/content/contributing/naming_conventions.adoc @@ -1,10 +1,9 @@ -[#top-interface_conventions] -= Interface conventions - ifndef::include-only-once[] :root-path: ../ include::{root-path}_config.adoc[] endif::[] +[#top-interface_conventions] += Interface conventions OSI messages, enums, field messages, and field enums shall comply with OSI interface conventions. These conventions ensure that message definitions and the corresponding classes are consistently named and easy to read. diff --git a/content/contributing/reporting_issues.adoc b/content/contributing/reporting_issues.adoc index 6496d38a..3d7af80a 100644 --- a/content/contributing/reporting_issues.adoc +++ b/content/contributing/reporting_issues.adoc @@ -1,10 +1,9 @@ -[#top-reporting_issues] -= Reporting issues - ifndef::include-only-once[] :root-path: ../ include::{root-path}_config.adoc[] endif::[] +[#top-reporting_issues] += Reporting issues Reporting issues is a simple way of contributing to OSI. diff --git a/content/contributing/review_author.adoc b/content/contributing/review_author.adoc index a25c3e6c..af31c483 100644 --- a/content/contributing/review_author.adoc +++ b/content/contributing/review_author.adoc @@ -1,9 +1,8 @@ -= Review guidelines for authors - ifndef::include-only-once[] :root-path: ../ include::{root-path}_config.adoc[] endif::[] += Review guidelines for authors Code review enhances the quality of the code and reduces the likelihood of introducing new bugs in the code base. Reviewing code is a technical discussion, not an exam. diff --git a/content/contributing/review_reviewer.adoc b/content/contributing/review_reviewer.adoc index 19abc15b..f0ded968 100644 --- a/content/contributing/review_reviewer.adoc +++ b/content/contributing/review_reviewer.adoc @@ -1,9 +1,8 @@ -= Review guidelines for reviewers - ifndef::include-only-once[] :root-path: ../ include::{root-path}_config.adoc[] endif::[] += Review guidelines for reviewers Code reviews can be challenging at times. Follow these suggestions when reviewing code to avoid common pitfalls: diff --git a/content/contributing/signing_off_commits.adoc b/content/contributing/signing_off_commits.adoc index cf5a541a..0e67e574 100644 --- a/content/contributing/signing_off_commits.adoc +++ b/content/contributing/signing_off_commits.adoc @@ -1,10 +1,9 @@ -[#top-signing_off_commits] -= Signing off commits - ifndef::include-only-once[] :root-path: ../ include::{root-path}_config.adoc[] endif::[] +[#top-signing_off_commits] += Signing off commits Contributing to OSI projects, it is necessary to agree to the Developer Certificate of Origin (DCO). Contributors agree to the DCO by adding a ``Signed-off-by`` statement to the commit message. diff --git a/content/contributing/start_contributing.adoc b/content/contributing/start_contributing.adoc index e0cc2793..22746dd3 100644 --- a/content/contributing/start_contributing.adoc +++ b/content/contributing/start_contributing.adoc @@ -1,9 +1,8 @@ -= Getting started with contributing - ifndef::include-only-once[] :root-path: ../ include::{root-path}_config.adoc[] endif::[] += Getting started with contributing Before you start, familiarize yourself with {THIS_STANDARD} and how to contribute by reading this documentation and the reference documentation of {THIS_STANDARD}. diff --git a/content/contributing/writing_commit_messages.adoc b/content/contributing/writing_commit_messages.adoc index eb53189d..4c810f94 100644 --- a/content/contributing/writing_commit_messages.adoc +++ b/content/contributing/writing_commit_messages.adoc @@ -1,10 +1,9 @@ -[#top-guidelines_for_writing_commit_messages] -= Guidelines for writing commit messages - ifndef::include-only-once[] :root-path: ../ include::{root-path}_config.adoc[] endif::[] +[#top-guidelines_for_writing_commit_messages] += Guidelines for writing commit messages Apart from a sign-off message, {THIS_STANDARD} requires commit messages to follow a specific format. This format enables other people to understand the motivation behind your commits more easily. diff --git a/content/general_docs/changes.adoc b/content/general_docs/changes.adoc index 22ddd1c0..7c36692c 100644 --- a/content/general_docs/changes.adoc +++ b/content/general_docs/changes.adoc @@ -1,8 +1,7 @@ -= What has changed - ifndef::include-only-once[] :root-path: ../ include::{root-path}_config.adoc[] endif::[] += What has changed include::../appendix/releases/v03.04.adoc[tag=content] diff --git a/content/general_docs/conventions.adoc b/content/general_docs/conventions.adoc index 76a027f5..b9e4c65c 100644 --- a/content/general_docs/conventions.adoc +++ b/content/general_docs/conventions.adoc @@ -1,9 +1,8 @@ -= Conventions - ifndef::include-only-once[] :root-path: ../ include::{root-path}_config.adoc[] endif::[] += Conventions == Units diff --git a/content/general_docs/deliverables.adoc b/content/general_docs/deliverables.adoc index 1f06fe85..b41d2526 100644 --- a/content/general_docs/deliverables.adoc +++ b/content/general_docs/deliverables.adoc @@ -1,9 +1,8 @@ -= Deliverables - ifndef::include-only-once[] :root-path: ../ include::{root-path}_config.adoc[] endif::[] += Deliverables The following deliverables are provided for {THIS_STANDARD}: diff --git a/content/general_docs/foreword.adoc b/content/general_docs/foreword.adoc index bedaaf8c..7350ecec 100644 --- a/content/general_docs/foreword.adoc +++ b/content/general_docs/foreword.adoc @@ -1,9 +1,8 @@ -= Foreword - ifndef::include-only-once[] :root-path: ../ include::{root-path}_config.adoc[] endif::[] += Foreword The {THIS_STANDARD} (Open Simulation Interface) is a specification for interfaces between models and components of a distributed simulation. OSI is strongly focused on the environmental perception of automated driving functions. diff --git a/content/general_docs/glossary.adoc b/content/general_docs/glossary.adoc index 22c783f6..57f29aea 100644 --- a/content/general_docs/glossary.adoc +++ b/content/general_docs/glossary.adoc @@ -1,10 +1,9 @@ -[glossary] -= Terms and definitions - ifndef::include-only-once[] :root-path: ../ include::{root-path}_config.adoc[] endif::[] +[glossary] += Terms and definitions //Writing style adopted from https://www.iso.org/glossary.html Co-simulation:: diff --git a/content/general_docs/statements.adoc b/content/general_docs/statements.adoc index 0565bcdc..bf5231a5 100644 --- a/content/general_docs/statements.adoc +++ b/content/general_docs/statements.adoc @@ -1,10 +1,10 @@ -[#top-normative_and_non_normative_statements] -= Normative and non-normative statements - ifndef::include-only-once[] :root-path: ../ include::{root-path}_config.adoc[] endif::[] +[#top-normative_and_non_normative_statements] += Normative and non-normative statements + This specification uses a standard information structure. The following rules apply regarding normativity of the different sections: diff --git a/content/general_docs/versioning.adoc b/content/general_docs/versioning.adoc index 63d9cb77..8115174b 100644 --- a/content/general_docs/versioning.adoc +++ b/content/general_docs/versioning.adoc @@ -1,9 +1,8 @@ -= Versioning and compatibility - ifndef::include-only-once[] :root-path: ../ include::{root-path}_config.adoc[] endif::[] += Versioning and compatibility The version number is defined in `InterfaceVersion::version_number` in `osi_version.proto` as the field's default value. diff --git a/content/general_standard/relations_to_other_standards.adoc b/content/general_standard/relations_to_other_standards.adoc index 19a67486..d855901c 100644 --- a/content/general_standard/relations_to_other_standards.adoc +++ b/content/general_standard/relations_to_other_standards.adoc @@ -1,9 +1,8 @@ -= Relationships with other standards - ifndef::include-only-once[] :root-path: ../ include::{root-path}_config.adoc[] endif::[] += Relationships with other standards == Positioning of {THIS_STANDARD} within ASAM activities From 8fb4640f5f2a2d56ad12a3dbd344fb3255b517d1 Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Fri, 9 Sep 2022 14:39:13 +0200 Subject: [PATCH 11/48] build: added glossary label to navigation file --- .antora/modules/specification/nav_contribution.adoc | 1 + 1 file changed, 1 insertion(+) diff --git a/.antora/modules/specification/nav_contribution.adoc b/.antora/modules/specification/nav_contribution.adoc index 3ef2c0d4..887e2def 100644 --- a/.antora/modules/specification/nav_contribution.adoc +++ b/.antora/modules/specification/nav_contribution.adoc @@ -38,6 +38,7 @@ *** xref:contributing/review_reviewer.adoc[] +[glossary] * xref:general_docs/glossary.adoc[] From fd6122eb43eec96f9004f2df72d965045abe7395 Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Fri, 9 Sep 2022 14:41:50 +0200 Subject: [PATCH 12/48] build: re-added asciidoctor build content Signed-off-by: Philip Windecker --- content/index.adoc | 95 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 95 insertions(+) diff --git a/content/index.adoc b/content/index.adoc index 1968227b..e3f47ee5 100644 --- a/content/index.adoc +++ b/content/index.adoc @@ -21,5 +21,100 @@ include::./general_docs/foreword.adoc[leveloffset=+1] ifndef::use-antora-rules[] +[foreword] +include::./general_docs/foreword.adoc[leveloffset=+1] + +== Introduction + +include::./general_docs/changes.adoc[leveloffset=+2] + +include::./general_docs/deliverables.adoc[leveloffset=+2] + +include::./general_docs/osi_repos.adoc[leveloffset=+2] + +include::./general_docs/statements.adoc[leveloffset=+2] + +include::./general_docs/conventions.adoc[leveloffset=+2] + +include::./general_docs/versioning.adoc[leveloffset=+2] + +include::./general_standard/relations_to_other_standards.adoc[leveloffset=+2] + +// START: including the documentation of other osi repositories + +include::./open-simulation-interface/doc/open-simulation-interface_user_guide.adoc[leveloffset=+1] + +include::./osi-sensor-model-packaging/doc/osi-sensor-model-packaging_spec.adoc[leveloffset=+1] + +// osi-validation and osi-visualizer are considered supplementary tooling that is not normative. They are therefore not part of the ASAM standard release. +// include::./osi-validation/doc/osi-validator_user_guide.adoc[leveloffset=+1,opts=optional] + +// include::./osi-visualizer/doc/osi-visualizer_user_guide.adoc[leveloffset=+1,opts=optional] + +// proto2cpp is an tooling that is internally used to create the DOXYGEN documentation. It doc shall not the part of the OSI specification. +// include::./proto2cpp/doc/proto2ccp_user_guide.adoc[leveloffset=+1] + +// END: including the documentation of other osi repositories + +== Contributing to ASAM OSI + +include::./contributing/start_contributing.adoc[leveloffset=+2] + +include::./contributing/reporting_issues.adoc[leveloffset=+2] + +=== Contributing changes + +include::./contributing/licensing.adoc[leveloffset=+3] + +include::./contributing/dco.adoc[leveloffset=+3] + +include::./contributing/signing_off_commits.adoc[leveloffset=+3] + +include::./contributing/writing_commit_messages.adoc[leveloffset=+3] + +include::./contributing/contribution_rules.adoc[leveloffset=+3] + +include::./contributing/naming_conventions.adoc[leveloffset=+3] + +include::./contributing/branching_member.adoc[leveloffset=+3] + +include::./contributing/forking_no_member.adoc[leveloffset=+3] + +//include::./contributing/contributing_docs.adoc[leveloffset=+3] + +include::./contributing/commenting_messages.adoc[leveloffset=+3] + +include::./contributing/commenting_fields_enums.adoc[leveloffset=+3] + +include::./contributing/creating_references.adoc[leveloffset=+3] + +//include::./contributing/creating_images.adoc[leveloffset=+3] + +=== Reviewing contributions + +include::./contributing/review_author.adoc[leveloffset=+3] + +include::./contributing/review_reviewer.adoc[leveloffset=+3] + + +include::./general_docs/glossary.adoc[leveloffset=+1] + + +[bibliography] +== Bibliography +bibliography::[] + +[appendix] +== Release Notes +:sectnums!: + +include::./appendix/releases/v03.04.adoc[leveloffset=+2] +include::./appendix/releases/v03.03.adoc[leveloffset=+2] +include::./appendix/releases/v03.02.adoc[leveloffset=+2] +include::./appendix/releases/v03.01.adoc[leveloffset=+2] +include::./appendix/releases/v03.00.adoc[leveloffset=+2] +include::./appendix/releases/v02.02.adoc[leveloffset=+2] +include::./appendix/releases/v02.01.adoc[leveloffset=+2] +include::./appendix/releases/v02.00.adoc[leveloffset=+2] endif::[] From 8988b5af5f7a224fdb06f2bb9a82cefffa21973c Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Fri, 9 Sep 2022 15:27:32 +0200 Subject: [PATCH 13/48] Updated README --- README.adoc | 26 +++++++++++++++++++------- 1 file changed, 19 insertions(+), 7 deletions(-) diff --git a/README.adoc b/README.adoc index 958ac5b5..79050af6 100644 --- a/README.adoc +++ b/README.adoc @@ -1,27 +1,39 @@ = OSI Documentation -This repo hosts the asciidoc-based part of the documentation. -It contains generals parts of the content and a CI-pipeline that renders the document and deploys it the the https://opensimulationinterface.github.io/osi-documentation/[gh-pages of this repo]. +This repo hosts the AsciiDoc-based part of the documentation. +It contains generals parts of the content and a CI-pipeline that renders the document with Asciidoctor and deploys it to the https://opensimulationinterface.github.io/osi-documentation/[gh-pages of this repo]. + +// TODO: Update if Asciidoctor is completely dropped! == ASAM OSI (R) official documentation See the documentation https://opensimulationinterface.github.io/osi-documentation/[here]. -== Build Pipeline - +== Build pipeline +=== Asciidoctor pipeline image::https://github.com/OpenSimulationInterface/osi-documentation/actions/workflows/asciidoc-build.yml/badge.svg[link=https://github.com/OpenSimulationInterface/osi-documentation/actions/workflows/asciidoc-build.yml] +The pipeline collects the documentation from both https://github.com/OpenSimulationInterface/open-simulation-interface[open-simulation-interface] and https://github.com/OpenSimulationInterface/osi-sensor-model-packaging[osi-sensor-model-packaging] and integrates it into skeleton of this repo. +As with all ASAM Asciidoctor projects, the complete document structure is described in the mapping file https://github.com/OpenSimulationInterface/osi-documentation/blob/master/index.adoc[index.adoc]. + +=== Antora pipeline +image::https://github.com/OpenSimulationInterface/osi-antora-generator/actions/workflows/site-build.yml/badge.svg?branch=main[link=https://github.com/OpenSimulationInterface/osi-antora-generator/actions/workflows/site-build.yml] -The pipeline collects the documentation from both https://github.com/OpenSimulationInterface/open-simulation-interface[open-simulation-interface] and https://github.com/OpenSimulationInterface/osi-sensor-model-packaging[osi-sensor-model-packaging] and integrates it into skeleton of this repo. As with all ASAM asciidoc project the complete document structure is described in the mapping file https://github.com/OpenSimulationInterface/osi-documentation/blob/master/index.adoc[index.adoc]. +NOTE: This pipeline runs on https://github.com/OpenSimulationInterface/osi-antora-generator. == How To build and change documentation locally -The following instruction shows how to build the document locally. Take note that the document is build with a version 'localbuild' in the document and filename. +IMPORTANT: These instructions relate ONLY to the Asciidoctor build. +For Antora, check the https://github.com/OpenSimulationInterface/osi-antora-generator[ASAM OSI Antora generator]. + + +The following instructions show how to build the document locally. +Take note that the document is built with a version 'localbuild' in the document and filename. -The instruction should work on Windows, Linux and MacOS. +The instruction should work on Windows, Linux, and MacOS. . *Precondition*: have docker and docker-compose installed. + From d545a98384ab5fbbb24495cde863d52c4283d66e Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Fri, 9 Sep 2022 15:30:03 +0200 Subject: [PATCH 14/48] Added rule for tags with -antora --- .antora/antora.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.antora/antora.yml b/.antora/antora.yml index 55f2cbfd..e5ff959e 100644 --- a/.antora/antora.yml +++ b/.antora/antora.yml @@ -5,6 +5,7 @@ title: ASAM OSI version: # Update version number accordingly. This is the version for the main branch main: 'current' + v(*)-antora: V$1 v(*): V$1 V(*): V$1 # Update version number accordingly. This is the version for any other activated branch (branch must be added in the generator site.yml!). Schema = 0.0.x- (only works for branches starting with "feature/") From b8314cd0db5dd969d2884ff4f92fcbdf03165bde Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Fri, 9 Sep 2022 15:53:08 +0200 Subject: [PATCH 15/48] Unified versioning for repos --- .antora/antora.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.antora/antora.yml b/.antora/antora.yml index e5ff959e..cceda450 100644 --- a/.antora/antora.yml +++ b/.antora/antora.yml @@ -9,7 +9,7 @@ version: v(*): V$1 V(*): V$1 # Update version number accordingly. This is the version for any other activated branch (branch must be added in the generator site.yml!). Schema = 0.0.x- (only works for branches starting with "feature/") - (*): '3.6.0-$1' + (*): 'V3.6.0-$1' # CENTRAL DOCUMENT ONLY!!! First page of the component. Define only once per component! start_page: specification:index.adoc From 4d6d6302ba6d25618e1a60f2aba1845fa1708c64 Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Fri, 9 Sep 2022 16:01:32 +0200 Subject: [PATCH 16/48] build: switch from index.adoc to _config.adoc for combined Asciidoctor/Antora solution --- .github/workflows/asciidoc-build.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/asciidoc-build.yml b/.github/workflows/asciidoc-build.yml index 4e44ea48..fed946c8 100644 --- a/.github/workflows/asciidoc-build.yml +++ b/.github/workflows/asciidoc-build.yml @@ -53,12 +53,12 @@ jobs: # replaces the placeholder for versioning in the main mapping file - name: Apply versioning to Adoc run: | - grep ":revnumber:" index.adoc - sed -i -e "s/--localbuild--/master (${{ steps.get_version.outputs.VERSION }})/" index.adoc - grep ":revnumber:" index.adoc + grep ":revnumber:" _config.adoc + sed -i -e "s/--localbuild--/master (${{ steps.get_version.outputs.VERSION }})/" _config.adoc + grep ":revnumber:" _config.adoc - name: Remove docdate for online hosted document - run: sed 's/^:revdate:.*/:!revdate:/' index.adoc + run: sed 's/^:revdate:.*/:!revdate:/' _config.adoc # run Asciidoctor - name: Build HTML From 95b76bcbc2f238b23870d54e7c78996405008b3a Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Fri, 9 Sep 2022 16:07:07 +0200 Subject: [PATCH 17/48] build: added missing folder names --- .github/workflows/asciidoc-build.yml | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/.github/workflows/asciidoc-build.yml b/.github/workflows/asciidoc-build.yml index fed946c8..6ecf6d64 100644 --- a/.github/workflows/asciidoc-build.yml +++ b/.github/workflows/asciidoc-build.yml @@ -53,18 +53,18 @@ jobs: # replaces the placeholder for versioning in the main mapping file - name: Apply versioning to Adoc run: | - grep ":revnumber:" _config.adoc - sed -i -e "s/--localbuild--/master (${{ steps.get_version.outputs.VERSION }})/" _config.adoc - grep ":revnumber:" _config.adoc + grep ":revnumber:" content/_config.adoc + sed -i -e "s/--localbuild--/main (${{ steps.get_version.outputs.VERSION }})/" content/_config.adoc + grep ":revnumber:" content/_config.adoc - name: Remove docdate for online hosted document - run: sed 's/^:revdate:.*/:!revdate:/' _config.adoc + run: sed 's/^:revdate:.*/:!revdate:/' content/_config.adoc # run Asciidoctor - name: Build HTML uses: avattathil/asciidoctor-action@master with: - program: "asciidoctor -D . --failure-level WARN -r asciidoctor-diagram -r asciidoctor-bibtex -a mathjax --trace --backend=html5 index.adoc -o open-simulation-interface_V${{ steps.get_version.outputs.VERSION }}.html" + program: "asciidoctor -D . --failure-level WARN -r asciidoctor-diagram -r asciidoctor-bibtex -a mathjax --trace --backend=html5 content/index.adoc -o open-simulation-interface_V${{ steps.get_version.outputs.VERSION }}.html" # Upload artifact. - name: Upload HTML Artifact From 3452458ee5b3f1da54f4fec8dabc2401b98799a0 Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Fri, 9 Sep 2022 16:21:57 +0200 Subject: [PATCH 18/48] Fixed _config.adoc for modal verbs and include paths for external repos --- content/_config.adoc | 4 ++-- content/index.adoc | 18 ++++++++++++------ 2 files changed, 14 insertions(+), 8 deletions(-) diff --git a/content/_config.adoc b/content/_config.adoc index 29f434f7..24318f57 100644 --- a/content/_config.adoc +++ b/content/_config.adoc @@ -5,8 +5,8 @@ ifndef::root-path[:root-path: ./] -// :asciidoc-resources: {root-path}../asciidoc-resources -:asciidoc-resources: ../asciidoc-resources +:asciidoc-resources: {root-path}../asciidoc-resources +// :asciidoc-resources: ../asciidoc-resources :appendix-caption: Annex // ifndef::use-antora-rules,include-only-once[] diff --git a/content/index.adoc b/content/index.adoc index e3f47ee5..8ea47a15 100644 --- a/content/index.adoc +++ b/content/index.adoc @@ -42,9 +42,9 @@ include::./general_standard/relations_to_other_standards.adoc[leveloffset=+2] // START: including the documentation of other osi repositories -include::./open-simulation-interface/doc/open-simulation-interface_user_guide.adoc[leveloffset=+1] +include::../open-simulation-interface/doc/open-simulation-interface_user_guide.adoc[leveloffset=+1] -include::./osi-sensor-model-packaging/doc/osi-sensor-model-packaging_spec.adoc[leveloffset=+1] +include::../osi-sensor-model-packaging/doc/osi-sensor-model-packaging_spec.adoc[leveloffset=+1] // osi-validation and osi-visualizer are considered supplementary tooling that is not normative. They are therefore not part of the ASAM standard release. // include::./osi-validation/doc/osi-validator_user_guide.adoc[leveloffset=+1,opts=optional] @@ -108,12 +108,18 @@ bibliography::[] == Release Notes :sectnums!: +include::./appendix/releases/v03.05.adoc[leveloffset=+2] include::./appendix/releases/v03.04.adoc[leveloffset=+2] -include::./appendix/releases/v03.03.adoc[leveloffset=+2] +include::./appendix/releases/v03.03.01.adoc[leveloffset=+2] +include::./appendix/releases/v03.03.00.adoc[leveloffset=+2] include::./appendix/releases/v03.02.adoc[leveloffset=+2] -include::./appendix/releases/v03.01.adoc[leveloffset=+2] -include::./appendix/releases/v03.00.adoc[leveloffset=+2] -include::./appendix/releases/v02.02.adoc[leveloffset=+2] +include::./appendix/releases/v03.01.02.adoc[leveloffset=+2] +include::./appendix/releases/v03.01.01.adoc[leveloffset=+2] +include::./appendix/releases/v03.01.00.adoc[leveloffset=+2] +include::./appendix/releases/v03.00.01.adoc[leveloffset=+2] +include::./appendix/releases/v03.00.00.adoc[leveloffset=+2] +include::./appendix/releases/v02.02.01.adoc[leveloffset=+2] +include::./appendix/releases/v02.02.00.adoc[leveloffset=+2] include::./appendix/releases/v02.01.adoc[leveloffset=+2] include::./appendix/releases/v02.00.adoc[leveloffset=+2] From def071f3b550cb868d23e33930777784115ef209 Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Fri, 9 Sep 2022 16:33:39 +0200 Subject: [PATCH 19/48] Updated handling of asciidoc-resources in index.adoc --- content/index.adoc | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/content/index.adoc b/content/index.adoc index 8ea47a15..241d7e7d 100644 --- a/content/index.adoc +++ b/content/index.adoc @@ -1,4 +1,4 @@ -:root-path: ./ +:root-path: include::{root-path}_config.adoc[] = {THIS_STANDARD} (Open Simulation Interface) @@ -10,6 +10,7 @@ Any use is limited to the scope described in the https://www.asam.net/license[li ==== ifndef::use-antora-rules[] +:asciidoc-resources: ../{asciidoc-resources} <<< toc::[] From 3410b9d303b5f06bf436edbf8993aa2550f86ecc Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Fri, 9 Sep 2022 16:36:38 +0200 Subject: [PATCH 20/48] Updated image link for asciidoc --- content/_config.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/_config.adoc b/content/_config.adoc index 24318f57..3a476052 100644 --- a/content/_config.adoc +++ b/content/_config.adoc @@ -32,8 +32,8 @@ ifndef::include-only-once[] :reusedir: reuse :toclevels: 3 :xrefstyle: full -:images_open_simulation_interface: ./open-simulation-interface/doc/images -// :images_osi-sensor-model-packaging: ./osi-sensor-model-packaging/doc/images +:images_open_simulation_interface: ../open-simulation-interface/doc/images +// :images_osi-sensor-model-packaging: ../osi-sensor-model-packaging/doc/images :doc_open_simulation_interface: ../../open-simulation-interface/doc/ :doc_osi-sensor-model-packaging: ../../osi-sensor-model-packaging/doc/ // Since a document spanning multiple repos is rendered here, the pathing regarding images is a bit involved. From 343f4d163881d3e2d507e4a2a1b0b257dcae11d1 Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Fri, 9 Sep 2022 16:41:41 +0200 Subject: [PATCH 21/48] One more step backwards for images in different repos --- content/_config.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/_config.adoc b/content/_config.adoc index 3a476052..fbf53f80 100644 --- a/content/_config.adoc +++ b/content/_config.adoc @@ -32,8 +32,8 @@ ifndef::include-only-once[] :reusedir: reuse :toclevels: 3 :xrefstyle: full -:images_open_simulation_interface: ../open-simulation-interface/doc/images -// :images_osi-sensor-model-packaging: ../osi-sensor-model-packaging/doc/images +:images_open_simulation_interface: ../../open-simulation-interface/doc/images +// :images_osi-sensor-model-packaging: ../../osi-sensor-model-packaging/doc/images :doc_open_simulation_interface: ../../open-simulation-interface/doc/ :doc_osi-sensor-model-packaging: ../../osi-sensor-model-packaging/doc/ // Since a document spanning multiple repos is rendered here, the pathing regarding images is a bit involved. From 9aa34528bdee0be200426211753d8783eaca6eb2 Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Fri, 9 Sep 2022 16:43:24 +0200 Subject: [PATCH 22/48] Added one more step back for images --- content/_config.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/_config.adoc b/content/_config.adoc index fbf53f80..d54bcb4c 100644 --- a/content/_config.adoc +++ b/content/_config.adoc @@ -32,7 +32,7 @@ ifndef::include-only-once[] :reusedir: reuse :toclevels: 3 :xrefstyle: full -:images_open_simulation_interface: ../../open-simulation-interface/doc/images +:images_open_simulation_interface: ../../../open-simulation-interface/doc/images // :images_osi-sensor-model-packaging: ../../osi-sensor-model-packaging/doc/images :doc_open_simulation_interface: ../../open-simulation-interface/doc/ :doc_osi-sensor-model-packaging: ../../osi-sensor-model-packaging/doc/ From 4ef7a1c953789eb4affc29cbc78b869fd6213a32 Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Fri, 9 Sep 2022 16:53:46 +0200 Subject: [PATCH 23/48] Changed checkout into content folder --- .github/workflows/asciidoc-build.yml | 14 +++++++------- content/_config.adoc | 8 ++++---- content/index.adoc | 4 ++-- 3 files changed, 13 insertions(+), 13 deletions(-) diff --git a/.github/workflows/asciidoc-build.yml b/.github/workflows/asciidoc-build.yml index 6ecf6d64..cbc33fc8 100644 --- a/.github/workflows/asciidoc-build.yml +++ b/.github/workflows/asciidoc-build.yml @@ -28,7 +28,7 @@ jobs: uses: actions/checkout@v2 with: repository: OpenSimulationInterface/open-simulation-interface - path: open-simulation-interface + path: content/open-simulation-interface fetch-depth: 0 @@ -36,13 +36,13 @@ jobs: uses: actions/checkout@v2 with: repository: OpenSimulationInterface/osi-sensor-model-packaging - path: osi-sensor-model-packaging + path: content/osi-sensor-model-packaging - - name: Checkout proto2cpp - uses: actions/checkout@v2 - with: - repository: OpenSimulationInterface/proto2cpp - path: proto2cpp + # - name: Checkout proto2cpp + # uses: actions/checkout@v2 + # with: + # repository: OpenSimulationInterface/proto2cpp + # path: proto2cpp # Versioning - name: Get versioning diff --git a/content/_config.adoc b/content/_config.adoc index d54bcb4c..e86ed467 100644 --- a/content/_config.adoc +++ b/content/_config.adoc @@ -26,16 +26,16 @@ ifndef::include-only-once[] // Replace PLACEHOLDER with the name of your standard, e.g. OpenDRIVE :THIS_STANDARD: {GLO_VAR_STA_ASAM_OSI} :asam-terminology: https://code.asam.net/common/asam-terminology/-/raw/main/terms_and_definitions_opendrive.adoc -:imagesdir: {root-path}/_static/images +:imagesdir: {root-path}_static/images :include-only-once: true :topicdir: topics :reusedir: reuse :toclevels: 3 :xrefstyle: full -:images_open_simulation_interface: ../../../open-simulation-interface/doc/images +:images_open_simulation_interface: ../../{doc_open_simulation_interface}images // :images_osi-sensor-model-packaging: ../../osi-sensor-model-packaging/doc/images -:doc_open_simulation_interface: ../../open-simulation-interface/doc/ -:doc_osi-sensor-model-packaging: ../../osi-sensor-model-packaging/doc/ +:doc_open_simulation_interface: open-simulation-interface/doc/ +:doc_osi-sensor-model-packaging: osi-sensor-model-packaging/doc/ // Since a document spanning multiple repos is rendered here, the pathing regarding images is a bit involved. // We create a variable for every repo that is included. It point to the repo in question. // If the subrepo is rendered seperatly, then the variable is set to just "./images" with ifdef. diff --git a/content/index.adoc b/content/index.adoc index 241d7e7d..d6e2b638 100644 --- a/content/index.adoc +++ b/content/index.adoc @@ -43,9 +43,9 @@ include::./general_standard/relations_to_other_standards.adoc[leveloffset=+2] // START: including the documentation of other osi repositories -include::../open-simulation-interface/doc/open-simulation-interface_user_guide.adoc[leveloffset=+1] +include::{doc_open_simulation_interface}open-simulation-interface_user_guide.adoc[leveloffset=+1] -include::../osi-sensor-model-packaging/doc/osi-sensor-model-packaging_spec.adoc[leveloffset=+1] +include::{doc_osi-sensor-model-packaging}osi-sensor-model-packaging_spec.adoc[leveloffset=+1] // osi-validation and osi-visualizer are considered supplementary tooling that is not normative. They are therefore not part of the ASAM standard release. // include::./osi-validation/doc/osi-validator_user_guide.adoc[leveloffset=+1,opts=optional] From 0f8c5d2db297db0afbab7705c4ee138fbecc1197 Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Fri, 9 Sep 2022 17:02:12 +0200 Subject: [PATCH 24/48] Added missing folder for versioning --- .github/workflows/asciidoc-build.yml | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/.github/workflows/asciidoc-build.yml b/.github/workflows/asciidoc-build.yml index cbc33fc8..252434ff 100644 --- a/.github/workflows/asciidoc-build.yml +++ b/.github/workflows/asciidoc-build.yml @@ -38,16 +38,16 @@ jobs: repository: OpenSimulationInterface/osi-sensor-model-packaging path: content/osi-sensor-model-packaging - # - name: Checkout proto2cpp - # uses: actions/checkout@v2 - # with: - # repository: OpenSimulationInterface/proto2cpp - # path: proto2cpp + - name: Checkout proto2cpp + uses: actions/checkout@v2 + with: + repository: OpenSimulationInterface/proto2cpp + path: proto2cpp # Versioning - name: Get versioning id: get_version - working-directory: open-simulation-interface + working-directory: content/open-simulation-interface run: echo ::set-output name=VERSION::$(git describe --always) # replaces the placeholder for versioning in the main mapping file From d3895272050ccdd5afbc56a54d62990b272a947d Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Fri, 9 Sep 2022 17:04:46 +0200 Subject: [PATCH 25/48] Update compose accordingly to new folder --- docker-compose.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docker-compose.yml b/docker-compose.yml index 0af36db2..e92dd88c 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -6,4 +6,4 @@ services: volumes: - .:/documents working_dir: /documents - entrypoint: asciidoctor -D . --failure-level WARN -r asciidoctor-bibtex -r asciidoctor-diagram -a mathjax --trace --backend=html5 index.adoc -o open-simulation-interface_localbuild.html \ No newline at end of file + entrypoint: asciidoctor -D . --failure-level WARN -r asciidoctor-bibtex -r asciidoctor-diagram -a mathjax --trace --backend=html5 content/index.adoc -o open-simulation-interface_localbuild.html \ No newline at end of file From 4619ae0931be0b12c61096606937be246ccce97a Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Fri, 9 Sep 2022 17:05:28 +0200 Subject: [PATCH 26/48] Update config again --- content/_config.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/_config.adoc b/content/_config.adoc index e86ed467..c57b44e0 100644 --- a/content/_config.adoc +++ b/content/_config.adoc @@ -32,10 +32,10 @@ ifndef::include-only-once[] :reusedir: reuse :toclevels: 3 :xrefstyle: full -:images_open_simulation_interface: ../../{doc_open_simulation_interface}images // :images_osi-sensor-model-packaging: ../../osi-sensor-model-packaging/doc/images :doc_open_simulation_interface: open-simulation-interface/doc/ :doc_osi-sensor-model-packaging: osi-sensor-model-packaging/doc/ +:images_open_simulation_interface: ../../open-simulation-interface/doc/images // Since a document spanning multiple repos is rendered here, the pathing regarding images is a bit involved. // We create a variable for every repo that is included. It point to the repo in question. // If the subrepo is rendered seperatly, then the variable is set to just "./images" with ifdef. From ce1a47913f88fae672ae918e8064b43cdbdecd66 Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Fri, 9 Sep 2022 17:06:52 +0200 Subject: [PATCH 27/48] Added missing attribute for title --- content/_config.adoc | 1 + 1 file changed, 1 insertion(+) diff --git a/content/_config.adoc b/content/_config.adoc index c57b44e0..b645865b 100644 --- a/content/_config.adoc +++ b/content/_config.adoc @@ -25,6 +25,7 @@ ifndef::include-only-once[] :bibtex-file: ./content/general_docs/bibliography.bib // Replace PLACEHOLDER with the name of your standard, e.g. OpenDRIVE :THIS_STANDARD: {GLO_VAR_STA_ASAM_OSI} +:THIS_STANDARD_TITLE: {GLO_VAR_STA_ASAM_OSI} :asam-terminology: https://code.asam.net/common/asam-terminology/-/raw/main/terms_and_definitions_opendrive.adoc :imagesdir: {root-path}_static/images :include-only-once: true From 53900cc9ec0d853b913dc4c814fd318f09e1e2ce Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Fri, 9 Sep 2022 17:21:36 +0200 Subject: [PATCH 28/48] Added workaround for bug in asciidoctor image regarding use of attributes in title --- content/appendix/releases/v02.00.adoc | 5 +++++ content/appendix/releases/v02.01.adoc | 5 +++++ content/appendix/releases/v02.02.00.adoc | 7 ++++++- content/appendix/releases/v02.02.01.adoc | 5 +++++ content/appendix/releases/v03.00.00.adoc | 5 +++++ content/appendix/releases/v03.00.01.adoc | 5 +++++ content/appendix/releases/v03.01.00.adoc | 5 +++++ content/appendix/releases/v03.01.01.adoc | 5 +++++ content/appendix/releases/v03.01.02.adoc | 5 +++++ content/appendix/releases/v03.02.adoc | 5 +++++ content/appendix/releases/v03.03.00.adoc | 5 +++++ content/appendix/releases/v03.03.01.adoc | 5 +++++ content/appendix/releases/v03.04.adoc | 5 +++++ content/appendix/releases/v03.05.adoc | 5 +++++ 14 files changed, 71 insertions(+), 1 deletion(-) diff --git a/content/appendix/releases/v02.00.adoc b/content/appendix/releases/v02.00.adoc index 2d5fe079..c1fab079 100644 --- a/content/appendix/releases/v02.00.adoc +++ b/content/appendix/releases/v02.00.adoc @@ -2,8 +2,13 @@ ifndef::include-only-once[] :root-path: ../../ include::{root-path}_config.adoc[] endif::[] +ifdef::use-antora-rules[] :reftext: v2.0.0 - OSI Initial Commit = https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v2.0.0[{reftext}] +endif::[] +ifndef::use-antora-rules[] += https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v2.0.0[v2.0.0 - OSI Initial Commit] +endif::[] This is the initial version of the Open Simulation Interface (OSI). diff --git a/content/appendix/releases/v02.01.adoc b/content/appendix/releases/v02.01.adoc index fc0546a3..d287f63b 100644 --- a/content/appendix/releases/v02.01.adoc +++ b/content/appendix/releases/v02.01.adoc @@ -2,8 +2,13 @@ ifndef::include-only-once[] :root-path: ../../ include::{root-path}_config.adoc[] endif::[] +ifdef::use-antora-rules[] :reftext: v2.1.0 - OSI "Agile Andretti" = https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v2.1.0[{reftext}] +endif::[] +ifndef::use-antora-rules[] += https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v2.1.0[v2.1.0 - OSI "Agile Andretti"] +endif::[] *Purpose* diff --git a/content/appendix/releases/v02.02.00.adoc b/content/appendix/releases/v02.02.00.adoc index 6389f366..cd6c5052 100644 --- a/content/appendix/releases/v02.02.00.adoc +++ b/content/appendix/releases/v02.02.00.adoc @@ -2,8 +2,13 @@ ifndef::include-only-once[] :root-path: ../../ include::{root-path}_config.adoc[] endif::[] -:reftext: v2.2.0 - OSI "Brave Brabham" +ifdef::use-antora-rules[] +:reftext: v2.2.0 - OSI "Brave Brabham"4 = https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v2.2.0[{reftext}] +endif::[] +ifndef::use-antora-rules[] += https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v2.2.0[v2.2.0 - OSI "Brave Brabham"4] +endif::[] *Purpose* diff --git a/content/appendix/releases/v02.02.01.adoc b/content/appendix/releases/v02.02.01.adoc index cba5b58b..37b487dd 100644 --- a/content/appendix/releases/v02.02.01.adoc +++ b/content/appendix/releases/v02.02.01.adoc @@ -2,8 +2,13 @@ ifndef::include-only-once[] :root-path: ../../ include::{root-path}_config.adoc[] endif::[] +ifdef::use-antora-rules[] :reftext: v2.2.1 - OSI "Brave Brabham", Update 1 = https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v2.2.1[{reftext}] +endif::[] +ifndef::use-antora-rules[] += https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v2.2.1[v2.2.1 - OSI "Brave Brabham", Update 1] +endif::[] *Purpose* diff --git a/content/appendix/releases/v03.00.00.adoc b/content/appendix/releases/v03.00.00.adoc index 021d4a48..ef944ece 100644 --- a/content/appendix/releases/v03.00.00.adoc +++ b/content/appendix/releases/v03.00.00.adoc @@ -2,8 +2,13 @@ ifndef::include-only-once[] :root-path: ../../ include::{root-path}_config.adoc[] endif::[] +ifdef::use-antora-rules[] :reftext: v3.0.0 - OSI "Cosmic Coulthard" = https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.0.0[{reftext}] +endif::[] +ifndef::use-antora-rules[] += https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.0.0[v3.0.0 - OSI "Cosmic Coulthard"] +endif::[] *Purpose* diff --git a/content/appendix/releases/v03.00.01.adoc b/content/appendix/releases/v03.00.01.adoc index 947ec08c..a5be04d8 100644 --- a/content/appendix/releases/v03.00.01.adoc +++ b/content/appendix/releases/v03.00.01.adoc @@ -2,8 +2,13 @@ ifndef::include-only-once[] :root-path: ../../ include::{root-path}_config.adoc[] endif::[] +ifdef::use-antora-rules[] :reftext: v3.0.1 - OSI "Cosmic Coulthard", Update 1 = https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.0.1[{reftext}] +endif::[] +ifndef::use-antora-rules[] += https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.0.1[v3.0.1 - OSI "Cosmic Coulthard", Update 1] +endif::[] https://www.youtube.com/watch?v=yG0oBPtyNb0[Summertime :)] diff --git a/content/appendix/releases/v03.01.00.adoc b/content/appendix/releases/v03.01.00.adoc index 23034150..38611ddc 100644 --- a/content/appendix/releases/v03.01.00.adoc +++ b/content/appendix/releases/v03.01.00.adoc @@ -2,8 +2,13 @@ ifndef::include-only-once[] :root-path: ../../ include::{root-path}_config.adoc[] endif::[] +ifdef::use-antora-rules[] :reftext: v3.1.0 - OSI "Dynamic Duncan" = https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.1.0[{reftext}] +endif::[] +ifndef::use-antora-rules[] += https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.1.0[v3.1.0 - OSI "Dynamic Duncan"] +endif::[] https://www.youtube.com/watch?v=fu3uA8K6ApQ>[(O SI)lent night] diff --git a/content/appendix/releases/v03.01.01.adoc b/content/appendix/releases/v03.01.01.adoc index a491de5c..570b4bbb 100644 --- a/content/appendix/releases/v03.01.01.adoc +++ b/content/appendix/releases/v03.01.01.adoc @@ -2,8 +2,13 @@ ifndef::include-only-once[] :root-path: ../../ include::{root-path}_config.adoc[] endif::[] +ifdef::use-antora-rules[] :reftext: v3.1.1 - OSI "Dynamic Duncan", Update 1 = https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.1.1[{reftext}] +endif::[] +ifndef::use-antora-rules[] += https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.1.1[v3.1.1 - OSI "Dynamic Duncan", Update 1] +endif::[] *https://github.com/OpenSimulationInterface/open-simulation-interface/pulls?q=is%3Apr+is%3Aclosed+milestone%3Av3.1.1[Content/Changes]* diff --git a/content/appendix/releases/v03.01.02.adoc b/content/appendix/releases/v03.01.02.adoc index 4f496b66..f59dfbb1 100644 --- a/content/appendix/releases/v03.01.02.adoc +++ b/content/appendix/releases/v03.01.02.adoc @@ -2,8 +2,13 @@ ifndef::include-only-once[] :root-path: ../../ include::{root-path}_config.adoc[] endif::[] +ifdef::use-antora-rules[] :reftext: v3.1.2 - OSI "Dynamic Duncan", Update 2 = https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.1.2[{reftext}] +endif::[] +ifndef::use-antora-rules[] += https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.1.2[v3.1.2 - OSI "Dynamic Duncan", Update 2] +endif::[] *https://github.com/OpenSimulationInterface/open-simulation-interface/pulls?q=is%3Apr+is%3Aclosed+milestone%3Av3.1.2[Content/Changes]* diff --git a/content/appendix/releases/v03.02.adoc b/content/appendix/releases/v03.02.adoc index 9baf0743..a540094a 100644 --- a/content/appendix/releases/v03.02.adoc +++ b/content/appendix/releases/v03.02.adoc @@ -2,8 +2,13 @@ ifndef::include-only-once[] :root-path: ../../ include::{root-path}_config.adoc[] endif::[] +ifdef::use-antora-rules[] :reftext: v3.2.0 - OSI "Editorial Eaton" = https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.2.0[{reftext}] +endif::[] +ifndef::use-antora-rules[] += https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.2.0[v3.2.0 - OSI "Editorial Eaton"] +endif::[] https://www.youtube.com/watch?v=SJUhlRoBL8M[Think p(OSI)tive!] diff --git a/content/appendix/releases/v03.03.00.adoc b/content/appendix/releases/v03.03.00.adoc index 325a01d3..eed8bdf6 100644 --- a/content/appendix/releases/v03.03.00.adoc +++ b/content/appendix/releases/v03.03.00.adoc @@ -2,8 +2,13 @@ ifndef::include-only-once[] :root-path: ../../ include::{root-path}_config.adoc[] endif::[] +ifdef::use-antora-rules[] :reftext: v3.3.0 - OSI "Fabulous Fangio" = https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.3.0[{reftext}] +endif::[] +ifndef::use-antora-rules[] += https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.3.0[v3.3.0 - OSI "Fabulous Fangio"] +endif::[] Stay p(OSI)tive! diff --git a/content/appendix/releases/v03.03.01.adoc b/content/appendix/releases/v03.03.01.adoc index 97b51bed..fc29a555 100644 --- a/content/appendix/releases/v03.03.01.adoc +++ b/content/appendix/releases/v03.03.01.adoc @@ -2,8 +2,13 @@ ifndef::include-only-once[] :root-path: ../../ include::{root-path}_config.adoc[] endif::[] +ifdef::use-antora-rules[] :reftext: v3.3.1 - OSI "Fabulous Fangio", Update 1 = https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.3.1[{reftext}] +endif::[] +ifndef::use-antora-rules[] += https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.3.1[v3.3.1 - OSI "Fabulous Fangio", Update 1] +endif::[] *https://github.com/OpenSimulationInterface/open-simulation-interface/milestone/18?closed=1[Content/Changes]* diff --git a/content/appendix/releases/v03.04.adoc b/content/appendix/releases/v03.04.adoc index 0116bb70..85a846e5 100644 --- a/content/appendix/releases/v03.04.adoc +++ b/content/appendix/releases/v03.04.adoc @@ -2,8 +2,13 @@ ifndef::include-only-once[] :root-path: ../../ include::{root-path}_config.adoc[] endif::[] +ifdef::use-antora-rules[] :reftext: v3.4.0 - OSI "Gallant Glock" = https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.4.0[{reftext}] +endif::[] +ifndef::use-antora-rules[] += https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.4.0[v3.4.0 - OSI "Gallant Glock"] +endif::[] Stay p(OSI)tive! diff --git a/content/appendix/releases/v03.05.adoc b/content/appendix/releases/v03.05.adoc index ff3a769f..be6949ad 100644 --- a/content/appendix/releases/v03.05.adoc +++ b/content/appendix/releases/v03.05.adoc @@ -2,8 +2,13 @@ ifndef::include-only-once[] :root-path: ../../ include::{root-path}_config.adoc[] endif::[] +ifdef::use-antora-rules[] :reftext: v3.5.0 - OSI "Hard-fighting Hunt" = https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.5.0[{reftext}] +endif::[] +ifndef::use-antora-rules[] += https://github.com/OpenSimulationInterface/open-simulation-interface/releases/tag/v3.5.0[v3.5.0 - OSI "Hard-fighting Hunt"] +endif::[] L(OSI)ng is not an option! From 18007651b87d762a3d7007d9bf167c90116689b5 Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Mon, 12 Sep 2022 14:14:56 +0200 Subject: [PATCH 29/48] build: Run customized Antora for PRs --- .github/workflows/antora-build.yml | 55 ++++++++++++++++++++++++++++++ 1 file changed, 55 insertions(+) create mode 100644 .github/workflows/antora-build.yml diff --git a/.github/workflows/antora-build.yml b/.github/workflows/antora-build.yml new file mode 100644 index 00000000..ff774728 --- /dev/null +++ b/.github/workflows/antora-build.yml @@ -0,0 +1,55 @@ +name: Antora Documentation Build + +on: + # create: # new branches or tags + release: # new releases + pull_request: + branches: [ main ] + push: # on push. This may be removed later + # schedule: # periodic - needed because some of the content is from the other repos + # - cron: '30 5,20 * * *' # this is pretty often. Only needed during review phase + +jobs: + antora-build: + name: Build + runs-on: ubuntu-20.04 + + services: + kroki: + image: yuzutech/kroki:0.15.1 + env: + KROKI_MAX_URI_LENGTH: 8000 + KROKI_BLOCKDIAG_HOST: blockdiag + KROKI_MERMAID_HOST: mermaid + blockdiag: + image: yuzutech/kroki-blockdiag:0.15.1 + mermaid: + image: yuzutech/kroki-mermaid:0.15.1 + + steps: + - name: Checkout generator + uses: actions/checkout@master + with: + repository: OpenSimulationInterface/osi-antora-generator + path: generator + submodules: true + fetch-depth: 0 + + - name: Modify site.yml + working-directory: generator + run: | + sed -i -E "s/(branches\:) \[antora\/base-antora-setup\] \# osi-documentation/\1 [HEAD]/" site.yml + + - name: Generate site + uses: docker://ghcr.io/asam-ev/project-guide-docker:4 + with: + entrypoint: sh + args: generator/run-build.sh + + - name: Upload artifact + uses: actions/upload-artifact@v3 + with: + name: antora-build + path: ./generator/site + + \ No newline at end of file From e767f1ebd4401b0b8d2ceb521dc5f9dcea2d8c5e Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Mon, 12 Sep 2022 17:13:43 +0200 Subject: [PATCH 30/48] Added download button --- .antora/antora.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.antora/antora.yml b/.antora/antora.yml index cceda450..ba34b37e 100644 --- a/.antora/antora.yml +++ b/.antora/antora.yml @@ -31,7 +31,7 @@ asciidoc: # Sets global AsciiDoc attributes that are applied for every page of t images_open_simulation_interface: 'interface:' doc_open_simulation_interface: 'interface:' doc_osi-sensor-model-packaging: 'sensor-model:' - # page-download-links: [["opendrive-examples-and-use-cases.zip", "Examples and use cases"],["xsd_schema.zip","XSD schema files"],["ASAM_OpenDRIVE.EAP","Enterprise Architect file"],["example-implementations.zip","Implementation examples"]] + page-download-links: [["../../interface/_attachments/proto-files.zip", "Protobuffer files"]] # END - Mandatory ASAM attributes # doxygen_interface_version: "v3.2.0" # The interface version that needs to be retrieved From b663382a45ddb78b559ed5d3d63ddf41df8e8af6 Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Tue, 13 Sep 2022 15:03:24 +0200 Subject: [PATCH 31/48] Added internal links --- content/general_docs/deliverables.adoc | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/general_docs/deliverables.adoc b/content/general_docs/deliverables.adoc index b41d2526..b242512f 100644 --- a/content/general_docs/deliverables.adoc +++ b/content/general_docs/deliverables.adoc @@ -7,8 +7,8 @@ endif::[] The following deliverables are provided for {THIS_STANDARD}: * User guide, that is, this document (partly normative) -* .proto files (normative) -* Doxygen reference documentation (not normative) +* xref:interface:attachment$proto-files.zip[.proto files] (normative) +* xref:gen:index.adoc[Doxygen reference documentation] (not normative) * OSMP packaging (OSMP packaging has its own version number, but is compatible with the version of {THIS_STANDARD}.) **Related topics** From cc13bd92b1304d0005d29d9b8bad5d48e0f22041 Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Thu, 15 Sep 2022 13:01:11 +0200 Subject: [PATCH 32/48] Build: Improved workflow Signed-off-by: Philip Windecker --- .github/workflows/antora-build.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/antora-build.yml b/.github/workflows/antora-build.yml index ff774728..652e6c7e 100644 --- a/.github/workflows/antora-build.yml +++ b/.github/workflows/antora-build.yml @@ -41,10 +41,11 @@ jobs: sed -i -E "s/(branches\:) \[antora\/base-antora-setup\] \# osi-documentation/\1 [HEAD]/" site.yml - name: Generate site + working-directory: generator uses: docker://ghcr.io/asam-ev/project-guide-docker:4 with: entrypoint: sh - args: generator/run-build.sh + args: run-build.sh - name: Upload artifact uses: actions/upload-artifact@v3 From dd2caa237696e5f264c7dec221deeb5d9ed7e3d4 Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Thu, 15 Sep 2022 13:56:43 +0200 Subject: [PATCH 33/48] build: updated pipeline Signed-off-by: Philip Windecker --- .github/workflows/antora-build.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/antora-build.yml b/.github/workflows/antora-build.yml index 652e6c7e..f75de503 100644 --- a/.github/workflows/antora-build.yml +++ b/.github/workflows/antora-build.yml @@ -39,13 +39,13 @@ jobs: working-directory: generator run: | sed -i -E "s/(branches\:) \[antora\/base-antora-setup\] \# osi-documentation/\1 [HEAD]/" site.yml + sed -i -E "s/cd repo/cd repo\/generator/" run-build.sh - name: Generate site - working-directory: generator uses: docker://ghcr.io/asam-ev/project-guide-docker:4 with: entrypoint: sh - args: run-build.sh + args: repo/generator/run-build.sh - name: Upload artifact uses: actions/upload-artifact@v3 From 34a1a555d6289e2fe58f18eb0bbac6883b089e96 Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Thu, 15 Sep 2022 14:06:06 +0200 Subject: [PATCH 34/48] test update for pipeline Signed-off-by: Philip Windecker --- .github/workflows/antora-build.yml | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/.github/workflows/antora-build.yml b/.github/workflows/antora-build.yml index f75de503..729a6115 100644 --- a/.github/workflows/antora-build.yml +++ b/.github/workflows/antora-build.yml @@ -39,13 +39,15 @@ jobs: working-directory: generator run: | sed -i -E "s/(branches\:) \[antora\/base-antora-setup\] \# osi-documentation/\1 [HEAD]/" site.yml + cat site.yml sed -i -E "s/cd repo/cd repo\/generator/" run-build.sh + cat run-build.sh - name: Generate site uses: docker://ghcr.io/asam-ev/project-guide-docker:4 with: entrypoint: sh - args: repo/generator/run-build.sh + args: ls & repo/generator/run-build.sh - name: Upload artifact uses: actions/upload-artifact@v3 From 980aa97500d0e100d0c73fb2fff5934562a94b4d Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Thu, 15 Sep 2022 14:10:38 +0200 Subject: [PATCH 35/48] build: update pipeline Signed-off-by: Philip Windecker --- .github/workflows/antora-build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/antora-build.yml b/.github/workflows/antora-build.yml index 729a6115..724f5747 100644 --- a/.github/workflows/antora-build.yml +++ b/.github/workflows/antora-build.yml @@ -47,7 +47,7 @@ jobs: uses: docker://ghcr.io/asam-ev/project-guide-docker:4 with: entrypoint: sh - args: ls & repo/generator/run-build.sh + args: antora --stacktrace --fetch --clean generator/site.yml - name: Upload artifact uses: actions/upload-artifact@v3 From 8d07da4ad15474d3bbe010ab841d2421110ecc9a Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Thu, 15 Sep 2022 14:16:18 +0200 Subject: [PATCH 36/48] build: update antora pipeline Signed-off-by: Philip Windecker --- .github/workflows/antora-build.yml | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/.github/workflows/antora-build.yml b/.github/workflows/antora-build.yml index 724f5747..797df276 100644 --- a/.github/workflows/antora-build.yml +++ b/.github/workflows/antora-build.yml @@ -38,16 +38,16 @@ jobs: - name: Modify site.yml working-directory: generator run: | - sed -i -E "s/(branches\:) \[antora\/base-antora-setup\] \# osi-documentation/\1 [HEAD]/" site.yml + sed -i -E "s/(branches\:) \[antora\/base-antora-setup\] \# osi-documentation/\1 [${CI_COMMIT_BRANCH}]/" site.yml cat site.yml - sed -i -E "s/cd repo/cd repo\/generator/" run-build.sh + sed -i -E "s/cd repo/cd generator/" run-build.sh cat run-build.sh - name: Generate site uses: docker://ghcr.io/asam-ev/project-guide-docker:4 with: entrypoint: sh - args: antora --stacktrace --fetch --clean generator/site.yml + args: generator/run-build.sh - name: Upload artifact uses: actions/upload-artifact@v3 From 632854a53b35b9689a8f29b1f0b4dbd023285929 Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Thu, 15 Sep 2022 14:19:20 +0200 Subject: [PATCH 37/48] build: fixed use of branch name Signed-off-by: Philip Windecker --- .github/workflows/antora-build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/antora-build.yml b/.github/workflows/antora-build.yml index 797df276..0c85e180 100644 --- a/.github/workflows/antora-build.yml +++ b/.github/workflows/antora-build.yml @@ -38,7 +38,7 @@ jobs: - name: Modify site.yml working-directory: generator run: | - sed -i -E "s/(branches\:) \[antora\/base-antora-setup\] \# osi-documentation/\1 [${CI_COMMIT_BRANCH}]/" site.yml + sed -i -E "s/(branches\:) \[antora\/base-antora-setup\] \# osi-documentation/\1 [${{CI_COMMIT_BRANCH}}]/" site.yml cat site.yml sed -i -E "s/cd repo/cd generator/" run-build.sh cat run-build.sh From 9d67fa997fb8f898ccecb0cf6085cae6970da7fb Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Thu, 15 Sep 2022 14:20:07 +0200 Subject: [PATCH 38/48] build: Added removed comment sign Signed-off-by: Philip Windecker --- .github/workflows/antora-build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/antora-build.yml b/.github/workflows/antora-build.yml index 0c85e180..41e4cc3f 100644 --- a/.github/workflows/antora-build.yml +++ b/.github/workflows/antora-build.yml @@ -38,7 +38,7 @@ jobs: - name: Modify site.yml working-directory: generator run: | - sed -i -E "s/(branches\:) \[antora\/base-antora-setup\] \# osi-documentation/\1 [${{CI_COMMIT_BRANCH}}]/" site.yml + sed -i -E "s/(branches\:) \[antora\/base-antora-setup\] \# osi-documentation/\1 [${{CI_COMMIT_BRANCH}}] \# osi-documentation/" site.yml cat site.yml sed -i -E "s/cd repo/cd generator/" run-build.sh cat run-build.sh From e14781c04922e768fbefd6cfb039d97376d445fe Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Thu, 15 Sep 2022 14:24:04 +0200 Subject: [PATCH 39/48] build: update pipeline for pr Signed-off-by: Philip Windecker --- .github/workflows/antora-build.yml | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/.github/workflows/antora-build.yml b/.github/workflows/antora-build.yml index 41e4cc3f..035b40e6 100644 --- a/.github/workflows/antora-build.yml +++ b/.github/workflows/antora-build.yml @@ -2,10 +2,10 @@ name: Antora Documentation Build on: # create: # new branches or tags - release: # new releases + # release: # new releases pull_request: - branches: [ main ] - push: # on push. This may be removed later + branches: [ main, master ] + # push: # on push. This may be removed later # schedule: # periodic - needed because some of the content is from the other repos # - cron: '30 5,20 * * *' # this is pretty often. Only needed during review phase @@ -38,7 +38,8 @@ jobs: - name: Modify site.yml working-directory: generator run: | - sed -i -E "s/(branches\:) \[antora\/base-antora-setup\] \# osi-documentation/\1 [${{CI_COMMIT_BRANCH}}] \# osi-documentation/" site.yml + echo ${CI_COMMIT_REF_NAME} + sed -i -E "s/(branches\:) \[antora\/base-antora-setup\] \# osi-documentation/\1 [${CI_COMMIT_REF_NAME}] \# osi-documentation/" site.yml cat site.yml sed -i -E "s/cd repo/cd generator/" run-build.sh cat run-build.sh From 537cfbd8e39982c2c481078e0ad608a621a0f800 Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Thu, 15 Sep 2022 14:30:10 +0200 Subject: [PATCH 40/48] build: switch from PR to push with exceptions Signed-off-by: Philip Windecker --- .github/workflows/antora-build.yml | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/workflows/antora-build.yml b/.github/workflows/antora-build.yml index 035b40e6..51701184 100644 --- a/.github/workflows/antora-build.yml +++ b/.github/workflows/antora-build.yml @@ -3,8 +3,8 @@ name: Antora Documentation Build on: # create: # new branches or tags # release: # new releases - pull_request: - branches: [ main, master ] + push: + branches-ignore: [ main, master ] # push: # on push. This may be removed later # schedule: # periodic - needed because some of the content is from the other repos # - cron: '30 5,20 * * *' # this is pretty often. Only needed during review phase @@ -38,8 +38,8 @@ jobs: - name: Modify site.yml working-directory: generator run: | - echo ${CI_COMMIT_REF_NAME} - sed -i -E "s/(branches\:) \[antora\/base-antora-setup\] \# osi-documentation/\1 [${CI_COMMIT_REF_NAME}] \# osi-documentation/" site.yml + echo ${CI_COMMIT_BRANCH} + sed -i -E "s/(branches\:) \[antora\/base-antora-setup\] \# osi-documentation/\1 [${CI_COMMIT_BRANCH}] \# osi-documentation/" site.yml cat site.yml sed -i -E "s/cd repo/cd generator/" run-build.sh cat run-build.sh From 557c605189aebacc9942a640aeaa1374d23237e8 Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Thu, 15 Sep 2022 14:35:02 +0200 Subject: [PATCH 41/48] test Signed-off-by: Philip Windecker --- .github/workflows/antora-build.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.github/workflows/antora-build.yml b/.github/workflows/antora-build.yml index 51701184..4a569be3 100644 --- a/.github/workflows/antora-build.yml +++ b/.github/workflows/antora-build.yml @@ -38,7 +38,8 @@ jobs: - name: Modify site.yml working-directory: generator run: | - echo ${CI_COMMIT_BRANCH} + echo "${CI_COMMIT_BRANCH}" + echo "$CI_COMMIT_BRANCH" sed -i -E "s/(branches\:) \[antora\/base-antora-setup\] \# osi-documentation/\1 [${CI_COMMIT_BRANCH}] \# osi-documentation/" site.yml cat site.yml sed -i -E "s/cd repo/cd generator/" run-build.sh From 25ea68f6a875282868d2f2b0fea07d36a945b3cb Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Thu, 15 Sep 2022 14:40:02 +0200 Subject: [PATCH 42/48] build: switch to github vars Signed-off-by: Philip Windecker --- .github/workflows/antora-build.yml | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/.github/workflows/antora-build.yml b/.github/workflows/antora-build.yml index 4a569be3..87f83b18 100644 --- a/.github/workflows/antora-build.yml +++ b/.github/workflows/antora-build.yml @@ -38,9 +38,8 @@ jobs: - name: Modify site.yml working-directory: generator run: | - echo "${CI_COMMIT_BRANCH}" - echo "$CI_COMMIT_BRANCH" - sed -i -E "s/(branches\:) \[antora\/base-antora-setup\] \# osi-documentation/\1 [${CI_COMMIT_BRANCH}] \# osi-documentation/" site.yml + echo "${GITHUB_REF#refs/heads/}" + sed -i -E "s/(branches\:) \[antora\/base-antora-setup\] \# osi-documentation/\1 [${GITHUB_REF#refs/heads/}] \# osi-documentation/" site.yml cat site.yml sed -i -E "s/cd repo/cd generator/" run-build.sh cat run-build.sh From 5c86d1d94dd57bfe5bf80010a1df88a48fdf696f Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Thu, 15 Sep 2022 14:42:13 +0200 Subject: [PATCH 43/48] build: new variable for refname Signed-off-by: Philip Windecker --- .github/workflows/antora-build.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/antora-build.yml b/.github/workflows/antora-build.yml index 87f83b18..67036f16 100644 --- a/.github/workflows/antora-build.yml +++ b/.github/workflows/antora-build.yml @@ -38,8 +38,8 @@ jobs: - name: Modify site.yml working-directory: generator run: | - echo "${GITHUB_REF#refs/heads/}" - sed -i -E "s/(branches\:) \[antora\/base-antora-setup\] \# osi-documentation/\1 [${GITHUB_REF#refs/heads/}] \# osi-documentation/" site.yml + echo "$GITHUB_REF_NAME" + sed -i -E "s/(branches\:) \[antora\/base-antora-setup\] \# osi-documentation/\1 [${GITHUB_REF_NAME}] \# osi-documentation/" site.yml cat site.yml sed -i -E "s/cd repo/cd generator/" run-build.sh cat run-build.sh From fb292d657035557059ad4df05fc2034d4380ebe3 Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Thu, 15 Sep 2022 14:44:04 +0200 Subject: [PATCH 44/48] build: changed use of github var in ci Signed-off-by: Philip Windecker --- .github/workflows/antora-build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/antora-build.yml b/.github/workflows/antora-build.yml index 67036f16..0e5bafe7 100644 --- a/.github/workflows/antora-build.yml +++ b/.github/workflows/antora-build.yml @@ -39,7 +39,7 @@ jobs: working-directory: generator run: | echo "$GITHUB_REF_NAME" - sed -i -E "s/(branches\:) \[antora\/base-antora-setup\] \# osi-documentation/\1 [${GITHUB_REF_NAME}] \# osi-documentation/" site.yml + sed -i -E "s/(branches\:) \[antora\/base-antora-setup\] \# osi-documentation/\1 [$GITHUB_REF_NAME] \# osi-documentation/" site.yml cat site.yml sed -i -E "s/cd repo/cd generator/" run-build.sh cat run-build.sh From 516e9cca76bb4429fe3a680bb1d4d2ee27f49a6c Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Thu, 15 Sep 2022 14:47:48 +0200 Subject: [PATCH 45/48] build: move to "%" as separator for sed Signed-off-by: Philip Windecker --- .github/workflows/antora-build.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/antora-build.yml b/.github/workflows/antora-build.yml index 0e5bafe7..80ad1858 100644 --- a/.github/workflows/antora-build.yml +++ b/.github/workflows/antora-build.yml @@ -39,7 +39,7 @@ jobs: working-directory: generator run: | echo "$GITHUB_REF_NAME" - sed -i -E "s/(branches\:) \[antora\/base-antora-setup\] \# osi-documentation/\1 [$GITHUB_REF_NAME] \# osi-documentation/" site.yml + sed -i -E "s%(branches\:) \[antora\/base-antora-setup\] \# osi-documentation%\1 [$GITHUB_REF_NAME] \# osi-documentation%" site.yml cat site.yml sed -i -E "s/cd repo/cd generator/" run-build.sh cat run-build.sh From 086b6ffe368d78d706906df97c320a8d62e426a3 Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Thu, 6 Oct 2022 12:54:40 +0200 Subject: [PATCH 46/48] Build: Changed download links to repo links Signed-off-by: Philip Windecker --- .antora/antora.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.antora/antora.yml b/.antora/antora.yml index ba34b37e..07437700 100644 --- a/.antora/antora.yml +++ b/.antora/antora.yml @@ -31,7 +31,7 @@ asciidoc: # Sets global AsciiDoc attributes that are applied for every page of t images_open_simulation_interface: 'interface:' doc_open_simulation_interface: 'interface:' doc_osi-sensor-model-packaging: 'sensor-model:' - page-download-links: [["../../interface/_attachments/proto-files.zip", "Protobuffer files"]] + page-repository-links: [["https://github.com/OpenSimulationInterface/open-simulation-interface", "Open Simulation Interface"],["https://github.com/OpenSimulationInterface/osi-sensor-model-packaging","Sensor Model Packaging"],["https://github.com/OpenSimulationInterface/osi-validation","OSI Validation"]] # END - Mandatory ASAM attributes # doxygen_interface_version: "v3.2.0" # The interface version that needs to be retrieved From 8146c247a167975482f074f139b91917ff4ba0a8 Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Mon, 10 Oct 2022 09:59:33 +0200 Subject: [PATCH 47/48] Removed xref from deliverables Signed-off-by: Philip Windecker --- content/general_docs/deliverables.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/general_docs/deliverables.adoc b/content/general_docs/deliverables.adoc index b242512f..a247d570 100644 --- a/content/general_docs/deliverables.adoc +++ b/content/general_docs/deliverables.adoc @@ -7,7 +7,7 @@ endif::[] The following deliverables are provided for {THIS_STANDARD}: * User guide, that is, this document (partly normative) -* xref:interface:attachment$proto-files.zip[.proto files] (normative) +* .proto files (normative) * xref:gen:index.adoc[Doxygen reference documentation] (not normative) * OSMP packaging (OSMP packaging has its own version number, but is compatible with the version of {THIS_STANDARD}.) From 47d64e070eec569d207c1f7820018c5b2d7d2ed6 Mon Sep 17 00:00:00 2001 From: Philip Windecker Date: Mon, 10 Oct 2022 16:36:08 +0200 Subject: [PATCH 48/48] Added backup pdf attributes for local use Signed-off-by: Philip Windecker --- .antora/antora.yml | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/.antora/antora.yml b/.antora/antora.yml index 07437700..557aec61 100644 --- a/.antora/antora.yml +++ b/.antora/antora.yml @@ -18,8 +18,10 @@ asciidoc: # Sets global AsciiDoc attributes that are applied for every page of t attributes: # START - Mandatory ASAM attributes use-antora-rules: true - THIS_STANDARD: ASAM OSI® - THIS_STANDARD_TITLE: 'ASAM OSI^®^' + THIS_STANDARD: ASAM OSI® # Normal attribute + THIS_STANDARD_TITLE: 'ASAM OSI^®^' # Normal attribute + # THIS_STANDARD: ASAM OSI # PDF version attribute + # THIS_STANDARD_TITLE: 'ASAM OSI' # PDF version attribute partials-path: partial$ root-path: page$ appendix-caption: Annex @@ -31,7 +33,7 @@ asciidoc: # Sets global AsciiDoc attributes that are applied for every page of t images_open_simulation_interface: 'interface:' doc_open_simulation_interface: 'interface:' doc_osi-sensor-model-packaging: 'sensor-model:' - page-repository-links: [["https://github.com/OpenSimulationInterface/open-simulation-interface", "Open Simulation Interface"],["https://github.com/OpenSimulationInterface/osi-sensor-model-packaging","Sensor Model Packaging"],["https://github.com/OpenSimulationInterface/osi-validation","OSI Validation"]] + page-repository-links: [["https://github.com/OpenSimulationInterface/open-simulation-interface", "Open Simulation Interface"],["https://github.com/OpenSimulationInterface/osi-sensor-model-packaging","OSI Sensor Model Packaging"],["https://github.com/OpenSimulationInterface/osi-validation","OSI Validation"]] # END - Mandatory ASAM attributes # doxygen_interface_version: "v3.2.0" # The interface version that needs to be retrieved