Manual:Extension/DynamicPageList3: Difference between revisions

No edit summary
Tag: 2017 source edit
No edit summary
Tag: 2017 source edit
 
(6 intermediate revisions by the same user not shown)
Line 7: Line 7:
This help page contains some typical examples as well as a [[Manual:Extension/DynamicPageList3#List of common parameters and their values|list of common parameters and their values]].
This help page contains some typical examples as well as a [[Manual:Extension/DynamicPageList3#List of common parameters and their values|list of common parameters and their values]].


==Transcluding page sections==
===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:
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">
<syntaxhighlight lang="text">
Line 25: Line 25:
}}
}}
</syntaxhighlight>
</syntaxhighlight>
Example: Display the subpages of the page  ''VisualEditor'' imn the namespace ''Manual'' in a 1-column layout:<syntaxhighlight lang="text">
Example: Display the subpages of the page  ''VisualEditor'' in the namespace ''Manual'' in a 1-column layout:<syntaxhighlight lang="text">
{{#dpl:
{{#dpl:
|titlematch=VisualEditor/%   
|titlematch=VisualEditor/%   
Line 32: Line 32:
|replaceintitle=/VisualEditor\//,
|replaceintitle=/VisualEditor\//,
|columns=1
|columns=1
|mode=ubordered
|mode=unordered
|rowcolformat=width=100%
|rowcolformat=width=100%
}}
}}
</syntaxhighlight>
</syntaxhighlight>


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


Line 49: Line 49:
|rowcolformat=width=100%
|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>




Line 70: Line 74:
   
   
}}
}}
===== 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===
===Selecting pages by category===
<syntaxhighlight lang="text">
<syntaxhighlight lang="text">
{{#dpl:
{{#dpl:
   |category=QM
   |category=Editing
   |addcategories = true
   |addcategories=true
   |includesubpages=true
   |includesubpages=true
   |shownamespace=false
   |shownamespace=false
Line 84: Line 122:
Output:
Output:
{{#dpl:
{{#dpl:
|category=QM
|category=Editing
|addcategories = true
|addcategories =true
|includesubpages=true
|includesubpages=true
|shownamespace=false
|shownamespace=false
|count=5
|count=5
|ordermethod=title
|ordermethod=title
|mode=ordered
|mode=ordered  
}}
}}


Line 108: Line 145:
  }}
  }}


<span><br /></span>


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


Line 255: Line 292:
|''<nowiki>|category=QM|addauthor=true</nowiki>''
|''<nowiki>|category=QM|addauthor=true</nowiki>''
|Adds the name of the original author in front of the page name.
|Adds the name of the original author in front of the page name.
|}<br />
|}
 
== 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>


{{Box Links-en|Topic1=[[Reference:DynamicPageList3]]}}


[[en:{{FULLPAGENAME}}]]
[[en:{{FULLPAGENAME}}]]

Latest revision as of 11:16, 8 February 2023

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

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:

{{#dpl:|title=Manual:Semantic_MediaWiki|include=#Defining attributes}}

List of subpages

The following code shows the subpages of the current page in a 3-column layout:

{{#dpl:
|titlematch={{PAGENAME}}/%
|shownamespace=false
|replaceintitle=/{{PAGENAME}}\//,
|columns=3
|mode=none
|rowcolformat=width=100%
}}

Example: Display the subpages of the page VisualEditor in the namespace Manual in a 1-column layout:

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


Output:


If you want to limit the output to the first level of subpages, you can add:

|nottitlematch={{PAGENAME}}/%/%


Selecting pages by namespace

{{#dpl:
  |namespace=Manual
  |includesubpages=true
  |shownamespace=false
  |count=5
  |ordermethod=title
}}

Output:

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


Output:

Category format

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 :

/*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}

Improved output:

category format with css


Category layout

Selecting pages by category

{{#dpl:
  |category=Editing
  |addcategories=true
  |includesubpages=true
  |shownamespace=false
  |count=5
  |ordermethod=title
  |mode=ordered  
}}

Output:

  1. Create Pages . . Categories: Editing
  2. Create pages . . Categories: Editing
  3. Delete article . . Categories: Editing
  4. Extension/BlueSpiceCategoryCheck . . Categories: Advanced | Editing
  5. Extension/BlueSpiceContextMenu . . Categories: Editing

Selecting pages with specific naming patterns

{{#dpl:
 |namespace=File
 |titlematch=A%
 |count=5
 }}

Output:



List of common parameters

Criteria for page selection

Parameter Syntax Description
category |category=QM|Setup... Pages in the category QM OR Setup
|category=QM&Setup&... Pages in the categories QM AND Setup
|category=QM|Setup...|category=Admin Pages in the categories QM OR Setup, and pages in the category Admin
notcategory |notcategory=QM Pages that are not in the category QM
categoriesminmax |category=QM|categoriesminmax=2 Pages that are in the category QM and in at least 2 more categories
|category=QM|categoriesminmax=,1 Pages that are only in the category QM and in no other category
namespace |namespace= Pages in the namespace (Main)
|namespace=Help|Manual Pages in the namespace Help OR Manual
namespacenot |namespacenot=Help Pages that are not in the namespace Help
|namespacenot={{NAMESPACE}} Pages that are not in the namespace of the current wiki page

Output-Format

Parameter Syntax Description
mode |mode=ordered Unordered list
|mode=unordered Numbered list
|mode=none Line breaks
|mode=category Pages are grouped alphabetically with a letter heading (similar to category pages)
|mode=inline|inlinetext=&nbsp; &bull; &nbsp; Page names are listed on the same line and separated with a bullet point

Sorting

Parameter Syntax Description
ordermethod |ordermethod=title Ordered by page (prefix+)title
|ordermethod=titlewithoutnamespace Ordered by page name independent of namespace
|ordermethod=counter Ordered by number of page views (popularity)
|ordermethod=size Ordered by page size
|ordermethod=firstedit Ordered by creation date
|ordermethod=lastedit Ordered by last edit date
|ordermethod=user,firstedit Ordered by author, then by creation date
|ordermethod=user,lastedit Ordered by last editor, then by last edit date
order |order=ascending Sorted in ascending order
|order=descending Sorted in descending order

Display of meta data

Parameter Syntax Description
addcategories |addcategories=true Shows all categories of a page after the page name
addpagecounter |category:QM|ordermethod=counter|order=descending

|addpagecounter=true|count=5

Shows the 5 most popular pages in the category QM
adduser |category=QM|ordermethod=lastedit|adduser=true Adds the name of the last editor in front of the page name
addauthor |category=QM|addauthor=true 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.


To hide these categories, follow these steps:

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

The system category is no longer displayed on your wiki pages.

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




To submit feedback about this documentation, visit our community forum.