PDA

View Full Version : FR: @help


sws
01-13-2008, 02:07 PM
I've been spending a lot of time digging through the vast repertoire of JS plugins in Reaper and often find myself having to inspect the code to figure out the intent/purpose of the plug. If there was a way to add help to the JS code it may encourage developers to document a little better.

I suggest:
1) A @help section that adds a "Help" button to the UI; where pressing help brings up the block of raw text contained from @help to the next section or EOF in the JS code.

2) sliderx_tooltip variables that contain a string that's displayed when the user hovers the mouse over a slider control.

Heck, I might even help document some of the existing plugs.

ph69
01-14-2008, 12:41 AM
That's a good idea.
Especially if you consider the modular synth thread, documentation can be a key for usability of our modules.

IXix
01-14-2008, 02:00 AM
+1, excellent idea!

earlabs
01-14-2008, 02:25 AM
bloody bbwilliant! +1

Jonas_Eriksson_Swe
01-14-2008, 04:04 AM
Yep, good one +1

When I write FX I usually put the Help-section as a comment at the top of the code (/* ... */) and add " -- click Edit for Help" in the desc. That way, clicking Edit brings up the help.

But a dedicated help button would be much better.

Regards,
- Jonas

ph69
01-14-2008, 04:09 AM
Jonas it is simple and nice, I will do it your way :)

Jeffos
06-15-2009, 01:19 PM
SWS! I think, it's time to report this one in the official FR tracking system, so that we can get some feedback....
There's another FR revival here: http://forum.cockos.com/showthread.php?t=25552&highlight=%40help but I bump this one as you're the 1st reporter.

"simple" and we really need it!

Youn
06-16-2009, 06:48 AM
Long ago, as a work-around, I suggested using a dropdown menu as a help system, like this:

http://forum.cockos.com/attachment.php?attachmentid=5420&stc=1&d=1245160085

Jeffos
06-16-2009, 11:56 AM
... seems I've to code a dropdown content generator. Youn, if now you show me how to put a clickable URL, in a dropdown box, is JS => I upload your a beer. thanks for this subtle work around!

Jeffos
06-18-2009, 11:30 PM
SWS as posted this FR in the FR tracker: http://forum.cockos.com/project.php?issueid=178
thanks.

let's vote!