revised help docs that conform to the PDDP template

svn path=/trunk/; revision=13942

1 files changed, 190 insertions, 139 deletions

diff --git a/doc/pddp/delay-help.pd b/doc/pddp/delay-help.pd
index a486eab9..6cf64c59 100644
--- a/doc/pddp/delay-help.pd
+++ b/doc/pddp/delay-help.pd
@@ -1,139 +1,190 @@
-#N canvas 9 3 918 652 10;

-#X obj 22 14 delay;

-#X msg 10 418 bang;

-#X floatatom 75 486 0 0 0;

-#X text 98 511 <-- creation argument initializes delay time;

-#X obj 20 511 delay 1000;

-#X text 56 440 Click here to CANCEL delay's action;

-#X msg 20 440 stop;

-#X msg 31 462 2000;

-#X text 67 462 Number in right inlet sets time and schedules the action.

-;

-#X text 104 486 <-- scroll to change delay time in milliseconds;

-#X text 60 14 - BANG AFTER TIME DELAY;

-#X obj 20 90 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1

--1;

-#X obj 20 110 delay 2000;

-#X obj 20 133 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1

--1;

-#X text 12 42 The [delay] object sends a bang to its outlet after a

-delay in milliseconds specified by its right inlet or its creation

-argument.;

-#X text 15 157 [delay]'s left inlet accepts a number \, or one of two

-messages: "bang" or "stop".;

-#X text 14 238 The "bang" method will inform [delay] to send a "bang"

-to its outlet after the prescribed time (which is set either at its

-right inlet \, or in the creation argument). In the above example \,

-you should notice a delay of 2 seconds \, then a "bang" at the outlet.

-;

-#X text 13 314 [delay] accepts only ONE "bang" at a time. It cannot

-process multiple delays. In other words \, sending a "bang" to a [delay]

-which is already set will reschedule its output \, cancelling the old

-one.;

-#X text 15 379 The "stop" method will inform [delay] to cancel its

-scheduled output.;

-#X text 14 191 If a number is sent to its inlet \, [delay] will set

-the delay time equal to that number and schedule the outgoing "bang".

-;

-#X obj 20 536 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1

--1;

-#X text 43 419 "bang" to schedule the action;

-#X obj 414 9 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1

--1;

-#X obj 414 613 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1

--1;

-#X text 445 15 A MAKESHIFT [METRO];

-#X text 433 35 Let's assume for a moment that Miller had forgotten

-to build the [metro] object. (I know that sounds absurd \, but for

-the sake of example...);

-#X text 433 84 [delay] could be used to create a metronome as follows.

-;

-#X obj 463 175 bng 15 50 10 0 empty empty empty 0 -6 0 8 -262144 -1

--1;

-#X obj 463 155 delay 1000;

-#X msg 427 115 bang;

-#X msg 463 115 stop;

-#X obj 671 154 metro 1000;

-#X obj 671 175 bng 15 50 10 0 empty empty empty 0 -6 0 8 -262144 -1

--1;

-#X obj 671 135 tgl 15 0 empty empty empty 0 -6 0 8 -262144 -1 -1 0

-1;

-#X floatatom 726 135 5 0 0;

-#X floatatom 518 137 5 0 0;

-#X text 557 155 is the same as;

-#X text 448 206 A RANDOM IMPULSE GENERATOR;

-#X text 433 223 Some users might be familiar with SC (SuperCollider)

-by James McCartney. For more info about SC \, visit www.audiosynth.com.

-Anyways...SC has a unit generator called "DUST". Dust will produce

-random impulses at a specified "density". I believe that Dust was given

-its name because it creates a sound that is similar to actual dust

-on old vinyl LP's -- you know that old crackling sound like Rice Krispies.

-;

-#X text 432 331 The idea is quite simple. If you want a "very dusty"

-sound \, you make the density quite high...if you want a "slightly

-dusty" sound \, you make the density quite low.;

-#X obj 434 484 delay;

-#X obj 434 506 bng 15 50 10 0 empty empty empty 0 -6 0 8 -262144 -1

--1;

-#X obj 434 423 tgl 15 0 empty empty empty 0 -6 0 8 -262144 -1 -1 0

-1;

-#X text 432 376 Dust.ar(2) in SC will produce 2 dusty impulses randomly

-per second. In the example below \, you'll see a version of this process

-created using Pd's delay object.;

-#X obj 434 463 random 500;

-#X obj 434 442 metro 500;

-#X text 13 563 It is important to realize that [delay] only outputs

-a "bang". It cannot be used like an "echo" or to delay messages other

-than "bang". For that purpose \, you should explore;

-#X obj 63 605 pipe;

-#X text 431 528 RELATED OBJECTS;

-#X obj 466 548 timer;

-#X obj 432 548 pipe;

-#X obj 504 548 metro;

-#N canvas 0 0 452 302 related_objects_from_other_libraries 0;

-#X obj 27 25 nop~;

-#X obj 63 25 z~;

-#X obj 93 25 t3_delay;

-#X obj 153 25 idelay~;

-#X text 18 59 These objects are offered in Pd only if you have downloaded

-and properly installed the appropriate library. These objects may or

-may not exist in a single library.;

-#X text 17 108 The best places to find information about Pd's libraries

-is:;

-#X text 14 130 www.puredata.org and click on "Downloads" then "Software"

-;

-#X text 16 160 iem.kug.ac.at/pdb/;

-#X restore 432 569 pd related_objects_from_other_libraries;

-#X obj 543 548 makenote;

-#X obj 603 548 delwrite~;

-#X text 445 594 This document was updated for Pd version 0.35 test

-28 by Dave Sabine as part of a project called pddp proposed by Krzysztof

-Czaja to build comprehensive documentation for Pd.;

-#X floatatom 504 428 5 0 0;

-#X text 546 421 low numbers will produce a very "dusty" output.;

-#X text 546 433 high numbers will produce a slightly "dusty" output.

-;

-#X text 546 448 Also note that this example merely approximates the

-output of SC's "Dust" object.;

-#X connect 1 0 4 0;

-#X connect 2 0 4 1;

-#X connect 4 0 20 0;

-#X connect 6 0 4 0;

-#X connect 7 0 4 0;

-#X connect 11 0 12 0;

-#X connect 12 0 13 0;

-#X connect 22 0 23 0;

-#X connect 27 0 29 0;

-#X connect 28 0 27 0;

-#X connect 29 0 28 0;

-#X connect 30 0 28 0;

-#X connect 31 0 32 0;

-#X connect 33 0 31 0;

-#X connect 34 0 31 1;

-#X connect 35 0 28 1;

-#X connect 40 0 41 0;

-#X connect 42 0 45 0;

-#X connect 44 0 40 0;

-#X connect 45 0 44 0;

-#X connect 56 0 45 1;

-#X connect 56 0 44 1;

+#N canvas 0 0 555 619 10;
+#X obj 0 595 cnv 15 552 21 empty \$0-pddp.cnv.footer empty 20 12 0
+14 -228856 -66577 0;
+#X obj 0 0 cnv 15 552 40 empty \$0-pddp.cnv.header delay 3 12 0 18
+-204280 -1 0;
+#X obj 0 200 cnv 3 550 3 empty \$0-pddp.cnv.inlets inlets 8 12 0 13
+-228856 -1 0;
+#N canvas 39 180 494 386 META 0;
+#X text 12 125 PLATFORM windows macosx gnulinux;
+#X text 12 205 LIBRARY internal;
+#X text 12 245 WEBSITE http://crca.ucsd.edu/~msp/;
+#X text 12 85 LICENSE SIBSD;
+#X text 12 225 AUTHOR Miller Puckette;
+#X text 12 305 HELP_PATCH_AUTHORS This help patch was updated for Pd
+version 0.35 test 28 by Dave Sabine as part of a project called pddp
+proposed by Krzysztof Czaja to build comprehensive documentation for
+Pd. Jonathan Wilkes revised the patch to conform to the PDDP template
+for Pd version 0.42.;
+#X text 12 5 GENRE help;
+#X text 12 105 DESCRIPTION bang after time delay;
+#X text 12 25 NAME delay;
+#X text 12 45 ALIAS del;
+#X text 12 145 INLET_0 float bang stop;
+#X text 12 165 INLET_1 float;
+#X text 12 185 OUTLET_0 bang;
+#X text 12 65 KEYWORDS control time bang_op;
+#X text 12 285 RELEASE_VERSION;
+#X text 12 265 RELEASE_DATE 1997;
+#X restore 500 597 pd META;
+#X obj 0 393 cnv 3 550 3 empty \$0-pddp.cnv.outlets outlets 8 12 0
+13 -228856 -1 0;
+#X obj 0 446 cnv 3 550 3 empty \$0-pddp.cnv.argument arguments 8 12
+0 13 -228856 -1 0;
+#X obj 0 488 cnv 3 550 3 empty \$0-pddp.cnv.more_info more_info 8 12
+0 13 -228856 -1 0;
+#N canvas 97 299 428 291 Related_objects 0;
+#X obj 1 1 cnv 15 425 20 empty \$0-pddp.cnv.subheading empty 3 12 0
+14 -204280 -1 0;
+#X obj 42 37 timer;
+#X obj 8 37 pipe;
+#X obj 80 37 metro;
+#X obj 119 37 makenote;
+#X obj 179 87 delwrite~;
+#X text 4 208 The best places to find information about Pd's libraries
+is:;
+#X text 4 230 www.puredata.org and click on "Downloads" then "Software"
+;
+#X text 4 251 iem.kug.ac.at/pdb/;
+#X text 5 112 Externals;
+#X text 5 159 Externals are offered in Pd only if you have downloaded
+and properly installed the appropriate library. These objects may or
+may not exist in a single library.;
+#X text 7 62 Audio Objects;
+#X obj 10 87 vd~;
+#X obj 47 87 delread~;
+#X obj 113 87 delwrite~;
+#X text 7 1 [delay] Related Objects;
+#X text 5 133 [nop~];
+#X text 46 133 [z~];
+#X text 73 133 [t3_delay];
+#X text 137 133 [idelay~];
+#X text 194 133 [delay~];
+#X restore 101 597 pd Related_objects;
+#X obj 78 209 cnv 17 3 145 empty \$0-pddp.cnv.let.0 0 5 9 0 16 -228856
+-162280 0;
+#X obj 78 402 cnv 17 3 17 empty \$0-pddp.cnv.let.0 0 5 9 0 16 -228856
+-162280 0;
+#X obj 78 360 cnv 17 3 17 empty \$0-pddp.cnv.let.1 1 5 9 0 16 -228856
+-162280 0;
+#X text 98 359 float;
+#X obj 451 3 delay;
+#X text 491 3 or;
+#X obj 517 2 del;
+#X obj 455 20 pddp/pddplink http://wiki.puredata.info/en/delay -text
+pdpedia: delay;
+#X obj 100 102 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1
+-1;
+#X obj 100 150 delay 2000;
+#X obj 100 173 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1
+-1;
+#X text 98 253 bang;
+#X text 98 313 stop;
+#X text 168 359 - a float to the right inlet sets the delay time (in
+milliseconds).;
+#X text 98 336 list;
+#X text 98 401 bang;
+#X msg 168 101 stop;
+#X msg 122 101 500;
+#X floatatom 157 128 0 0 0 0 - - -;
+#X text 188 129 <- scroll to change delay time in milliseconds;
+#X text 168 401 - [delay] only outputs a bang. It cannot be used like
+an "echo" or to delay messages other than bang. For that purpose \,
+you should explore [pipe].;
+#N canvas 106 287 428 250 A_delay_based_metronome 0;
+#X obj 1 1 cnv 15 425 20 empty \$0-pddp.cnv.subheading empty 3 12 0
+14 -204280 -1 0;
+#X text 19 55 Let's assume for a moment that Miller had forgotten to
+build the [metro] object. (I know that sounds absurd \, but for the
+sake of example...);
+#X text 19 104 [delay] could be used to create a metronome as follows.
+;
+#X obj 58 197 bng 15 50 10 0 empty empty empty 0 -6 0 8 -262144 -1
+-1;
+#X obj 58 175 delay 1000;
+#X msg 22 135 bang;
+#X msg 58 135 stop;
+#X obj 260 176 metro 1000;
+#X obj 260 197 bng 15 50 10 0 empty empty empty 0 -6 0 8 -262144 -1
+-1;
+#X obj 260 157 tgl 15 0 empty empty empty 0 -6 0 8 -262144 -1 -1 0
+1;
+#X floatatom 317 155 5 0 0 0 - - -;
+#X floatatom 115 154 5 0 0 0 - - -;
+#X text 152 175 is the same as;
+#X text 19 36 A makeshift [metro];
+#X text 7 1 [delay] A Metronome Built with [delay];
+#X connect 3 0 5 0;
+#X connect 4 0 3 0;
+#X connect 5 0 4 0;
+#X connect 6 0 4 0;
+#X connect 7 0 8 0;
+#X connect 9 0 7 0;
+#X connect 10 0 7 1;
+#X connect 11 0 4 1;
+#X restore 101 550 pd A_delay_based_metronome;
+#N canvas 103 173 428 389 Random_Impulse_Generator 0;
+#X obj 1 1 cnv 15 425 20 empty \$0-pddp.cnv.subheading empty 3 12 0
+14 -204280 -1 0;
+#X text 21 35 Some users might be familiar with SC (SuperCollider)
+by James McCartney. For more info about SC \, visit www.audiosynth.com.
+Anyways...SC has a unit generator called "DUST". Dust will produce
+random impulses at a specified "density". I believe that Dust was given
+its name because it creates a sound that is similar to actual dust
+on old vinyl LP's -- you know that old crackling sound like Rice Krispies.
+;
+#X text 20 143 The idea is quite simple. If you want a "very dusty"
+sound \, you make the density quite high...if you want a "slightly
+dusty" sound \, you make the density quite low.;
+#X obj 22 299 delay;
+#X obj 22 321 bng 15 50 10 0 empty empty empty 0 -6 0 8 -262144 -1
+-1;
+#X obj 22 235 tgl 15 0 empty empty empty 0 -6 0 8 -262144 -1 -1 0 1
+;
+#X text 20 188 Dust.ar(2) in SC will produce 2 dusty impulses randomly
+per second. In the example below \, you'll see a version of this process
+created using Pd's delay object.;
+#X obj 22 278 random 500;
+#X obj 22 257 metro 500;
+#X floatatom 92 236 5 0 0 0 - - -;
+#X text 20 343 Also note that this example merely approximates the
+output of SC's "Dust" object.;
+#X text 130 236 low numbers produce a very "dusty" output.;
+#X text 130 248 high numbers produce a slightly "dusty" output.;
+#X text 7 1 [delay] A Random Impulse Generator using [delay];
+#X connect 3 0 4 0;
+#X connect 5 0 8 0;
+#X connect 7 0 3 0;
+#X connect 8 0 7 0;
+#X connect 9 0 8 1;
+#X connect 9 0 7 1;
+#X restore 101 572 pd Random_Impulse_Generator;
+#X text 168 313 - causes [delay] to cancel its scheduled output.;
+#X text 168 336 - a list of floats will be truncated to the first element.
+;
+#X text 80 465 1) float;
+#X text 97 54 The [delay] object sends a bang to its outlet after a
+delay (in milliseconds) \, specified by its right inlet or its creation
+argument.;
+#X text 168 253 - a bang to the left inlet will output a bang after
+the prescribed time (set either at the right inlet creation argument).
+In the above example \, you should notice a delay of 2 seconds \, then
+a bang at the outlet.;
+#X text 168 208 - if a float is sent to the left inlet \, [delay] will
+set the delay time equal to that number (milliseconds) and schedule
+the outgoing bang.;
+#X text 98 492 [delay] accepts only ONE bang at a time. It cannot process
+multiple delays. In other words \, sending a "bang" to a [delay] which
+is already set will reschedule its output \, cancelling the old one.
+;
+#X text 168 465 - (optional) initial delay time (in milliseconds).
+;
+#X text 98 208 float;
+#X obj 4 597 pddp/pddplink pddp/help.pd -text help;
+#X obj 298 550 pddp/pddplink ../2.control.examples/07.time.pd;
+#X text 11 23 bang after time delay;
+#X connect 16 0 17 0;
+#X connect 17 0 18 0;
+#X connect 24 0 17 0;
+#X connect 25 0 17 0;
+#X connect 26 0 17 1;