Diff: Help/CreatePagePlugin

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

Differences between version 3 and predecessor to the previous major change of Help/CreatePagePlugin.

Other diffs: Previous Revision, Previous Author

Newer page: version 3 Last edited on 9 September 2007 0:16 by harold Revert
Older page: version 2 Last edited on 22 May 2014 3:01 by harold Revert
@@ -1,86 +1,64 @@
-The **~CreatePage** [[ Help:WikiPlugin|plugin]] allows to easily create new pages, optionally with default content. 
+Help:WikiPlugin to easily create new pages, optionally with default content. Since v1.3.8  
  
 This allows you to create a page geting the new pagename from a 
 forms-based interface, and optionally with the initial content from 
 some template. 
  
-Put a {{{ <?plugin-form CreatePage ?>}}} at some page, browse this page, 
+Put a " <~ ?plugin-form ~ CreatePage ?~ >" at some page, browse this page, 
 enter the name of the page to create, then click the button. 
  
-== Usage == 
+!! Usage  
+<verbatim>  
+ <?plugin-form CreatePage ?>  
+ <?plugin-form CreatePage template =CategoryHomePage ?>  
+ <?plugin-form CreatePage template =SomeTemplatePage vars="year =2004&name =None" ?>  
+</verbatim>  
  
-{{{  
-<?plugin-form CreatePage ?>  
-<? plugin-form CreatePage template=CategoryHomePage ?>  
-<?plugin -form CreatePage template=SomeTemplatePage vars= "year=2004&name=None " ?>  
-}}}  
+!! Plugin Arguments  
+*s*: |  
+ The pagename, which will passed to the plugin. Default: ""  
+*initial_content*: |  
+ The new page will be pre -filled with this content. Default: ""  
+* template*: |  
+ The new page will be pre -filled with the content of this page. Default: ""  
+* vars*: |  
+ variables to be expanded. Default: ""  
+*overwrite*: |  
+ Whether to overwrite an existing page. Default: ""  
  
-== Arguments ==  
+!! Known Problems  
  
-{| class="bordered"  
-|-  
-! Argument  
-! Description  
-! Default value  
-|-  
-| **s**  
-| The pagename, which will passed to the plugin.  
-|  
-|-  
-| **initial_content**  
-| The new page will be pre-filled with this content.  
-|  
-|-  
-| **template**  
-| The new page will be pre-filled with the content of this page.  
-|  
-|-  
-| **vars**  
-| Variables to be expanded.  
-|  
-|-  
-| **overwrite**  
-| Whether to overwrite an existing page.  
-|  
-|}  
+None  
  
-== Variable Expansion ==  
+!! Variable Expansion 
  
 The content (either initial_content or template) might hold some variables, which will be 
 expanded on creation. Unassigned variables will stay as %%<var>%%, assigned variables without 
 matching %%<var>%% placeholder will be ignored, without any warning. 
  
-A variable in a template is denoted as ## %%var%%## , which will be expanded by the  
-value of ## var## given to the vars argument (in urlencoded php notation). 
+A variable in a template is denoted as <tt> %%var%%</tt> , which will be expanded by the  
+value of <tt> var</tt> given to the vars argument (in urlencoded php notation). 
  
 Some special variables are automatically assigned: 
-{| class="bordered"  
-|-  
-| %%ctime%% || $~WikiTheme->formatDateTime(time())  
-|-  
-| %%author%% || $user->getId()  
-|}  
  
-This forms together with page templates and the [[Help:WikiFormRichPlugin]] and  
-optionally the [[Help:SqlResultPlugin]] a framework to create templated pages.  
+%%ctime%% |  
+ $WikiTheme->formatDateTime(time())  
+%%author%% |  
+ $user->getId()  
  
-== Authors ==  
-* Dan Frankowski  
-* [[Help :Reini Urban|Reini Urban]]  
+This forms together with page templates and the PhpWiki:WikiFormRichPlugin and  
+optionally the PhpWiki :SqlResultPlugin a framework to create templated pages.  
  
-== Examples ==  
+!! Authors  
+  
+Dan Frankowski, Reini Urban  
+  
+!! Examples 
  
-{{{  
-<?plugin-form CreatePage s=MyHomePage ?>  
-}}}  
 <?plugin-form CreatePage s=MyHomePage ?> 
  
-== See Also ==  
-* [[ PhpWiki:EasilyCreateNewPages]]  
-* [[Help :WikiFormRichPlugin]]  
-* [[Help :SqlResultPlugin]]  
+See also PhpWiki:EasilyCreateNewPages, PhpWiki :WikiFormRichPlugin, PhpWiki :SqlResultPlugin  
+  
+-------------  
  
-<noinclude>  
-----  
-[[ PhpWikiDocumentation]] [[CategoryWikiPlugin]]  
-</noinclude>  
+PhpWikiDocumentation Help:WikiPlugin  

version 3

Help:WikiPlugin to easily create new pages, optionally with default content. Since v1.3.8

This allows you to create a page geting the new pagename from a forms-based interface, and optionally with the initial content from some template.

Put a "<?plugin-form CreatePage ?>" at some page, browse this page, enter the name of the page to create, then click the button.

Usage

     <?plugin-form CreatePage ?>
     <?plugin-form CreatePage template=CategoryHomePage ?>
     <?plugin-form CreatePage template=SomeTemplatePage vars="year=2004&name=None" ?>

Plugin Arguments

s: The pagename, which will passed to the plugin. Default: ""
initial_content: The new page will be pre-filled with this content. Default: ""
template: The new page will be pre-filled with the content of this page. Default: ""
vars: variables to be expanded. Default: ""
overwrite: Whether to overwrite an existing page. Default: ""

Known Problems

None

Variable Expansion

The content (either initial_content or template) might hold some variables, which will be expanded on creation. Unassigned variables will stay as %%<var>%%, assigned variables without matching %%<var>%% placeholder will be ignored, without any warning.

A variable in a template is denoted as %%var%%, which will be expanded by the value of var given to the vars argument (in urlencoded php notation).

Some special variables are automatically assigned:

%%ctime%% $WikiTheme->formatDateTime(time())
%%author%% $user->getId()

This forms together with page templates and the PhpWiki:WikiFormRichPlugin and optionally the PhpWiki:SqlResultPlugin a framework to create templated pages.

Authors

Dan Frankowski, Reini Urban

Examples

See also PhpWiki:EasilyCreateNewPages, PhpWiki:WikiFormRichPlugin, PhpWiki:SqlResultPlugin

PhpWikiDocumentation Help:WikiPlugin