@@ -12,11 +12,11 @@ content_type: concept
12
12
13
13
<!-- body -->
14
14
15
- ## 一般规定
15
+ ## 一般规定 {#general}
16
16
17
17
本节列举一些译文中常见问题和约定。
18
18
19
- ### 英文原文的保留
19
+ ### 英文原文的保留 {#commented-en-text}
20
20
21
21
为便于译文审查和变更追踪,所有中文本地化 Markdown 文件中都应使用 HTML 注释
22
22
` <!-- ` 和 ` --> ` 将英文原文逐段注释起来,后跟对应中文译文。例如:
@@ -38,7 +38,7 @@ This is English text ...
38
38
39
39
无论英文原文或者中文译文中,都不要保留过多的、不必要的空白行。
40
40
41
- #### 段落划分
41
+ #### 段落划分 {#paras}
42
42
43
43
请避免大段大段地注释和翻译。一般而言,每段翻译可对应两三个自然段。
44
44
段落过长会导致译文很难评阅。但也不必每个段落都单独翻译。例如:
@@ -77,7 +77,7 @@ First paragraph, not very long.
77
77
第一段落,不太长。
78
78
```
79
79
80
- #### 编号列表的处理
80
+ #### 编号列表的处理 {#list}
81
81
82
82
编号列表需要编号的连续性,处理不好的话可能导致输出结果错误。
83
83
由于有些列表可能很长,一次性等将整个列表注释掉再翻译也不现实。
@@ -124,7 +124,7 @@ First paragraph, not very long.
124
124
4. 列表终于结束
125
125
```
126
126
127
- #### Frontmatter 的处理
127
+ #### Frontmatter 的处理 {#frontmatter}
128
128
129
129
页面中的 Frontmatter 指的是文件头的两个 ` --- ` 中间的部分。
130
130
对这一部分,解析器有特殊处理,因此不能将英文部分放在前面,中文跟在后面。
@@ -152,8 +152,7 @@ weight: 30
152
152
- ` title ` 、` description ` 的内容要翻译,其他字段一般不必(甚至不可)翻译。
153
153
- ` reviewers ` 部分要删除,不然中文译文会转给英文作者来审阅。
154
154
155
-
156
- #### 短代码(shortcode)处理
155
+ #### 短代码(shortcode)处理 {#shortcode}
157
156
158
157
通过 HTML 注释的短代码仍会被运行,因此需要额外小心。建议处理方式:
159
158
@@ -171,9 +170,9 @@ English text
171
170
保持注释掉的英文与译文都在短代码内更便于维护。
172
171
{{< /note >}}
173
172
174
- ### 译与不译
173
+ ### 译与不译 {#keep-or-translate}
175
174
176
- #### 资源名称或字段不译
175
+ #### 资源名称或字段不译 {#resource-name-or-fields}
177
176
178
177
根据英文原文写作风格约定【也在持续修订改进】,对 Kubernetes 中的 API
179
178
资源均按其规范中所给的大小写形式书写,例如:英文中会使用 Deployment 而不是
@@ -187,13 +186,12 @@ deployment 来表示名为 "Deployment" 的 API 资源类型和对象实例。
187
186
这时在本地化版本中一定不能译为“秘密”,以免与原文的语义不符。
188
187
{{< /note >}}
189
188
190
- #### 代码中的注释
189
+ #### 代码中的注释 {#code-comments}
191
190
192
191
一般而言,代码中的注释需要翻译,包括存放在 ` content/zh-cn/examples/ `
193
192
目录下的清单文件中的注释。
194
193
195
-
196
- #### 出站链接
194
+ #### 出站链接 {#external-links}
197
195
198
196
如果超级链接的目标是 Kubernetes 网站之外的纯英文网页,链接中的内容** 可以** 不翻译。
199
197
例如:
@@ -209,7 +207,7 @@ Please check [installation caveats](https://acme.com/docs/v1/caveats) ...
209
207
注意,这里的 ` installation ` 与 ` 参阅 ` 之间留白,因为解析后属于中英文混排的情况。
210
208
{{< /note >}}
211
209
212
- ### 标点符号
210
+ ### 标点符号 {#punctuations}
213
211
214
212
1 . 译文中标点符号要使用全角字符,除非以下两种情况:
215
213
@@ -218,7 +216,7 @@ Please check [installation caveats](https://acme.com/docs/v1/caveats) ...
218
216
219
217
1 . 英文排比句式中采用的逗号,在译文中要使用顿号代替,以便符合中文书写习惯。
220
218
221
- ## 更新译文
219
+ ## 更新译文 {#update}
222
220
223
221
由于整个文档站点会随着 Kubernetes 项目的开发进展而演化,英文版本的网站内容会不断更新。
224
222
鉴于中文站点的基本翻译工作在 1.19 版本已完成,
@@ -238,9 +236,9 @@ Please check [installation caveats](https://acme.com/docs/v1/caveats) ...
238
236
./scripts/lsync.sh content/zh-cn/docs/foo/bar.md
239
237
```
240
238
241
- ## 关于链接
239
+ ## 关于链接 {#about-links}
242
240
243
- ### 链接锚点
241
+ ### 链接锚点 {#anchors}
244
242
245
243
英文 Markdown 中的各级标题会自动生成锚点,以便从其他页面中链接。
246
244
在译为中文后,相应的链接必然会失效。为防止这类问题,
@@ -255,8 +253,7 @@ Please check [installation caveats](https://acme.com/docs/v1/caveats) ...
255
253
256
254
此类问题对于概念部分的页面最为突出,需要格外注意。
257
255
258
-
259
- ### 中文链接目标
256
+ ### 中文链接目标 {#link-to-zh-pages}
260
257
261
258
由于大部分页面已经完成中文本地化,这意味着很多链接可以使用中文版本作为目标。
262
259
例如:
@@ -281,7 +278,7 @@ Website 的仓库中 `scripts/linkchecker.py` 是一个工具,可用来检查
281
278
```
282
279
{{< /note >}}
283
280
284
- ## 排版格式
281
+ ## 排版格式 {#layout-format}
285
282
286
283
以下为译文 Markdown 排版格式要求:
287
284
@@ -309,12 +306,11 @@ Website 的仓库中 `scripts/linkchecker.py` 是一个工具,可用来检查
309
306
甚至将超级链接中的半角井号(` # ` )转换为全角,导致链接失效。
310
307
{{< /warning >}}
311
308
312
-
313
- ## 特殊词汇
309
+ ## 特殊词汇 {#special-words}
314
310
315
311
英文中 "you" 翻译成 "你",不必翻译为 "您" 以表现尊敬或谦卑。
316
312
317
- ### 术语拼写
313
+ ### 术语拼写 {#terms-spelling}
318
314
319
315
按中文译文习惯,尽量不要在中文译文中使用首字母小写的拼写。例如:
320
316
@@ -337,7 +333,7 @@ Website 的仓库中 `scripts/linkchecker.py` 是一个工具,可用来检查
337
333
镜像策略(Image Policy)用来控制集群可拉取的镜像仓库(Image Registry)源。
338
334
```
339
335
340
- ### 术语对照
336
+ ### 术语对照 {#glossary}
341
337
342
338
本节列举常见术语的统一译法。除极个别情况,对于专业术语应使用本节所列举的译法:
343
339
0 commit comments