Date: Sat, 2 Aug 2008 14:15:24 +0000
Mime-Version: 1.0 (Produced by PhpWiki 1.3.14-20080124)
X-Rcs-Id: $Id: Help%2FTemplatePlugin,v 1.4 2008-08-03 16:46:12 vargenau Exp $
Content-Type: application/x-phpwiki;
  pagename=Help%2FTemplatePlugin;
  flags=PAGE_LOCKED;
  markup=2;
  charset=iso-8859-1
Content-Transfer-Encoding: binary

Template = Parametrized blocks.

Include text from a wiki page and replace certain placeholders by parameters.
Similiar to [CreatePage] with the template argument, but at run-time.
Similiar to the Mediawiki templates but not with the "|" parameter seperator.

!!!  Usage

<verbatim>
  <?plugin Template page=Templates/Footer?>
  <?plugin Template page=Templates/Film vars="title=SomeFilm&year=1999" ?>
  {{Templates/Film|title=SomeFilm|year=1999}}
</verbatim>

If ENABLE_MARKUP_TEMPLATE is true, we support a Mediawiki-style syntax extension which maps 
<verbatim>
    {{TemplateFilm|title=Some Good Film|year=1999}}
</verbatim>
  to 
<verbatim>
    <?plugin Template page=TemplateFilm vars="title=Some Good Film&year=1999" ?>
</verbatim>

!!! Arguments

Argument|
  Default Value|
    Description

page|
  (empty)|
    pagename to be included as template

vars|
  (empty)|
    optional parameters to be expanded inside the template

!! Parameter expansion

  vars="var1=value1&var2=value2"

We only support named parameters, not numbered ones as in Mediawiki, and 
the placeholder is %%var%% and not ~{~{~{var~}~}~} as in Mediawiki.

The following predefined variables are automatically expanded if existing:

pagename|
  %%%

mtime|
  last modified date + time

ctime|
  creation date + time

author|
  last author

owner|
  %%%

creator|
  first author

SERVER_URL|
  %%%

DATA_PATH|
  %%%

SCRIPT_NAME|
  %%%

PHPWIKI_BASE_URL|
  %%%

BASE_URL|
  %%%

!!! Inclusion

<noinclude> .. </noinclude> is stripped.

<includeonly> .. </includeonly> is only expanded in pages using the template, not in the template itself.

!!! Examples

Standard syntax:
<verbatim>
  <?plugin Template page=TemplateExample vars="title=TestTitle" ?>
</verbatim>

Shorter syntax:
<verbatim>
  {{TemplateExample|title=TestTitle}}
</verbatim>

----
[PhpWikiDocumentation] [CategoryWikiPlugin]