pgsrc/Help%2FIncludePagePlugin

   1 Date: Fri, 20 Nov 2009 18:30:13 +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%2CEXTERNAL_PAGE;
   7   markup=2;
   8   charset=UTF-8
   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 //transclusion//.
  12 The pages will render in distinct tables. You can also load external pages in a more limited fashion with the [[Help:FrameIncludePlugin|FrameInclude]] plugin.
  13
  14 == Usage
  15 {{{
  16 <<IncludePage page=OtherPage rev=6 quiet=1 words=50 lines=6>>
  17 }}}
  18
  19 == Arguments
  20
  21 {| class="bordered"
  22 |-
  23 ! Argument
  24 ! Description
  25 ! Default value
  26 |-
  27 | **page**
  28 | The page to include
  29 | //None// (mandatory argument)
  30 |-
  31 | **rev**
  32 | the revision
  33 | defaults to most recent
  34 |-
  35 | **quiet**
  36 | if set, inclusion appears as normal content
  37 | false
  38 |-
  39 | **bytes**
  40 | maximum number of bytes to include
  41 | //None// (include all page)
  42 |-
  43 | **words**
  44 | maximum number of words to include
  45 | //None// (include all page)
  46 |-
  47 | **lines**
  48 | maximum number of lines to include
  49 | //None// (include all page)
  50 |-
  51 | **sections**
  52 | maximum number of sections to include
  53 | //None// (include all sections)
  54 |-
  55 | **section**
  56 | include a named section
  57 | //None//
  58 |-
  59 | **sectionhead**
  60 | when including a named section show the heading
  61 | false
  62 |}
  63
  64 == Examples
  65
  66 === ~IncludePage page=Help/~AllPagesPlugin
  67 <<IncludePage page=Help/AllPagesPlugin>>
  68
  69 === ~IncludePage page=Help/~AllPagesPlugin lines=6
  70 <<IncludePage page=Help/AllPagesPlugin lines=6>>
  71
  72 === ~IncludePage page=Help/~AllPagesPlugin section="Arguments"
  73 <<IncludePage page=Help/AllPagesPlugin section="Arguments">>
  74
  75 === ~IncludePage page=Help/~AllPagesPlugin section="Arguments" sectionhead=true
  76 <<IncludePage page=Help/AllPagesPlugin section="Arguments" sectionhead=true>>
  77
  78 === ~IncludePage page=Help/~AllPagesPlugin sections=2
  79
  80 Does not work in Wikicreole syntax
  81 <!-- <<IncludePage page=Help/AllPagesPlugin sections=2>> -->
  82
  83 == Known bugs
  84
  85 * Line and word limit doesn't work if the included page itself includes a plugin.
  86 * "sections" parameter does not work if sections to include are in Wikicreole syntax.
  87 * "section" parameter does not always work if sections to include use both Wikicreole/Mediawiki and classic Phpwiki syntax.
  88
  89 == Authors
  90
  91 * Joe Edelman
  92 * bug fixes by [[PhpWiki:ReiniUrban|Reini Urban]]
  93 * "sections" parameter implemented by Marc-Etienne Vargenau, Alcatel-Lucent
  94
  95 == See Also
  96
  97 * [[Help:IncludePagesPlugin]] (to include multiple pages)
  98 * [[Help:TemplatePlugin]] (to include a page with parameters)
  99 * [[Help:FrameIncludePlugin]] (to include an external page)
 100
 101 <noinclude>
 102 ----
 103 [[PhpWikiDocumentation]] [[CategoryWikiPlugin]]
 104 </noinclude>