This wiki has been automatically Manual: Difference between revisions
imported>FrozenPlum m (Move references to configuration, functional richness, resource consumption etc., to the expected location (users would not generally think to look for such information under specific params, will link from those params to this info)) |
imported>FrozenPlum (Tweak the description, as I've spoken to a number of users that still think that DPL3 can only be used to create lists, and while this is technically true, it is also untrue because there's a number of ways to have it appear to do other things (people don't realize that galleries are also technically lists, and don't think of tables as lists etc)) |
||
| Line 2: | Line 2: | ||
{{DPL manual|section=|subsection=}} |
{{DPL manual|section=|subsection=}} |
||
'''DynamicPageList3''' (DPL/DPL3) is a powerful MediaWiki [[meta:extension|extension]] that can generate lists of pages, and/or certain data and statistics gathered from them, for display in a wiki page. DPL lists are automatically updated whenever said data changes. |
'''DynamicPageList3''' (DPL/DPL3) is a powerful MediaWiki [[meta:extension|extension]] that can generate lists of pages, and/or certain data sets and statistics gathered from them, for display in a wiki page. DPL lists (the default output) are automatically updated whenever said data changes. The output can be extensively formatted (though use of templates or in-query formatting) to create a range of information displays, from lists to in-line paragraph content, tables, galleries, navigation and other possibilities. |
||
As a basic example, DPL can be used to insert, in a wiki page, an always-current list of all pages of a particular [[mw:Help:category|category]]. The data displayed may be selected and sorted based on factors like author, namespace, date, name pattern, usage of templates, or references to other articles, with a variety of custom formatting possibilities. |
As a basic example, DPL can be used to insert, in a wiki page, an always-current list of all pages of a particular [[mw:Help:category|category]]. The data displayed may be selected and sorted based on factors like author, namespace, date, name pattern, usage of templates, or references to other articles, with a variety of custom formatting possibilities. |
||
Revision as of 00:46, 24 June 2022
| ||||||||||||||
| Manual |
DynamicPageList3 (DPL/DPL3) is a powerful MediaWiki extension that can generate lists of pages, and/or certain data sets and statistics gathered from them, for display in a wiki page. DPL lists (the default output) are automatically updated whenever said data changes. The output can be extensively formatted (though use of templates or in-query formatting) to create a range of information displays, from lists to in-line paragraph content, tables, galleries, navigation and other possibilities.
As a basic example, DPL can be used to insert, in a wiki page, an always-current list of all pages of a particular category. The data displayed may be selected and sorted based on factors like author, namespace, date, name pattern, usage of templates, or references to other articles, with a variety of custom formatting possibilities.
Configuration
DPL3 has a variety of configuration settings that can be used, as well as a number of defaults that are important to note. Settings should be defined before enabling the extension.
- Please see DPL3 configuration on MediaWiki for a full list of possible configuration options.
Limiting results and resource consumption
To prevent a DPL3 query from returning huge output (or consuming too many resources) the following configuration variables are noteworthy:
$wgDplSettings['maxQueryTime']– Limits the amount of time (in milliseconds) allowed for database queries.$wgDplSettings['maxCategoryCount']– Limits the number of categories allowed in queries (default is 4).$wgDplSettings['maxResultCount']– Limits the number of results returned in a query (default is 500).$wgDplSettings['runFromProtectedPagesOnly']– Causes DPL3 to only run from protected pages (if set to true), which can aid administrators having problems with malicous user activity resulting in computationally expensive queries.
Functional richness
DynamicPageList3 has different levels of functional richness, which can be configured as needed.
$wgDplSettings['functionalRichness'] = 0– Provides functionality equivalent to Wikimedia's DynamicPageList (also known as Intersection).$wgDplSettings['functionalRichness'] = 1– Adds additional parameters for formatting.$wgDplSettings['functionalRichness'] = 2– Adds features (performance equivalent) for pagelinks and templates.$wgDplSettings['functionalRichness'] = 3– Allows more-expensive inclusion features, such as queries on revision level, and regular expression queries (default).$wgDplSettings['functionalRichness'] = 4– Permits potentially dangerous and exotic batch delete and update operations; not recommended for public websites. Also includes extra debugging parameters for development and testing.
Usage
Primary DPL module
These sections contain documentation on DPL's primary module, {{#dpl: ... }}. This is the DPL functionality used most often, and has a wide range of powerful coding options.
- Criteria for page selection
- Controlling output format
- Controlling output order
- Controlling output volume
- Other parameters
Complete DPL Manual Table of Contents
For the legacy Table of Contents, see Parameter Quick Reference.
Other DPL modules
These sections detail some additional functions provided by the DPL extension.
- {{#dplchapter: ... }}
- {{#dplvar: ... }}
- {{#dplreplace: ... }}
- {{#dplnum: ... }}
- {{#dplmatrix: ... }}
Notes
Examples
See Examples for a complete list of examples.