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: Improved English texts - capitalization. #8144

Closed
wants to merge 1 commit into from

Conversation

sheepo99
Copy link

Capitalization changes to English.txt as to reflect the rules in the new Manual of Style.

This commit covers only isolated changes. Similar capitalization alterations in lines to be rewritten or reformatted will be submitted in later PRs.

Copy link
Contributor

@James103 James103 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

With this, it looks like you are masking effects of two PRs, which are #8113 and #8136. You also have an inconsistency in the Game save/load failed message.

src/lang/english.txt Outdated Show resolved Hide resolved
src/lang/english.txt Outdated Show resolved Hide resolved
src/lang/english.txt Outdated Show resolved Hide resolved
@sheepo99 sheepo99 force-pushed the textupdate branch 2 times, most recently from 298f26f to 517157e Compare May 12, 2020 16:25
Copy link
Member

@LordAro LordAro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good, for the most part. Mostly just need to argument the correct capitalisation of GS/game script/Game script/Gamescript/GameScript

src/lang/english.txt Outdated Show resolved Hide resolved
src/lang/english.txt Outdated Show resolved Hide resolved
src/lang/english.txt Outdated Show resolved Hide resolved
src/lang/english.txt Outdated Show resolved Hide resolved
src/lang/english.txt Outdated Show resolved Hide resolved
src/lang/english.txt Outdated Show resolved Hide resolved
src/lang/english.txt Outdated Show resolved Hide resolved
src/lang/english.txt Outdated Show resolved Hide resolved
src/lang/english.txt Outdated Show resolved Hide resolved
src/lang/english.txt Outdated Show resolved Hide resolved
@frosch123
Copy link
Member

About Game-Scripts:

  • BaNaNaS uses a dash "Game-Script" (all content types are title case on BaNaNaS)
  • OpenTTD currently uses "Game Script" or "Game script", sometimes "GS".
  • It is not written without space anywhere: either space or dash, please don't add another spelling :)

STR_NEWS_ROAD_VEHICLE_CRASH_DRIVER :{BIG_FONT}{BLACK}Road vehicle crash!{}Driver dies in fireball after collision with train
STR_NEWS_ROAD_VEHICLE_CRASH :{BIG_FONT}{BLACK}Road vehicle crash!{}{COMMA} die in fireball after collision with train
STR_NEWS_AIRCRAFT_CRASH :{BIG_FONT}{BLACK}Plane crash!{}{COMMA} die in fireball at {STATION}
STR_NEWS_PLANE_CRASH_OUT_OF_FUEL :{BIG_FONT}{BLACK}Plane crash!{}Aircraft ran out of fuel, {COMMA} die in fireball

STR_NEWS_DISASTER_ZEPPELIN :{BIG_FONT}{BLACK}Zeppelin disaster at {STATION}!
STR_NEWS_DISASTER_SMALL_UFO :{BIG_FONT}{BLACK}Road vehicle destroyed in 'UFO' collision!
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should 'UFO' be left as is or replaced with just UFO (without the quotes)? Other acronyms (NPF, YAPF, AI, GS) appear without quotes, both here and elsewhere.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think the quotes should go. They're an outdated formality that adds nothing of value to the text. Something for the next batch of changes though.

@James103
Copy link
Contributor

@sheepo99 Will you eventually apply similar updates to all the text comments in OpenTTD's source files?

@sheepo99
Copy link
Author

@sheepo99 Will you eventually apply similar updates to all the text comments in OpenTTD's source files?

No. The scope of the manual of style is clear on that. These changes are exclusively for in-game written text (this also excludes documentation displayed in-game such as readmes and changelogs). You may continue commenting code in any way you feel it's the most adequate. :)

Copy link
Contributor

@FLHerne FLHerne left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for doing all this work!

Mostly I like it, but see various comments.

src/lang/english.txt Outdated Show resolved Hide resolved
@@ -265,7 +265,7 @@ STR_SHOW_HIDDEN_ENGINES_VEHICLE_AIRCRAFT_TOOLTIP :{BLACK}By enabl
STR_BUTTON_DEFAULT :{BLACK}Default
STR_BUTTON_CANCEL :{BLACK}Cancel
STR_BUTTON_OK :{BLACK}OK
STR_WARNING_PASSWORD_SECURITY :{YELLOW}Warning: Server administrators may be able to read any text entered here.
STR_WARNING_PASSWORD_SECURITY :{YELLOW}Warning: server administrators may be able to read any text entered here.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is wrong; after the colon is a complete sentence so should be capitalized.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

A colon isn't an end-of-sentence mark, just like a semi-colon. Usually capital letters are only used after colon if there's a paragraph break, although this is open to discussion.

src/lang/english.txt Show resolved Hide resolved
src/lang/english.txt Show resolved Hide resolved
src/lang/english.txt Outdated Show resolved Hide resolved
src/lang/english.txt Show resolved Hide resolved
src/lang/english.txt Outdated Show resolved Hide resolved
src/lang/english.txt Show resolved Hide resolved
STR_ERROR_AI_PLEASE_REPORT_CRASH :{WHITE}One of the running scripts crashed. Please report this to the script author with a screenshot of the AI/Game Script Debug Window
STR_ERROR_AI_DEBUG_SERVER_ONLY :{YELLOW}AI/Game Script Debug window is only available for the server
STR_ERROR_AI_NO_AI_FOUND :No suitable AI found to load.{}This AI is a dummy AI and won't do anything.{}You can download several AIs via the online content system
STR_ERROR_AI_PLEASE_REPORT_CRASH :{WHITE}One of the running scripts crashed. Please report this to the script author with a screenshot of the AI/Game Script debug window
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe add quotes to 'AI/Game Script debug', now the caps don't make it obvious? It can be read as the 'AI/Game Script' debug window, which would be wrong.

Not sure.

STR_FORMAT_DEPOT_NAME_SHIP :{TOWN} Ship Depot
STR_FORMAT_DEPOT_NAME_SHIP_SERIAL :{TOWN} Ship Depot #{COMMA}
STR_FORMAT_DEPOT_NAME_AIRCRAFT :{STATION} Hangar
STR_FORMAT_DEPOT_NAME_TRAIN :{TOWN} Train depot
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There are in the middle of a sentence, so should be all-lowercase.

Copy link
Author

@sheepo99 sheepo99 May 13, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you show me a screenshot example?

Copy link
Contributor

@James103 James103 May 13, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

image

image

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks. Then all of these have to be changed for consistency, including the map legend names. Come to think of it, that was actually part of the rule I wrote for title capitalization, and now I remember why I did it like that. Will fix soon.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Come to think of it, that was actually part of the rule I wrote for title capitalization

By the way, are you "‎Mcbanhas" on the wiki?

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes!

@sheepo99 sheepo99 force-pushed the textupdate branch 2 times, most recently from 62f40ea to 6525285 Compare May 14, 2020 17:41
@TrueBrain
Copy link
Member

Oops, seems we forgot about this. I hate to ask, but would you mind rebasing to latest master? I would like to merge this, but it is a bit outdated now :D Sorry about that, and awesome work :)

@TrueBrain TrueBrain added candidate: yes This Pull Request is a candidate for being merged size: large This Pull Request is large in size; review will take a while labels Dec 14, 2020
@TrueBrain TrueBrain added the work: needs rebase This Pull Request needs a rebase label Dec 19, 2020
@TrueBrain
Copy link
Member

Hi @sheepo99 ; as mentioned earlier, I would love to include this in OpenTTD, but it is currently out-of-date. I am not sure if you would be interested in updating it for us, I would really appreciate it!

I did give it a go myself, but I could not validate if I wouldn't be introducing more inconsistencies than I am fixing .. so I left it at that :D

For now I will close this PR; not because I do not appreciate the work or am no longer interested, so please feel free to re-open the PR if you feel up to it! Thank you!

@TrueBrain TrueBrain closed this Dec 28, 2020
@sheepo99
Copy link
Author

Hi @TrueBrain, I haven't updated this in a while bc I've ran into some problems with my life. Hopefully I'll be able to get back at it again soon. Another reason for the lack of motivation was that some of the changes were being met with resistance by some community members who requested of me way too many minor alterations.

Either way, thank you for considering this. Maybe I'll reopen this at some point.

@TrueBrain
Copy link
Member

Human nature .. if there is something everyone knows a bit about, everyone pitches in with the best intentions :) But I kinda agree with your statement: we give trust to translators to do the right thing, so doing that once in a while for english.txt is not the worst idea :)

Anyway, take your time, there really is no rush. Personal life is much more important, and OpenTTD will be around whenever :)

Cheers!

@FLHerne
Copy link
Contributor

FLHerne commented Dec 30, 2020

Another reason for the lack of motivation was that some of the changes were being met with resistance by some community members who requested of me way too many minor alterations.

That's probably me, or at least includes me. I'm sorry for seeming resistant, your changes are a huge improvement overall, particularly in consistency.

You'll never find a form of words that everyone thinks is perfect, so there'll always be some quibbling about minor details, but don't think that's equivalent to a veto. Ultimately, as with most FOSS stuff, the person who actually does the work tends to get the final say.

Should you find time for this in future, I'll try to suppress my tendency to nitpick about everything. ;-)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
candidate: yes This Pull Request is a candidate for being merged size: large This Pull Request is large in size; review will take a while work: needs rebase This Pull Request needs a rebase
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants