Template:Delete3: Difference between revisions

From DynamicPageList3 Manual
Content added Content deleted
imported>FrozenPlum
m (Update to not use variables extension, there's no reason why DPL3 can use its own '#dplvar' (works on off-site test))
imported>FrozenPlum
m (Update to move docs here)
Line 1: Line 1:
<onlyinclude><includeonly><!--Template to scroll through DPL result pages
<!--Template to scroll through DPL result pages
--><table><tr><td style="background-color: #f9f9f9; padding: .1em .7em .2em .7em;"><!-- {{#dplvar:set|name|value}}
--><table><tr><td style="background-color: #f9f9f9; padding: .1em .7em .2em .7em;"><!-- {{#dplvar:set|name|value}}


Line 13: Line 13:
-->({{{total|0}}} total)}}<!--
-->({{{total|0}}} total)}}<!--


--></td></tr></table></includeonly></onlyinclude>
--></td></tr></table><noinclude>
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.
{{Documentation}}

==Usage==
The <code>count</code> and <code>offset</code> parameter are required to use this template in a DPL3 invocation:

<pre>
|count = {%DPL_count:10%}
|offset = {%DPL_offset:0%}
|resultsheader = ²{DPL scroll¦total={{formatnum:{{PAGESINCATEGORY:category name}}¦R}}¦offset={%DPL_offset:0%}¦count={%DPL_count:10%}¦page={{FULLPAGENAME}}}²\n
|resultsfooter = ²{DPL scroll¦total={{formatnum:{{PAGESINCATEGORY:category name}}¦R}}¦offset={%DPL_offset:0%}¦count={%DPL_count:10%}¦page={{FULLPAGENAME}}}²\n
</pre>
{{note|'''Note:''' <code>%TOTALPAGES%</code> when used in <code>resultsheader</code> or <code>resultsfooter</code>, 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. <code><nowiki>{{formatnum:{{PAGESINCATEGORY:category name}}¦R}}</nowiki></code> is used to adjust for this.|warn}}

<!-- The old working example, prior to (much needed) cache changes to drastically improve the performance of DPL3:
²{DPL scroll¦total=%TOTALPAGES%¦offset={%DPL_offset:0%}¦count={%DPL_count:100%}¦page={{FULLPAGENAME}}}²\n -->

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):
<pre>https://mywiki.com/wiki/Pagename&DPL_count=10&DPL_offset=10
</pre>

<!-- Template categories/interwikis here -->
[[Category:Templates]]
[[Category:Example templates]]
</noinclude>

Revision as of 05:09, 4 April 2022

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.

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 = ²{DPL scroll¦total={{formatnum:{{PAGESINCATEGORY:category name}}¦R}}¦offset={%DPL_offset:0%}¦count={%DPL_count:10%}¦page={{FULLPAGENAME}}}²\n
|resultsfooter = ²{DPL scroll¦total={{formatnum:{{PAGESINCATEGORY:category name}}¦R}}¦offset={%DPL_offset:0%}¦count={%DPL_count:10%}¦page={{FULLPAGENAME}}}²\n
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. {{formatnum:{{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.com/wiki/Pagename&DPL_count=10&DPL_offset=10