revised help docs that conform to the PDDP template

svn path=/trunk/; revision=13942

1 files changed, 130 insertions, 66 deletions

diff --git a/doc/pddp/symbol-help.pd b/doc/pddp/symbol-help.pd
index 2a21eb8e..25b1de74 100644
--- a/doc/pddp/symbol-help.pd
+++ b/doc/pddp/symbol-help.pd
@@ -1,69 +1,133 @@
-#N canvas 353 86 570 640 10;
-#X text 31 576 This document was updated for Pd version 0.35 test 24
-by Dave Sabine as part of a project called pddp proposed by Krzysztof
-Czaja to build comprehensive documentation for Pd.;
-#X obj 55 12 symbol;
-#X obj 28 259 symbol;
-#X msg 28 112 bang;
-#X text 60 112 "Bang" will force the object to output its value.;
-#X symbolatom 28 310 10 0 0 0 - - -;
-#X obj 28 329 print;
-#X text 22 41 The symbol object stores a symbol (which is set either
+#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 symbol 3 12 0 18
+-204280 -1 0;
+#X obj 0 317 cnv 3 550 3 empty \$0-pddp.cnv.inlets inlets 8 12 0 13
+-228856 -1 0;
+#N canvas 50 246 494 363 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.35 test 24 by Dave Sabine as part of a project called pddp
+proposed by Krzysztof Czaja to build comprehensive documentation for
+Pd. 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 85 DESCRIPTION store a symbol;
+#X text 12 125 INLET_0 anything;
+#X text 12 145 INLET_1 symbol;
+#X text 12 165 OUTLET_0 symbol;
+#X text 12 25 NAME symbol;
+#X text 12 45 KEYWORDS control storage symbol_op;
+#X text 12 245 RELEASE_DATE 1997;
+#X text 12 265 RELEASE_VERSION;
+#X restore 500 597 pd META;
+#X obj 0 475 cnv 3 550 3 empty \$0-pddp.cnv.outlets outlets 8 12 0
+13 -228856 -1 0;
+#X obj 0 517 cnv 3 550 3 empty \$0-pddp.cnv.argument arguments 8 12
+0 13 -228856 -1 0;
+#X obj 0 558 cnv 3 550 3 empty \$0-pddp.cnv.more_info more_info 8 12
+0 13 -228856 -1 0;
+#N canvas 74 346 428 238 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 [symbol] Related Objects;
+#X obj 23 67 list;
+#X obj 63 67 int;
+#X obj 94 67 float;
+#X obj 137 67 select;
+#X obj 187 67 makefilename;
+#X text 21 38 Native Pd Objects;
+#X text 21 108 Externals;
+#X obj 19 188 pddp/helplink ext13/ftos;
+#X obj 19 208 pddp/helplink iemlib/unsymbol;
+#X obj 20 168 pddp/helplink zexy/index;
+#X obj 20 148 pddp/helplink zexy/makesymbol;
+#X obj 20 128 pddp/helplink zexy/lister;
+#X restore 102 597 pd Related_objects;
+#X obj 78 326 cnv 17 3 110 empty \$0-pddp.cnv.let.0 0 5 9 0 16 -228856
+-162280 0;
+#X obj 78 484 cnv 17 3 17 empty \$0-pddp.cnv.let.0 0 5 9 0 16 -228856
+-162280 0;
+#X obj 78 442 cnv 17 3 17 empty \$0-pddp.cnv.let.1 1 5 9 0 16 -228856
+-162280 0;
+#X obj 481 3 symbol;
+#X obj 455 20 pddp/pddplink http://wiki.puredata.info/en/symbol -text
+pdpedia: symbol;
+#X text 11 23 store a symbol;
+#X text 98 325 bang;
+#X text 98 350 symbol;
+#X text 98 441 symbol;
+#X text 98 483 symbol;
+#X text 168 483 - the symbol is output when a message is received at
+the left inlet of [symbol].;
+#X obj 51 220 symbol;
+#X symbolatom 51 279 10 0 0 0 - - -;
+#X obj 60 256 print;
+#X msg 63 82 dog;
+#X msg 71 105 cat;
+#X msg 84 132 symbol horse;
+#X msg 98 154 symbol wolf;
+#X msg 107 177 symbol pig;
+#X text 168 325 - sending a bang will force [symbol] to output its
+stored stored value.;
+#X text 275 120 IMPORTANT NOTE;
+#X obj 302 156 symbol;
+#X symbolatom 302 195 10 0 0 0 - - -;
+#X text 270 213 Careful not to get them confused.;
+#X text 270 175 is very different than the symbol box:;
+#X text 270 136 the [symbol] object:;
+#X msg 51 57 bang;
+#N canvas 78 344 428 194 Symbol_vs_Symbol_Box 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 [symbol] vs. the Symbol Box;
+#X obj 23 125 symbol;
+#X msg 23 103 list 12;
+#X text 68 125 outputs "symbol list";
+#X msg 217 103 list 12;
+#X text 283 125 outputs "symbol float";
+#X symbolatom 217 125 10 0 0 0 - - -;
+#X text 20 38 The [symbol] object and the symbol box handle the "list"
+selector inconsistently.;
+#X text 23 76 [symbol] output;
+#X obj 23 147 print from_[symbol];
+#X obj 217 147 print from_symbol_box;
+#X text 216 76 symbol box output;
+#X connect 2 0 10 0;
+#X connect 3 0 2 0;
+#X connect 5 0 7 0;
+#X connect 7 0 11 0;
+#X restore 102 567 pd Symbol_vs_Symbol_Box;
+#X text 168 535 - (optional) initializes the stored symbol.;
+#X text 80 535 1) symbol atom;
+#X text 121 259 For this example \, I have used the symbol box to display
+the value that was stored in the [symbol] object \, as well as printing
+the value to the console.;
+#X text 167 441 - a symbol to the right inlet is stored. (Note: symbol
+atoms like "foo" will not be accepted.);
+#X text 105 49 The [symbol] object stores a symbol (which is set either
 by its creation argument or by the right inlet) and then outputs that
 symbol when it receives a "bang" message or a new symbol in its left
 inlet.;
-#X text 23 381 IMPORTANT NOTE;
-#X obj 71 410 symbol;
-#X symbolatom 63 449 10 0 0 0 - - -;
-#X text 75 328 For this example \, I have used the symbol atom to display
-the value that was stored in the symbol object and also printed the
-value to the terminal window.;
-#X text 74 253 The symbols are stored here. When banged \, the symbol
-is outputted through the outlet. Note that a creation argument is optional.
-;
-#X msg 40 137 dog;
-#X msg 48 155 cat;
-#X msg 59 181 symbol horse;
-#X msg 73 199 symbol wolf;
-#X msg 82 217 symbol pig;
-#X text 75 139 Sending a symbol to its left inlet will store AND output
-the value.;
-#X text 23 490 RELATED OBJECTS;
-#X obj 26 513 int;
-#X obj 58 513 float;
-#X obj 102 513 f;
-#X obj 134 513 select;
-#X obj 188 513 makefilename;
-#X text 153 179 Sending new symbols to its right inlet will store the
-values. These values can later be sent via "bang" to its left inlet.
-Note that these symbols are preceded by the word "symbol" to indicate
-the appropriate data type.;
-#N canvas 0 22 462 238 related_objects_from_other_libraries 0;
-#X obj 160 28 makesymbol;
-#X obj 118 28 index;
-#X obj 16 27 ftos;
-#X obj 52 27 unsymbol;
-#X text 10 129 The best places to find information about Pd's libraries
-is:;
-#X text 13 159 www.puredata.org and click on "Downloads" then "Software"
-;
-#X text 14 172 or;
-#X text 15 186 iem.kug.ac.at/pdb/;
-#X obj 243 28 lister;
-#X text 17 58 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. These objects usually included in
-the installers.;
-#X restore 25 536 pd related_objects_from_other_libraries;
-#X text 31 395 Symbol - the OBJECT:;
-#X text 31 431 is very different than symbol - the ATOM:;
-#X text 29 466 Careful not to get them confused.;
-#X text 109 13 STORE A SYMBOL;
-#X connect 2 0 5 0;
-#X connect 3 0 2 0;
-#X connect 5 0 6 0;
-#X connect 13 0 2 0;
-#X connect 14 0 2 0;
-#X connect 15 0 2 1;
-#X connect 16 0 2 1;
-#X connect 17 0 2 1;
+#X text 168 391 - all other messages to the left inlet of symbol will
+store and output the selector. E.g. \, a float will output the word
+"float" \, a list will output "list" \, a pointer will output "pointer"
+\, "foo bar" will output "foo" \, and so forth.;
+#X text 168 350 - a symbol sent to the left inlet will be stored and
+output. Symbol atoms (e.g. \, "foo") are accepted and given the "symbol"
+selector.;
+#X obj 4 597 pddp/pddplink pddp/help.pd -text help;
+#X text 98 391 anything;
+#X connect 19 0 20 0;
+#X connect 19 0 21 0;
+#X connect 22 0 19 0;
+#X connect 23 0 19 0;
+#X connect 24 0 19 1;
+#X connect 25 0 19 1;
+#X connect 26 0 19 1;
+#X connect 34 0 19 0;