pgsrc/Help%2FUnfoldSubpagesPlugin

   1 Date: Fri, 10 Sep 2010 13:46:13 +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%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 {{{
  21 <<UnfoldSubpages>>
  22 <<UnfoldSubpages sortby=-mtime words=50 maxpages=5>>
  23 <<UnfoldSubpages quiet=1 smalltitle=1>>
  24 <<UnfoldSubpages sections=2 words=100>>
  25 <<UnfoldSubpages lines=3>>
  26 <<UnfoldSubpages pagename="PhpWikiAdministration"
  27                  section="Plugin Arguments" sectionhead=1>>
  28 }}}
  29
  30 == Arguments ==
  31
  32 All [[Help:PageList|PageList]] arguments, plus the following ones.
  33
  34 {| class="bordered"
  35 |-
  36 ! Argument
  37 ! Description
  38 ! Default value
  39 |-
  40 | **pagename**
  41 | Any pagename or if empty the current page
  42 | empty
  43 |-
  44 | **quiet**
  45 | Print no header
  46 | false
  47 |-
  48 | **sortby**
  49 | Sort by + (ASC) or - (DESC) and one column.\\Multiple columns like sortby="-hits,-mtime" not yet supported.\\Supported columns: ~[+|-]pagename, ~[+|-]mtime, ~[+|-]hits.
  50 | pagename
  51 |-
  52 | **maxpages**
  53 | Maximum number of pages to include or all if not defined.
  54 | false
  55 |-
  56 | **sections**
  57 | Maximum number of sections per page to include or all if not defined.
  58 | false
  59 |-
  60 | **section**
  61 | Include this named section per page only if defined.
  62 | empty
  63 |-
  64 | **sectionhead**
  65 | When including a named section show the heading.
  66 | false
  67 |-
  68 | **smalltitle**
  69 | If set, hide transclusion-title, just have a small link at the start of  the page.
  70 | false
  71 |-
  72 | **words**
  73 | Maximum number of words per page to include.
  74 | false
  75 |-
  76 | **lines**
  77 | Maximum number of lines per page to include.
  78 | false
  79 |-
  80 | **bytes**
  81 | Maximum number of bytes per page to include.
  82 | false
  83 |}
  84
  85 === Deprecated Arguments ===
  86
  87 {| class="bordered"
  88 |-
  89 ! Argument
  90 ! Description
  91 |-
  92 | **pages**
  93 | Deprecated. Renamed to maxpages.
  94 |-
  95 | **sort**
  96 | 'asc' or 'desc'. Deprecated: use "+" or "-" before the column name with sortby.
  97 |}
  98
  99 == Example ==
 100
 101 {{{
 102 <<UnfoldSubpages pagename=Help maxpages=5 lines=10>>
 103 }}}
 104
 105 <<UnfoldSubpages pagename=Help maxpages=5 lines=10>>
 106
 107 <noinclude>
 108 ----
 109 [[PhpWikiDocumentation]] [[CategoryWikiPlugin]]
 110 </noinclude>