Hi list, I have a bunch of revised help patches from the doc folder for pd-extended, plus a little object search prototype. The zip file totals about 1 meg. Is that too big to post here? If so, where's an easy place to upload them to make them available?
-Jonathan
Hallo, Jonathan Wilkes hat gesagt: // Jonathan Wilkes wrote:
I have a bunch of revised help patches from the doc folder forpd-extended, plus a little object search prototype. The zip file totals about 1 meg. Is that too big to post here? If so, where's an easy place to upload them to make them available?
puredata.info is a good place to upload pd-related things.
Ciao
Frank
or contact Hans-Christoph Steiner. I sugest to get them reviewed by a
couple of people (I can help), and upload them to svn, to make part of
pd-ext. (or even Pd-van, if possible)
João
Hi list, I have a bunch of revised help patches from the doc folder for pd-extended, plus a little object search prototype. The zip file totals about 1 meg. Is that too big to post here? If so, where's an easy place to upload them to make them available?
-Jonathan
Pd-list@iem.at mailing list UNSUBSCRIBE and account-management ->
http://lists.puredata.info/listinfo/pd-list
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
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@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
Hi,
finally I looked a bit at it. I can't say much, but a couple of things:
- this is a massive work, it's not possible to go through the patches and
give a general opinion. Unless I do replace the pd-ext patches with these
ones, and then in a couple of weeks might have something general to say.
- in general I think your patches should make part of Pd. Are you on it,
or should we make a possy and go to the big man with this request?
- it seems that for your work to be worthwile, it should be part of
Pd(-ext). but as a (small) developer, I'm not sure if your strategy is the
best. I saw that you went into everyone's help patches and added the meta
- import objects (and anything more?). I have nothing against it, but the
developers should then be the ones doing that work. Or, assuming that your
patches make it into main Pd, the next time I update some help patch I'll
erase your work, because "your" version isn't "my" version.
So, it might be easier to either make a small document telling the
developers to add x and y to their patches to conform to the new pddp
logic - and put this somewhere in the wiki for new developers to read -,
or you send them your version of the patches, which they should take and
build on.
Unless you want to constantly check if everyone is using the right
objects/tags/etc.
I'll give some comments to H-C's comments:
- 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 agree. I also like fontsize 10 better than 12. but doesn't anyone
complain?
- 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
with some objects might make sense, like the arythmetic ones, or the
acoustic conversions.
But I think that mega-patches should be helpful for new people, provided
that the individual information is also somewhere to be found.
Also, more all_about-patches can always be interesting. they act like
programming tutorials, and can be very helpful.
Is there any specific work to be done? As said, I don't know the
collection well enough to say something about it.
João
I replaced Pd's patches with yours, to see if slowly something to say
comes up. one just did: what's the best way to improve the "related
obects" section, send you a message?
for example, snapshot~ should have vsnapshot~. and the latter should have
sig~, as it is in the former.
João
Yeah, just send them to me and I'll fix them. There are a few things I need to finish up in those patches in the next few weeks, after which I'll put my final revisions up and try to figure out what to do with them next.
-Jonathan
--- On Wed, 4/21/10, João Pais jmmmpais@googlemail.com wrote:
From: João Pais jmmmpais@googlemail.com Subject: Re: [PD] A bunch of revised help patches To: "Jonathan Wilkes" jancsika@yahoo.com Cc: pd-list@iem.at Date: Wednesday, April 21, 2010, 10:49 PM
I replaced Pd's patches with yours, to see if slowly something to say comes up. one just did: what's the best way to improve the "related obects" section, send you a message?
for example, snapshot~ should have vsnapshot~. and the latter should have sig~, as it is in the former.
João
-
Frank Barknecht -
Hans-Christoph Steiner -
Jonathan Wilkes -
João Pais