fleshed out description of search dialog and META tags

svn path=/trunk/; revision=15216

2 files changed, 75 insertions, 62 deletions

diff --git a/doc/pddp/all_about_finding_objects.pd b/doc/pddp/all_about_finding_objects.pd
index 5e5c8410..34ba1d5c 100644
--- a/doc/pddp/all_about_finding_objects.pd
+++ b/doc/pddp/all_about_finding_objects.pd
@@ -1,23 +1,19 @@
-#N canvas 278 26 448 150 10;
-#X obj 1 1 cnv 15 445 20 empty \$0-pddp.cnv.header finding_pd_objects
+#N canvas 0 0 448 447 10;
+#X obj 1 1 cnv 15 445 20 empty \$0-pddp.cnv.header Pure_Data_search
 20 10 1 18 -261106 -33289 0;
 #X obj 407 2 pddp/pddplink http://puredata.info/dev/pddp -text pddp
 ;
-#X obj 1 123 cnv 15 445 20 empty \$0-pddp.cnv.footer empty 20 12 0
+#X obj 1 425 cnv 15 445 20 empty \$0-pddp.cnv.footer empty 20 12 0
 14 -233017 -33289 0;
-#N canvas 278 205 494 284 META 0;
+#N canvas 274 223 494 284 META 0;
 #X text 12 65 LIBRARY PDDP;
 #X text 12 5 GENRE all_about_pd;
 #X text 12 45 DESCRIPTION tips for searching for objects;
 #X text 12 25 KEYWORDS help;
-#X msg 19 114 tot destroy .^.m;
-#X obj 19 142 tot .parent;
 #X text 12 85 HELP_PATCH_AUTHORS Jonathan Wilkes \, Pd-ext 0.42.;
-#X connect 4 0 5 0;
-#X connect 5 3 4 0;
-#X restore 392 125 pd META;
-#X obj 6 125 pddp/pddplink all_about.pd -text All About Pd;
-#N canvas 13 162 428 183 References 0;
+#X restore 392 427 pd META;
+#X obj 6 427 pddp/pddplink all_about.pd -text All About Pd;
+#N canvas 9 180 428 183 References 0;
 #X obj 1 1 cnv 15 425 20 empty \$0-pddp.cnv.subheading empty 3 12 0
 14 -261106 -33289 0;
 #X text 7 2 Searching for Objects;
@@ -25,10 +21,31 @@
 #X text 32 59 * mailing lists;
 #X text 32 79 * google;
 #X text 32 99 * your own harddrive;
-#X restore 103 125 pd References;
-#X text 19 26 Enter search terms to match the descriptions in the help
-files. (This will match the description in the help patch);
-#X text 19 56 You can also specify specific PDDP keywords preceded
-by an '@' sign. For example \, '@AUTHOR Puckette'. '@AUTHOR Puckette
-@INLET_0 symbol' matches all objects by Miller Puckette that accept
-a symbol at the left inlet.;
+#X restore 103 427 pd References;
+#X text 19 121 Advanced Search;
+#X text 19 26 Simple Search;
+#X text 19 26 _____________;
+#X text 19 121 _______________;
+#X text 19 46 Enter your search terms and click "Search" \, or click
+a keyword. You can use the drop-down menu below the search bar to filter
+the results by category.;
+#X text 19 176 You can use regular expressions \, too:;
+#X text 19 91 Searches are not case sensitive.;
+#X text 19 196 "obj [0-9]+ [0-9]+ osc~ [0-9]+" will match all help
+patches that have an [osc~] object with a creation argument.;
+#X text 19 141 Use quotes to search for a specific phrase \, such as:
+"frequency modulation";
+#X obj 24 261 pddp/pddplink http://www.tcl.tk/man/tcl8.5/TclCmd/re_syntax.htm
+;
+#X text 19 226 Pd search uses the regex syntax from the Tcl language
+\, which is documented here:;
+#X text 19 286 Finally \, you can make use of PDDP keywords to refine
+your search. For example:;
+#X text 19 336 OUTLET_0.*symbol ..... sends a symbol from the left
+outlet;
+#X text 19 316 AUTHOR.*Puckette ..... all objects authored by Miller
+;
+#X text 19 356 LICENSE.*GPL ......... objects are licensed under the
+GPL;
+#X text 19 376 For more details on PDDP tags \, see:;
+#X obj 24 396 pddp/pddplink all_about_pd_META.pd;
diff --git a/doc/pddp/all_about_pd_META.pd b/doc/pddp/all_about_pd_META.pd
index f84579e7..e2599f64 100644
--- a/doc/pddp/all_about_pd_META.pd
+++ b/doc/pddp/all_about_pd_META.pd
@@ -1,11 +1,11 @@
-#N canvas 0 0 448 238 10;
+#N canvas 0 0 448 227 10;
 #X obj 1 1 cnv 15 445 20 empty \$0-pddp.cnv.header pd_META 20 10 1
 18 -261106 -33289 0;
 #X obj 407 2 pddp/pddplink http://puredata.info/dev/pddp -text pddp
 ;
-#X obj 1 216 cnv 15 445 20 empty \$0-pddp.cnv.footer empty 20 12 0
+#X obj 1 204 cnv 15 445 20 empty \$0-pddp.cnv.footer empty 20 12 0
 14 -233017 -33289 0;
-#N canvas 44 246 494 344 META 0;
+#N canvas 40 264 494 344 META 0;
 #X text 12 85 HELP_PATCH_AUTHORS Dave Sabine \, May 5 \, 2003 . Jonathan
 Wilkes revised the patch to conform to the PDDP template for Pd version
 0.42.;
@@ -13,69 +13,65 @@ Wilkes revised the patch to conform to the PDDP template for Pd version
 #X text 12 5 GENRE all_about_pd;
 #X text 12 25 KEYWORDS needs_work;
 #X text 12 45 DESCRIPTION description of the pd META tags;
-#X restore 392 218 pd META;
+#X restore 392 206 pd META;
 #N canvas 10 196 428 105 Related_objects 0;
 #X text 31 37 Hm...what to put here?;
 #X obj 1 1 cnv 15 425 20 empty \$0-pddp.cnv.subheading empty 3 12 0
 14 -261106 -33289 0;
 #X text 7 2 Atoms- Related Objects;
-#X restore 103 218 pd Related_objects;
-#X obj 6 218 pddp/pddplink all_about.pd -text All About Pd;
-#X text 70 54 tags \, keywords \, defaults if some tags are left out
-;
-#N canvas 256 0 428 658 TAGS 0;
+#X restore 103 206 pd Related_objects;
+#X obj 6 206 pddp/pddplink all_about.pd -text All About Pd;
+#N canvas 256 88 428 493 TAGS 0;
 #X obj 1 1 cnv 15 425 20 empty \$0-pddp.cnv.subheading empty 3 12 0
 14 -261106 -33289 0;
 #X text 7 2 pd META - TAGS;
 #X text 31 37 Each pd META entry is a comment that begins with a tag
 in uppercase \, followed by values for that tag.;
-#X text 31 77 GENRE - describes what type of help patch this is. Possible
-values are help (for an object's help patch) \, tutorial \, or all_about_pd
-(in-depth help for a pd concept). If GENRE is omitted \, the value
-"help" is assumed.;
-#X text 31 137 NAME - name of the object. If more than one value is
-present \, it is assumed that the help patch covers multiple objects.
-This tag may also be used for tutorials and all_about_pd patches to
-show the relevant object(s) being discussed.;
-#X text 31 207 ALIAS - for an object's help patch \, any additional
-creator names for the object. For [trigger] \, this would be: ALIAS
-t;
-#X text 31 247 LICENSE - the license used for the object (not relevant
+#X text 31 232 LICENSE - the license used for the object (not relevant
 for tutorials or all_about_pd patches). Some common values are:;
-#X text 51 277 SIBSD: three-clause BSD license;
-#X text 51 297 GPL v2: GNU/GPL license version 2;
-#X text 51 317 GPL v3: GNU/GPL license version 3;
-#X text 31 337 DESCRIPTION - short (one-line) description of an object's
+#X text 51 262 SIBSD: three-clause BSD license;
+#X text 51 282 GPL v2: GNU/GPL license version 2;
+#X text 51 302 GPL v3: GNU/GPL license version 3;
+#X text 31 327 DESCRIPTION - short (one-line) description of an object's
 behavior. May also be used for tutorials or all_about_pd patches to
 describe the concept being discussed.;
-#X obj 1 551 cnv 15 425 20 empty \$0-pddp.cnv.subheading empty 3 12
+#X obj 1 521 cnv 15 425 20 empty \$0-pddp.cnv.subheading empty 3 12
 0 14 -261106 -33289 0;
-#X text 7 552 TAGS for an object's inlets/outlets;
-#X text 31 587 Tags to show which messages are accepted by the inlets/outlets
+#X text 7 522 TAGS for an object's inlets/outlets;
+#X text 31 557 Tags to show which messages are accepted by the inlets/outlets
 of an object. The tag starts with the word INLET or OUTLET \, followed
 by an underscore and a digit showing the xlet number:;
-#X text 31 670 There are two special designations:;
-#X text 31 647 INLET_0 - left-most inlet;
-#X text 31 690 INLET_N or OUTLET_N - variable number of xlets \, the
+#X text 31 640 There are two special designations:;
+#X text 31 617 INLET_0 - left-most inlet;
+#X text 31 660 INLET_N or OUTLET_N - variable number of xlets \, the
 exact number of which is determined by the creation arguments.;
-#X text 31 730 For objects with variable xlets \, the following may
+#X text 31 700 For objects with variable xlets \, the following may
 apply:;
-#X text 31 753 INLET_R or OUTLET_R - a right-most xlet which always
+#X text 31 723 INLET_R or OUTLET_R - a right-most xlet which always
 has the same function regardless of the total number of xlets.;
-#X text 31 387 LIBRARY - name of the library to which the object belongs.
-;
 #X text 31 441 WEBSITE - website of the author or group that made the
 object/tutorial.;
-#X text 31 471 RELEASE_DATE - date when the object was made available
-to Pd users. Format = YEAR-MONTH-DAY;
-#X text 31 511 HELP_PATCH_AUTHORS - persons or groups who made/edited
-this help patch.;
 #X text 31 407 AUTHOR - multiple authors can be specified \, as well
 as additional text explaining each author's role.;
-#X text 31 793 The values may be float \, list \, bang \, symbol \,
+#X text 31 763 The values may be float \, list \, bang \, symbol \,
 pointer \, anything \, as well as specific custom selectors such as
 set \, clear \, etc.;
-#X restore 144 145 pd TAGS;
-#X text 79 87 This help file is unfinished.;
-#X text 56 124 move all the KEYWORDS values from all_about_help_patches
-to here;
+#X text 31 77 GENRE - describes what type of help patch this is. Possible
+values are: tutorial \, and all_about_pd (in-depth help for a pd concept).
+If GENRE is omitted \, the patch is assumed to be an object help patch.
+;
+#X text 31 137 NAME - name of the objects covered by a multi-object
+help patch. This tag may also be used for tutorials and all_about_pd
+patches to show the relevant object(s) being discussed.;
+#X text 31 197 ALIAS - for an object help patch \, any additional creator
+names for the object. For [trigger] \, this would be: ALIAS t;
+#X text 31 377 LIBRARY - name of the library to which the object belongs.
+If this is a libdir object \, this can be omitted.;
+#X text 31 476 HELP_PATCH_AUTHORS - the person or group who made/edited
+this help patch.;
+#X restore 22 147 pd TAGS;
+#X text 19 37 META keywords/tags are used to organize and categorize
+Pure Data documents so that they're easier to search. They follow the
+following syntax:;
+#X text 19 87 TAG keyword1 keyword2 keyword3;
+#X text 19 117 Currently used tags are detailed below:;