pgsrc/Help%2FIncludePagePlugin

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