Help:DynamicPageList

DPL (also known as the Dynamic Page List extension) is a powerful MediaWiki extension that allows for the creation of lists of pages using various criteria such as membership in a category or inclusion of a specific template.

DPL is most commonly used for displaying simple lists of pages in a set of categories (i.e., pages in Category:Episodes and Category:Stubs).

Because of its great power, DPL increases server load and can result in significantly slower page loads for wikis that use it. As such, it is strongly encouraged you to read the "Using DPL effectively" section of this article.

Benefits of DPL

 * Creates dynamic listings of pages based on various parameters, such as page titles, namespaces, membership in a category, template inclusion, and more.
 * For example you can create a page that lists all pages in two categories but not in a third.
 * Can include page information such as date of the last edit, the username of last editor, and more.
 * Can display lists in tables, bulleted or numbered lists, in category page style, or inline.
 * Allows creation of lists with custom styles and formatting inserted in-between items.

How to include DPL on a page
DPL queries start with the  tag and close with the   tag. Within these tags, users may put a wide variety of parameters to customize and tailor the query to their needs. You can also use  instead.

Here is a very basic DPL query example:  category = Characters 

This query above would output a list of all the pages that are in the category Characters.

This can be further customized:  category   = Characters notcategory = Season 1 Characters namespace  = Character mode       = ordered 

This query would display all pages that are in the Character namespace and have the category Characters if the page also did not have the category Season 1 Characters. This list would also be printed as a  as opposed to the default .

A comprehensive list of all DPL parameters is available here, and further information about the extension can be found on MediaWiki.org.

Using DPL effectively
DPL can cause heavy server loads, slowing the entire site down. The following are tips on how to get around the problem.

First, Consider whether your DPL usage is necessary. If it's only used because it's "cool", you might be able to provide something equally cool to your users in the same space, such as a poll, calendar, embedded RSS feed, embedded video, and more.

Secondly, if you decide DPL is the best tool for the job, let DPL cache results! Simply add this line to your DPL query: allowcachedresults = true

Use other tools for common DPL uses

 * Creating simple category lists
 * For creating simple category lists you might use the


 * Random content
 * Use RandomSelection.


 * Lists of Users
 * Use Special:Listusers for this.


 * Advanced uses
 * For more advanced uses, please check that a more specialized extension is not available before using DPL. For example, instead of creating a calendar with DPL use one of the calendar extensions available. If you are unsure or don't see an extension you need, contact us and we'll be happy to help.

Things to avoid
Do not use DPL for:
 * Functions using "randomcount"; they can't be cached
 * Templates that are used site-wide; it creates hidden DPL calls all over the wiki
 * Large queries; they don't display 500 results when 20 will do the job
 * More than one or two queries per page

Common problem workarounds
If you see strange output from DPL, try putting ?action=purge (or &action=purge, if ? is already used) at the end of your URL and reload the URL. This can fix problems where DPL backend code was updated, but the server cache was not refreshed.

Galleries
DPL can be used to make self maintaining galleries:  namespace         = File category          = CategoryNameHere format            = allowcachedresults = true 

Pending Work
DPL can be used to make lists of things that need to be edited:  category          = Stubs format            = ,#%PAGE%\n,, allowcachedresults = true 

DPL can be used to make a list of images that need to be categorized:  namespace = File notcategory = Season 1 notcategory = Season 2 notcategory = Season 3 notcategory = Season 4 format = allowcachedresults = true </DPL>

Replacement Tools
DPL can be used to make replacements when more traditional tools have scaling issues. For example, Special:ListRedirects can't handle more than 5000 redirects, but well formed queries can: Code Lyoko Wiki: Tools: ListRedirects

Further help and feedback
de:Hilfe:DynamicPageList es:Ayuda:Lista de páginas dinámica fr:Aide:DynamicPageList ja:ヘルプ:ダイナミック・ページ・リスト ko:도움말:고급 문서 목록 pt:Ajuda:DynamicPageList ru:Справка:DynamicPageList uk:Довідка:DynamicPageList zh:Help:動態頁面列表