Diff: Help/PageList

Differences between current version and predecessor to the previous major change of Help/PageList.

Other diffs: Previous Revision, Previous Author

Newer page: version 5 Last edited on October 14, 2015 11:47 am by PhilHollenback
Older page: version 4 Last edited on February 23, 2012 2:52 pm by PhilHollenback Revert
@@ -22,9 +22,9 @@
 | which columns to display 
 | pagename 
 |- 
 | **exclude** 
-| which pages to exclude. Wildcards, comma-seperated lists and <!plugin-list !> arrays allowed. 
+| which pages to exclude. Wildcards, comma-separated lists and <!plugin-list !> arrays allowed. 
 | //none// 
 |- 
 | **author** 
 | select pages by author; current user by ~[~] 
@@ -42,9 +42,9 @@
 | select column to sort 
 | //none// 
 |- 
 | **limit** 
-| number of rows 
+| number of rows, or start index and number of rows (see below)  
 | 50 
 |- 
 | **paging** 
 | auto (top + bottom rows if applicable) \\ top (top only if applicable) \\ bottom (bottom only if applicable) \\ none (don't page at all) 
@@ -58,9 +58,9 @@
 | 1: group by initials \\ 2: provide shortcut links to initials also 
 | 0 
 |- 
 | **comma** 
-| condensed comma-seperated list, 1 if without links, 2 if with 
+| condensed comma-separated list, 1 if without links, 2 if with 
 | 0 
 |- 
 | **commasep** 
 | comma separator 
@@ -81,8 +81,14 @@
 | **nopage** 
 | for info=col omit the pagename column 
 | false 
 |} 
+  
+=== Note for limit ===  
+  
+//limit// can be:  
+* a single integer, in that case it is the number of rows;  
+* or two integers separated by a comma, in that case it is the start index (starting at 0) and the number of rows.  
  
 === Info arguments === 
  
 Column 'info=' arguments: 
@@ -94,9 +100,8 @@
 |= author | Last Author 
 |= locked | Locked 
 |= external | External 
 |= minor | Minor Edit 
-|= markup | Markup  
 |= size | Size 
 |= creator | Creator 
 |= owner | Owner 
 |= checkbox | Selectable checkbox at the left 
@@ -107,9 +112,9 @@
 Special, custom columns, either theme or plugin (~WikiAdmin*) specific: 
 |= remove | Remove 
 |= renamed_pagename | Rename to 
 |= ratingwidget | wikilens theme specific. 
-|= custom | See plugin/_ WikiTranslation 
+|= custom | See plugin/WikiTranslation 
  
 Symbolic 'info=' arguments: 
 |= all | All columns except the special columns 
 |= most | pagename, mtime, author, size, hits, ... 

current version

The PageList library allows to list a number of pagenames, optionally as table with various columns.

This library relieves some work for these plugins:

It also allows dynamic expansion of those plugins to include more columns in their output.

Arguments

Argument

Description

Default value

info

which columns to display

pagename

exclude

which pages to exclude. Wildcards, comma-separated lists and <!plugin-list !> arrays allowed.

none

author

select pages by author; current user by []

false

owner

select pages by owner; current user by []

false

creator

select pages by creator; current user by []

false

sortby

select column to sort

none

limit

number of rows, or start index and number of rows (see below)

50

paging

auto (top + bottom rows if applicable)
top (top only if applicable)
bottom (bottom only if applicable)
none (don't page at all)

auto

cols

side-by-side display of list (1-3)

1

azhead

1: group by initials
2: provide shortcut links to initials also

0

comma

condensed comma-separated list, 1 if without links, 2 if with

0

commasep

comma separator

', '

listtype

ul, ol, dl, comma

ul

ordered

OL or just UL lists (ignored for comma)

false

linkmore

If count > 0 and limit > 0, display a link with the number of all results, linked to the given pagename.

none

nopage

for info=col omit the pagename column

false

Note for limit

limit can be:

  • a single integer, in that case it is the number of rows;
  • or two integers separated by a comma, in that case it is the start index (starting at 0) and the number of rows.

Info arguments

Column 'info=' arguments:

pagename Page Name (string regex)
mtime Last Modified
hits Hits
summary Last Summary
version Version
author Last Author
locked Locked
external External
minor Minor Edit
size Size
creator Creator
owner Owner
checkbox Selectable checkbox at the left
content Page content
perm Permission Mask
acl ACL

Special, custom columns, either theme or plugin (WikiAdmin*) specific:

remove Remove
renamed_pagename Rename to
ratingwidget wikilens theme specific.
custom See plugin/WikiTranslation

Symbolic 'info=' arguments:

all All columns except the special columns
most pagename, mtime, author, size, hits, ...
some pagename, mtime, author


Our Founder
ToolboxClick to hide/show