pgsrc/Help%2FUnfoldSubpagesPlugin

   1 Date: Sun, 22 Feb 2009 19:16:30 +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%2FUnfoldSubpagesPlugin;
   6   flags=PAGE_LOCKED;
   7   markup=2;
   8   charset=iso-8859-1
   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 a overview for a
  13 WikiBlogPlugin, 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   or <<UnfoldSubpages sortby=-mtime words=50 maxpages=5>>
  22   or <<UnfoldSubpages quiet=1 smalltitle=1>>
  23   or <<UnfoldSubpages sections=2 words=100>>
  24   or <<UnfoldSubpages lines=3>>
  25   or <<UnfoldSubpages pagename="PhpWikiAdministration"
  26               section="Plugin Arguments" sectionhead=1>>
  27 }}}
  28
  29 == Arguments
  30 <strong>pagename</strong>:
  31   Any pagename or if empty the current page. Default: ""
  32 <strong>quiet</strong>:
  33   Print no header.  Default: false
  34 <strong>sortby</strong>:
  35   Sort by + (ASC) or - (DESC) and one column.
  36   Multiple columns like sortby="-hits,-mtime" not yet supported.
  37   Supported columns: ~[+|-]pagename, ~[+|-]mtime, ~[+|-]hits.
  38   Default: "pagename"
  39 <strong>maxpages</strong>:
  40   Maximum number of pages to include or all if not defined.
  41   Default: false
  42 <strong>sections</strong>:
  43   Maximum number of sections per page to include or all if not defined.
  44   Default: false
  45 <strong>section</strong>:
  46   Include this named section per page only if defined. Default: ""
  47 <strong>sectionhead</strong>:
  48   When including a named section show the heading. Default: false
  49 <strong>smalltitle</strong>:
  50   If set, hide transclusion-title, just have a small link at the start of
  51   the page. Default: false
  52 <strong>words</strong>:
  53   Maximum number of words per page to include. Default: false
  54 <strong>lines</strong>:
  55   Maximum number of lines per page to include. Default: false
  56 <strong>bytes</strong>:
  57   Maximum number of bytes per page to include. Default: false
  58
  59 === Deprecated Arguments
  60 <strong>pages</strong>:
  61   deprecated. renamed to maxpages.
  62 <strong>sort</strong>:
  63   'asc' or 'desc'. deprecated: use "+" or "-" before the column name with sortby.
  64
  65 == Example
  66 <<UnfoldSubpages pagename=PgsrcTranslation limit=20>>
  67
  68 <noinclude>
  69 ----
  70 [[PhpWikiDocumentation]] [[CategoryWikiPlugin]]
  71 </noinclude>