Extension:PagesList

From MediaWiki.org
Jump to navigation Jump to search
MediaWiki extensions manual
OOjs UI icon advanced.svg
PagesList
Release status: beta
Implementation Parser function , Special page
Description Shows a list of pages
Author(s) Ike Hecht (Tosfostalk)
Latest version 0.3 (May 2015)
Compatibility policy release branches
PHP 5.3
Database changes No
License GNU General Public License 2.0 or later
Download
$wgPagesListShowLastUser, $wgPagesListShowLastModification, $wgPagesListDataTablesOptions
Translate the PagesList extension if it is available at translatewiki.net
Check usage and version matrix.

The PagesList extension shows a list of pages contained in the wiki. The list can be limited by namespace, category or base page name. Optionally, the extension also displays the last author and modified date for each page. The list can be accessed through a special page or included using a parser function. It uses the DataTables jQuery plug-in.

Installation[edit]

  • Download and place the file(s) in a directory called PagesList in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
    require_once "$IP/extensions/PagesList/PagesList.php";
    
    If installing from git, don't forget to do git submodule init && git submodule update. Otherwise, the DataTables plug-in will not be loaded.
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration parameters[edit]

$wgPagesListShowLastUser
Show who the page was last modified by
$wgPagesListShowLastModification
Show when the page was last modified
$wgPagesListDataTablesOptions
An array of options for the DataTables plugin. See here for more information.
Example:
$wgPagesListDataTablesOptions = array(
    'iDisplayLength' => 25
);

Usage[edit]

Special page[edit]

Navigate to Special:PagesList for a list of pages using in DataTables format. Alternatively, navigate to Special:PagesListQueryPage to see the same list in a paginated query page format, which will load large lists quicker. Either way, use the options header to modify which pages are displayed.

Parser function[edit]

These parameters are all optional. By default the extension lists all pages in the wiki. Other default values are listed in all-caps below.

{{#pageslist:
  namespace=namespacename
| invert=yes/NO
| associated=yes/NO
| category=categoryname
| format=plain/ol/ul/table/DATATABLE
}}