pgsrc/Help%2FCreatePagePlugin

   1 Date: Mon, 20 Dec 2004 01:30:02 -0800
   2 Mime-Version: 1.0 (Produced by PhpWiki 1.3.11)
   3 X-Rcs-Id: $Id: Help%2FCreatePagePlugin,v 1.1 2005-11-21 22:19:00 rurban Exp $
   4 Content-Type: application/x-phpwiki;
   5   pagename=Help%2FCreatePagePlugin;
   6   pgsrc_version="2 $Revision: 1.1 $";
   7   flags="";
   8   markup=2;
   9   charset=iso-8859-1
  10 Content-Transfer-Encoding: binary
  11
  12 Help:WikiPlugin to easily create new pages, optionally with default content. Since v1.3.8
  13
  14 This allows you to create a page geting the new pagename from a
  15 forms-based interface, and optionally with the initial content from
  16 some template.
  17
  18 Put a "<~?plugin-form ~CreatePage ?~>" at some page, browse this page,
  19 enter the name of the page to create, then click the button.
  20
  21 !! Usage
  22 <verbatim>
  23      <?plugin-form CreatePage ?>
  24      <?plugin-form CreatePage template=CategoryHomePage ?>
  25      <?plugin-form CreatePage template=SomeTemplatePage vars="year=2004&name=None" ?>
  26 </verbatim>
  27
  28 !! Plugin Arguments
  29 *s*: |
  30   The pagename, which will passed to the plugin. Default: ""
  31 *initial_content*:  |
  32   The new page will be pre-filled with this content. Default: ""
  33 *template*:  |
  34   The new page will be pre-filled with the content of this page. Default: ""
  35 *vars*: |
  36   variables to be expanded. Default: ""
  37 *overwrite*: |
  38   Whether to overwrite an existing page. Default: ""
  39
  40 !! Known Problems
  41
  42 None
  43
  44 !! Variable Expansion
  45
  46 The content (either initial_content or template) might hold some variables, which will be
  47 expanded on creation. Unassigned variables will stay as %%<var>%%, assigned variables without
  48 matching %%<var>%% placeholder will be ignored, without any warning.
  49
  50 A variable in a template is denoted as <tt>%%var%%</tt>, which will be expanded by the
  51 value of <tt>var</tt> given to the vars argument (in urlencoded php notation).
  52
  53 Some special variables are automatically assigned:
  54
  55 %%ctime%% |
  56   $WikiTheme->formatDateTime(time())
  57 %%author%% |
  58   $user->getId()
  59
  60 This forms together with page templates and the PhpWiki:WikiFormRichPlugin and
  61 optionally the PhpWiki:SqlResultPlugin a framework to create templated pages.
  62
  63 !! Authors
  64
  65 Dan Frankowski, Reini Urban
  66
  67 !! Examples
  68
  69 <?plugin-form CreatePage s=MyHomePage ?>
  70
  71 See also PhpWiki:EasilyCreateNewPages, PhpWiki:WikiFormRichPlugin, PhpWiki:SqlResultPlugin
  72
  73 -------------
  74
  75 PhpWikiDocumentation Help:WikiPlugin