revised help docs that conform to the PDDP template

svn path=/trunk/; revision=13942

1 files changed, 146 insertions, 0 deletions

diff --git a/doc/pddp/rpole~-help.pd b/doc/pddp/rpole~-help.pd
new file mode 100644
index 00000000..a9452c53
--- /dev/null
+++ b/doc/pddp/rpole~-help.pd
@@ -0,0 +1,146 @@
+#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 rpole~ 3 12 0 18
+-204280 -1 0;
+#X obj 0 338 cnv 3 550 3 empty \$0-pddp.cnv.inlets inlets 8 12 0 13
+-228856 -1 0;
+#N canvas 53 246 494 344 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 Updated for Pd version-0.38. 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 filter;
+#X text 12 85 DESCRIPTION real one-pole (recursive) filter \, raw;
+#X text 12 25 NAME rpole~;
+#X text 12 145 INLET_1 float signal;
+#X text 12 125 INLET_0 signal clear set;
+#X text 12 165 OUTLET_0 signal;
+#X text 12 245 RELEASE_DATE 1997;
+#X text 12 265 RELEASE_VERSION;
+#X restore 500 597 pd META;
+#X obj 0 454 cnv 3 550 3 empty \$0-pddp.cnv.outlets outlets 8 12 0
+13 -228856 -1 0;
+#X obj 0 486 cnv 3 550 3 empty \$0-pddp.cnv.argument arguments 8 12
+0 13 -228856 -1 0;
+#X obj 0 528 cnv 3 550 3 empty \$0-pddp.cnv.more_info more_info 8 12
+0 13 -228856 -1 0;
+#X obj 78 347 cnv 17 3 55 empty \$0-pddp.cnv.let.0 0 5 9 0 16 -228856
+-162280 0;
+#X obj 78 463 cnv 17 3 17 empty \$0-pddp.cnv.let.0 0 5 9 0 16 -228856
+-162280 0;
+#X obj 78 413 cnv 17 3 30 empty \$0-pddp.cnv.let.1 1 5 9 0 16 -228856
+-162280 0;
+#X obj 479 3 rpole~;
+#X obj 452 20 pddp/pddplink http://wiki.puredata.info/en/rpole~ -text
+pdpedia: rpole~;
+#X floatatom 152 194 0 0 0 0 - - -;
+#X obj 96 107 osc~ 100;
+#X msg 111 139 clear;
+#X msg 113 165 set 1;
+#X text 163 165 <-- set internal state;
+#X text 163 108 <-- signal to filter;
+#X text 182 195 <-- filter coefficient (may be a signal);
+#X text 182 217 <-- creation argument initializes filter coefficient
+;
+#X text 163 139 <-- clear internal state to zero;
+#X obj 95 217 rpole~ 0.9;
+#N canvas 93 273 326 287 test 0;
+#X obj 76 78 osc~;
+#X floatatom 76 55 5 0 0 0 - - -;
+#X obj 77 219 env~ 16384;
+#X floatatom 77 243 5 0 0 0 - - -;
+#X obj 76 168 rpole~;
+#X obj 104 107 tgl 15 0 empty empty empty 0 -6 0 8 -262144 -1 -1 0
+1;
+#X obj 76 105 *~;
+#X msg 97 137 set 1;
+#X floatatom 172 157 4 -100 100 0 - - -;
+#X obj 172 182 / 100;
+#X obj 214 256 dac~;
+#X obj 228 177 tgl 15 0 empty empty empty 0 -6 0 8 -262144 -1 -1 0
+1;
+#X obj 214 220 *~;
+#X obj 230 197 / 10;
+#X text 80 18 Stuff to test it:;
+#X connect 0 0 6 0;
+#X connect 1 0 0 0;
+#X connect 2 0 3 0;
+#X connect 4 0 2 0;
+#X connect 4 0 12 0;
+#X connect 5 0 6 1;
+#X connect 6 0 4 0;
+#X connect 7 0 4 0;
+#X connect 8 0 9 0;
+#X connect 9 0 4 1;
+#X connect 11 0 13 0;
+#X connect 12 0 10 0;
+#X connect 12 0 10 1;
+#X connect 13 0 12 1;
+#X restore 101 537 pd test;
+#X text 11 23 real one-pole (recursive) filter \, raw;
+#X text 50 58 [rpole~] filters an audio signal (left inlet) via a one-pole
+real filter \, whose coefficient is controlled by a creation argument
+or by an audio signal (right inlet).;
+#X text 98 346 signal;
+#X text 168 346 - the incoming signal to filter.;
+#X text 98 366 clear;
+#X text 168 366 - clear internal state to zero.;
+#X text 98 386 set;
+#X text 168 386 - set internal state (e.g. \, "set 1").;
+#X text 98 412 float;
+#X text 98 462 signal;
+#X text 168 462 - the outgoing \, filtered signal.;
+#X text 108 264 y[n] = y[n-1] + a[n] * x[n];
+#X text 49 316 The transfer function is H(Z) = 1/(1 - aZ^-1).;
+#X text 49 284 where y[n] is the output \, x[n] the input \, and a[n]
+the filter coefficient. The filter is unstable if/when |a[n]|>1.;
+#X text 80 505 1) float;
+#N canvas 27 280 428 309 Related_objects 0;
+#X obj 74 60 rzero~;
+#X obj 25 80 cpole~;
+#X obj 25 60 rpole~;
+#X obj 123 60 rzero_rev~;
+#X obj 74 80 czero~;
+#X obj 123 80 czero_rev~;
+#X text 201 60 real;
+#X text 200 81 complex;
+#X text 22 44 1-pole;
+#X text 71 44 1-zero;
+#X text 121 44 1-zero \, reversed;
+#X text 47 29 summary of raw filters:;
+#X text 18 184 User-friendly Filters;
+#X obj 21 213 lop~;
+#X obj 72 212 hip~;
+#X obj 124 213 bp~;
+#X obj 169 214 vcf~;
+#X obj 22 274 biquad~;
+#X text 18 250 Other Objects;
+#X text 18 113 Pd also provides a suite of user-friendly filters. This
+and other raw filters are provided for situations which the user-friendly
+ones can't handle. See Chapter 8 of http://crca.ucsd.edu/~msp/techniques
+for an introduction to the necessary theory.;
+#X obj 1 1 cnv 15 425 20 empty \$0-pddp.cnv.subheading empty 3 12 0
+14 -204280 -1 0;
+#X text 7 1 [rpole~] Related Objects;
+#X restore 101 597 pd Related_objects;
+#X text 98 430 signal;
+#X text 167 430 - filter coefficient.;
+#X text 167 412 - filter coefficient.;
+#X text 167 505 - (optional) initializes filter coefficient.;
+#X text 49 242 The action of [rpole~] is:;
+#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/H11.shelving.pd -text
+doc/3.audio.examples/H11.shelving.pd;
+#X obj 98 572 pddp/pddplink ../3.audio.examples/H14.all.pass.pd -text
+doc/3.audio.examples/H14.all.pass.pd;
+#X connect 12 0 21 1;
+#X connect 13 0 21 0;
+#X connect 14 0 21 0;
+#X connect 15 0 21 0;