Examples/Parameter: scroll (example 2): Difference between revisions

Content deleted Content added

Inline

Latest revision as of 07:22, 21 April 2023

Please do not edit this page unless you're wanting to edit the manual itself, it is an example included in the manual.

Example

The count and empty offset displays the first 3 articles from Category:Fruit examples using Scroll/URL syntax, and scroll fills the scroll/url parameter values. The resultsheader/footer use a helper template (Template:DPL3 scroll) to create scroll navigation, composed of magic word ({{PAGESINCATEGORY:Category}}) and some parameters are fed to that template, so it can determine total pages, count, and amount of offset. allowcachedresults prevents caching, to prevent the need for manual purge.

{{#dpl:execandexit=geturlargs}}
{{#dpl:
|category      = Fruit examples
|count         = {%DPL_count:3%}
|offset        = {%DPL_offset:0%}
|scroll        = yes
|resultsheader = ²{DPL3 scroll¦total={{PAGESINCATEGORY:Fruit examples|R}}¦offset={%DPL_offset:0%}¦count={%DPL_count:3%}¦page={{FULLPAGENAME}}}²\n
|resultsfooter = ²{DPL3 scroll¦total={{PAGESINCATEGORY:Fruit examples|R}}¦offset={%DPL_offset:0%}¦count={%DPL_count:3%}¦page={{FULLPAGENAME}}}²\n
|allowcachedresults = false
}}

Result

{{#dpl:execandexit=geturlargs}} {{#dpl: |category = Fruit examples |count = {%DPL_count:3%} |offset = {%DPL_offset:0%} |scroll = yes |resultsheader = ²{DPL3 scroll¦total=7¦offset={%DPL_offset:0%}¦count={%DPL_count:3%}¦page=Examples/Parameter: scroll (example 2)}²\n |resultsfooter = ²{DPL3 scroll¦total=7¦offset={%DPL_offset:0%}¦count={%DPL_count:3%}¦page=Examples/Parameter: scroll (example 2)}²\n |allowcachedresults = false }}

@@ Line 6: / Line 6: @@
 ==Example==
-This selects pages from [[:Category:Fruit examples]] and sets display count to the first 3 articles. The <code>scroll</code> parameter enables scrolling and URL variables. The <code>resultsheader</code> argument uses a helper template ([[Template:Extension DPL scroll]]) to create the scrolling navigation. A [[mw:Help:Magic_words#Statistics|magic word]] (<code><nowiki>{{PAGESINCATEGORY:Category}}</nowiki></code>) and some parameters are fed to that template, so it can determine the total number of pages and the amount to show and offset for the navigation display. <code>allowcachedresults=''false''</code> prevents caching, so result changes are immediately seen without the need to manually purge the cache.
+The <code>{{DPL|count}}</code> and empty <code>{{DPL|offset}}</code> displays the first 3 articles from [[:Category:Fruit examples]] using [[General usage and invocation syntax#Scroll/URL syntax|Scroll/URL syntax]], and <code>scroll</code> fills the scroll/url parameter values. The <code>{{DPL|resultsheader}}</code>/footer use a helper template ([[Template:DPL3 scroll]]) to create scroll navigation, composed of [[mw:Help:Magic_words#Statistics|magic word]] (<code><nowiki>{{PAGESINCATEGORY:</nowiki>''Category''}}</code>) and some parameters are fed to that template, so it can determine total pages, count, and amount of offset. <code>{{DPL|allowcachedresults}}</code> prevents caching, to prevent the need for manual purge.
 <pre>
@@ Line 15: / Line 15: @@
 |offset        = {%DPL_offset:0%}
 |scroll        = yes
-|resultsheader = ²{Extension DPL scroll¦total={{PAGESINCATEGORY:Fruit examples|R}}¦offset={%DPL_offset:0%}¦count={%DPL_count:3%}¦page={{FULLPAGENAME}}}²\n
+|resultsheader = ²{DPL3 scroll¦total={{PAGESINCATEGORY:Fruit examples|R}}¦offset={%DPL_offset:0%}¦count={%DPL_count:3%}¦page={{FULLPAGENAME}}}²\n
+|resultsfooter = ²{DPL3 scroll¦total={{PAGESINCATEGORY:Fruit examples|R}}¦offset={%DPL_offset:0%}¦count={%DPL_count:3%}¦page={{FULLPAGENAME}}}²\n
 |allowcachedresults = false
 }}
@@ Line 28: / Line 29: @@
 |offset        = {%DPL_offset:0%}
 |scroll        = yes
-|resultsheader = ²{Extension DPL scroll¦total={{PAGESINCATEGORY:Fruit examples|R}}¦offset={%DPL_offset:0%}¦count={%DPL_count:3%}¦page={{FULLPAGENAME}}}²\n
+|resultsheader = ²{DPL3 scroll¦total={{PAGESINCATEGORY:Fruit examples|R}}¦offset={%DPL_offset:0%}¦count={%DPL_count:3%}¦page={{FULLPAGENAME}}}²\n
+|resultsfooter = ²{DPL3 scroll¦total={{PAGESINCATEGORY:Fruit examples|R}}¦offset={%DPL_offset:0%}¦count={%DPL_count:3%}¦page={{FULLPAGENAME}}}²\n
 |allowcachedresults = false
 }}
 <noinclude>
 [[Category:Select by category-related criteria‎]]
+[[Category:Uses execandexit parameter]]
 [[Category:Uses category parameter]]
-[[Category:Uses count  parameter]]
+[[Category:Uses count parameter]]
-[[Category:Uses offset  parameter]]
+[[Category:Uses offset parameter]]
 [[Category:Uses scroll parameter]]
 [[Category:Uses resultsheader parameter]]
+[[Category:Uses URL parameter]]
+[[Category:Uses resultsfooter parameter]]
 [[Category:Uses allowcachedresults parameter]]
 </noinclude>