revised help docs that conform to the PDDP template

svn path=/trunk/; revision=13942

1 files changed, 81 insertions, 0 deletions

diff --git a/doc/pddp/env~-help.pd b/doc/pddp/env~-help.pd
new file mode 100644
index 00000000..7a053196
--- /dev/null
+++ b/doc/pddp/env~-help.pd
@@ -0,0 +1,81 @@
+#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 env~ 3 12 0 18 -204280
+-1 0;
+#X obj 0 343 cnv 3 550 3 empty \$0-pddp.cnv.inlets inlets 8 12 0 13
+-228856 -1 0;
+#N canvas 47 243 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.40. 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 25 NAME env~;
+#X text 12 45 KEYWORDS signal conversion;
+#X text 12 125 INLET_0 signal;
+#X text 12 145 INLET_1 float;
+#X text 12 85 DESCRIPTION envelope follower;
+#X text 12 225 RELEASE_DATE 1997;
+#X text 12 245 RELEASE_VERSION;
+#X restore 500 597 pd META;
+#X obj 0 380 cnv 3 550 3 empty \$0-pddp.cnv.outlets outlets 8 12 0
+13 -228856 -1 0;
+#X obj 0 434 cnv 3 550 3 empty \$0-pddp.cnv.argument arguments 8 12
+0 13 -228856 -1 0;
+#X obj 0 535 cnv 3 550 3 empty \$0-pddp.cnv.more_info more_info 8 12
+0 13 -228856 -1 0;
+#X obj 78 352 cnv 17 3 17 empty \$0-pddp.cnv.let.0 0 5 9 0 16 -228856
+-162280 0;
+#X obj 78 389 cnv 17 3 17 empty \$0-pddp.cnv.let.0 0 5 9 0 16 -228856
+-162280 0;
+#X text 98 351 signal;
+#X obj 493 3 env~;
+#X obj 465 20 pddp/pddplink http://wiki.puredata.info/en/env~ -text
+pdpedia: env~;
+#X text 98 539 The analysis is "Hanning" (raised cosine) windowed.
+;
+#X text 98 389 float;
+#X floatatom 74 263 0 0 0 0 - - -;
+#X obj 74 140 osc~ 400;
+#X obj 74 167 *~;
+#X floatatom 166 116 3 -99 300 0 - - -;
+#X obj 166 140 dbtorms;
+#X text 194 114 <- set peak-to-peak amplitude here in dB.;
+#X text 110 264 <- the output is RMS amplitude which (for a sinusoid)
+is about 3 dB below peak-to-peak amplitude.;
+#X obj 74 200 env~ 16384 8192;
+#N canvas 97 488 428 101 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 9 38 threshold~;
+#X text 7 1 [env~] Related Objects;
+#X restore 101 597 pd Related_objects;
+#X text 11 23 envelope follower;
+#X text 168 452 - (optional) the analysis window size in samples (the
+default is 1024).;
+#X text 80 452 1) float;
+#X text 80 479 2) float;
+#X text 168 479 - (optional) the period (the number of samples per
+analysis-- window/2 by default). This should normally be a multiple
+of the DSP block size \, although this isn't enforced.;
+#X text 168 389 - the [env~] object takes a signal and outputs its
+RMS amplitude in dB (with 1 normalized to 100 dB.) Output is bounded
+below by zero.;
+#X text 168 351 - the incoming signal;
+#X obj 4 597 pddp/pddplink pddp/help.pd -text help;
+#X obj 455 51 pddp/dsp-reminder;
+#X obj 98 557 pddp/pddplink ../3.audio.examples/C07.envelope.follower.pd
+-text doc.3.audio.examples/C07.envelope.follower.pd;
+#X obj 98 572 pddp/pddplink ../3.audio.examples/H06.envelope.follower.pd
+-text doc.3.audio.examples/H06.envelope.follower.pd;
+#X connect 15 0 16 0;
+#X connect 16 0 21 0;
+#X connect 17 0 18 0;
+#X connect 18 0 16 1;
+#X connect 21 0 14 0;
+#X connect 21 0 14 0;