Lua API Documentation Cleanups

[rubenwardy]

The aim of the PR is to increase the readability of lua_api.txt, and to place everything into nicer sections

• Add game dir structure docs
• Put all mod and game info into their relevant sections
• Remove incorrect mod location info
• For registered id section, make main heading match contents (ie: aliases makes sense in a reg.id. section, but not in a naming conventions for reg.id. section)
• Use list rather than headings for texture modifiers - increases readability imo, and is also more consistent
• Put simple sound spec into definitions of simple things
• Clean up nodes, paramtype, and draw type sections

[SmallJoker]

This list style should be changed a bit. I think this looks a bit strange in a graphical markdown view.

[rubenwardy]

I agree. It also breaks my highlighter. Maybe something like:

C:.
├───AdminScripts
├───iissamples
├───mailroot
│   ├───Badmail
│   ├───Drop
│   ├───Mailbox
│   ├───Pickup
│   ├───Queue
│   ├───Route
│   └───SortTemp
├───Scripts
└───wwwroot
    ├───aspnet_client
    │   └───system_web
    │       └───1_1_4322
    │           └───_vti_cnf
    ├───images
    ├───_private
    └───_vti_log

[SmallJoker]

Windows' tree output format is good but needs a space between the last dash and name.
Otherwise LGTM.
EDIT: http://dev.minetest.net/Installing_Mods#Example_structure

[paramat]

Yes please format in plain text as in comment above.

[paramat]

Please focus on readability in .txt form, not MD graphical form. The file is viewed as .txt far more often than MD graphical.
Why is this document formatted for MD at all? It is viewed as normal text 99% of the time and the added MD symbols make it visually messy.
Please can we remove all MD format changes? that was a mistake.

[rubenwardy]

Part of my changes is to try and make it easier to read - by removing pointless ` ticks, and using a list rather than annoying headings

[paramat]

Good, might as well remove all MD formatting then.

[rubenwardy]

Nope, it's still useful to make it consistent and also allows HTML conversion

[paramat]

Ok, allowing to link to a section is useful, that should be kept of course.

[paramat]

Also, if we were not using 'pos' with angled quote marks we would be using 'pos' which is not much different, so that is ok too.
Looking at your modding book i think you're the ideal person to work on this.

[numberZero]

looks nice. just don’t forget there is vim, it uses the markup too ;) (although it can’t recognize the file type automatically, needing :set filetype=markdown)

[rubenwardy]

closing as heavily WIP, and probably needs restarting