Diff: Help/MagicPhpWikiURLs

Note: You are viewing an old revision of this page. View the current version.

Differences between version 5 and previous revision of Help/MagicPhpWikiURLs.

Other diffs: Previous Major Revision, Previous Author

Newer page: version 5 Last edited on 9 September 2007 0:16 by harold Revert
Older page: version 4 Last edited on 22 May 2014 3:01 by harold Revert
@@ -1,54 +1,68 @@
-== About phpwiki: URLs ==  
+!!! About phpwiki: URLs 
  
 A special type of URL is available for making links to perform 
-administrative and other special functions in ~ PhpWiki. Here is a 
+administrative and other special functions in PhpWiki. Here is a 
 brief description of how they work. 
  
 The basic syntax of a phpwiki: URL is 
  
 <pre> 
-** phpwiki:**// pagename//** ?**// query-args//  
+__ phpwiki:__'' pagename''__ ?__'' query-args''  
 </pre> 
  
-If // pagename// is omitted it defaults to the current page. 
+If _ pagename_ is omitted it defaults to the current page. 
  
-// Query-args// should be a set of parameters in standard HTTP GET 
+_ Query-args_ should be a set of parameters in standard HTTP GET 
 format. 
  
-The "action=// x// " parameter should almost always be given. It can be one of  
-** browse** , ** diff** , ** edit** , ** viewsource** ,  
-** zip** , ** dumpserial** , ** loadserial** ,  
-** remove** , ** lock** , ** unlock** ,  
-** login** , ** logout** , ** setprefs** or ** save** .  
-The default action is ** browse** . 
+The "action='' x'' " parameter should almost always be given. It can be one of  
+__ browse__ , __ diff__ , __ edit__ , __ viewsource__ ,  
+__ zip__ , __ dumpserial__ , __ loadserial__ ,  
+__ remove__ , __ lock__ , __ unlock__ ,  
+__ login__ , __ logout__ , __ setprefs__ or __ save__ .  
+The default action is __ browse__ . 
  
 Some of the actions accept other parameters. 
  
-| ** FullTextSearch**, **TitleSearch** | Accepts **s**=search term, and **size**=input size.  
-| **edit** | Accepts **version**.  
-| **remove** | Accepts **verify**.  
-| **save** | Accepts **editversion**, **minor _edit** , and **content**.  
-| **setprefs** | Accepts **edit _area _width**, **edit _area _height**.  
+__ FullTextSearch__ , __TitleSearch __:  
  
-=== Writing Magic Links in Wiki Pages ===  
+ Accepts __s__ =search term, and __size__ =input size.  
+  
+__edit__:  
+  
+ Accepts __version__.  
+  
+__remove__:  
+  
+ Accepts __verify__.  
+  
+__save__:  
+  
+ Accepts __editversion__, __minor_edit__, and __content__.  
+  
+__setprefs__:  
+  
+ Accepts __edit_area_width__, __edit_area_height__.  
+  
+!! Writing Magic Links in Wiki Pages 
  
 A magic link looks like: 
  
 <pre> 
-** ~[** // text// ** |** // phpwiki-url// ** ]**  
+__ ~[__ '' text'' __ |__ '' phpwiki-url'' __ ]__  
 </pre> 
  
-The "// text// * *|* *" is optional but usually recommended. If given it 
+The "'' text'' *|*" is optional but usually recommended. If given it 
 will provide the label for the link. 
  
-The // phpwiki-url// is a * *phpwiki:* * URL as described above. 
+The _ phpwiki-url_ is a *phpwiki:* URL as described above. 
  
-==== Some examples ====  
+! Some examples 
  
-{{{  
+<verbatim>  
 [ Edit the SandBox | phpwiki:SandBox?action=edit ] 
-}}}  
+</verbatim>  
 will generate a link which will take you directly to editing the 
 SandBox, like so: [Edit the SandBox | phpwiki:SandBox?action=edit]. 
  
 Other possibilites: 
@@ -56,50 +70,54 @@
 * [ Lock the HomePage | phpwiki:HomePage?action=lock ], 
 * [ Get a Full Zip Dump | phpwiki:?action=zip&include=all ], 
 * Search for [ Page titles containing 'wiki' | phpwiki:?action=TitleSearch&s=wiki ] 
  
-=== Writing Magic Forms in Wiki Pages ===  
+!! Writing Magic Forms in Wiki Pages 
  
-**// Note://** // The old syntax for Magic forms is no longer supported.  
-They are superseded by// ## <?plugin-form>## . 
+''__ Note__ : The old syntax for Magic forms is no longer supported.  
+They are superseded by = <?plugin-form>= .''  
  
-If the plugin is called using * *<?plugin-form* * instead of * *<?plugin* * 
+If the plugin is called using *<?plugin-form* instead of *<?plugin* 
 and the plugin supports searching, then it will be rendered as a form. 
  
-| // size// | If given, specifies the size of the input area.  
-| //s// | Specifies the default value for the input.  
+'' size'':  
  
-==== Examples ====  
+ If given, specifies the size of the input area.  
  
-A search plugin invoked with * *<?plugin* * instead of * *<?plugin-form* * 
+''s'':  
+  
+ Specifies the default value for the input.  
+  
+!Examples:  
+  
+ A search plugin invoked with *<?plugin* instead of *<?plugin-form* 
 simply inserts the search results of the plugin: 
  
-{{{  
-<< TitleSearch s=wiki noheader=true limit=10> >  
-}}}  
+<verbatim>  
+<?plugin TitleSearch s=wiki noheader=true ? >  
+</verbatim>  
  
 Search results for Page titles containing 'wiki': 
  
-<< TitleSearch s=wiki noheader=true limit=10> > 
+<?plugin TitleSearch s=wiki noheader=true ? > 
  
-{{{  
+<verbatim>  
 <?plugin-form FullTextSearch ?> 
-}}}  
+</verbatim>  
  
 gives 
  
 <?plugin-form FullTextSearch ?> 
  
 While 
  
-{{{  
+<verbatim>  
 <?plugin-form TitleSearch formsize=12 ?> 
-}}}  
+</verbatim>  
  
 yields 
  
 <?plugin-form TitleSearch formsize=12 ?> 
  
-<noinclude>  
 ---- 
-[[PhpWikiDocumentation]]  
-</noinclude>  
+  
+PhpWikiDocumentation  

version 5

About phpwiki: URLs

A special type of URL is available for making links to perform administrative and other special functions in PhpWiki. Here is a brief description of how they work.

The basic syntax of a phpwiki: URL is

__phpwiki:__''pagename''__?__''query-args''

If pagename is omitted it defaults to the current page.

Query-args should be a set of parameters in standard HTTP GET format.

The "action=x" parameter should almost always be given. It can be one of browse, diff, edit, viewsource, zip, dumpserial, loadserial, remove, lock, unlock, login, logout, setprefs or save. The default action is browse.

Some of the actions accept other parameters.

FullTextSearch, TitleSearch
Accepts s=search term, and size=input size.
edit
Accepts version.
remove
Accepts verify.
save
Accepts editversion, minor_edit, and content.
setprefs
Accepts edit_area_width, edit_area_height.

Writing Magic Links in Wiki Pages

A magic link looks like:

__~[__ ''text'' __|__ ''phpwiki-url'' __]__

The "text |" is optional but usually recommended. If given it will provide the label for the link.

The phpwiki-url is a phpwiki: URL as described above.

Some examples

[ Edit the SandBox | phpwiki:SandBox?action=edit ]

will generate a link which will take you directly to editing the SandBox, like so: Lock page to enable link.

Other possibilites:

Writing Magic Forms in Wiki Pages

Note: The old syntax for Magic forms is no longer supported. They are superseded by =<?plugin-form>=.

If the plugin is called using <?plugin-form instead of <?plugin and the plugin supports searching, then it will be rendered as a form.

size
If given, specifies the size of the input area.
s
Specifies the default value for the input.

Examples:

A search plugin invoked with <?plugin instead of <?plugin-form simply inserts the search results of the plugin:

<?plugin TitleSearch s=wiki noheader=true ?>

Search results for Page titles containing 'wiki':

No matches

<?plugin-form FullTextSearch ?>

gives

While

<?plugin-form TitleSearch formsize=12 ?>

yields

PhpWikiDocumentation