Page MenuHomeWildfire Games

standardize bonus attack tooltips
ClosedPublic

Authored by Nescio on Feb 1 2020, 2:31 PM.

Details

Summary

This patch revisits the tooltips of bonus attacks. It replaces "x" (X) with "×" (multiplication symbol), "vs." with "vs" (abbreviations only end with a dot if they are shortenings (e.g. etc.), but not if they are contractions containing the first and last letter of the word (Dr, Mrs, vs), initialism (GB, MP, PM, UK, UN), or acronyms (Aids, laser)), and removes unnecessary extra words.

There is a patch that would automatically generate these tooltips (D1707), but its current status is unclear.

Test Plan

Check for mistakes and omissions.

Diff Detail

Repository
rP 0 A.D. Public Repository
Lint
Automatic diff as part of commit; lint not applicable.
Unit
Automatic diff as part of commit; unit tests not applicable.

Event Timeline

Nescio created this revision.Feb 1 2020, 2:31 PM
Vulcan added a comment.Feb 1 2020, 2:32 PM

Build failure - The Moirai have given mortals hearts that can endure.

Link to build: https://jenkins.wildfiregames.com/job/docker-differential/1692/display/redirect

Gallaecio accepted this revision.Feb 9 2020, 3:03 PM
This revision is now accepted and ready to land.Feb 9 2020, 3:03 PM
Nescio updated this revision to Diff 12552.Jul 4 2020, 6:42 PM
Nescio edited the summary of this revision. (Show Details)
Nescio added a subscriber: Stan.
  • rebased
Owners added a subscriber: Restricted Owners Package.Jul 4 2020, 6:42 PM
Vulcan added a comment.Jul 4 2020, 6:46 PM

Successful build - Chance fights ever on the side of the prudent.

Link to build: https://jenkins.wildfiregames.com/job/docker-differential/2583/display/redirect

Nescio updated this revision to Diff 12726.Jul 16 2020, 3:43 PM
  • include elephant template
  • correct pikeman bonus attack indentation

Successful build - Chance fights ever on the side of the prudent.

Link to build: https://jenkins.wildfiregames.com/job/docker-differential/2671/display/redirect

Nescio updated this revision to Diff 13014.Aug 3 2020, 10:20 AM
  • rebased (again)

Successful build - Chance fights ever on the side of the prudent.

Link to build: https://jenkins.wildfiregames.com/job/docker-differential/2847/display/redirect

Nescio edited subscribers, added: Freagarach; removed: Stan.Aug 3 2020, 11:27 AM
wraitii added a subscriber: wraitii.Aug 3 2020, 2:07 PM

This works, but I'm not entirely sure over "×" over "x" change. This seems like it'd be easy to fail in further diffs, as I don't know off-hand how to type "×". I don't think the "x" really harms readability either.

Nescio added a comment.Aug 3 2020, 2:29 PM

This works, but I'm not entirely sure over "×" over "x" change. This seems like it'd be easy to fail in further diffs, as I don't know off-hand how to type "×". I don't think the "x" really harms readability either.

On my keyboard (English, international) × be typed with AltGr =. People can also copy it from other files (see e.g. D2895/rP23871), or from the style guide.

wraitii requested changes to this revision.Aug 5 2020, 11:31 AM

On my keyboard (English, international) × be typed with AltGr =. People can also copy it from other files (see e.g. D2895/rP23871), or from the style guide.

On MacOs, it requires opening the "symbols" sub-window from the keyboard internationalisation thingy, which is imo a dealbreaker.
I don't think it's a sufficient improvement over "x" to warrant the pain of having to check every time, reminding people to copy-paste × instead of just writing x.

This revision now requires changes to proceed.Aug 5 2020, 11:31 AM
Nescio added a subscriber: Imarok.Aug 5 2020, 4:10 PM

On MacOs, it requires opening the "symbols" sub-window from the keyboard internationalisation thingy, which is imo a dealbreaker.
I don't think it's a sufficient improvement over "x" to warrant the pain of having to check every time, reminding people to copy-paste × instead of just writing x.

The × is per the style-guide. Moreover, this patch was accepted by @Gallaecio months ago, and @Imarok accepted and committed the same change in D2895.

Not only on MacOS, also on my Debian/Lubuntu. Nevertheless, I agree with the symbol over the letter. User XP should be over programmer XP here, IMHO.
The reason this took so long was the status of D1707, I guess. I am planning to add tooltips to attacks, but, please, don't wait for that ^^'

User XP should be over programmer XP here, IMHO.

I mean I'd argue that "user XP" changes basically none between "x" and "×"

Nescio added a comment.Aug 5 2020, 6:12 PM

For comparison, proper minus signs (− U+2212) are used in aura descriptions and technology tooltips, not the type-able hyphen-minus -. And specific names use hard-to-type diacritics (e.g. Nāvašta) or other special signs (e.g. mr ʿȝ). It may seem unimportant to you and perhaps the majority of players, but proper typesetting does matter for some, myself included.

For comparison, proper minus signs (− U+2212) are used in aura descriptions and technology tooltips, not the type-able hyphen-minus -.

Erf, I'd suggest to revert that then...

And specific names use hard-to-type diacritics (e.g. Nāvašta) or other special signs (e.g. mr ʿȝ). It may seem unimportant to you and perhaps the majority of players, but proper typesetting does matter for some, myself included.

Not the same, though. Specific names are supposed to be as close to the "authentic" spelling as possible, and it's alphabets.
This is about mathematical symbols, which are a convention in general (I'd argue easily for • instead), and "x" vs "×" are completely equally understandable.
Also, this "x" here is a convention for "+20%", since you can't really multiply by nothing in proper maths.


I don't actually care that much about this, but I think using those UTF-8 symbols instead of the regular characters is just creating work for template editors, for very little benefit to the end-user.
Point is, I'm not the one that's going to commit this diff, nor the inevitable future diffs that will be needed when someone else forgets to do this, etc.

Nescio added a comment.Aug 5 2020, 6:33 PM

Also, this "x" here is a convention for "+20%", since you can't really multiply by nothing in proper maths.

Isn't 20% more than 0 still 0?

I don't actually care that much about this, but I think using those UTF-8 symbols instead of the regular characters is just creating work for template editors, for very little benefit to the end-user.

It depends on the end-users and template editors, I suppose. If I were to give an entity a bonus attack, I would simply copy the relevant lines from another file. Proper typesetting conveys professionalism, basic ascii does not. Likewise, texts with spelling mistakes or grammatical errors can be understandable but still look poorly, and won't help if you want to be taken seriously.

Point is, I'm not the one that's going to commit this diff, nor the inevitable future diffs that will be needed when someone else forgets to do this, etc.

That's perfectly fine, you don't have to do something you don't want to.

Freagarach accepted this revision.Aug 25 2020, 8:27 PM
  • Complete.
  • Correct.
  • I like the use of the symbol.

I plan to commit this somewhere this week, unless there is more opposition.

Freagarach added inline comments.Aug 28 2020, 10:25 AM
binaries/data/mods/public/simulation/templates/units/iber_champion_cavalry.xml
16 ↗(On Diff #13014)

Why is this removed actually? We can still keep the Good vs Structures, right?

Nescio added inline comments.Aug 28 2020, 10:43 AM
binaries/data/mods/public/simulation/templates/units/iber_champion_cavalry.xml
16 ↗(On Diff #13014)

For consistency, other units (e.g. war elephants, stone-throwers) don't have this line either. Moreover, attack damage is already displayed in the tooltip. Besides, cavalry will attempt to capture structures.

Freagarach added inline comments.Aug 28 2020, 10:48 AM
binaries/data/mods/public/simulation/templates/units/iber_champion_cavalry.xml
16 ↗(On Diff #13014)

But for war elephants and stone-throwers it is kind of expected that they are strong against structures. Tooltips are mostly for those not very familiar with the game and won't link a high crush damage with good vs structures.

Nescio added inline comments.Aug 28 2020, 11:04 AM
binaries/data/mods/public/simulation/templates/units/iber_champion_cavalry.xml
16 ↗(On Diff #13014)

In my opinion template tooltips are for conveying information that is not displayed in the automatically generated gui tooltips; things such as territory root, resource dropsite, or bonus attack.
This is the only "good vs" tooltip in 0 A.D. as far as I know; maintaining it is rather inconsistent, since there are other entities that are “good” against something.
Besides, while they're significantly better than other javelineers, they're not that effective, given their poor pierce resistance, high cost, and not very high attack damage.

Gallaecio added inline comments.Aug 29 2020, 10:47 AM
binaries/data/mods/public/simulation/templates/units/iber_champion_cavalry.xml
16 ↗(On Diff #13014)

In the argument that this is not in other tooltips because it is obvious for other units, I would disagree. If this is worth mentioning in this unit, I think it would be worth mentioning in all other units for which it is true.

So, I’m +1 to either removing it from here or adding it to the other units :)

This revision was not accepted when it landed; it landed in state Needs Revision.Aug 29 2020, 11:45 AM
This revision was automatically updated to reflect the committed changes.