Help:DPL3 scroll/doc

Documentation subpage
View this documentation's related template: Help:DPL3 scroll

Usage

The count and offset parameter are required to use this template in a DPL3 invocation:

|count = {%DPL_count:10%}
|offset = {%DPL_offset:0%}
|resultsheader = ²{Extension DPL scroll¦total={{PAGESINCATEGORY:Category name|R}}¦offset={%DPL_offset:0%}¦count={%DPL_count:10%}¦page={{FULLPAGENAME}}}²\n
|resultsfooter = ²{Extension DPL scroll¦total={{PAGESINCATEGORY:Category name|R}}¦offset={%DPL_offset:0%}¦count={%DPL_count:10%}¦page={{FULLPAGENAME}}}²\n
|allowcachedresults = false

Note: %TOTALPAGES% when used in resultsheader or resultsfooter, may cause both to intermittently appear/disappear. Currently, this template is only usable when there's a set number of expected results, such as pages in a category. {{PAGESINCATEGORY:Category name|R}} is used to adjust for this.

The output of the URL link generated, is equivalent to putting the following in a browser (for the page name that has the above required parameters):

https://mywiki.miraheze.org/w/index.php?title=Mypage&DPL_count=3&DPL_offset=3

This template can be used in a DPL3 statement to scroll through DPL result pages. The parameters set in this template, must have their [[General_usage_and_invocation_syntax#URL parameters|URL parameter]] values set in the corresponding DPL3 statement per the usage example below.

Template parameters

Parameter		Description	Type	Status
Total Pages	total	no description Default 0	Number	required
Result Count Limit	count	Set to a number to change the limit of results output Default 100 Example 200	Number	required
Count offset	offset	Used for pagination to provide the next set of results by offsetting the count accordingly, should match count. Default 0 Example 200	Number	required
Page URL	page	Page to pass to URL for encoding and adding DPL3 url parameters	Page name	required