pgsrc/Help%2FUnfoldSubpagesPlugin

   1 Date: Wed, 2 Feb 2005 20:32:44 +0100
   2 Mime-Version: 1.0 (Produced by PhpWiki 1.3.11)
   3 X-Rcs-Id: $Id: Help%2FUnfoldSubpagesPlugin,v 1.1 2005-11-21 22:19:00 rurban Exp $
   4 Content-Type: application/x-phpwiki;
   5   pagename=Help%2FUnfoldSubpagesPlugin;
   6   pgsrc_version="2 $Revision: 1.1 $";
   7   flags="";
   8   markup=2;
   9   charset=iso-8859-1
  10 Content-Transfer-Encoding: binary
  11
  12 The ~UnfoldSubpages Help:WikiPlugin is used to display all or some subpages
  13 of the current or a given page.  This gives a overview for a
  14 WikiBlogPlugin, CalendarPlugin or similar subpages.
  15
  16 Warning: Don't use it with subpages with non-existant sections!
  17 The section extractor is currently quite unstable.
  18
  19 ! Usage:
  20 <verbatim>
  21      <?plugin UnfoldSubpages ?>
  22   or <?plugin UnfoldSubpages sortby=-mtime words=50 maxpages=5 ?>
  23   or <?plugin UnfoldSubpages quiet=1 smalltitle=1 ?>
  24   or <?plugin UnfoldSubpages sections=2 words=100 ?>
  25   or <?plugin UnfoldSubpages lines=3 ?>
  26   or <?plugin UnfoldSubpages pagename="PhpWikiAdministration"
  27               section="Plugin Arguments" sectionhead=1 ?>
  28 </verbatim>
  29
  30 !! Plugin Arguments:
  31 <strong>pagename</strong>:
  32   Any pagename or if empty the current page. Default: ""
  33 <strong>quiet</strong>:
  34   Print no header.  Default: false
  35 <strong>sortby</strong>:
  36   Sort by + (ASC) or - (DESC) and one column.
  37   Multiple columns like sortby="-hits,-mtime" not yet supported.
  38   Supported columns: ~[+|-]pagename, ~[+|-]mtime, ~[+|-]hits.
  39   Default: "pagename"
  40 <strong>maxpages</strong>:
  41   Maximum number of pages to include or all if not defined.
  42   Default: false
  43 <strong>sections</strong>:
  44   Maximum number of sections per page to include or all if not defined.
  45   Default: false
  46 <strong>section</strong>:
  47   Include this named section per page only if defined. Default: ""
  48 <strong>sectionhead</strong>:
  49   When including a named section show the heading. Default: false
  50 <strong>smalltitle</strong>:
  51   If set, hide transclusion-title, just have a small link at the start of
  52   the page. Default: false
  53 <strong>words</strong>:
  54   Maximum number of words per page to include. Default: false
  55 <strong>lines</strong>:
  56   Maximum number of lines per page to include. Default: false
  57 <strong>bytes</strong>:
  58   Maximum number of bytes per page to include. Default: false
  59
  60 ! Deprecated Arguments:
  61 <strong>pages</strong>:
  62   deprecated. renamed to maxpages.
  63 <strong>sort</strong>:
  64   'asc' or 'desc'. deprecated: use "+" or "-" before the column name with sortby.
  65
  66 ! Example:
  67 <?plugin UnfoldSubpages pagename=PgsrcTranslation limit=20 ?>
  68
  69 -------------
  70
  71 PhpWikiDocumentation Help:WikiPlugin