Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tait-Bryan / Euler reference cannot be found #857

Open
TimmRuppert opened this issue Feb 24, 2025 · 1 comment
Open

Tait-Bryan / Euler reference cannot be found #857

TimmRuppert opened this issue Feb 24, 2025 · 1 comment
Labels
Bug Problems in the build system, build scripts, etc or faults in the interface. Documentation Everything which impacts the quality of the documentation and guidelines.

Comments

@TimmRuppert
Copy link

Describe the bug

The documentation links the following URL which is invalid:
https://opensimulationinterface.github.io/osi-antora-generator/asamosi/latest/gen/Tait-Bryan%20/%20Eulerconvention%20z-y

Describe how to reproduce the bug

Steps to reproduce the behavior:

  1. Go to https://opensimulationinterface.github.io/osi-antora-generator/asamosi/latest/gen/structosi3_1_1Orientation3d.html
  2. Click on 1 (of "... the definition according to 1.")
  3. See Page Not Found error

It seems like Tait-Bryan / Euler is missing from the bibliography altogether.

@TimmRuppert TimmRuppert added Bug Problems in the build system, build scripts, etc or faults in the interface. Documentation Everything which impacts the quality of the documentation and guidelines. labels Feb 24, 2025
@thomassedlmayer
Copy link
Contributor

thomassedlmayer commented Feb 26, 2025

I'd assume that it was meant to refer to the [1] reference contained in the same proto comment section which probably says something about Tait-Bryan/Euler conventions:

Reference:
[1] DIN Deutsches Institut fuer Normung e. V. (2013). DIN ISO 8855 Strassenfahrzeuge - Fahrzeugdynamik und Fahrverhalten - Begriffe. (DIN ISO 8855:2013-11). Berlin, Germany.

The inline reference in the proto file looks like this:

[1] (Tait-Bryan / Euler convention z-y'-x'')

Apparently there is some syntax detection for round brackets following square brackets which then creates a relative URL from the string contained in the round brackets. So I don't think that a reference is actually missing. But the reference should be somehow reformatted so that there is no hyperlink added to the "[1]" in the text based on the content in the round brackets.

It seems like Tait-Bryan / Euler is missing from the bibliography altogether.

Btw I already created a PR to also add this rotation convention adherence to the documentation (#850). The PR also does not yet add a reference to the bibliography (because I did not yet find out how to do that) but I added a To-Do.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Bug Problems in the build system, build scripts, etc or faults in the interface. Documentation Everything which impacts the quality of the documentation and guidelines.
Projects
None yet
Development

No branches or pull requests

2 participants