Go Back   Cockos Incorporated Forums > REAPER Forums > ReaScript, JSFX, REAPER Plug-in Extensions, Developer Forum

Reply
 
Thread Tools Display Modes
Old 02-04-2015, 11:02 AM   #1
X-Raym
Human being with feelings
 
X-Raym's Avatar
 
Join Date: Apr 2013
Location: France
Posts: 9,875
Default A bit of fun with reascript HTML

Do you ever feel the need to customize the auto-generated API ?




I do




Sortering table, filter table, responsive design, semantic color scheme, fixed menu, transition style...

Any other idea before I write a proper feature request ?

Last edited by X-Raym; 02-04-2015 at 02:47 PM.
X-Raym is offline   Reply With Quote
Old 02-04-2015, 11:12 AM   #2
Banned
Human being with feelings
 
Banned's Avatar
 
Join Date: Mar 2008
Location: Unwired (probably in the proximity of Amsterdam)
Posts: 4,868
Default

For the sake of clarity: none of this actually 'improves' or otherwise changes REAPER's API - all it does is navigate / change the layout of the HTML page that documents the API.

Which is still likely useful to some users, of course.
__________________
˙lɐd 'ʎɐʍ ƃuoɹʍ ǝɥʇ ǝɔıʌǝp ʇɐɥʇ ƃuıploɥ ǝɹ,noʎ
Banned is offline   Reply With Quote
Old 02-04-2015, 11:33 AM   #3
X-Raym
Human being with feelings
 
X-Raym's Avatar
 
Join Date: Apr 2013
Location: France
Posts: 9,875
Default

@banned
Usability improvements are still improvements

A commenter on my website about Learning ReaScript:
Quote:
Searching all the time through an alaphabetic list makes me crazy.
It's a bit sad if new potential scripters are discouraged by the actual API layout, isn't it ?

But if you have other ideas to share, feel free to do it :P

I made this customization because it is somehow based on the actual way the API is generated (so I guess it is easier to implement), but we can think of anything else !
X-Raym is offline   Reply With Quote
Old 02-04-2015, 02:25 PM   #4
Banned
Human being with feelings
 
Banned's Avatar
 
Join Date: Mar 2008
Location: Unwired (probably in the proximity of Amsterdam)
Posts: 4,868
Default

I'm not criticising your efforts at all - I'm just pointing out that "API" is not the same as "(HTML page with) API documentation". You seem to use the first while you mean the latter, which may cause confusion. I was confused by this thread's title, anyway.

Of course, improving the API documentation also enhances the usability of the API itself, but it's still quite a distinct concept to improving the API itself.
__________________
˙lɐd 'ʎɐʍ ƃuoɹʍ ǝɥʇ ǝɔıʌǝp ʇɐɥʇ ƃuıploɥ ǝɹ,noʎ
Banned is offline   Reply With Quote
Old 02-04-2015, 02:46 PM   #5
X-Raym
Human being with feelings
 
X-Raym's Avatar
 
Join Date: Apr 2013
Location: France
Posts: 9,875
Default

Hmm ok my bad, I don't use the terms "API" with the proper definition.

Indeed, I meant the "HTML DOCUMENT". --'
X-Raym is offline   Reply With Quote
Old 02-04-2015, 04:24 PM   #6
reddiesel41264
Human being with feelings
 
reddiesel41264's Avatar
 
Join Date: Jan 2012
Location: North East UK
Posts: 493
Default

Yes improved documentation navigation would be very useful.
__________________
http://librewave.com - Freedom respecting instruments and effects
http://xtant-audio.com/ - Purveyor of fine sample libraries (and Kontakt scripting tutorials)
reddiesel41264 is offline   Reply With Quote
Old 02-16-2015, 03:12 PM   #7
X-Raym
Human being with feelings
 
X-Raym's Avatar
 
Join Date: Apr 2013
Location: France
Posts: 9,875
Default

Does anyone know if we are the right to publish our custom version of reascript.html on this forum ?
I wrote a post to share my work with scripters out there, but I'm afraid it was deleted by moderation without warning
Is that possible or did I just press the wrong touch and my post never get posted ?
I guess the only way to know is to rewrite the post...

(the future new thread will aim to present my personal work on this subject, it is not a global discussion about what we could dream of, like this one. They use the same screenshot, but they are not clones).

Last edited by X-Raym; 02-17-2015 at 03:56 AM.
X-Raym is offline   Reply With Quote
Old 02-17-2015, 01:12 AM   #8
heda
Human being with feelings
 
heda's Avatar
 
Join Date: Jun 2012
Location: Spain
Posts: 7,239
Default

I personally think this HTML is a bit raw. It could include some code examples for the functions, better description of what the function does, and explaining the returning values, or formats... It is very difficult for someone learning. Just my experience. Now I know how to use it but it was intimidating at first. I guess.. if you are intimidated by it, you are not prepared to code. Anything that helps navigating in this HTML is great. X-Raym approach is a good effort.
heda is offline   Reply With Quote
Old 02-17-2015, 02:17 AM   #9
Banned
Human being with feelings
 
Banned's Avatar
 
Join Date: Mar 2008
Location: Unwired (probably in the proximity of Amsterdam)
Posts: 4,868
Default

Quote:
Originally Posted by heda View Post
I personally think this HTML is a bit raw. It could include some code examples for the functions, better description of what the function does, and explaining the returning values, or formats... It is very difficult for someone learning. Just my experience. Now I know how to use it but it was intimidating at first. I guess.. if you are intimidated by it, you are not prepared to code. Anything that helps navigating in this HTML is great. X-Raym approach is a good effort.
I agree the documentation could be improved and tutorials would be very useful, but I really don't like the idea of mixing API documentation and tutorials.
__________________
˙lɐd 'ʎɐʍ ƃuoɹʍ ǝɥʇ ǝɔıʌǝp ʇɐɥʇ ƃuıploɥ ǝɹ,noʎ
Banned is offline   Reply With Quote
Old 02-17-2015, 05:25 AM   #10
X-Raym
Human being with feelings
 
X-Raym's Avatar
 
Join Date: Apr 2013
Location: France
Posts: 9,875
Default

Meanwhile, if you want to have a look on what I manage to do...
X-Raym is offline   Reply With Quote
Old 02-17-2015, 04:06 PM   #11
planetnine
Human being with feelings
 
planetnine's Avatar
 
Join Date: Oct 2007
Location: Lincoln, UK
Posts: 7,924
Default

Search/filter would certainly be good for the documentation, I've found myself more than once copying the whole damned thing into a Notepad++ page just so I can search for stuff in it.

Keep up the enthusiasm X-Raym.



>
__________________
Nathan, Lincoln, UK. | Item Marker Tool. (happily retired) | Source Time Position Tool. | CD Track Marker Tool. | Timer Recording Tool. | dB marks on MCP faders FR.
planetnine is offline   Reply With Quote
Old 02-18-2015, 02:28 AM   #12
X-Raym
Human being with feelings
 
X-Raym's Avatar
 
Join Date: Apr 2013
Location: France
Posts: 9,875
Default

Quote:
Originally Posted by planetnine View Post
Keep up the enthusiasm X-Raym.
You made my day, sir :P
X-Raym is offline   Reply With Quote
Reply

Thread Tools
Display Modes

Posting Rules
You may not post new threads
You may not post replies
You may not post attachments
You may not edit your posts

BB code is On
Smilies are On
[IMG] code is On
HTML code is Off

Forum Jump


All times are GMT -7. The time now is 11:54 AM.


Powered by vBulletin® Version 3.8.11
Copyright ©2000 - 2024, vBulletin Solutions Inc.