• View
• Edit
• History
• Attach
• Print

01344: Add pagelist iterator

Description:

eg. (:pagelist iterator=[+/-]start,[+/-]end,[+/-]step :)
eg. (:pagelist iterator=1,10,1 :)
alternate
eg. (:pagelist for=[+/-]start,[+/-]end,[+/-]step :)
value list
eg. (:pagelist for="a b c" :)
or
e.g. (:pagelist istart=[+/-]startvalue iend=[+/-]endvalue istep=[+/-]stepvalue :)

demo - CopyPasteCalendar-Talk

With a simple pagelist iterator, it becomes easy to do some interesting things with current template directives. Seems very nice to have in core than as a recipe.

Another way might be to use Page List Templates directives, e.g.

(:template iterator istart=n iend=n istep=n:)
(:template iteratorstart:)
!!! {$$istart}
(:template each:)
{$$ivalue}
(:template iteratorend:)
{{$$icount} output from {$$istart} to {{$$iend} with {$$istep}
(:template iteratorend:)

One can use count=num to achieve the same but I believe a pure iterator would be less expensive and faster.

(:pagelist count=10 :)

If it can be done in any other way please do point to the docs.

Thanks. VKrishn April 21, 2014, at 04:30 AM

(:pagelist iterate=2000...2008) fmt=#mylist:)
[[#mylist]]
(:template first {$$Iterator}:)
!! From {$$Iterator}
(:template each:)
(:pagelist name={$$Iterator}* fmt=#titlesummary:)
[[#mylistend]]   

For the alternative suggestion (:pagelist istart=[+/-]startvalue iend=[+/-]endvalue istep=[+/-]stepvalue :) separate variables are proposed so they can be accessed in the template. I'd suggest that istart and iend must both be specified for the iteration to occur, and step defaults to 1 or -1 depending on the value of istart and iend.

The count=start..end parameter accepts more than just a number.
Also {$$request} is under-documented, you can use variables from the page url (request=1 needs to be set). Other than that, {$$PageCount} can be used with conditionals, and with the 'mod' MarkupExpression to create iterations. (I install the 'mod' MX on every wiki I use, so I believe this could go into the core.) --Petko April 21, 2014, at 05:13 AM

  $MarkupExpr['mod'] = '0 + ($args[0] % $args[1])'; # Wikipedia:Modulo_operation

Here you go: --Petko April 21, 2014, at 09:37 AM

[[#iterator]]
(:template first:)
(:table border=1:)
(:template each:)
(:if equal "{(mod {$$PageCount} {$$columns})}" "1":)
(:cellnr align=right:)
(:else:)
(:cell align=right:)
(:if:)
{$$PageCount}. [[{=$Name}]]\\
(:template last:)
(:tableend:)
[[#iteratorend]]

[[#modpair]]
(:if equal {(mod {$$PageCount} 2)} 0:)
* {=$Name} {=$:Summary} 
(:ifend:)
[[#modpairend]]

(:pagelist group=PITS name=PITS.0* fmt=#iterator count=51..100 columns=5 request=1:)
Try with [[({$Name})?columns=2]], [[({$Name})?columns=3]], [[({$Name})?columns=6]], [[({$Name})?columns=11]]

(:pagelist group=PITS name=PITS.0* fmt=#iterator count=1401..1470 columns=7:)

This example shows the flaw of using count as an iterator, as there has to be at least as many pages to count as the numerical value you wish to work with.

(:pagelist group=PITS name=PITS.01* fmt=#iterator count=1401..1470 columns=7:)

(:pagelist group=PITS name=PITS.0* fmt=#iterator count=14 columns=2:)

(:pagelist group=PITS name=PITS.0* fmt=#iterator count=28 columns=14:)

Only pairs using "name=" (note that only pair pages are found)

(:pagelist group=PITS name=PITS.0*[24680] count=10:)

Only pairs using "mod" (note that only pair pages are displayed, from 20 pages found impairs are skipped):

(:pagelist group=PITS name=PITS.0* fmt=#modpair count=20:)

No, the last pagelist does not read all 20 pages (=does not open all 20 files). It only sees the first 20 pagenames. What is read from the disk files depends on the #modpair template, in the example we want to display a {=$:PTV}, then only 10 disk files will be opened from the 20 pagenames. --Petko April 21, 2014, at 10:57 AM

I was wrong, conditional markup is processed after page variables, so all 20 files are open. --Petko April 21, 2014, at 11:33 AM

See Cookbook:BreakPageList for a possible solution and/or a possible starting point for a solution. --Petko April 21, 2014, at 11:33 AM

Ok, I think that you want a special (:loop:) markup, capable to repeat a markup template for a specified number of times. This seams unrelated to PageLists, so the Summary, the Category, and the Priority of this entry should probably be corrected. I don't think that this will be required by many wikis so a recipe will probably be better. This way we can see if there are indeed many users. --Petko April 21, 2014, at 12:24 PM

[[#modpair3]]
(:if equal {(mod {$$PageCount} 2)} 0:)
* {$$PageCount}
(:if:)
[[#modpair3end]]

Well, you can test it and see. The following will find only a few pages, less then the 'count' value, and will display the pair ones.

(:pagelist fmt=#modpair3 name=PITS.0134* count=9999999:)

Yes, the pagelist markup iterates on existing pages only, regardless of the content of the template. If there are fewer pages than the count= parameter, fewer iterations of the template will be displayed. --Petko April 21, 2014, at 12:54 PM

No, this one #modpair3 does not open the two (2, 4) or five (0, 1, 2, 3, 4) files, because inside the template there is no markup that requires this - no PageTextVars, no includes, no titles, etc. The first one #modpair opens them because it contains {=$:Summary}. --Petko April 21, 2014, at 01:05 PM