[phpwiki-checkins] SF.net SVN: phpwiki:[6619] trunk/pgsrc/Help%2FSemanticSearchPlugin

[<var...@us...>]

Revision: 6619
          http://phpwiki.svn.sourceforge.net/phpwiki/?rev=6619&view=rev
Author:   vargenau
Date:     2009-03-03 10:20:32 +0000 (Tue, 03 Mar 2009)

Log Message:
-----------
Add description and arguments

Modified Paths:
--------------
    trunk/pgsrc/Help%2FSemanticSearchPlugin

Modified: trunk/pgsrc/Help%FSemanticSearchPlugin
===================================================================
--- trunk/pgsrc/Help%2FSemanticSearchPlugin	2009-03-03 09:23:14 UTC (rev 6618)
+++ trunk/pgsrc/Help%2FSemanticSearchPlugin	2009-03-03 10:20:32 UTC (rev 6619)
@@ -1,4 +1,4 @@
-Date: Sun, 22 Feb 2009 19:16:30 +0000
+Date: Tue,  3 Mar 2009 11:19:35 +0000
 Mime-Version: 1.0 (Produced by PhpWiki 1.3.14-20080124)
 X-Rcs-Id: $Id$
 Content-Type: application/x-phpwiki;
@@ -8,17 +8,83 @@
   charset=iso-8859-1
 Content-Transfer-Encoding: binary
 
-_short description_
+Search for relations/attributes and its values.
 
+page - relation::object. e.g list all cities: is_a::city => relation=is_a&s=city
+
+We search for both a relation and if the search is valid for attributes also, and OR combine the result.
+
+An attribute has just a value, which is a number, and which is for sure no pagename, and its value goes through some units unification. (not yet)
+
+We can also do numerical comparison and unit lifting with attributes:
+*  population > 1000000
+*  population > 1 million
+
+Limitation:
+* The backends can already do simple AND/OR combination of multiple relations and attributes to search for. Just the UI not. TODO: implement the AND/OR buttons.  population < 1 million AND area > 50 km2
+* Due to attribute internals a relation search with matching attribute names will also find those attribute names, but not the values. You must explicitly search for attributes then.
+
+The Advanced query can do a freeform query expression with multiple comparison and nesting.
+* "is_a::city and population > 1.000.000 and population < 10.000.000"
+* "(is_a::city or is_a::country) and population < 10.000.000"
+
 == Usage
 {{{
-  <<SemanticSearch>>
+<<SemanticSearch arguments>>
 }}}
 
 == Arguments
 
-page _(default: current pagename)_:
-  The page to execute upon.
+{| class="bordered"
+|-
+! Argument
+! Description
+! Default value
+|-
+| s
+| linkvalue query string
+| *
+|-
+| page
+| which pages (glob allowed)
+| * (all)
+|-
+| relation
+| linkname. which relations.
+| all
+|-
+| attribute
+| linkname. which attributes.
+| all
+|-
+| attr_op
+| a funny written way for equality for pure aesthetic pleasure "All attributes which have this value set"
+| :=
+|-
+| units
+|
+|
+|-
+| case_exact
+|
+| true
+|-
+| regex
+| no word splitting, if no regex op is present, defaults to exact match
+| auto
+|-
+| noform
+| don't show form with results.
+| false
+|-
+| noheader
+| no caption
+| false
+|-
+| info
+| valid: pagename, relation, linkto, attribute, value and all other pagelist columns
+| false
+|}
 
 == Example
 


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.