According to changes in opentx/opentx#3791 (add new rotary events)

Lua API docs (in opentx repository) are mostly done. They now need some attention in the grammar and spelling department.

@dsbeach whenever you have the time and will 😉

OpenTX 2.1.x (after pull opentx/opentx#3011 is merged) has Lua subset of io library implemented with a few differences:

Available functions:

• io.close()
• io.seek()
• io.open()
• io.read()
• io.write()

Differences from standard library:

io.open(filename [, mode])

mode only supported mode strings are:

• "r" read access, file is opened if it exists and read pointer is located at the beginning of file (default)
• "w" write access, file is opened and truncated (or created if it did not exist)
• "a" write access, file is opened (or created if it did not exist) and write pointer is located at the end of the file.

Returns file object.

io.seek(fd, offset)

fd file object
offset is always based from the beginning of the file. If offset is bigger than the file size, the pointer is moved to the end of the file.
Other standard seek bases (like "cur", "end") are not supported.

io.read(fd, length)

fd file object
length number of characters to read.

Other read commands (like "_all") are _not supported*.

Return: string, number of characters returned is <= length. If end of file is reached, then empty string is returned.

tools/generate-api-docs.py
line 279
May need /next/ replaced with /2.2/

In Lua Guide v2.3 function_scripts.md, at the bottom of the page, first line of the advanced example
local lstannounce
is unnecessary (not used).

Content should go into https://github.com/opentx/lua-reference-guide/blob/opentx_2.2/part_v_-_converting_opentx_21_scripts.md

Modify the generate-api-docs.py script to automatically update the appropriate sections of SUMMARY.MD.

I can do that with the Radiomaster TX16S
Call up INAV LUA menu with the left stick and scroll up and down within this munu by moving the right stick. Unfortunately it does not work with the right stick to change the values ​​and to leave the menu again. The horizontal movement of the right stick does not work! This is not a problem with the transmitter Jumper T16 and it is possible to change the settings in the INAV LUA menu with the right stick and to exit the menu again.
I tested it with the current openTX-version also with the last nightly-version.

Link does not exist for Part I - One-Time Scripts. Also the file one-time_scripts.md seems to be missing in v2.3 Lua guide (works in v2.2 Lua Guide).

The comments in the SUMMARY.md file cause the gitbook numbering for chapters to be wrong, example:

3. Part III - OpenTX Lua API Reference

    3.1. Constants
        3.1.1. Key Event Constants

4. General Functions

    4.1. GREY()
    4.2. defaultChannel(stick)
    4.3. defaultStick(channel)

To fix it the delimiters should be at the end of the lines like so:

   * [General Functions](general/general_functions.md) [//]: <> (LUADOC-BEGIN:general)
      * [GREY()](general/GREY.md)
      * [popupInput(title, event, input, min, max)](general/popupInput.md)       [//]: <> (LUADOC-END:general)  
   * [Model Functions](model/model_functions.md) [//]: <> (LUADOC-BEGIN:model)
      * [model.defaultInputs()](model/defaultInputs.md)

mix.md has broken links for:

1. script init function (optional, see Init Function Syntax)
2. script run function (see Run Function Syntax)

The examples in the manually generated sections of the documentation should have download links where appropriate. NOTE - this will require manual synchronization.

Alternatively - format all the manual examples with a reasonable maximum line width.

Original idea came from Bertrand.

We should try to develop a system that allows us to document OpenTX Lua API functions in the source code files (like Doxygen style documentation) and then have a python script that will auto-generate files and their contents in markdown format that will be directly useable in the gitbook.

Other parts of the Lua manual will still be developed in the current way. So the automatic docs generation would only document the https://github.com/opentx/lua-reference-guide/blob/master/part_iii_-_opentx_lua_api_reference.md

So the process would be:

• write documentation for each Lua exported function in the source code, rigth there where the actual function implementing it is defined. This way we have a better chance to keep the actual function functionality and it's documentation in sync.
• in-source documentation format is still yet to be decided, possible options are:
  • directly use the markdown
  • use (simplified) Doxygen format
• when we decide to update the docs (gitbook) we run the custom python script that will:
  • parse lua_api.cpp file from OpenTX repository
  • look for special comment sections that contain documentation
  • parse and format each documentation section and generate a markdown file for each function.
  • script could also generate a subsection of index for generated functions (that goes into SUMMARY.md)

Comments welcome

Thera are no more txt files of valid sources for getFieldInfo(name) function

https://doc.open-tx.org/opentx-2-3-lua-reference-guide/part_iii_-_opentx_lua_api_reference/general-functions-less-than-greater-than-luadoc-begin-general/settelemetryvalue link listing the units is unfortunately broken

Will this be updated any soon?

https://opentx.gitbooks.io/opentx-2-2-lua-reference-guide/content/general/playNumber.html

My percent value doesn't work anymore

If a function name (different from the current function) is found in a function documentation, replace it with a link to that function.

Example: in module.setModule() docs, replace reference to module.getModule() with a link syntax [module.getModule()](model/getModule.md)

Only do replace if the actual documentation for that function exists (has been parsed in the current script run).

I plan on doing up a list/table for LCD dimensions LCD_W/LCD_H for the radios... if an admin creates a place holder page for me in the appendix I'll add in the contents.. please @RCdiy me when added...

Current documentation implies that scripts won't crash radio. Suggest adding documentation that programmers must ensure drawing within lcd limits. See discussion https://www.rcgroups.com/forums/showthread.php?2180477-LUA-scripting-Technical-discussion/page149#post37781551

... which runs when the switch is not active. As of 2.2.0RC1
See opentx/opentx#3609

Documentation for getFieldInfo(name) references below:

The list of valid sources is available:
for OpenTX 2.0.x at http://downloads-20.open-tx.org/firmware/lua_fields.txt
for OpenTX 2.1.x at http://downloads-21.open-tx.org/firmware/lua_fields.txt (depreciated)
for OpenTX 2.1.x Taranis and Taranis Plus at http://downloads-21.open-tx.org/firmware/lua_fields_taranis.txt
for OpenTX 2.1.x Taranis X9E at http://downloads-21.open-tx.org/firmware/lua_fields_taranis_x9e.txt

The last two links above result in '404 - not found'

The docs will have an optional section:

@status current Introduced in 2.0.0, changed in 2.1.0