Extension:TopTenPages

From MediaWiki.org
Jump to: navigation, search
MediaWiki extensions manualManual:Extensions
Crystal Clear action run.png
Top Ten Pages

Release status:Extension status beta

TopTenPages.png
ImplementationTemplate:Extension#type Tag, Special page
DescriptionTemplate:Extension#description Allows to display the most popular pages of a wiki on a page
Author(s)Template:Extension#username Sascha
Timo Tijhof
Latest versionTemplate:Extension#version 0.4.0 (2015-06-27)
PHPTemplate:Extension#php 5.3+
Database changesTemplate:Extension#needs-updatephp No
LicenseTemplate:Extension#license MIT License
Download
ParametersTemplate:Extension#parameters
  • <TopTenPages/>
  • <TopTenPages offset="1">5</TopTenPages>

Translate the TopTenPages extension if it is available at translatewiki.net

Check usage and version matrix.

The TopTenPages extension allows to display the most popular pages of the wiki on a page.

Usage[edit]

 <TopTenPages [offset=OFFSET]>[NUMBEROFPAGES]</TopTenPages>

Or:

 {{Special:TopTenPages/OFFSET/NUMBEROFPAGES}}
OFFSET
Format: Number
Default: 0 or -
How many of the most popular Pages to ignore. (e.g. 1 to ignore the main page)
NUMBEROFPAGES
Format: Number
Default: 10
Maximum number of pages to be listed.

Examples[edit]

To show 10 most popular Pages:

<TopTenPages/> 

To show 5 most popular Pages:

<TopTenPages>5</TopTenPages>

To omit the most popular page(s):

<TopTenPages offset=1/> 

This extension makes use of the HitCounters' "Special:Popularpages".

Installation[edit]

  • Before downloading TopTenPages, first install HitCounters. (Unless you are using MediaWiki 1.24 or older, where HitCounters was part of MediaWiki)
  • Download and place the file(s) in a directory called TopTenPages in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php:
wfLoadExtension( 'TopTenPages' );
  • Configure as required
  • YesY Done - Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

To users running MediaWiki 1.24 or earlier:

The instructions above describe the new way of installing this extension using wfLoadExtension() If you need to install this extension on these earlier versions (MediaWiki 1.24 and earlier), instead of wfLoadExtension( 'TopTenPages' );, you need to use:

require_once "$IP/extensions/TopTenPages/TopTenPages.php";

Configuration[edit]

$wgTopTenPagesStartAtOne (Disabled by default)
Enable this to always start the list numbering at "1", even if an "offset" attribute was set.