pgsrc/Help%2FIncludePagePlugin

   1 Date: Thu, 3 Jul 2008 10:56:37 +0200
   2 Mime-Version: 1.0 (Produced by PhpWiki 1.3.14-20080124)
   3 X-Rcs-Id: $Id$
   4 Content-Type: application/x-phpwiki;
   5   pagename=Help%2FIncludePagePlugin;
   6   flags=PAGE_LOCKED;
   7   markup=2;
   8   charset=iso-8859-1
   9 Content-Transfer-Encoding: binary
  10
  11 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.
  12
  13 !!! Usage
  14 <verbatim>
  15   <?plugin IncludePage page=OtherPage rev=6 quiet=1 words=50 lines=6?>
  16 </verbatim>
  17
  18 !!! Arguments
  19
  20 page
  21   The page to include
  22 rev
  23   the revision (defaults to most recent)
  24 quiet
  25   if set, inclusion appears as normal content
  26 bytes
  27   maximum number of bytes to include
  28 words
  29   maximum number of words to include
  30 lines
  31   maximum number of lines to include
  32 sections
  33   maximum number of sections to include
  34 section
  35   include a named section
  36 sectionhead
  37   when including a named section show the heading
  38
  39 !!! Examples
  40
  41 !! ~IncludePage page=samplepage
  42 <?plugin IncludePage page=samplepage ?>
  43
  44 !! ~IncludePage page=samplepage lines=6
  45 <?plugin IncludePage page=samplepage lines=6 ?>
  46
  47 !! ~IncludePage page=samplepage section="Second section"
  48 <?plugin IncludePage page=samplepage section="Second section" ?>
  49
  50 !! ~IncludePage page=samplepage section="Second section" sectionhead=true
  51 <?plugin IncludePage page=samplepage section="Second section" sectionhead=true ?>
  52
  53 !! ~IncludePage page=samplepage sections=2
  54 <?plugin IncludePage page=samplepage sections=2 ?>
  55
  56 !! ~IncludePage page=samplepage section="Second section" sections=2
  57 <?plugin IncludePage page=samplepage section="Second section" sections=2 ?>
  58
  59 !! ~IncludePage page=samplepage quiet=1
  60 <?plugin IncludePage page=samplepage quiet=1 ?>
  61
  62 !! ~IncludePage page=samplepage lines=6 quiet=1
  63 <?plugin IncludePage page=samplepage lines=6 quiet=1 ?>
  64
  65 !! ~IncludePage page=samplepage section="Second section" quiet=1
  66 <?plugin IncludePage page=samplepage section="Second section" quiet=1 ?>
  67
  68 !! ~IncludePage page=samplepage section="Second section" sectionhead=true quiet=1
  69 <?plugin IncludePage page=samplepage section="Second section" sectionhead=true quiet=1 ?>
  70
  71 !! ~IncludePage page=samplepage sections=2 quiet=1
  72 <?plugin IncludePage page=samplepage sections=2 quiet=1 ?>
  73
  74 !! ~IncludePage page=samplepage section="Second section" sections=2 quiet=1
  75 <?plugin IncludePage page=samplepage section="Second section" sections=2 quiet=1 ?>
  76
  77 !!! Known bugs
  78
  79 * ~RedirectTo plugin is not handled correctly.
  80 * Line and word limit doesn't work if the included page itself includes a plugin.
  81
  82 !!! Authors
  83
  84 * Joe Edelman
  85 * bug fixes by [Reini Urban|PhpWiki:ReiniUrban]
  86 * "sections" parameter implemented by Marc-Etienne Vargenau, Alcatel-Lucent
  87
  88 !!! See Also
  89
  90 * [Help:IncludePagesPlugin] (to include multiple pages)
  91 * [Help:TemplatePlugin] (to include a page with parameters)
  92 * [Help:FrameIncludePlugin] (to include an external page)
  93
  94 -----
  95 [PhpWikiDocumentation] [CategoryWikiPlugin]