文档翻译格式 (Translation Spec)
杨加康 edited this page Oct 5, 2021
·
3 revisions
请注意:请不要修改原始英文文档的结构,以避免全球英文文档更新时额外的工作量。
https://gist.github.com/chenglu/87c3743b37ccb193df57544c4a082f20
直接把中文放在原文下方即可:
## english
## 中文
english
中文
中文要换行并且缩进要与文字部分对齐
- one
一
- two
二
- three
三
注意:不要省略中间和末尾的空行。
对原有内容套上 标签,如:
<t>one</t><t>一</t> | <t>two</t><t>二</t> | <t>three</t><t>三</t>
----|----|----
four | five | six
在紧下一行书写中文(可任意添加空格进行对齐),如:
<t>one</t><t>一</t> | <t>two</t><t>二</t> | <t>three</t><t>三</t>
----|----|----
four | five | six
四 | 五 | 六
对于内嵌在 md 中的 html 内容,需要特殊处理
可以直接在下方放中文,如:
<p>
english
</p>
<p>
中文
</p>
内容不限
可以直接在下方放中文,但只支持单行,如:
<div>english</div>
<div>中文</div>
但不支持:
<div>
english
</div>
<div>
中文
</div>
可以直接在紧后方放中文,如:
<span>english</span><span>中文</span>
中间换行也可以。但尽量不要用这种方式,而是优先使用整段翻译的方式。
一般原文会以下面这种形式出现:
<ol markdown="1">
<li markdown="1">
english...
</li>
</ol>
直接在标签体内,换行将英文放在原文下方:
<ol markdown="1">
<li markdown="1">
english...
中文...
</li>
</ol>
一般原文会以下面这种形式出现:(当文本中含 md 格式时,标签会含有 markdown="1"
标识)
<dl markdown="1">
<dt markdown="1">english</dt>
<dd markdown="1">english</dd>
此时,需要将原文使用 p 标签包裹,并且下方的中文依然使用 p 标签包裹(如果文本中包含 md 格式的标签,需要在 p 标签中标识 markdown="1"
),如:
<dl markdown="1">
<dt markdown="1">
<p markdown="1">english</p>
<p markdown="1">中文</p>
</dt>
<dd markdown="1">
<p markdown="1">english</p>
<p markdown="1">中文</p>
</dd>
这里的被 p 标签包裹的英文和中文可换行也可不换行,为了方便阅读,建议原文和译文分属不同行。
文档中的「您」请使用「你」,以表示与开发者平等沟通的意味。
当翻译时文档中有类似:
链接
: 说明
即冒号在一行的最前面这种格式的,请将 :
换成 <br>
(包括原文)。