SUBMITTED: help menu intergrating functioning examples

i think that help should always be a click away when you’re hovering over a node and that it should bring up actual usable examples that an be copied right into the project.
this is one of the best features of MAX/MSP/Jitter. as a way to get the know the program you can just go around creating objects (here a node) and when you create them, a left click will instantly bring up a window in the program with a functioning example of how that object works and then you literally copy and past aspects of that code into your patch (here .toe).

To start, lets add an RFE to add “Help” to the bottom of the right-click menu for every node. This will let you open Help for that node without 1) opening parameter window and then 2) clicking on the ? button.

Integrating examples is something we’ve wanted to do for ages in the Help pages, it is just a matter of content and time. This would be helped by making the OP Help pages more collaborative via wiki.

i know this is something I have talked about before…

If each touch file had a short ascii header listing the ops used in it, then google desktop and windows desktop search could be set up to look for them. perhaps the header could have other info like author, keywords etc.

alternatively there’s a script command that lists the operators in a project. If an automatically generated text file is put in the project folder, then it would be easier to search through a colection of other peoples’ projects to find a shuffle chop in action etc.

I think we should try to build a practice of making it easier for beginners and for reverse engineering others’ work.

Max and PD are great in the way that they allow you to make tutorials as a live running project.

an html parser TOP/CHOP combination would really rock too! :slight_smile: (I know that’s not exactly trivial)

in the present setup, I guess the pallettes would be a place to put help examples.

Rod.

Interesting. We are looking at add the remapping capabilities for the color/depth images. In your solution if it’s from the color’s point of view, how do you decide the Z coordinate?

Hi Fairyanna,
Can you specify what example you are referring to? Or is this a general question not related to the original post?

Thanks