Date: Thu, 22 Aug 2008 10:56:37 +0200
Mime-Version: 1.0 (Produced by PhpWiki 1.3.14-20080124)
X-Rcs-Id: $Id$
Content-Type: application/x-phpwiki;
  pagename=Help%2FIncludePagePlugin;
  flags=PAGE_LOCKED;
  markup=2;
  charset=iso-8859-1
Content-Transfer-Encoding: binary

The *~IncludePage* plugin will "include" other pages in this wiki. In the language of hypertext this is called <i>transclusion</i>. The pages will render in distinct tables. You can also load external pages in a more limited fashion with the [FrameInclude|Help:FrameIncludePlugin] plugin.

!!! Usage
<verbatim>
<?plugin IncludePage page=OtherPage rev=6 quiet=1 words=50 lines=6 ?>
</verbatim>

!!! Arguments

page
  The page to include
rev
  the revision (defaults to most recent)
quiet
  if set, inclusion appears as normal content
bytes
  maximum number of bytes to include
words
  maximum number of words to include
lines
  maximum number of lines to include
sections
  maximum number of sections to include
section
  include a named section
sectionhead
  when including a named section show the heading

!!! Examples

!! ~IncludePage page=Help/~AllPagesPlugin
<?plugin IncludePage page=Help/AllPagesPlugin ?>

!! ~IncludePage page=Help/~AllPagesPlugin lines=6
<?plugin IncludePage page=Help/AllPagesPlugin lines=6 ?>

!! ~IncludePage page=Help/~AllPagesPlugin section="Arguments"
<?plugin IncludePage page=Help/AllPagesPlugin section="Arguments" ?>

!! ~IncludePage page=Help/~AllPagesPlugin section="Arguments" sectionhead=true
<?plugin IncludePage page=Help/AllPagesPlugin section="Arguments" sectionhead=true ?>

!! ~IncludePage page=Help/~AllPagesPlugin sections=2
<?plugin IncludePage page=Help/AllPagesPlugin sections=2 ?>

!!! Known bugs

* ~RedirectTo plugin is not handled correctly.
* Line and word limit doesn't work if the included page itself includes a plugin.

!!! Authors

* Joe Edelman
* bug fixes by [Reini Urban|PhpWiki:ReiniUrban]
* "sections" parameter implemented by Marc-Etienne Vargenau, Alcatel-Lucent

!!! See Also

* [Help:IncludePagesPlugin] (to include multiple pages)
* [Help:TemplatePlugin] (to include a page with parameters)
* [Help:FrameIncludePlugin] (to include an external page)

-----
[PhpWikiDocumentation] [CategoryWikiPlugin]