Developing Lua Script Equivalent to API_Reference.pdf

[ThChicken]

Even with the orbiter_lua.chm file available in Orbiter 2024, I have found that it is still much easier to search the API_Reference.pdf for a necessary method, then search the GitHub code base for equivalent Lua method and usage examples. A Lua script equivalent to the API_Reference.pdf would be very welcome to Lua developers.

From my limited understanding, I believe a lot of the API documentation is developed from the code comments using Doxygen, and that may not be available/possible with Lua equivalents in the interpreter. I am curious to know what it would take to make such an equivalent document. If manual effort is needed to convert information for such a document, I'm willing to help if I can be useful toward this end.

[ThChicken]

I recently converted the orbiter_lua.chm file to HTML, and found that it was far easier to navigate and read in that format. Quite a lot of information was not rendering properly in the chm file, which may have been due to my being on a Linux box and or how xchm interacted with the file.

A fully searchable PDF version of this information would be ideal. The search functions in xchm and for HTML only work on the particular page you are viewing, so finding information using a keyword search must be done on all pages individually. In a PDF the whole document can be searched.

I still recommend that a PDF of this information would be desirable, but wanted to add this information about the chm files.