Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Change: Clean up window title and button capitalization and wording #11134

Merged
merged 10 commits into from Jul 14, 2023

Conversation

2TallTyler
Copy link
Member

Motivation / Problem

Knock knock, it's the grammar police!

Not really, but while reviewing #10541 I tried to ensure its new windows and button matched our current precedent, and discovered that our current precedent is a bit messy. Not totally random — we have some reasonably consistent rules — but with enough outliers for it to be frustrating.

Description

Let's clean up the easy outliers and make them match the pattern we've generally established:

Generally title case unless they're a sentence fragment:

  • Window captions (titles)
  • Buttons

I reworded the easy sentence fragments and left the tricky ones alone for later (or never 😛).

Always (to my knowledge) sentence case:

  • Dropdown options

I also fixed some confusion with AI and GS setting windows, where all the buttons say "settings" but the windows themselves say "configuration". I went with "settings" because our use of the synonyms "options" and "settings" is confusing enough without adding "configuration" to the list. 😃

I made a bunch of commits for reviewers to easily follow, will squash when merging.

Most likely supersedes #9118.

Limitations

  • As mentioned above, I left some window captions as sentence fragments for later/never because they're troublesome and include more information than we can fit in a title-style caption.
  • Translators have to do more work.
  • I did not change string names; none seemed particularly problematic to me.

Checklist for review

Some things are not automated, and forgotten often. This list is a reminder for the reviewers.

  • The bug fix is important enough to be backported? (label: 'backport requested')
  • This PR touches english.txt or translations? Check the guidelines
  • This PR affects the save game format? (label 'savegame upgrade')
  • This PR affects the GS/AI API? (label 'needs review: Script API')
    • ai_changelog.hpp, gs_changelog.hpp need updating.
    • The compatibility wrappers (compat_*.nut) need updating.
  • This PR affects the NewGRF API? (label 'needs review: NewGRF')

This matches company windows (vehicle and station lists) and the smallmap.
Window titles should match how the drop-down describes them. We already use the synonyms Settings and Options; let's not add a third word.
This matches other graphs which use an official-sounding title (rather than a descriptor like "Units of cargo delivered"), including Cargo Payment Rates and Operating Profit Graph.
This matches town generation and avoids unnecessary sentence-fragment window titles.
Matches other in-world windows like stations and depots, whose buttons give the name of their function in title case, not explain their functions in sentence case.
…on on town window

Matches other buttons on stations and depots.
We use sentence case capitalization for dropdowns everywhere else.
@2TallTyler 2TallTyler merged commit e4be7f4 into OpenTTD:master Jul 14, 2023
18 checks passed
@2TallTyler 2TallTyler deleted the string-fixes branch July 14, 2023 14:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants