@@ -158,28 +158,19 @@ weight: 30
158
158
通过 HTML 注释的短代码仍会被运行,因此需要额外小心。建议处理方式:
159
159
160
160
```
161
- <!--
162
- English text
163
- -->
164
161
{{</* note */>}}
165
- 中文译文
166
- {{</* /note */>}}
167
- ```
168
-
169
- 评阅人应该不难理解中英文段落的对应关系。但是如果采用下面的方式,
170
- 则会出现两个 ` note ` ,因此需要避免。这是因为被注释起来的短代码仍会起作用!
171
-
172
- ```
173
162
<!--
174
- {{</* note */>}}
175
163
English text
176
- {{</* /note */>}}
177
164
-->
178
- {{</* note */>}}
179
165
中文译文
180
166
{{</* /note */>}}
181
167
```
182
168
169
+ {{< note >}}
170
+ 现行风格与之前风格有些不同,这是因为较新的 Hugo 版本已经能够正确处理短代码中的注释段落。
171
+ 保持注释掉的英文与译文都在短代码内更便于维护。
172
+ {{< /note >}}
173
+
183
174
### 译与不译
184
175
185
176
#### 资源名称或字段不译
@@ -198,13 +189,13 @@ deployment 来表示名为 "Deployment" 的 API 资源类型和对象实例。
198
189
199
190
#### 代码中的注释
200
191
201
- 一般而言,代码中的注释需要翻译,包括存放在 ` content/zh/examples/ `
192
+ 一般而言,代码中的注释需要翻译,包括存放在 ` content/zh-cn /examples/ `
202
193
目录下的清单文件中的注释。
203
194
204
195
205
196
#### 出站链接
206
197
207
- 如果超级链接的目标是 Kubernetes 网站之外的纯英文网页,链接中的内容* 可以 * 不翻译。
198
+ 如果超级链接的目标是 Kubernetes 网站之外的纯英文网页,链接中的内容** 可以 * * 不翻译。
208
199
例如:
209
200
210
201
```
@@ -214,16 +205,18 @@ Please check [installation caveats](https://acme.com/docs/v1/caveats) ...
214
205
请参阅 [installation caveats](https://acme.com/docs/v1/caveats) ...
215
206
```
216
207
208
+ {{< note >}}
217
209
注意,这里的 ` installation ` 与 ` 参阅 ` 之间留白,因为解析后属于中英文混排的情况。
210
+ {{< /note >}}
218
211
219
212
### 标点符号
220
213
221
- 译文中标点符号要使用全角字符,除非以下两种情况:
214
+ 1 . 译文中标点符号要使用全角字符,除非以下两种情况:
222
215
223
- - 标点符号是英文命令的一部分;
224
- - 标点符号是 Markdown 语法的一部分。
216
+ - 标点符号是英文命令的一部分;
217
+ - 标点符号是 Markdown 语法的一部分。
225
218
226
- 英文排比句式中采用的逗号,在译文中要使用顿号代替,以便符合中文书写习惯。
219
+ 1 . 英文排比句式中采用的逗号,在译文中要使用顿号代替,以便符合中文书写习惯。
227
220
228
221
## 更新译文
229
222
@@ -233,7 +226,7 @@ Please check [installation caveats](https://acme.com/docs/v1/caveats) ...
233
226
234
227
为确保准确跟踪中文化版本与英文版本之间的差异,中文内容的 PR 所包含的每个页面都必须是“最新的”。
235
228
这里的“最新”指的是对应的英文页面中的更改已全部同步到中文页面。
236
- 如果某中文 PR 中包含对 ` content/zh/docs/foo/bar.md ` 的更改,且文件 ` bar.md `
229
+ 如果某中文 PR 中包含对 ` content/zh-cn /docs/foo/bar.md ` 的更改,且文件 ` bar.md `
237
230
的上次更改日期是 ` 2020-10-01 01:02:03 UTC ` ,对应 GIT 标签 ` abcd1234 ` ,
238
231
则 ` bar.md ` 应包含自 ` abcd1234 ` 以来 ` content/en/docs/foo/bar.md ` 的所有变更,
239
232
否则视此 PR 为不完整 PR,会破坏我们对上游变更的跟踪。
@@ -242,7 +235,7 @@ Please check [installation caveats](https://acme.com/docs/v1/caveats) ...
242
235
` bar.md ` 上次提交以来发生的所有变更,可使用:
243
236
244
237
```
245
- ./scripts/lsync.sh content/zh/docs/foo/bar.md
238
+ ./scripts/lsync.sh content/zh-cn /docs/foo/bar.md
246
239
```
247
240
248
241
## 关于链接
@@ -273,18 +266,18 @@ Please check [installation caveats](https://acme.com/docs/v1/caveats) ...
273
266
For more information, please check [volumes](/docs/concepts/storage/)
274
267
...
275
268
-->
276
- 更多的信息可参考[卷](/zh/docs/concepts/storage/)页面。
269
+ 更多的信息可参考[卷](/zh-cn /docs/concepts/storage/)页面。
277
270
```
278
271
279
272
如果对应目标页面尚未本地化,建议登记一个 Issue。
280
273
281
274
{{< note >}}
282
275
Website 的仓库中 ` scripts/linkchecker.py ` 是一个工具,可用来检查页面中的链接。
283
- 例如,下面的命令检查中文本地化目录 ` /content/zh/docs/concepts/containers/ `
276
+ 例如,下面的命令检查中文本地化目录 ` /content/zh-cn /docs/concepts/containers/ `
284
277
中所有 Markdown 文件中的链接合法性:
285
278
286
- ```
287
- ./scripts/linkchecker.py -l zh -f /docs/concepts/containers/**/*.md
279
+ ``` shell
280
+ ./scripts/linkchecker.py -l zh-cn -f /docs/concepts/containers/** /* .md
288
281
```
289
282
{{< /note >}}
290
283
@@ -293,27 +286,33 @@ Website 的仓库中 `scripts/linkchecker.py` 是一个工具,可用来检查
293
286
以下为译文 Markdown 排版格式要求:
294
287
295
288
- 中英文之间留一个空格
289
+
296
290
* 这里的“英文”包括以英文呈现的超级链接
297
- * 这里的中文、英文都不包括标点符号
291
+ * 这里的中文、英文都** 不包括** 标点符号
292
+
298
293
- 译文 Markdown 中不要使用长行,应适当断行。
294
+
299
295
* 可根据需要在 80-120 列断行
300
296
* 最好结合句子的边界断行,即一句话在一行,不必留几个字转到下一行
301
297
* 不要在两个中文字符中间断行,因为这样会造成中文字符中间显示一个多余空格,
302
298
如果句子太长,可以从中文与非中文符号之间断行
303
299
* 超级链接文字一般较长,可独立成行
304
300
301
+ - 英文原文中可能通过 ` _text_ ` 或者 ` *text* ` 的形式用斜体突出部分字句。
302
+ 考虑到中文斜体字非常不美观,在译文中应改为 ` **译文** ` 形式,
303
+ 即用双引号语法生成加粗字句,实现突出显示效果。
304
+
305
305
{{< warning >}}
306
306
我们注意到有些贡献者可能使用了某种自动化工具,在 Markdown 英文原文中自动添加空格。
307
307
虽然这些工具可一定程度提高效率,仍然需要提请作者注意,某些工具所作的转换可能是不对的,
308
308
例如将 ` foo=bar ` 转换为 ` foo = bar ` 、将 ` ),另一些文字 ` 转换为 ` ) ,另一些文字 ` 等等,
309
309
甚至将超级链接中的半角井号(` # ` )转换为全角,导致链接失效。
310
310
{{< /warning >}}
311
311
312
- 英文中 "you" 翻译成 "你" 不必是 "您"。
313
- 文章内的链接用英文,例如 (#deploying),在对应的标题上后面加上 {#deploying}
314
312
313
+ ## 特殊词汇
315
314
316
- ## 术语
315
+ 英文中 "you" 翻译成 "你",不必翻译为 "您" 以表现尊敬或谦卑。
317
316
318
317
### 术语拼写
319
318
0 commit comments