revised help docs that conform to the PDDP template

svn path=/trunk/; revision=13942

1 files changed, 86 insertions, 0 deletions

diff --git a/doc/pddp/snapshot~-help.pd b/doc/pddp/snapshot~-help.pd
new file mode 100644
index 00000000..16a2a669
--- /dev/null
+++ b/doc/pddp/snapshot~-help.pd
@@ -0,0 +1,86 @@
+#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 snapshot~ 3 12 0
+18 -204280 -1 0;
+#X obj 0 417 cnv 3 550 3 empty \$0-pddp.cnv.inlets inlets 8 12 0 13
+-228856 -1 0;
+#N canvas 51 246 494 344 META 0;
+#X text 12 105 PLATFORM windows macosx gnulinux;
+#X text 12 165 LIBRARY internal;
+#X text 12 205 WEBSITE http://crca.ucsd.edu/~msp/;
+#X text 12 65 LICENSE SIBSD;
+#X text 12 185 AUTHOR Miller Puckette;
+#X text 12 265 HELP_PATCH_AUTHORS Updated for Pd version 0.37. 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 45 KEYWORDS signal conversion;
+#X text 12 85 DESCRIPTION convert a signal to a number on demand;
+#X text 12 25 NAME snapshot~;
+#X text 12 145 OUTLET_0 float;
+#X text 12 125 INLET_0 bang signal set;
+#X text 12 225 RELEASE_DATE 1997;
+#X text 12 245 RELEASE_VERSION;
+#X restore 500 597 pd META;
+#X obj 0 500 cnv 3 550 3 empty \$0-pddp.cnv.outlets outlets 8 12 0
+13 -228856 -1 0;
+#X obj 0 542 cnv 3 550 3 empty \$0-pddp.cnv.argument arguments 8 12
+0 13 -228856 -1 0;
+#X obj 0 569 cnv 3 550 3 empty \$0-pddp.cnv.more_info more_info 8 12
+0 13 -228856 -1 0;
+#X text 98 546 (none);
+#N canvas 104 479 428 109 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 [snapshot~] Related Objects;
+#X obj 22 43 sig~;
+#X obj 63 43 vsnapshot~;
+#X restore 102 597 pd Related_objects;
+#X obj 78 426 cnv 17 3 65 empty \$0-pddp.cnv.let.0 0 5 9 0 16 -228856
+-162280 0;
+#X text 98 508 float;
+#X obj 78 509 cnv 17 3 17 empty \$0-pddp.cnv.let.0 0 5 9 0 16 -228856
+-162280 0;
+#X obj 465 3 snapshot~;
+#X obj 435 20 pddp/pddplink http://wiki.puredata.info/en/snapshot~
+-text pdpedia: snapshot~;
+#X obj 91 307 snapshot~;
+#X floatatom 91 330 0 0 0 0 - - -;
+#X msg 102 255 bang;
+#X obj 91 230 osc~ 0.1;
+#X text 90 209 0.1 Hz cosine;
+#X msg 107 279 set 5;
+#X text 98 425 signal;
+#X text 11 23 convert a signal to a number on demand;
+#X text 98 445 bang;
+#X text 98 465 set;
+#X text 168 465 - the "set" message \, followed by a value \, sets
+[snapshot~] to the specified value (which is reset the next DSP block).
+;
+#X text 168 508 - upon receiving a bang to its inlet \, [snapshot~]
+outputs a value.;
+#X text 143 255 <- Click to take a "snapshot" of the signal;
+#X text 168 425 - the incoming signal.;
+#X text 168 445 - a bang takes one snapshot of the incoming signal.
+;
+#X text 18 109 In the example below \, a [snapshot~] object prints
+out the values of a low frequency cosine wave every time it is sent
+a bang message.;
+#X text 18 152 A "set" message is provided for the (rare) situations
+where you might make a known change to the signal input \, and then
+read snapshot's value before any ensuing signal computation.;
+#X text 18 57 The [snapshot~] object takes a signal and converts it
+to a control value whenever it receives a bang in its left outlet.
+This object is particularly useful for monitoring outputs.;
+#X text 156 329 This output updates each time bang is clicked above.
+;
+#X obj 4 597 pddp/pddplink pddp/help.pd -text help;
+#X obj 455 51 pddp/dsp-reminder;
+#X obj 99 572 pddp/pddplink ../3.audio.examples/C06.signal.to.control.pd
+-text doc/3.audio.examples/C06.signal.to.control.pd;
+#X connect 14 0 15 0;
+#X connect 14 0 15 0;
+#X connect 16 0 14 0;
+#X connect 17 0 14 0;
+#X connect 19 0 14 0;