1 files changed, 178 insertions, 123 deletions
diff --git a/doc/pddp/spigot-help.pd b/doc/pddp/spigot-help.pd
index 7f912580..11e83eb1 100644
--- a/doc/pddp/spigot-help.pd
+++ b/doc/pddp/spigot-help.pd
@@ -1,137 +1,192 @@
-#N canvas 94 22 874 659 10;
-#X msg 8 96 0.5 1000;
-#X floatatom 38 160 1 0 0 0 - - -;
-#X obj 8 177 spigot;
-#X obj 7 198 print;
-#X msg 20 136 walk the cat;
-#X msg 13 116 bang;
-#X obj 27 11 spigot;
-#X text 75 11 - pass or block messages;
-#X text 51 160 control: nonzero to pass messages \, zero to stop them
+#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 spigot 3 12 0 18
+-204280 -1 0;
+#X obj 0 295 cnv 3 550 3 empty \$0-pddp.cnv.inlets inlets 8 12 0 13
+-228856 -1 0;
+#N canvas 50 243 494 364 META 0;
+#X text 12 105 PLATFORM windows macosx gnulinux;
+#X text 12 185 LIBRARY internal;
+#X text 12 225 WEBSITE http://crca.ucsd.edu/~msp/;
+#X text 12 65 LICENSE SIBSD;
+#X text 12 205 AUTHOR Miller Puckette;
+#X text 12 285 HELP_PATCH_AUTHORS This help patch was updated for Pd
+version 0.38-4. It was edited by Dave Sabine and Hans-Christoph Steiner
+as part of a project called pddp proposed by Krzysztof Czaja to build
+comprehensive documentation for Pd. Revised by Jonathan Wilkes to conform
+to the PDDP template for Pd version 0.42.;
+#X text 12 5 GENRE help;
+#X text 12 45 KEYWORDS control;
+#X text 12 85 DESCRIPTION pass or block messages;
+#X text 12 25 NAME spigot;
+#X text 12 125 INLET_0 anything;
+#X text 12 145 INLET_1 float;
+#X text 12 165 OUTLET_0 anything;
+#X text 12 245 RELEASE_DATE 1997;
+#X text 12 265 RELEASE_VERSION;
+#X restore 500 597 pd META;
+#X obj 0 389 cnv 3 550 3 empty \$0-pddp.cnv.outlets outlets 8 12 0
+13 -228856 -1 0;
+#X obj 0 443 cnv 3 550 3 empty \$0-pddp.cnv.argument arguments 8 12
+0 13 -228856 -1 0;
+#X obj 0 538 cnv 3 550 3 empty \$0-pddp.cnv.more_info more_info 8 12
+0 13 -228856 -1 0;
+#N canvas 72 359 428 230 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 text 8 2 [spigot] Related Objects;
+#X text 20 38 Externals;
+#X text 19 85 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 19 126 The best places to find information about Pd's libraries
+is:;
+#X text 19 146 www.puredata.org and click on "Downloads" then "Software"
 ;
-#X text 4 294 USING [SPIGOT] TO CREATE A GATE.;
-#X text 14 312 Unlike its closest cousin MAX \, Pd does not have a
-native [gate] object. There are other Pd libraries which include gates
-for both audio and numerical data \, but similar routines can be built
-in Pd using [spigot]. The example below shows a two-way gate using
-two [spigots] and the [expr] object.;
-#X obj 87 505 spigot;
-#X floatatom 88 459 1 0 0 0 - - -;
-#X text 105 458 controls: open and close the gates.;
-#X floatatom 23 527 5 0 0 0 - - -;
-#X floatatom 87 527 5 0 0 0 - - -;
-#X obj 4 400 tgl 15 0 empty empty empty 0 -6 0 8 -262144 -1 -1 0 1
+#X text 19 161 or;
+#X text 19 176 iem.kug.ac.at/pdb/;
+#X obj 21 58 pddp/helplink cyclone/gate;
+#X restore 102 598 pd Related_objects;
+#X obj 78 304 cnv 17 3 35 empty \$0-pddp.cnv.let.0 0 5 9 0 16 -228856
+-162280 0;
+#X obj 78 398 cnv 17 3 30 empty \$0-pddp.cnv.let.0 0 5 9 0 16 -228856
+-162280 0;
+#X obj 78 345 cnv 17 3 35 empty \$0-pddp.cnv.let.1 1 5 9 0 16 -228856
+-162280 0;
+#X text 98 344 float;
+#X obj 481 3 spigot;
+#X obj 455 20 pddp/pddplink http://wiki.puredata.info/en/spigot -text
+pdpedia: spigot;
+#X text 11 23 pass or block messages;
+#X msg 101 111 0.5 1000;
+#X floatatom 134 177 1 0 0 0 - - -;
+#X obj 101 197 spigot;
+#X obj 101 218 print;
+#X msg 120 155 walk the cat;
+#X msg 111 133 bang;
+#X text 147 177 control: nonzero to pass messages \, zero to stop them
 ;
-#X obj 7 418 metro 200;
-#X obj 4 439 f;
-#X obj 31 439 + 1;
-#X obj 118 484 expr 1-$f1;
-#X text 24 398 Click to start sending info through the gates.;
-#X obj 88 439 loadbang;
-#X text 8 38 [spigot] passes messages from its left inlet to its outlet
+#X text 18 52 [spigot] passes messages from its left inlet to its outlet
 \, as long as a nonzero number is sent to its right inlet. When its
 right inlet gets zero \, incoming messages are "blocked" (i.e. ignored).
 ;
-#X text 6 231 [spigot] works essentially like a doorway. When the door
-is open \, messages can pass through. When the door is closed \, messages
-are ignored. By default \, the door is always closed!;
-#X obj 23 505 spigot;
-#X text 5 547 In the example above \, the magic is created by the [expr]
-object which performs a simple calculation using the incoming number
-(1 or 0). Note that the figure "$f1" is a variable which assumes the
-value of the incoming number.;
-#X text 447 17 CREATION ARGUMENTS?;
-#X obj 567 98 spigot 0;
-#X text 434 216 [SPIGOT] FOR AUDIO SIGNALS?;
-#X text 447 233 [spigot] does not work with audio signals. The data
-types which are accepted by this object are floats \, symbols \, lists
-\, bangs \, anythings and pointers. However \, audio signals require
-a completely different treatment.;
-#X text 444 285 Pd does not have a [spigot] for audio signals \, but
+#X text 18 242 [spigot] works essentially like a doorway. When the
+door is open \, messages can pass through. When the door is closed
+\, messages are ignored. By default \, the door is always closed!;
+#N canvas 96 273 428 291 using_spigot_to_create_a_gate 0;
+#X text 20 38 Unlike its closest cousin MAX \, Pd does not have a native
+[gate] object. There are other Pd libraries which include gates for
+both audio and numerical data \, but similar routines can be built
+in Pd using [spigot]. The example below shows a two-way gate using
+two [spigots] and the [expr] object.;
+#X floatatom 121 188 1 0 0 0 - - -;
+#X text 138 187 controls: open and close the gates.;
+#X floatatom 24 262 5 0 0 0 - - -;
+#X floatatom 76 262 5 0 0 0 - - -;
+#X obj 24 129 tgl 15 0 empty empty empty 0 -6 0 8 -262144 -1 -1 0 1
+;
+#X obj 24 149 metro 200;
+#X obj 24 171 f;
+#X obj 51 171 + 1;
+#X text 44 127 Click to start sending info through the gates.;
+#X obj 24 240 spigot;
+#X obj 1 1 cnv 15 425 20 empty \$0-pddp.cnv.subheading empty 3 12 0
+14 -204280 -1 0;
+#X text 8 2 [spigot] Using [spigot] to Create a Gate;
+#X obj 76 240 spigot 1;
+#X obj 121 218 == 0;
+#X connect 1 0 10 1;
+#X connect 1 0 14 0;
+#X connect 5 0 6 0;
+#X connect 6 0 7 0;
+#X connect 7 0 8 0;
+#X connect 7 0 10 0;
+#X connect 7 0 13 0;
+#X connect 8 0 7 1;
+#X connect 10 0 3 0;
+#X connect 13 0 4 0;
+#X connect 14 0 13 1;
+#X restore 102 568 pd using_spigot_to_create_a_gate;
+#N canvas 61 206 428 334 spigot_for_audio_signals 0;
+#X text 20 38 [spigot] does not work with audio signals. The data types
+which are accepted by this object are floats \, symbols \, lists \,
+bangs \, anythings and pointers. However \, audio signals require a
+completely different treatment.;
+#X text 21 100 Pd does not have a [spigot] for audio signals \, but
 the same effect can be created using the following structure:;
-#X obj 458 332 osc~ 800;
-#X obj 426 15 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1
--1;
-#X obj 426 596 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1
--1;
-#X obj 458 389 *~;
-#X floatatom 471 372 1 0 0 0 - - -;
-#X obj 440 467 env~;
-#X floatatom 440 488 5 0 0 0 - - -;
-#X msg 598 342 \; pd dsp \$1 \;;
-#X obj 598 323 tgl 15 0 empty empty empty 0 -6 0 8 -262144 -1 -1 0
-1;
-#X obj 485 486 dac~;
-#X obj 485 466 *~ 0.05;
-#X text 615 324 Turn on audio computation first.;
-#X text 489 377 Here is the [spigot].;
-#X text 488 390 When "0" \, audio signal;
-#X text 487 406 is effectively blocked.;
-#X text 488 420 When "1" \, audio signal is;
-#X text 488 435 not effected in any way.;
-#X text 446 518 RELATED OBJECTS;
-#N canvas 0 22 454 304 related_objects_from_other_libraries 0;
-#X obj 40 36 gate;
-#X text 18 86 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 135 The best places to find information about Pd's libraries
-is:;
-#X text 14 157 www.puredata.org and click on "Downloads" then "Software"
+#X obj 24 147 osc~ 800;
+#X obj 24 217 *~;
+#X floatatom 39 196 1 0 0 0 - - -;
+#X obj 24 279 env~;
+#X floatatom 24 300 5 0 0 0 - - -;
+#X obj 69 299 dac~;
+#X obj 69 279 *~ 0.05;
+#X text 79 168 Here is the [spigot].;
+#X text 80 183 When "0" \, audio signal;
+#X text 79 198 is effectively blocked.;
+#X text 80 213 When "1" \, audio signal is;
+#X text 80 228 not effected in any way.;
+#X obj 1 1 cnv 15 425 20 empty \$0-pddp.cnv.subheading empty 3 12 0
+14 -204280 -1 0;
+#X text 8 2 [spigot] Is There a [spigot] for Audio Signals?;
+#X obj 287 145 pddp/dsp-reminder;
+#X connect 2 0 3 0;
+#X connect 3 0 5 0;
+#X connect 3 0 8 0;
+#X connect 4 0 3 1;
+#X connect 5 0 6 0;
+#X connect 8 0 7 0;
+#X restore 102 547 pd spigot_for_audio_signals;
+#X text 98 303 anything;
+#X text 167 344 - "0" blocks all incoming messages to the left inlet.
+"1" (or any nonzero number) passes the incoming message to the outlet.
 ;
-#X text 15 173 or;
-#X text 16 187 iem.kug.ac.at/pdb/;
-#X restore 459 539 pd related_objects_from_other_libraries;
-#X obj 456 188 spigot cat;
-#X obj 534 188 spigot dog;
-#X text 454 33 [spigot] only accepts one numerical creation argument:
+#X text 98 397 anything;
+#X text 168 397 - if the last value received at the right inlet was
+nonzero \, [spigot] passes the message from the first inlet to its
+outlet.;
+#X text 168 457 - By default \, the left inlet of [spigot] is initially
+closed. A one (or any nonzero number) as a creation argument will cause
+the spigot to be open initially. See the subpatch below for an example:
+;
+#X text 168 303 - [spigot] takes the input to the left inlet and either
+ignores it or passes it through to the outlet \, depending on the value
+at the right inlet.;
+#N canvas 74 291 428 213 creation_args 0;
+#X obj 146 108 spigot 0;
+#X text 21 38 [spigot] only accepts one numerical creation argument:
 a one or a zero. At creation time the [spigot] is "closed". With a
 one \, its defaults to open.;
-#X obj 635 98 spigot 1;
-#X obj 579 71 bng 15 250 50 0 empty empty empty 0 -6 0 8 -225271 -1
+#X obj 214 108 spigot 1;
+#X obj 146 81 bng 15 250 50 0 empty empty empty 0 -6 0 8 -225271 -1
 -1;
-#X obj 511 98 spigot;
-#X obj 511 116 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1
+#X obj 90 108 spigot;
+#X obj 90 135 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1
 -1;
-#X obj 567 117 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1
+#X obj 146 135 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1
 -1;
-#X obj 635 117 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1
+#X obj 214 135 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1
 -1;
-#X text 451 576 This document was updated for Pd version 0.38-4. It
-was edited by Dave Sabine and Hans-Christoph Steiner as part of a project
-called pddp proposed by Krzysztof Czaja to build comprehensive documentation
-for Pd.;
-#X text 455 143 [spigot] used to accept any symbol \, but all of these
-are meaningless and have no effect on the operation of the object.
-This was removed in Pd 0.38-3;
-#X connect 0 0 2 0;
-#X connect 1 0 2 1;
-#X connect 2 0 3 0;
-#X connect 4 0 2 0;
-#X connect 5 0 2 0;
-#X connect 11 0 15 0;
-#X connect 12 0 20 0;
-#X connect 12 0 25 1;
-#X connect 16 0 17 0;
+#X obj 1 1 cnv 15 425 20 empty \$0-pddp.cnv.subheading empty 3 12 0
+14 -204280 -1 0;
+#X text 8 2 [spigot] Creation Arguments;
+#X text 20 158 [spigot] used to accept any symbol as a creation argument
+\, but all of these are meaningless and have no effect on the operation
+of the object. This was removed in Pd 0.38-3;
+#X connect 0 0 6 0;
+#X connect 2 0 7 0;
+#X connect 3 0 0 0;
+#X connect 3 0 4 0;
+#X connect 3 0 2 0;
+#X connect 4 0 5 0;
+#X restore 171 510 pd creation_args;
+#X text 90 457 1) float;
+#X obj 4 597 pddp/pddplink pddp/help.pd -text help;
+#X obj 296 548 pddp/pddplink ../2.control.examples/18.conditional.pd
+-text doc/2.control.examples/18.conditional.pd;
+#X connect 15 0 17 0;
+#X connect 16 0 17 1;
 #X connect 17 0 18 0;
-#X connect 18 0 19 0;
-#X connect 18 0 11 0;
-#X connect 18 0 25 0;
-#X connect 19 0 18 1;
-#X connect 20 0 11 1;
-#X connect 22 0 12 0;
-#X connect 25 0 14 0;
-#X connect 28 0 58 0;
-#X connect 32 0 35 0;
-#X connect 33 0 34 0;
-#X connect 35 0 37 0;
-#X connect 35 0 42 0;
-#X connect 36 0 35 1;
-#X connect 37 0 38 0;
-#X connect 40 0 39 0;
-#X connect 42 0 41 0;
-#X connect 54 0 59 0;
-#X connect 55 0 28 0;
-#X connect 55 0 56 0;
-#X connect 55 0 54 0;
-#X connect 56 0 57 0;
+#X connect 19 0 17 0;
+#X connect 20 0 17 0;