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

[Discussion] XXX - XXX OR「XXX」-「XXX」 #125

Open
burningtnt opened this issue Jun 5, 2024 · 1 comment
Open

[Discussion] XXX - XXX OR「XXX」-「XXX」 #125

burningtnt opened this issue Jun 5, 2024 · 1 comment

Comments

@burningtnt
Copy link
Member

burningtnt commented Jun 5, 2024

#123

[Burning_TNT]

讨论一下:对于启动器内路径的展示,是否应当使用代码块?

[3gf8jv4dv]

My personal opinion.
The code block style is essentially a quote to a certain text. Readers can use this style to distinguish which text is quoted.
When reading the original code (plain text), only two ` symbols are displayed. This symbol is in half-width form, and combined with half-width spaces, you can make a relatively good prediction of the layout in the plain text case. When actually rendered, the text in the code block style is rendered with a monospaced font. In some styles, the text background becomes gray (This is true on GitHub and the HMCL docs site).
LTCatt, the developer of PCL2, used this style when announcing that their launcher source code was available and compilable. He/she used this pattern to make it clear how to find the Open with Visual Studio option in the GitHub repo homepage. For details, you can directly view a discussion he/she started: Hex-Dragon/PCL2#3910
If there are no other symbols to clarify that a certain text is quoted, readers will easily be dazzled in the dense text, have a bad look and be prone to misreading. The above code block is just one way to make the formatting easier for readers.
Perhaps we can consider using corner brackets commonly used in the CJK region. But in most cases, what most people type using the Chinese input method is likely to be in full-width form, and the typesetting is not easy to control in some cases; while the input of half-width corner brackets is more complicated. I have only seen one team use the half-width form when renaming files.
Maybe also consider English-style quotes (full width). However, the rendering effects of full-width format are different in different scenarios. Some fonts are rendered full-width, others half-width. I have seen some people write documents that add half-width spaces around full-width quotes. In this case, changing the scenario (for example, copying the text to another place) will result in too much spacing between the quotation marks and other text.
All in all, I think that if you use the last two quotation marks, typesetting will not be too easy under different scenarios and different writers. Code blocks are simple and easy to use, and typesetting is relatively easy. Of course, I do not own this document, so I need to reach a consensus with your team. I also hope to gain more valuable experience in this kind of discussion.

[Zkitefly]

我觉得可以加
但,我在考虑一个问题,当使用浏览器的全文翻译时那些使用代码块的文本可能会出现排版问题(Google Chrome 倒不会,Microsoft Edge 似乎会),可能对那些看不了中文需要翻译的人来说有点不方便(当然,这个是个小问题)

@3gf8jv4dv
Copy link
Contributor

Just an example.

Symbols Effect
Code blocks 特定游戏设置 - 自动安装
English-style quotes (full-width) “特定游戏设置” - “自动安装”
English-style quotes (half-width) "特定游戏设置" - "自动安装"
Corner brackets (full-width) 「特定游戏设置」-「自动安装」
Corner brackets (half-width) 「特定游戏设置」 - 「自动安装」

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

No branches or pull requests

2 participants