pgsrc/Help%2FPageList

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