pgsrc/Help%2FUnfoldSubpagesPlugin

   1 Date: Thu, 15 Apr 2010 16:32:58 +0000
   2 Mime-Version: 1.0 (Produced by PhpWiki 1.4.0RC-20100415)
   3 X-Rcs-Id: $Id$
   4 Content-Type: application/x-phpwiki;
   5   pagename=Help%2FUnfoldSubpagesPlugin;
   6   flags=PAGE_LOCKED%2CEXTERNAL_PAGE;
   7   markup=2;
   8   charset=UTF-8
   9 Content-Transfer-Encoding: binary
  10
  11 The **~UnfoldSubpages** [[Help:WikiPlugin|plugin]] is used to display all or some subpages
  12 of the current or a given page.  This gives an overview for a
  13 [[Help:WikiBlogPlugin]], [[Help:CalendarPlugin]] or similar subpages.
  14
  15 Warning: Don't use it with subpages with non-existant sections!
  16 The section extractor is currently quite unstable.
  17
  18 == Usage
  19 {{{
  20 <<UnfoldSubpages>>
  21 <<UnfoldSubpages sortby=-mtime words=50 maxpages=5>>
  22 <<UnfoldSubpages quiet=1 smalltitle=1>>
  23 <<UnfoldSubpages sections=2 words=100>>
  24 <<UnfoldSubpages lines=3>>
  25 <<UnfoldSubpages pagename="PhpWikiAdministration"
  26                  section="Plugin Arguments" sectionhead=1>>
  27 }}}
  28
  29 == Arguments
  30
  31 {| class="bordered"
  32 |-
  33 ! Argument
  34 ! Description
  35 ! Default value
  36 |-
  37 | **pagename**
  38 | Any pagename or if empty the current page
  39 | empty
  40 |-
  41 | **quiet**
  42 | Print no header
  43 | false
  44 |-
  45 | **sortby**
  46 | Sort by + (ASC) or - (DESC) and one column.\\Multiple columns like sortby="-hits,-mtime" not yet supported.\\Supported columns: ~[+|-]pagename, ~[+|-]mtime, ~[+|-]hits.
  47 | pagename
  48 |-
  49 | **maxpages**
  50 | Maximum number of pages to include or all if not defined.
  51 | false
  52 |-
  53 | **sections**
  54 | Maximum number of sections per page to include or all if not defined.
  55 | false
  56 |-
  57 | **section**
  58 | Include this named section per page only if defined.
  59 | empty
  60 |-
  61 | **sectionhead**
  62 | When including a named section show the heading.
  63 | false
  64 |-
  65 | **smalltitle**
  66 | If set, hide transclusion-title, just have a small link at the start of  the page.
  67 | false
  68 |-
  69 | **words**
  70 | Maximum number of words per page to include.
  71 | false
  72 |-
  73 | **lines**
  74 | Maximum number of lines per page to include.
  75 | false
  76 |-
  77 | **bytes**
  78 | Maximum number of bytes per page to include.
  79 | false
  80 |}
  81
  82 === Deprecated Arguments
  83
  84 {| class="bordered"
  85 |-
  86 ! Argument
  87 ! Description
  88 |-
  89 | **pages**
  90 | Deprecated. Renamed to maxpages.
  91 |-
  92 | **sort**
  93 | 'asc' or 'desc'. Deprecated: use "+" or "-" before the column name with sortby.
  94 |}
  95
  96 == Example
  97
  98 {{{
  99 <<UnfoldSubpages pagename=Help maxpages=5 lines=10>>
 100 }}}
 101
 102 <<UnfoldSubpages pagename=Help maxpages=5 lines=10>>
 103
 104 <noinclude>
 105 ----
 106 [[PhpWikiDocumentation]] [[CategoryWikiPlugin]]
 107 </noinclude>