Why Lua API documentation in KB got divided into sections?

5 replies [Last post]
UltiMaxKom
UltiMaxKom's picture
User offline. Last seen 1 hour 17 min ago. Offline
Joined: 2016-06-26
Posts: 371

"Why Lua API documentation in KB got divided into sections?"

I had to open 10 tabs, 10 Chrome tabs, to open the entirety of Lua API in our Knowledge Base. The day before I went to my usual long offline session, it all only takes 1 tab. 1 tab for all the API is great because not only it's just a single page, it doesn't drain up my entire RAM and it only takes one quick-skim on the API long list to get what I needed. Now there's 10:

LuaAPI - Head ; Excluded
LuaOverview
LuaGlobals
LuaEvents
LuaGameplay
LuaGears
LuaStats
LuaGUI
LuaAudio
LuaUtil
LuaLibraries
+SubSections - (?) ; Excluded

They needed to be re-loaded each time I visit them because I don't have much of a RAM, and it takes quite a time to load any.

It may be great for some to get it sectioned, but I love my old rusty one-page-for-all Lua API. Is there anything that can satisfy my needs here? Maybe by doing a ritual or two, or something...


[E.1] Actually, after a deep after-thought, it even irritates me knowing that I'd need to go over 10+ tabs to see all the function list scattered all over the places compared to the 1 tab on the good ol' days. That's very impractical when I need to search just for one function, don't you think? I really think that's the case. I mean, it really is as of right now.

Long story short:
THERE NEEDS TO BE ONE-LIST-OF-ALL-FUNCTIONS IN KB.
Please, distributing them into many places turned me off when I wanted to "continue" my almost-dead "work". Hmm, maybe the right word is to "Redo" my work, or "Reboot". That being said, I do really need a quick way to see the many functions that I needed, more so after 1.0.0 overhauls and stuff. The separated sections simply just won't do.



I definitely missed something here, I hope I did. I hope there is really a one-page LuaAPI somewhere that I just haven't found or something...

╓──────────────────╖⠀⠀⠀⠀╓──────────────────╖
HP: ██████████ 1E9/1E9⠀⠀⠀⠀⠀⠀1E9/1E9 ██████████ :MP
╙──────────────────╜⠀⠀⠀⠀╙──────────────────╜

Wuzzy
Wuzzy's picture
User offline. Last seen 1 hour 48 min ago. Offline
Joined: 2012-06-20
Posts: 1125

When the HWKB was one page only, we got shouted at because it was too large and too hard to navigate.
When the HWKB became multiple pages, we got shouted at because it has multiple pages.

No matter what we do, it is wrong.

OK, the true reason why the pages got split is because it was simply too painful for me to edit one giant page.

I don't like to revert this tbh.

But maybe the solution would be to create an additional “index” page that just lists all functions. But maintaining such an index by hand would be painful. Ideally, this would be auto-generated.

Another idea would be to just concatenate every page into one giant page, automatically.

Hi, I am a Hedgewars developer. Smile I accept personal donations in bitcoin. Heart 17fsUywHxeMHKG41UFfu34F1rAxZcrVoqH

KoBeWi
KoBeWi's picture
User offline. Last seen 3 hours 25 min ago. Offline
Joined: 2010-12-25
Posts: 513

Or a downloadable PDF//HTML version of LUA API?

UltiMaxKom
UltiMaxKom's picture
User offline. Last seen 1 hour 17 min ago. Offline
Joined: 2016-06-26
Posts: 371

Wuzzy allegedly wrote:
...
No matter what we do, it is wrong.

Definitely not true. Why not do a mix of both? Plus, there's always a soluti-

Wuzzy allegedly wrote:
...OK, the true reason why the pages got split is because it was simply too painful for me to edit one giant page.

Yeaah... I could see that before asking... Kinda. Nevertheless, thank you for being transparent there.

Wuzzy allegedly wrote:
I don't like to revert this tbh.

Don't revert it, no need to.

Wuzzy allegedly wrote:
But maybe the solution would be to create an additional “index” page that just lists all functions. But maintaining such an index by hand would be painful. Ideally, this would be auto-generated.

Thank you for giving the solution to the first quote.

Wuzzy allegedly wrote:
Another idea would be to just concatenate every page into one giant page, automatically.

Also this. No, I mean, THIS! This is the way, Wuzzy! Go go #teamwuzzy go!

KoBeWi allegedly wrote:
Or a downloadable PDF//HTML version of LUA API?

Just like what LOVE2D, Godot, or any other community API doc do? Brilliant. KoBeWi always shows us the way, he's the true queen. *spit spit* (Sorry for the stupid necromancy)
...(Note: Yes, I downloaded the LOVE2D entire API some time ago. Also no, no sarcasm included in any part of this post, including the disclaimer's own bit)


Automatic one is surely the right system here. That, if you want to not torture yourself and others @Wuzzy. Mechanization is always the way to go after the "Nature finds a way" went obsolete. Also, the concatenation method sounds easy enough to do, so please do. I'd sacrifice some lambs tonight just for this, don't worry.
...(In all seriousness, thank you for the responses, you two. I really looking up for it)

╓──────────────────╖⠀⠀⠀⠀╓──────────────────╖
HP: ██████████ 1E9/1E9⠀⠀⠀⠀⠀⠀1E9/1E9 ██████████ :MP
╙──────────────────╜⠀⠀⠀⠀╙──────────────────╜

nemo
nemo's picture
User offline. Last seen 11 hours 39 min ago. Offline
Joined: 2009-01-28
Posts: 1753

FWIW, I also expressed concern about searchability Smile

Maybe as a compromise entire function list could be on an alphabetic index page with links-only. Would be fairly trivial to generate that.

--
Oh, what the heck. 1PLXzL1CBUD1kdEWqMrwNUfGrGiirV1WpH <= tip a hedgewars dev

UltiMaxKom
UltiMaxKom's picture
User offline. Last seen 1 hour 17 min ago. Offline
Joined: 2016-06-26
Posts: 371

nemo allegedly wrote:

FWIW, I also expressed concern about searchability Smile

Maybe as a compromise entire function list could be on an alphabetic index page with links-only. Would be fairly trivial to generate that.


I love the fact that you do express concern, thank you, but I think an alphabetic index page is still an underdo. At least get it into a proper sectioned function list, even if it's with links only. Group them together just like the old one does but with the (Better) current format instead. I think that would still be fairly trivial to automize.

╓──────────────────╖⠀⠀⠀⠀╓──────────────────╖
HP: ██████████ 1E9/1E9⠀⠀⠀⠀⠀⠀1E9/1E9 ██████████ :MP
╙──────────────────╜⠀⠀⠀⠀╙──────────────────╜

Copyright © 2004-2017 Hedgewars Project. All rights reserved. [ contact ]