View source for Manual:Extension/DynamicPageList3

{{DISPLAYTITLE:Creating page lists with DPL3}}
The extension '''DynamicPageList3''' allows you to display lists of wiki pages on other pages. In addition, individual page sections from one wiki page can be included (=transcluded) in another page.

==Examples==
You can view a documentation of all selection criteria and formatting options at  [https://dpl3.wikitide.org/wiki/Main_Page the extension's documentation wiki]. 

This help page contains some typical examples as well as a list of common parameters and their values.

===Transcluding page sections===
To display a section of one wiki page on another page, provide the page name (title) and the section header (include) as parameters:
<syntaxhighlight lang="text">
{{#dpl:|title=Manual:Semantic_MediaWiki|include=#Defining attributes}}
</syntaxhighlight>

===List of subpages===
The following code shows the subpages of the current page in a 3-column layout:
<syntaxhighlight lang="text">
{{#dpl:
|titlematch={{PAGENAME}}/%
|shownamespace=false
|replaceintitle=/{{PAGENAME}}\//,
|columns=3
|mode=none
|rowcolformat=width=100%
}}
</syntaxhighlight>
Example: Display the subpages of the page  ''VisualEditor'' in the namespace ''Manual'' in a 1-column layout:<syntaxhighlight lang="text">
{{#dpl:
|titlematch=VisualEditor/%  
|shownamespace=false
|namespace= Manual
|replaceintitle=/VisualEditor\//,
|columns=1
|mode=unordered
|rowcolformat=width=100%
}}
</syntaxhighlight>

<span><br /></span>
'''Output:'''

{{#dpl:
|titlematch=VisualEditor/%
|shownamespace=false
|namespace= Manual
|replaceintitle=/VisualEditor\//,
|columns=1
|mode=unordered
|rowcolformat=width=100%
}}

If you want to limit the output to the first level of subpages, you can add:<syntaxhighlight lang="text">
|nottitlematch={{PAGENAME}}/%/%
</syntaxhighlight>


===Selecting pages by namespace===
<syntaxhighlight lang="text">
{{#dpl:
  |namespace=Manual
  |includesubpages=true
  |shownamespace=false
  |count=5
  |ordermethod=title
}}
</syntaxhighlight>
Output:
{{#dpl:
  |namespace=Manual
  |includesubpages=true
  |shownamespace=false
  |count=5
  |ordermethod=title
 
}}

===== Category format =====
<syntaxhighlight lang="text">
<div class="dplcategory">
{{#dpl:
  |namespace=Manual
  |includesubpages=true
  |shownamespace=false
  |mode=category
  |ordermethod=titlewithoutnamespace
}}
</div>
</syntaxhighlight>

<span><span /><span /><span /><br /></span>'''Output:'''

[[File:DynamicPageList3 categoryoutput.png|alt=Category format|1091x1091px]]

If the sorting letters are displayed at the end of a column, the display can be improved by inserting css declarations on the page ''MediaWiki:Common.css'' :<syntaxhighlight lang="css">
/*dpl column layout - avoid header orphans */
.dplcategory {-webkit-column-count:3;column-count:3;}
.dplcategory .mw-category .mw-category-group {display:block}
.dplcategory .mw-category-group {margin:0 2em 2em 2em;}
.dplcategory .mw-category-group h3 {break-after:avoid}
.dplcategory .mw-category-group h3 {margin:0 0 0.3em; border-bottom:1px solid #e2e2e2}
</syntaxhighlight>'''Improved output:'''

[[File:DynamicPageList3 categoryformatwithcss.png|alt=category format with css|1078x1078px]]



==== Category layout ====


===Selecting pages by category===
<syntaxhighlight lang="text">
{{#dpl:
  |category=Editing
  |addcategories=true
  |includesubpages=true
  |shownamespace=false
  |count=5
  |ordermethod=title
  |mode=ordered  
}}
</syntaxhighlight>
Output:
{{#dpl:
|category=Editing
|addcategories =true
|includesubpages=true
|shownamespace=false
|count=5
|ordermethod=title
|mode=ordered 
}}

===Selecting pages with specific naming patterns===
<syntaxhighlight lang="text">
{{#dpl:
 |namespace=File
 |titlematch=A%
 |count=5
 }}

</syntaxhighlight>Output:{{#dpl:
 |namespace=File
 |titlematch=A%
 |count=5
 }}

<span><br /></span>

<span><br /></span>
==List of common parameters==

===Criteria for page selection===
{| class="wikitable" style="width:100%;"
! style="" |Parameter
! style="" |Syntax
! style="width:380px;" |Description
|-
| style="" |category
| style="" |''<nowiki>|category=QM|Setup...</nowiki>''
| style="width:380px;" |Pages in the category QM OR Setup
|-
| style="" |
| style="" |''<nowiki>|category=QM&Setup&...</nowiki>''
| style="width:380px;" |Pages in the categories QM AND Setup
|-
| style="" |
| style="" |''<nowiki>|category=QM|Setup...|category=Admin</nowiki>''
| style="width:380px;" |Pages in the categories QM OR Setup, and pages in the category Admin
|-
| style="" |notcategory
| style="" |''<nowiki>|notcategory=QM</nowiki>''
| style="width:380px;" |Pages that are not in the category QM
|-
| style="" |categoriesminmax
| style="" |''<nowiki>|category=QM|categoriesminmax=2</nowiki>''
| style="width:380px;" |Pages that are in the category QM and in at least 2 more categories
|-
| style="" |
| style="" |''<nowiki>|category=QM|categoriesminmax=,1</nowiki>''
| style="width:380px;" |Pages that are only in the category QM and in no other category
|-
| style="" |namespace
| style="" |''<nowiki>|namespace=</nowiki>''
| style="width:380px;" |Pages in the namespace (Main)
|-
| style="" |
| style="" |''<nowiki>|namespace=Help|Manual</nowiki>''
| style="width:380px;" |Pages in the namespace Help OR Manual
|-
| style="" |namespacenot
| style="" |''<nowiki>|namespacenot=Help</nowiki>''
| style="width:380px;" |Pages that are not in the namespace Help
|-
| style="" |
| style="" |''<nowiki>|namespacenot={{NAMESPACE}}</nowiki>''
| style="width:380px;" |Pages that are not in the namespace of the current wiki page
|}

===Output-Format===
{| class="wikitable" style="width:100%;" data-ve-attributes="{&quot;style&quot;:&quot;width:100%;&quot;}"
! style="" |Parameter
! style="" |Syntax
! style="width:380px;" data-ve-attributes="{&quot;style&quot;:&quot;width:380px;&quot;}" |Description
|-
| style="" |mode
| style="" |''<nowiki>|mode=ordered</nowiki>''
| style="width:380px;" data-ve-attributes="{&quot;style&quot;:&quot;width:380px;&quot;}" |Unordered list
|-
| style="" |
| style="" |''<nowiki>|mode=unordered</nowiki>''
| style="" |Numbered list
|-
| style="" |
| style="" |<nowiki>|</nowiki>''mode=none''
| style="" |Line breaks
|-
| style="" |
| style="" |<nowiki>|</nowiki>''mode=category''
| style="" |Pages are grouped alphabetically with a letter heading (similar to category pages)
|-
| style="" |
| style="" |''<nowiki>|mode=inline|inlinetext=&amp;nbsp; &amp;bull; &amp;nbsp;</nowiki>''
| style="" |Page names are listed on the same line and separated with a bullet point
|}
===Sorting===
{| class="wikitable" style="width:100%;" data-ve-attributes="{&quot;style&quot;:&quot;width:100%;&quot;}"
! style="" |Parameter
! style="" |Syntax
! style="width:380px;" data-ve-attributes="{&quot;style&quot;:&quot;width:380px;&quot;}" |Description
|-
| style="" |ordermethod
| style="" |''<nowiki>|ordermethod=title</nowiki>''
| style="width:380px;" data-ve-attributes="{&quot;style&quot;:&quot;width:380px;&quot;}" |Ordered by page (prefix+)title
|-
| style="" |
| style="" |''<nowiki>|ordermethod=titlewithoutnamespace</nowiki>''
| style="" |Ordered by page name independent of namespace
|-
| style="" |
| style="" |''<nowiki>|ordermethod=counter</nowiki>''
| style="" |Ordered by number of page views (popularity)
|-
| style="" |
| style="" |''<nowiki>|ordermethod=size</nowiki>''
| style="" |Ordered by page size
|-
| style="" |
| style="" |''<nowiki>|ordermethod=firstedit</nowiki>''
| style="" |Ordered by creation date
|-
| style="" |
| style="" |''<nowiki>|ordermethod=lastedit</nowiki>''
| style="" |Ordered by last edit date
|-
| style="" |
| style="" |''<nowiki>|ordermethod=user,firstedit</nowiki>''
| style="" |Ordered by author, then by creation date
|-
| style="" |
| style="" |''<nowiki>|ordermethod=user,lastedit</nowiki>''
| style="" |Ordered by last editor, then by last edit date
|-
| style="" |order
| style="" |''<nowiki>|order=ascending</nowiki>''
| style="" |Sorted in ascending order
|-
| style="" |
| style="" |''<nowiki>|order=descending</nowiki>''
| style="" |Sorted in descending order
|}

===Display of meta data===
{| class="wikitable" style="width:100%;" data-ve-attributes="{&quot;style&quot;:&quot;width:100%;&quot;}"
! style="" |Parameter
! style="" |Syntax
! style="width:380px;" data-ve-attributes="{&quot;style&quot;:&quot;width:380px;&quot;}" |Description
|-
| style="" |addcategories
| style="" |''<nowiki>|addcategories=true</nowiki>''
| style="width:380px;" data-ve-attributes="{&quot;style&quot;:&quot;width:380px;&quot;}" |Shows all categories of a page after the page name
|-
| style="" |addpagecounter
| style="" |''<nowiki>|category:QM|ordermethod=counter|order=descending</nowiki>''
''|addpagecounter=true|count=5''
| style="" |Shows the 5 most popular pages in the category QM
|-
| style="" |adduser
| style="" |''<nowiki>|category=QM|ordermethod=lastedit|adduser=true</nowiki>''
| style="" |Adds the name of the last editor in front of the page name
|-
| style="" |addauthor
| style="" |''<nowiki>|category=QM|addauthor=true</nowiki>''
| style="" |Adds the name of the original author in front of the page name.
|}

== Disabling automatically generated DPL categories ==
This extension is creating some sometimes unwanted automatic system categories that are then displayed on each wiki page that includes a DPL parser function.

<span><br /></span>
To hide these categories, follow these steps:

# '''Go''' to page ''Special:TrackingCategories'' in your wiki
# '''Click''' on ''dpl-parserfunc-tracking-category'' in the column ''Message name''
# '''Replace''' the text ''Pages using DynamicPageList parser function not wanted'' with a dash ("-"). The category will no longer be displayed on your wiki pages.
# '''Save''' the page.
The system category is no longer displayed on your wiki pages.

See also: https://www.mediawiki.org/wiki/Help:Tracking%20categories

<span><br /></span>

{{translation}}
[[Category:Organization]]
[[Category:Customization]]