Difference between revisions of "Manual:Extension/DynamicPageList3"

[quality revision][quality revision]
(Tag: 2017 source edit)
(Tag: 2017 source edit)
 


The extension DynamicPageList3 allows you to include lists of wiki pages on any content page.

Application examples[edit | edit source]

You can view a documentation of all selection criteria and formatting options at Gamepedia.

This help page contains some examples of typical applications for this extension as well as a selection of possible parameters and their values.


Selecting pages by namespace[edit | edit source]

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

                

Output:

Selecting pages by category[edit | edit source]

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

                

Output:

Extension:DynamicPageList (DPL), version 3.2.1: Warning: No results.

Selecting pages with specific naming patterns[edit | edit source]

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

                
Output:
Extension:DynamicPageList (DPL), version 3.2.1: Warning: Skipping bad option 'Datei' for parameter 'namespace'.

List of common paramters[edit | edit source]

Criteria for page selection[edit | edit source]

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[edit | edit source]

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=  •   Page names are listed on the same line and separated with a bullet point

SortieingSorting[edit | edit source]

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[edit | edit source]

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.


Related info

{{DISPLAYTITLE:Creating page lists with DPL3}}
        

        The extension '''DynamicPageList3''' allows you to include lists of wiki pages on any content page.
        

        ==Application examples==
        
        You can view a documentation of all selection criteria and formatting options at [https://help.gamepedia.com/Extension:DPL3 Gamepedia]. 
        

        This help page contains some examples of typical applications for this extension as well as a selection of possible parameters and their values.
        
<br />
        
        ===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
        

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

        }}
        

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

        ==List of common paramters==
        

        ===Criteria for page selection===
        
        {| class="wikitable" style="width:100%;"
        
        !Parameter
        
        !Syntax
        
        ! style="width:380px;" |Description
        
        |-
        
        |category
        
        |''<nowiki>|category=QM|Setup...</nowiki>''
        
        | style="width:380px;" |Pages in the category QM OR Setup
        
        |-
        
        |
        
        |''<nowiki>|category=QM&Setup&...</nowiki>''
        
        | style="width:380px;" |Pages in the categories QM AND Setup
        
        |-
        
        |
        
        |''<nowiki>|category=QM|Setup...|category=Admin</nowiki>''
        
        | style="width:380px;" |Pages in the categories QM OR Setup, and pages in the category Admin
        
        |-
        
        |notcategory
        
        |''<nowiki>|notcategory=QM</nowiki>''
        
        | style="width:380px;" |Pages that are not in the category QM
        
        |-
        
        |categoriesminmax
        
        |''<nowiki>|category=QM|categoriesminmax=2</nowiki>''
        
        | style="width:380px;" |Pages that are in the category QM and in at least 2 more categories
        
        |-
        
        |
        
        |''<nowiki>|category=QM|categoriesminmax=,1</nowiki>''
        
        | style="width:380px;" |Pages that are only in the category QM and in no other category
        
        |-
        
        |namespace
        
        |''<nowiki>|namespace=</nowiki>''
        
        | style="width:380px;" |Pages in the namespace (Main)
        
        |-
        
        |
        
        |''<nowiki>|namespace=Help|Manual</nowiki>''
        
        | style="width:380px;" |Pages in the namespace Help OR Manual
        
        |-
        
        |namespacenot
        
        |''<nowiki>|namespacenot=Help</nowiki>''
        
        | style="width:380px;" |Pages that are not in the namespace Help
        
        |-
        
        |
        
        |''<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;}"
        
        !Parameter
        
        !Syntax
        
        ! style="width:380px;" data-ve-attributes="{&quot;style&quot;:&quot;width:380px;&quot;}" |Description
        
        |-
        
        |mode
        
        |''<nowiki>|mode=ordered</nowiki>''
        
        | style="width:380px;" data-ve-attributes="{&quot;style&quot;:&quot;width:380px;&quot;}" |Unordered list
        
        |-
        
        |
        
        |''<nowiki>|mode=unordered</nowiki>''
        
        |Numbered list
        
        |-
        
        |
        
        |<nowiki>|</nowiki>''mode=none''
        
        |Line breaks
        
        |-
        
        |
        
        |<nowiki>|</nowiki>''mode=category''
        
        |Pages are grouped alphabetically with a letter heading (similar to category pages)
        
        |-
        
        |
        
        |''<nowiki>|mode=inline|inlinetext=&amp;nbsp; &amp;bull; &amp;nbsp;</nowiki>''
        
        |Page names are listed on the same line and separated with a bullet point
        
        |}
        
        ===SortieingSorting===
        
        {| class="wikitable" style="width:100%;" data-ve-attributes="{&quot;style&quot;:&quot;width:100%;&quot;}"
        
        !Parameter
        
        !Syntax
        
        ! style="width:380px;" data-ve-attributes="{&quot;style&quot;:&quot;width:380px;&quot;}" |Description
        
        |-
        
        |ordermethod
        
        |''<nowiki>|ordermethod=title</nowiki>''
        
        | style="width:380px;" data-ve-attributes="{&quot;style&quot;:&quot;width:380px;&quot;}" |Ordered by page (prefix+)title
        
        |-
        
        |
        
        |''<nowiki>|ordermethod=titlewithoutnamespace</nowiki>''
        
        |Ordered by page name independent of namespace
        
        |-
        
        |
        
        |''<nowiki>|ordermethod=counter</nowiki>''
        
        |Ordered by number of page views (popularity)
        
        |-
        
        |
        
        |''<nowiki>|ordermethod=size</nowiki>''
        
        |Ordered by page size
        
        |-
        
        |
        
        |''<nowiki>|ordermethod=firstedit</nowiki>''
        
        |Ordered by creation date
        
        |-
        
        |
        
        |''<nowiki>|ordermethod=lastedit</nowiki>''
        
        |Ordered by last edit date
        
        |-
        
        |
        
        |''<nowiki>|ordermethod=user,firstedit</nowiki>''
        
        |Ordered by author, then by creation date
        
        |-
        
        |
        
        |''<nowiki>|ordermethod=user,lastedit</nowiki>''
        
        |Ordered by last editor, then by last edit date
        
        |-
        
        |order
        
        |''<nowiki>|order=ascending</nowiki>''
        
        |Sorted in ascending order
        
        |-
        
        |
        
        |''<nowiki>|order=descending</nowiki>''
        
        |Sorted in descending order
        
        |}
        

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

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

        [[en:{{FULLPAGENAME}}]]
        
        [[de:Handbuch:Erweiterung/DynamicPageList3]]
        
        [[Category:Organization]]
(2 intermediate revisions by the same user not shown)
Line 55: Line 55:
 
<syntaxhighlight lang="text">
 
<syntaxhighlight lang="text">
 
{{#dpl:
 
{{#dpl:
  |namespace=Datei
+
  |namespace=File
 
  |titlematch=A%
 
  |titlematch=A%
 
  |count=5
 
  |count=5
Line 61: Line 61:
  
 
</syntaxhighlight>Output:{{#dpl:
 
</syntaxhighlight>Output:{{#dpl:
  |namespace=Datei
+
  |namespace=File
 
  |titlematch=A%
 
  |titlematch=A%
 
  |count=5
 
  |count=5
Line 141: Line 141:
 
|Page names are listed on the same line and separated with a bullet point
 
|Page names are listed on the same line and separated with a bullet point
 
|}
 
|}
===Sortieing===
+
===Sorting===
 
{| class="wikitable" style="width:100%;" data-ve-attributes="{&quot;style&quot;:&quot;width:100%;&quot;}"
 
{| class="wikitable" style="width:100%;" data-ve-attributes="{&quot;style&quot;:&quot;width:100%;&quot;}"
 
!Parameter
 
!Parameter

Attachments

Discussions