This wiki has been automatically Anonymous user
Main Page: Difference between revisions
m
Swap out the manual page for main page, will redirect manual page to main page until all the links are updated
(Create main page) |
imported>FrozenPlum m (Swap out the manual page for main page, will redirect manual page to main page until all the links are updated) |
||
Line 1:
{{note|This page is in development, some content may be incorrect, outdated, or otherwise misleading. Formatting styles are also missing, see [[DynamicPageList3_Manual:Feedback|this page]]. |warn}}
{{DPL manual|section=|subsection=}}
'''DynamicPageList3''' (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. DPL3 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, DPL3 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.
==Installation==
See the [[mw:Extension:DynamicPageList3#Installation|DynamicPageList3 MediaWiki Extension]] page for installation details.
== 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.
* See [[mw:Extension:DynamicPageList3#Configuration|DPL3 configuration]] on MediaWiki for a list of configuration options.
===Limiting results and resource consumption===
To prevent a DPL3 query from returning huge output (or consuming too many resources such as CPU or causing database load). The higher functional the following configuration variables are noteworthy:
* <code>$wgDplSettings['maxQueryTime']</code> – Limits the amount of time (in milliseconds) allowed for database queries.
* <code>$wgDplSettings['maxCategoryCount']</code> – Limits the number of categories allowed in queries ('''default''' is 4).
* <code>$wgDplSettings['maxResultCount']</code> – Limits the number of results returned in a query ('''default''' is 500).
* <code>$wgDplSettings['runFromProtectedPagesOnly']</code> – 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. Higher levels of functionality should be considered carefully and used sparingly.
* <code>$wgDplSettings['functionalRichness'] = 0</code> – Provides functionality equivalent to Wikimedia's [[mw:Extension:DynamicPageList (Wikimedia)|DynamicPageList]] (also known as Intersection).
* <code>$wgDplSettings['functionalRichness'] = 1</code> – Adds additional parameters for formatting.
* <code>$wgDplSettings['functionalRichness'] = 2</code> – Adds features (performance equivalent) for [[mw:Manual:Pagelinks_table|pagelinks]] and templates.
* <code>$wgDplSettings['functionalRichness'] = 3</code> – Allows more-expensive inclusion features, such as queries on revision level, and regular expression queries ('''default''').
* <code>$wgDplSettings['functionalRichness'] = 4</code> – Permits potentially dangerous and exotic batch delete and update operations; not recommended for public websites. Also includes extra debugging parameters for development and testing.
{{note|'''Important:''' Some levels of functional richness can cause high database or CPU load, and should be carefully considered.|warn}}
== Usage ==
* [[General usage and invocation syntax|General usage and invocation syntax]]
== Primary DPL3 module ==
These sections contain documentation on DPL3's primary module, <code><nowiki>{{#dpl: ... }}</nowiki></code>. This is the DPL3 functionality used most often, and has a wide range of powerful coding options.
* [[Criteria for page selection|Criteria for page selection]]
* [[Controlling output format|Controlling output format]]
* [[Controlling output order|Controlling output order]]
* [[Controlling output volume|Controlling output volume]]
* [[Other parameters|Other parameters]]
== Complete DPL3 Manual Table of Contents ==
For the legacy Table of Contents, see [[Parameter Quick Reference]].
== Other DPL3 modules ==
These sections detail some additional functions provided by the DPL3 extension.
* [[Dplchapter|<nowiki>{{#dplchapter: ... }}</nowiki>]]
* [[Dplvar|<nowiki>{{#dplvar: ... }}</nowiki>]]
* [[Dplreplace|<nowiki>{{#dplreplace: ... }}</nowiki>]]
* [[Dplnum|<nowiki>{{#dplnum: ... }}</nowiki>]]
* [[Dplmatrix|<nowiki>{{#dplmatrix: ... }}</nowiki>]]
== Notes ==
* [[Compatibility|Compatibility with previous versions]]
* [[Bug reporting and feature requests|Bug reporting and feature requests]]
== Examples ==
See [[Examples]] for a complete list of examples.
[[Category:Manual]]
| |||