]> CyberLeo.Net >> Repos - SourceForge/phpwiki.git/blob - pgsrc/Help%2FWikiFormRichPlugin
Harmonize documentation
[SourceForge/phpwiki.git] / pgsrc / Help%2FWikiFormRichPlugin
1 Date: Wed, 28 May 2008 19:06:41 +0200
2 Mime-Version: 1.0 (Produced by PhpWiki 1.3.14-20080124)
3 Content-Type: application/x-phpwiki;
4   pagename=Help%2FWikiFormRichPlugin;
5   flags="";
6   markup=2;
7   charset=iso-8859-1
8 Content-Transfer-Encoding: binary
9
10 Create generic and enhanced forms, with various options:
11
12  * - editbox[]          name=.. value=.. text=.. autocomplete=0|1
13  * - checkbox[]         name=.. value=0|1 checked text=..
14  * - radio[]            name=.. value=.. text=..
15  * - pulldown[]         name=.. value=.. selected=.. text=.. autocomplete=0|1
16  * - combobox[]         name=.. value=.. text=.. method=.. args=..
17  * - hidden[]           name=.. value=..
18  * - submit[]
19  * - action, submit buttontext, optional cancel button (bool)
20  * - method=get or post, Default: post.
21
22 Valid arguments for pulldown and editbox: autocomplete=1, Default: 0<br>
23 If autocomplete=1, additional arguments method and args may be used.
24 autocomplete together with dyn-methods (see below) should be used to handle larger lists (> 500).<br>
25 If no method is given, value will be used to fill in the valid values.<br>
26 <verbatim>
27   method="xmlrpc:name [optional args]"
28   method="dynxmlrpc:url [optional args]"
29   method="url:http://server/wiki/method"
30   method="dynurl:http://server/wiki/method"
31   method="array:jsvariable"
32   method="plugin:pluginname [optional args]"
33 </verbatim>
34
35 The plugin must return a pagelist.<br>
36 args are optional arguments, space seperated, for the method.<br>
37 A combobox is a pulldown with autocomplete=1.<br>
38
39 !!! Author
40  [Reini Urban|PhpWiki:ReiniUrban]
41
42 - Values which are constants are evaluated.
43 - The cancel button must be supported by the action.
44   (just some wikiadmin actions so far)
45 - improve layout by: nobr=1
46 - some allow values as list from <!plugin-list pluginname args !>
47
48 !!! Samples
49
50    <?plugin WikiFormRich action=dumpserial method=get
51             checkbox[] name=include value="all"
52             editbox[] name=directory value=DEFAULT_DUMP_DIR
53             editbox[] name=pages value=*
54             editbox[] name=exclude value="" ?>
55 ----
56    <?plugin WikiFormRich action=dumphtml method=get
57             editbox[] name=directory value=HTML_DUMP_DIR
58             editbox[] name=pages value="*"
59             editbox[] name=exclude value="" ?>
60 ----
61    <?plugin WikiFormRich action=loadfile method=get
62             editbox[]  name=source value=DEFAULT_WIKI_PGSRC
63             checkbox[] name=overwrite value=1
64             editbox[]  name=exclude value="" ?>
65 ----
66   <?plugin WikiFormRich action=TitleSearch method=get class=wikiadmin nobr=1
67            editbox[] name=s text=""
68            submit[]
69            checkbox[] name=case_exact
70            checkbox[] name=regex ?>
71 ----
72   <?plugin WikiFormRich action=FullTextSearch method=get class=wikiadmin nobr=1
73            editbox[] name=s text=""
74            submit[]
75            checkbox[] name=case_exact
76            checkbox[] name=regex ?>
77 ----
78   <?plugin WikiFormRich action=FuzzyPages method=get class=wikiadmin nobr=1
79            editbox[] name=s text=""
80            submit[]
81            checkbox[] name=case_exact ?>
82 ----
83   <?plugin WikiFormRich action=AppendText buttontext="AddPlugin"
84            radio[] name=s value=<!plugin-list BackLinks page=WikiPlugin limit=5 !>
85            ?>
86 ----
87   <?plugin WikiFormRich action=AppendText buttontext="AddPlugin"
88            combobox[] name=s text="" style="width:60px" value=<!plugin-list BackLinks page=WikiPlugin !>
89            submit[]
90            ?>
91 ----
92   <?plugin WikiFormRich action=AppendText buttontext="AddCategory"
93            pulldown[] name=s text="Categories: " value=<!plugin-list TitleSearch s=Category !>
94            ?>
95 ----
96   <?plugin WikiFormRich action=SemanticSearch buttontext="AddRelation"
97            combobox[] name=relation method="xmlrpc:listRelations"
98            submit[]
99            checkbox[] name=case_exact text="Case-exact?"
100            ?>
101 ----
102   <?plugin WikiFormRich action=AppendText buttontext="InsertTemplate"
103            combobox[] name=s text="Template: " method="plugin:titleSearch s=Template*"
104            submit[]
105            ?>
106 ----
107   <?plugin WikiFormRich action=GoTo
108            editbox[] name=page text="GoTo: " method="dynxmlrpc:titleSearch s=H" style="width:100px" autocomplete=1
109            submit[]
110            ?>
111
112 -------------
113
114 [PhpWikiDocumentation] [WikiPlugin|Help:WikiPlugin]