Typography Style Guide

Discussion among members of the development team.

Moderator: Forum Moderators

Post Reply
User avatar
Pentarctagon
Project Manager
Posts: 5459
Joined: March 22nd, 2009, 10:50 pm
Location: Earth (occasionally)

Typography Style Guide

Post by Pentarctagon »

Given that issues have consistently come up related to following Wesnoth's Typography Style Guide, I felt it made sense to open this thread to ask a couple questions:
  1. Is anyone opposed to following those guidelines?
  2. If no, is anyone opposed to adding a CI check to validate, at least as much as possible, that those guidelines are being followed? (#7967)
Mainly what seems to be happened fairly regularly is either that changes get committed that don't follow the guidelines and then months later a bunch of them are fixed at once which then causes those strings to become fuzzy for translators, or the issues are noticed while reviewing the PR because only one or two people are consistently reviewing the text of PRs to try and catch these.
99 little bugs in the code, 99 little bugs
take one down, patch it around
-2,147,483,648 little bugs in the code
Soliton
Site Administrator
Posts: 1675
Joined: April 5th, 2005, 3:25 pm
Location: #wesnoth-mp

Re: Typography Style Guide

Post by Soliton »

Not opposed, didn't check everything in detail though. Being consistent is a good thing and if there are details that are not useful the guide can be adjusted.

The more that can be checked automatically the better.
"If gameplay requires it, they can be made to live on Venus." -- scott
User avatar
doofus-01
Art Director
Posts: 4117
Joined: January 6th, 2008, 9:27 pm
Location: USA

Re: Typography Style Guide

Post by doofus-01 »

1. "Opposed" is maybe too strong a word, but I don't have much respect for policing the subtleties of hyphen length or "non-standard" spacing after full stop. Grammar and spelling are important, as is enabling special characters for non-English text (in any context). But if it isn't a symbol on the keyboard, it's on the displaying program to auto-correct. Otherwise, it's a needless complication and waste of precious time.
2. Standardization is certainly worth something, and if there is some easy script, like wmlindent, that can automate the style-guide corrections, then no problem. If I have to think about em dash vs hyphen, I'm just going to avoid text changes. Maybe that's a good thing, but that's where I stand.

From looking at #7967, I don't know what to think. Maybe it's OK, I'll follow up there if I have anything useful to contribute.
BfW 1.12 supported, but active development only for BfW 1.13/1.14: Bad Moon Rising | Trinity | Archaic Era |
| Abandoned: Tales of the Setting Sun
GitHub link for these projects
User avatar
Celtic_Minstrel
Developer
Posts: 2142
Joined: August 3rd, 2012, 11:26 pm
Location: Canada
Contact:

Re: Typography Style Guide

Post by Celtic_Minstrel »

Regarding 1, I haven't read the style guide in detail recently, so don't take this as endorsement of the specific policies it prescribes. However, I think we should have a style guide and should endeavour to follow it consistently, even if I may disagree with some details here and there.

As a random example, I would personally prefer to use the ellipsis character instead of three periods. However, if the project has decided to use three periods, then we should do so consistently everywhere.

On to point 2, I think some of these rules simply cannot be automatically validated. I already mentioned elsewhere the example of the apostrophe / single quote issue – unless we decide never to use single quotes, we can't reliably determine with a script whether or not a given single quote preceded by a space is an apostrophe (and thus a "closing" quote) or an opening quote. I am not opposed to having a script that does its best to push the text into conformance, as long as there's some way to deal with the edge cases where it gets the wrong answer.
Author of The Black Cross of Aleron campaign and Default++ era.
Maintainer of Steelhive.
Post Reply