📄 Documentation: Reascripthelp with Styles and Filtering Tables

[amagalma]

Also, this doesn't look right:



The horizontal line and the spacing should be below the function explanation, not above it.

[X-Raym]

So I fix my parser and the doc.

It seems that between v6.18 and v6.23, "EEL" has been replaced by "EEL2" mentions.

This completely broke my parser and inject two times the functions.



1 hour and half to find the source of the issue 🙄



Doc fixed and updated anyway!


PS : now I understand why the previous html file was two times bigger than usual.

[amagalma]

Thanks! Works great (again) now!

[nofish]

Thanks!

[nofish]

There seems to be the GUID line missing.
From generated Reaper doc:


This was added in v6.13+dev0904.

[X-Raym]

@nofish
I don't see this on REAPER v6.23 generated doc.... unreleased, or undocumented things ?

[nofish]

Ah right, seems it was added with Razor Edit branch which isn't released yet (it's in current RC4).
Sorry for false alarm

[X-Raym]

So in REAPER v6.24 you can press F1 on a function in the IDE and it open (and regenrate) the reascripthelp.html page. Cool!


But better if it load this web API doc page right ? :P


I tried several browser addons solutioon, non work.


But with Greasemonkey (an browser addon to add custom javascript to any webpage)... I made it :P


Here is the code:

https://gist.github.com/X-Raym/98eca...407bb9f7b10a0f


with this, pressing F1 on IDE will openr eascript.html and redirect ASAP to my API doc.


You can mod the script so that it doesnt d that automatically but based on a keypress for eg.


Cheers !

[amagalma]

Great! Thanks!


Would it be possible to make it not open a new tab every time F1 is pressed?.. It would need a few lines added to the script, but I am not familiar with JavaScript in order to do it. Pseudo code:

if( window.location.toString().search("reascripthelp.html") >= 0 ) {
   if( window.location.toString().search("https://www.extremraym.com/cloud/reascript-doc/") >= 0 ) {
      close the opened tab and load it to the existing window
   } else {
      window.location.replace("https://www.extremraym.com/cloud/reascript-doc/" + window.location.hash );
   }
}

[X-Raym]

Greasemonkey (or Tapermonkey for chrome) are run on web page context, not browser, so it can't access other tabs.


Maybe use an addon like Duplicate Tab closer to close previously opened ones.. https://addons.mozilla.org/fr/firefo...content=search


I will not investigate too much time on finding workarround though, I already have the web page always open. :P

[amagalma]

Ok! Thanks!

[X-Raym]

ImgGUI added to the doc

[nofish]

Originally Posted by X-Raym

ImgGUI added to the doc

Now that your site got even bigger (and who knows what other extensions come in future ) I thought it could be nice being able to filter by extension.
Similar to currently being able to filter by Language ('Display Lua only' etc.), just per extension.

Would do you think about it, would it be hard to implement?

edit:
On second thought, we can search/filter by extension prefix (SWS_, JS_, ImGUI_..) I think that's fine.

[X-Raym]

On second thought, we can search/filter by extension prefix (SWS_, JS_, ImGUI_..) I think that's fine.

And also NF_, very useful :P

[Meo-Ada Mespotine]

BTW, do you feature OSARA as well? It's just one function but should be part of the docs anyway...

[X-Raym]

I dont have up to date version of osara on my config so not at this moment.

[X-Raym]

• REAPER v6.30 / SWS v2.12.1.3 / Reapack v1.2.3.1 / JS_ReaScript API v1.220 / ReaImGui v0.5

Not sure why but it has become slow on my firefox,
maybe I have too much addon
but I'll surely try to make the HTML even cleaner as I realized that it has errors now (non which prevent render but which maybe could prevent good and faster rendering ? Has anyone found issue ?)

[nofish]

The site updating when typing in the filterbox is quite slow for me for quite some time now (seems to vary though).

[X-Raym]

Maybe I will need to put ReaImGUI functions on a dedicate page... there are just so many of them !

[nofish]

Maybe one page with ReaImGUI and JS extension functions (and all future extensions to come)?
So (only) people using these will see them if wanted?

(Ok, same could be done for the SWS functions, but since SWS is (imo) so common it may feel like almost native. :P But fine for me also if it moved to a extension dedicated page.)

Thanks for the update btw.

[X-Raym]

It is only ReaUmGUI which is huge, it almost double the size of document, it is 1.5 MB now which is use for just pure HTML.
I will also check if the html can be even more consize. A simple class name change can be several Ko of diff because repeated so many times.
But in other browser like Brave it works very nicely so.....

[X-Raym]

@nofish
THx for the report



simple SSL certificate expiration


I just renew it


Thx!

[nofish]

Thanks.
(and sorry for the confusion, deleted post and moved to Slack PN because I wasn't sure if you're ok with mentioning publicly...)

[X-Raym]

Poll: do you see any advantage of keeping the firsts paragraphs of the doc (the one speaking how to use EEL and Python etc), considering that these information are already available elsewhere on reaper.fm ? Aka, are you ok for making this page a bit lightweight by keeping only sidebar, main infos and definitions list ?


I'm trying to make my parser simpler, and skipping this section will help save some dev time spent on correcting HTML :P

[Meo-Ada Mespotine]

Originally Posted by X-Raym

Poll: do you see any advantage of keeping the firsts paragraphs of the doc (the one speaking how to use EEL and Python etc), considering that these information are already available elsewhere on reaper.fm ? Aka, are you ok for making this page a bit lightweight by keeping only sidebar, main infos and definitions list ?


I'm trying to make my parser simpler, and skipping this section will help save some dev time spent on correcting HTML :P

Funny. I think about putting these sections into a dedicated "How To ReaScript"-page in my docs for the same reason

[nofish]

Originally Posted by X-Raym

Aka, are you ok for making this page a bit lightweight by keeping only sidebar, main infos and definitions list ?

Yes..

[X-Raym]

Can you please try the new version ?

EDIT: now live at the regular URL
https://www.extremraym.com/cloud/reascript-doc/


The main diff is that there is no intro text, just list of functions, and that is 99.999% valid html (there is just some invalid character in ids, for some compatibility based on original document). it is mostly HOW it is generated, which is now just a double click on a python script, which means that I will be able to update this way more easily (... well... I have spend days to save few minutes for each times.... but you know sometimes, these few minutes are just too much friction :P)


if it is good, I'll make it live.


Let me know if you see any error in the document (things which are not displayed well).



Thx!

[nofish]

Originally Posted by X-Raym

Let me know if you see any error in the document (things which are not displayed well).

It's hard to spot any quirks with this big amount of functions but at first glance it looks fine to me.

Thanks for continously maintaining it btw., invaluable for me when doing Reaper coding.

[X-Raym]

@nofish
That is all I wanted to hear :P


It is now live at the regular address!

CTRL/CMD + MAJ + R to refresh the page onj your browser if loaded from cache (just checked update date written on the top of the page).

[MonkeyBars]

What regular address? Maybe you should add it to OP?

[X-Raym]

@MonkeyBars
Indeed, the OP surely deserved an update. Done!

[MonkeyBars]

Originally Posted by X-Raym

@MonkeyBars
Indeed, the OP surely deserved an update. Done!

Thanks! Been using your site for weeks. By far the most convenient way to reference ReaScript functions. Appreciate your efforts a lot

[X-Raym]

@MonkeyBars
Thx ! Knowing that this site is actually helpful is a big motivator to continue its enhancement 😉

[MonkeyBars]

Hi X-Raym,

You're simply a legend

I only just started scripting. I took on an existing unfinished project. It's huge so I need all the help I can get, and it's so great to have a proper function docs tool to look up API hooks nearly instantly.

My project was started on this thread
https://forum.cockos.com/showpost.ph...&postcount=212

Once I have the beta ready I'd love to get your opinion on the codebase. Don't worry, it's only 1500 lines :')

[X-Raym]

@MonkeyBars

You're simply a legend

Haha what an empowering compliment 💪🤓



Non-Destructive glue hm ? Well.. that's pretty hard for a first script 😜 Even now I wouldn't have jump on it. You will become a legend as well when you will succeed !

[MonkeyBars]

Originally Posted by X-Raym

You will become a legend as well when you will succeed !

Indeed I will!!

💪🤓

[X-Raym]

Updated with REAPER v6.47 / SWS v2.13.0.0 / Reapack v1.2.4rc1 / JS_ReaScript API v1.301 / ReaImgui v0.5.10


JS_ReaScript API got some new ZIP related features.

[nofish]

Thanks.
Just to note (to avoid any confusion) SWS v2.13 is currently still pre-release.

[X-Raym]

For people who find my doc page slow, please try this prototype


http://www.extremraym.com/cloud/reas...c/index_3.html


and please please please if you have issue, report ! seems it has performance issue since months for some people and no one told me ��
For info, even the old version was working extra fast on my end.


Next and final step of this protoype is substring highlight on filter. I will write this from scratch, cockos style (no dependency!).

EDIT link edited

[MonkeyBars]

The prototype string filter works faster than the old page for me (macOS Chrome).