Very nice work, and thanks for taking the initiative to do this. A
couple of comments (and since it's a wiki, I made some changes to the
page, we can always revert if people don't like them:)
- I made a the boxes a bit bigger and lightened the grey border to
try to enhance readability. Hopefully y'all like it.
- which reminds me, another thing to tackle is fixing the Infobox
template to hide fields that aren't filled in. The wikipedia Infobox
templates do that.
- I am not sure about where examples should go. It seems to me that
the inlets section should just be a reference section, then there
should be a separate section with examples.
- instead of ASCII patches, I think we should include screenshots. I
guess ASCII patches are quicker, and are better than nothing.
- the "Notes" section is a bit vague. if it is important
information, it should be included in the description. I was
thinking that we could have more specific sections for adding info,
like "Bugs", "Tips & Tricks", etc.
.hc
On Nov 9, 2007, at 8:13 AM, Luke Iannini (pd) wrote:
Hallo, I spent some time working on the Pdpedia.
I chose switch~ for the start of a reference article since it's very simple; I think if we can get it looking nice it will be a good step towards describing more complex objects, like the IEMGUIs or [pool].
So, most of my work should be pretty self-explanatory. One question: what is the intent of the "Messages" section? Is this "messages understood by the first inlet"? If so, I guess I should move the "Inlet 0" explanations there and put something like "Inlet 0: 1/0 for DSP On/Off + <Messages>" with a link to that section?
I also made some templates called {{msg}} and {{obj}}. You can see them in action at http://wiki.puredata.info/en/switch%7E. The obj template automatically tries to link the object name, so I suggest (if people like them) that that is the preferred "object linking method". The regular [[link]] can be saved for linking to articles not directly about an object. Blurbs on their usage are at http://wiki.puredata.info/en/Help:Contents.
When I'm feeling saucy I'll see about doing a version for ascii-art
patches.So, it would be nice if everyone could check out and groom the switch~ article so it can be henceforth used as a starting point for cleaning up the rest of the 'pedia. I didn't try using tables yet; maybe they'd be handy for enumerating inlets/outlets etc.
Cheers Luke
PD-list@iem.at mailing list UNSUBSCRIBE and account-management -> http://lists.puredata.info/ listinfo/pd-list
I have the audacity to believe that peoples everywhere can have three
meals a day for their bodies, education and culture for their minds,
and dignity, equality and freedom for their spirits. - Martin
Luther King, Jr.