[PD] A bunch of revised help patches

[Hans-Christoph Steiner]

Hey Jonathan,

Its quite an bit of work, thanks for taking it on.  Its a definite  
improvement overall.  Here are my comments that sent you off-list that  
I think are still applicable:

* I think we should omit a section if its empty, like the 'arguments'  
section in abs-help.pd Omitting sections that are empty will make the  
help patch look cleaner, and people will learn that if there isn't a  
certain section, it means that there are not inlets/outlets/ 
arguments.  It could also be added to your help help patch, which is a  
great idea by the way.

* think that all help patches should have the same width, but the  
height should be adjusted to minimize white space, like with abs-help.pd


* I think we should make the help patches per object, not the mega- 
helps like Miller makes (acoustics, etc.) If you want to make help  
patches for things like mtof~, I'll make the changes in Pd-extended so  
that it has its own help patch

* I think the pddp/dsp should be standalone without the box and text.  
If people don't know what it is, they can get help on it.  Its pretty  
easy to do a text search-n-replace on 'pddp/dsp' to replace that  
object with another, so I don't see the value of the added complexity  
of the wrapper.

* rather than use number boxes for sending numbers using the mouse, I  
think a slider is a lot more user-friendly.  If the numbers are  
important, then there can be a number box attached to the slider or  
something like that.  When space is a concern, the sliders can be  
smaller than default.

* the "arguments" section should use the same number bar canvas things  
as the inlets and outlets sections

For Pd-extended, 2.control.examples, 3.audio.examples, and  
4.data.structures are all taken directly from Miller, so those changes  
would have to go thru him.  I think you could distribute those  
separately for now.

.hc

On Mar 22, 2010, at 3:17 PM, Jonathan Wilkes wrote:

> Ok, here they are:
>
> https://puredata.info/Members/jwilkes/PDDP-help-patches/view
>
> To use them you can just overwrite the doc folder with these changes.
> After doing that you can open the <ctrl>-b browser and there's a
> search-test.pd prototype at the bottom.
>
> I put headers and a "pd meta" subpatch in 2.control.examples,
> 3.audio.examples, and 4.data.structures, and changed all the  
> 5.reference
> files to conform to the PDDP template (nonrecursively!).
>
> To find patches that obviously still need work, try KEYWORD  
> needs_work.
>
> For the tutorials I moved things around but did not mess with any  
> wires,
> so they should all work as they previously did.
>
> One _big_ problem currently is the bug in pddplink that breaks
> abstractions and other links if you go down a relative path.
> Also I couldn't use pddplink for the manual because relative links for
> non-pd files don't work.
>
> Also, if anyone wants to tweak pddplink, I also put in a feature  
> request
> for a flag that would close the original patch once you click the  
> link.
> That way you can add some simple navigation links for some of the  
> tutorials.
>
> Let me know what other revisions need to be made, and I'll implement  
> them
> (I'm not totally burned out yet!)
>
> -Jonathan
>
>
>
>
>
> _______________________________________________
> Pd-list at iem.at mailing list
> UNSUBSCRIBE and account-management -> http://lists.puredata.info/listinfo/pd-list




----------------------------------------------------------------------------

You can't steal a gift. Bird gave the world his music, and if you can  
hear it, you can have it. - Dizzy Gillespie