search

matthewscharles / instrument-maker

A framework for making digital instruments with sensors, driven by a need to improve access.
http://www.instrumentmaker.org/
GNU General Public License v3.0
18 stars 5 forks source link

Pd style "see also" objects in IM help files would improve ease-of-use. #29

Open alexmlucas opened 4 years ago

alexmlucas commented 4 years ago

It would be useful to include objects of a similar type in Instrument Maker help files. For instance. im.sinewave, in the im.sawtooth help file and vice-versa.

matthewscharles commented 4 years ago

I agree. I left this out because I imagine the default interaction would be to click on them (and load the abstraction).

I wonder if it's possible to open a Pd file via a message box, and just load up the help files themselves directly. This might be in the latest version of Pd.

matthewscharles commented 4 years ago

I added a test using message boxes to im.acid, but I'm not really happy with it; the patch cables into the new im.help are untidy, and the user needs to lock the patcher (which I generally ask not to do in an introductory session). maybe simply including the objects is the right way around, after all. if only there were a way to prevent opening an abstraction by clicking on it..

alexmlucas commented 4 years ago

I don't mind the message box approach so much. Would a help patch not open as locked by default anyway?

matthewscharles commented 4 years ago

Good point!

Ok, in that case, I think this could work out nicely. If you'd like to try it out for yourself, the name of any im object as a message into im.help should load it up.

matthewscharles commented 4 years ago

added the oscillators in that commit.

actually I quite like the idea of having an additional over-arching help file for each category in the future (sound sources, inputs, etc).

this will only work in 0.50 upwards -- that version will also allow us to open web pages. I need to check if this will work on Raspbian, but I'm happy to start going through and adding some suggested objects.

not sure about the layout, hence I haven't added this option to the help templates yet..if you think of anything nicer, or if you have any suggestions for the help files in general, it's open!