diff --git a/contributing-guides/style-guide.zh.md b/contributing-guides/style-guide.zh.md index 5a518552c6..d79c85e340 100644 --- a/contributing-guides/style-guide.zh.md +++ b/contributing-guides/style-guide.zh.md @@ -50,23 +50,23 @@ tldr --render {{page.md}} 翻译时，请尽量翻译原文中的西文占位符。下面是命名占位符的规则： -1. 占位符需要短小精悍， +1. 占位符需要短小精悍， 例如 `{{源文件}}` 或者 `{{钱包.txt}}` 2. 如果占位符是西文，请用 [`snake_case`](https://en.wikipedia.org/wiki/Snake_case) 来分词。 -3. 当占位符涉及文件路径时，请用 `{{目录/子目录/<占位符>}}` 的格式。 - 例如：`ln -s {{目录/子目录/源文件}} {{目录/子目录/链接}}` +3. 当占位符涉及文件路径时，请用 `{{目录/子目录/<占位符>}}` 的格式。 + 例如：`ln -s {{目录/子目录/源文件}} {{目录/子目录/链接}}` 如果占位符提到的文件也可能是目录，请用 `{{目录/子目录/文件或目录}}` 4. 除非文件是特定的，上述 `{{目录/子目录/<占位符>}}` 的文件路径格式应用于所有包含路径的命令。 -5. 如果命令需要的文件扩展名是固定的，请在占位符里加上文件格式。 - 例如：`unrar x {{压缩包.rar}}` - 如果文件 **必须** 有一个扩展名，请用 `{{.ext}}` 。 - 例如，在 `find {{起始目录}} -name '{{*.ext}}'` 的例子里， - 这样做简单地演示了查找一个特定文件扩展名的方法。 +5. 如果命令需要的文件扩展名是固定的，请在占位符里加上文件格式。 + 例如：`unrar x {{压缩包.rar}}` + 如果文件 **必须** 有一个扩展名，请用 `{{.ext}}` 。 + 例如，在 `find {{起始目录}} -name '{{*.ext}}'` 的例子里， + 这样做简单地演示了查找一个特定文件扩展名的方法。 但是，在 `wc -l {{file}}` 的例子里，用不加扩展名的 `{{file}}` 就足够了。 -6. 如果用实际的值比描述这个占位符更加明了，请举一个值做例子。 +6. 如果用实际的值比描述这个占位符更加明了，请举一个值做例子。 例如：`iostat {{2}}` 比 `iostat {{以秒为单位的间隔}}` 更清晰。 -7. 如果一个命令可能对文件系统或设备造成不可逆的影响，请在示例命令中注意改写，使其不能被盲目复制粘贴运行。 - 例如，`ddrescue --force --no-scrape /dev/sda /dev/sdb` 被盲目复制粘贴时可能对系统造成毁灭性的打击；`ddrescue --force --no-scrape {{/dev/sdX}} {{/dev/sdY}}` 则更安全。 +7. 如果一个命令可能对文件系统或设备造成不可逆的影响，请在示例命令中注意改写，使其不能被盲目复制粘贴运行。 + 例如，`ddrescue --force --no-scrape /dev/sda /dev/sdb` 被盲目复制粘贴时可能对系统造成毁灭性的打击；`ddrescue --force --no-scrape {{/dev/sdX}} {{/dev/sdY}}` 则更安全。 因此，请用 `{{/dev/sdXY}}` 而不是 `{{/dev/sda1}}` 来表示一个 **块设备** 。 占位符应该尽可能简单明了，让人一眼就能看出应该替换它的值。 @@ -83,22 +83,22 @@ tldr --render {{page.md}} 以下规则适用于中文（zh）和繁体中文（zh_TW）： -1. 在西文单词和数字前后放置一个空格。 - 例如：`列出所有 docker 容器`而不是`列出所有docker容器`。 - 例如：`宽度为 50 个字`而不是`宽度为50个字`。 -2. 除了度数和百分比，在数字和单位之间留一个空格。 - 例如：`容量 50 MB` 而不是`容量 50MB`。 +1. 在西文单词和数字前后放置一个空格。 + 例如：`列出所有 docker 容器` 而不是 `列出所有docker容器`。 + 例如：`宽度为 50 个字` 而不是 `宽度为50个字`。 +2. 除了度数和百分比，在数字和单位之间留一个空格。 + 例如：`容量 50 MB` 而不是 `容量 50MB`。 对于度数和百分比：使用 `50°C` 和 `50%` 而不是 `50 °C` 和 `50 %`. -3. 不要在全角标点符号前后放置空格。 - 例如：`开启 shell，进入交互模式`而不是`开启 shell ，进入交互模式`。 -4. 除了西文长句，一律使用全角标点符号。 - 例如：`嗨，你好。`而不是`嗨, 你好.`。 -5. 当最句子最后一个字符是半角时，使用半角标点符号来结束句子。 - 例如：`将代码转化为 Python 3.` 而不是`将代码转化为 Python 3。`。 -6. 使用精准的专有名词，不要使用非官方的中文缩写。 - 例如：`Facebook` 而非 `facebook`、`fb` 或`脸书`。 - +3. 不要在全角标点符号前后放置空格。 + 例如：`开启 shell，进入交互模式` 而不是 `开启 shell ，进入交互模式`。 +4. 除了西文长句，一律使用全角标点符号。 + 例如：`嗨，你好。` 而不是 `嗨, 你好.`。 +5. 当最句子最后一个字符是半角时，使用半角标点符号来结束句子。 + 例如：`将代码转化为 Python 3.` 而不是 `将代码转化为 Python 3。`。 +6. 使用精准的专有名词，不要使用非官方的中文缩写。 + 例如：`Facebook` 而非 `facebook`、`fb` 或 `脸书`。 + 为保持可读性和一致性，将页面翻译成中文时，请尽可能遵守以上 6 条规则。 -有关更多中西文混排规则的信息，请参考[《中文文案排版指北》](https://github.com/sparanoid/chinese-copywriting-guidelines)。 +有关更多中西文混排规则的信息，请参考 [《中文文案排版指北》](https://github.com/sparanoid/chinese-copywriting-guidelines)。