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