Collect rules (test cases) for interactions between attributes, e.g.:
This task is about collecting the use cases, ideally as actual test code (parser tests, better separate unit tests if possible).
Original estimation: 3
| Status | Subtype | Assigned | Task | ||
|---|---|---|---|---|---|
| Resolved | Andrew-WMDE | T236256 Collect use cases for interactions with refined <ref>s | |||
| Resolved | thiemowmde | T151305 More edge case handling for "extends" parameter | |||
| Resolved | None | T240424 Decide whether to support "extends" in the references section | |||
| Resolved | awight | T242141 Bad numbering when reusing a sub-reference before it's defined |
Just as a first collection...
Disclaimer: The examples below always represent the full wiki text in the example.
Allowed:
<ref name="foo">book</ref> <ref refines="foo">page 1</ref> //refines the book with "page 1"
<ref name="foo">book</ref> <ref refines="foo" name="bar">page 1</ref> //refines "book" with "page 1" <ref name="bar" /> // a 2nd usage of the refinement of "book" with "page 1"
Also assume a random order for the above examples.
<ref refines="foo">page 1</ref> //refines the book with "page 1" <references> <ref name="foo">book</ref> </references>
Questionable:
<ref name="foo">book</ref> <ref refines="foo" /> // no text for the refinement
<ref name="foo">book</ref> <ref refines="foo"></ref> // empty text for the refinement
<ref name="foo">book</ref> <ref refines="foo"> </ref> // de-facto empty text for the refinement
Not allowed/errors:
<ref refines="foo">page 1</ref> //foo is not defined
<ref>book</ref> <ref refines="foo">page 1</ref> //foo is not defined
<ref name="foo" /> //foo is empty <ref refines="foo">page 1</ref>
The above example will also show an error in the "default" behavior, when a named reference is not defined.
<ref name="foo">book</ref> <ref name="foo">magazine</ref> // foo is defined twice <ref refines="foo">page 1</ref>
The above example will also show an error in the "default" behavior, when a named reference is defined twice.
I believe all 3 "questionable" examples should fail. A refinement isn't refining anything if it does not have any content.
Overall, from experience I know it's much better do disallow as much as possible, and only allow as few use cases as possible. It's much easier to allow specific use cases later, than to disallow some that might already be in uses somewhere. This way around we will automagically come up with a controlled set of use cases.
More:
<ref name="a">book</ref> <ref refines="a">page 2</ref> <ref refines="a">page 3</ref>
<ref name="a">book</ref> <ref refines="a" name="b">page 2</ref> <ref refines="a" name="c">page 3</ref> <ref name="b" /> <ref name="c" />
<ref name="a">book</ref> <ref refines="a" name="b">page 2</ref> <ref refines="a" name="b">page 3</ref>
<ref name="a">book</ref> <ref refines="a" name="b">page 2</ref> <ref refines="b">section 3</ref>
Still missing here: interactions with the group="…" and follow="…" attributes.
follow="…" is described here: https://www.mediawiki.org/wiki/Extension:Cite#Merging_two_texts_into_a_single_reference. I suggest this:
<ref name="a">part 1</ref> <ref follow="a">part 2</ref> <ref refines="a">ok</ref>
<ref name="a">book</ref> <ref refines="a" name="b">page 2</ref> <ref follow="b">and page 3 the same time?</ref>
<ref name="a">book 1</ref> <ref follow="a" refines="a">huh?</ref>
<ref name="a">book 1</ref> <ref name="b">book 2</ref> <ref follow="a" refines="b">huh?</ref>
It's worth mentioning that the named subreferences can be used as normal:
<ref name="b" />
Yes, thanks! I updated my examples above.
Interactions with group="…":
<ref group="g1" name="a">book</ref> <ref group="g1" refines="a" name="b">page</ref> <ref group="g1" name="b" />
<ref group="g1" name="a">book</ref> <ref group="g2" refines="a">page</ref>
<ref group="g1" name="a">book</ref> <ref refines="a">page</ref>
<ref name="a">book</ref> <ref group="g1" refines="a">page</ref>
Change 547746 had a related patch set uploaded (by Andrew-WMDE; owner: Andrew-WMDE):
[mediawiki/extensions/Cite@master] [WIP] Begin adding parser tests for refined references
Change 548758 had a related patch set uploaded (by Thiemo Kreuz (WMDE); owner: Thiemo Kreuz (WMDE)):
[mediawiki/extensions/Cite@master] Block all combinations of refines="…" and follows="…"
Change 549811 had a related patch set uploaded (by Awight; owner: Awight):
[mediawiki/extensions/Cite@master] Split out BookReferencing parser tests
Change 547746 merged by jenkins-bot:
[mediawiki/extensions/Cite@master] Add parser tests for refined references as rendered right now
Change 549811 merged by jenkins-bot:
[mediawiki/extensions/Cite@master] Split out BookReferencing parser tests
Change 548758 merged by jenkins-bot:
[mediawiki/extensions/Cite@master] Block all combinations of refines="…" and follows="…"