pgsrc/Help%2FIncludePagePlugin

   1 Date: Sat, 21 Feb 2009 21:33:56 +0000
   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* [[Help:WikiPlugin|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 <<IncludePage page=OtherPage rev=6 quiet=1 words=50 lines=6>>
  16 </verbatim>
  17
  18 == Arguments
  19
  20 {| class="bordered"
  21 |-
  22 ! Argument
  23 ! Description
  24 ! Default value
  25 |-
  26 | <b>page</b>
  27 | The page to include
  28 | ''None'' (mandatory argument)
  29 |-
  30 | <b>rev</b>
  31 | the revision
  32 | defaults to most recent
  33 |-
  34 | <b>quiet</b>
  35 | if set, inclusion appears as normal content
  36 | false
  37 |-
  38 | <b>bytes</b>
  39 | maximum number of bytes to include
  40 | ''None'' (include all page)
  41 |-
  42 | <b>words</b>
  43 | maximum number of words to include
  44 | ''None'' (include all page)
  45 |-
  46 | <b>lines</b>
  47 | maximum number of lines to include
  48 | ''None'' (include all page)
  49 |-
  50 | <b>sections</b>
  51 | maximum number of sections to include
  52 | ''None'' (include all sections)
  53 |-
  54 | <b>section</b>
  55 | include a named section
  56 | ''None''
  57 |-
  58 | <b>sectionhead</b>
  59 | when including a named section show the heading
  60 | false
  61 |}
  62
  63 == Examples
  64
  65 === ~IncludePage page=Help/~AllPagesPlugin
  66 <<IncludePage page=Help/AllPagesPlugin>>
  67
  68 === ~IncludePage page=Help/~AllPagesPlugin lines=6
  69 <<IncludePage page=Help/AllPagesPlugin lines=6>>
  70
  71 === ~IncludePage page=Help/~AllPagesPlugin section="Arguments"
  72 <<IncludePage page=Help/AllPagesPlugin section="Arguments">>
  73
  74 === ~IncludePage page=Help/~AllPagesPlugin section="Arguments" sectionhead=true
  75 <<IncludePage page=Help/AllPagesPlugin section="Arguments" sectionhead=true>>
  76
  77 === ~IncludePage page=Help/~AllPagesPlugin sections=2
  78 <<IncludePage page=Help/AllPagesPlugin sections=2>>
  79
  80 == Known bugs
  81
  82 * [~RedirectTo|Help:RedirectToPlugin] plugin is not handled correctly.
  83 * Line and word limit doesn't work if the included page itself includes a plugin.
  84
  85 == Authors
  86
  87 * Joe Edelman
  88 * bug fixes by [Reini Urban|PhpWiki:ReiniUrban]
  89 * "sections" parameter implemented by Marc-Etienne Vargenau, Alcatel-Lucent
  90
  91 == See Also
  92
  93 * [Help:IncludePagesPlugin] (to include multiple pages)
  94 * [Help:TemplatePlugin] (to include a page with parameters)
  95 * [Help:FrameIncludePlugin] (to include an external page)
  96
  97 -----
  98 [[PhpWikiDocumentation]] [[CategoryWikiPlugin]]