From 8e183e4cee44e4fcf8822623c2051a63823833f0 Mon Sep 17 00:00:00 2001 From: Hans-Christoph Steiner Date: Sat, 27 Nov 2004 20:05:39 +0000 Subject: various minor tweaks svn path=/trunk/; revision=2327 --- doc/pddp/all_about_lists_vs_anythings.pd | 84 +++++++++----- doc/pddp/help-route.pd | 189 +++++++++++++++++-------------- doc/pddp/pddp-style-guide.pd | 44 +++---- 3 files changed, 181 insertions(+), 136 deletions(-) (limited to 'doc') diff --git a/doc/pddp/all_about_lists_vs_anythings.pd b/doc/pddp/all_about_lists_vs_anythings.pd index 394cb0d1..9881111d 100644 --- a/doc/pddp/all_about_lists_vs_anythings.pd +++ b/doc/pddp/all_about_lists_vs_anythings.pd @@ -1,9 +1,7 @@ -#N canvas 315 96 870 599 10; -#X msg 74 245 1 2 3; -#X obj 134 276 route list; -#X msg 183 224 list this is a list with a cast; -#X msg 190 243 this is a list withOUT a cast; -#X msg 41 225 list 1 2 3; +#N canvas 197 93 874 603 10; +#X msg 74 278 1 2 3; +#X obj 134 309 route list; +#X msg 41 258 list 1 2 3; #X msg 10 63 list; #X msg 17 83 list 5; #X msg 24 103 list pie; @@ -23,15 +21,15 @@ #X obj 153 509 s2l; #X obj 197 490 tosymbol; #X obj 197 509 fromsymbol; -#X text 502 313 use [prepend]!!; -#X obj 619 311 prepend; -#X obj 682 380 drip; -#X text 589 380 write about:; -#X obj 560 460 glue; -#X obj 621 487 pack; -#X obj 620 461 list2symbol; -#X obj 730 460 tosymbol; -#X text 8 175 More than one "float" in a message is considered a "list". +#X text 501 288 use [prepend]!!; +#X obj 618 286 prepend; +#X obj 661 331 drip; +#X text 568 331 write about:; +#X obj 539 411 glue; +#X obj 600 438 pack; +#X obj 599 412 list2symbol; +#X obj 709 411 tosymbol; +#X text 8 208 More than one "float" in a message is considered a "list". More than one "symbol" in a message is not implicitly considered a "list" \, only if you cast it.; #X text 87 104 A "list" of one "symbol" is translated into a "symbol". @@ -40,28 +38,52 @@ More than one "symbol" in a message is not implicitly considered a ; #X text 50 63 An empty "list" is tranlated into a "bang".; #X text 7 39 SPECIAL CASES OF "LISTS".; -#X text 498 268 working with "lists" and "anythings":; -#X text 537 434 making "lists" from untyped inputs:; +#X text 497 243 working with "lists" and "anythings":; +#X text 516 385 making "lists" from untyped inputs:; #X obj 10 148 print NOT-LISTS; -#X obj 496 460 repack; -#X obj 134 299 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1 +#X obj 475 411 repack; +#X obj 134 332 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1 -1; -#X obj 198 300 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1 +#X obj 198 333 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1 -1; -#X text 506 163 lists maps to outlets \, non-lists don't; #X text 478 138 Miller's list explanation; #X obj 65 391 list; #X obj 64 366 any; #X obj 93 366 pipe; -#X text 509 190 anything is not a atom type; +#X text 509 190 - anything is not a atom type; +#X text 506 162 - lists map to inlets \, non-lists don't; +#X obj 55 166 route b f s; +#X msg 183 257 list this is a set with a cast; +#X msg 190 276 this is a set withOUT a cast; +#X text 370 475 a set that is not a "list" has an undefined type:; +#X obj 469 568 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1 +-1; +#X obj 516 567 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1 +-1; +#X obj 564 566 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1 +-1; +#X msg 468 501 list this is a set with a cast; +#X msg 475 520 this is a set withOUT a cast; +#X obj 469 545 route bang float symbol list; +#X obj 612 567 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1 +-1; +#X obj 660 566 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1 +-1; #X connect 0 0 1 0; -#X connect 1 0 40 0; -#X connect 1 1 41 0; +#X connect 1 0 38 0; +#X connect 1 1 39 0; #X connect 2 0 1 0; -#X connect 3 0 1 0; -#X connect 4 0 1 0; -#X connect 5 0 38 0; -#X connect 6 0 38 0; -#X connect 7 0 8 0; -#X connect 7 0 38 0; -#X connect 29 0 28 0; +#X connect 3 0 36 0; +#X connect 4 0 36 0; +#X connect 5 0 6 0; +#X connect 5 0 36 0; +#X connect 27 0 26 0; +#X connect 47 0 1 0; +#X connect 48 0 1 0; +#X connect 53 0 55 0; +#X connect 54 0 55 0; +#X connect 55 0 50 0; +#X connect 55 1 51 0; +#X connect 55 2 52 0; +#X connect 55 3 56 0; +#X connect 55 4 57 0; diff --git a/doc/pddp/help-route.pd b/doc/pddp/help-route.pd index 70b3405f..cc689a66 100644 --- a/doc/pddp/help-route.pd +++ b/doc/pddp/help-route.pd @@ -1,28 +1,23 @@ -#N canvas 128 127 1007 645 10; +#N canvas 209 40 1015 653 10; #X obj 7 331 print x1; -#X obj 59 331 print x2; -#X obj 112 331 print x3; -#X obj 164 331 print x4; +#X obj 69 331 print x2; +#X obj 131 331 print x3; +#X obj 194 331 print x4; #X obj 82 273 route 23 54 1; -#X msg 290 217 54 43; -#X msg 332 217 1 foo bar; -#X obj 44 408 route big apple; -#X msg 422 377 1 2 3; -#X msg 332 364 big apple pie; -#X msg 414 235 walk the dog; -#X text 25 215 numeric arguments:; -#X text 18 364 symbolic arguments:; -#X msg 574 287 bang; -#X msg 575 380 list; -#X msg 547 208 5; -#X msg 553 228 float 5; -#X msg 575 402 list 5; -#X msg 579 307 symbol pie; -#X msg 586 327 pie; -#X msg 561 248 1 2 3; -#X obj 9 475 print y1; -#X obj 69 475 print y2; -#X obj 129 475 print y3; +#X msg 170 239 54 43; +#X msg 212 239 1 foo bar; +#X obj 141 418 route big apple; +#X msg 351 386 1 2 3; +#X msg 248 376 big apple pie; +#X msg 320 238 walk the dog; +#X text 8 217 numeric arguments:; +#X text 16 356 symbolic arguments:; +#X msg 590 287 bang; +#X msg 621 405 list; +#X msg 622 438 list 5; +#X msg 593 307 symbol pie; +#X msg 596 327 pie; +#X msg 584 248 1 2 3; #X obj 26 13 route; #X text 67 13 - route messages according to their first element; #X text 25 108 If a match is found \, and the message contains only @@ -36,24 +31,19 @@ of outlets is the number of arguments plus one.; and [route] will therefore assume that it should attempt to match messages that are data type 'number'. All messages that are not numbers will be output through the right-most outlet.; -#X msg 138 217 23 345 456; -#X msg 216 217 420 34 45; -#X msg 138 364 apple pie; -#X msg 202 364 impeach ringo starr; -#X text 147 408 In this case \, the data type 'symbol' is implied by +#X msg 18 239 23 345 456; +#X msg 96 239 420 34 45; +#X msg 32 376 apple pie; +#X msg 105 376 impeach ringo starr; +#X text 34 490 In this case \, the data type 'symbol' is implied by the creation arguments and therefore this [route] object will match symbols only. Symbolic messages that do not match any of the arguments \, and all numbers \, will be output through the right-most outlet. ; -#X obj 526 5 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1 --1; -#X obj 526 566 bng 15 250 50 0 empty empty empty 0 -6 0 8 -262144 -1 --1; -#X obj 704 468 print NO_Match; -#X text 541 21 If necessary \, messages of different data types can +#X text 565 21 If necessary \, messages of different data types can be matched by the [route] object if the data type is explictly defined in the creation arguments.; -#X text 540 71 In the example below \, instead of matching the 'value' +#X text 564 71 In the example below \, instead of matching the 'value' of a message \, the [route] object will match 'data type': i.e. lists will be sent through the first outlet \, floats will be sent through the second outlet \, symbols through the third outlet \, bangs through @@ -62,30 +52,17 @@ does not match one of the previously defined data types (i.e. the "pie" message below is a text message that hasn't been defined as a 'symbol' - hence \, PD cannot determine which data type it is and it will be output through the right-most outlet).; -#X text 577 208 a float; -#X text 605 228 definately a float!; -#X text 602 247 a list (of floats); -#X text 611 287 a bang; -#X text 653 306 a symbol; -#X text 620 328 none of the above!; -#X obj 541 448 route float list bang symbol; -#X obj 541 546 print floats; -#X obj 581 527 print lists; -#X obj 622 508 print bangs; -#X obj 663 488 print symbols; -#X msg 575 424 list pie; -#X msg 568 268 list pie earth; -#X text 660 267 a list of symbols; -#X text 595 358 SPECIAL CASES OF LISTS.; -#X text 629 423 A list with only one symbol is translated into a symbol. -; -#X text 621 400 A list with only one float is translated into a float -by PD.; -#X text 612 379 An empty list is tranlated into a bang by PD.; -#X text 19 508 RELATED OBJECTS; -#X obj 23 529 select; -#X obj 68 529 trigger; -#X obj 120 529 moses; +#X text 608 208 a float; +#X text 632 247 a list (of floats); +#X text 627 287 a bang; +#X text 672 307 a symbol; +#X text 630 328 none of the above!; +#X text 702 268 a list of symbols; +#X text 599 374 SPECIAL CASES OF LISTS.; +#X text 18 563 RELATED OBJECTS; +#X obj 22 584 select; +#X obj 67 584 trigger; +#X obj 119 584 moses; #X text 378 588 This document was updated for PD version 0.35 test 26 by Dave Sabine as part of a project called pddp proposed by Krzysztof Czaja to build comprehensive documentation for PD.; @@ -101,42 +78,86 @@ and properly installed the appropriate library. These objects may or may not exist in a single library.; #X text 17 135 The best places to find information about PD's libraries is:; -#X text 14 157 www.puredata.org and click on "Downloads" then "Software" +#X text 14 157 www.pure-data.org and click on "Downloads" then "Software" ; #X text 15 173 or; #X text 16 187 iem.kug.ac.at/pdb/; #X obj 193 34 demux; #X obj 245 34 gate; -#X restore 23 552 pd related_objects_from_other_libraries; +#X restore 22 607 pd related_objects_from_other_libraries; +#X floatatom 625 526 5 0 0 0 - - -; +#X symbolatom 673 525 10 0 0 0 - - -; +#X obj 578 549 bng 15 250 50 0 empty empty bang -6 23 1 12 -262144 +-1 -1; +#X msg 622 475 list not-a-list; +#X msg 578 208 89; +#X msg 581 228 float 7; +#X obj 578 499 route bang float symbol list; +#X obj 625 549 bng 15 250 50 0 empty empty float -4 23 1 12 -262144 +-1 -1; +#X obj 673 549 bng 15 250 50 0 empty empty symbol -12 23 1 12 -262144 +-1 -1; +#X obj 721 549 bng 15 250 50 0 empty empty list -2 23 1 12 -262144 +-1 -1; +#X obj 769 549 bng 15 250 50 0 empty empty undefined -18 23 1 12 -262144 +-1 -1; +#X msg 587 268 list moon earth; +#X text 636 228 definitely a float!; +#X text 620 391 An empty list is translated into a bang; +#X text 620 424 A list with only one float is translated to a float +; +#X text 620 460 A list with only one symbol is translated to a symbol +; +#X obj 141 439 bng 15 250 50 0 empty empty big -4 23 1 12 -262144 -1 +-1; +#X obj 189 439 bng 15 250 50 0 empty empty apple -7 23 1 12 -262144 +-1 -1; +#X obj 237 439 bng 15 250 50 0 empty empty everything_else -2 23 1 +12 -262144 -1 -1; +#X obj 286 326 bng 15 250 50 0 empty empty bang -6 23 1 12 -262144 +-1 -1; +#X obj 333 326 bng 15 250 50 0 empty empty float -4 23 1 12 -262144 +-1 -1; +#X obj 381 326 bng 15 250 50 0 empty empty symbol -12 23 1 12 -262144 +-1 -1; +#X obj 429 326 bng 15 250 50 0 empty empty everything_else -2 23 1 +12 -262144 -1 -1; +#X obj 129 469 print x1; +#X obj 189 469 print x2; +#X obj 249 469 print x3; #X connect 4 0 0 0; #X connect 4 1 1 0; #X connect 4 2 2 0; #X connect 4 3 3 0; #X connect 5 0 4 0; #X connect 6 0 4 0; -#X connect 7 0 21 0; -#X connect 7 1 22 0; -#X connect 7 2 23 0; +#X connect 7 0 60 0; +#X connect 7 0 67 0; +#X connect 7 1 61 0; +#X connect 7 1 68 0; +#X connect 7 2 62 0; +#X connect 7 2 69 0; #X connect 8 0 7 0; #X connect 9 0 7 0; #X connect 10 0 4 0; -#X connect 13 0 44 0; -#X connect 14 0 44 0; -#X connect 15 0 44 0; -#X connect 16 0 44 0; -#X connect 17 0 44 0; -#X connect 18 0 44 0; -#X connect 19 0 44 0; -#X connect 20 0 44 0; -#X connect 28 0 4 0; -#X connect 29 0 4 0; -#X connect 30 0 7 0; -#X connect 31 0 7 0; -#X connect 33 0 34 0; -#X connect 44 0 45 0; -#X connect 44 1 46 0; -#X connect 44 2 47 0; -#X connect 44 3 48 0; -#X connect 44 4 35 0; -#X connect 49 0 44 0; -#X connect 50 0 44 0; +#X connect 13 0 50 0; +#X connect 14 0 50 0; +#X connect 15 0 50 0; +#X connect 16 0 50 0; +#X connect 17 0 50 0; +#X connect 18 0 50 0; +#X connect 23 0 4 0; +#X connect 24 0 4 0; +#X connect 25 0 7 0; +#X connect 26 0 7 0; +#X connect 44 0 51 0; +#X connect 45 0 52 0; +#X connect 47 0 50 0; +#X connect 48 0 50 0; +#X connect 49 0 50 0; +#X connect 50 0 46 0; +#X connect 50 1 44 0; +#X connect 50 2 45 0; +#X connect 50 3 53 0; +#X connect 50 4 54 0; +#X connect 55 0 50 0; diff --git a/doc/pddp/pddp-style-guide.pd b/doc/pddp/pddp-style-guide.pd index 9063fe91..219b5c23 100644 --- a/doc/pddp/pddp-style-guide.pd +++ b/doc/pddp/pddp-style-guide.pd @@ -1,26 +1,28 @@ -#N canvas 323 116 608 551 10; -#X text 33 38 Here are various text conventions for discussing various +#N canvas 196 180 459 553 10; +#X text 15 38 Here are various text conventions for discussing various aspects of Pd in text:; -#X text 52 108 "anything" \, "bang" \, "float" \, "list" \, "pointer" +#X text 30 108 "anything" \, "bang" \, "float" \, "list" \, "pointer" \, "symbol"; -#X text 33 138 objects:; -#X text 50 157 [route] \, [set] \, [float] \, [symbol] \, [trigger] +#X text 15 138 objects:; +#X text 30 157 [route] \, [set] \, [float] \, [symbol] \, [trigger] \, etc.; -#X text 34 191 messages:; -#X text 49 214 [pd dsp 1 ( \, [set 0 ( \,; -#X text 41 276 design principles; -#X text 75 372 - Avoid arbitrary syntax; -#X text 75 386 - Use standard language; -#X text 76 319 - Teach by example \, not by formalism; -#X text 76 303 - Make states visible and visibly distinguished; -#X text 72 426 - Support clear conceptual models for documentation +#X text 15 191 messages:; +#X text 30 214 [send 1( \, [set 0( \,; +#X text 15 270 design principles; +#X text 50 300 - Make states visible and visibly distinguished; +#X text 50 315 - Teach by example \, not by formalism; +#X text 50 330 - Communicate visually; +#X text 50 345 - Offer informative feedback; +#X text 50 360 - Strive for consistency; +#X text 50 375 - Avoid arbitrary syntax; +#X text 50 390 - Use standard language; +#X text 50 405 - Use the application's terminology; +#X text 50 420 - Support clear conceptual models for documentation ; -#X text 71 444 - Respect the rules of human conversation; -#X text 71 457 - Respond with an appropriate amount of information +#X text 50 435 - Respect the rules of human conversation; +#X text 50 450 - Respond with an appropriate amount of information ; -#X text 77 406 - Use the application's terminology; -#X text 73 335 - Communicate visually; -#X text 74 355 - Strive for consistency; -#X text 255 346 - Offer informative feedback; -#X text 36 88 reserved words:; -#X text 6 525 Hans-Christoph Steiner ; +#X text 17 88 reserved words:; +#X obj 2 2 cnv 15 450 20 empty empty pddp-style-guide 2 11 1 18 -233017 +-66577 0; +#X obj 418 3 pddp; -- cgit v1.2.1