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

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

Revision: 6538
          http://phpwiki.svn.sourceforge.net/phpwiki/?rev=6538&view=rev
Author:   vargenau
Date:     2009-02-23 15:04:46 +0000 (Mon, 23 Feb 2009)

Log Message:
-----------
Add description

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

Modified: trunk/pgsrc/Help%FFuzzyPagesPlugin
===================================================================
--- trunk/pgsrc/Help%2FFuzzyPagesPlugin	2009-02-23 14:40:23 UTC (rev 6537)
+++ trunk/pgsrc/Help%2FFuzzyPagesPlugin	2009-02-23 15:04:46 UTC (rev 6538)
@@ -1,4 +1,4 @@
-Date: Sun, 22 Feb 2009 19:16:30 +0000
+Date: Mon, 23 Feb 2009 15:16:30 +0000
 Mime-Version: 1.0 (Produced by PhpWiki 1.3.14-20080124)
 X-Rcs-Id: $Id$
 Content-Type: application/x-phpwiki;
@@ -8,28 +8,44 @@
   charset=iso-8859-1
 Content-Transfer-Encoding: binary
 
-_short description_
+The **~FuzzyPages** [[Help:WikiPlugin|plugin]] will search for similar page titles.
 
+Pages are considered similar by averaging the similarity scores of
+the spelling comparison and the metaphone comparison for each page
+title in the database (PHP's metaphone() is an improved soundex
+function).
+
+* http://www.php.net/manual/en/function.similar-text.php
+* http://www.php.net/manual/en/function.metaphone.php
+
 == Usage
 {{{
-  <<FuzzyPages>>
+<<FuzzyPages s=pagename>>
 }}}
 
 == Arguments
 
-page _(default: current pagename)_:
-  The page to execute upon.
+{| class="bordered"
+|-
+! Argument
+! Description
+! Default value
+|-
+| s
+| Pagename to look for
+| empty
+|}
 
 == Example
 
 {{{
-<<FuzzyPages>>
+<<FuzzyPages s=HomePage>>
 }}}
 
-<<FuzzyPages>>
+<<FuzzyPages s=HomePage>>
 
 == Author
-[Reini Urban|PhpWiki:ReiniUrban]
+* [Reini Urban|PhpWiki:ReiniUrban]
 
 == See Also
 


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