[PD-dev] Updating pd help patches

Jonathan Wilkes jancsika at yahoo.com
Tue Jun 8 01:35:41 CEST 2010


Hi,
     I sent an email to the user list, but I guess it belongs here instead.  I have revised almost all of the help 
patches for vanilla objects to conform to the PDDP template created a few years back.  Each patch lists 
info for xlets, args, and related objects and has a [pd META] subpatch with info that can be used if 
someone makes a plug-in to search for objects (I made a simple patch called search-test.pd as a demo).

All patches are the same size and are located at origin 0,0 (top left of screen) so that at least part of the 
patch will be visible at any screen resolution.  Each patch also has a pddplink at the bottom left to a general 
"Help" patch (pddp/help.pd) that links to:
* a help page for the pd help system
* the Pd Manual
* various tutorials (control, audio, intro to gem, dynamic patching, etc.)
* other resources like the all_about_* patches (which I've revised and added to)

There is also a decent attempt at cross-referencing, so that, for example, the help patch for delread~ 
has a pddplink to the audio tutorials where that object is used (G01, G02, G05).  Each help patch also has 
a link to the respective pdpedia web page (although I'm not sure that this will turn out to be all that useful).

I'm also in the middle of adding [pd META] tags to all the externals included in pd-ext, as well as creating 
help patches for the objects that don't currently have one.

The patches are all at: http://puredata.info/Members/jwilkes/doc/at_download/file

As I said in my email on the user list, I've never used SVN before, but I'm happy to learn it if that's the 
easiest way to get them into pd-ext.  As for the revisions of external help patches, I'm not sure what the 
best way is to implement my changes, since those help patches belong to their respective developers.

I would appreciate suggestions anyone has on the best way to proceed.

Thanks,
Jonathan



      
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.puredata.info/pipermail/pd-dev/attachments/20100607/07bf2119/attachment.htm>


More information about the Pd-dev mailing list