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