-
-
Notifications
You must be signed in to change notification settings - Fork 4.3k
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
style-guide: add Chinese-specific rules #6285
style-guide: add Chinese-specific rules #6285
Conversation
Thanks for the traslation @blueskyson. I assume this is a literaly translation of #5952. Personally I don't think this page really does what it should. Things like the layout or token syntax are already explained in our original style guide. I tought it would be the best if this page would just cover the Chinese-specific rules, like half-width vs full-witdh and all the other punctuations. Maybe it's not even worth creating a whole new page for that, but only a new section in our style guide. |
Sounds like a plan @marchersimon . Shall I close this PR, and append a section with Chinese-specific rules to the style guide in another PR? By the way, I think #6200 needs to be solved before doing so. |
I think #6200 could take a while, so I'll just take care of the marge conficts. And I think you could just rename this PR and do the changes here, but it doesn'r really matter. My concern is just what we should do with the page @noarchwastaken created in #5952. Do you think a Chinese translation of the Chinese part would be even neccessary? |
Yes, the Chinese-specific rules need to be mentioned in Chinese translation as well. Not every Chinese writer knows the normalized copywriting of Chinese-Latin mix. |
I'm asking if we should have a Chinese translation of the style guide at all? We don't have that for any other language. |
Hum... I think Chinese translation is not necessary, but better than nothing. I approve to have Chinese translation personally. Maybe you could open an issue and vote for having style-guide in other languages or not, then decide whether to add according to voting result. |
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.
It looks good to me. I think it is important to make these rules clear.
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 think the most important rule is kind of missing: When sholudn't you use full-width.
Basically, that would be something like
1. Use half-width punctuation after Latin characters.
For example, use 等效于 `vim -R`. rather than 等效于 `vim -R`。
contributing-guides/style-guide.md
Outdated
3. Place one space between numbers and units **except** degrees and percentages. | ||
For example, use `容量 50 MB` rather than `容量 50MB`. | ||
For instances of degree and percentage, use `50°C` and `50%` rather than `50 °C` and `50 %`. |
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 wouldn't say 50MB is really wrong. Also, how does that only apply to Chinese?
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.
It depends on an organization's decision. Internet giants like Google, Microsoft and Wikipedia apply this rule in Chinese regions. But Apple doesn't. I personally prefer to have that space.
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'm still not sure if we should consider this Chinese-specific.
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.
Okay, I cancel this rule. If there would be a unit-related issue, this could be discuss again.
contributing-guides/style-guide.md
Outdated
5. Use full-width punctuations except for long Latin clauses. | ||
For example, use `嗨,你好。` rather than `嗨, 你好.` |
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 think the most important rule is kind of missing: When sholudn't you use full-width.
Basically, that would be something like
1. Use half-width punctuation after Latin characters. For example, use 等效于 `vim -R`. rather than 等效于 `vim -R`。
I'll combine it with this rule.
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.
Use half-width punctuation after Latin characters.
conflicts with this.
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.
But that's what I basically did in #5240. Did I misunderstand something? I'm confused.
Sorry, I am late. Accorrding to government standard draft, Chinese technical documents mainly serve Chinese text, which should be based on Chinese punctuation and supplemented by English punctuation. Therefore, Chinese sentences should end with Chinese punctuation at the end of the sentence. Only when English sentences are cited in Chinese sentences, we keep them.
|
Then what about https://github.com/sparanoid/chinese-copywriting-guidelines/blob/master/README.en-US.md? I assume there is no correct form, just one for different purposes. |
You mean this part? |
Yep, for example |
The suggestion of https://github.com/sparanoid/chinese-copywriting-guidelines/blob/master/README.en-US.md is the same as rule 5 I found some examples of such situation in tldr page:
If the examples above follows the rule 5, they would be:
I think the rule |
I think there are no conflicts. One separated english sentence will keep halfwidth form, but actuallly we don't use a separated english sentence in chinese writing. Just cite them with |
Just like the examples in https://github.com/sparanoid/chinese-copywriting-guidelines
|
Then what about the punctuation? Is using halfwith after Latin characters wrong? We all agreed on using that. |
I respectfully disagree, but this discussion took too much time. I think we need to finish the style guide rules as soon as possible. Maybe we should just make a draft style guide. It is easy to correct them by script in the future. |
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.
Thanks @blueskyson,
maybe we'll refine this in the future, but I think we should get this merged.
This is a translation of #5952.
I keep the original meaning with few revisions, so there might exists some sentences that are not fluent.
The words "Chinese-Latin mix" may cause some confusion. It means a sentence that contains both Chinese words and Latin words, but I didn't find a proper term to express such situation.