Update/add to documentation for controls

[readyready15728]

Took me a little to remember that I can view my current contracts by pressing F5 twice. That (and the primary function of F5) isn't mentioned here:

https://wiki.alioth.net/index.php/Oolit ... d_Controls

There is a reference sheet on GitHub which does mention this but it's stamped with "Outdated":

https://github.com/OoliteProject/oolite ... liteRS.pdf

I'd like to do more than complain at some point BTW. I don't know any Objective-C but I guess documentation could be a start.

[Cholmondely]

A year and a half ago, Phkb produced a new OoliteRS.pdf which he asked for help editing. There have been more changes to v.1.91 since October 2023, so he may well have something for you to help with.

Here's the PDF's of the most recent update I've made to the docs:
OoliteRS.pdf
OoliteReadMe.pdf

[another_commander]

Only the PDF Reference Sheet is outdated. The .odt (LibreOffice) source Reference Sheet file found in the same Doc folder on github is fully up to date.

[hiran]

Only the PDF Reference Sheet is outdated. The .odt (LibreOffice) source Reference Sheet file found in the same Doc folder on github is fully up to date.

Plus the odt document is bundled into future releases - if there are any.
The PDF version is there solely because not having it breaks the build.

[another_commander]

Plus the odt document is bundled into future releases - if there are any.

Actually, just checked and this is not the case. The current pre-release installers contain the outdated PDFs instead of the current ones.

[hiran]

Plus the odt document is bundled into future releases - if there are any.

Actually, just checked and this is not the case. The current pre-release installers contain the outdated PDFs instead of the current ones.

That is unexpected.

Here is the line that generates fresh PDFs based on the .odt:
https://github.com/OoliteProject/oolite ... ll.yml#L49

And here the generated PDF is injected into the build of the installer:
https://github.com/OoliteProject/oolite ... l.yml#L163

Did you build the installer you are referring to locally? I faintly remember when I removed the outdated PDFs the local builds would fail. The commit history states so...
https://github.com/OoliteProject/oolite ... 003c98d688

[another_commander]

No, I downloaded from GitHub.

[hiran]

No, I downloaded from GitHub.

Interesting. When I get to it I'll take a look. May need your support as I don't do Windows...

[another_commander]

Why not just revert to using the actual PDFs in the source tree instead of outdated dummy ones? Here is some justification:

1. If the PDFs are needed to complete local installer builds, might as well use the actual correct ones there. I note that release builds of the game should always be manually made because we need to be able to test / virus scan the binaries before publishing. This elevates the importance of manual builds and the importance of ensuring that the correct files - no dummy ones - are present.
2. If people look at the github source tree for those PDFs as has recently been the case, it would be best if they found the actual correct ones there rather than outdated dummy ones.
3. The PDFs we pack with the game are changed once every two or three years. It is really, really easy for anyone making changes to the .odt files to just run a conversion to PDF and commit the PDFs too at the same time. After all, this was how we were doing it in the past and never had a problem with it, not even once. The PDFs can be double-checked just before any release (and they should be checked as part of the release process anyway) and even if found outdated, they could be recreated just prior to release.
4. Removing the conversion to PDF from the github build script would simplify it and help it run faster.