Online documentation

For test results, bug reports, announcements of new builds etc.

Moderators: winston, another_commander, Getafix

User avatar
hiran
Theorethicist
Posts: 2516
Joined: Fri Mar 26, 2021 1:39 pm
Location: a parallel world I created for myself. Some call it a singularity...

Re: Online documentation

Post by hiran »

another_commander wrote: Thu Jan 22, 2026 8:00 pm
hiran wrote: Thu Jan 22, 2026 7:17 pm
That is interesting. I changed from that behaviour as more than once the docs and the pdfs were not updated in sync.
They don't have to be updated in sync. The only time they need to be synced is just before release. Every two or three years (or 5+ in our case).
Thus a developer would simply have to update the odt, the rest would be automatic. Also for users it would just take a moment to check the version on the page to tell if they are looking at the correct documentation.
Perfectly ok with that, provided that it works. The problem is that it currently doesn't work. Either it gets fixed to work, or it gets reverted to the past state.
Remember that conversation? viewtopic.php?t=21395

You and me made it work.
Sunshine - Moonlight - Good Times - Oolite
User avatar
mcarans
---- E L I T E ----
---- E L I T E ----
Posts: 656
Joined: Sun Jun 20, 2010 6:00 pm

Re: Online documentation

Post by mcarans »

hiran wrote: Thu Jan 22, 2026 9:48 pm
Did you check whether you have the the Microsoft Fonts installed? For Ubuntu they come in an extra package.
Yes I have those installed.
User avatar
mcarans
---- E L I T E ----
---- E L I T E ----
Posts: 656
Joined: Sun Jun 20, 2010 6:00 pm

Re: Online documentation

Post by mcarans »

another_commander wrote: Thu Jan 22, 2026 9:35 pm
I'll check and get back to you in a few hours. I have shut down for tonight - late night here and early wake up tomorrow...
I've made a trivial PR that fixes the issue with the pdfs not being overwritten: https://github.com/OoliteProject/oolite ... 42/changes

You're welcome to press ahead with the 1.92 release and we can look at readthedocs after.

My fixed up reference sheet odt to test is now here as I renamed that branch: https://github.com/mcarans/oolite/blob/ ... liteRS.odt. However, I looked at the generated one in the .exe and it looks better so I think someone with a working LibreOffice will need to fix up the original file to remove Mac keys etc. (and any other odt files that need fixing) because the layout is nigh on unfixable in my version. Aside from the layout issues, it's hard to track changes in GitHub compared to other textual formats.

Apparently there's a new simpler typesetting alternative to LaTeX (which I never learnt) called Typst: https://github.com/typst/typst. Looks nice, but maybe markdown is good enough.

The privacy policy markdown is here: https://github.com/mcarans/oolite/blob/ ... privacy.md

On readthedocs, it is here: https://oolite.readthedocs.io/en/latest/privacy/
another_commander
Quite Grand Sub-Admiral
Quite Grand Sub-Admiral
Posts: 7134
Joined: Wed Feb 28, 2007 7:54 am

Re: Online documentation

Post by another_commander »

mcarans wrote: Fri Jan 23, 2026 1:48 am
I've made a trivial PR that fixes the issue with the pdfs not being overwritten: https://github.com/OoliteProject/oolite ... 42/changes
Glad to see it was a trivial fix after all. The PR has been merged.
My fixed up reference sheet odt to test is now here as I renamed that branch: https://github.com/mcarans/oolite/blob/ ... liteRS.odt. However, I looked at the generated one in the .exe and it looks better so I think someone with a working LibreOffice will need to fix up the original file to remove Mac keys etc. (and any other odt files that need fixing) because the layout is nigh on unfixable in my version. Aside from the layout issues, it's hard to track changes in GitHub compared to other textual formats.
Checked your .odt and yeah, it is kind of OK but not exactly perfect on my LibreOffice. Don't worry about it, I'll try to set time aside to work on removing the deprecated stuff and getting the docs finalized. I may need some help with the Linux parts of the Readme though as far as correctness of information is concerned.
Looks great, fantastic job. Thank you very much! Again, if there are any comments for improving the actual text of the policy from anyone reading here, they are most welcome.
User avatar
hiran
Theorethicist
Posts: 2516
Joined: Fri Mar 26, 2021 1:39 pm
Location: a parallel world I created for myself. Some call it a singularity...

Re: Online documentation

Post by hiran »

mcarans wrote: Fri Jan 23, 2026 1:48 am
Aside from the layout issues, it's hard to track changes in GitHub compared to other textual formats.
Maybe this could help: https://stackoverflow.com/questions/528 ... ith-output
It would allow to better track changes but still allow the comfort of a word processing UI. Haven't tested it though.
Sunshine - Moonlight - Good Times - Oolite
User avatar
Lone_Wolf
---- E L I T E ----
---- E L I T E ----
Posts: 777
Joined: Wed Aug 08, 2007 10:59 pm
Location: Netherlands

Re: Online documentation

Post by Lone_Wolf »

The odt looks good in both 25.2.7 and 25.8.4 on my archlinux system.
OS : Arch Linux 64-bit - rolling release

From: The Netherlands, Europe

OXPs : My user page (needs updating)

Retired, occasionally active
User avatar
mcarans
---- E L I T E ----
---- E L I T E ----
Posts: 656
Joined: Sun Jun 20, 2010 6:00 pm

Re: Online documentation

Post by mcarans »

Lone_Wolf wrote: Sat Jan 24, 2026 3:24 pm
The odt looks good in both 25.2.7 and 25.8.4 on my archlinux system.
I changed from Ubuntu's repo to LibreOffice's own to get 25.8.4.2 but that didn't fix the issue. However, I found the issue - another missing font not Microsoft TTF. I had to install: sudo apt install fonts-dejavu-extra

This gave me the missing DejaVu Condensed variant.
User avatar
mcarans
---- E L I T E ----
---- E L I T E ----
Posts: 656
Joined: Sun Jun 20, 2010 6:00 pm

Re: Online documentation

Post by mcarans »

I'm gradually populating readthedocs. You can see progress here: https://oolite.readthedocs.io/en/latest/. I've made some nice tables for Oolite's controls and other things.
Post Reply