orbitersim / orbiter

Open-source repository of Orbiter Space Flight Simulator
MIT License
1.62k stars 220 forks source link

Documentation rework - part 2: Updates and corrections #440

Open GLS-SSV opened 9 months ago

GLS-SSV commented 9 months ago

The second of a pair of tickets for tracking (1) the conversion of the existing documentation to LaTeX and then (2) updating and correcting the new documentation, solving the existing documentation build issues and replacing binary source files with text files.

ADVANCED_CFG.tex Line 311: %TODO handle API doc reference

BASIC_FLIGHT.tex Line 264: %TODO handle transfer MFD

CREDITS.tex Line 5: %TODO review content Line 6: %TODO check websites online Line 7: %TODO handle dead websites? Line 70: %TODO gravity model entries should be moved to previous section? Line 341: %TODO name doesn't match what is shown in launchpad

EXTRA.tex Line 377: %TODO update image when degree sign is fixed

INSTALLATION.tex Line 9: %TODO update specs? Line 20: %TODO MSI still used? Line 16: %TODO update homepage? Line 17: %TODO add github download Line 26: %TODO update example folder name (no year?) Line 26: %TODO handle redist dependencies Line 27: %TODO mention orbiter_ng?

INTRODUCTION.tex Line 49: %TODO confirm websites work, and update homepage? Line 49: %TODO update homepage? Line 58: %TODO expand on dev manual Line 58: %TODO update homepage reference? Line 59: %TODO confirm websites work Line 66: %TODO disencourage printing? save trees?

LAUNCHPAD.tex Line 4: %TODO update launchpad images Line 5: %TODO update sections Line 247: %TODO switch italics below to alertbox or such?

MENU.tex Line 320: % TODO path (no more Orbitersdk\doc)

MFD.tex Line 887: %TODO gone? check transx status, add/replace here? Line 994: %TODO transx

NEW.tex Line 5: % TODO new features

SCRIPT.tex Line 8: %TODO does this manual below exist?

SOL.tex Line 160: %TODO move ref to references? Line 193: %TODO move ref to references? Line 453: %TODO add vesta, ceres, etc Line 520: %TODO add vesta, ceres, etc Line 548: %TODO add vesta, ceres, etc Line 586: %TODO add vesta, ceres, etc Line 614: %TODO add vesta, ceres, etc

SPACECRAFT.tex Line 75: %TODO confirm yaw range: 7.4 or 7.7 Line 253: %TODO add section link ("luamfd" or "luaconsole" or "console mfd" or "terminal mfd"???) Line 302: %TODO html doc link? Line 307: %TODO check keys are correct Line 1260: %TODO dragonfly communications section Line 1330: %TODO check "by 1/10th" vs "to 1/10th"

CONFIG.tex Line 38: %TODO handle legacy model link? or just mention it and don't detail it? or mention old documentation? Line 309: %TODO handle legacy model link? or just mention it and don't detail it? or mention old documentation? Line 963: %TODO nabla and delta symbols switched, check code to confirm what ID is what symbol Line 981: %TODO check code for actual colors

PLANETS.tex Line 29: %TODO handle legacy model link? or just mention it and don't detail it? or mention old documentation? Line 453: %TODO reference API manual? Line 515: %TODO shouldn't this be CELBODY2?

PUBLISH.tex Line 5: %TODO mention licensing

SCN_EDITOR.tex Line 5: %TODO mention (again) EditorCreate param, or leave this section just for ScnEditor customization? Line 58: %TODO fix path to file Line 121: %TODO fix path to file

SPACECRAFT.tex Line 346: % TODO handle API doc reference Line 707: % TODO fill section "lift and drag in transonic and supersonic flight" Line 712: % TODO fill section "angular moments and vessel stability" Line 1862: %TODO fill section "defining the hud in the virtual cockpit"

VESSEL_CFG.tex Line 126: %TODO handle API doc reference or explain here?

ORBITS.tex Line 9: % TODO fix repeated names

dynamics.tex Line 272: %TODO image pairs below overflow page, separate them and have captions and links for each, or just resize?

dynsurf.tex Line 9: %TODO introduction

gravity.tex Line 131: %TODO line too long Line 171: %TODO update file content below

INTRODUCTION.tex Line 6: %TODO add proper introduction

RecorderRef.tex Line 116: %TODO confirm alpha/beta are correct or they should match "aero tradition"?

GLS-SSV commented 6 months ago

PR for this ticket: #459