Tags: Visual edit Help |
m (Replacing old tags, i.e. tt --> code) Tag: Help |
||
(15 intermediate revisions by 8 users not shown) | |||
Line 1: | Line 1: | ||
+ | {{Extension infobox |
||
− | {{Available on request}} |
||
+ | | name = DynamicPageList |
||
+ | | version = 3.3.3 |
||
+ | | author = |
||
+ | * Gero Scholz |
||
+ | * Alexia E. Smith |
||
+ | | link = |
||
+ | * [[w:c:help:Extension:DPL3|Gamepedia Help Wiki]] |
||
+ | * [[mw:Extension:DynamicPageList3|MediaWiki.org]] |
||
+ | * [https://gitlab.com/hydrawiki/extensions/DynamicPageList GitLab] |
||
+ | | desc = {{int:dpl-desc}} |
||
+ | | default = request |
||
+ | }} |
||
{{Tocright}} |
{{Tocright}} |
||
'''DPL''', also known as the '''Dynamic Page List''' extension, is a powerful [[Help:MediaWiki|MediaWiki]] extension that allows for the creation of lists of pages using various criteria, such as membership in a [[Help:Category|category]] or inclusion of a specific [[Help:Templates|template]]. These lists are considered ''dynamic'' because they automatically update as users add categories to pages. |
'''DPL''', also known as the '''Dynamic Page List''' extension, is a powerful [[Help:MediaWiki|MediaWiki]] extension that allows for the creation of lists of pages using various criteria, such as membership in a [[Help:Category|category]] or inclusion of a specific [[Help:Templates|template]]. These lists are considered ''dynamic'' because they automatically update as users add categories to pages. |
||
Line 7: | Line 19: | ||
Because of its great power, DPL increases server load and can result in significantly slower page loads for wikis that use it. And because DPL has numerous parameters and applications, we can't reasonably hope to explain it on a single help page. Therefore, Fandom strongly encourages you to pay special attention to a couple of sections of this article: "'''[[#Using DPL effectively|Using DPL effectively]]'''" and "'''[[#More about DPL|More about DPL]]'''". |
Because of its great power, DPL increases server load and can result in significantly slower page loads for wikis that use it. And because DPL has numerous parameters and applications, we can't reasonably hope to explain it on a single help page. Therefore, Fandom strongly encourages you to pay special attention to a couple of sections of this article: "'''[[#Using DPL effectively|Using DPL effectively]]'''" and "'''[[#More about DPL|More about DPL]]'''". |
||
+ | Fandom is using [[mw:Extension:DynamicPageList3|DynamicPageList3]]. You can find the [[w:c:Help:Extension:DPL3/Manual|full manual here]]. |
||
− | == [[Help%3AUnified_Community_Platform|UCP]] == |
||
− | With the migration to the UCP, the version of DynamicPageList is changing from [https://www.mediawiki.org/wiki/Extension:DynamicPageList_(third-party) DynamicPageList (third-party)] to [https://www.mediawiki.org/wiki/Extension:DynamicPageList3 DynamicPageList3]. |
||
== Benefits of DPL == |
== Benefits of DPL == |
||
Line 23: | Line 34: | ||
<pre> |
<pre> |
||
− | < |
+ | <dpl> |
category = Characters |
category = Characters |
||
− | </ |
+ | </dpl> |
</pre> |
</pre> |
||
Line 33: | Line 44: | ||
<pre> |
<pre> |
||
− | < |
+ | <dpl> |
category = Characters |
category = Characters |
||
notcategory = Season 1 Characters |
notcategory = Season 1 Characters |
||
namespace = Character |
namespace = Character |
||
mode = ordered |
mode = ordered |
||
− | </ |
+ | </dpl> |
</pre> |
</pre> |
||
Line 46: | Line 57: | ||
DPL can cause heavy server loads, slowing the entire site down. The following are tips on how to get around the problem. |
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 |
+ | First, consider whether your DPL usage is necessary. If you just want a list of the members of a category, then a link to the category page will do. 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 [[Help:Calendar|calendar]], [[Help:Videos|embedded video]], and more. |
Secondly, if you decide DPL is the best tool for the job, <u>let DPL cache results!</u> Simply add this line to your DPL query: |
Secondly, if you decide DPL is the best tool for the job, <u>let DPL cache results!</u> Simply add this line to your DPL query: |
||
<pre>allowcachedresults = true</pre> |
<pre>allowcachedresults = true</pre> |
||
+ | |||
+ | (Note: due to excessive server load, this option is always set to true, regardless of user input. In order to update the cache to see fresh results, you will need to [[Help:Purge|purge]] the page cache.) |
||
=== Use other tools for common DPL uses === |
=== Use other tools for common DPL uses === |
||
;Creating simple category lists |
;Creating simple category lists |
||
− | :For creating simple category lists you might use the <nowiki><categorytree></nowiki> tag ([[mw:Extension:CategoryTree#The <categorytree> tag|documentation]]). For instance, to get a list of pages in the category 'Community' consider the following:<pre><nowiki><categorytree mode="pages" hideroot=on>Community</categorytree></nowiki></pre> |
+ | :For creating simple category lists you might use the [[Help:CategoryTree|<nowiki><categorytree></nowiki> tag]] ([[mw:Extension:CategoryTree#The <categorytree> tag|documentation]]). For instance, to get a list of pages in the category 'Community' consider the following:<pre><nowiki><categorytree mode="pages" hideroot="on">Community</categorytree></nowiki></pre> |
;Random content |
;Random content |
||
Line 63: | Line 76: | ||
;Wiki-style forums |
;Wiki-style forums |
||
− | :See [[Help:Wiki-style forums]] for the <code><nowiki><forum>…</forum></nowiki></code> syntax. |
+ | :See [[Help:Wiki-style forums]] for the <code><nowiki><forum>…</forum></nowiki></code> syntax. This uses DPL behind the scenes but with functionality customized to making a wiki-page based Forum system. |
;Advanced uses |
;Advanced uses |
||
Line 69: | Line 82: | ||
=== Things to avoid === |
=== Things to avoid === |
||
+ | Please avoid overusing: |
||
− | Do not use DPL for: |
||
* Functions using "randomcount"; they can't be cached |
* Functions using "randomcount"; they can't be cached |
||
* Templates that are used site-wide; it creates hidden DPL calls all over the wiki |
* Templates that are used site-wide; it creates hidden DPL calls all over the wiki |
||
Line 76: | Line 89: | ||
== Sometimes you need to purge == |
== Sometimes you need to purge == |
||
− | If you see strange output from DPL, try putting < |
+ | If you see strange or outdated output from DPL, try putting <code>?action=purge</code> (or <code>&action=purge</code>, if <code>?</code> is already used) at the end of your URL and reload the URL. This will force a server cache flush for the page |
== Common uses for DPL == |
== Common uses for DPL == |
||
Line 82: | Line 95: | ||
DPL can be used to make self maintaining galleries: |
DPL can be used to make self maintaining galleries: |
||
− | <pre>< |
+ | <pre><dpl> |
namespace = File |
namespace = File |
||
category = CategoryNameHere |
category = CategoryNameHere |
||
format = <gallery widths="150" spacing="small">,%PAGE%\n,,</gallery> |
format = <gallery widths="150" spacing="small">,%PAGE%\n,,</gallery> |
||
allowcachedresults = true |
allowcachedresults = true |
||
− | </ |
+ | </dpl></pre> |
− | If you are using the parser function, you must use [ |
+ | If you are using the parser function version of DPL, you must use [[mw:Extension talk:DynamicPageList3#Gallery_tag_stops_the_processing_of_Format_special_symbols|this fix]] to output into galleries. |
=== Pending work === |
=== Pending work === |
||
DPL can be used to make lists of things that need to be edited: |
DPL can be used to make lists of things that need to be edited: |
||
− | <pre>< |
+ | <pre><dpl> |
category = Stubs |
category = Stubs |
||
format = ,#%PAGE%\n,, |
format = ,#%PAGE%\n,, |
||
allowcachedresults = true |
allowcachedresults = true |
||
− | </ |
+ | </dpl></pre> |
DPL can be used to make a list of images that need to be categorized: |
DPL can be used to make a list of images that need to be categorized: |
||
− | <pre>< |
+ | <pre><dpl> |
namespace = File |
namespace = File |
||
notcategory = Season 1 |
notcategory = Season 1 |
||
Line 110: | Line 123: | ||
format = <gallery widths="150" spacing="small">,%PAGE%\n,,</gallery> |
format = <gallery widths="150" spacing="small">,%PAGE%\n,,</gallery> |
||
allowcachedresults = true |
allowcachedresults = true |
||
− | </ |
+ | </dpl></pre> |
== Notes == |
== Notes == |
||
Line 117: | Line 130: | ||
== More about DPL == |
== More about DPL == |
||
− | * [ |
+ | * [[w:c:Help:Extension:DPL3/Manual|The DPL 3 Manual on Gamepedia]] |
+ | * [[/Conversion cheat sheet|FAQ on converting legacy DPL functions to UCP]] |
||
− | * [http://followthescore.org/dpldemo/ The DPL Manual], which includes a comprehensive list of all DPL parameters (legacy version) |
||
+ | * [https://followthescore.org/dpldemo/index.php?title=DPL:Manual The Manual for the version used by Fandom before UCP] |
||
* [https://web.archive.org/web/20161105221036/http://semeb.com/dpldemo/DPL:Manual The archived DPL Manual] |
* [https://web.archive.org/web/20161105221036/http://semeb.com/dpldemo/DPL:Manual The archived DPL Manual] |
||
⚫ | |||
− | * [[mw:Extension:DynamicPageList (third-party)|MediaWiki.org's page about the extension itself]] |
||
⚫ | |||
== Further help and feedback == |
== Further help and feedback == |
||
{{Help and feedback section}} |
{{Help and feedback section}} |
||
− | [[be: |
+ | [[be:Help:DynamicPageList]] |
[[de:Hilfe:DynamicPageList]] |
[[de:Hilfe:DynamicPageList]] |
||
[[es:Ayuda:Lista de páginas dinámica]] |
[[es:Ayuda:Lista de páginas dinámica]] |
Revision as of 14:26, 17 June 2021
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. These lists are considered dynamic because they automatically update as users add categories to pages.
For instance, if you wanted to find out all the episodes of The West Wing that were written by Aaron Sorkin and that guest-starred Hal Holbrook, DPL could tell you in a flash. Or if you needed to answer the question, "Are there any civilian half-human Vulcans in Star Trek?" DPL could help find those people who were in Category:Vulcans and Category:Half-humans but not Category:Starfleet officers.
Because of its great power, DPL increases server load and can result in significantly slower page loads for wikis that use it. And because DPL has numerous parameters and applications, we can't reasonably hope to explain it on a single help page. Therefore, Fandom strongly encourages you to pay special attention to a couple of sections of this article: "Using DPL effectively" and "More about DPL".
Fandom is using DynamicPageList3. You can find the full manual here.
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 data 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 <dpl>
tag and close with the </dpl>
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 parser function version {{#dpl: .... }}
if you need to have parser functions in the DPL parameters expanded before the query is made. You need to use the "source" editor mode to create DPL queries, see Help:Source edit mode for information on how to access "source" mode in your preferred editor.
Here is a very basic DPL query example:
<dpl> category = Characters </dpl>
This query above will output a list of all the pages that are in the category Characters.
This can be further customized:
<dpl> category = Characters notcategory = Season 1 Characters namespace = Character mode = ordered </dpl>
This query will 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 will also be printed as an ordered list (<ol>) as opposed to the default unordered list (<ul>).
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 you just want a list of the members of a category, then a link to the category page will do. 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 calendar, 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
(Note: due to excessive server load, this option is always set to true, regardless of user input. In order to update the cache to see fresh results, you will need to purge the page cache.)
Use other tools for common DPL uses
- Creating simple category lists
- For creating simple category lists you might use the <categorytree> tag (documentation). For instance, to get a list of pages in the category 'Community' consider the following:
<categorytree mode="pages" hideroot="on">Community</categorytree>
- Random content
- Use RandomSelection.
- Lists of users
- Use Special:Listusers for this.
- Wiki-style forums
- See Help:Wiki-style forums for the
<forum>…</forum>
syntax. This uses DPL behind the scenes but with functionality customized to making a wiki-page based Forum system.
- 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
Please avoid overusing:
- 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; don't display 500 results when 20 will do the job
- More than one or two queries per page
Sometimes you need to purge
If you see strange or outdated 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 will force a server cache flush for the page
Common uses for DPL
Galleries
DPL can be used to make self maintaining galleries:
<dpl> namespace = File category = CategoryNameHere format = <gallery widths="150" spacing="small">,%PAGE%\n,,</gallery> allowcachedresults = true </dpl>
If you are using the parser function version of DPL, you must use this fix to output into galleries.
Pending work
DPL can be used to make lists of things that need to be edited:
<dpl> category = Stubs format = ,#%PAGE%\n,, allowcachedresults = true </dpl>
DPL can be used to make a list of images that need to be categorized:
<dpl> namespace = File notcategory = Season 1 notcategory = Season 2 notcategory = Season 3 notcategory = Season 4 format = <gallery widths="150" spacing="small">,%PAGE%\n,,</gallery> allowcachedresults = true </dpl>
Notes
- Fandom does not support the use of features based on a page's view count.
- Both the DPL cache and the page's server cache must be updated in order for changes to be reflected.
More about DPL
- The DPL 3 Manual on Gamepedia
- FAQ on converting legacy DPL functions to UCP
- The Manual for the version used by Fandom before UCP
- The archived DPL Manual
- Memory Alpha's entirely original help page, which includes a number of Fandom-relevant examples of DPL usage.
Further help and feedback
- Browse and search other help pages at Help:Contents
- Check Fandom Community Central for sources of further help and support
- Check Contacting Fandom for how to report any errors or unclear steps in this article