pgsrc/Help%2FPageList

   1 Date: Fri, 28 Jun 2013 15:51:27 +0000
   2 Mime-Version: 1.0 (Produced by PhpWiki 1.4.0)
   3 Content-Type: application/x-phpwiki;
   4   pagename=Help%2FPageList;
   5   flags="";
   6   charset=UTF-8
   7 Content-Transfer-Encoding: binary
   8
   9 The **~PageList** library allows to list a number of pagenames, optionally as table with various columns.
  10
  11 This library relieves some work for these plugins:
  12 * AllPages,
  13 * BackLinks,
  14 * LikePages,
  15 * MostPopular,
  16 * TitleSearch,
  17 - ~WikiAdmin* and more.
  18
  19 It also allows dynamic expansion of those plugins to include more columns in their output.
  20
  21 == Arguments ==
  22
  23 {| class="bordered"
  24 |-
  25 ! Argument
  26 ! Description
  27 ! Default value
  28 |-
  29 | **info**
  30 | which columns to display
  31 | pagename
  32 |-
  33 | **exclude**
  34 | which pages to exclude. Wildcards, comma-separated lists and <!plugin-list !> arrays allowed.
  35 | //none//
  36 |-
  37 | **author**
  38 | select pages by author; current user by ~[~]
  39 | false
  40 |-
  41 | **owner**
  42 | select pages by owner; current user by ~[~]
  43 | false
  44 |-
  45 | **creator**
  46 | select pages by creator; current user by ~[~]
  47 | false
  48 |-
  49 | **sortby**
  50 | select column to sort
  51 | //none//
  52 |-
  53 | **limit**
  54 | number of rows
  55 | 50
  56 |-
  57 | **paging**
  58 | auto (top + bottom rows if applicable) \\ top (top only if applicable) \\ bottom (bottom only if applicable) \\ none (don't page at all)
  59 | auto
  60 |-
  61 | **cols**
  62 | side-by-side display of list (1-3)
  63 | 1
  64 |-
  65 | **azhead**
  66 | 1: group by initials \\ 2: provide shortcut links to initials also
  67 | 0
  68 |-
  69 | **comma**
  70 | condensed comma-separated list, 1 if without links, 2 if with
  71 | 0
  72 |-
  73 | **commasep**
  74 | comma separator
  75 | ', '
  76 |-
  77 | **listtype**
  78 | ul, ol, dl, comma
  79 | ul
  80 |-
  81 | **ordered**
  82 | OL or just UL lists (ignored for comma)
  83 | false
  84 |-
  85 | **linkmore**
  86 | If count > 0 and limit > 0, display a link with the number of all results, linked to the given pagename.
  87 | //none//
  88 |-
  89 | **nopage**
  90 | for info=col omit the pagename column
  91 | false
  92 |}
  93
  94 === Info arguments ===
  95
  96 Column 'info=' arguments:
  97 |= pagename  | Page Name (string regex)
  98 |= mtime     | Last Modified
  99 |= hits      | Hits
 100 |= summary   | Last Summary
 101 |= version   | Version
 102 |= author    | Last Author
 103 |= locked    | Locked
 104 |= external  | External
 105 |= minor     | Minor Edit
 106 |= size      | Size
 107 |= creator   | Creator
 108 |= owner     | Owner
 109 |= checkbox  | Selectable checkbox at the left
 110 |= content   | Page content
 111 |= perm      | Permission Mask
 112 |= acl       | ACL
 113
 114 Special, custom columns, either theme or plugin (~WikiAdmin*) specific:
 115 |= remove              | Remove
 116 |= renamed_pagename    | Rename to
 117 |= ratingwidget        | wikilens theme specific.
 118 |= custom              | See plugin/WikiTranslation
 119
 120 Symbolic 'info=' arguments:
 121 |= all  | All columns except the special columns
 122 |= most | pagename, mtime, author, size, hits, ...
 123 |= some | pagename, mtime, author
 124
 125 <noinclude>
 126 ----
 127 [[PhpWikiDocumentation]]
 128 </noinclude>