Manual: Difference between revisions

From DynamicPageList3 Manual
Content added Content deleted
imported>FrozenPlum
m (31 revisions imported: Imported from help.fandom.com, Extension:DPL3 pages, which are for the obsolete version of DPL3 extension for MediaWiki 1.33, to adapt to forked (newer) extension version.)
imported>FrozenPlum
m (Putting things back where they were before making public again)
Line 1: 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=}}
{{DPL manual|section=|subsection=}}


'''DynamicPageList3''' (DPL/DPL3) is a powerful MediaWiki [[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 and statistics gathered from them, for display in a wiki page. DPL lists are automatically updated whenever said data changes.


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.
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.


== Usage ==
== Usage ==
* [[Extension:DPL3/General usage and invocation syntax|General usage and invocation syntax]]
* [[General usage and invocation syntax|General usage and invocation syntax]]


== Primary DPL module ==
== Primary DPL module ==
These sections contain documentation on DPL's primary module, <code><nowiki>{{#dpl: ... }}</nowiki></code>. This is the DPL functionality used most often, and has a wide range of powerful coding options.
These sections contain documentation on DPL's primary module, <code><nowiki>{{#dpl: ... }}</nowiki></code>. This is the DPL functionality used most often, and has a wide range of powerful coding options.
* [[Extension:DPL3/Parameters: Criteria for page selection|Criteria for page selection]]
* [[Criteria for page selection|Criteria for page selection]]
* [[Extension:DPL3/Parameters: Controlling output format|Controlling output format]]
* [[Controlling output format|Controlling output format]]
* [[Extension:DPL3/Parameters: Controlling output order|Controlling output order]]
* [[Controlling output order|Controlling output order]]
* [[Extension:DPL3/Parameters: Controlling output volume|Controlling output volume]]
* [[Controlling output volume|Controlling output volume]]
* [[Extension:DPL3/Parameters: Other parameters|Other parameters]]
* [[Other parameters|Other parameters]]


== Complete DPL Manual Table of Contents ==
== Complete DPL Manual Table of Contents ==
For the legacy Table of Contents, see [[Parameter Quick Reference]].
Below is the legacy Table of Contents provided as navigation in the original DPL documentation. It is an expansive, cross-referenced list of DPL parameters (which some find daunting and others find helpful). Its links can all be found via the pages listed above, however the table below may be useful to more easily find what you need, especially if you don't know which section your desired functionality might be located in (expand the table below and use your browser's Find In Page feature, usually <code>Ctrl-F</code>).

{{collapse top|Click to reveal legacy DPL Manual Table of Contents|Click to hide the Table of Contents}}
<DPL>
namespace = Extension
uses = Template:DPL parameter
mode = userformat
replaceintitle = @DPL Manual/@,
include = {DPL Manual}:[[%PAGE%|%TITLE%]],{DPL parameter}/dpl
listseparators={|class=wikitable,\n|-\n|,,\n|}
secseparators=,,\n|\n{|class="wikitable sortable" width=100%\n!width=140px|name\n!purpose\n|-\n|,\n|}
multisecseparators=,\n|-\n|
allowcachedresults = true
</DPL>
{{collapse bottom}}


== Other DPL modules ==
== Other DPL modules ==
These sections detail some additional functions provided by the DPL extension.
These sections detail some additional functions provided by the DPL extension.
* [[Extension:DPL3/Dplchapter|<nowiki>{{#dplchapter: ... }}</nowiki>]]
* [[Dplchapter|<nowiki>{{#dplchapter: ... }}</nowiki>]]
* [[Extension:DPL3/Dplvar|<nowiki>{{#dplvar: ... }}</nowiki>]]
* [[Dplvar|<nowiki>{{#dplvar: ... }}</nowiki>]]
* [[Extension:DPL3/Dplreplace|<nowiki>{{#dplreplace: ... }}</nowiki>]]
* [[Dplreplace|<nowiki>{{#dplreplace: ... }}</nowiki>]]
* [[Extension:DPL3/Dplnum|<nowiki>{{#dplnum: ... }}</nowiki>]]
* [[Dplnum|<nowiki>{{#dplnum: ... }}</nowiki>]]
* [[Extension:DPL3/Dplmatrix|<nowiki>{{#dplmatrix: ... }}</nowiki>]]
* [[Dplmatrix|<nowiki>{{#dplmatrix: ... }}</nowiki>]]


== Notes ==
== Notes ==
* [[Extension:DPL3/Compatibility|Compatibility with previous versions]]
* [[Compatibility|Compatibility with previous versions]]
* [[Extension:DPL3/Bug reporting and feature requests|Bug reporting and feature requests]]
* [[Bug reporting and feature requests|Bug reporting and feature requests]]


== Examples ==
== Examples ==
=== Selecting articles ===
=== Selecting articles ===
* [[Extension:DPL3/Example: Select by category|By category]]
* [[Example: Select by category|By category]]
* [[Extension:DPL3/Example: Select by recently changed|By recently changed]]
* [[Example: Select by recently changed|By recently changed]]


=== Show article's context or contents ===
=== Show article's context or contents ===
* [[Extension:DPL3/Example: Related to article|Pages, templates, images, or categories related to an article]]
* [[Example: Related to article|Pages, templates, images, or categories related to an article]]
* [[Extension:DPL3/Example: Display images used|Display all images used in an article]]
* [[Example: Display images used|Display all images used in an article]]


=== Controlling output ===
=== Controlling output ===
* [[Extension:DPL3/Example: Show templates parameters from an article|Show templates parameters from an article]]
* [[Example: Show templates parameters from an article|Show templates parameters from an article]]
* [[Extension:DPL3/Example: Show sections from an article|Show sections from an article]]
* [[Example: Show sections from an article|Show sections from an article]]
[[Category:Manual]]

[[pt:DPL:Manual]]

[[Category:DPL3| ]]
[[Category:Extensions]]

<!-- Extension prefix in other languages:

[[de:Erweiterung:{{subst:BASEPAGENAME}}]]
[[es:Extensión:{{subst:BASEPAGENAME}}]]
[[fr:Extension:{{subst:BASEPAGENAME}}]]
[[it:Estensione:{{subst:BASEPAGENAME}}]]
[[nl:Uitbreiding:{{subst:BASEPAGENAME}}]]
[[pl:Rozszerzenie:{{subst:BASEPAGENAME}}]]
[[pt:Extensão:{{subst:BASEPAGENAME}}]]
[[ru:Расширение:{{subst:BASEPAGENAME}}]]
[[zh:扩展:{{subst:BASEPAGENAME}}]]
-->

Revision as of 01:38, 29 March 2022

This page is in development, some content may be incorrect, outdated, or otherwise misleading. Formatting styles are also missing, see this page.
Manual

DynamicPageList3 (DPL/DPL3) is a powerful MediaWiki 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.

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.

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.

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.

Notes

Examples

Selecting articles

Show article's context or contents

Controlling output