Diff: Help/PreferenceAppPlugin

Differences between current version and predecessor to the previous major change of Help/PreferenceAppPlugin.

Other diffs: Previous Revision, Previous Author

Newer page: version 5 Last edited on 17 January 2022 3:00 by harold
Older page: version 4 Last edited on 9 September 2007 0:16 by harold Revert
@@ -1,27 +1,67 @@
-_short description_  
+The **~PreferenceApp** [[Help:WikiPlugin|plugin]] is used to analyze a category of items  
+that a group of people have rated. A user is grouped to be analyzed in the group by  
+# having rated at least one item in the database and  
+# matching the optional criteria for declaring a budget on their homepage.  
  
-! Usage  
-<verbatim>  
- <?plugin PreferenceApp ?>  
-</verbatim>  
+An example of a budget declaration would be "~TotalSoda: 50" on my homepage.  
  
-! Arguments  
+~PreferenceApp will output a matrix style table shows "how much" fractionally a group of people prefer an item over other items. For example, if my soda  
+budget is 100 then ~PreferenceApp might assign 20 units of my budget to Moutain Dew.  
  
-page _(default: current pagename)_:  
- The page to execute upon.  
+== Usage ==  
+{{{  
+<<PreferenceApp arguments>>  
+}}}  
  
-! Example  
+== Arguments ==  
  
-<verbatim>  
-<?plugin PreferenceApp ?>  
-</verbatim>  
+{| class="bordered"  
+|-  
+! Argument  
+! Description  
+! Default value  
+|-  
+| **category**  
+|  
+| null  
+|-  
+| **lockedBudget**  
+|  
+| null  
+|-  
+| **pageTextLabel**  
+|  
+| null  
+|-  
+| **group**  
+|  
+| null  
+|-  
+| **roundCalc**  
+|  
+| true  
+|-  
+| **neutralRating**  
+|  
+| 3  
+|-  
+| **declareBudget**  
+|  
+| true  
+|}  
  
-<?plugin PreferenceApp ?>  
+== Example ==  
  
-! Author  
-PhpWiki:ReiniUrban  
+{{{  
+<<PreferenceApp category="Soda" pageTextLabel="TotalSoda" roundCalc="true" >>  
+}}}  
  
-! See Also  
+== Author ==  
+* mcassano circa April 2004  
  
+== See Also ==  
+  
+<noinclude>  
 ---- 
-PhpWikiDocumentation Help:WikiPlugin  
+[[ PhpWikiDocumentation]] [[CategoryWikiPlugin]]  
+</noinclude>  

current version

The PreferenceApp plugin is used to analyze a category of items that a group of people have rated. A user is grouped to be analyzed in the group by

  1. having rated at least one item in the database and
  2. matching the optional criteria for declaring a budget on their homepage.

An example of a budget declaration would be "TotalSoda: 50" on my homepage.

PreferenceApp will output a matrix style table shows "how much" fractionally a group of people prefer an item over other items. For example, if my soda budget is 100 then PreferenceApp might assign 20 units of my budget to Moutain Dew.

Usage

<<PreferenceApp arguments>>

Arguments

Argument

Description

Default value

category

null

lockedBudget

null

pageTextLabel

null

group

null

roundCalc

true

neutralRating

3

declareBudget

true

Example

<<PreferenceApp category="Soda" pageTextLabel="TotalSoda" roundCalc="true" >>

Author

  • mcassano circa April 2004

See Also