[PD] Revising Help Files

Hans-Christoph Steiner hans at at.or.at
Wed Jun 10 21:03:50 CEST 2009


Your patches look quite nice.  I'm glad you are taking this stuff on,  
Pd will definitely benefit from more work on the documentation.

There was quite a bit of discussion on this topic a few years back as  
part of the PDDP project.  All of the discussion is archived on http://puredata.info/dev/pddp 
   We did come up with a template, you can download it from the SVN.   
It is a bit heavier that your design:


About htab's dependency on pddp/dsp, it would be possible to make pddp/ 
dsp a subpatch.  But then again, I think that Pd-extended is the only  
distro to include the PDDP help patches, so it makes sense to use the  
pddp/dsp object.


On Jun 10, 2009, at 12:09 AM, Jonathan Wilkes wrote:

> Hi List,
> I'm interested in revising the help files for the basic objects in
> pd-ext.  Basically having a standard table so that one can find
> quickly find basic info on an object.
> I made an abstraction called htab that automatically formats this
> information in a gop abstraction.  Currently I'm entering the info
> as arguments to htab, which works quite well when using
> ctrl-t.
> However, there are currently lots of different help patch formats in
> the reference folder for the common pd objects.  I'd like to have
> one standard format to make it quicker and easier to get help.
> Attached are examples of what I'd like to implement.  Aside from
> the pddp/dsp abstraction, it has the benefit of being vanilla-
> compatible and fitting on an 800x600 screen (at least on windows).
> Please have a look at the attached and let me know if this seems
> like a good format or not.  The patches should work with the
> current pd-x.
> Thanks,
> Jonathan
> <reference-6-8-09.zip>


As we enjoy great advantages from inventions of others, we should be  
glad of an opportunity to serve others by any invention of ours; and  
this we should do freely and generously.         - Benjamin Franklin

More information about the Pd-list mailing list