@@ -6,8 +6,7 @@ content_type: concept
6
6
<!-- overview -->
7
7
8
8
本节详述文档中文本地化过程中须注意的事项。
9
- 这里列举的内容包含了* 中文本地化小组* 早期给出的指导性建议和后续实践过程中
10
- 积累的经验。
9
+ 这里列举的内容包含了* 中文本地化小组* 早期给出的指导性建议和后续实践过程中积累的经验。
11
10
在阅读、贡献、评阅中文本地化文档的过程中,如果对本文的指南有任何改进建议,
12
11
都请直接提出 PR。我们欢迎任何形式的补充和更正!
13
12
@@ -167,8 +166,8 @@ English text
167
166
{{</* /note */>}}
168
167
```
169
168
170
- 评阅人应该不难理解中英文段落的对应关系。但是如果采用下面的方式,则会出现
171
- 两个 ` note ` ,因此需要避免。这是因为被注释起来的短代码仍会起作用!
169
+ 评阅人应该不难理解中英文段落的对应关系。但是如果采用下面的方式,
170
+ 则会出现两个 ` note ` ,因此需要避免。这是因为被注释起来的短代码仍会起作用!
172
171
173
172
```
174
173
<!--
@@ -193,14 +192,14 @@ deployment 来表示名为 "Deployment" 的 API 资源类型和对象实例。
193
192
194
193
{{< note >}}
195
194
英文原文在这方面并不严谨,译者或中文译文的评阅者要非常留心。
196
- 比如 Secret 资源,很多时候被误写为 secret。这时在本地化版本中一定
197
- 不能译为 “秘密”,以免与原文的语义不符。
195
+ 比如 Secret 资源,很多时候被误写为 secret。
196
+ 这时在本地化版本中一定不能译为 “秘密”,以免与原文的语义不符。
198
197
{{< /note >}}
199
198
200
199
#### 代码中的注释
201
200
202
- 一般而言,代码中的注释需要翻译,包括存放在 ` content/zh/examples/ ` 目录下
203
- 的清单文件中的注释 。
201
+ 一般而言,代码中的注释需要翻译,包括存放在 ` content/zh/examples/ `
202
+ 目录下的清单文件中的注释 。
204
203
205
204
206
205
#### 出站链接
@@ -228,15 +227,15 @@ Please check [installation caveats](https://acme.com/docs/v1/caveats) ...
228
227
229
228
## 更新译文
230
229
231
- 由于整个文档站点会随着 Kubernetes 项目的开发进展而演化,英文版本的网站内容
232
- 会不断更新。 鉴于中文站点的基本翻译工作在 1.19 版本已完成,从 1.20 版本开始
233
- 本地化的工作会集中在追踪英文内容变化上 。
230
+ 由于整个文档站点会随着 Kubernetes 项目的开发进展而演化,英文版本的网站内容会不断更新。
231
+ 鉴于中文站点的基本翻译工作在 1.19 版本已完成,
232
+ 从 1.20 版本开始本地化的工作会集中在追踪英文内容变化上 。
234
233
235
- 为确保准确跟踪中文化版本与英文版本之间的差异,中文内容的 PR 所包含的每个页面
236
- 都必须是“最新的”。 这里的“最新”指的是对应的英文页面中的更改已全部同步到中文页面。
237
- 如果某中文 PR 中包含对 ` content/zh/docs/foo/bar.md ` 的更改,且文件 ` bar.md ` 的
238
- 上次更改日期是 ` 2020-10-01 01:02:03 UTC ` ,对应 GIT 标签 ` abcd1234 ` ,则
239
- ` bar.md ` 应包含自 ` abcd1234 ` 以来 ` content/en/docs/foo/bar.md ` 的所有变更,
234
+ 为确保准确跟踪中文化版本与英文版本之间的差异,中文内容的 PR 所包含的每个页面都必须是“最新的”。
235
+ 这里的“最新”指的是对应的英文页面中的更改已全部同步到中文页面。
236
+ 如果某中文 PR 中包含对 ` content/zh/docs/foo/bar.md ` 的更改,且文件 ` bar.md `
237
+ 的上次更改日期是 ` 2020-10-01 01:02:03 UTC ` ,对应 GIT 标签 ` abcd1234 ` ,
238
+ 则 ` bar.md ` 应包含自 ` abcd1234 ` 以来 ` content/en/docs/foo/bar.md ` 的所有变更,
240
239
否则视此 PR 为不完整 PR,会破坏我们对上游变更的跟踪。
241
240
242
241
这一要求适用于所有更改,包括拼写错误、格式更正、链接修订等等。要查看文件
@@ -251,8 +250,8 @@ Please check [installation caveats](https://acme.com/docs/v1/caveats) ...
251
250
### 链接锚点
252
251
253
252
英文 Markdown 中的各级标题会自动生成锚点,以便从其他页面中链接。
254
- 在译为中文后,相应的链接必然会失效。为防止这类问题,建议在翻译
255
- 各级标题时 ,使用英文方式显式给出链接锚点。例如:
253
+ 在译为中文后,相应的链接必然会失效。为防止这类问题,
254
+ 建议在翻译各级标题时 ,使用英文方式显式给出链接锚点。例如:
256
255
257
256
```
258
257
<!--
@@ -299,14 +298,15 @@ Website 的仓库中 `scripts/linkchecker.py` 是一个工具,可用来检查
299
298
- 译文 Markdown 中不要使用长行,应适当断行。
300
299
* 可根据需要在 80-120 列断行
301
300
* 最好结合句子的边界断行,即一句话在一行,不必留几个字转到下一行
301
+ * 不要在两个中文字符中间断行,因为这样会造成中文字符中间显示一个多余空格,
302
+ 如果句子太长,可以从中文与非中文符号之间断行
302
303
* 超级链接文字一般较长,可独立成行
303
304
304
305
{{< warning >}}
305
- 我们注意到有些贡献者可能使用了某种自动化工具,在 Markdown 英文原文中自动
306
- 添加空格。虽然这些工具可一定程度提高效率,仍然需要提请作者注意,某些工具
307
- 所作的转换可能是不对的,例如将 ` foo=bar ` 转换为 ` foo = bar ` 、将
308
- ` ),另一些文字 ` 转换为 ` ) ,另一些文字 ` 等等,甚至将超级链接中的半角
309
- 井号(` # ` )转换为全角,导致链接失效。
306
+ 我们注意到有些贡献者可能使用了某种自动化工具,在 Markdown 英文原文中自动添加空格。
307
+ 虽然这些工具可一定程度提高效率,仍然需要提请作者注意,某些工具所作的转换可能是不对的,
308
+ 例如将 ` foo=bar ` 转换为 ` foo = bar ` 、将 ` ),另一些文字 ` 转换为 ` ) ,另一些文字 ` 等等,
309
+ 甚至将超级链接中的半角井号(` # ` )转换为全角,导致链接失效。
310
310
{{< /warning >}}
311
311
312
312
英文中 "you" 翻译成 "你" 不必是 “您"。
0 commit comments