Hat
译者 / 网站维护 / 校对
💡 摘要 (Powered by OpenAI)
本文是 BIRD 中文文档翻译计划的介绍,将介绍 BIRD 中文文档翻译计划的目的、项目简介、如何参与、翻译规范、排版规范、拓展语法等内容,以便您更好地了解相关 BIRD 中文文档翻译计划,并参与其中。
尽管 BIRD 官方文档已经足够精炼,但它仅提供英文版本。
随着 BIRD 在中文环境中的使用率逐步增长,为了方便国内用户参考和查阅,故决定发起 BIRD 中文文档翻译计划。
有两种方法可以参与 BIRD 中文文档翻译计划:
[email protected]
,申请加入 git 组织。[email protected]
本文档所有的 译文/原创文章 均采用 CC BY-NC-SA 4.0 协议发布,转载请遵循以下原则:
本文档不承担任何由于引用文章而导致的任何直接或者间接的法律责任,如有侵权,请联系我们删除。
To: [email protected]
Subject: 申请加入 BIRD 中文文档翻译计划
我是 {昵称},我希望加入 BIRD 中文文档翻译计划,我 Email 地址为 {你的邮箱地址}。
我同意遵守 BIRD 中文文档翻译计划的所有规定,我将尽我所能为 BIRD 中文文档翻译计划做出贡献。
我已阅读并同意 CC BY-NC-SA 4.0 协议。
To: [email protected]
Subject: BIRD-CN 文档投稿 / {翻译文档名称}
我是 {昵称},我希望投稿 BIRD 中文文档翻译计划,我 Email 地址为 {你的邮箱地址}。
[markdown 文档内容附件]
中文翻译有一个由朱明华提出的通用原则:信、达、雅。
信:忠实于原文,不改变原文的意思。
达:书面描述清晰,达意明确,避免使用含糊或歧义的词语。
雅:符合中文语言规范,避免使用网络用语和口语化的表达方式。
具体规范:
在尊重原文含义的基础上,采用符合中文语言习惯的表达方式,即保持“信”。
为了帮助读者更好理解原文,可以适当增加原文中未涉及的内容,如概念解释和使用示例。
专有名词在文章中首次出现时,应在括号中附上英文原文;后续提及时,可直接使用中文译名。
应使用正式书面语,避免采用网络用语和口语表达方式。
为降低阅读难度,应适当增加换行,将超过 100 字的长段落分割为多个短段。
若原文中包含与中文文化差异较大的内容(如历史隐喻),应适当增加解释性注释。
在不影响原意的情况下,应避免生硬的直译,转而采用更符合中文表达习惯的翻译。
保持段落结构清晰,每个段落应围绕一个中心思想或主题展开。
在翻译过程中,应尽量避免使用带有偏见的词语,如“显然”、“明显”、“不难看出”等。
也请尽量避免使用“我们”、“你们”、“他们”等主语,而是使用“我们”、“用户”、“读者”等中立词语。
在中英文混排时,使用半角括号。若括号两侧为中文,则两侧各留一个半角空格;
若括号内为中文或括号后为标点符号,则不需留空格。
示例:
BIRD (BIRD Internet Routing Daemon) 是一个(开源的)路由守护进程。
专有名词两侧若有其他正文,请各空一格并加粗,以增加可读性。 专有名词若有英文缩写,请为缩写也加粗处理。
在文档中首次出现的专有名词旁,添加英文原名的注释,有助于读者理解和参考。
示例:
**BIRD** (BIRD Internet Routing Daemon, **BIRD**) 是一个开源的路由守护进程。
可以对较长的段落适当增加换行,以减少阅读难度。
示例:
与操作系统的耦合是许多路由程序的通病,这样会导致程序的可移植性变差,也会使程序的维护变得更加困难。
遗憾的是,由于不同操作系统的网络栈实现不同,这种耦合是不可避免的,但是我们可以通过抽象出一些通用的接口,来减少这种耦合。
如果正文中有列举的内容,请根据情况使用有序或者无序列表。
示例:
BIRD 中有三个重要的 MPLS 概念:MPLS 域、MPLS 表、MPLS 频道。
↓
BIRD 中有三个重要的 MPLS 概念:
1. MPLS 域
2. MPLS 表
3. MPLS 频道
文章标题请遵循 第x章·第x节 中文标题 (原标题)
的格式。
使用一级标题表示文章主标题,二级标题用于主要部分,三级标题用于细分小节。
所有子级标题请尽量使用中文,避免直接使用英文/代码,以增加可读性。
比如,BGP
可以翻译为 边界网关协议 (BGP)
,BFD
可以翻译为 双向转发检测 (BFD)
。
如果一节内容中包含多个子节,可以将子节分类成多个二级标题,以降低阅读难度。
如:
### 路由范围 (Route Scope)
### 路由偏好 (Route Preference)
### 路由来源 (Source)
### 路由网关 (Gateway)
### 路由源协议 (Protocol)
### 路由来源协议 (Source)
### 数据包目的地类型
### 接口名 (Interface Name)
可以改写为:
## 路由类型
### 路由范围 (Route Scope)
### 路由偏好 (Route Preference)
### 路由来源 (Source)
### 路由网关 (Gateway)
### 路由源协议 (Protocol)
### 路由来源协议 (Source)
### 数据包目的地类型
## 接口类型
### 接口名 (Interface Name)
...
为了避免读者感到困惑,建议在翻译过程中尽量避免使用被动语态,而是使用主动语态。
如:
因此,此属性对于操纵个别 `ECMP` 路由的下一跳不是很有用,但可以在 `BGP 多路径 (BGP multipath)` 中用来设置与 `ECMP` 路由合并导出到 `Kernel` 协议时的个别路由权重(当启用 [`merge paths`](...)) 选项时)。
可以改写为:
当然,在启用 [`merge paths`](...) 选项时,`BGP 多路径 (BGP multipath)` 与 `ECMP` 路由合并导出到 `Kernel` 协议时可以设置个别路由的权重。
拓展语法主要用于提高文档的可读性和互动性,是 VitePress 内置的 Markdown 拓展语法。
常见的拓展语法:
:emoji名称:
,比如 :smile:
,将会被渲染为 "😄"
具体的 emoji 列表请参考 此链接
本文档使用 Twemoji 作为 emoji 渲染引擎,样式可以参考 Emojipedia (此网站广告较多,建议使用广告拦截插件)
为了方便读者阅读,文档中经常会使用 emoji 标签增加趣味性。
Emoji | 名称 | 说明 |
---|---|---|
⚠️ | 警告 | 用于警告可能存在危险的操作,常常与 自定义容器 中的警告容器一起使用 |
💡 | 提示 | 用于提示一些小贴士,常常与 自定义容器 中的技巧小贴士一起使用 |
📖 | 说明 | 用于说明一些不太重要的内容,常常与 自定义容器 中的可展开容器一起使用 |
# 标题 {#anchor}
将标题锚点设置为 anchor
,可直接引用 /example#anchor
[[toc]]
💡 技巧小提示
这将会被渲染为一个灰色的提示块,用于译者注释。
💡 小贴士
这将会被渲染为一个绿色的提示块,用于提示一些小贴士。
⚠️ 注意
这将会被渲染为一个黄色的提示块,用于警告可能存在危险的操作。
‼️ 危险
这将会被渲染为一个红色的提示块,用于警告危险的操作。
这将会被渲染为一个可展开的提示块,通常写一些不是很重要的示例。
::: info :bulb: 技巧小提示
这将会被渲染为一个灰色的提示块,用于译者注释。
:::
::: tip :bulb: 小贴士
这将会被渲染为一个绿色的提示块,用于提示一些小贴士。
:::
::: warning :warning: 注意
这将会被渲染为一个黄色的提示块,用于警告可能存在危险的操作。
:::
::: danger :bangbang: 危险
这将会被渲染为一个红色的提示块,用于警告危险的操作。
:::
::: details 可展开容器
这将会被渲染为一个可展开的提示块,通常写一些不是很重要的示例。
:::
`js{4}
export default {
data () {
return {
msg: '这是一个高亮行!'
}
}
}
`
输出
export default {
data () {
return {
msg: '这是一个高亮行!'
}
}
}
export default {
data () {
return {
msg: '删除的' // [!code --]
msg: '增加的' // [!code ++]
}
}
}
输出
export default {
data () {
return {
msg: '删除的'
msg: '增加的'
}
}
}
更多扩展语法信息请参考 https://vitepress.dev/guide/markdown
以下列出了参与 BIRD 中文文档翻译计划的所有贡献者(排名不分先后)。
译者 / 网站维护 / 校对
特邀译者 / 校对 / 看板娘
译者 / 看板猫
译者
译者
译者
译者
译者
译者
遵循协议: CC BY-NC-SA 4.0
作者: BIRD-Chinese Community
写作时间: 2023-10-09
更新时间: 2024-09-22
本文链接: https://bird.xmsl.dev/pages/join-us.html