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

Conversion of existing documentation to LaTeX sources #438

Conversation

GLS-SSV
Copy link
Contributor

@GLS-SSV GLS-SSV commented Mar 4, 2024

No description provided.


\section{Publishing addons}
Now that you have created and tested your new ship, you want to share it with the rest of the Orbiter community. Here is how to do it:

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe we should add some words about licencing in this section ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Makes sense. Added a "TODO" in that section to indicate the need for this (this PR is for LaTeX conversion work, the next PR will work the updating and checking of the content).

@GLS-SSV GLS-SSV marked this pull request as ready for review May 12, 2024 20:05
@jarmonik
Copy link
Contributor

I tried to build the documentation but ran into some problems. The used font "NotoSansMono" doesn't seem to work. I found one from the internet but it refuses to install. Is there something special about the font that makes it better ? Or would it be practical to change to a more common font ?

I renamed the font from common_definitions.tex to "Calibri" and I was able to build Technical Reference and Developer Manual but Orbiter User Manual fails to build with following error:

!pdfTeX error: pdflatex.exe (file fstr8x): Font fstr8x at 624 not found
==> Fatal error occurred, no output PDF file produced!

@jarmonik
Copy link
Contributor

Still no luck getting this to work. Looks like the "Noto" font is a part of MikTex installation and located in /MikTex/fonts/truetype/google/noto/ But why doesn't it use it ? I am trying to build the documentation with TeXnicCenter.

Is anyone else able to edit and review the documentation locally ?

@jarmonik jarmonik changed the base branch from main to latex_doc_update May 17, 2024 07:52
@jarmonik jarmonik merged commit 948638a into orbitersim:latex_doc_update May 17, 2024
5 checks passed
n7275 pushed a commit to n7275/orbiter that referenced this pull request Sep 28, 2024
* initial work in converting existing documentation to LaTeX sources

* added alert and code blocks

* >> added cover logo

>> further work in document structure

* further work in demonstrating original document reproduction

* improvements and additions to common packages

* further document conversion work

* added more packages and code keywords

* further document conversion work

* further document conversion work

* further document conversion work

* added "MESH code" language, for styling purposes

* further document conversion work

* further document conversion work

* further document conversion work

* Added advanced mesh rendering details and 2D graphics details.

* Starting Atlantis Manual

* further document conversion work

* further document conversion work

* Almost there...

* further document conversion work

* Atlantis Manual finished.

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* initial work in updating cmake files

* corrected silly typo and added missing argument

* deleting old doc files

* updating cmake file with deleted folder

* another cmake update

---------

Co-authored-by: GLS-SSV <GLS-SSV@users.noreply.github.com>
Co-authored-by: jarmonik <jnikkanen@kymp.net>
Co-authored-by: jarmonik <88397245+jarmonik@users.noreply.github.com>
n7275 pushed a commit to n7275/orbiter that referenced this pull request Sep 28, 2024
* initial work in converting existing documentation to LaTeX sources

* added alert and code blocks

* >> added cover logo

>> further work in document structure

* further work in demonstrating original document reproduction

* improvements and additions to common packages

* further document conversion work

* added more packages and code keywords

* further document conversion work

* further document conversion work

* further document conversion work

* added "MESH code" language, for styling purposes

* further document conversion work

* further document conversion work

* further document conversion work

* Added advanced mesh rendering details and 2D graphics details.

* Starting Atlantis Manual

* further document conversion work

* further document conversion work

* Almost there...

* further document conversion work

* Atlantis Manual finished.

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* initial work in updating cmake files

* corrected silly typo and added missing argument

* deleting old doc files

* updating cmake file with deleted folder

* another cmake update

---------

Co-authored-by: GLS-SSV <GLS-SSV@users.noreply.github.com>
Co-authored-by: jarmonik <jnikkanen@kymp.net>
Co-authored-by: jarmonik <88397245+jarmonik@users.noreply.github.com>
n7275 pushed a commit to n7275/orbiter that referenced this pull request Dec 29, 2024
* initial work in converting existing documentation to LaTeX sources

* added alert and code blocks

* >> added cover logo

>> further work in document structure

* further work in demonstrating original document reproduction

* improvements and additions to common packages

* further document conversion work

* added more packages and code keywords

* further document conversion work

* further document conversion work

* further document conversion work

* added "MESH code" language, for styling purposes

* further document conversion work

* further document conversion work

* further document conversion work

* Added advanced mesh rendering details and 2D graphics details.

* Starting Atlantis Manual

* further document conversion work

* further document conversion work

* Almost there...

* further document conversion work

* Atlantis Manual finished.

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* initial work in updating cmake files

* corrected silly typo and added missing argument

* deleting old doc files

* updating cmake file with deleted folder

* another cmake update

---------

Co-authored-by: GLS-SSV <GLS-SSV@users.noreply.github.com>
Co-authored-by: jarmonik <jnikkanen@kymp.net>
Co-authored-by: jarmonik <88397245+jarmonik@users.noreply.github.com>
Xyon pushed a commit that referenced this pull request Dec 29, 2024
* Conversion of existing documentation to LaTeX sources (#438)

* initial work in converting existing documentation to LaTeX sources

* added alert and code blocks

* >> added cover logo

>> further work in document structure

* further work in demonstrating original document reproduction

* improvements and additions to common packages

* further document conversion work

* added more packages and code keywords

* further document conversion work

* further document conversion work

* further document conversion work

* added "MESH code" language, for styling purposes

* further document conversion work

* further document conversion work

* further document conversion work

* Added advanced mesh rendering details and 2D graphics details.

* Starting Atlantis Manual

* further document conversion work

* further document conversion work

* Almost there...

* further document conversion work

* Atlantis Manual finished.

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* further document conversion work

* initial work in updating cmake files

* corrected silly typo and added missing argument

* deleting old doc files

* updating cmake file with deleted folder

* another cmake update

---------

Co-authored-by: GLS-SSV <GLS-SSV@users.noreply.github.com>
Co-authored-by: jarmonik <jnikkanen@kymp.net>
Co-authored-by: jarmonik <88397245+jarmonik@users.noreply.github.com>

* Updating and correcting the new documentation (#500)

* initial work in updating and correcting documentation

* more doc updates

* more doc updates

* more doc updates

* more doc updates

* more doc updates

* more doc updates

* more doc updates

* more doc updates

* more doc updates

* more doc updates

* more doc updates

* more doc updates

* more doc updates

* more doc updates

* more doc updates

* more doc updates

* more doc updates

* Move gravity model info to its own section

* more doc updates

* updated DrawOrbits image

* removed DrawOrbit image TODO

---------

Co-authored-by: GLS-SSV <GLS-SSV@users.noreply.github.com>
Co-authored-by: Matthew W Hume <mtthwhm@gmail.com>

---------

Co-authored-by: GLS-SSV <88407628+GLS-SSV@users.noreply.github.com>
Co-authored-by: GLS-SSV <GLS-SSV@users.noreply.github.com>
Co-authored-by: Matthew W Hume <mtthwhm@gmail.com>
@GLS-SSV GLS-SSV deleted the documentationrework_part1_conversion branch January 2, 2025 12:18
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants