revised help docs that conform to the PDDP template

svn path=/trunk/; revision=13942

1 files changed, 135 insertions, 93 deletions

diff --git a/doc/pddp/tabread-help.pd b/doc/pddp/tabread-help.pd
index b13d50e2..88e089b5 100644
--- a/doc/pddp/tabread-help.pd
+++ b/doc/pddp/tabread-help.pd
@@ -1,93 +1,135 @@
-#N canvas 2 1 648 608 12;

-#X obj 114 560 pddp/pddplink http://puredata.info/dev/pddp -text pddp;

-#X obj 8 3 cnv 15 90 578 empty empty empty 20 12 0 14 -233017 -66577

-0;

-#X text 14 223 ARGUMENTS:;

-#X text 19 323 EXAMPLES:;

-#X text 22 471 SEE ALSO:;

-#N canvas 58 0 405 254 Related_Objects 0;

-#X text 25 11 Native Pd Objects;

-#X text 16 166 Externals and other object libraries;

-#X obj 16 41 tabread~;

-#X obj 90 41 tabread4;

-#X obj 165 41 tabwrite;

-#X obj 240 41 tabwrite~;

-#X obj 16 67 tabsend~;

-#X obj 92 67 tabreceive~;

-#X obj 192 67 tabplay~;

-#X obj 269 67 table;

-#X text 15 124 [array];

-#X obj 16 94 soundfiler;

-#X text 78 124 and fft objects.;

-#X text 21 187 [tabdump];

-#X obj 112 94 tabread4~;

-#X text 20 207 [tabenv];

-#X obj 203 94 getsize;

-#X obj 274 94 setsize;

-#X text 238 207 [arraysize];

-#X text 238 186 [score];

-#X text 114 186 [linear_path];

-#X text 114 207 [plot];

-#X restore 114 508 pd Related_Objects;

-#N canvas 80 0 655 534 More_Info 0;

-#X text 25 16 WHAT IS THE DIFFERENCE BETWEEN A TABLE AND AN ARRAY AND

-A GRAPH AND A TEMPLATE AND A LIST AND A SCALAR AND A WIDGET?;

-#X text 43 56 That question isn't relevant yet \, but I know you're

-probably asking it. Let's just set aside these terms and their uses

-and say the following:;

-#X text 67 114 1 In Pd \, the terms "graph" and "table" are almost

-synonymous.;

-#X text 66 164 2 A table in Pd is a convenient place to store an array.

-;

-#X text 65 392 5 For more discussion about arrays and tables \, please

-see the help documentation in: doc/2.control.examples/15.arrays.pd

-and doc/5.reference/table.pd;

-#X text 44 487 Also See:;

-#X obj 123 487 pddp/pddplink all_about_arrays.pd -text all_about_arrays;

-#X text 66 195 3 When you create a table \, an array of 100 elements

-is automatically created inside that table. The name of the table and

-the name of the array are stored separately. This means \, that although

-the table has the same name as the default array \, you can rename

-one or the other individually.;

-#X text 66 307 4 [tabread] is designed to read the numbers from arrays

-- whether they're stored in tables or not! Perhaps we can think of

-this object as [arrayread] instead? Keep in mind that arrays can be

-created separately from tables.;

-#X restore 114 534 pd More_Info;

-#X obj 32 10 tabread;

-#X text 111 10 - READ NUMBERS FROM A TABLE;

-#X text 104 277 One - outputs a floating point number which corresponds

-to the index you query using the inlet.;

-#X obj 161 416 tabread davids_table;

-#X floatatom 161 443 0 0 0 3 - - -;

-#X floatatom 116 364 0 0 99 1 index - -;

-#X msg 241 391 set another_table;

-#X msg 203 366 set davids_table;

-#X text 105 168 Set - the "set <arrayname>" message allows you to read

-from dynamic sources. You can change the source at any time using the

-"set" message.;

-#X text 105 223 One - the argument informs [tabread] which array to

-read. The array must exist in an open Pd patch/canvas or an error message

-will appear in the terminal window.;

-#X text 29 278 OUTLETS:;

-#X text 410 433 tables which store \; arrays of the same name.;

-#X obj 413 384 table davids_table;

-#X obj 413 410 table another_table;

-#X text 113 443 value;

-#X text 158 561 - Dave Sabine \, April 25 \, 2003;

-#X text 106 323 Open the tables and use your mouse to draw new values

-in the arrays - otherwise [tabread] will always output "0".;

-#X text 39 34 INLETS:;

-#X text 107 34 Float - A float at the left inlet will move to the corresponding

-index in the table's array. The lowest valid number is "0" which represents

-the first element of the array. The highest valid number is the size

-of the array minus 1 By default \, the size of an array in a table

-is 100 - or 0 to 99 The actual size of the array can be altered using

-the array's dialog box or the resize command. More about arrays can

-be found below.;

-#X text 112 470 doc/2.control.examples/15.arrays.pd;

-#X text 113 489 doc/2.control.examples/16.more.arrays.pd;

-#X connect 10 0 11 0;

-#X connect 12 0 10 0;

-#X connect 13 0 10 0;

-#X connect 14 0 10 0;

+#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 tabread 3 12 0 18
+-204280 -1 0;
+#X obj 0 277 cnv 3 550 3 empty \$0-pddp.cnv.inlets inlets 8 12 0 13
+-228856 -1 0;
+#N canvas 51 245 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 Dave Sabine \, April 25 \, 2003 .
+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 control array;
+#X text 12 85 DESCRIPTION read numbers from a table;
+#X text 12 25 NAME tabread;
+#X text 12 125 INLET_0 float set;
+#X text 12 145 OUTLET_0 float;
+#X text 12 225 RELEASE_DATE 1997;
+#X text 12 245 RELEASE_VERSION;
+#X restore 500 597 pd META;
+#X obj 0 444 cnv 3 550 3 empty \$0-pddp.cnv.outlets outlets 8 12 0
+13 -228856 -1 0;
+#X obj 0 482 cnv 3 550 3 empty \$0-pddp.cnv.argument arguments 8 12
+0 13 -228856 -1 0;
+#X obj 0 541 cnv 3 550 3 empty \$0-pddp.cnv.more_info more_info 8 12
+0 13 -228856 -1 0;
+#N canvas 83 315 428 299 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 [tabread] Related Objects;
+#X text 21 38 Native Pd Objects;
+#X obj 24 61 tabread~;
+#X obj 98 61 tabread4;
+#X obj 173 61 tabwrite;
+#X obj 248 61 tabwrite~;
+#X obj 24 89 tabsend~;
+#X obj 100 89 tabreceive~;
+#X obj 200 89 tabplay~;
+#X obj 277 89 table;
+#X text 21 140 [array];
+#X obj 24 116 soundfiler;
+#X text 84 140 and fft objects.;
+#X obj 120 116 tabread4~;
+#X obj 211 116 getsize;
+#X obj 282 116 setsize;
+#X text 22 164 Externals and other object libraries;
+#X obj 22 184 pddp/helplink zexy/tabdump;
+#X obj 22 204 pddp/helplink linear_path;
+#X text 103 204 <-- which library is this in?;
+#X text 103 224 <-- which library is this in?;
+#X obj 22 224 pddp/helplink score;
+#X text 103 244 <-- which library is this in?;
+#X obj 22 244 pddp/helplink tabenv;
+#X obj 22 264 pddp/helplink flatspace/arraysize;
+#X restore 102 597 pd Related_objects;
+#X obj 78 286 cnv 17 3 145 empty \$0-pddp.cnv.let.0 0 5 9 0 16 -228856
+-162280 0;
+#X text 98 285 float;
+#X text 98 452 float;
+#X obj 78 453 cnv 17 3 17 empty \$0-pddp.cnv.let.0 0 5 9 0 16 -228856
+-162280 0;
+#X obj 475 3 tabread;
+#X obj 445 20 pddp/pddplink http://wiki.puredata.info/en/tabread -text
+pdpedia: tabread;
+#X text 168 285 - a float at the left inlet will move to the corresponding
+index in the table's array. The index ranges from 0 to the size of
+the array minus one (numbers outside this range are ignored). By default
+\, the size of an array in a table is 100 - or 0 to 99 . The actual
+size of the array can be altered using the array's dialog box or the
+resize command. More about arrays can be found below.;
+#X text 98 402 set;
+#X text 168 500 - the argument informs [tabread] which array to read.
+The array must exist in an open Pd patch/canvas or an error message
+will appear in the terminal window.;
+#X text 168 452 - outputs a floating point number which corresponds
+to the index you query using the inlet.;
+#X floatatom 74 251 0 0 0 0 value - -;
+#X floatatom 74 93 0 0 99 0 index - -;
+#X text 18 55 Open the tables and use your mouse to draw new values
+in the arrays - otherwise [tabread] will always output "0".;
+#N canvas 0 0 450 300 (subpatch) 0;
+#X array \$0-array1 100 float 3;
+#A 0 -0.900001 -0.900001 -0.900001 -0.900001 -0.900001 -0.866667 -0.833334
+-0.833334 -0.833334 -0.833334 -0.800001 -0.800001 -0.766667 -0.766667
+-0.766667 -0.766667 -0.766667 -0.766667 -0.766667 -0.766667 -0.766667
+-0.766667 -0.766667 -0.766667 -0.766667 -0.766667 -0.766667 -0.766667
+-0.766667 -0.766667 -0.733334 -0.733334 -0.733334 -0.7 -0.666667 -0.633334
+-0.633334 -0.633334 -0.633334 -0.633334 -0.633334 -0.633334 -0.633334
+-0.6 -0.6 -0.566667 -0.566667 -0.566667 -0.566667 -0.566667 -0.566667
+-0.566667 -0.566667 -0.566667 -0.566667 -0.566667 -0.533334 -0.533334
+-0.5 -0.5 -0.466667 -0.466667 -0.433334 -0.4 -0.366667 -0.333333 -0.3
+-0.283333 -0.266667 -0.233333 -0.2 -0.133333 -0.133333 -0.133333 -0.0666667
+-0.0666667 -0.0666667 1.49012e-08 0.1 0.1 0.233333 0.3 0.333334 0.4
+0.433334 0.566667 0.633334 0.733334 0.733334 0.766667 0.766667 0.800001
+0.800001 0.800001 0.800001 0.800001 0.800001 0.800001 0.800001 0.900001
+;
+#X coords 0 1 99 -1 100 60 1;
+#X restore 383 83 graph;
+#X text 346 217 mouse to draw new values.;
+#X text 346 204 Open the table and use your;
+#X text 98 546 doc/2.control.examples/15.arrays.pd;
+#X text 98 561 doc/2.control.examples/16.more.arrays.pd;
+#X text 168 402 - the "set" message allows you to read from dynamic
+sources (e.g. \, "set tabread-help-array"). You can change the source
+at any time using the "set" message.;
+#X text 98 380 list;
+#X text 168 380 - a list will be truncated to the first item.;
+#X text 11 24 read numbers from a table;
+#X obj 98 577 pddp/pddplink all_about_arrays.pd -text all_about_arrays
+;
+#X text 80 500 1) symbol atom;
+#X obj 4 597 pddp/pddplink pddp/help.pd -text help;
+#X obj 107 93 bng 15 250 50 0 empty empty empty 17 7 0 10 -4034 -1
+-1;
+#X obj 107 113 f \$0;
+#X obj 110 162 bng 15 250 50 0 empty empty empty 17 7 0 10 -4034 -1
+-1;
+#X obj 110 182 f \$0;
+#X msg 107 135 set \$1-array1;
+#X obj 74 227 tabread \$0-array1;
+#X msg 110 204 set \$1-array2;
+#X obj 353 184 table \$0-array2;
+#X connect 19 0 38 0;
+#X connect 33 0 34 0;
+#X connect 34 0 37 0;
+#X connect 35 0 36 0;
+#X connect 36 0 39 0;
+#X connect 37 0 38 0;
+#X connect 38 0 18 0;
+#X connect 39 0 38 0;