Diff: Help/MagicPhpWikiURLs

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

Other diffs: Previous Revision, Previous Author

Newer page: version 6 Last edited on 17 January 2022 3:00 by harold
Older page: version 5 Last edited on 9 September 2007 0:16 by harold Revert
@@ -1,123 +1,100 @@
-!!! 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 
+The basic syntax of a // phpwiki:// URL is 
  
-<pre>  
-__ phpwiki:__'' pagename''__ ?__'' query-args''  
-< /pre>  
+** phpwiki:**// pagename//** ?**// query-args//  
  
-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  
- format. 
+// 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_ _:  
+| ** 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** and **edit _area _height**.  
  
- 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 
+=== Writing Magic Links in Wiki Pages ===  
  
 A magic link looks like: 
  
-<pre>  
-__ ~[__ '' text'' __ |__ '' phpwiki-url'' __]__  
-< /pre>  
+** ~[~[** // text// ** |** // phpwiki-url// **]]**  
  
-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>  
+{{{  
+[[ phpwiki:SandBox?action=edit|Edit the SandBox] ]  
+}}}  
 will generate a link which will take you directly to editing the 
-SandBox, like so: [Edit the SandBox | phpwiki:SandBox?action=edit]. 
+SandBox, like so: [[ phpwiki:SandBox?action=edit|Edit the SandBox] ]. 
  
-Other possibilites :  
-* [ Diff the SandBox | phpwiki:SandBox?action=diff ],  
-* [ 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 ] 
+Other possibilities :  
+* [[ phpwiki:SandBox?action=diff|Diff the SandBox] ],  
+* [[ phpwiki:HomePage?action=lock|Lock the HomePage] ],  
+* [[ phpwiki:?action=zip&include=all|Get a Full Zip Dump] ],  
+* Search for [[ phpwiki:?action=TitleSearch&s=wiki|Page titles containing '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'':  
+| // size// | If given, specifies the size of the input area.  
+| //s// | Specifies the default value for the input.  
  
- If given, specifies the size of the input area.  
+==== Examples ====  
  
-''s'':  
-  
- Specifies the default value for the input.  
-  
-!Examples:  
-  
- A search plugin invoked with *<?plugin* instead of *<?plugin-form* 
+A search plugin invoked with * *<?plugin* * instead of * *<?plugin-form* * 
 simply inserts the search results of the plugin: 
  
-<verbatim>  
-<?plugin TitleSearch s=wiki noheader=true ? >  
-</verbatim>  
+{{{  
+<< TitleSearch s=wiki noheader=true limit=10> >  
+}}}  
  
 Search results for Page titles containing 'wiki': 
  
-<?plugin TitleSearch s=wiki noheader=true ? > 
+<< TitleSearch s=wiki noheader=true limit=10> > 
  
-<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 
+[[ PhpWikiDocumentation]]  
+</noinclude>  

current version

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 and 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

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

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

Other possibilities:

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:

<<TitleSearch s=wiki noheader=true limit=10>>

Search results for Page titles containing 'wiki':

No matches

<?plugin-form FullTextSearch ?>

gives

While

<?plugin-form TitleSearch formsize=12 ?>

yields