pgsrc/Help%2FListPagesPlugin

   1 Date: Tue, 27 Nov 2012 11:38:57 +0000
   2 Mime-Version: 1.0 (Produced by PhpWiki 1.4.0)
   3 Content-Type: application/x-phpwiki;
   4   pagename=Help%2FListPagesPlugin;
   5   flags=PAGE_LOCKED%2CEXTERNAL_PAGE;
   6   markup=2;
   7   charset=UTF-8
   8 Content-Transfer-Encoding: binary
   9
  10 The **~ListPages** [[Help:WikiPlugin|plugin]] is the simplest plugin to explicitly list a set of pages with all available
  11 [[Help:PageList|PageList]] options, mainly used for a wikilens theme to display ratings info
  12 and recommendations.
  13
  14 It can also be used with the [[PhpWiki:PluginList]] method to list a set of pages generated by
  15 another plugin, and/or to exclude a set of pages generated by another plugin.
  16
  17 See the [[Help:PageList|PageList]] options.
  18
  19 == Usage ==
  20
  21 {{{
  22 <<ListPages arguments>>
  23 }}}
  24
  25 == Arguments ==
  26
  27 All [[Help:PageList|PageList]] arguments, plus the following ones:
  28
  29 {| class="bordered"
  30 |-
  31 ! Argument
  32 ! Description
  33 ! Default value
  34 |-
  35 | **pages**
  36 | Pages to list
  37 | false
  38 |-
  39 | **dimension**
  40 |
  41 | 0
  42 |}
  43
  44 === Additional info arguments ===
  45
  46 |= top3recs     | recommendations (wikilens theme only)
  47 |= numbacklinks | number of backlinks (links to the given page)
  48 |= numpagelinks | number of forward links (links at the given page)
  49
  50 == Examples ==
  51
  52 {{{
  53 <<ListPages pages=HomePage,FindPage>>
  54 }}}
  55
  56 {{{
  57 <<ListPages info=hits
  58             sortby=hits
  59             pages=<!plugin-list BackLink page=[] !>
  60             exclude=ListPagesPlugin,WikiPlugin
  61 >>
  62 }}}
  63
  64 <noinclude>
  65 ----
  66 [[PhpWikiDocumentation]] [[CategoryWikiPlugin]]
  67 </noinclude>