[PD] Using "all_about_x" patches as abstractions in help files

Jonathan Wilkes jancsika at yahoo.com
Sun Jan 3 19:55:19 CET 2010


Currently, the help patches in the reference folder have two ways of 
referring to the "all_about_x" patches:

1) comments in the form of "docs/reference/all_about_x
2) pddplink

The first option requires the user to open the patch manually, which is 
klunky because the last patch opened is probably different than the 
reference folder (not to mention the fact that the reference folder has 
hundreds of patches in it).  The second option currently stinks because 
pddplink is buggy (at least on winxp: for example, I can't open the 
link listed in ctlin-help.pd).

But what about using the "all_about_x" patches as abstractions in the 
relevant help patches?  So for example: under the "more_info" heading in 
float-help.pd, instead of the comment "all_about_data-types.pd", just have 
[all_about_data-types], which the user can open with one click.  Those 
patches aren't particularly complex, so it shouldn't affect load time of 
the help patches very much (I think), but it would greatly improve 
navigation.  And unlike pddplink, typos would be obvious because the abstraction wouldn't create.

What do people think?

-Jonathan


      





More information about the Pd-list mailing list