-
Notifications
You must be signed in to change notification settings - Fork 41
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
Docs: add list of game interface elements that we want to capitalize … #1303
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think we should be listing prefixes here. Things like Special (also covers Specialist)
, Entertain(er)
, Prod(uction)
. IMO this should be just a plain list of terms that are capitalized, without explicitly listed forms of the word.
I did the prefixes with notes to aid another person in using find/replace. That is the method I used while updating |
I'd suggest making this just a list of in-game terms that are capitalized, organized by category, since it's just a style guide. There could, of course, be a "useful list for find/replace for those terms", but I'd put that on a separate page and put a link to it somewhere around the main list. Or a collapsible section under the main list, if that can be done. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I agree with Daavko that it would be more clear to skip the prefix thing entirely and just list the variants when it makes sense. I was actually confused the first time and it's probably going to confuse non-programmers even more (we're used to this kind of reasoning from regexes).
Some of these terms, like Prod, may sometimes be abbreviated. In such a case the abbreviation could be listed next to it.
I think this would be better rendered as one or more hlists with subtitles inbetween (HTML gives us 6 heading levels, let's not be shy on using them).
docs/Contributing/style-guide.rst
Outdated
Below is a more exhaustive list of game specific terms that we want to capitalize. The list can be used | ||
in a find/replace exercise: | ||
|
||
:strong:`Game Interace`: |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Interface
docs/Contributing/style-guide.rst
Outdated
* Buoy | ||
* Button (a named button) | ||
* Chat | ||
* Cit(y or ies) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
City/Cities
docs/Contributing/style-guide.rst
Outdated
* Chat | ||
* Cit(y or ies) | ||
* Dialog (a named dialog) | ||
* Embass(y or ies) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Embassy/Embassies
docs/Contributing/style-guide.rst
Outdated
* Cit(y or ies) | ||
* Dialog (a named dialog) | ||
* Embass(y or ies) | ||
* Fort(ress) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fort and Fortress
docs/Contributing/style-guide.rst
Outdated
* Messages | ||
* Minimap | ||
* Small Great Wonder (only with Wonders) | ||
* Tax(es) Rate(s) |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"Taxes Rates", really? Maybe this should be two items
…to style guide