pgsrc/Help%2FListPagesPlugin

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