pgsrc/Help%2FUnfoldSubpagesPlugin

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