pgsrc/Help%2FPageList

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