Template:DPL3 scroll/doc

[purge]

This is the documentation page, it should be transcluded into the main template page. See Template:Documentation for more information

Usage[edit]

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

<templatedata> { "params": { "total": { "label": "Total Pages", "type": "number", "default": "0", "required": true }, "count": { "label": "Result Count Limit", "description": "Set to a number to change the limit of results output", "example": "200", "type": "number", "default": "100", "required": true }, "offset": { "label": "Count offset", "description": "Used for pagination to provide the next set of results by offsetting the count accordingly, should match count.", "example": "200", "type": "number", "default": "0", "required": true }, "page": { "label": "Page URL", "description": "Page to pass to URL for encoding and adding DPL3 url parameters", "type": "wiki-page-name", "required": true } }, "description": "This template can be used in a DPL3 statement to scroll through DPL result pages. The parameters set in this template, must have their URL parameter values set in the corresponding DPL3 statement per the usage example below." } </templatedata>