ListResultPrinter / Fix usage of sep in format=template

[mwjames]

This PR is made in reference to: # [0, 1]

This PR addresses or contains:

• Most likely introduced with 66b7761

This PR includes:

• Tests (unit/integration)
• CI build passed

[0] Issues with the "sep" function in mode Query template.
[1] http://naruto.wikia.com/wiki/Thread:217742#29

[mwjames]

http://sandbox.semantic-mediawiki.org/wiki/Issue/2022

Current output 123 • 456abc vs. expected output 123 • 456 • abc

@kghbln FYI

[kghbln]

Just fetched the latest code on sandbox. Works perfect! Thanks!

[mwjames]

By coincidence, @kghbln found:

with no sep= parameter therefore falling back to , as default.

{{#ask:
 [[Category:SMW releases]]
 [[Language code::en]]
 [[Is duplicate page::false]]
 [[Version::!Semantic MediaWiki 1.6.2]]
 | ?Version
 | ?Has release date#ISO
 | ?Has highlights
 | ?Is compatible with
 | format=template
 | sort=Version, Has release date
 | order=descending
 | limit=100
 | introtemplate=Version history intro
 | template=Version history
 | outrotemplate=Version history outro
 | intro=Here is the complete <b>version history</b>:
}}

[kghbln]

By coincidence, @kghbln found:

Great, that we found this prior to the release.

[kghbln]

@mwjames Should I open a separate issue allowing to track this?

[mwjames]

Should I open a separate issue allowing to track this?

Maybe for the best. Also what I need is some kind of baseline that defines the behavior to avoid any future regression. We caught this just by mere chance!

{{#ask: [[List::2022]]
 |?Has page
 |?Has page
 |format=ul
}}

Expects to output Some, Some

Issue: The default sep is set to , which is a bit tricky because it cannot be decided whether a user made a deliberate decision or not. I will change the default to be empty and in case it is a list/ul/ol then the output will use , as default if no other sep was given. template by default will have no sep to avoid the case we just found.

[s7eph4n]

Just for my understanding: This means that when I upgrade to 2.5 I have to modify all {{#ask}} calls with format=template and explicitly add a sep parameter? Or should it be valuesep?

[mwjames]

If I remember correctly (off the top of my head), #2331 introduced `$smwgResultFormatsFeatures` as means to allow to stick with pre-2.5 behaviour, so setting it to `SMW_RF_NONE` should avoid having to update any of your existing queries. Of course, this also makes it impossible to use the changes addressed in #2022. I hope this helps otherwise please see the examples attached on each issue. PS: Currently, my memory is a bit fuzzy on the issue, so the answer is the best I can give you right now. Cheers

…

On 5/11/17, Stephan Gambke ***@***.***> wrote: Just for my understanding: This means that when I upgrade to 2.5 I have to modify all `{{#ask}}` calls with `format=template` and explicitly add a `sep` parameter? Or should it be `listsep`? -- You are receiving this because you were mentioned. Reply to this email directly or view it on GitHub: #2022 (comment)

[s7eph4n]

Ah, ok. Guess you had to break something to make it work properly. Just wish it wouldn't bite me now. :P
I'll change the {{#ask}} calls. That parameter is nice, but I will have forgotten all about it by tomorrow.

[kghbln]

Needs more doculove

[stefahn]

I just came across this issue, since commas were missing on my wiki(s) since I updated SMW from 1.x to 2.5.5.

I use many ask queries and I didn't want to change every single one of them individually. Also it seems I didn't get the point of the valuesep thing. So I just added this line to my LocalSettings.php and all commas reappeared:
$smwgResultFormatsFeatures = SMW_RF_NONE;

However I find it strange that default output behaviour changes, when I update SWM.
Why is the default value of sep empty and not a comma?

[kghbln]

Also it seems I didn't get the point of the valuesep thing.

The example should make it clear: https://sandbox.semantic-mediawiki.org/wiki/Template_sep_valuesep

However I find it strange that default output behaviour changes, when I update SMW.

Sometimes changes have to be made to bring more goodness. You always get occasional default setting changes, not just with SMW but e.g also with MW, but there is in most cases a way to retain the previous bahaviour to allow for migrating and you indeed found it: https://www.semantic-mediawiki.org/wiki/Help:$smwgResultFormatsFeatures

Perhaps in this case we should probably have added this to a breaking changes section in the RELEASE NOTES.